Cryptoki

java.lang.Object
- com.safenetinc.jcprov.Cryptoki

```
public class Cryptoki
extends java.lang.Object
```
This class is the static interface to SafeNet Inc. implementation of PKCS#11.
The goal of this class is to stay as pure to PKCS#11 as possible whilst incorporating SafeNet Inc. extensions. As such, some functions may not be as java'ised as possible (e.g. functions which take a byte[] as well as a length could really just take a byte[] because the length can be obtained).

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static CK_RV`	`C_CancelFunction(CK_SESSION_HANDLE hSession)` C_CancelFunction is a legacy function; it cancels a function running in parallel.
`static CK_RV`	`C_CloseAllSessions(long slotID)` Close all sessions with a token.
`static CK_RV`	`C_CloseSession(CK_SESSION_HANDLE hSession)` Close a session between an application and a token.
`static CK_RV`	`C_CopyObject(CK_SESSION_HANDLE hSession, CK_OBJECT_HANDLE hObject, CK_ATTRIBUTE[] template, long attributeCount, CK_OBJECT_HANDLE hNewObject)` Copy an object, creating a new object for the copy.
`static CK_RV`	`C_CreateObject(CK_SESSION_HANDLE hSession, CK_ATTRIBUTE[] template, long attributeCount, CK_OBJECT_HANDLE hObject)` Create a new object.
`static CK_RV`	`C_Decrypt(CK_SESSION_HANDLE hSession, byte[] encryptedData, long encryptedDataLen, byte[] data, LongRef dataLen)` Decrypt encrypted data in a single part.
`static CK_RV`	`C_DecryptDigestUpdate(CK_SESSION_HANDLE hSession, byte[] encryptedPart, long encryptedPartLen, byte[] part, LongRef partLen)` Continues a multiple-part decryption and digesting operation.
`static CK_RV`	`C_DecryptFinal(CK_SESSION_HANDLE hSession, byte[] lastPart, LongRef lastPartLen)` Finish a multiple-part decryption operation.
`static CK_RV`	`C_DecryptInit(CK_SESSION_HANDLE hSession, CK_MECHANISM mechanism, CK_OBJECT_HANDLE hKey)` Initialise a decryption operation.
`static CK_RV`	`C_DecryptUpdate(CK_SESSION_HANDLE hSession, byte[] encryptedPart, long encryptedPartLen, byte[] part, LongRef partLen)` Continue a multiple-part decryption operation.
`static CK_RV`	`C_DecryptVerifyUpdate(CK_SESSION_HANDLE hSession, byte[] encryptedPart, long encryptedPartLen, byte[] part, LongRef partLen)` Continue a multiple-part decryption and verify operation.
`static CK_RV`	`C_DeriveKey(CK_SESSION_HANDLE hSession, CK_MECHANISM mechanism, CK_OBJECT_HANDLE hBaseKey, CK_ATTRIBUTE[] template, long attributeCount, CK_OBJECT_HANDLE hKey)` Derive a key from a base key, creating a new key object.
`static CK_RV`	`C_DestroyObject(CK_SESSION_HANDLE hSession, CK_OBJECT_HANDLE hObject)` Destroy an object.
`static CK_RV`	`C_Digest(CK_SESSION_HANDLE hSession, byte[] data, long dataLen, byte[] digest, LongRef digestLen)` Digests data in a single part.
`static CK_RV`	`C_DigestEncryptUpdate(CK_SESSION_HANDLE hSession, byte[] part, long partLen, byte[] encryptedPart, LongRef encryptedPartLen)` Continues a multiple-part digesting and encryption operation.
`static CK_RV`	`C_DigestFinal(CK_SESSION_HANDLE hSession, byte[] digest, LongRef digestLen)` Finish a multiple-part message-digesting operation.
`static CK_RV`	`C_DigestInit(CK_SESSION_HANDLE hSession, CK_MECHANISM mechanism)` Initialise a message-digesting operation.
`static CK_RV`	`C_DigestKey(CK_SESSION_HANDLE hSession, CK_OBJECT_HANDLE hKey)` Continues a multi-part message-digesting operation, by digesting the value of a secret key as part of the data already digested.
`static CK_RV`	`C_DigestUpdate(CK_SESSION_HANDLE hSession, byte[] part, long partLen)` Continue a multiple-part message-digesting operation.
`static CK_RV`	`C_Encrypt(CK_SESSION_HANDLE hSession, byte[] data, long dataLen, byte[] encryptedData, LongRef encryptedDataLen)` Encrypt single-part data.
`static CK_RV`	`C_EncryptFinal(CK_SESSION_HANDLE hSession, byte[] lastEncryptedPart, LongRef lastEncryptedPartLen)` Finish a multiple-part encryption operation.
`static CK_RV`	`C_EncryptInit(CK_SESSION_HANDLE hSession, CK_MECHANISM mechanism, CK_OBJECT_HANDLE hKey)` Initialise an encryption operation.
`static CK_RV`	`C_EncryptUpdate(CK_SESSION_HANDLE hSession, byte[] part, long partLen, byte[] encryptedPart, LongRef encryptedPartLen)` Continue a multiple-part encryption operation.
`static CK_RV`	`C_Finalize(java.lang.Object reserved)` Indicates that an application is done with the Cryptoki library.
`static CK_RV`	`C_FindObjects(CK_SESSION_HANDLE hSession, CK_OBJECT_HANDLE[] hObjects, long maxObjectCount, LongRef objectCount)` Continue the search for token and session objects that match a template, obtaining additional object handles.
`static CK_RV`	`C_FindObjectsFinal(CK_SESSION_HANDLE hSession)` Finish a search for token and session objects.
`static CK_RV`	`C_FindObjectsInit(CK_SESSION_HANDLE hSession, CK_ATTRIBUTE[] template, long attributeCount)` Initialise a search for token and session objects that match a template.
`static CK_RV`	`C_GenerateKey(CK_SESSION_HANDLE hSession, CK_MECHANISM mechanism, CK_ATTRIBUTE[] template, long attributeCount, CK_OBJECT_HANDLE hKey)` Generate a secret key, creating a new key object.
`static CK_RV`	`C_GenerateKeyPair(CK_SESSION_HANDLE hSession, CK_MECHANISM mechanism, CK_ATTRIBUTE[] publicKeyTemplate, long publicKeyAttributeCount, CK_ATTRIBUTE[] privateKeyTemplate, long privateKeyAttributeCount, CK_OBJECT_HANDLE hPublicKey, CK_OBJECT_HANDLE hPrivateKey)` Generate a public-key/private-key pair, creating new key objects.
`static CK_RV`	`C_GenerateRandom(CK_SESSION_HANDLE hSession, byte[] randomData, long randomLen)` Generate random data.
`static CK_RV`	`C_GetAttributeValue(CK_SESSION_HANDLE hSession, CK_OBJECT_HANDLE hObject, CK_ATTRIBUTE[] template, long attributeCount)` Obtain the value of one or more object attributes.
`static CK_RV`	`C_GetFunctionStatus(CK_SESSION_HANDLE hSession)` C_GetFunctionStatus is a legacy function; it obtains an updated status of a function running in parallel with an application.
`static CK_RV`	`C_GetInfo(CK_INFO info)` Retrieve general information about Cryptoki.
`static CK_RV`	`C_GetMechanismInfo(long slotID, CK_MECHANISM_TYPE type, CK_MECHANISM_INFO info)` Obtain information about a particular mechanism possibly supported by a token.
`static CK_RV`	`C_GetMechanismList(long slotID, CK_MECHANISM_TYPE[] mechanismList, LongRef count)` Obtain a list of mechanism types supported by a token.
`static CK_RV`	`C_GetObjectSize(CK_SESSION_HANDLE hSession, CK_OBJECT_HANDLE hObject, LongRef size)` Get the size of an object in bytes.
`static CK_RV`	`C_GetOperationState(CK_SESSION_HANDLE hSession, byte[] operationState, LongRef operationStateLen)` Obtain the state of the cryptographic operation in a session.
`static CK_RV`	`C_GetSessionInfo(CK_SESSION_HANDLE hSession, CK_SESSION_INFO info)` Obtain information about the session.
`static CK_RV`	`C_GetSlotInfo(long slotID, CK_SLOT_INFO info)` Obtain information about a particular slot in the system.
`static CK_RV`	`C_GetSlotList(CK_BBOOL tokenPresent, long[] slotList, LongRef count)` Obtain a list of slots in the system.
`static CK_RV`	`C_GetTokenInfo(long slotID, CK_TOKEN_INFO info)` Obtain information about a particular token in the system.
`static CK_RV`	`C_Initialize(CK_C_INITIALIZE_ARGS initArgs)` Initialise the Cryptoki library.
`static CK_RV`	`C_InitPIN(CK_SESSION_HANDLE hSession, byte[] pin, long pinLen)` Initialise the normal user's PIN.
`static CK_RV`	`C_InitToken(long slotID, byte[] pin, long pinLen, byte[] label)` Initialise a token.
`static CK_RV`	`C_Login(CK_SESSION_HANDLE hSession, CK_USER_TYPE userType, byte[] pin, long pinLen)` Log a user into a token.
`static CK_RV`	`C_Logout(CK_SESSION_HANDLE hSession)` Log a user out from a token.
`static CK_RV`	`C_OpenSession(long slotID, long flags, java.lang.Object pApplication, java.lang.Object notifyUnsupported, CK_SESSION_HANDLE hSession)` Open a session between an application and a token in a particular slot.
`static CK_RV`	`C_SeedRandom(CK_SESSION_HANDLE hSession, byte[] seed, long seedLen)` Mix additional seed material into the token's random number generator.
`static CK_RV`	`C_SetAttributeValue(CK_SESSION_HANDLE hSession, CK_OBJECT_HANDLE hObject, CK_ATTRIBUTE[] template, long attributeCount)` Modify the value of one or more object attributes.
`static CK_RV`	`C_SetOperationState(CK_SESSION_HANDLE hSession, byte[] operationState, long operationStateLen, CK_OBJECT_HANDLE hEncryptionKey, CK_OBJECT_HANDLE hAuthenticationKey)` Restore the state of the cryptographic operation in a session.
`static CK_RV`	`C_SetPIN(CK_SESSION_HANDLE hSession, byte[] oldPin, long oldLen, byte[] newPin, long newLen)` Modify the PIN of the user who is logged in.
`static CK_RV`	`C_Sign(CK_SESSION_HANDLE hSession, byte[] data, long dataLen, byte[] signature, LongRef signatureLen)` Sign (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.
`static CK_RV`	`C_SignEncryptUpdate(CK_SESSION_HANDLE hSession, byte[] part, long partLen, byte[] encryptedPart, LongRef encryptedPartLen)` Continue a multiple-part signing and encryption operation.
`static CK_RV`	`C_SignFinal(CK_SESSION_HANDLE hSession, byte[] signature, LongRef signatureLen)` Finish a multiple-part signature operation, returning the signature.
`static CK_RV`	`C_SignInit(CK_SESSION_HANDLE hSession, CK_MECHANISM mechanism, CK_OBJECT_HANDLE hKey)` Initialise 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.
`static CK_RV`	`C_SignRecover(CK_SESSION_HANDLE hSession, byte[] data, long dataLen, byte[] signature, LongRef signatureLen)` Sign data in a single operation, where the data can be recovered from the signature.
`static CK_RV`	`C_SignRecoverInit(CK_SESSION_HANDLE hSession, CK_MECHANISM mechanism, CK_OBJECT_HANDLE hKey)` C_SignRecoverInit initializes a signature operation, where the data can be recovered from the signature.
`static CK_RV`	`C_SignUpdate(CK_SESSION_HANDLE hSession, byte[] part, long partLen)` Continue a multiple-part signature operation, where the signature is (will be) an appendix to the data, and plaintext cannot be recovered from the signature.
`static CK_RV`	`C_UnwrapKey(CK_SESSION_HANDLE hSession, CK_MECHANISM mechanism, CK_OBJECT_HANDLE hUnwrappingKey, byte[] wrappedKey, long wrappedKeyLen, CK_ATTRIBUTE[] template, long attributeCount, CK_OBJECT_HANDLE hKey)` Unwraps (decrypts) a wrapped key, creating a new key object.
`static CK_RV`	`C_Verify(CK_SESSION_HANDLE hSession, byte[] data, long dataLen, byte[] signature, long signatureLen)` Verify a signature in a single-part operation, where the signature is an appendix to the data, and plaintext cannot be recovered from the signature.
`static CK_RV`	`C_VerifyFinal(CK_SESSION_HANDLE hSession, byte[] signature, long signatureLen)` Finish a multiple-part verification operation, checking the signature.
`static CK_RV`	`C_VerifyInit(CK_SESSION_HANDLE hSession, CK_MECHANISM mechanism, CK_OBJECT_HANDLE hKey)` Initialise a verification operation, where the signature is an appendix to the data, and plaintext cannot cannot be recovered from the signature (e.g.
`static CK_RV`	`C_VerifyRecover(CK_SESSION_HANDLE hSession, byte[] signature, long signatureLen, byte[] data, LongRef dataLen)` Verify a signature in a single-part operation, where the data is recovered from the signature.
`static CK_RV`	`C_VerifyRecoverInit(CK_SESSION_HANDLE hSession, CK_MECHANISM mechanism, CK_OBJECT_HANDLE hKey)` Initialise a signature verification operation, where the data is recovered from the signature.
`static CK_RV`	`C_VerifyUpdate(CK_SESSION_HANDLE hSession, byte[] part, long partLen)` Continue a multiple-part verification operation, where the signature is an appendix to the data, and plaintext cannot be recovered from the signature.
`static CK_RV`	`C_WaitForSlotEvent(long flags, LongRef slot, java.lang.Object reserved)` Wait for a slot event (token insertion, removal, etc.) to occur.
`static CK_RV`	`C_WrapKey(CK_SESSION_HANDLE hSession, CK_MECHANISM mechanism, CK_OBJECT_HANDLE hWrappingKey, CK_OBJECT_HANDLE hKey, byte[] wrappedKey, LongRef wrappedKeyLen)` Wrap (i.e., encrypts) a key.
`static CK_RV`	`CA_CloseApplicationID(long SlotID, long ulHigh, long ulLow)` CA_CloseApplicationID removes the property of an application ID that prevents it from going dormant.
`static CK_RV`	`CA_DeriveKeyAndWrap(CK_SESSION_HANDLE hSession, CK_MECHANISM mechanism, CK_OBJECT_HANDLE hBaseKey, CK_ATTRIBUTE[] template, long attributeCount, CK_MECHANISM mechanismWrap, CK_OBJECT_HANDLE hWrappingKey, byte[] wrappedKey, LongRef wrappedKeyLen)` Derive a key from a base key, return the key bytes.
`static CK_RV`	`CA_GetFirmwareVersion(long slotID, LongRef major, LongRef minor, LongRef subminor)` Obtain full firmware version about a particular token in the system.
`static CK_RV`	`CA_GetHSMPolicySetting(long slotId, HsmPolicy policy, LongRef policyValue)` Retrieve a HSM policy.
`static CK_RV`	`CA_HAAnswerLoginChallenge(CK_SESSION_HANDLE hSession, CK_OBJECT_HANDLE hLoginPrivateKey, byte[] pChallengeBlob, long ulChallengeBlobLen, byte[] pEncryptedPin, LongRef pulEncryptedPinLen)` Accepts the login challenge blob and returns the ecrypted PIN (SO or User)
`static CK_RV`	`CA_HAGetLoginChallenge(CK_SESSION_HANDLE hSession, CK_USER_TYPE userType, byte[] pCertificate, long ulCertificateLen, byte[] pChallengeBlob, LongRef pulChallengeBlobLen)` Accepts the TWC blob and returns the secondary token's login challenge blob.
`static CK_RV`	`CA_HAGetMasterPublic(long slotId, byte[] pCertificate, LongRef pulCertificate)` Retrieves the primary token's Token Wrapping Certificate(TWC) and returns it as a blob (octet string)
`static CK_RV`	`CA_HAInit(CK_SESSION_HANDLE hSession, CK_OBJECT_HANDLE hLoginPrivateKey)` Creates a login key pair on the primary token
`static CK_RV`	`CA_HALogin(CK_SESSION_HANDLE hSession, byte[] pEncryptedPin, long ulEncryptedPinLen, byte[] pMofNBlob, LongRef pulMofNBlobLen)` Accepts the encrypted PIN and logs into the secondary token.
`static CK_RV`	`CA_OpenApplicationID(long SlotID, long ulHigh, long ulLow)` CA_OpenApplicationID forces a given application ID on a given token to remain active, even when all sessions belonging to the application ID have been closed.
`static CK_RV`	`CA_SetApplicationID(long ulHigh, long ulLow)` CA_SetApplicationID allows an application to set its own application ID, rather than letting the application ID be generated automatically from the application's process ID.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - C_Initialize
```
public static CK_RV C_Initialize(CK_C_INITIALIZE_ARGS initArgs)
```
    Initialise the Cryptoki library. This must be the first Cryptoki method called.
    
    Parameters:
    
    initArgs - Optional Cryptoki initialisation arguments. This argument is used to define how multi-threaded access is to be supported.
  - C_Finalize
```
public static CK_RV C_Finalize(java.lang.Object reserved)
```
    Indicates that an application is done with the Cryptoki library. This must be the last Cryptoki method called.
    
    Parameters:
    
    reserved - Must be null.
  - C_GetInfo
```
public static CK_RV C_GetInfo(CK_INFO info)
```
    Retrieve general information about Cryptoki.
    
    Parameters:
    
    info - Location to hold general information retrieved.
  - C_GetSlotList
```
public static CK_RV C_GetSlotList(CK_BBOOL tokenPresent,
                                  long[] slotList,
                                  LongRef count)
```
    Obtain a list of slots in the system.
    SafeNet Inc. Notes :-
    When multiple devices are installed in a single machine, they will appear as a set of consecutive slots. For example, if there are two devices with their default configuration, 4 slots will be visible. the first and third slots will be normal user slots, the second and fouth slots will be the Admin slots for their respective adapters.
    
    Parameters:
    
    tokenPresent - Indicates if only slots with a token present are to be returned.
    
    slotList - Location to hold resulting slot ID list.
    
    count - As input, size of slotList. On return, number of entries copied into slotList.
  - C_GetSlotInfo
```
public static CK_RV C_GetSlotInfo(long slotID,
                                  CK_SLOT_INFO info)
```
    Obtain information about a particular slot in the system.
    
    Parameters:
    
    slotID - ID of the slot to retrieve information about.
    
    info - Location to hold slot information retrieved.
  - C_GetTokenInfo
```
public static CK_RV C_GetTokenInfo(long slotID,
                                   CK_TOKEN_INFO info)
```
    Obtain information about a particular token in the system.
    
    Parameters:
    
    slotID - ID of the slot holding the token to retrieve information about.
    
    info - Location to hold token information retrieved.
  - C_GetMechanismList
```
public static CK_RV C_GetMechanismList(long slotID,
                                       CK_MECHANISM_TYPE[] mechanismList,
                                       LongRef count)
```
    Obtain a list of mechanism types supported by a token.
    SafeNet Inc. Notes :-
    The list of mechanisms may vary at run time depending on Mode settings and other configuration values. For example, the smart card slots do not support any mechanisms.
    
    Parameters:
    
    slotID - ID of the slot containg the token whose mechanism list is to be retrieved.
    
    mechanismList - Location to hold resulting list of mechanism types supported by the token.
    
    count - As input, size of mechanismList. On return, number of entries copied into mechanismList.
  - C_GetMechanismInfo
```
public static CK_RV C_GetMechanismInfo(long slotID,
                                       CK_MECHANISM_TYPE type,
                                       CK_MECHANISM_INFO info)
```
    Obtain information about a particular mechanism possibly supported by a token.
    SafeNet Inc. Notes :-
    Normally this will return CKR.MECHANISM_INVALID if the mechanism type is not recognised, however, if the Entrust Ready Mode is set, the info structure will be cleared and CKR.OK will be returned.
    
    Parameters:
    
    slotID - ID of the slot containing the token of interest.
    
    type - Mechanism type whose information is to be retrieved.
    
    info - Location to hold mechanism information retrieved.
  - C_InitToken
```
public static CK_RV C_InitToken(long slotID,
                                byte[] pin,
                                long pinLen,
                                byte[] label)
```
    Initialise a token.
    SafeNet Inc. Notes :-
    This function is disabled if the No Clear PINs Mode is set - resulting in CKR.ACCESS_DENIED being returned.
    
    Parameters:
    
    slotID - ID of the slot containing the token to be initialised.
    
    pin - SO's initial PIN.
    
    pinLen - Length in bytes of the pin.
    
    label - Label of the token.
  - C_InitPIN
```
public static CK_RV C_InitPIN(CK_SESSION_HANDLE hSession,
                              byte[] pin,
                              long pinLen)
```
    Initialise the normal user's PIN.
    SafeNet Inc. Notes :-
    If the device is in the No Clear PINs Mode, the library protection system will encrypt the sensitive material before presenting it to the adapter.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    pin - Normal user's PIN.
    
    pinLen - Length in bytes of the pin.
  - C_SetPIN
```
public static CK_RV C_SetPIN(CK_SESSION_HANDLE hSession,
                             byte[] oldPin,
                             long oldLen,
                             byte[] newPin,
                             long newLen)
```
    Modify the PIN of the user who is logged in.
    SafeNet Inc. Notes :-
    If the device is in the No Clear PINs Mode, the library protection system will encrypt the sensitive material before presenting it to the adapter.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    oldPin - Old PIN of the user.
    
    oldLen - Length in bytes of oldPin.
    
    newPin - New PIN of the user.
    
    newLen - Length in bytes of newPin.
  - C_OpenSession
```
public static CK_RV C_OpenSession(long slotID,
                                  long flags,
                                  java.lang.Object pApplication,
                                  java.lang.Object notifyUnsupported,
                                  CK_SESSION_HANDLE hSession)
```
    Open a session between an application and a token in a particular slot.
    SafeNet Inc. Notes :-
    Application notification is not supported, as such the pApplication and notifyUnsupported arguments are ignored.
    Also, the CKF.SERIAL_SESSION flag is ignored.
    
    Parameters:
    
    slotID - ID of the slot containing the token to open a session with.
    
    flags - Indicates the type of session.
    
    pApplication - Unsupported - must be null.
    
    notifyUnsupported - Unsupported - must be null.
    
    hSession - Resulting session handle.
  - C_CloseSession
```
public static CK_RV C_CloseSession(CK_SESSION_HANDLE hSession)
```
    Close a session between an application and a token.
    SafeNet Inc. Notes :-
    There is no capability to eject the token from its reader.
    
    Parameters:
    
    hSession - Handle to an open session.
  - C_CloseAllSessions
```
public static CK_RV C_CloseAllSessions(long slotID)
```
    Close all sessions with a token.
    SafeNet Inc. Notes :-
    There is no capability to eject the token from its reader.
    This function will perform a "logout" on each token if necessary.
    
    Parameters:
    
    slotID - ID of the slot containing the token whose sessions are to be closed.
  - C_GetSessionInfo
```
public static CK_RV C_GetSessionInfo(CK_SESSION_HANDLE hSession,
                                     CK_SESSION_INFO info)
```
    Obtain information about the session.
    SafeNet Inc. Notes :-
    Any non-zero ulDeviceError value is cleared by this operation.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    info - Location to hold session information retrieved.
  - C_GetOperationState
```
public static CK_RV C_GetOperationState(CK_SESSION_HANDLE hSession,
                                        byte[] operationState,
                                        LongRef operationStateLen)
```
    Obtain the state of the cryptographic operation in a session.
    SafeNet Inc. Notes :-
    Only the current Message Digest state and Object Search state may be saved and restored.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    operationState - Location to hold resulting operation state information.
    
    operationStateLen - As input, length in bytes of operationState. On return, number of bytes copied into operationState.
  - C_SetOperationState
```
public static CK_RV C_SetOperationState(CK_SESSION_HANDLE hSession,
                                        byte[] operationState,
                                        long operationStateLen,
                                        CK_OBJECT_HANDLE hEncryptionKey,
                                        CK_OBJECT_HANDLE hAuthenticationKey)
```
    Restore the state of the cryptographic operation in a session.
    SafeNet Inc. Notes :-
    Only the current Message Digest state and Object Search state may be saved and restored.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    operationState - Operation state to restore.
    
    operationStateLen - Lenght in bytes of operationState.
    
    hEncryptionKey - Handle to the key to be used for ongoing encryption/decryption operations.
    
    hAuthenticationKey - Handle to the key to be used for ongoing signature/MAC/Verification operations.
  - C_Login
```
public static CK_RV C_Login(CK_SESSION_HANDLE hSession,
                            CK_USER_TYPE userType,
                            byte[] pin,
                            long pinLen)
```
    Log a user into a token.
    SafeNet Inc. Notes :-
    If the device is in the No Clear PINs Mode, the library protection system will encrypt the sensitive material before presenting it to the adapter.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    userType - Type of the user logging in.
    
    pin - User's PIN.
    
    pinLen - Length in bytes of pin.
  - C_Logout
```
public static CK_RV C_Logout(CK_SESSION_HANDLE hSession)
```
    Log a user out from a token.
    
    Parameters:
    
    hSession - Handle to an open session which has a user logged in.
  - C_CreateObject
```
public static CK_RV C_CreateObject(CK_SESSION_HANDLE hSession,
                                   CK_ATTRIBUTE[] template,
                                   long attributeCount,
                                   CK_OBJECT_HANDLE hObject)
```
    Create a new object.
    SafeNet Inc. Notes :-
    If the device is in the No Clear PINs Mode, the library protection system will encrypt the template before presenting it to the adapter.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    template - Template of the object to be created.
    
    attributeCount - Number of attributes in the template.
    
    hObject - Location to receive the new object's handle.
  - C_CopyObject
```
public static CK_RV C_CopyObject(CK_SESSION_HANDLE hSession,
                                 CK_OBJECT_HANDLE hObject,
                                 CK_ATTRIBUTE[] template,
                                 long attributeCount,
                                 CK_OBJECT_HANDLE hNewObject)
```
    Copy an object, creating a new object for the copy.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    hObject - Handle of the object to be copied.
    
    template - Template of the new object.
    
    attributeCount - Number of attributes in the template.
    
    hNewObject - Location to receive the new object's handle.
  - C_DestroyObject
```
public static CK_RV C_DestroyObject(CK_SESSION_HANDLE hSession,
                                    CK_OBJECT_HANDLE hObject)
```
    Destroy an object.
    SafeNet Inc. Notes :-
    If the object has the optional attribute CKA.DELETABLE set to false, the object can not be deleted with this function and CKR.OBJECT_READ_ONLY will be returned.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    hObject - Handle of the object to destroy.
  - C_GetObjectSize
```
public static CK_RV C_GetObjectSize(CK_SESSION_HANDLE hSession,
                                    CK_OBJECT_HANDLE hObject,
                                    LongRef size)
```
    Get the size of an object in bytes.
    SafeNet Inc. Notes :-
    The object size is interpreted as the amount of memory guaranteed to be sufficient to encode the objects attributes.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    hObject - Handle of the objects whose size is to be retrieved.
    
    size - Location to hold the size in bytes of the object.
  - C_GetAttributeValue
```
public static CK_RV C_GetAttributeValue(CK_SESSION_HANDLE hSession,
                                        CK_OBJECT_HANDLE hObject,
                                        CK_ATTRIBUTE[] template,
                                        long attributeCount)
```
    Obtain the value of one or more object attributes.
    SafeNet Inc. Notes :-
    It is possible to enumerate through all attributes for a given object.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    hObject - Handle of the objects whose attributes are to be reteived.
    
    template - Template which specified which attribute values are to be retrieved.
    
    attributeCount - Number of attributes in the template.
  - C_SetAttributeValue
```
public static CK_RV C_SetAttributeValue(CK_SESSION_HANDLE hSession,
                                        CK_OBJECT_HANDLE hObject,
                                        CK_ATTRIBUTE[] template,
                                        long attributeCount)
```
    Modify the value of one or more object attributes.
    SafeNet Inc. Notes :-
    Special processing or access checks may be made if the object is a Hardware Feature.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    hObject - Handle of the object whose attributes are to be modified.
    
    template - Template which specifies which attributes are to be modified and their new values.
    
    attributeCount - Number of attributes in the template.
  - C_FindObjectsInit
```
public static CK_RV C_FindObjectsInit(CK_SESSION_HANDLE hSession,
                                      CK_ATTRIBUTE[] template,
                                      long attributeCount)
```
    Initialise a search for token and session objects that match a template.
    SafeNet Inc. Notes :-
    PKCS#11 states that to match CKO.HW_FEATURE objects this class must be specified in the supplied template. This requirement is not enforced.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    template - Search template which specifies the attribute values to match.
    
    attributeCount - Number of attributes in the template.
  - C_FindObjects
```
public static CK_RV C_FindObjects(CK_SESSION_HANDLE hSession,
                                  CK_OBJECT_HANDLE[] hObjects,
                                  long maxObjectCount,
                                  LongRef objectCount)
```
    Continue the search for token and session objects that match a template, obtaining additional object handles.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    hObjects - Location to hold object handles which match the search criteria.
    
    maxObjectCount - Maximum number of object handles to be returned.
    
    objectCount - Location to hold the actual number of object handles returned.
  - C_FindObjectsFinal
```
public static CK_RV C_FindObjectsFinal(CK_SESSION_HANDLE hSession)
```
    Finish a search for token and session objects.
    
    Parameters:
    
    hSession - Handle to an open session.
  - C_EncryptInit
```
public static CK_RV C_EncryptInit(CK_SESSION_HANDLE hSession,
                                  CK_MECHANISM mechanism,
                                  CK_OBJECT_HANDLE hKey)
```
    Initialise an encryption operation.
    SafeNet Inc. Notes :-
    The session will retain its initialised state even when a C_Encrypt or C_EncryptFinal operation has occured.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    mechanism - The encryption mechanism to initialise.
    
    hKey - Handle of the encryption key.
  - C_Encrypt
```
public static CK_RV C_Encrypt(CK_SESSION_HANDLE hSession,
                              byte[] data,
                              long dataLen,
                              byte[] encryptedData,
                              LongRef encryptedDataLen)
```
    Encrypt single-part data.
    SafeNet Inc. Notes :-
    Symetric cipher operations are terminated by this function.
    C_Encrypt can be used to terminate a multi-part operation.
    This function will terminate the current encryption operation, however the session's encryption state will not be cleared.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    data - The data to encrypt.
    
    dataLen - Length in bytes of the data to encrypt.
    
    encryptedData - Location to receive the resulting cipher text.
    
    encryptedDataLen - As input, length in bytes of the encryptedData buffer. On return, number of bytes copied into encryptedData.
  - C_EncryptUpdate
```
public static CK_RV C_EncryptUpdate(CK_SESSION_HANDLE hSession,
                                    byte[] part,
                                    long partLen,
                                    byte[] encryptedPart,
                                    LongRef encryptedPartLen)
```
    Continue a multiple-part encryption operation.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    part - The next data part to encrypt.
    
    partLen - Length in bytes of part.
    
    encryptedPart - Location to receive the resulting cipher text.
    
    encryptedPartLen - As input, length in bytes of the encryptedPart buffer. On return, number of bytes copied into encryptedPart.
  - C_EncryptFinal
```
public static CK_RV C_EncryptFinal(CK_SESSION_HANDLE hSession,
                                   byte[] lastEncryptedPart,
                                   LongRef lastEncryptedPartLen)
```
    Finish a multiple-part encryption operation.
    SafeNet Inc. Notes :-
    This function will terminate the current encryption operation, however the session's encryption state will not be cleared.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    lastEncryptedPart - Location to recieve the last part of cipher text.
    
    lastEncryptedPartLen - As input, length in bytes of the lastEncryptedPart buffer. On return, number of bytes copied into lastEncryptedPart.
  - C_DecryptInit
```
public static CK_RV C_DecryptInit(CK_SESSION_HANDLE hSession,
                                  CK_MECHANISM mechanism,
                                  CK_OBJECT_HANDLE hKey)
```
    Initialise a decryption operation.
    SafeNet Inc. Notes :-
    The session will retain its initialised state even when a C_Decrypt or C_DecryptFinal operation has occured.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    mechanism - The decryption mechanism to initialise.
    
    hKey - Handle of the decryption key.
  - C_Decrypt
```
public static CK_RV C_Decrypt(CK_SESSION_HANDLE hSession,
                              byte[] encryptedData,
                              long encryptedDataLen,
                              byte[] data,
                              LongRef dataLen)
```
    Decrypt encrypted data in a single part.
    SafeNet Inc. Notes :-
    Symetric cipher operations are terminated by this function.
    This function will terminate the current decryption operation, however the session's decryption state will not be cleared.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    encryptedData - The data to decrypt.
    
    encryptedDataLen - Length in bytes of the data to decrypt.
    
    data - Location to receive the resulting plain text.
    
    dataLen - As input, length in bytes of the data buffer. On return, number of bytes copied into data.
  - C_DecryptUpdate
```
public static CK_RV C_DecryptUpdate(CK_SESSION_HANDLE hSession,
                                    byte[] encryptedPart,
                                    long encryptedPartLen,
                                    byte[] part,
                                    LongRef partLen)
```
    Continue a multiple-part decryption operation.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    encryptedPart - The next data part to decrypt.
    
    encryptedPartLen - Length in bytes of encryptedPart.
    
    part - Location to receive the resulting plain text.
    
    partLen - As input, length in bytes of the part buffer. On return, number of bytes copied into part.
  - C_DecryptFinal
```
public static CK_RV C_DecryptFinal(CK_SESSION_HANDLE hSession,
                                   byte[] lastPart,
                                   LongRef lastPartLen)
```
    Finish a multiple-part decryption operation.
    SafeNet Inc. Notes :-
    This function will terminate the current decryption operation, however the session's decryption state will not be cleared.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    lastPart - Location to recieve the last part of plain text.
    
    lastPartLen - As input, length in bytes of the lastPart buffer. On return, number of bytes copied into lastPart.
  - C_DigestInit
```
public static CK_RV C_DigestInit(CK_SESSION_HANDLE hSession,
                                 CK_MECHANISM mechanism)
```
    Initialise a message-digesting operation.
    SafeNet Inc. Notes :-
    It is not required for the user to be logged in to access this function.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    mechanism - Digesting mechanism.
  - C_Digest
```
public static CK_RV C_Digest(CK_SESSION_HANDLE hSession,
                             byte[] data,
                             long dataLen,
                             byte[] digest,
                             LongRef digestLen)
```
    Digests data in a single part.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    data - The data to digest.
    
    dataLen - Length in bytes of data.
    
    digest - Location of the reuslting message digest.
    
    digestLen - As input, length in bytes of the digest buffer. On return, number of bytes copied into data.
  - C_DigestUpdate
```
public static CK_RV C_DigestUpdate(CK_SESSION_HANDLE hSession,
                                   byte[] part,
                                   long partLen)
```
    Continue a multiple-part message-digesting operation.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    part - The next part of the data to digest.
    
    partLen - Length in bytes of part.
  - C_DigestKey
```
public static CK_RV C_DigestKey(CK_SESSION_HANDLE hSession,
                                CK_OBJECT_HANDLE hKey)
```
    Continues a multi-part message-digesting operation, by digesting the value of a secret key as part of the data already digested.
    SafeNet Inc. Notes :-
    If the CKF.LOGIN_REQUIRED flag is set for the Token associated with the provided session, the session state must be either CKS.RW_USER_FUNCTIONS or CKS.RO_USER_FUNCTIONS, otherwise the error result CKR.USER_NOT_LOGGED_IN will be returned.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    hKey - Handle of the secret key to digest.
  - C_DigestFinal
```
public static CK_RV C_DigestFinal(CK_SESSION_HANDLE hSession,
                                  byte[] digest,
                                  LongRef digestLen)
```
    Finish a multiple-part message-digesting operation.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    digest - Location to receive the message digest.
    
    digestLen - As input, length in bytes of the digest buffer. On return, number of bytes copied into digest.
  - C_SignInit
```
public static CK_RV C_SignInit(CK_SESSION_HANDLE hSession,
                               CK_MECHANISM mechanism,
                               CK_OBJECT_HANDLE hKey)
```
    Initialise 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.
    SafeNet Inc. Notes :-
    It is required to specify the signing key and signing mechanism used to create X509 certificates with the CKM.ENCODE_X_509, CKM.ENCODE_LOCAL_CERT and CKM.ENCODE_PKCS10 mechanisms.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    mechanism - Signature mechanism.
    
    hKey - Handle of the signing key.
  - C_Sign
```
public static CK_RV C_Sign(CK_SESSION_HANDLE hSession,
                           byte[] data,
                           long dataLen,
                           byte[] signature,
                           LongRef signatureLen)
```
    Sign (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.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    data - The data to sign.
    
    dataLen - Length in bytes of data.
    
    signature - Location to hold the resulting signature.
    
    signatureLen - As input, length in bytes of the signature buffer. On return, number of bytes copied into siganture.
  - C_SignUpdate
```
public static CK_RV C_SignUpdate(CK_SESSION_HANDLE hSession,
                                 byte[] part,
                                 long partLen)
```
    Continue a multiple-part signature operation, where the signature is (will be) an appendix to the data, and plaintext cannot be recovered from the signature.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    part - The next part of the data to sign.
    
    partLen - Length in bytes of part.
  - C_SignFinal
```
public static CK_RV C_SignFinal(CK_SESSION_HANDLE hSession,
                                byte[] signature,
                                LongRef signatureLen)
```
    Finish a multiple-part signature operation, returning the signature.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    signature - Location to receive the signature.
    
    signatureLen - As input, length in bytes of the signature buffer. On return, number of bytes copied into signature.
  - C_SignRecoverInit
```
public static CK_RV C_SignRecoverInit(CK_SESSION_HANDLE hSession,
                                      CK_MECHANISM mechanism,
                                      CK_OBJECT_HANDLE hKey)
```
    C_SignRecoverInit initializes a signature operation, where the data can be recovered from the signature.
    SafeNet Inc. Notes :-
    If the CKF.LOGIN_REQUIRED flag is set for the Token associated with the provided session, the session state must be either CKS.RW_USER_FUNCTIONS or CKS.RO_USER_FUNCTIONS, otherwise the error result CKR.USER_NOT_LOGGED_IN will be returned.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    mechanism - Signature mechanism.
    
    hKey - Handle of the signing key.
  - C_SignRecover
```
public static CK_RV C_SignRecover(CK_SESSION_HANDLE hSession,
                                  byte[] data,
                                  long dataLen,
                                  byte[] signature,
                                  LongRef signatureLen)
```
    Sign data in a single operation, where the data can be recovered from the signature.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    data - The data to sign.
    
    dataLen - Length in bytes of data.
    
    signature - Location to receive the resulting signature.
    
    signatureLen - As input, length in bytes of signatrue. On return, number of bytes copied into signature.
  - C_VerifyInit
```
public static CK_RV C_VerifyInit(CK_SESSION_HANDLE hSession,
                                 CK_MECHANISM mechanism,
                                 CK_OBJECT_HANDLE hKey)
```
    Initialise a verification operation, where the signature is an appendix to the data, and plaintext cannot cannot be recovered from the signature (e.g. DSA).
    SafeNet Inc. Notes :-
    If the CKF.LOGIN_REQUIRED flag is set for the Token associated with the provided session, the session state must be either CKS.RW_USER_FUNCTIONS or CKS.RO_USER_FUNCTIONS, otherwise the error result CKR.USER_NOT_LOGGED_IN will be returned.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    mechanism - Verification mechainsm.
    
    hKey - Handle of the verification key.
  - C_Verify
```
public static CK_RV C_Verify(CK_SESSION_HANDLE hSession,
                             byte[] data,
                             long dataLen,
                             byte[] signature,
                             long signatureLen)
```
    Verify a signature in a single-part operation, where the signature is an appendix to the data, and plaintext cannot be recovered from the signature.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    data - The data to verify the signatur of.
    
    dataLen - Length in bytes of data.
    
    signature - Signature to verify.
    
    signatureLen - Length in bytes of signature.
  - C_VerifyUpdate
```
public static CK_RV C_VerifyUpdate(CK_SESSION_HANDLE hSession,
                                   byte[] part,
                                   long partLen)
```
    Continue a multiple-part verification operation, where the signature is an appendix to the data, and plaintext cannot be recovered from the signature.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    part - The next part of the data to verify the signature of.
    
    partLen - Length in bytes of part.
  - C_VerifyFinal
```
public static CK_RV C_VerifyFinal(CK_SESSION_HANDLE hSession,
                                  byte[] signature,
                                  long signatureLen)
```
    Finish a multiple-part verification operation, checking the signature.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    signature - The signature to verify.
    
    signatureLen - Length in bytes of signature.
  - C_VerifyRecoverInit
```
public static CK_RV C_VerifyRecoverInit(CK_SESSION_HANDLE hSession,
                                        CK_MECHANISM mechanism,
                                        CK_OBJECT_HANDLE hKey)
```
    Initialise a signature verification operation, where the data is recovered from the signature.
    SafeNet Inc. Notes :-
    If the CKF.LOGIN_REQUIRED flag is set for the Token associated with the provided session, the session state must be either CKS.RW_USER_FUNCTIONS or CKS.RO_USER_FUNCTIONS, otherwise the error result CKR.USER_NOT_LOGGED_IN will be returned.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    mechanism - Verification mechanism.
    
    hKey - Handle of the verification key.
  - C_VerifyRecover
```
public static CK_RV C_VerifyRecover(CK_SESSION_HANDLE hSession,
                                    byte[] signature,
                                    long signatureLen,
                                    byte[] data,
                                    LongRef dataLen)
```
    Verify a signature in a single-part operation, where the data is recovered from the signature.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    signature - Signature to verify.
    
    signatureLen - Length in bytes of signature.
    
    data - Location to receive the recovered data.
    
    dataLen - As input, length in bytes of the data buffer. On return, number of bytes copied into data.
  - C_DigestEncryptUpdate
```
public static CK_RV C_DigestEncryptUpdate(CK_SESSION_HANDLE hSession,
                                          byte[] part,
                                          long partLen,
                                          byte[] encryptedPart,
                                          LongRef encryptedPartLen)
```
    Continues a multiple-part digesting and encryption operation.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    part - The next part of the data to digest and encrypt.
    
    partLen - Length in bytes of part.
    
    encryptedPart - Location to receive the digested and encrypted data part.
    
    encryptedPartLen - As input, length in bytes of the encryptedPart buffer. On return, number of bytes copied into encryptedPart.
  - C_DecryptDigestUpdate
```
public static CK_RV C_DecryptDigestUpdate(CK_SESSION_HANDLE hSession,
                                          byte[] encryptedPart,
                                          long encryptedPartLen,
                                          byte[] part,
                                          LongRef partLen)
```
    Continues a multiple-part decryption and digesting operation.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    encryptedPart - The next part of data to decrypt and digest.
    
    encryptedPartLen - Length in bytes of encryptedPart.
    
    part - Location to receive the recovered data.
    
    partLen - As input, length in bytes of the part buffer. On return, number of bytes copied into part.
  - C_SignEncryptUpdate
```
public static CK_RV C_SignEncryptUpdate(CK_SESSION_HANDLE hSession,
                                        byte[] part,
                                        long partLen,
                                        byte[] encryptedPart,
                                        LongRef encryptedPartLen)
```
    Continue a multiple-part signing and encryption operation.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    part - The next part of the data to sign and encrypt.
    
    partLen - Length in bytes of part.
    
    encryptedPart - Location to receive the digest and encrypted data part.
    
    encryptedPartLen - As input, length in bytes of the encryptedPart buffer. On return, number of bytes copied into encryptedPart.
  - C_DecryptVerifyUpdate
```
public static CK_RV C_DecryptVerifyUpdate(CK_SESSION_HANDLE hSession,
                                          byte[] encryptedPart,
                                          long encryptedPartLen,
                                          byte[] part,
                                          LongRef partLen)
```
    Continue a multiple-part decryption and verify operation.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    encryptedPart - The next part of the data to decrypt and verify.
    
    encryptedPartLen - Length in bytes of encryptedPart.
    
    part - Location to receive the recovered data.
    
    partLen - As input, length in bytes of the part buffer. On return, number of bytes copied into part.
  - C_GenerateKey
```
public static CK_RV C_GenerateKey(CK_SESSION_HANDLE hSession,
                                  CK_MECHANISM mechanism,
                                  CK_ATTRIBUTE[] template,
                                  long attributeCount,
                                  CK_OBJECT_HANDLE hKey)
```
    Generate a secret key, creating a new key object.
    SafeNet Inc. Notes :-
    If the CKF.LOGIN_REQUIRED flag is set for the Token associated with the provided session, the session state must be either CKS.RW_USER_FUNCTIONS or CKS.RO_USER_FUNCTIONS, otherwise the error result CKR.USER_NOT_LOGGED_IN will be returned.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    mechanism - Key generation mechanism.
    
    template - Template for the new key.
    
    attributeCount - Number of attibibutes in the template.
    
    hKey - Location to receive the new key handle.
  - C_GenerateKeyPair
```
public static CK_RV C_GenerateKeyPair(CK_SESSION_HANDLE hSession,
                                      CK_MECHANISM mechanism,
                                      CK_ATTRIBUTE[] publicKeyTemplate,
                                      long publicKeyAttributeCount,
                                      CK_ATTRIBUTE[] privateKeyTemplate,
                                      long privateKeyAttributeCount,
                                      CK_OBJECT_HANDLE hPublicKey,
                                      CK_OBJECT_HANDLE hPrivateKey)
```
    Generate a public-key/private-key pair, creating new key objects.
    SafeNet Inc. Notes :-
    If the CKF.LOGIN_REQUIRED flag is set for the Token associated with the provided session, the session state must be either CKS.RW_USER_FUNCTIONS or CKS.RO_USER_FUNCTIONS, otherwise the error result CKR.USER_NOT_LOGGED_IN will be returned.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    mechanism - Key pair generation mechanism.
    
    publicKeyTemplate - Template for the public key.
    
    publicKeyAttributeCount - Number of attributes in publicKeyTemplate.
    
    privateKeyTemplate - Template for the private key.
    
    privateKeyAttributeCount - Number of attributes in privateKeyTemplate.
    
    hPublicKey - Location to receive the handle to the public key.
    
    hPrivateKey - Location to receive the handle to the private key.
  - C_WrapKey
```
public static CK_RV C_WrapKey(CK_SESSION_HANDLE hSession,
                              CK_MECHANISM mechanism,
                              CK_OBJECT_HANDLE hWrappingKey,
                              CK_OBJECT_HANDLE hKey,
                              byte[] wrappedKey,
                              LongRef wrappedKeyLen)
```
    Wrap (i.e., encrypts) a key.
    SafeNet Inc. Notes :-
    If the CKF.LOGIN_REQUIRED flag is set for the Token associated with the provided session, the session state must be either CKS.RW_USER_FUNCTIONS or CKS.RO_USER_FUNCTIONS, otherwise the error result CKR.USER_NOT_LOGGED_IN will be returned.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    mechanism - Wrapping mechanism.
    
    hWrappingKey - Handle fot he wrapping key.
    
    hKey - Handle of the key to be wrapped.
    
    wrappedKey - Location to receive the wrapped key.
    
    wrappedKeyLen - As input, length in bytes of the wrappedKey buffer. On return, number of bytes copied into wrappedKey.
  - C_UnwrapKey
```
public static CK_RV C_UnwrapKey(CK_SESSION_HANDLE hSession,
                                CK_MECHANISM mechanism,
                                CK_OBJECT_HANDLE hUnwrappingKey,
                                byte[] wrappedKey,
                                long wrappedKeyLen,
                                CK_ATTRIBUTE[] template,
                                long attributeCount,
                                CK_OBJECT_HANDLE hKey)
```
    Unwraps (decrypts) a wrapped key, creating a new key object.
    SafeNet Inc. Notes :-
    If the CKF.LOGIN_REQUIRED flag is set for the Token associated with the provided session, the session state must be either CKS.RW_USER_FUNCTIONS or CKS.RO_USER_FUNCTIONS, otherwise the error result CKR.USER_NOT_LOGGED_IN will be returned.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    mechanism - Unwrapping mechanism.
    
    hUnwrappingKey - Handle to the unwrapping key.
    
    wrappedKey - The wrapped key.
    
    wrappedKeyLen - Length in bytes of wrappedKey.
    
    template - Template for the new key.
    
    attributeCount - Number of attributes in template.
    
    hKey - Location to receive the handle of the recovered key.
  - C_DeriveKey
```
public static CK_RV C_DeriveKey(CK_SESSION_HANDLE hSession,
                                CK_MECHANISM mechanism,
                                CK_OBJECT_HANDLE hBaseKey,
                                CK_ATTRIBUTE[] template,
                                long attributeCount,
                                CK_OBJECT_HANDLE hKey)
```
    Derive a key from a base key, creating a new key object.
    SafeNet Inc. Notes :-
    If the CKF.LOGIN_REQUIRED flag is set for the Token associated with the provided session, the session state must be either CKS.RW_USER_FUNCTIONS or CKS.RO_USER_FUNCTIONS, otherwise the error result CKR.USER_NOT_LOGGED_IN will be returned.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    mechanism - Key derivation mechanism.
    
    hBaseKey - Handle to the base key.
    
    template - Template of the new key.
    
    attributeCount - Number of attributes in template.
    
    hKey - Location to receive the handle of the derived key.
  - C_SeedRandom
```
public static CK_RV C_SeedRandom(CK_SESSION_HANDLE hSession,
                                 byte[] seed,
                                 long seedLen)
```
    Mix additional seed material into the token's random number generator.
    SafeNet Inc. Notes :-
    It is not required to call this function for the adapter as it has a hardware random generation source.
    Also note this function will only operate for those tokens with the CKF.RNG flag set in their CK_TOKEN_INFO flags.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    seed - Seed material.
    
    seedLen - Length in bytes of seed.
  - C_GenerateRandom
```
public static CK_RV C_GenerateRandom(CK_SESSION_HANDLE hSession,
                                     byte[] randomData,
                                     long randomLen)
```
    Generate random data.
    SafeNet Inc. Notes :-
    This function will only operate for those tokens with the CKF.RNG flag set in their CK_TOKEN_INFO flags.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    randomData - Location to receive the radom data.
    
    randomLen - Length in bytes of the random data to be generated.
  - C_GetFunctionStatus
```
public static CK_RV C_GetFunctionStatus(CK_SESSION_HANDLE hSession)
```
    C_GetFunctionStatus is a legacy function; it obtains an updated status of a function running in parallel with an application.
    SafeNet Inc. Notes :-
    This is a legacy function which will simply return the value CKR.FUNCTION_NOT_PARALLEL.
    
    Parameters:
    
    hSession - Handle to an open session.
  - C_CancelFunction
```
public static CK_RV C_CancelFunction(CK_SESSION_HANDLE hSession)
```
    C_CancelFunction is a legacy function; it cancels a function running in parallel.
    SafeNet Inc. Notes :-
    This is a legacy function which will simply return the value CKR.FUNCTION_NOT_PARALLEL.
    
    Parameters:
    
    hSession - Handle to an open session.
  - C_WaitForSlotEvent
```
public static CK_RV C_WaitForSlotEvent(long flags,
                                       LongRef slot,
                                       java.lang.Object reserved)
```
    Wait for a slot event (token insertion, removal, etc.) to occur.
    SafeNet Inc. Notes :-
    There are no events supported by this library.
    
    Parameters:
    
    flags - Specify whether or not the call blocks.
    
    slot - Location to receive the slot ID that the event occured in.
    
    reserved - Must be null.
  - CA_SetApplicationID
```
public static CK_RV CA_SetApplicationID(long ulHigh,
                                        long ulLow)
```
    CA_SetApplicationID allows an application to set its own application ID, rather than letting the application ID be generated automatically from the application's process ID.
    SafeNet Inc. Notes :-
    CA_SetApplicationID should be invoked after C_Initialize but before any session manipulation functions are invoked. If CA_SetApplicationID is invoked after sessions have been opened, results will be unpredictable.
    
    Parameters:
    
    ulHigh - Application major ID
    
    ulLow - Application minor ID
  - CA_OpenApplicationID
```
public static CK_RV CA_OpenApplicationID(long SlotID,
                                         long ulHigh,
                                         long ulLow)
```
    CA_OpenApplicationID forces a given application ID on a given token to remain active, even when all sessions belonging to the application ID have been closed.
    SafeNet Inc. Notes :-
    Normally an application ID on a token goes dormant when the last session that belongs to the application ID is closed. When an application ID goes dormant login state is lost, so when a new session is created within the application ID, it starts in the logged-out state. However, if CA_OpenApplicationID is used the application ID is prevented from going dormant, so login state is maintained even when all sessions for an application ID are closed.
    
    Parameters:
    
    SlotID - ID of the slot to open the application ID on.
    
    ulHigh - Application major ID
    
    ulLow - Application minor ID
  - CA_CloseApplicationID
```
public static CK_RV CA_CloseApplicationID(long SlotID,
                                          long ulHigh,
                                          long ulLow)
```
    CA_CloseApplicationID removes the property of an application ID that prevents it from going dormant.
    SafeNet Inc. Notes :-
    CA_CloseApplicationID also closes any open sessions owned by the given application ID. Thus, when CA_CloseApplicationID returns, all open sessions owned by the given application ID have been closed and the application ID has gone dormant.
    
    Parameters:
    
    SlotID - ID of the slot to close the application ID on.
    
    ulHigh - Application major ID
    
    ulLow - Application minor ID
  - CA_HALogin
```
public static CK_RV CA_HALogin(CK_SESSION_HANDLE hSession,
                               byte[] pEncryptedPin,
                               long ulEncryptedPinLen,
                               byte[] pMofNBlob,
                               LongRef pulMofNBlobLen)
```
    Accepts the encrypted PIN and logs into the secondary token.
    SafeNet Inc. Notes :-
    Called on secondary (target) token. If the secondary token requires M of N authentication, an M of N blob is returned. If no M of N authentication is required, a zero-length blob is returned.
    
    Parameters:
    
    hSession - Handle to session used to call CA_HAGetLoginChallenge
    
    pEncryptedPin - encrypted PIN
    
    ulEncryptedPinLen - length of encrypted PIN buffer
    
    pMofNBlob - buffer to hold M of N blob
    
    pulMofNBlobLen - length of M of N blob
  - CA_HAGetMasterPublic
```
public static CK_RV CA_HAGetMasterPublic(long slotId,
                                         byte[] pCertificate,
                                         LongRef pulCertificate)
```
    Retrieves the primary token's Token Wrapping Certificate(TWC) and returns it as a blob (octet string)
    SafeNet Inc. Notes :-
    Method is called on the primary (source) token
    
    Parameters:
    
    slotId - slot number of the primary token
    
    pCertificate - buffer to hold TWC
    
    pulCertificate - length of returned TWC
  - CA_HAGetLoginChallenge
```
public static CK_RV CA_HAGetLoginChallenge(CK_SESSION_HANDLE hSession,
                                           CK_USER_TYPE userType,
                                           byte[] pCertificate,
                                           long ulCertificateLen,
                                           byte[] pChallengeBlob,
                                           LongRef pulChallengeBlobLen)
```
    Accepts the TWC blob and returns the secondary token's login challenge blob.
    SafeNet Inc. Notes :-
    Method called on secondary (target) token
    
    Parameters:
    
    hSession - Handle to an open session
    
    userType - user type (CKU.SO, CKU.USER)
    
    pCertificate - TWC retrieved from primary token
    
    ulCertificateLen - TWC length
    
    pChallengeBlob - buffer to hold the challenge blob
    
    pulChallengeBlobLen - challenge blob length
  - CA_HAAnswerLoginChallenge
```
public static CK_RV CA_HAAnswerLoginChallenge(CK_SESSION_HANDLE hSession,
                                              CK_OBJECT_HANDLE hLoginPrivateKey,
                                              byte[] pChallengeBlob,
                                              long ulChallengeBlobLen,
                                              byte[] pEncryptedPin,
                                              LongRef pulEncryptedPinLen)
```
    Accepts the login challenge blob and returns the ecrypted PIN (SO or User)
    
    Parameters:
    
    hSession - session of the Login private key owner
    
    hLoginPrivateKey - handle to the login private key
    
    pChallengeBlob - the challenge buffer
    
    ulChallengeBlobLen - length of the challenge buffer
    
    pEncryptedPin - encrypted PIN buffer
    
    pulEncryptedPinLen - length of the encrypted PIN buffer
  - CA_HAInit
```
public static CK_RV CA_HAInit(CK_SESSION_HANDLE hSession,
                              CK_OBJECT_HANDLE hLoginPrivateKey)
```
    Creates a login key pair on the primary token
    
    Parameters:
    
    hSession - logged in session of Login key pair user
    
    hLoginPrivateKey - handle to the Login private key
  - CA_DeriveKeyAndWrap
```
public static CK_RV CA_DeriveKeyAndWrap(CK_SESSION_HANDLE hSession,
                                        CK_MECHANISM mechanism,
                                        CK_OBJECT_HANDLE hBaseKey,
                                        CK_ATTRIBUTE[] template,
                                        long attributeCount,
                                        CK_MECHANISM mechanismWrap,
                                        CK_OBJECT_HANDLE hWrappingKey,
                                        byte[] wrappedKey,
                                        LongRef wrappedKeyLen)
```
    Derive a key from a base key, return the key bytes.
    SafeNet Inc. Notes :-
    If the CKF.LOGIN_REQUIRED flag is set for the Token associated with the provided session, the session state must be either CKS.RW_USER_FUNCTIONS or CKS.RO_USER_FUNCTIONS, otherwise the error result CKR.USER_NOT_LOGGED_IN will be returned.
    
    Parameters:
    
    hSession - Handle to an open session.
    
    mechanism - Key derivation mechanism.
    
    hBaseKey - Handle to the base key.
    
    template - Template of the new key.
    
    attributeCount - Number of attributes in template.
    
    mechanismWrap - Wrapping mechanism.
    
    hWrappingKey - Handle fot he wrapping key.
    
    wrappedKey - Location to receive the wrapped key.
    
    wrappedKeyLen - As input, length in bytes of the wrappedKey buffer. On return, number of bytes copied into wrappedKey.
  - CA_GetHSMPolicySetting
```
public static CK_RV CA_GetHSMPolicySetting(long slotId,
                                           HsmPolicy policy,
                                           LongRef policyValue)
```
    Retrieve a HSM policy.
    
    Parameters:
    
    slotId - The PKCS 11 slot ID
    
    policyId - The HSM policy ID
    
    policyValue - To store the policy value based on the policy ID parameter
  - CA_GetFirmwareVersion
```
public static CK_RV CA_GetFirmwareVersion(long slotID,
                                          LongRef major,
                                          LongRef minor,
                                          LongRef subminor)
```
    Obtain full firmware version about a particular token in the system.
    
    Parameters:
    
    slotID - ID of the slot holding the token to retrieve firmware version.
    
    major - Location to hold firmware major version retrieved.
    
    minor - Location to hold firmware minor version retrieved.
    
    subminor - Location to hold firmware subminor version retrieved.

Class Cryptoki

Method Summary

Methods inherited from class java.lang.Object

Method Detail

C_Initialize

C_Finalize

C_GetInfo

C_GetSlotList

C_GetSlotInfo

C_GetTokenInfo

C_GetMechanismList

C_GetMechanismInfo

C_InitToken

C_InitPIN

C_SetPIN

C_OpenSession

C_CloseSession

C_CloseAllSessions

C_GetSessionInfo

C_GetOperationState

C_SetOperationState

C_Login

C_Logout

C_CreateObject

C_CopyObject

C_DestroyObject

C_GetObjectSize

C_GetAttributeValue

C_SetAttributeValue

C_FindObjectsInit

C_FindObjects

C_FindObjectsFinal

C_EncryptInit

C_Encrypt

C_EncryptUpdate

C_EncryptFinal

C_DecryptInit

C_Decrypt

C_DecryptUpdate

C_DecryptFinal

C_DigestInit

C_Digest

C_DigestUpdate

C_DigestKey

C_DigestFinal

C_SignInit

C_Sign

C_SignUpdate

C_SignFinal

C_SignRecoverInit

C_SignRecover

C_VerifyInit

C_Verify

C_VerifyUpdate

C_VerifyFinal

C_VerifyRecoverInit

C_VerifyRecover

C_DigestEncryptUpdate

C_DecryptDigestUpdate

C_SignEncryptUpdate

C_DecryptVerifyUpdate

C_GenerateKey

C_GenerateKeyPair

C_WrapKey

C_UnwrapKey

C_DeriveKey

C_SeedRandom

C_GenerateRandom

C_GetFunctionStatus

C_CancelFunction

C_WaitForSlotEvent

CA_SetApplicationID

CA_OpenApplicationID

CA_CloseApplicationID

CA_HALogin

CA_HAGetMasterPublic

CA_HAGetLoginChallenge

CA_HAAnswerLoginChallenge

CA_HAInit

CA_DeriveKeyAndWrap