iaik.pkcs.pkcs11

Class Session

java.lang.Object

iaik.pkcs.pkcs11.Session

public class Session
extends Object

Session objects are used to perform cryptographic operations on a token. The application gets a Session object by calling openSession on a certain Token object. Having the session object, the application may log-in the user, if required.

 
   TokenInfo tokenInfo = token.getTokenInfo();
   // check, if log-in of the user is required at all
   if (tokenInfo.isLoginRequired()) {
     // check, if the token has own means to authenticate the user; e.g. a
     // PIN-pad on the reader
     if (tokenInfo.isProtectedAuthenticationPath()) {
       System.out.println(
               "Please enter the user PIN at the PIN-pad of your reader.");
       // the token prompts the PIN by other means; e.g. PIN-pad
       session.login(Session.UserType.USER, null);
     } else {
       System.out.print("Enter user-PIN and press [return key]: ");
       System.out.flush();
       BufferedReader input = new BufferedReader(
               new InputStreamReader(System.in));
       String userPINString = input.readLine();
       session.login(Session.UserType.USER, userPINString.toCharArray());
     }
   }
 
 

With this session object the application can search for token objects and perform a cryptographic operation. For example, to find private RSA keys that the application can use for signing, you can write:

 
   RSAPrivateKey privateSignatureKeyTemplate = new RSAPrivateKey();
   privateSignatureKeyTemplate.getSign().setBooleanValue(Boolean.TRUE);

   session.findObjectsInit(privateSignatureKeyTemplate);
   PKCS11Object[] privateSignatureKeys;

   List signatureKeyList = new Vector(4);
   while ((privateSignatureKeys = session.findObjects(1)).length > 0) {
     signatureKeyList.add(privateSignatureKeys[0]);
   }
   session.findObjectsFinal();
 
 

Having chosen one of this keys, the application can create a signature value using it.

 
   // e.g. the encoded digest info object that contains an identifier of the
   // hash algorithm and the hash value
   byte[] toBeSigned;

   // toBeSigned = ... assign value

   RSAPrivateKey selectedSignatureKey;

   // selectedSignatureKey = ... assign one of the available signature keys

   // initialize for signing
   session.signInit(Mechanism.RSA_PKCS, selectedSignatureKey);

   // sign the data to be signed
   byte[] signatureValue = session.sign(toBeSigned);
 
 

If the application does not need the session any longer, it should close the session.

 
   session.closeSession();
 
 

Version:

1.0

Author:

Karl Scheibelhofer

See Also:

PKCS11Object, Parameters, Session, SessionInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Session.UserType This interface defines the different user types of PKCS#11.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Session(Token token, long sessionHandle) Constructor taking the token and the session handle.

Method Summary

Modifier and Type	Method and Description
void	closeSession() Closes this session.
PKCS11Object	copyObject(PKCS11Object sourceObject, PKCS11Object templateObject) Copy an existing object.
PKCS11Object	createObject(PKCS11Object templateObject) Create a new object on the token (or in the session).
int	decrypt(byte[] in, int inOfs, int inLen, byte[] out, int outOfs, int outLen) Decrypts the given data with the key and mechanism given to the decryptInit method.
int	decryptFinal(byte[] out, int outOfs, int outLen) This method finalizes a decryption operation and returns the final result.
void	decryptInit(Mechanism mechanism, Key key) Initializes a new decryption operation.
int	decryptUpdate(byte[] in, int inOfs, int inLen, byte[] out, int outOfs, int outLen) This method can be used to decrypt multiple pieces of data; e.g.
Key	deriveKey(Mechanism mechanism, Key baseKey, Key template) Derives a new key from a specified base key using the given mechanism.
void	destroyObject(PKCS11Object object) Destroy a certain object on the token (or in the session).
int	digest(byte[] in, int inOfs, int inLen, byte[] digest, int digestOfs, int digestLen) Digests the given data with the mechanism given to the digestInit method.
int	digestFinal(byte[] digest, int digestOfs, int digestLen) This method finalizes a digesting operation and returns the final result.
void	digestInit(Mechanism mechanism) Initializes a new digesting operation.
void	digestKey(SecretKey key) This method is similar to digestUpdate and can be combined with it during one digesting operation.
int	digestSingle(Mechanism mechanism, byte[] in, int inOfs, int inLen, byte[] digest, int digestOfs, int digestLen) This method digests data in a single part.
void	digestUpdate(byte[] part, int partOfs, int partLen) This method can be used to digest multiple pieces of data; e.g.
int	encrypt(byte[] in, int inOfs, int inLen, byte[] out, int outOfs, int outLen) Encrypts the given data with the key and mechanism given to the encryptInit method.
int	encryptFinal(byte[] out, int outOfs, int outLen) This method finalizes an encryption operation and returns the final result.
void	encryptInit(Mechanism mechanism, Key key) Initializes a new encryption operation.
int	encryptUpdate(byte[] in, int inOfs, int inLen, byte[] out, int outOfs, int outLen) This method can be used to encrypt multiple pieces of data; e.g.
boolean	equals(Object otherObject) Compares the sessionHandle and token of this object with the other object.
PKCS11Object[]	findObjects(int maxObjectCount) Finds objects that match the template object passed to findObjectsInit.
void	findObjectsFinal() Finalizes a find operation.
void	findObjectsInit(PKCS11Object templateObject) Initializes a find operations that provides means to find objects by passing a template object.
PKCS11Object	generateKey(Mechanism mechanism, PKCS11Object template) Generate a new secret key or a set of domain parameters.
KeyPair	generateKeyPair(Mechanism mechanism, PKCS11Object publicKeyTemplate, PKCS11Object privateKeyTemplate) Generate a new public key - private key key-pair and use the set attributes of the template objects for setting the attributes of the new public key and private key objects.
byte[]	generateRandom(int numberOfBytesToGenerate) Generates a certain number of random bytes.
PKCS11Object	getAttributeValues(PKCS11Object objectToRead) Reads all the attributes of the given PKCS11Object from the token and returns a new PKCS11Object that contains all these attributes.
Module	getModule() Get the Module which this Session object operates with.
byte[]	getOperationState() Get the current operation state.
long	getSessionHandle() Get the handle of this session.
SessionInfo	getSessionInfo() Get information about this session.
Token	getToken() Get the token that created this Session object.
int	hashCode() The overriding of this method should ensure that the objects of this class work correctly in a hashtable.
void	login(boolean userType, char[] pin) Logs in the user or the security officer to the session.
void	login(long userType, char[] pin) Logs in the user or the security officer to the session.
void	logout() Logs out this session.
void	seedRandom(byte[] seed) Mixes additional seeding material into the random number generator.
void	setAttributeValues(PKCS11Object objectToUpdate, PKCS11Object templateObject) Gets all present attributes of the given template object an writes them to the object to update on the token (or in the session).
void	setOperationState(byte[] operationState, Key encryptionKey, Key authenticationKey) Sets the operation state of this session to a previously saved one.
void	setSessionHandle(long sessionHandle)
byte[]	sign(byte[] data) Signs the given data with the key and mechanism given to the signInit method.
byte[]	signFinal(int expectedLen) This method finalizes a signing operation and returns the final result.
void	signInit(Mechanism mechanism, Key key) Initializes a new signing operation.
int	signRecover(byte[] in, int inOfs, int inLen, byte[] out, int outOfs, int outLen) Signs the given data with the key and mechanism given to the signRecoverInit method.
void	signRecoverInit(Mechanism mechanism, Key key) Initializes a new signing operation for signing with recovery.
void	signUpdate(byte[] in, int inOfs, int inLen) This method can be used to sign multiple pieces of data; e.g.
String	toString() Returns the string representation of this object.
Key	unwrapKey(Mechanism mechanism, Key unwrappingKey, byte[] wrappedKey, PKCS11Object keyTemplate) Unwraps (decrypts) the given encrypted key with the unwrapping key using the given mechanism.
void	verify(byte[] data, byte[] signature) Verifies the given signature against the given data with the key and mechanism given to the verifyInit method.
void	verifyFinal(byte[] signature) This method finalizes a verification operation.
void	verifyInit(Mechanism mechanism, Key key) Initializes a new verification operation.
int	verifyRecover(byte[] in, int inOfs, int inLen, byte[] out, int outOfs, int outLen) Signs the given data with the key and mechanism given to the signRecoverInit method.
void	verifyRecoverInit(Mechanism mechanism, Key key) Initializes a new verification operation for verification with data recovery.
void	verifyUpdate(byte[] in, int inOfs, int inLen) This method can be used to verify a signature with multiple pieces of data; e.g.
byte[]	wrapKey(Mechanism mechanism, Key wrappingKey, Key key) Wraps (encrypts) the given key with the wrapping key using the given mechanism.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Session

protected Session(Token token,
                  long sessionHandle)

Constructor taking the token and the session handle.

Parameters:

token - The token this session operates with.

sessionHandle - The session handle to perform the operations with.

Method Detail

closeSession

public void closeSession()
                  throws TokenException

Closes this session.

Throws:

TokenException - If closing the session failed.

equals

public boolean equals(Object otherObject)

Compares the sessionHandle and token of this object with the other object. Returns only true, if those are equal in both objects.

Overrides:

equals in class Object

Parameters:

otherObject - The other Session object.

Returns:

True, if other is an instance of Token and the session handles and tokens of both objects are equal. False, otherwise.

hashCode

public int hashCode()

The overriding of this method should ensure that the objects of this class work correctly in a hashtable.

Overrides:

hashCode in class Object

Returns:

The hash code of this object. Gained from the sessionHandle.

getSessionHandle

public long getSessionHandle()

Get the handle of this session.

Returns:

The handle of this session.

getSessionInfo

public SessionInfo getSessionInfo()
                           throws TokenException

Get information about this session.

Returns:

An object providing information about this session.

Throws:

TokenException - If getting the information failed.

getModule

public Module getModule()

Get the Module which this Session object operates with.

Returns:

The module of this session.

getToken

public Token getToken()

Get the token that created this Session object.

Returns:

The token of this session.

getOperationState

public byte[] getOperationState()
                         throws TokenException

Get the current operation state. This state can be used later to restore the operation to exactly this state.

Returns:

The current operation state as a byte array.

Throws:

TokenException - If saving the state fails or is not possible.

See Also:

setOperationState(byte[],Key,Key)

setOperationState

public void setOperationState(byte[] operationState,
                              Key encryptionKey,
                              Key authenticationKey)
                       throws TokenException

Sets the operation state of this session to a previously saved one. This method may need the key used during the saved operation to continue, because it may not be possible to save a key into the state's byte array. Refer to the PKCS#11 standard for details on this function.

Parameters:

operationState - The previously saved state as returned by getOperationState().

encryptionKey - A encryption or decryption key, if a encryption or decryption operation was saved which should be continued, but the keys could not be saved.

authenticationKey - A signing, verification of MAC key, if a signing, verification or MAC operation needs to be restored that could not save the key.

Throws:

TokenException - If restoring the state fails.

See Also:

getOperationState()

setSessionHandle

public void setSessionHandle(long sessionHandle)

login

public void login(boolean userType,
                  char[] pin)
           throws TokenException

Logs in the user or the security officer to the session. Notice that all sessions of a token have the same login state; i.e. if you login the user to one session all other open sessions of this token get user rights.

Parameters:

userType - UserType.SO for the security officer or UserType.USER to login the user.

pin - The PIN. The security officer-PIN or the user-PIN depending on the userType parameter.

Throws:

TokenException - If login fails.

login

public void login(long userType,
                  char[] pin)
           throws TokenException

Logs in the user or the security officer to the session. Notice that all sessions of a token have the same login state; i.e. if you login the user to one session all other open sessions of this token get user rights.

Parameters:

userType - PKCS11Constants.CKU_SO for the security officer or PKCS11Constants.CKU_USER to login the user.

pin - The PIN. The security officer-PIN or the user-PIN depending on the userType parameter.

Throws:

TokenException - If login fails.

logout

public void logout()
            throws TokenException

Logs out this session.

Throws:

TokenException - If logging out the session fails.

createObject

public PKCS11Object createObject(PKCS11Object templateObject)
                          throws TokenException

Create a new object on the token (or in the session). The application must provide a template that holds enough information to create a certain object. For instance, if the application wants to create a new DES key object it creates a new instance of the DESSecretKey class to serve as a template. The application must set all attributes of this new object which are required for the creation of such an object on the token. Then it passes this DESSecretKey object to this method to create the object on the token. Example:

   ValuedSecretKey aesKeyTemplate =
       new ValuedSecretKey(PKCS11Constants.CKK_AES);
   aesKeyTemplate.setValue(myDesKeyValueAs8BytesLongByteArray);
   aesKeyTemplate.setToken(Boolean.TRUE);
   aesKeyTemplate.setPrivate(Boolean.TRUE);
   aesKeyTemplate.setEncrypt(Boolean.TRUE);
   aesKeyTemplate.setDecrypt(Boolean.TRUE);
   ...
   ValuedSecretKey theCreatedAESKeyObject =
           (ValuedSecretKey) userSession.createObject(aesKeyTemplate);
 

Refer to the PKCS#11 standard to find out what attributes must be set for certain types of objects to create them on the token.

Parameters:

templateObject - The template object that holds all values that the new object on the token should contain. (this is not a Object!)

Returns:

A new PKCS#11 PKCS11Object (this is not a Object!) that serves holds all the (readable) attributes of the object on the token. In contrast to the templateObject, this object might have certain attributes set to token-dependent default-values.

Throws:

TokenException - If the creation of the new object fails. If it fails, the no new object was created on the token.

copyObject

public PKCS11Object copyObject(PKCS11Object sourceObject,
                               PKCS11Object templateObject)
                        throws TokenException

Copy an existing object. The source object and a template object are given. Any value set in the template object will override the corresponding value from the source object, when the new object is created. See the PKCS#11 standard for details.

Parameters:

sourceObject - The source object of the copy operation.

templateObject - A template object which's attribute values are used for the new object; i.e. they have higher priority than the attribute values from the source object. May be null; in that case the new object is just a one-to-one copy of the sourceObject.

Returns:

The new object that is created by copying the source object and setting attributes to the values given by the templateObject.

Throws:

TokenException - If copying the object fails for some reason.

setAttributeValues

public void setAttributeValues(PKCS11Object objectToUpdate,
                               PKCS11Object templateObject)
                        throws TokenException

Gets all present attributes of the given template object an writes them to the object to update on the token (or in the session). Both parameters may refer to the same Java object. This is possible, because this method only needs the object handle of the objectToUpdate, and gets the attributes to set from the template. This means, an application can get the object using createObject of findObject, then modify attributes of this Java object and then call this method passing this object as both parameters. This will update the object on the token to the values as modified in the Java object.

Parameters:

objectToUpdate - The attributes of this object get updated.

templateObject - This methods gets all present attributes of this template object and set this attributes at the objectToUpdate.

Throws:

TokenException - If update of the attributes fails. All or no attributes are updated.

getAttributeValues

public PKCS11Object getAttributeValues(PKCS11Object objectToRead)
                                throws TokenException

Reads all the attributes of the given PKCS11Object from the token and returns a new PKCS11Object that contains all these attributes. The given objectToRead and the returned PKCS11Object are different Java objects. This method just uses the object handle of the given object, it does not modify anything in this object.

Parameters:

objectToRead - The object to newly read from the token.

Returns:

A new PKCS11Object holding all attributes that this method just read from the token.

Throws:

TokenException - If reading the attributes fails.

destroyObject

public void destroyObject(PKCS11Object object)
                   throws TokenException

Destroy a certain object on the token (or in the session). Give the object that you want to destroy. This method uses only the internal object handle of the given object to identify the object.

Parameters:

object - The object that should be destroyed.

Throws:

TokenException - If the object could not be destroyed.

findObjectsInit

public void findObjectsInit(PKCS11Object templateObject)
                     throws TokenException

Initializes a find operations that provides means to find objects by passing a template object. This method gets all set attributes of the template object and searches for all objects on the token that match with these attributes.

Parameters:

templateObject - The object that serves as a template for searching. If this object is null, the find operation will find all objects that this session can see. Notice, that only a user session will see private objects.

Throws:

TokenException - If initializing the find operation fails.

findObjects

public PKCS11Object[] findObjects(int maxObjectCount)
                           throws TokenException

Finds objects that match the template object passed to findObjectsInit. The application must call findObjectsInit before calling this method. With maxObjectCount the application can specify how many objects to return at once; i.e. the application can get all found objects by subsequent calls to this method like maxObjectCount(1) until it receives an empty array (this method never returns null!).

Parameters:

maxObjectCount - Specifies how many objects to return with this call.

Returns:

An array of found objects. The maximum size of this array is maxObjectCount, the minimum length is 0. Never returns null.

Throws:

TokenException - A plain TokenException if something during PKCS11 FindObject went wrong, a TokenException with a nested TokenException if the Exception is raised during object parsing.

findObjectsFinal

public void findObjectsFinal()
                      throws TokenException

Finalizes a find operation. The application must call this method to finalize a find operation before attempting to start any other operation.

Throws:

TokenException - If finalizing the current find operation was not possible.

encryptInit

public void encryptInit(Mechanism mechanism,
                        Key key)
                 throws TokenException

Initializes a new encryption operation. The application must call this method before calling any other encrypt* operation. Before initializing a new operation, any currently pending operation must be finalized using the appropriate *Final method (e.g. digestFinal()). There are exceptions for dual-function operations. This method requires the mechanism to use for encryption and the key for this operation. The key must have set its encryption flag. For the mechanism the application may use a constant defined in the Mechanism class. Notice that the key and the mechanism must be compatible; i.e. you cannot use a DES key with the RSA mechanism.

Parameters:

mechanism - The mechanism to use; e.g. Mechanism.DES_CBC.

key - The decryption key to use.

Throws:

TokenException - If initializing this operation failed.

encrypt

public int encrypt(byte[] in,
                   int inOfs,
                   int inLen,
                   byte[] out,
                   int outOfs,
                   int outLen)
            throws TokenException

Encrypts the given data with the key and mechanism given to the encryptInit method. This method finalizes the current encryption operation; i.e. the application need (and should) not call encryptFinal() after this call. For encrypting multiple pieces of data use encryptUpdate and encryptFinal.

Parameters:

in - buffer containing the to-be-encrypted data

inOfs - buffer offset of the to-be-encrypted data

inLen - length of the to-be-encrypted data

out - buffer for the encrypted data

outOfs - buffer offset for the encrypted data

outLen - buffer size for the encrypted data

Returns:

the length of encrypted data

Throws:

TokenException - If encrypting failed.

encryptUpdate

public int encryptUpdate(byte[] in,
                         int inOfs,
                         int inLen,
                         byte[] out,
                         int outOfs,
                         int outLen)
                  throws TokenException

This method can be used to encrypt multiple pieces of data; e.g. buffer-size pieces when reading the data from a stream. Encrypts the given data with the key and mechanism given to the encryptInit method. The application must call encryptFinal to get the final result of the encryption after feeding in all data using this method.

Parameters:

in - buffer containing the to-be-encrypted data

inOfs - buffer offset of the to-be-encrypted data

inLen - length of the to-be-encrypted data

out - buffer for the encrypted data

outOfs - buffer offset for the encrypted data

outLen - buffer size for the encrypted data

Returns:

the length of encrypted data for this update

Throws:

TokenException - If encrypting the data failed.

encryptFinal

public int encryptFinal(byte[] out,
                        int outOfs,
                        int outLen)
                 throws TokenException

This method finalizes an encryption operation and returns the final result. Use this method, if you fed in the data using encryptUpdate. If you used the encrypt(byte[]) method, you need not (and shall not) call this method, because encrypt(byte[]) finalizes the encryption itself.

Parameters:

out - buffer for the encrypted data

outOfs - buffer offset for the encrypted data

outLen - buffer size for the encrypted data

Returns:

the length of the last part of the encrypted data

Throws:

TokenException - If calculating the final result failed.

decryptInit

public void decryptInit(Mechanism mechanism,
                        Key key)
                 throws TokenException

Initializes a new decryption operation. The application must call this method before calling any other decrypt* operation. Before initializing a new operation, any currently pending operation must be finalized using the appropriate *Final method (e.g. digestFinal()). There are exceptions for dual-function operations. This method requires the mechanism to use for decryption and the key for this operation. The key must have set its decryption flag. For the mechanism the application may use a constant defined in the Mechanism class. Notice that the key and the mechanism must be compatible; i.e. you cannot use a DES key with the RSA mechanism.

Parameters:

mechanism - The mechanism to use; e.g. Mechanism.DES_CBC.

key - The decryption key to use.

Throws:

TokenException - If initializing this operation failed.

decrypt

public int decrypt(byte[] in,
                   int inOfs,
                   int inLen,
                   byte[] out,
                   int outOfs,
                   int outLen)
            throws TokenException

Decrypts the given data with the key and mechanism given to the decryptInit method. This method finalizes the current decryption operation; i.e. the application need (and should) not call decryptFinal() after this call. For decrypting multiple pieces of data use decryptUpdate and decryptFinal.

Parameters:

in - buffer containing the to-be-decrypted data

inOfs - buffer offset of the to-be-decrypted data

inLen - length of the to-be-decrypted data

out - buffer for the decrypted data

outOfs - buffer offset for the decrypted data

outLen - buffer size for the decrypted data

Returns:

the length of decrypted data

Throws:

TokenException - If decrypting failed.

decryptUpdate

public int decryptUpdate(byte[] in,
                         int inOfs,
                         int inLen,
                         byte[] out,
                         int outOfs,
                         int outLen)
                  throws TokenException

This method can be used to decrypt multiple pieces of data; e.g. buffer-size pieces when reading the data from a stream. Decrypts the given data with the key and mechanism given to the decryptInit method. The application must call decryptFinal to get the final result of the encryption after feeding in all data using this method.

Parameters:

in - buffer containing the to-be-decrypted data

inOfs - buffer offset of the to-be-decrypted data

inLen - length of the to-be-decrypted data

out - buffer for the decrypted data

outOfs - buffer offset for the decrypted data

outLen - buffer size for the decrypted data

Returns:

the length of decrypted data for this update

Throws:

TokenException - If decrypting the data failed.

decryptFinal

public int decryptFinal(byte[] out,
                        int outOfs,
                        int outLen)
                 throws TokenException

This method finalizes a decryption operation and returns the final result. Use this method, if you fed in the data using decryptUpdate. If you used the decrypt(byte[]) method, you need not (and shall not) call this method, because decrypt(byte[]) finalizes the decryption itself.

Parameters:

out - buffer for the decrypted data

outOfs - buffer offset for the decrypted data

outLen - buffer size for the decrypted data

Returns:

the length of this last part of decrypted data

Throws:

TokenException - If calculating the final result failed.

digestInit

public void digestInit(Mechanism mechanism)
                throws TokenException

Initializes a new digesting operation. The application must call this method before calling any other digest* operation. Before initializing a new operation, any currently pending operation must be finalized using the appropriate *Final method (e.g. digestFinal()). There are exceptions for dual-function operations. This method requires the mechanism to use for digesting for this operation. For the mechanism the application may use a constant defined in the Mechanism class.

Parameters:

mechanism - The mechanism to use; e.g. Mechanism.SHA_1.

Throws:

TokenException - If initializing this operation failed.

digest

public int digest(byte[] in,
                  int inOfs,
                  int inLen,
                  byte[] digest,
                  int digestOfs,
                  int digestLen)
           throws TokenException

Digests the given data with the mechanism given to the digestInit method. This method finalizes the current digesting operation; i.e. the application need (and should) not call digestFinal() after this call. For digesting multiple pieces of data use digestUpdate and digestFinal.

Parameters:

in - buffer containing the to-be-digested data

inOfs - buffer offset of the to-be-digested data

inLen - length of the to-be-digested data

digest - buffer for the digested data

digestOfs - buffer offset for the digested data

digestLen - buffer size for the digested data

Returns:

the length of digested data for this update

Throws:

TokenException - If digesting the data failed.

digestSingle

public int digestSingle(Mechanism mechanism,
                        byte[] in,
                        int inOfs,
                        int inLen,
                        byte[] digest,
                        int digestOfs,
                        int digestLen)
                 throws TokenException

This method digests data in a single part.

Parameters:

mechanism - The mechanism to use; e.g. Mechanism.SHA_1.

in - buffer containing the to-be-digested data

inOfs - buffer offset of the to-be-digested data

inLen - length of the to-be-digested data

digest - buffer for the digested data

digestOfs - buffer offset for the digested data

digestLen - buffer size for the digested data

Returns:

the length of digested data for this update

Throws:

TokenException - If digesting the data failed.

digestUpdate

public void digestUpdate(byte[] part,
                         int partOfs,
                         int partLen)
                  throws TokenException

This method can be used to digest multiple pieces of data; e.g. buffer-size pieces when reading the data from a stream. Digests the given data with the mechanism given to the digestInit method. The application must call digestFinal to get the final result of the digesting after feeding in all data using this method.

Parameters:

part - buffer containing the to-be-digested data

partOfs - buffer offset of the to-be-digested data

partLen - length of the to-be-digested data

Throws:

TokenException - If digesting the data failed.

digestKey

public void digestKey(SecretKey key)
               throws TokenException

This method is similar to digestUpdate and can be combined with it during one digesting operation. This method digests the value of the given secret key.

Parameters:

key - The key to digest the value of.

Throws:

TokenException - If digesting the key failed.

digestFinal

public int digestFinal(byte[] digest,
                       int digestOfs,
                       int digestLen)
                throws TokenException

This method finalizes a digesting operation and returns the final result. Use this method, if you fed in the data using digestUpdate and/or digestKey. If you used the digest(byte[]) method, you need not (and shall not) call this method, because digest(byte[]) finalizes the digesting itself.

Parameters:

digest - buffer for the message digest

digestOfs - buffer offset for the message digest

digestLen - buffer size for the message digest

Returns:

the length of message digest

Throws:

TokenException - If calculating the final message digest failed.

signInit

public void signInit(Mechanism mechanism,
                     Key key)
              throws TokenException

Initializes a new signing operation. Use it for signatures and MACs. The application must call this method before calling any other sign* operation. Before initializing a new operation, any currently pending operation must be finalized using the appropriate *Final method (e.g. digestFinal()). There are exceptions for dual-function operations. This method requires the mechanism to use for signing and the key for this operation. The key must have set its sign flag. For the mechanism the application may use a constant defined in the Mechanism class. Notice that the key and the mechanism must be compatible; i.e. you cannot use a DES key with the RSA mechanism.

Parameters:

mechanism - The mechanism to use; e.g. Mechanism.RSA_PKCS.

key - The signing key to use.

Throws:

TokenException - If initializing this operation failed.

sign

public byte[] sign(byte[] data)
            throws TokenException

Signs the given data with the key and mechanism given to the signInit method. This method finalizes the current signing operation; i.e. the application need (and should) not call signFinal() after this call. For signing multiple pieces of data use signUpdate and signFinal.

Parameters:

data - The data to sign.

Returns:

The signed data.

Throws:

TokenException - If signing the data failed.

signUpdate

public void signUpdate(byte[] in,
                       int inOfs,
                       int inLen)
                throws TokenException

This method can be used to sign multiple pieces of data; e.g. buffer-size pieces when reading the data from a stream. Signs the given data with the mechanism given to the signInit method. The application must call signFinal to get the final result of the signing after feeding in all data using this method.

Parameters:

in - buffer containing the to-be-signed data

inOfs - buffer offset of the to-be-signed data

inLen - length of the to-be-signed data

Throws:

TokenException - If signing the data failed.

signFinal

public byte[] signFinal(int expectedLen)
                 throws TokenException

This method finalizes a signing operation and returns the final result. Use this method, if you fed in the data using signUpdate. If you used the sign(byte[]) method, you need not (and shall not) call this method, because sign(byte[]) finalizes the signing operation itself.

Parameters:

expectedLen - expected length of the signature value.

Returns:

The final result of the signing operation; i.e. the signature value.

Throws:

TokenException - If calculating the final signature value failed.

signRecoverInit

public void signRecoverInit(Mechanism mechanism,
                            Key key)
                     throws TokenException

Initializes a new signing operation for signing with recovery. The application must call this method before calling signRecover. Before initializing a new operation, any currently pending operation must be finalized using the appropriate *Final method (e.g. digestFinal()). There are exceptions for dual-function operations. This method requires the mechanism to use for signing and the key for this operation. The key must have set its sign-recover flag. For the mechanism the application may use a constant defined in the Mechanism class. Notice that the key and the mechanism must be compatible; i.e. you cannot use a DES key with the RSA mechanism.

Parameters:

mechanism - The mechanism to use; e.g. Mechanism.RSA_9796.

key - The signing key to use.

Throws:

TokenException - If initializing this operation failed.

signRecover

public int signRecover(byte[] in,
                       int inOfs,
                       int inLen,
                       byte[] out,
                       int outOfs,
                       int outLen)
                throws TokenException

Signs the given data with the key and mechanism given to the signRecoverInit method. This method finalizes the current sign-recover operation; there is no equivalent method to signUpdate for signing with recovery.

Parameters:

in - buffer containing the to-be-signed data

inOfs - buffer offset of the to-be-signed data

inLen - length of the to-be-signed data

out - buffer for the signed data

outOfs - buffer offset for the signed data

outLen - buffer size for the signed data

Returns:

the length of signed data

Throws:

TokenException - If signing the data failed.

verifyInit

public void verifyInit(Mechanism mechanism,
                       Key key)
                throws TokenException

Initializes a new verification operation. You can use it for verifying signatures and MACs. The application must call this method before calling any other verify* operation. Before initializing a new operation, any currently pending operation must be finalized using the appropriate *Final method (e.g. digestFinal()). There are exceptions for dual-function operations. This method requires the mechanism to use for verification and the key for this operation. The key must have set its verify flag. For the mechanism the application may use a constant defined in the Mechanism class. Notice that the key and the mechanism must be compatible; i.e. you cannot use a DES key with the RSA mechanism.

Parameters:

mechanism - The mechanism to use; e.g. Mechanism.RSA_PKCS.

key - The verification key to use.

Throws:

TokenException - If initializing this operation failed.

verify

public void verify(byte[] data,
                   byte[] signature)
            throws TokenException

Verifies the given signature against the given data with the key and mechanism given to the verifyInit method. This method finalizes the current verification operation; i.e. the application need (and should) not call verifyFinal() after this call. For verifying with multiple pieces of data use verifyUpdate and verifyFinal. This method throws an exception, if the verification of the signature fails.

Parameters:

data - The data that was signed.

signature - The signature or MAC to verify.

Throws:

TokenException - If verifying the signature fails. This is also the case, if the signature is forged.

verifyUpdate

public void verifyUpdate(byte[] in,
                         int inOfs,
                         int inLen)
                  throws TokenException

This method can be used to verify a signature with multiple pieces of data; e.g. buffer-size pieces when reading the data from a stream. To verify the signature or MAC call verifyFinal after feeding in all data using this method.

Parameters:

in - buffer containing the to-be-verified data

inOfs - buffer offset of the to-be-verified data

inLen - length of the to-be-verified data

Throws:

TokenException - If verifying (e.g. digesting) the data failed.

verifyFinal

public void verifyFinal(byte[] signature)
                 throws TokenException

This method finalizes a verification operation. Use this method, if you fed in the data using verifyUpdate. If you used the verify(byte[]) method, you need not (and shall not) call this method, because verify(byte[]) finalizes the verification operation itself. If this method verified the signature successfully, it returns normally. If the verification of the signature fails, e.g. if the signature was forged or the data was modified, this method throws an exception.

Parameters:

signature - The signature value.

Throws:

TokenException - If verifying the signature fails. This is also the case, if the signature is forged.

verifyRecoverInit

public void verifyRecoverInit(Mechanism mechanism,
                              Key key)
                       throws TokenException

Initializes a new verification operation for verification with data recovery. The application must call this method before calling verifyRecover. Before initializing a new operation, any currently pending operation must be finalized using the appropriate *Final method (e.g. digestFinal()). This method requires the mechanism to use for verification and the key for this operation. The key must have set its verify-recover flag. For the mechanism the application may use a constant defined in the Mechanism class. Notice that the key and the mechanism must be compatible; i.e. you cannot use a DES key with the RSA mechanism.

Parameters:

mechanism - The mechanism to use; e.g. Mechanism.RSA_9796.

key - The verification key to use.

Throws:

TokenException - If initializing this operation failed.

verifyRecover

public int verifyRecover(byte[] in,
                         int inOfs,
                         int inLen,
                         byte[] out,
                         int outOfs,
                         int outLen)
                  throws TokenException

Signs the given data with the key and mechanism given to the signRecoverInit method. This method finalizes the current sign-recover operation; there is no equivalent method to signUpdate for signing with recovery.

Parameters:

in - buffer containing the to-be-verified data

inOfs - buffer offset of the to-be-verified data

inLen - length of the to-be-verified data

out - buffer for the verified data

outOfs - buffer offset for the verified data

outLen - buffer size for the verified data

Returns:

the length of verified data

Throws:

TokenException - If signing the data failed.

generateKey

public PKCS11Object generateKey(Mechanism mechanism,
                                PKCS11Object template)
                         throws TokenException

Generate a new secret key or a set of domain parameters. It uses the set attributes of the template for setting the attributes of the new key object. As mechanism the application can use a constant of the Mechanism class.

Parameters:

mechanism - The mechanism to generate a key for; e.g. Mechanism.DES to generate a DES key.

template - The template for the new key or domain parameters; e.g. a DESSecretKey object which has set certain attributes.

Returns:

The newly generated secret key or domain parameters.

Throws:

TokenException - If generating a new secret key or domain parameters failed.

generateKeyPair

public KeyPair generateKeyPair(Mechanism mechanism,
                               PKCS11Object publicKeyTemplate,
                               PKCS11Object privateKeyTemplate)
                        throws TokenException

Generate a new public key - private key key-pair and use the set attributes of the template objects for setting the attributes of the new public key and private key objects. As mechanism the application can use a constant of the Mechanism class.

Parameters:

mechanism - The mechanism to generate a key for; e.g. Mechanism.RSA to generate a new RSA key-pair.

publicKeyTemplate - The template for the new public key part; e.g. a RSAPublicKey object which has set certain attributes (e.g. public exponent and verify).

privateKeyTemplate - The template for the new private key part; e.g. a RSAPrivateKey object which has set certain attributes (e.g. sign and decrypt).

Returns:

The newly generated key-pair.

Throws:

TokenException - If generating a new key-pair failed.

wrapKey

public byte[] wrapKey(Mechanism mechanism,
                      Key wrappingKey,
                      Key key)
               throws TokenException

Wraps (encrypts) the given key with the wrapping key using the given mechanism.

Parameters:

mechanism - The mechanism to use for wrapping the key.

wrappingKey - The key to use for wrapping (encrypting).

key - The key to wrap (encrypt).

Returns:

The wrapped key as byte array.

Throws:

TokenException - If wrapping the key failed.

unwrapKey

public Key unwrapKey(Mechanism mechanism,
                     Key unwrappingKey,
                     byte[] wrappedKey,
                     PKCS11Object keyTemplate)
              throws TokenException

Unwraps (decrypts) the given encrypted key with the unwrapping key using the given mechanism. The application can also pass a template key to set certain attributes of the unwrapped key. This creates a key object after unwrapping the key and returns an object representing this key.

Parameters:

mechanism - The mechanism to use for unwrapping the key.

unwrappingKey - The key to use for unwrapping (decrypting).

wrappedKey - The encrypted key to unwrap (decrypt).

keyTemplate - The template for creating the new key object.

Returns:

A key object representing the newly created key object.

Throws:

TokenException - If unwrapping the key or creating a new key object failed.

deriveKey

public Key deriveKey(Mechanism mechanism,
                     Key baseKey,
                     Key template)
              throws TokenException

Derives a new key from a specified base key using the given mechanism. After deriving a new key from the base key, a new key object is created and a representation of it is returned. The application can provide a template key to set certain attributes of the new key object.

Parameters:

mechanism - The mechanism to use for deriving the new key from the base key.

baseKey - The key to use as base for derivation.

template - The template for creating the new key object.

Returns:

A key object representing the newly derived (created) key object or null, if the used mechanism uses other means to return its values; e.g. the CKM_SSL3_KEY_AND_MAC_DERIVE mechanism.

Throws:

TokenException - If deriving the key or creating a new key object failed.

seedRandom

public void seedRandom(byte[] seed)
                throws TokenException

Mixes additional seeding material into the random number generator.

Parameters:

seed - The seed bytes to mix in.

Throws:

TokenException - If mixing in the seed failed.

generateRandom

public byte[] generateRandom(int numberOfBytesToGenerate)
                      throws TokenException

Generates a certain number of random bytes.

Parameters:

numberOfBytesToGenerate - The number of random bytes to generate.

Returns:

An array of random bytes with length numberOfBytesToGenerate.

Throws:

TokenException - If generating random bytes failed.

toString

public String toString()

Returns the string representation of this object.

Overrides:

toString in class Object

Returns:

the string representation of this object