Cryptographic Token Interface Standard

PKCS#11

---

pkcs11_all.h

Go to the documentation of this file.

/* rewritten */
#define CK_INVALID_HANDLE

#define CK_TRUE 1

#define CK_FALSE 0

#define CK_UNAVAILABLE_INFORMATION (~0UL)

#define CK_EFFECTIVELY_INFINITE 0

#define CKU_SO 0

#define CKU_USER 1

#define CKU_CONTEXT_SPECIFIC 2

#define CKS_RO_PUBLIC_SESSION 0

#define CKS_RO_USER_FUNCTIONS 1

#define CKS_RW_PUBLIC_SESSION 2

#define CKS_RW_USER_FUNCTIONS 3

#define CKS_RW_SO_FUNCTIONS 4

#define TRUE CK_TRUE

#define FALSE CK_FALSE
/* an unsigned 8-bit value */
typedef unsigned char CK_BYTE;
/* an unsigned 8-bit character */
typedef CK_BYTE CK_CHAR;
/* a BYTE-sized Boolean flag */
typedef CK_BYTE CK_BBOOL;
/* an unsigned value, at least 16 bits long */
typedef unsigned short int CK_USHORT;
/* an unsigned value, at least 32 bits long */
typedef unsigned long int CK_ULONG;
/* at least 32 bits, each bit is a Boolean flag */
typedef CK_ULONG CK_FLAGS;


typedef CK_BYTE CK_PTR CK_BYTE_PTR;
typedef CK_CHAR CK_PTR CK_CHAR_PTR;
typedef CK_USHORT CK_PTR CK_USHORT_PTR;
typedef void CK_PTR CK_VOID_PTR;




typedef struct CK_VERSION {
CK_BYTE major;
CK_BYTE minor;
} CK_VERSION;




typedef struct CK_INFO {
CK_VERSION version;
CK_CHAR manufacturerID[32];
CK_FLAGS flags;
} CK_INFO;


typedef enum CK_NOTIFICATION {
CKN_SURRENDER,
CKN_COMPLETE,
CKN_DEVICE_REMOVED
} CK_NOTIFICATION;


typedef CK_ULONG CK_SLOT_ID;




typedef struct CK_SLOT_INFO {
CK_CHAR slotDescription[64];
CK_CHAR manufacturerID[32];
CK_FLAGS flags;
} CK_SLOT_INFO;


#define CKF_TOKEN_PRESENT 0x0001

#define CKF_REMOVABLE_DEVICE 0x0002

#define CKF_HW_SLOT 0x0004



typedef struct CK_TOKEN_INFO {
CK_CHAR label[32];
CK_CHAR manufacturerID[32];
CK_CHAR model[16];
CK_CHAR serialNumber[16];
CK_FLAGS flags;
CK_USHORT usMaxSessionCount;
CK_USHORT usSessionCount;
CK_USHORT usMaxRwSessionCount;
CK_USHORT usRwSessionCount;
CK_USHORT usMaxPinLen;
CK_USHORT usMinPinLen;
CK_ULONG ulTotalPublicMemory;
CK_ULONG ulFreePublicMemory;
CK_ULONG ulTotalPrivateMemory;
CK_ULONG ulFreePrivateMemory;
} CK_TOKEN_INFO;


#define CKF_RNG 0x0001

#define CKF_WRITE_PROTECTED 0x0002

#define CKF_LOGIN_REQUIRED 0x0004

#define CKF_USER_PIN_INITIALIZED 0x0008

#define CKF_EXCLUSIVE_EXISTS 0x0010

typedef CK_ULONG CK_SESSION_HANDLE;


typedef enum CK_USER_TYPE {
CKU_SO, /* Security Officer */
CKU_USER /* Normal user */
} CK_USER_TYPE;


typedef enum CK_STATE {
CKS_RW_PUBLIC_SESSION,
CKS_RW_USER_FUNCTIONS,
CKS_RO_PUBLIC_SESSION,
CKS_RO_SO_FUNCTIONS,
CKS_RO_USER_FUNCTIONS
} CK_STATE;




typedef struct CK_SESSION_INFO {
CK_SLOT_ID slotID;
CK_STATE state;
CK_FLAGS flags;
CK_USHORT usDeviceError;
} CK_SESSION_INFO;


#define CKF_EXCLUSIVE_SESSION 0x0001

#define CKF_RW_SESSION 0x0002

#define CKF_SERIAL_SESSION 0x0004

typedef CK_ULONG CK_OBJECT_HANDLE;


typedef CK_USHORT CK_OBJECT_CLASS;


typedef CK_USHORT CK_KEY_TYPE;


typedef CK_USHORT CK_CERTIFICATE_TYPE;


typedef CK_USHORT CK_ATTRIBUTE_TYPE;




typedef struct CK_ATTRIBUTE {
CK_ATTRIBUTE_TYPE type;
CK_VOID_PTR pValue;
CK_USHORT usValueLen;
} CK_ATTRIBUTE;




typedef struct CK_DATE{
CK_CHAR year[4];
CK_CHAR month[2];
CK_CHAR day[2];
} CK_DATE;


typedef CK_USHORT CK_MECHANISM_TYPE;




typedef struct CK_MECHANISM {
CK_MECHANISM_TYPE mechanism;
CK_VOID_PTR pParameter;
CK_USHORT usParameterLen;
} CK_MECHANISM;




typedef struct CK_MECHANISM_INFO {
CK_ULONG ulMinKeySize;
CK_ULONG ulMaxKeySize;
CK_FLAGS flags;
} CK_MECHANISM_INFO;


#define CKF_HW 0x0001

#define CKF_EXTENSION 0x8000



typedef struct CK_RC2_CBC_PARAMS {
CK_USHORT usEffectiveBits;
CK_BYTE iv[8];
} CK_RC2_CBC;


typedef CK_USHORT CK_RV;


#define CKA_CLASS 

#define CKA_TOKEN 

#define CKA_PRIVATE 

#define CKA_LABEL 

#define CKA_APPLICATION 

#define CKA_VALUE 



#define CKA_CERTIFICATE_TYPE 

#define CKA_SUBJECT 

#define CKA_ID 

#define CKA_ISSUER 

#define CKA_SERIAL_NUMBER 

#define CKA_VALUE 



#define CKA_KEY_TYPE 

#define CKA_ID 

#define CKA_START_DATE 

#define CKA_END_DATE 

#define CKA_DERIVE 

#define CKA_SUBJECT 

#define CKA_ENCRYPT 

#define CKA_VERIFY 

#define CKA_VERIFY_RECOVER 

#define CKA_WRAP 

#define CKA_MODULUS 

#define CKA_MODULUS_BITS 

#define CKA_PUBLIC_EXPONENT 



#define CKA_PRIME 

#define CKA_SUBPRIME 

#define CKA_BASE 

#define CKA_VALUE 



#define CKA_PRIME 

#define CKA_BASE 

#define CKA_VALUE 



#define CKA_SUBJECT 

#define CKA_SENSITIVE 

#define CKA_DECRYPT 

#define CKA_SIGN 

#define CKA_SIGN_RECOVER 

#define CKA_UNWRAP 

#define CKA_MODULUS 

#define CKA_PUBLIC_EXPONENT 

#define CKA_PRIVATE_EXPONENT 

#define CKA_PRIME_1 

#define CKA_PRIME_2 

#define CKA_EXPONENT_1 

#define CKA_EXPONENT_2 

#define CKA_COEFFICIENT 



#define CKA_PRIME 

#define CKA_SUBPRIME 

#define CKA_BASE 

#define CKA_VALUE 



#define CKA_PRIME 

#define CKA_BASE 

#define CKA_VALUE 

#define CKA_VALUE_BITS 



#define CKA_SENSITIVE 

#define CKA_ENCRYPT 

#define CKA_DECRYPT 

#define CKA_SIGN 

#define CKA_VERIFY 

#define CKA_WRAP 

#define CKA_UNWRAP 

#define CKA_VALUE 

#define CKA_VALUE_LEN 



#define CKA_VALUE 

#define CKA_VALUE_LEN 



#define CKA_VALUE 

#define CKA_VALUE_LEN 



#define CKA_VALUE 



#define CKA_VALUE 



#define CKA_VALUE 



CK_RV C_Initialize(
CK_VOID_PTR pReserved
);


CK_RV C_GetInfo(
CK_INFO_PTR pInfo
);


CK_RV C_GetSlotList(
CK_BBOOL tokenPresent,
CK_SLOT_ID_PTR pSlotList,
CK_USHORT_PTR pusCount
);


CK_RV C_GetSlotInfo(
CK_SLOT_ID slotID,
CK_SLOT_INFO_PTR pInfo
);


CK_RV C_GetTokenInfo(
CK_SLOT_ID slotID,
CK_TOKEN_INFO_PTR pInfo
);


CK_RV C_GetMechanismList(
CK_SLOT_ID slotID,
CK_MECHANISM_TYPE_PTR pMechanismList,
CK_USHORT_PTR pusCount
);


CK_RV C_GetMechanismInfo(
CK_SLOT_ID slotID,
CK_MECHANISM_TYPE type,
CK_MECHANISM_INFO_PTR pInfo
);


CK_RV C_InitToken(
CK_SLOT_ID slotID,
CK_CHAR_PTR pPin,
CK_USHORT usPinLen,
CK_CHAR_PTR pLabel
);


CK_RV C_InitPIN(
CK_SESSION_HANDLE hSession,
CK_CHAR_PTR pPin,
CK_USHORT usPinLen
);


CK_RV C_SetPIN(
CK_SESSION_HANDLE hSession,
CK_CHAR_PTR pOldPin,
CK_USHORT usOldLen,
CK_CHAR_PTR pNewPin,
CK_USHORT usNewLen
);


CK_RV C_OpenSession(
CK_SLOT_ID slotID,
CK_FLAGS flags,
CK_VOID_PTR pApplication,
CK_RV (*Notify)(CK_SESSION_HANDLE hSession,
 CK_NOTIFICATION event, CK_VOID_PTR pApplication),
CK_SESSION_HANDLE_PTR phSession
);


CK_RV C_CloseSession(
CK_SESSION_HANDLE hSession
);


CK_RV C_CloseAllSessions(
CK_SLOT_ID slotID
);


CK_RV C_GetSessionInfo(
CK_SESSION_HANDLE hSession,
CK_SESSION_INFO_PTR pInfo
);


CK_RV C_Login(
CK_SESSION_HANDLE hSession,
CK_USER_TYPE userType,
CK_CHAR_PTR pPin,
CK_USHORT usPinLen
);


CK_RV C_Logout(
CK_SESSION_HANDLE hSession
);


CK_RV C_CreateObject(
CK_SESSION_HANDLE hSession,
CK_ATTRIBUTE_PTR pTemplate,
CK_USHORT usCount,
CK_OBJECT_HANDLE_PTR phObject
);


CK_RV C_CopyObject(
CK_SESSION_HANDLE hSession,
CK_OBJECT_HANDLE hObject,
CK_ATTRIBUTE_PTR pTemplate,
CK_USHORT usCount,
CK_OBJECT_HANDLE_PTR phNewObject
);


CK_RV C_DestroyObject(
CK_SESSION_HANDLE hSession,
CK_OBJECT_HANDLE hObject
);


CK_RV C_GetObjectSize(
CK_SESSION_HANDLE hSession,
CK_OBJECT_HANDLE hObject,
CK_USHORT_PTR pusSize
);


CK_RV C_GetAttributeValue(
CK_SESSION_HANDLE hSession,
CK_OBJECT_HANDLE hObject,
CK_ATTRIBUTE_PTR pTemplate,
CK_USHORT usCount
);


CK_RV C_SetAttributeValue(
CK_SESSION_HANDLE hSession,
CK_OBJECT_HANDLE hObject,
CK_ATTRIBUTE_PTR pTemplate,
CK_USHORT usCount
);


CK_RV C_FindObjectsInit(
CK_SESSION_HANDLE hSession,
CK_ATTRIBUTE_PTR pTemplate,
CK_USHORT usCount
);


CK_RV C_FindObjects(
CK_SESSION_HANDLE hSession,
CK_OBJECT_HANDLE_PTR phObject,CK_USHORT usMaxObjectCount,
CK_USHORT_PTR pusObjectCount
);


CK_RV C_EncryptInit(
CK_SESSION_HANDLE hSession,
CK_MECHANISM_PTR pMechanism,
CK_OBJECT_HANDLE hKey
);


CK_RV C_Encrypt(
CK_SESSION_HANDLE hSession,
CK_BYTE_PTR pData,
CK_USHORT usDataLen,
CK_BYTE_PTR pEncryptedData,
CK_USHORT_PTR pusEncryptedDataLen
);


CK_RV C_EncryptUpdate(
CK_SESSION_HANDLE hSession,
CK_BYTE_PTR pPart,
CK_USHORT usPartLen,
CK_BYTE_PTR pEncryptedPart,
CK_USHORT_PTR pusEncryptedPartLen
);


CK_RV C_EncryptFinal(
CK_SESSION_HANDLE hSession,
CK_BYTE_PTR pLastEncryptedPart,
CK_USHORT_PTR pusEncryptedPartLen
);


CK_RV C_DecryptInit(
CK_SESSION_HANDLE hSession,
CK_MECHANISM_PTR pMechanism,
CK_OBJECT_HANDLE hKey
);


CK_RV C_Decrypt(
CK_SESSION_HANDLE hSession,
CK_BYTE_PTR pEncryptedData,
CK_USHORT usEncryptedDataLen,
CK_BYTE_PTR pData,
CK_USHORT_PTR pusDataLen
);


CK_RV C_DecryptUpdate(
CK_SESSION_HANDLE hSession,
CK_BYTE_PTR pEncryptedPart,
CK_USHORT usEncryptedPartLen,
CK_BYTE_PTR pPart,
CK_USHORT_PTR pusPartLen
);


CK_RV C_DecryptFinal(
CK_SESSION_HANDLE hSession,
CK_BYTE_PTR pLastPart,
CK_USHORT_PTR usLastPartLen
);


CK_RV C_DigestInit(
CK_SESSION_HANDLE hSession,
CK_MECHANISM_PTR pMechanism
);


CK_RV C_Digest(
CK_SESSION_HANDLE hSession,
CK_BYTE_PTR pData,
CK_USHORT usDataLen,
CK_BYTE_PTR pDigest,
CK_USHORT_PTR pusDigestLen
);


CK_RV C_DigestUpdate(
CK_SESSION_HANDLE hSession,
CK_BYTE_PTR pPart,
CK_USHORT usPartLen
);


CK_RV C_DigestFinal(
CK_SESSION_HANDLE hSession,
CK_BYTE_PTR pDigest,
CK_USHORT_PTR pusDigestLen
);


CK_RV C_SignInit(
CK_SESSION_HANDLE hSession,
CK_MECHANISM_PTR pMechanism,
CK_OBJECT_HANDLE hKey
);


CK_RV C_Sign(
CK_SESSION_HANDLE hSession,
CK_BYTE_PTR pData,
CK_USHORT usDataLen,
CK_BYTE_PTR pSignature,
CK_USHORT_PTR pusSignatureLen
);


CK_RV C_SignUpdate(
CK_SESSION_HANDLE hSession,
CK_BYTE_PTR pPart,
CK_USHORT usPartLen
);


CK_RV C_SignFinal(
CK_SESSION_HANDLE hSession,
CK_BYTE_PTR pSignature,
CK_USHORT_PTR pusSignatureLen
);


CK_RV C_SignRecoverInit(
CK_SESSION_HANDLE hSession,
CK_MECHANISM_PTR pMechanism,
CK_OBJECT_HANDLE hKey
);


CK_RV C_SignRecover(
CK_SESSION_HANDLE hSession,
CK_BYTE_PTR pData,
CK_USHORT usDataLen,
CK_BYTE_PTR pSignature,
CK_USHORT_PTR pusSignatureLen
);


CK_RV C_VerifyInit(
CK_SESSION_HANDLE hSession,
CK_MECHANISM_PTR pMechanism,
CK_OBJECT_HANDLE hKey
);


CK_RV C_Verify(
CK_SESSION_HANDLE hSession,
CK_BYTE_PTR pData,
CK_USHORT usDataLen,
CK_BYTE_PTR pSignature,
CK_USHORT usSignatureLen
);


CK_RV C_VerifyUpdate(
CK_SESSION_HANDLE hSession,
CK_BYTE_PTR pPart,
CK_USHORT usPartLen
);


CK_RV C_VerifyFinal(
CK_SESSION_HANDLE hSession,
CK_BYTE_PTR pSignature,
CK_USHORT usSignatureLen
);


CK_RV C_VerifyRecoverInit(
CK_SESSION_HANDLE hSession,
CK_MECHANISM_PTR pMechanism,
CK_OBJECT_HANDLE hKey
);


CK_RV C_VerifyRecover(
CK_SESSION_HANDLE hSession,
CK_BYTE_PTR pSignature,
CK_USHORT usSignatureLen,
CK_BYTE_PTR pData,
CK_USHORT_PTR pusDataLen
);


CK_RV C_GenerateKey(
CK_SESSION_HANDLE hSession,
CK_MECHANISM_PTR pMechanism,
CK_ATTRIBUTE_PTR pTemplate,
CK_USHORT usCount,
CK_OBJECT_HANDLE_PTR phKey
);


CK_RV C_GenerateKeyPair(
CK_SESSION_HANDLE hSession,
CK_MECHANISM_PTR pMechanism,
CK_ATTRIBUTE_PTR pPublicKeyTemplate,
CK_USHORT usPublicKeyAttributeCount,
CK_ATTRIBUTE_PTR pPrivateKeyTemplate,
CK_USHORT usPrivateKeyAttributeCount,
CK_OBJECT_HANDLE_PTR phPrivateKey,
CK_OBJECT_HANDLE_PTR phPublicKey
);


CK_RV C_WrapKey(
CK_SESSION_HANDLE hSession,
CK_MECHANISM_PTR pMechanism,
CK_OBJECT_HANDLE hWrappingKey,
CK_OBJECT_HANDLE hKey,
CK_BYTE_PTR pWrappedKey,
CK_USHORT_PTR pusWrappedKeyLen
);


CK_RV C_UnwrapKey(
CK_SESSION_HANDLE hSession,
CK_MECHANISM_PTR pMechanism,
CK_OBJECT_HANDLE hUnwrappingKey,
CK_BYTE_PTR pWrappedKey,
CK_USHORT usWrappedKeyLen,
CK_ATTRIBUTE_PTR pTemplate,
CK_USHORT usAttributeCount,
CK_OBJECT_HANDLE_PTR phKey
);


CK_RV C_DeriveKey(
CK_SESSION_HANDLE hSession,
CK_MECHANISM_PTR pMechanism,
CK_OBJECT_HANDLE hBaseKey,
CK_ATTRIBUTE_PTR pTemplate,
CK_USHORT usAttributeCount,
CK_OBJECT_HANDLE_PTR phKey
);


CK_RV C_SeedRandom(
CK_SESSION_HANDLE hSession,
CK_BYTE_PTR pSeed,
CK_USHORT usSeedLen
);


CK_RV C_GenerateRandom(
CK_SESSION_HANDLE hSession,
CK_BYTE_PTR pRandomData,
CK_USHORT usRandomLen
);


CK_RV C_GetFunctionStatus(
CK_SESSION_HANDLE hSession
);


CK_RV C_CancelFunction(
CK_SESSION_HANDLE hSession
);

---

RSA Security Inc. Public-Key Cryptography Standards - PKCS#11 - v100