Expand description
This module is basically a full conversion of the pkcs11f.h C header file.
Type Definitions
C_CancelFunction is a legacy function; it cancels a function running in parallel.C_CloseAllSessions closes all sessions with a token.C_CloseSession closes a session between an application and a token.C_CopyObject copies an object, creating a new object for the copy.C_CreateObject creates a new object.C_Decrypt decrypts encrypted data in a single part.C_DecryptDigestUpdate continues a multiple-part decryption and digesting operation.C_DecryptFinal finishes a multiple-part decryption operation.C_DecryptInit initializes a decryption operation.C_DecryptUpdate continues a multiple-part decryption operation.C_DecryptVerifyUpdate continues a multiple-part decryption and verify operation.C_DeriveKey derives a key from a base key, creating a new key object.C_DestroyObject destroys an object.C_Digest digests data in a single part.C_DigestEncryptUpdate continues a multiple-part digesting and encryption operation.C_DigestFinal finishes a multiple-part message-digesting operation.C_DigestInit initializes a message-digesting operation.C_DigestKey continues a multi-part message-digesting operation, by digesting the value of a secret key as part of the data already digested.C_DigestUpdate continues a multiple-part message-digesting operation.C_Encrypt encrypts single-part data.C_EncryptFinal finishes a multiple-part encryption operationC_EncryptInit initializes an encryption operation.C_EncryptUpdate continues a multiple-part encryption operation.C_Finalize indicates that an application is done with the Cryptoki library.C_FindObjects continues a search for token and session objects that match a template, obtaining additional object handles.C_FindObjectsFinal finishes a search for token and session objects.C_FindObjectsInit initializes a search for token and session objects that match a template.C_GenerateKey generates a secret key, creating a new key object.C_GenerateKeyPair generates a public-key/private-key pair, creating new key objects.C_GenerateRandom generates random data.C_GetAttributeValue obtains the value of one or more object attributes.C_GetFunctionList returns the function list.C_GetFunctionStatus is a legacy function; it obtains an updated status of a function running in parallel with an application.C_GetInfo returns general information about Cryptoki.C_GetMechanismInfo obtains information about a particular mechanism possibly supported by a token.C_GetMechanismList obtains a list of mechanism types supported by a token.C_GetObjectSize gets the size of an object in bytes.C_GetOperationState obtains the state of the cryptographic operation in a session.C_GetSessionInfo obtains information about the session.C_GetSlotInfo obtains information about a particular slot in the system.C_GetSlotList obtains a list of slots in the system.C_GetTokenInfo obtains information about a particular token in the system.C_InitPIN initializes the normal user’s PIN.C_InitToken initializes a token.C_Initialize initializes the Cryptoki library.C_Login logs a user into a token.C_Logout logs a user out from a token.C_OpenSession opens a session between an application and a token.C_SeedRandom mixes additional seed material into the token’s random number generator.C_SetAttributeValue modifies the value of one or more object attributes.C_SetOperationState restores the state of the cryptographic operation in a session.C_SetPIN modifies the PIN of the user who is logged in.C_Sign signs (encrypts with private key) data in a single part, where the signature is (will be) an appendix to the data, and plaintext cannot be recovered from the signature.C_SignEncryptUpdate continues a multiple-part signing and encryption operation.C_SignFinal finishes a multiple-part signature operation, returning the signature.C_SignInit initializes a signature (private key encryption) operation, where the signature is (will be) an appendix to the data, and plaintext cannot be recovered from the signature.C_SignRecover signs data in a single operation, where the data can be recovered from the signature.C_SignRecoverInit initializes a signature operation, where the data can be recovered from the signature.
hSession: the session’s handle
pMechanism: the signature mechanism
hKey: handle of the signature keyC_SignUpdate continues a multiple-part signature operation, where the signature is (will be) an appendix to the data, and plaintext cannot be recovered from the signature.C_UnwrapKey unwraps (decrypts) a wrapped key, creating a new key object.C_Verify verifies a signature in a single-part operation, where the signature is an appendix to the data, and plaintext cannot be recovered from the signature.C_VerifyFinal finishes a multiple-part verification operation, checking the signature.C_VerifyInit initializes a verification operation, where the signature is an appendix to the data, and plaintext cannot cannot be recovered from the signature (e.g. DSA).C_VerifyRecover verifies a signature in a single-part operation, where the data is recovered from the signature.C_VerifyRecoverInit initializes a signature verification operation, where the data is recovered from the signature.C_VerifyUpdate continues a multiple-part verification operation, where the signature is an appendix to the data, and plaintext cannot be recovered from the signature.C_WaitForSlotEvent waits for a slot event (token insertion, removal, etc.) to occur.C_WrapKey wraps (i.e., encrypts) a key.