oracle.security.crypto.cryptoki.crypto

Class CkiRSApkcs1

java.lang.Object

Cipher

oracle.security.crypto.cryptoki.crypto.CkiRSApkcs1

public class CkiRSApkcs1
extends Cipher

An implementation encapsulating the PKCS #1 cryptographic functions of a PKCS #11 token.

Constructor Summary

Constructors

Constructor and Description
CkiRSApkcs1() Creates a new CkiRSApkcs1 object.

Method Summary

Modifier and Type	Method and Description
java.lang.String	algName() The algorithm for which this key is used.
int	blockSize() Deprecated.
byte[]	decrypt(byte[] bytes) Decrypts the given encrypted block with the decryption key.
byte[]	decrypt(byte[] bytes, int inOff, int len, boolean unpad) Decrypts a sequence of bytes of specified length.
void	decrypt(byte[] input, int inOff, int len, byte[] output, int outOff) Decrypts a sequence of bytes of specified length and places the original plaintext message in the given output buffer starting at the given offset.
void	decryptOp(byte[] in, int inOff, byte[] out, int outOff) Deprecated.
byte[]	encrypt(byte[] bytes) Encrypts the given data with the encryption key.
byte[]	encrypt(byte[] bytes, int inOff, int len, boolean pad) Encrypts a sequence of bytes of specified length.
void	encrypt(byte[] input, int inOff, int len, byte[] output, int outOff) Encrypts a sequence of bytes of specified length and places the resulting ciphertext in the given output buffer starting at the given offset.
void	encryptOp(byte[] in, int inOff, byte[] out, int outOff) Deprecated.
void	erase() Erase the keys.
void	finalize()
AlgorithmIdentifier	getAlgID() Returns the algorithm identifier for this key.
int	getBlockSize() The blocksize returns 0.
void	initialize(AlgorithmIdentifier algID, Key key) This method initializes the cipher with the given AlgorithmIdentifier and then configures itself with the given key.
void	setAlgID(AlgorithmIdentifier algID) Deprecated. Use an initialize method.
void	setDecryptionKey(Key key) Deprecated. Use an initialize method instead.
void	setEncryptionKey(Key key) Deprecated. Use an initialize method instead.
void	setKey(SymmetricKey key) Deprecated. Use an initialize method instead.
void	setSession(CkiMgtSession session) Sets the session to be used within this Cipher object.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CkiRSApkcs1

public CkiRSApkcs1()

Creates a new CkiRSApkcs1 object.

Method Detail

initialize

public void initialize(AlgorithmIdentifier algID,
                       Key key)
                throws AlgorithmIdentifierException,
                       InvalidKeyException,
                       CipherException

This method initializes the cipher with the given AlgorithmIdentifier and then configures itself with the given key.

Parameters:

algID - is the AlgorithmIdentifier whose params will be used to configure the cipher.

key - is the Key instance that will be used by the cipher internally. This instance will be erased when the Cipher.erase() is called.^M

Throws:

AlgorithmIdentifierException - is thrown if the algID's OID isn't valid for the Cipher instance being initialized or if the params are not valid for the algID's OID.

InvalidKeyException - is thrown if there is a problem with the Key instance the Cipher is being initialized with.

CipherException - is thrown if the op argument is null.

setSession

public void setSession(CkiMgtSession session)

Sets the session to be used within this Cipher object.

setAlgID

public void setAlgID(AlgorithmIdentifier algID)
              throws AlgorithmIdentifierException

Deprecated. Use an initialize method.

Throws:

AlgorithmIdentifierException

getAlgID

public AlgorithmIdentifier getAlgID()

Returns the algorithm identifier for this key.

Returns:

An AlgorithmIdentifier object representing the algorithm of this key.

algName

public java.lang.String algName()

The algorithm for which this key is used.

Returns:

A String: "RSA PKCS1"

blockSize

public int blockSize()

Deprecated.

The blocksize returns 0.

getBlockSize

public int getBlockSize()

The blocksize returns 0.

setKey

public void setKey(SymmetricKey key)
            throws InvalidKeyException

Deprecated. Use an initialize method instead.

Invalid use of this method in this class. Calling this method will throw an InvalidKeyException.

Throws:

InvalidKeyException - is always thrown here.

setDecryptionKey

public void setDecryptionKey(Key key)
                      throws InvalidKeyException

Deprecated. Use an initialize method instead.

Clones the given key, sets it as the Cipher's key.

Throws:

InvalidKeyException - is thrown if the the key is not valid for the Cipher instance

setEncryptionKey

public void setEncryptionKey(Key key)
                      throws InvalidKeyException

Deprecated. Use an initialize method instead.

Clones the given key, sets it as the Cipher's key.

Throws:

InvalidKeyException - is thrown if the the key is not valid for the Cipher instance

decrypt

public byte[] decrypt(byte[] bytes)
               throws CipherException

Decrypts the given encrypted block with the decryption key.

Parameters:

bytes - the data block to decrypt.

Returns:

the decrypted data.

Throws:

CipherException - if the given block is not the right size or is incorrectly formatted, or uses a block type which is not supported. An exception is also thrown if the key cannot be found on the token.

decrypt

public byte[] decrypt(byte[] bytes,
                      int inOff,
                      int len,
                      boolean unpad)
               throws CipherException

Decrypts a sequence of bytes of specified length.

Parameters:

bytes - Buffer in which data to be decrypted is stored.

inOff - Offset within buffer of the start of data.

len - The length of the data

unpad - is an ignored parameter because encoding data is not optional in RSA Encryption.

Returns:

the decrypted bytes

Throws:

CipherException - if cipher not initialized, data is not a multiple of the block size and no padding is specified, etc.

decrypt

public void decrypt(byte[] input,
                    int inOff,
                    int len,
                    byte[] output,
                    int outOff)
             throws CipherException

Decrypts a sequence of bytes of specified length and places the original plaintext message in the given output buffer starting at the given offset. This method will not attempt to pad the input.

Parameters:

input - array of bytes to decrypt

inOff - offset of the start of the data to decrypt

len - the length of the data to decrypt

output - array to place the decrypted bytes

outOff - offset of the start of the decrypted bytes

Throws:

CipherException - is thrown if there is a problem with the decryption process or if the cipher was initialized for encryption.

encrypt

public byte[] encrypt(byte[] bytes)
               throws CipherException

Encrypts the given data with the encryption key. The maximum size of the data to be encrypted is k-11 bytes, where k is the length of the modulus in bytes.

Parameters:

bytes - the data to encrypt.

Returns:

the encrypted data.

Throws:

CipherException - if the given data is too long, or if the key cannot be found on the token.

encrypt

public byte[] encrypt(byte[] bytes,
                      int inOff,
                      int len,
                      boolean pad)
               throws CipherException

Encrypts a sequence of bytes of specified length.

Parameters:

bytes - buffer in which data to be encrypted is stored.

inOff - offset within buffer of the start of the data.

len - the length of the data.

pad - is an ignored parameter because encoding data is not optional in RSA Encryption.

Returns:

the encrypted bytes

Throws:

CipherException - if cipher not initialized, data is not a multiple of the block size and no padding is specified, etc.

encrypt

public void encrypt(byte[] input,
                    int inOff,
                    int len,
                    byte[] output,
                    int outOff)
             throws CipherException

Encrypts a sequence of bytes of specified length and places the resulting ciphertext in the given output buffer starting at the given offset. This method will not attempt to unpad the result.

Parameters:

input - array of bytes to encrypt

inOff - offset of the start of data to encrypt

len - the length of the data to encrypt

output - array to place the encrypted bytes

outOff - offset of the start of the encrypted bytes

Throws:

CipherException - is thrown if there are problems with the encryption operation or if the Cipher was initialized for decryption.

encryptOp

public void encryptOp(byte[] in,
                      int inOff,
                      byte[] out,
                      int outOff)
               throws CipherException

Deprecated.

Not used. An exception is thrown if this method is called.

Throws:

CipherException

decryptOp

public void decryptOp(byte[] in,
                      int inOff,
                      byte[] out,
                      int outOff)
               throws CipherException

Deprecated.

Not used. An exception is thrown if this method is called.

Throws:

CipherException

erase

public void erase()

Erase the keys.

finalize

public void finalize()