/* pkcs11f.h include file for PKCS #11. */
/* $Revision: 1.4 $ */
/* License to copy and use this software is granted provided that it is
* identified as "RSA Security Inc. PKCS #11 Cryptographic Token Interface
* (Cryptoki)" in all material mentioning or referencing this software.
* License is also granted to make and use derivative works provided that
* such works are identified as "derived from the RSA Security Inc. PKCS #11
* Cryptographic Token Interface (Cryptoki)" in all material mentioning or
* referencing the derived work.
* RSA Security Inc. makes no representations concerning either the
* merchantability of this software or the suitability of this software for
* any particular purpose. It is provided "as is" without express or implied
* warranty of any kind.
*/
/* This header file contains pretty much everything about all the */
/* Cryptoki function prototypes. Because this information is */
/* used for more than just declaring function prototypes, the */
/* order of the functions appearing herein is important, and */
/* should not be altered. */
/* General-purpose */
/* C_Initialize initializes the Cryptoki library. */
#ifdef CK_NEED_ARG_LIST
(
* cast to CK_C_INITIALIZE_ARGS_PTR
* and dereferenced */
);
#endif
/* C_Finalize indicates that an application is done with the
* Cryptoki library. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_GetInfo returns general information about Cryptoki. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_GetFunctionList returns the function list. */
#ifdef CK_NEED_ARG_LIST
(
* function list */
);
#endif
/* Slot and token management */
/* C_GetSlotList obtains a list of slots in the system. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_GetSlotInfo obtains information about a particular slot in
* the system. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_GetTokenInfo obtains information about a particular token
* in the system. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_GetMechanismList obtains a list of mechanism types
* supported by a token. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_GetMechanismInfo obtains information about a particular
* mechanism possibly supported by a token. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_InitToken initializes a token. */
#ifdef CK_NEED_ARG_LIST
/* pLabel changed from CK_CHAR_PTR to CK_UTF8CHAR_PTR for v2.10 */
(
);
#endif
/* C_InitPIN initializes the normal user's PIN. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_SetPIN modifies the PIN of the user who is logged in. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* Session management */
/* C_OpenSession opens a session between an application and a
* token. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_CloseSession closes a session between an application and a
* token. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_CloseAllSessions closes all sessions with a token. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_GetSessionInfo obtains information about the session. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_GetOperationState obtains the state of the cryptographic operation
* in a session. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_SetOperationState restores the state of the cryptographic
* operation in a session. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_Login logs a user into a token. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_Logout logs a user out from a token. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* Object management */
/* C_CreateObject creates a new object. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_CopyObject copies an object, creating a new object for the
* copy. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_DestroyObject destroys an object. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_GetObjectSize gets the size of an object in bytes. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_GetAttributeValue obtains the value of one or more object
* attributes. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_SetAttributeValue modifies the value of one or more object
* attributes */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_FindObjectsInit initializes a search for token and session
* objects that match a template. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_FindObjects continues a search for token and session
* objects that match a template, obtaining additional object
* handles. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_FindObjectsFinal finishes a search for token and session
* objects. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* Encryption and decryption */
/* C_EncryptInit initializes an encryption operation. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_Encrypt encrypts single-part data. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_EncryptUpdate continues a multiple-part encryption
* operation. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_EncryptFinal finishes a multiple-part encryption
* operation. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_DecryptInit initializes a decryption operation. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_Decrypt decrypts encrypted data in a single part. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_DecryptUpdate continues a multiple-part decryption
* operation. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_DecryptFinal finishes a multiple-part decryption
* operation. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* Message digesting */
/* C_DigestInit initializes a message-digesting operation. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_Digest digests data in a single part. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_DigestUpdate continues a multiple-part message-digesting
* operation. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_DigestKey continues a multi-part message-digesting
* operation, by digesting the value of a secret key as part of
* the data already digested. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_DigestFinal finishes a multiple-part message-digesting
* operation. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* Signing and MACing */
/* 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. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* 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. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_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. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_SignFinal finishes a multiple-part signature operation,
* returning the signature. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_SignRecoverInit initializes a signature operation, where
* the data can be recovered from the signature. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_SignRecover signs data in a single operation, where the
* data can be recovered from the signature. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* Verifying signatures and MACs */
/* 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). */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* 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. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* 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. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_VerifyFinal finishes a multiple-part verification
* operation, checking the signature. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_VerifyRecoverInit initializes a signature verification
* operation, where the data is recovered from the signature. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_VerifyRecover verifies a signature in a single-part
* operation, where the data is recovered from the signature. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* Dual-function cryptographic operations */
/* C_DigestEncryptUpdate continues a multiple-part digesting
* and encryption operation. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_DecryptDigestUpdate continues a multiple-part decryption and
* digesting operation. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_SignEncryptUpdate continues a multiple-part signing and
* encryption operation. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_DecryptVerifyUpdate continues a multiple-part decryption and
* verify operation. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* Key management */
/* C_GenerateKey generates a secret key, creating a new key
* object. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_GenerateKeyPair generates a public-key/private-key pair,
* creating new key objects. */
#ifdef CK_NEED_ARG_LIST
(
* handle */
* mech. */
* for pub.
* key */
* attrs. */
* for priv.
* key */
* attrs. */
* key
* handle */
* priv. key
* handle */
);
#endif
/* C_WrapKey wraps (i.e., encrypts) a key. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_UnwrapKey unwraps (decrypts) a wrapped key, creating a new
* key object. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_DeriveKey derives a key from a base key, creating a new key
* object. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* Random number generation */
/* C_SeedRandom mixes additional seed material into the token's
* random number generator. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_GenerateRandom generates random data. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* Parallel function management */
/* C_GetFunctionStatus is a legacy function; it obtains an
* updated status of a function running in parallel with an
* application. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* C_CancelFunction is a legacy function; it cancels a function
* running in parallel. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif
/* Functions added in for Cryptoki Version 2.01 or later */
/* C_WaitForSlotEvent waits for a slot event (token insertion,
* removal, etc.) to occur. */
#ifdef CK_NEED_ARG_LIST
(
);
#endif