RSA BSAFE Micro Edition Suite

Streamlined security for mobile and embedded devices

Search  Print

Information Identifiers

This section lists the identifiers used to set and/or retrieve information from an R_PKEY. The following table details the data types to pass into param when calling R_PKEY_get_info().

Identifier Param Data Type
R_PKEY_INFO_ID_RSA_MOD R_ITEM *
R_PKEY_INFO_ID_RSA_EXP R_ITEM *
R_PKEY_INFO_ID_RSA_PRIV_EXP R_ITEM *
R_PKEY_INFO_ID_RSA_PRIME_N R_ITEM *
R_PKEY_INFO_ID_RSA_EXP_N R_ITEM *
R_PKEY_INFO_ID_RSA_INV_N R_ITEM *
R_PKEY_INFO_ID_RSA_Q R_ITEM *
R_PKEY_INFO_ID_RSA_DMQ1 R_ITEM *
R_PKEY_INFO_ID_RSA_X931_Q1 R_ITEM *
R_PKEY_INFO_ID_RSA_X931_Q2 R_ITEM *
R_PKEY_INFO_ID_RSA_P R_ITEM *
R_PKEY_INFO_ID_RSA_DMP1 R_ITEM *
R_PKEY_INFO_ID_RSA_IQMP R_ITEM *
R_PKEY_INFO_ID_RSA_X931_P1 R_ITEM *
R_PKEY_INFO_ID_RSA_X931_P2 R_ITEM *

R_PKEY_INFO_ID_DSA_PRIME R_ITEM *
R_PKEY_INFO_ID_DSA_SUBPRIME R_ITEM *
R_PKEY_INFO_ID_DSA_BASE R_ITEM *
R_PKEY_INFO_ID_DSA_PUB_KEY R_ITEM *
R_PKEY_INFO_ID_DSA_PRIV_KEY R_ITEM *
R_PKEY_INFO_ID_DSA_SEED R_ITEM *
R_PKEY_INFO_ID_DSA_COUNTER int *
R_PKEY_INFO_ID_DSA_H R_ITEM *
R_PKEY_INFO_ID_R_PKEY_CTX R_PKEY_CTX **
R_PKEY_INFO_ID_R_EITEMS R_EITEMS **
R_PKEY_INFO_ID_FLAG int *
R_PKEY_INFO_ID_DATA void **
R_PKEY_INFO_ID_REFERENCE int *
R_PKEY_INFO_ID_TYPE R_PKEY_TYPE *
R_PKEY_INFO_ID_NUM_BITS int *
R_PKEY_INFO_ID_NUM_PRIMES int *
R_PKEY_INFO_ID_KEY_ID R_ITEM *

R_PKEY_INFO_ID_KEY_SENSITIVE R_ITEM *
R_PKEY_INFO_ID_IS_TOKEN R_ITEM *
R_PKEY_INFO_ID_LABEL R_ITEM *

R_PKEY_INFO_ID_ENCRYPT R_ITEM *
R_PKEY_INFO_ID_DECRYPT R_ITEM *
R_PKEY_INFO_ID_VERIFY R_ITEM *
R_PKEY_INFO_ID_SIGN R_ITEM *
R_PKEY_INFO_ID_PRIVATE R_ITEM *
R_PKEY_INFO_ID_MODIFIABLE R_ITEM *
R_PKEY_INFO_ID_PURPOSE R_ITEM *
R_PKEY_INFO_ID_DELETE R_ITEM *

The following table details the data types to pass into param when calling R_PKEY_set_info().

Identifier Param Data Type
R_PKEY_INFO_ID_RSA_MOD R_ITEM *
R_PKEY_INFO_ID_RSA_EXP R_ITEM *
R_PKEY_INFO_ID_RSA_PRIV_EXP R_ITEM *
R_PKEY_INFO_ID_RSA_PRIME_N R_ITEM *
R_PKEY_INFO_ID_RSA_EXP_N R_ITEM *
R_PKEY_INFO_ID_RSA_INV_N R_ITEM *
R_PKEY_INFO_ID_RSA_Q R_ITEM *
R_PKEY_INFO_ID_RSA_DMQ1 R_ITEM *
R_PKEY_INFO_ID_RSA_X931_Q1 R_ITEM *
R_PKEY_INFO_ID_RSA_X931_Q2 R_ITEM *
R_PKEY_INFO_ID_RSA_P R_ITEM *
R_PKEY_INFO_ID_RSA_DMP1 R_ITEM *
R_PKEY_INFO_ID_RSA_IQMP R_ITEM *
R_PKEY_INFO_ID_RSA_X931_P1 R_ITEM *
R_PKEY_INFO_ID_RSA_X931_P2 R_ITEM *

R_PKEY_INFO_ID_DSA_PRIME R_ITEM *
R_PKEY_INFO_ID_DSA_SUBPRIME R_ITEM *
R_PKEY_INFO_ID_DSA_BASE R_ITEM *
R_PKEY_INFO_ID_DSA_PUB_KEY R_ITEM *
R_PKEY_INFO_ID_DSA_PRIV_KEY R_ITEM *
R_PKEY_INFO_ID_DSA_SEED R_ITEM *
R_PKEY_INFO_ID_DSA_COUNTER int *
R_PKEY_INFO_ID_DSA_H R_ITEM *
R_PKEY_INFO_ID_NUM_PRIMES int *
R_PKEY_INFO_ID_KEY_ID R_ITEM *

R_PKEY_INFO_ID_KEY_SENSITIVE R_ITEM *
R_PKEY_INFO_ID_IS_TOKEN R_ITEM *
R_PKEY_INFO_ID_LABEL R_ITEM *

R_PKEY_INFO_ID_ENCRYPT R_ITEM *
R_PKEY_INFO_ID_DECRYPT R_ITEM *
R_PKEY_INFO_ID_VERIFY R_ITEM *
R_PKEY_INFO_ID_SIGN R_ITEM *
R_PKEY_INFO_ID_PRIVATE R_ITEM *
R_PKEY_INFO_ID_MODIFIABLE R_ITEM *
R_PKEY_INFO_ID_PURPOSE R_ITEM *
R_PKEY_INFO_ID_DELETE R_ITEM *


Defines

#define R_PKEY_INFO_ID_RSA_MOD
 This identifier is used for the retrieval of the RSA modulus associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_RSA_EXP
 This identifier is used for the retrieval of the RSA exponent associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_RSA_PRIV_EXP
 This identifier is used for the retrieval of the RSA private exponent associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_RSA_PRIME_N(n)
 This identifier is used for the retrieval of the nth RSA prime associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_RSA_EXP_N(n)
 This identifier is used for the retrieval of the nth RSA exponent associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_RSA_INV_N(n)
 This identifier is used for the retrieval of the associated RSA inverse associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_RSA_Q
 This identifier is used for the retrieval of the first RSA prime associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_RSA_DMQ1
 This identifier is used for the retrieval of the first RSA exponent associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_RSA_X931_Q1
 This identifier is used for the retrieval of the first RSA X9.31 subprime 1 associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_RSA_X931_Q2
 This identifier is used for the retrieval of the first RSA X9.31 subprime 2 associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_RSA_P
 This identifier is used for the retrieval of the second RSA prime associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_RSA_DMP1
 This identifier is used for the retrieval of the second RSA exponent associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_RSA_IQMP
 This identifier is used for the retrieval of the second RSA inverse associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_RSA_X931_P1
 This identifier is used for the retrieval of the second RSA X9.31 subprime 1 associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_RSA_X931_P2
 This identifier is used for the retrieval of the second RSA X9.31 subprime 2 associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_DSA_PRIME
 This identifier is used for the retrieval of the Digital Signature Algorithm (DSA) prime associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_DSA_SUBPRIME
 This identifier is used for the retrieval of the DSA sub-prime associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_DSA_BASE
 This identifier is used for the retrieval of the DSA base associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_DSA_PUB_KEY
 This identifier is used for the retrieval of the DSA public key associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_DSA_PRIV_KEY
 This identifier is used for the retrieval of the DSA private key associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_DSA_SEED
 This identifier is used for the retrieval of the DSA seed associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_DSA_COUNTER
 This identifier is used for the retrieval of the DSA counter associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_DSA_H
 This identifier is used for the retrieval of the DSA h value associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_R_PKEY_CTX
 This identifier is used for the retrieval of the R_PKEY_CTX associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_R_EITEMS
 This identifier is used for the retrieval of the R_EITEMS associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_FLAG
 This identifier is used for the retrieval of the flags associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_DATA
 This identifier is used for the retrieval of the implementation data associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_REFERENCE
 This identifier is used for the retrieval of the reference count associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_TYPE
 This identifier is used for the retrieval of the R_PKEY_TYPE associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_NUM_BITS
 This identifier is used for the retrieval of the number of bits associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_NUM_PRIMES
 This identifier is used for the retrieval of the number of primes associated with the R_PKEY. More...

#define R_PKEY_INFO_ID_BY_ALG
 This identifier is used to access key information based on the algorithm information of the information. More...

#define R_PKEY_INFO_ID_DELETE
 This identifier is used to delete an item that has been added to a key. More...

#define R_PKEY_INFO_ID_KEY_SENSITIVE
 This identifier is used to locate privacy need in an R_PKEY. More...

#define R_PKEY_INFO_ID_IS_TOKEN
 This identifier is a handle for storing whether the key is to be permanently kept on the token. More...

#define R_PKEY_INFO_ID_LABEL
 This identifier is a handle for storing the key's label. More...

#define R_PKEY_INFO_ID_ENCRYPT
 This identifier is a handle for storing the key's encryption permission. More...

#define R_PKEY_INFO_ID_DECRYPT
 This identifier is a handle for storing the key's decryption permission. More...

#define R_PKEY_INFO_ID_VERIFY
 This identifier is a handle for storing the key's verification permission. More...

#define R_PKEY_INFO_ID_SIGN
 This identifier is a handle for storing the key's signing permission. More...

#define R_PKEY_INFO_ID_PRIVATE
 This identifier is a common storage attribute that is used to determine if an object is private. More...

#define R_PKEY_INFO_ID_MODIFIABLE
 This identifier is a common storage attribute that determines whether or not an object is read-only. More...

#define R_PKEY_INFO_ID_PURPOSE
 The purpose for which they key will be used. More...

#define R_PKEY_INFO_ID_LOCATION
 Identifies the location(s) where the complete object may be stored. More...


Define Documentation

#define R_PKEY_INFO_ID_BY_ALG
 

This identifier is used to access key information based on the algorithm information of the information. The algorithm information is represented by a R_PKEY_ALG_INFO.

See also:
R_PKEY_get_info().

#define R_PKEY_INFO_ID_DATA
 

This identifier is used for the retrieval of the implementation data associated with the R_PKEY. To retrieve this value the parameter reference should be passed in as cast void **.

See also:
R_PKEY_get_info().

#define R_PKEY_INFO_ID_DECRYPT
 

This identifier is a handle for storing the key's decryption permission. TRUE if the key supports decryption.

See also:
R_PKEY_get_info().

#define R_PKEY_INFO_ID_DELETE
 

This identifier is used to delete an item that has been added to a key. The info_id should be passed in as a pointer to an R_ITEM.

See also:
R_PKEY_get_info().

#define R_PKEY_INFO_ID_DSA_BASE
 

This identifier is used for the retrieval of the DSA base associated with the R_PKEY. To retrieve this value the parameter reference should be passed in as cast R_ITEM *.

See also:
R_PKEY_get_info(), R_PKEY_set_info() and R_PKEY_FIELD_ID_DSA_BASE.

#define R_PKEY_INFO_ID_DSA_COUNTER
 

This identifier is used for the retrieval of the DSA counter associated with the R_PKEY. To retrieve this value the parameter reference should be passed in as cast int *.

See also:
R_PKEY_get_info(), R_PKEY_set_info() and R_PKEY_FIELD_ID_DSA_COUNTER.

#define R_PKEY_INFO_ID_DSA_H
 

This identifier is used for the retrieval of the DSA h value associated with the R_PKEY. To retrieve this value the parameter reference should be passed in as cast R_ITEM *.

See also:
R_PKEY_get_info(), R_PKEY_set_info() and R_PKEY_FIELD_ID_DSA_H.

#define R_PKEY_INFO_ID_DSA_PRIME
 

This identifier is used for the retrieval of the Digital Signature Algorithm (DSA) prime associated with the R_PKEY. To retrieve this value the parameter reference should be passed in as cast R_ITEM *.

See also:
R_PKEY_get_info(), R_PKEY_set_info() and R_PKEY_FIELD_ID_DSA_PRIME.

#define R_PKEY_INFO_ID_DSA_PRIV_KEY
 

This identifier is used for the retrieval of the DSA private key associated with the R_PKEY. To retrieve this value the parameter reference should be passed in as cast R_ITEM *.

See also:
R_PKEY_get_info(), R_PKEY_set_info() and R_PKEY_FIELD_ID_DSA_PRIV_KEY.

#define R_PKEY_INFO_ID_DSA_PUB_KEY
 

This identifier is used for the retrieval of the DSA public key associated with the R_PKEY. To retrieve this value the parameter reference should be passed in as cast R_ITEM *.

See also:
R_PKEY_get_info(), R_PKEY_set_info() and R_PKEY_FIELD_ID_DSA_PUB_KEY.

#define R_PKEY_INFO_ID_DSA_SEED
 

This identifier is used for the retrieval of the DSA seed associated with the R_PKEY. To retrieve this value the parameter reference should be passed in as cast R_ITEM *.

See also:
R_PKEY_get_info(), R_PKEY_set_info() and R_PKEY_FIELD_ID_DSA_SEED.

#define R_PKEY_INFO_ID_DSA_SUBPRIME
 

This identifier is used for the retrieval of the DSA sub-prime associated with the R_PKEY. To retrieve this value the parameter reference should be passed in as cast R_ITEM *.

See also:
R_PKEY_get_info(), R_PKEY_set_info() and R_PKEY_FIELD_ID_DSA_SUBPRIME.

#define R_PKEY_INFO_ID_ENCRYPT
 

This identifier is a handle for storing the key's encryption permission. TRUE if the key supports encryption.

See also:
R_PKEY_get_info().

#define R_PKEY_INFO_ID_FLAG
 

This identifier is used for the retrieval of the flags associated with the R_PKEY. To retrieve this value the parameter reference should be passed in as cast int *.

See also:
R_PKEY_get_info().

#define R_PKEY_INFO_ID_IS_TOKEN
 

This identifier is a handle for storing whether the key is to be permanently kept on the token.

See also:
R_PKEY_get_info().

#define R_PKEY_INFO_ID_KEY_SENSITIVE
 

This identifier is used to locate privacy need in an R_PKEY. After an object has been created this attribute may only be changed to the value TRUE.

See also:
R_PKEY_get_info() and R_PKEY_set_info().

#define R_PKEY_INFO_ID_LABEL
 

This identifier is a handle for storing the key's label. This attribute can be modified after the object has been created.

See also:
R_PKEY_get_info() and R_PKEY_set_info().

#define R_PKEY_INFO_ID_LOCATION
 

Identifies the location(s) where the complete object may be stored.

See also:
R_PKEY_get_info().

#define R_PKEY_INFO_ID_MODIFIABLE
 

This identifier is a common storage attribute that determines whether or not an object is read-only. TRUE if the object is modifiable.

See also:
R_PKEY_get_info().

#define R_PKEY_INFO_ID_NUM_BITS
 

This identifier is used for the retrieval of the number of bits associated with the R_PKEY. To retrieve this value the parameter reference should be passed in as cast int *.

See also:
R_PKEY_get_info().

#define R_PKEY_INFO_ID_NUM_PRIMES
 

This identifier is used for the retrieval of the number of primes associated with the R_PKEY. This is valid for two prime and MultiPrime™ keys. To retrieve this value the parameter reference should be passed in as cast int *.

See also:
R_PKEY_get_info() and R_PKEY_set_info().

#define R_PKEY_INFO_ID_PRIVATE
 

This identifier is a common storage attribute that is used to determine if an object is private. TRUE if the object is private.

See also:
R_PKEY_get_info().

#define R_PKEY_INFO_ID_PURPOSE
 

The purpose for which they key will be used. See PKEY_PURPOSE.

See also:
R_PKEY_get_info().

#define R_PKEY_INFO_ID_R_EITEMS
 

This identifier is used for the retrieval of the R_EITEMS associated with the R_PKEY. To retrieve this value the parameter reference should be passed in as cast R_EITEMS **.

See also:
R_PKEY_get_info().

#define R_PKEY_INFO_ID_R_PKEY_CTX
 

This identifier is used for the retrieval of the R_PKEY_CTX associated with the R_PKEY. To retrieve this value the parameter reference should be passed in as cast R_PKEY_CTX **.

See also:
R_PKEY_get_info().

#define R_PKEY_INFO_ID_REFERENCE
 

This identifier is used for the retrieval of the reference count associated with the R_PKEY. To retrieve this value the parameter reference should be passed in as cast int *.

See also:
R_PKEY_get_info() and R_PKEY_reference_inc().

#define R_PKEY_INFO_ID_RSA_DMP1
 

This identifier is used for the retrieval of the second RSA exponent associated with the R_PKEY. To retrieve this value the parameter reference should be passed in as cast R_ITEM *.

See also:
R_PKEY_get_info(), R_PKEY_set_info() and R_PKEY_FIELD_ID_RSA_DMP1.

#define R_PKEY_INFO_ID_RSA_DMQ1
 

This identifier is used for the retrieval of the first RSA exponent associated with the R_PKEY. To retrieve this value the parameter reference should be passed in as cast R_ITEM *.

See also:
R_PKEY_get_info(), R_PKEY_set_info() and R_PKEY_FIELD_ID_RSA_DMQ1.

#define R_PKEY_INFO_ID_RSA_EXP
 

This identifier is used for the retrieval of the RSA exponent associated with the R_PKEY. To retrieve this value the parameter reference should be passed in as cast R_ITEM *.

See also:
R_PKEY_get_info(), R_PKEY_set_info() and R_PKEY_FIELD_ID_RSA_EXP.

#define R_PKEY_INFO_ID_RSA_EXP_N  
 

This identifier is used for the retrieval of the nth RSA exponent associated with the R_PKEY. To retrieve this value the parameter reference should be passed in as cast R_ITEM *.

See also:
R_PKEY_get_info(), R_PKEY_set_info() and R_PKEY_FIELD_ID_RSA_EXP_N.

#define R_PKEY_INFO_ID_RSA_INV_N  
 

This identifier is used for the retrieval of the associated RSA inverse associated with the R_PKEY. To retrieve this value the parameter reference should be passed in as cast R_ITEM *.

See also:
R_PKEY_get_info(), R_PKEY_set_info() and R_PKEY_FIELD_ID_RSA_INV_N.

#define R_PKEY_INFO_ID_RSA_IQMP
 

This identifier is used for the retrieval of the second RSA inverse associated with the R_PKEY. To retrieve this value the parameter reference should be passed in as cast R_ITEM *.

See also:
R_PKEY_get_info(), R_PKEY_set_info() and R_PKEY_FIELD_ID_RSA_IQMP.

#define R_PKEY_INFO_ID_RSA_MOD
 

This identifier is used for the retrieval of the RSA modulus associated with the R_PKEY. To retrieve this value the parameter reference should be passed in as cast R_ITEM *.

See also:
R_PKEY_get_info(), R_PKEY_set_info() and R_PKEY_FIELD_ID_RSA_MOD.

#define R_PKEY_INFO_ID_RSA_P
 

This identifier is used for the retrieval of the second RSA prime associated with the R_PKEY. To retrieve this value the parameter reference should be passed in as cast R_ITEM *.

See also:
R_PKEY_get_info(), R_PKEY_set_info() and R_PKEY_FIELD_ID_RSA_P.

#define R_PKEY_INFO_ID_RSA_PRIME_N  
 

This identifier is used for the retrieval of the nth RSA prime associated with the R_PKEY. To retrieve this value the parameter reference should be passed in as cast R_ITEM *.

See also:
R_PKEY_get_info(), R_PKEY_set_info() and R_PKEY_FIELD_ID_RSA_PRIME_N.

#define R_PKEY_INFO_ID_RSA_PRIV_EXP
 

This identifier is used for the retrieval of the RSA private exponent associated with the R_PKEY. To retrieve this value the parameter reference should be passed in as cast R_ITEM *.

See also:
R_PKEY_get_info(), R_PKEY_set_info() and R_PKEY_FIELD_ID_RSA_PRIV_EXP.

#define R_PKEY_INFO_ID_RSA_Q
 

This identifier is used for the retrieval of the first RSA prime associated with the R_PKEY. To retrieve this value the parameter reference should be passed in as cast R_ITEM *.

See also:
R_PKEY_get_info(), R_PKEY_set_info() and R_PKEY_FIELD_ID_RSA_Q.

#define R_PKEY_INFO_ID_RSA_X931_P1
 

This identifier is used for the retrieval of the second RSA X9.31 subprime 1 associated with the R_PKEY. To retrieve this value the parameter reference should be passed in as cast R_ITEM *.

See also:
R_PKEY_get_info(), R_PKEY_set_info() and R_PKEY_FIELD_ID_RSA_P1.

#define R_PKEY_INFO_ID_RSA_X931_P2
 

This identifier is used for the retrieval of the second RSA X9.31 subprime 2 associated with the R_PKEY. To retrieve this value the parameter reference should be passed in as cast R_ITEM *.

See also:
R_PKEY_get_info(), R_PKEY_set_info() and R_PKEY_FIELD_ID_RSA_P2.

#define R_PKEY_INFO_ID_RSA_X931_Q1
 

This identifier is used for the retrieval of the first RSA X9.31 subprime 1 associated with the R_PKEY. To retrieve this value the parameter reference should be passed in as cast R_ITEM *.

See also:
R_PKEY_get_info(), R_PKEY_set_info() and R_PKEY_FIELD_ID_RSA_Q1.

#define R_PKEY_INFO_ID_RSA_X931_Q2
 

This identifier is used for the retrieval of the first RSA X9.31 subprime 2 associated with the R_PKEY. To retrieve this value the parameter reference should be passed in as cast R_ITEM *.

See also:
R_PKEY_get_info(), R_PKEY_set_info() and R_PKEY_FIELD_ID_RSA_Q2.

#define R_PKEY_INFO_ID_SIGN
 

This identifier is a handle for storing the key's signing permission. TRUE if the key supports signatures.

See also:
R_PKEY_get_info().

#define R_PKEY_INFO_ID_TYPE
 

This identifier is used for the retrieval of the R_PKEY_TYPE associated with the R_PKEY. To retrieve this value the parameter reference should be passed in as cast R_PKEY_TYPE *.

See also:
R_PKEY_get_info().

#define R_PKEY_INFO_ID_VERIFY
 

This identifier is a handle for storing the key's verification permission. TRUE if the key supports verification.

See also:
R_PKEY_get_info().


Copyright (c) 1999-2005 RSA Security Inc. All rights reserved. 072-001001-2100-001-000 - 2.1