fpkcs11f.h

来自「支持SSL v2/v3, TLS, PKCS #5, PKCS #7, PKCS」· C头文件 代码 · 共 954 行 · 第 1/2 页

#endif


/* C_DecryptFinal finishes a multiple-part decryption operation. */
CK_EXTERN _CK_RV CK_FUNC(C_DecryptFinal)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE hSession,       /* the session's handle */
  CK_BYTE_PTR       pLastPart,      /* receives decrypted output */
  CK_ULONG_PTR      pulLastPartLen  /* receives decrypted byte count */
);
#endif



/* Message digesting */

/* C_DigestInit initializes a message-digesting operation. */
CK_EXTERN _CK_RV CK_FUNC(C_DigestInit)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE hSession,   /* the session's handle */
  CK_MECHANISM_PTR  pMechanism  /* the digesting mechanism */
);
#endif


/* C_Digest digests data in a single part. */
CK_EXTERN _CK_RV CK_FUNC(C_Digest)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE hSession,     /* the session's handle */
  CK_BYTE_PTR       pData,        /* data to be digested */
  CK_ULONG          ulDataLen,    /* bytes of data to be digested */
  CK_BYTE_PTR       pDigest,      /* receives the message digest */
  CK_ULONG_PTR      pulDigestLen  /* receives byte length of digest */
);
#endif


/* C_DigestUpdate continues a multiple-part message-digesting operation.
*/
CK_EXTERN _CK_RV CK_FUNC(C_DigestUpdate)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE hSession,  /* the session's handle */
  CK_BYTE_PTR       pPart,     /* data to be digested */
  CK_ULONG          ulPartLen  /* bytes of data to be digested */
);
#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.
 */
CK_EXTERN _CK_RV CK_FUNC(C_DigestKey)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE hSession,  /* the session's handle */
  CK_OBJECT_HANDLE  hKey       /* handle of secret key to digest */
);
#endif


/* C_DigestFinal finishes a multiple-part message-digesting operation.
*/
CK_EXTERN _CK_RV CK_FUNC(C_DigestFinal)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE hSession,     /* the session's handle */
  CK_BYTE_PTR       pDigest,      /* receives the message digest */
  CK_ULONG_PTR      pulDigestLen  /* receives byte count of digest */
);
#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 */
CK_EXTERN _CK_RV CK_FUNC(C_SignInit)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE hSession,    /* the session's handle */
  CK_MECHANISM_PTR  pMechanism,  /* the signature mechanism */
  CK_OBJECT_HANDLE  hKey         /* handle of the signature key */
);
#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 */
CK_EXTERN _CK_RV CK_FUNC(C_Sign)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE hSession,        /* the session's handle */
  CK_BYTE_PTR       pData,           /* the data (digest) to be signed
*/
  CK_ULONG          ulDataLen,       /* count of bytes to be signed */
  CK_BYTE_PTR       pSignature,      /* receives the signature */
  CK_ULONG_PTR      pulSignatureLen  /* receives byte count of signature
*/
);
#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 */
CK_EXTERN _CK_RV CK_FUNC(C_SignUpdate)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE hSession,  /* the session's handle */
  CK_BYTE_PTR       pPart,     /* the data (digest) to be signed */
  CK_ULONG          ulPartLen  /* count of bytes to be signed */
);
#endif


/* C_SignFinal finishes a multiple-part signature operation, 
 * returning the signature. */
CK_EXTERN _CK_RV CK_FUNC(C_SignFinal)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE hSession,        /* the session's handle */
  CK_BYTE_PTR       pSignature,      /* receives the signature */
  CK_ULONG_PTR      pulSignatureLen  /* receives byte count of signature
*/
);
#endif


/* C_SignRecoverInit initializes a signature operation,
 * where the (digest) data can be recovered from the signature. 
 * E.g. encryption with the user's private key */
CK_EXTERN _CK_RV CK_FUNC(C_SignRecoverInit)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE hSession,   /* the session's handle */
  CK_MECHANISM_PTR  pMechanism, /* the signature mechanism */
  CK_OBJECT_HANDLE  hKey        /* handle of the signature key */
);
#endif


/* C_SignRecover signs data in a single operation
 * where the (digest) data can be recovered from the signature. 
 * E.g. encryption with the user's private key */
CK_EXTERN _CK_RV CK_FUNC(C_SignRecover)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE hSession,        /* the session's handle */
  CK_BYTE_PTR       pData,           /* the data (digest) to be signed
*/
  CK_ULONG          ulDataLen,       /* count of bytes to be signed */
  CK_BYTE_PTR       pSignature,      /* receives the signature */
  CK_ULONG_PTR      pulSignatureLen  /* receives byte count of signature
*/
);
#endif



/* Verifying signatures and MACs */

/* C_VerifyInit initializes a verification operation, 
 * where the signature is an appendix to the data, 
 * and plaintext cannot be recovered from the signature (e.g. DSA) */
CK_EXTERN _CK_RV CK_FUNC(C_VerifyInit)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE hSession,    /* the session's handle */
  CK_MECHANISM_PTR  pMechanism,  /* the verification mechanism */
  CK_OBJECT_HANDLE  hKey         /* handle of the verification key */ 
);
#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 */
CK_EXTERN _CK_RV CK_FUNC(C_Verify)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE hSession,       /* the session's handle */
  CK_BYTE_PTR       pData,          /* plaintext data (digest) to
compare */
  CK_ULONG          ulDataLen,      /* length of data (digest) in bytes
*/
  CK_BYTE_PTR       pSignature,     /* the signature to be verified */
  CK_ULONG          ulSignatureLen  /* count of bytes of signature */
);
#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 */
CK_EXTERN _CK_RV CK_FUNC(C_VerifyUpdate)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE hSession,  /* the session's handle */
  CK_BYTE_PTR       pPart,     /* plaintext data (digest) to compare */
  CK_ULONG          ulPartLen  /* length of data (digest) in bytes */
);
#endif


/* C_VerifyFinal finishes a multiple-part verification operation, 
 * checking the signature. */
CK_EXTERN _CK_RV CK_FUNC(C_VerifyFinal)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE hSession,       /* the session's handle */
  CK_BYTE_PTR       pSignature,     /* the signature to be verified */
  CK_ULONG          ulSignatureLen  /* count of bytes of signature */
);
#endif


/* C_VerifyRecoverInit initializes a signature verification operation, 
 * where the data is recovered from the signature. 
 * E.g. Decryption with the user's public key */
CK_EXTERN _CK_RV CK_FUNC(C_VerifyRecoverInit)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE hSession,    /* the session's handle */
  CK_MECHANISM_PTR  pMechanism,  /* the verification mechanism */
  CK_OBJECT_HANDLE  hKey         /* handle of the verification key */
);
#endif


/* C_VerifyRecover verifies a signature in a single-part operation, 
 * where the data is recovered from the signature. 
 * E.g. Decryption with the user's public key */
CK_EXTERN _CK_RV CK_FUNC(C_VerifyRecover)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE hSession,        /* the session's handle */
  CK_BYTE_PTR       pSignature,      /* the signature to be verified */
  CK_ULONG          ulSignatureLen,  /* count of bytes of signature */
  CK_BYTE_PTR       pData,           /* receives decrypted data (digest)
*/
  CK_ULONG_PTR      pulDataLen       /* receives byte count of data */
);
#endif



/* Dual-function cryptographic operations */

/* C_DigestEncryptUpdate continues a multiple-part digesting and
encryption operation. */
CK_EXTERN _CK_RV CK_FUNC(C_DigestEncryptUpdate)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE hSession,            /* the session's handle */
  CK_BYTE_PTR       pPart,               /* the plaintext data */
  CK_ULONG          ulPartLen,           /* bytes of plaintext data */
  CK_BYTE_PTR       pEncryptedPart,      /* receives encrypted data */
  CK_ULONG_PTR      pulEncryptedPartLen  /* receives encrypted byte
count */
);
#endif


/* C_DecryptDigestUpdate continues a multiple-part decryption and
 * digesting operation. */
CK_EXTERN _CK_RV CK_FUNC(C_DecryptDigestUpdate)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE hSession,            /* the session's handle */
  CK_BYTE_PTR       pEncryptedPart,      /* input encrypted data */
  CK_ULONG          ulEncryptedPartLen,  /* count of bytes of input */
  CK_BYTE_PTR       pPart,               /* receives decrypted output */
  CK_ULONG_PTR      pulPartLen           /* receives decrypted byte
count */
);
#endif


/* C_SignEncryptUpdate continues a multiple-part signing and
 * encryption operation. */
CK_EXTERN _CK_RV CK_FUNC(C_SignEncryptUpdate)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE hSession,            /* the session's handle */
  CK_BYTE_PTR       pPart,               /* the plaintext data */
  CK_ULONG          ulPartLen,           /* bytes of plaintext data */
  CK_BYTE_PTR       pEncryptedPart,      /* receives encrypted data */
  CK_ULONG_PTR      pulEncryptedPartLen  /* receives encrypted byte
count */
);
#endif


/* C_DecryptVerifyUpdate continues a multiple-part decryption and
 * verify operation. */
CK_EXTERN _CK_RV CK_FUNC(C_DecryptVerifyUpdate)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE hSession,            /* the session's handle */
  CK_BYTE_PTR       pEncryptedPart,      /* input encrypted data */
  CK_ULONG          ulEncryptedPartLen,  /* count of byes of input */
  CK_BYTE_PTR       pPart,               /* receives decrypted output */
  CK_ULONG_PTR      pulPartLen           /* receives decrypted byte
count */
);
#endif



/* Key management */

/* C_GenerateKey generates a secret key, creating a new key object. */
CK_EXTERN _CK_RV CK_FUNC(C_GenerateKey)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE    hSession,    /* the session's handle */
  CK_MECHANISM_PTR     pMechanism,  /* the key generation mechanism */
  CK_ATTRIBUTE_PTR     pTemplate,   /* template for the new key */
  CK_ULONG             ulCount,     /* number of attributes in template
*/
  CK_OBJECT_HANDLE_PTR phKey        /* receives handle of new key */
);
#endif


/* C_GenerateKeyPair generates a public-key/private-key pair, 
 * creating new key objects. */
CK_EXTERN _CK_RV CK_FUNC(C_GenerateKeyPair)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE    hSession,                    /* the session's
handle */
  CK_MECHANISM_PTR     pMechanism,                  /* the key gen.
mech. */
  CK_ATTRIBUTE_PTR     pPublicKeyTemplate,          /* pub. attr.
template */
  CK_ULONG             ulPublicKeyAttributeCount,   /* # of pub. attrs.
*/
  CK_ATTRIBUTE_PTR     pPrivateKeyTemplate,         /* priv. attr.
template */
  CK_ULONG             ulPrivateKeyAttributeCount,  /* # of priv. attrs.
*/
  CK_OBJECT_HANDLE_PTR phPublicKey,                 /* gets pub. key
handle */
  CK_OBJECT_HANDLE_PTR phPrivateKey                 /* gets priv. key
handle */
);
#endif


/* C_WrapKey wraps (i.e., encrypts) a key. */
CK_EXTERN _CK_RV CK_FUNC(C_WrapKey)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE hSession,        /* the session's handle */
  CK_MECHANISM_PTR  pMechanism,      /* the wrapping mechanism */
  CK_OBJECT_HANDLE  hWrappingKey,    /* handle of the wrapping key */
  CK_OBJECT_HANDLE  hKey,            /* handle of the key to be wrapped
*/
  CK_BYTE_PTR       pWrappedKey,     /* receives the wrapped key */
  CK_ULONG_PTR      pulWrappedKeyLen /* receives byte size of wrapped
key */
);
#endif


/* C_UnwrapKey unwraps (decrypts) a wrapped key, creating a new key
object. */
CK_EXTERN _CK_RV CK_FUNC(C_UnwrapKey)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE    hSession,          /* the session's handle */
  CK_MECHANISM_PTR     pMechanism,        /* the unwrapping mechanism */
  CK_OBJECT_HANDLE     hUnwrappingKey,    /* handle of the unwrapping
key */
  CK_BYTE_PTR          pWrappedKey,       /* the wrapped key */
  CK_ULONG             ulWrappedKeyLen,   /* bytes length of wrapped key
*/
  CK_ATTRIBUTE_PTR     pTemplate,         /* template for the new key */
  CK_ULONG             ulAttributeCount,  /* # of attributes in template
*/
  CK_OBJECT_HANDLE_PTR phKey              /* gets handle of recovered
key */
);
#endif


/* C_DeriveKey derives a key from a base key, creating a new key object.
*/
CK_EXTERN _CK_RV CK_FUNC(C_DeriveKey)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE    hSession,          /* the session's handle */
  CK_MECHANISM_PTR     pMechanism,        /* the key derivation
mechanism */
  CK_OBJECT_HANDLE     hBaseKey,          /* handle of the base key */
  CK_ATTRIBUTE_PTR     pTemplate,         /* template for the new key */
  CK_ULONG             ulAttributeCount,  /* # of attributes in template
*/
  CK_OBJECT_HANDLE_PTR phKey              /* gets handle of derived key
*/
);
#endif



/* Random number generation */

/* C_SeedRandom mixes additional seed material into the token's random
number 
 * generator. */
CK_EXTERN _CK_RV CK_FUNC(C_SeedRandom)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE hSession,  /* the session's handle */
  CK_BYTE_PTR       pSeed,     /* the seed material */
  CK_ULONG          ulSeedLen  /* count of bytes of seed material */
);
#endif


/* C_GenerateRandom generates random data. */
CK_EXTERN _CK_RV CK_FUNC(C_GenerateRandom)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE hSession,    /* the session's handle */
  CK_BYTE_PTR       RandomData,  /* receives the random data */
  CK_ULONG          ulRandomLen  /* number of bytes to be generated */
);
#endif



/* Parallel function management */

/* C_GetFunctionStatus obtains an updated status of a function running 
 * in parallel with an application. */
CK_EXTERN _CK_RV CK_FUNC(C_GetFunctionStatus)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE hSession  /* the session's handle */
);
#endif


/* C_CancelFunction cancels a function running in parallel. */
CK_EXTERN _CK_RV CK_FUNC(C_CancelFunction)
#ifdef CK_NEED_ARG_LIST
(
  CK_SESSION_HANDLE hSession  /* the session's handle */
);
#endif



/* Functions added in for PKCS #11 Version 2.01 or later */

/* C_WaitForSlotEvent waits for a slot event (token insertion,
 * removal, etc.) to occur. */
CK_EXTERN _CK_RV CK_FUNC(C_WaitForSlotEvent)
#ifdef CK_NEED_ARG_LIST
(
  CK_FLAGS flags,        /* blocking/nonblocking flag */
  CK_SLOT_ID_PTR pSlot,  /* location that receives the slot ID */
  CK_VOID_PTR pRserved   /* reserved.  Should be NULL_PTR */
);
#endif