|
FreeRTOS:
PKCS11
PKCS11 Cryptoki Library
|
| Return to main page ↑ |
| Constants | Defined constants of the PKCS #11 library. Libraries may # constants in their headers with special meanings. This page describes the meanings and uses of any constants defined by the PKCS #11 library. Related constants are shown in a single section on this page. |
| Configuration | Configuration settings of the PKCS #11 library. Configuration settings are C pre-processor constants. They can be set with a # in the iot_config.h or by using a compiler option such as -D in gcc. If a configuration setting is not defined, the library will use a "sensible" default value (unless otherwise noted). Because they are compile-time constants, a library must be rebuilt if a configuration setting is changed |
| ▼PKCS #11 Wrapper | Functions of the PKCS #11 Wrapper library. The PKCS #11 Wrapper library consists of the following functions |
| xInitializePKCS11 | Initializes a PKCS #11 session. |
| xGetSlotList | Get a list of available PKCS #11 slots. |
| xInitializePkcs11Token | Initializes a PKCS #11 module and token. |
| xInitializePkcs11Session | Initializes the PKCS #11 module and opens a session. |
| xFindObjectWithLabelAndClass | Searches for an object with a matching label and class provided. |
| vAppendSHA256AlgorithmIdentifierSequence | Appends digest algorithm sequence to SHA-256 hash for RSA signatures. |
| ▼PKCS #11 mbedTLS | Functions of the PKCS #11 mbedTLS implementation library. The PKCS #11 mbedTLS implementation library consists of the following functions |
| C_Initialize | Initializes Cryptoki. |
| C_Finalize | Clean up miscellaneous Cryptoki-associated resources. |
| C_GetFunctionList | Obtains entry points of Cryptoki library functions. |
| C_GetSlotList | Obtains a list of slots in the system. |
| C_GetTokenInfo | Obtains information about a particular token. |
| C_GetMechanismInfo | Obtains information about a particular mechanism. |
| C_InitToken | Initializes a token. This function is not implemented for this port. |
| C_OpenSession | Opens a connection between an application and a particular token or sets up an application callback for token insertion. |
| C_CloseSession | Closes a session. |
| C_Login | Logs into a token. This function is not implemented for this port. |
| C_CreateObject | Creates an object. |
| C_DestroyObject | Destroys an object. |
| C_GetAttributeValue | Obtains an attribute value of an object. |
| C_FindObjectsInit | Initializes an object search operation. |
| C_FindObjects | Initializes an object search operation. |
| C_FindObjectsFinal | Finishes an object search operation. |
| C_DigestInit | Initializes a message-digesting operation. |
| C_DigestUpdate | Continues a multiple-part digesting operation. |
| C_DigestFinal | Finishes a multiple-part digesting operation. |
| C_SignInit | Initializes a signature operation. |
| C_Sign | Signs single-part data. |
| C_VerifyInit | Initializes a verification operation. |
| C_Verify | Verifies a signature on single-part data. |
| C_GenerateKeyPair | Generates a public-key/private-key pair. |
| C_GenerateRandom | Generates random data. |
| ▼PKCS #11 PAL | Functions of the PKCS #11 PAL Layer library. The PKCS #11 PAL Layer library consists of the following functions |
| PKCS11_PAL_SaveObject | Saves an object in non-volatile storage. |
| PKCS11_PAL_DestroyObject | Delete an object from NVM. |
| PKCS11_PAL_FindObject | Translates a PKCS #11 label into an object handle. |
| PKCS11_PAL_GetObjectValue | Gets the value of an object in storage, by handle. |
| PKCS11_PAL_GetObjectValueCleanup | Cleanup after PKCS11_GetObjectValue(). |
| ▼PKCS #11 Utilities | |
| PKI_pkcs11SignatureTombedTLSSignature | Converts and ECDSA P-256 signature from the format provided by PKCS #11 to an ASN.1 formatted signature. |
| PKI_mbedTLSSignatureToPkcs11Signature | Converts an ECDSA P-256 signature from the format provided by mbedTLS to the format expected by PKCS #11. |