pkcs11p6r.h

Go to the documentation of this file.

#ifndef _PKCS11P6R_H_
#define _PKCS11P6R_H_ 1


#ifdef __cplusplus
extern "C" {
#endif

/* [A] The following P6R vendor initialization flags are defined: */
#define CKF_P6R_LOGGINGON 0x80000000UL


/* [B] The following P6R vendor attribute types are defined: */

/* CKA_P6R_GROUP
   Purpose: to allow PKCS 11 objects to be placed into collections
   Data Type: RFC 2279 string                                         
   MUST be specified when object is created with C_CreateObject.
   MUST be specified when object is created with C_GenerateKey or C_GenerateKeyPair. 
 */
#define CKA_P6R_GROUP   0x80001000UL

/* CKA_P6R_EXT1
   Purpose: to allow a user to associate whatever data they want to an object
   Data Type: Byte Array
   Can be created and modified at any time
 */
#define CKA_P6R_EXT1    0x80001002UL

/* CKA_P6R_UUID
   Purpose: every PKCS#11 object is assigned a unique identifier by a token
   Data Type: RFC2279 string
   Read only attribute, created by token
 */
#define CKA_P6R_UUID    0x80001004UL


/* [C] The following P6R vendor methods are defined: */
extern CK_DECLARE_FUNCTION(CK_RV, P6R_GetSlotList)
( 
   CK_ULONG       slotId,        /* input: P6R slot number for 3rd party token */
   CK_BBOOL       tokenPresent,  /* input: same as C_GetSlotList */
   CK_SLOT_ID_PTR pSlotList,     /* output: same as C_GetSlotList */
   CK_ULONG_PTR   pulCount       /* input/output: same as C_GetSlotList */
);


/* P6R_DeleteSlot frees all contents in the token and disables its containing slot */
extern CK_DECLARE_FUNCTION(CK_RV, P6R_DeleteSlot)
(
  CK_SLOT_ID      slotID,    /* input: ID of the token's slot */
  CK_UTF8CHAR_PTR pPin,      /* input: the SO's initial PIN */
  CK_ULONG        ulPinLen   /* input: length in bytes of the PIN */
);


extern CK_DECLARE_FUNCTION(CK_RV, P6R_AddSlot)
(    
  CK_SLOT_ID slotId      /* input: the slot to add from the p6pkcs11.conf file */
);


extern CK_DECLARE_FUNCTION(CK_RV, P6R_GetKMIPClient)
(    
  CK_SESSION_HANDLE hSession,   /* input: the identifier value returned by a call to C_OpenSession() */
  CK_VOID_PTR_PTR   pKMIP       /* output: p6IKMIPClient3 pointer to an active KMIP Client object for an open session for a KMIP token */
);


extern CK_DECLARE_FUNCTION( CK_RV, P6R_Conversions )
( 
  CK_SESSION_HANDLE hSession,       /* input:  the identifier value returned by a call to C_OpenSession() */
  CK_OBJECT_CLASS   objectType,     /* input:  type of PKCS#11 object to convert */
  CK_ULONG          convertCount,   /* input:  number of PKCS#11 object to attempt to convert */
  CK_ULONG          convertCode,    /* input:  type of conversion to perform, currently only "1" supported */
  CK_ULONG_PTR      pConverted      /* output: number of objects successfully converted */
);


// [D] Supported 3rd party token extensions defined
/* Vendor defined user login types
 * Purpose:
 * login type for Utimaco CryptoServer user (used for Admin login)
 */ 
#define CKU_CS_GENERIC              0x83            


extern CK_DECLARE_FUNCTION(CK_RV, Thales_C_LoginBegin)
(
    CK_SESSION_HANDLE hSession, /* the session's handle */
    CK_USER_TYPE      userType, /* the user type */
    CK_ULONG_PTR      pulK, /* cards required to load logical token*/
    CK_ULONG_PTR      pulN /* Number of cards in set */
);

extern CK_DECLARE_FUNCTION(CK_RV, Thales_C_LoginNext)
(
    CK_SESSION_HANDLE hSession, /* the session's handle */
    CK_USER_TYPE      userType, /* the user type*/
    CK_CHAR_PTR       pPin, /* the user's PIN*/
    CK_ULONG          ulPinLen, /* the length of the PIN */
    CK_ULONG_PTR      pulSharesLeft /* Number of shares still needed */
);

extern CK_DECLARE_FUNCTION(CK_RV, Thales_C_LoginEnd)
(
    CK_SESSION_HANDLE hSession, /* the session's handle */
    CK_USER_TYPE      userType /* the user type*/
);


extern CK_DECLARE_FUNCTION(CK_RV, Futurex_C_FX_GetLogFile)( CK_SLOT_ID P6RslotId, CK_RV* pRV, CK_CHAR_PTR szLogFile, CK_LONG* piLen );

extern CK_DECLARE_FUNCTION(CK_LONG, Futurex_C_FX_GetLogMode)( CK_SLOT_ID P6RslotId );

extern CK_DECLARE_FUNCTION(CK_LONG, Futurex_C_FX_GetKeyClarityMode)( CK_SLOT_ID P6RslotId );

extern CK_DECLARE_FUNCTION(void, Futurex_C_FX_MemFree)( CK_SLOT_ID P6RslotId, CK_VOID_PTR pvMem );

extern CK_DECLARE_FUNCTION(CK_CHAR_PTR, Futurex_C_FX_HexEncode)( CK_SLOT_ID P6RslotId, const CK_CHAR_PTR pauclnput, CK_LONG iLen );

extern CK_DECLARE_FUNCTION(CK_CHAR_PTR, Futurex_C_FX_HexDecode)( CK_SLOT_ID P6RslotId, CK_CHAR_PTR pszInput );

extern CK_DECLARE_FUNCTION(void, Futurex_C_FX_FreeTemplate)( CK_SLOT_ID P6RslotId, CK_ATTRIBUTE_PTR ptTemplate, CK_ULONG ulNumAttributes );

extern CK_DECLARE_FUNCTION(void, Futurex_C_FX_SleepMS)( CK_SLOT_ID P6RslotId, CK_ULONG ulSleepTime );

extern CK_DECLARE_FUNCTION(CK_ULONG, Futurex_C_FX_ThreadID)( CK_SLOT_ID P6RslotId );

extern CK_DECLARE_FUNCTION(CK_RV, Futurex_C_FX_ReloadTokenInfo)( CK_SLOT_ID P6RslotId, CK_SLOT_ID ulSlotID );

extern CK_DECLARE_FUNCTION(CK_CHAR_PTR, Futurex_C_FX_GetClassString)( CK_SLOT_ID P6RslotId, CK_OBJECT_CLASS ocClass );

extern CK_DECLARE_FUNCTION(CK_CHAR_PTR, Futurex_C_FX_GetKeyTypeString)( CK_SLOT_ID P6RslotId, CK_KEY_TYPE ktKeyType );

extern CK_DECLARE_FUNCTION(CK_CHAR_PTR, Futurex_C_FX_GetErrorString)( CK_SLOT_ID P6RslotId, CK_RV ckrv );

extern CK_DECLARE_FUNCTION(CK_CHAR_PTR, Futurex_C_FX_GetMechanismString)( CK_SLOT_ID P6RslotId, CK_MECHANISM_TYPE ulMech );

extern CK_DECLARE_FUNCTION(CK_RV, Futurex_C_FX_SendMessageSynch)
(
    CK_SESSION_HANDLE hSession,
    const CK_CHAR_PTR binMessage,
    CK_ULONG          ulMessageLen,
    CK_CHAR_PTR       binResponse,
    CK_ULONG*         pulResponseLen
);

extern CK_DECLARE_FUNCTION(CK_SLOT_ID, Futurex_C_FX_GetObjectSlot)( CK_SLOT_ID P6RslotId, CK_OBJECT_HANDLE hObject );

extern CK_DECLARE_FUNCTION(CK_VOID_PTR, Futurex_C_FX_GenericCreateMutex)( CK_SLOT_ID P6RslotId );

extern CK_DECLARE_FUNCTION(CK_BBOOL, Futurex_C_FX_GenericLockMutex)( CK_SLOT_ID P6RslotId, CK_VOID_PTR pMutex );

extern CK_DECLARE_FUNCTION(CK_BBOOL, Futurex_C_FX_GenericUnlockMutex)( CK_SLOT_ID P6RslotId, CK_VOID_PTR pMutex );

extern CK_DECLARE_FUNCTION(CK_BBOOL, Futurex_C_FX_GenericDestroyMutex)( CK_SLOT_ID P6RslotId, CK_VOID_PTR pMutex );



/* CKK_HPE_AES_NSPWRAPPED
   Purpose: to be used for a CKA_KEY_TYPE attribute indicating an AES key wrapped in the HSM's MFK.
   Data Type: the symmetric key is an ASCII array of bytes.
   The HPE Atalla HSM token is designed to store keys that have been generated by the Atalla HSM.
   These keys are always wrapped when they are outside of the Atalla HSM hardware boundary.  
   This vendor defined key type is to allow AES keys to be imported into the HPE token. 
 */
#define CKK_HPE_AES_NSPWRAPPED   0x88000000UL

/* CKK_HPE_DES_NSPWRAPPED, CKK_HPE_DES2_NSPWRAPPED, CKK_HPE_DES3_NSPWRAPPED
   Purpose: to be used for a CKA_KEY_TYPE attribute indicating a DES key wrapped in the HSM's MFK.
   Data Type: the symmetric key is an ASCII array of bytes.
   The HPE Atalla HSM token is designed to store keys that have been generated by the Atalla HSM.
   These keys are always wrapped when they are outside of the Atalla HSM hardware boundary.  
   This vendor defined key type is to allow DES keys to be imported into the HPE token. 
 */
#define CKK_HPE_DES_NSPWRAPPED   0x88000001UL
#define CKK_HPE_DES2_NSPWRAPPED  0x88000002UL
#define CKK_HPE_DES3_NSPWRAPPED  0x88000003UL

/* CKK_HPE_RSAPUB_NSPWRAPPED (public key),  CKK_HPE_RSAPRV_NSPWRAPPED (private key)
   Purpose: to be used for a CKA_KEY_TYPE attribute indicating a RSA key wrapped in the HSM's MFK.
   Data Type: the symmetric key is an ASCII array of bytes.
   The HPE Atalla HSM token is designed to store keys that have been generated by the Atalla HSM.
   These keys are always wrapped when they are outside of the Atalla HSM hardware boundary.  
   This vendor defined key type is to allow RSA keys to be imported into the HPE token. 
 */
#define CKK_HPE_RSAPUB_NSPWRAPPED   0x88000004UL
#define CKK_HPE_RSAPRV_NSPWRAPPED   0x88000005UL

#define CKR_ATTRIBUTE_MODULUS_WRITE 0x88000001UL

#ifdef __cplusplus
}
#endif

#endif