com.ibm.crypto.fips.provider
Class RSA
- java.lang.Object
javax.crypto.CipherSpi
com.ibm.crypto.fips.provider.RSA
- public final class RSA
- extends javax.crypto.CipherSpi
- implements AlgorithmStatus
Constructor Summary
Modifier | Constructor and Description |
---|---|
|
RSA()
Creates an instance of RSA
|
|
RSA(boolean blinding)
Creates an instance of RSA
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
engineDoFinal(byte[] input,int inputOffset,int inputLen)
Encrypts or decrypts data in a single-part operation,
or finishes a multiple-part operation.
|
|
engineDoFinal(byte[] input,int inputOffset,int inputLen,byte[] output,int outputOffset)
Encrypts or decrypts data in a single-part operation,
or finishes a multiple-part operation.
|
|
engineGetBlockSize()
Returns the block size (in bytes).
|
|
engineGetIV()
Returns the initialization vector (IV) in a new buffer.
|
|
engineGetKeySize(java.security.Key key)
Returns the key size of the given key object.
|
|
engineGetOutputSize(int inputLen)
Returns the length in bytes that an output buffer would need to be in
order to hold the result of the next
update or
doFinal operation, given the input length
inputLen (in bytes).
|
|
engineGetParameters()
Returns the parameters used with this cipher.
|
|
engineInit(int opmode,java.security.Key key,java.security.spec.AlgorithmParameterSpec params,java.security.SecureRandom random)
Initializes this cipher with a key, a set of
algorithm parameters, and a source of randomness.
|
|
engineInit(int opmode,java.security.Key key,java.security.AlgorithmParameters params,java.security.SecureRandom random)
Initializes this cipher with a key, a set of
algorithm parameters, and a source of randomness.
|
|
engineInit(int opmode,java.security.Key key,java.security.SecureRandom random)
Initializes this cipher with a key and a source of randomness.
|
|
engineSetMode(java.lang.String mode)
Sets the mode of this cipher.
|
|
engineSetPadding(java.lang.String paddingScheme)
Sets the padding mechanism of this cipher.
|
|
engineUnwrap(byte[] wrappedKey,java.lang.String wrappedKeyAlgorithm,int wrappedKeyType)
Unwrap a previously wrapped key.
|
|
engineUpdate(byte[] input,int inputOffset,int inputLen)
Continues a multiple-part encryption or decryption operation
(depending on how this cipher was initialized), processing another data
part.
|
|
engineUpdate(byte[] input,int inputOffset,int inputLen,byte[] output,int outputOffset)
Continues a multiple-part encryption or decryption operation
(depending on how this cipher was initialized), processing another data
part.
|
|
engineWrap(java.security.Key key)
Wrap a key.
|
|
internalDoFinal(byte[] input,int inputOffset,int inputLen)
Encrypts or decrypts data in a single-part operation,
or finishes a multiple-part operation.
|
|
internalDoFinal(byte[] input,int inputOffset,int inputLen,byte[] output,int outputOffset)
Encrypts or decrypts data in a single-part operation,
or finishes a multiple-part operation.
|
|
internalGetBlockSize()
Returns the block size (in bytes).
|
|
internalGetKeySize(java.security.Key key)
Returns the key size of the given key object.
|
|
internalGetOutputSize(int inputLen)
Returns the length in bytes that an output buffer would need to be in
order to hold the result of the next
update or
doFinal operation, given the input length
inputLen (in bytes).
|
|
internalInit(int opmode,java.security.Key key,java.security.SecureRandom random)
Initializes this cipher with a key and a source of randomness.
|
|
internalSetMode(java.lang.String mode)
Sets the mode of this cipher.
|
|
internalSetPadding(java.lang.String paddingScheme)
Sets the padding mechanism of this cipher.
|
|
internalUnwrap(byte[] wrappedKey,java.lang.String wrappedKeyAlgorithm,int wrappedKeyType)
Unwrap a previously wrapped key.
|
|
internalUpdate(byte[] input,int inputOffset,int inputLen)
Continues a multiple-part encryption or decryption operation
(depending on how this cipher was initialized), processing another data
part.
|
|
internalUpdate(byte[] input,int inputOffset,int inputLen,byte[] output,int outputOffset)
Continues a multiple-part encryption or decryption operation
(depending on how this cipher was initialized), processing another data
part.
|
|
internalWrap(java.security.Key key)
Wrap a key.
|
|
isFipsApproved()
This function allows an application to verify the the algorithm is
FIPS approved.
|
Methods inherited from class javax.crypto.CipherSpi |
---|
engineDoFinal, engineUpdate |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail
RSA
- public RSA()
RSA
- protected RSA(boolean blinding)
Method Detail
isFipsApproved
- public boolean isFipsApproved()
isFipsApproved
in interface AlgorithmStatus
engineSetMode
- protected void engineSetMode(java.lang.String mode)
- throws java.security.NoSuchAlgorithmException
engineSetMode
in class javax.crypto.CipherSpi
mode
- the cipher mode java.security.NoSuchAlgorithmException
- if the requested cipher mode does
not exist internalSetMode
- protected void internalSetMode( java.lang.String mode)
- throws java.security.NoSuchAlgorithmException
mode
- the cipher mode java.security.NoSuchAlgorithmException
- if the requested cipher mode does
not exist engineSetPadding
- protected void engineSetPadding( java.lang.String paddingScheme)
- throws javax.crypto.NoSuchPaddingException
engineSetPadding
in class javax.crypto.CipherSpi
javax.crypto.NoSuchPaddingException
- if the requested padding mechanism
does not exist internalSetPadding
- protected void internalSetPadding( java.lang.String paddingScheme)
- throws javax.crypto.NoSuchPaddingException
javax.crypto.NoSuchPaddingException
- if the requested padding mechanism
does not exist engineGetBlockSize
- protected int engineGetBlockSize( )
engineGetBlockSize
in class javax.crypto.CipherSpi
internalGetBlockSize
- protected int internalGetBlockSize( )
engineGetOutputSize
- protected int engineGetOutputSize( int inputLen)
update
or
doFinal
operation, given the input length
inputLen
(in bytes).
This call takes into account any unprocessed (buffered) data from a
previous update
call, and padding.
The actual output length of the next update
or
doFinal
call may be smaller than the length returned by
this method.
engineGetOutputSize
in class javax.crypto.CipherSpi
inputLen
- the input length (in bytes) internalGetOutputSize
- protected int internalGetOutputSize( int inputLen)
update
or
doFinal
operation, given the input length
inputLen
(in bytes).
This call takes into account any unprocessed (buffered) data from a
previous update
call, and padding.
The actual output length of the next update
or
doFinal
call may be smaller than the length returned by
this method.
inputLen
- the input length (in bytes) engineGetIV
- protected byte[] engineGetIV()
This is useful in the case where a random IV has been created (see init), or in the context of password-based encryption or decryption, where the IV is derived from a user-supplied password.
engineGetIV
in class javax.crypto.CipherSpi
engineGetParameters
- protected java.security.AlgorithmParameters engineGetParameters( )
The returned parameters may be the same that were used to initialize this cipher, or may contain the default set of parameters or a set of randomly generated parameters used by the underlying cipher implementation (provided that the underlying cipher implementation uses a default set of parameters or creates new parameters if it needs parameters but was not initialized with any).
engineGetParameters
in class javax.crypto.CipherSpi
engineInit
- protected void engineInit(int opmode,
- java.security.Key key,
- java.security.SecureRandom random)
- throws java.security.InvalidKeyException
The cipher is initialized for one of the following four operations:
encryption, decryption, key wrapping or key unwrapping, depending on
the value of opmode
.
If this cipher requires an initialization vector (IV), it will get
it from random
.
This behaviour should only be used in encryption or key wrapping
mode, however.
When initializing a cipher that requires an IV for decryption or
key unwrapping, the IV
(same IV that was used for encryption or key wrapping) must be provided
explicitly as a
parameter, in order to get the correct result.
This method also cleans existing buffer and other related state information.
engineInit
in class javax.crypto.CipherSpi
opmode
- the operation mode of this cipher (this is one of
the following:
ENCRYPT_MODE
, DECRYPT_MODE
,
WRAP_MODE
or UNWRAP_MODE
) key
- the secret key random
- the source of randomness java.security.InvalidKeyException
- if the given key is inappropriate for
initializing this cipher internalInit
- protected void internalInit(int opmode,
- java.security.Key key,
- java.security.SecureRandom random)
- throws java.security.InvalidKeyException
The cipher is initialized for one of the following four operations:
encryption, decryption, key wrapping or key unwrapping, depending on
the value of opmode
.
If this cipher requires an initialization vector (IV), it will get
it from random
.
This behaviour should only be used in encryption or key wrapping
mode, however.
When initializing a cipher that requires an IV for decryption or
key unwrapping, the IV
(same IV that was used for encryption or key wrapping) must be provided
explicitly as a
parameter, in order to get the correct result.
This method also cleans existing buffer and other related state information.
opmode
- the operation mode of this cipher (this is one of
the following:
ENCRYPT_MODE
, DECRYPT_MODE
,
WRAP_MODE
or UNWRAP_MODE
) key
- the secret key random
- the source of randomness java.security.InvalidKeyException
- if the given key is inappropriate for
initializing this cipher engineInit
- protected void engineInit(int opmode,
- java.security.Key key,
- java.security.spec.AlgorithmParameterSpec params,
- java.security.SecureRandom random)
- throws java.security.InvalidKeyException
- java.security.InvalidAlgorithmParameterException
The cipher is initialized for one of the following four operations:
encryption, decryption, key wrapping or key unwrapping, depending on
the value of opmode
.
If this cipher (including its underlying feedback or padding scheme)
requires any random bytes, it will get them from random
.
engineInit
in class javax.crypto.CipherSpi
opmode
- the operation mode of this cipher (this is one of
the following:
ENCRYPT_MODE
, DECRYPT_MODE
,
WRAP_MODE
or UNWRAP_MODE
) key
- the encryption key params
- the algorithm parameters random
- the source of randomness java.security.InvalidKeyException
- if the given key is inappropriate for
initializing this cipher java.security.InvalidAlgorithmParameterException
- if the given algorithm
parameters are inappropriate for this cipher engineInit
- protected void engineInit(int opmode,
- java.security.Key key,
- java.security.AlgorithmParameters params,
- java.security.SecureRandom random)
- throws java.security.InvalidKeyException
- java.security.InvalidAlgorithmParameterException
The cipher is initialized for one of the following four operations:
encryption, decryption, key wrapping or key unwrapping, depending on
the value of opmode
.
If this cipher (including its underlying feedback or padding scheme)
requires any random bytes, it will get them from random
.
engineInit
in class javax.crypto.CipherSpi
opmode
- the operation mode of this cipher (this is one of
the following:
ENCRYPT_MODE
, DECRYPT_MODE
,
WRAP_MODE
or UNWRAP_MODE
) key
- the encryption key params
- the algorithm parameters random
- the source of randomness java.security.InvalidKeyException
- if the given key is inappropriate for
initializing this cipher java.security.InvalidAlgorithmParameterException
- if the given algorithm
parameters are inappropriate for this cipher engineUpdate
- protected byte[] engineUpdate(byte[] input,
- int inputOffset,
- int inputLen)
The first inputLen
bytes in the input
buffer, starting at inputOffset
, are processed, and the
result is stored in a new buffer.
engineUpdate
in class javax.crypto.CipherSpi
input
- the input buffer inputOffset
- the offset in input
where the input
starts inputLen
- the input length java.lang.IllegalStateException
- if this cipher is in a wrong state
(e.g., has not been initialized) internalUpdate
- protected byte[] internalUpdate( byte[] input,
- int inputOffset,
- int inputLen)
The first inputLen
bytes in the input
buffer, starting at inputOffset
, are processed, and the
result is stored in a new buffer.
input
- the input buffer inputOffset
- the offset in input
where the input
starts inputLen
- the input length java.lang.IllegalStateException
- if this cipher is in a wrong state
(e.g., has not been initialized) engineUpdate
- protected int engineUpdate(byte[] input,
- int inputOffset,
- int inputLen,
- byte[] output,
- int outputOffset)
- throws javax.crypto.ShortBufferException
The first inputLen
bytes in the input
buffer, starting at inputOffset
, are processed, and the
result is stored in the output
buffer, starting at
outputOffset
.
engineUpdate
in class javax.crypto.CipherSpi
input
- the input buffer inputOffset
- the offset in input
where the input
starts inputLen
- the input length output
- the buffer for the result outputOffset
- the offset in output
where the result
is stored output
javax.crypto.ShortBufferException
- if the given output buffer is too small
to hold the result internalUpdate
- protected int internalUpdate(byte[] input,
- int inputOffset,
- int inputLen,
- byte[] output,
- int outputOffset)
- throws javax.crypto.ShortBufferException
The first inputLen
bytes in the input
buffer, starting at inputOffset
, are processed, and the
result is stored in the output
buffer, starting at
outputOffset
.
input
- the input buffer inputOffset
- the offset in input
where the input
starts inputLen
- the input length output
- the buffer for the result outputOffset
- the offset in output
where the result
is stored output
javax.crypto.ShortBufferException
- if the given output buffer is too small
to hold the result engineDoFinal
- protected byte[] engineDoFinal( byte[] input,
- int inputOffset,
- int inputLen)
- throws javax.crypto.IllegalBlockSizeException
- javax.crypto.BadPaddingException
The first inputLen
bytes in the input
buffer, starting at inputOffset
, and any input bytes that
may have been buffered during a previous update
operation,
are processed, with padding (if requested) being applied.
The result is stored in a new buffer.
The cipher is reset to its initial state (uninitialized) after this call.
engineDoFinal
in class javax.crypto.CipherSpi
input
- the input buffer inputOffset
- the offset in input
where the input
starts inputLen
- the input length javax.crypto.IllegalBlockSizeException
- if this cipher is a block cipher,
no padding has been requested (only in encryption mode), and the total
input length of the data processed by this cipher is not a multiple of
block size javax.crypto.BadPaddingException
- if this cipher is in decryption mode,
and (un)padding has been requested, but the decrypted data is not
bounded by the appropriate padding bytes internalDoFinal
- protected byte[] internalDoFinal( byte[] input,
- int inputOffset,
- int inputLen)
- throws javax.crypto.IllegalBlockSizeException
- javax.crypto.BadPaddingException
The first inputLen
bytes in the input
buffer, starting at inputOffset
, and any input bytes that
may have been buffered during a previous update
operation,
are processed, with padding (if requested) being applied.
The result is stored in a new buffer.
The cipher is reset to its initial state (uninitialized) after this call.
input
- the input buffer inputOffset
- the offset in input
where the input
starts inputLen
- the input length javax.crypto.IllegalBlockSizeException
- if this cipher is a block cipher,
no padding has been requested (only in encryption mode), and the total
input length of the data processed by this cipher is not a multiple of
block size javax.crypto.BadPaddingException
- if this cipher is in decryption mode,
and (un)padding has been requested, but the decrypted data is not
bounded by the appropriate padding bytes engineDoFinal
- protected int engineDoFinal(byte[] input,
- int inputOffset,
- int inputLen,
- byte[] output,
- int outputOffset)
- throws javax.crypto.IllegalBlockSizeException
- javax.crypto.ShortBufferException
- javax.crypto.BadPaddingException
The first inputLen
bytes in the input
buffer, starting at inputOffset
, and any input bytes that
may have been buffered during a previous update
operation,
are processed, with padding (if requested) being applied.
The result is stored in the output
buffer, starting at
outputOffset
.
The cipher is reset to its initial state (uninitialized) after this call.
engineDoFinal
in class javax.crypto.CipherSpi
input
- the input buffer inputOffset
- the offset in input
where the input
starts inputLen
- the input length output
- the buffer for the result outputOffset
- the offset in output
where the result
is stored output
javax.crypto.IllegalBlockSizeException
- if this cipher is a block cipher,
no padding has been requested (only in encryption mode), and the total
input length of the data processed by this cipher is not a multiple of
block size javax.crypto.ShortBufferException
- if the given output buffer is too small
to hold the result javax.crypto.BadPaddingException
- if this cipher is in decryption mode,
and (un)padding has been requested, but the decrypted data is not
bounded by the appropriate padding bytes internalDoFinal
- protected int internalDoFinal(byte[] input,
- int inputOffset,
- int inputLen,
- byte[] output,
- int outputOffset)
- throws javax.crypto.IllegalBlockSizeException
- javax.crypto.ShortBufferException
- javax.crypto.BadPaddingException
The first inputLen
bytes in the input
buffer, starting at inputOffset
, and any input bytes that
may have been buffered during a previous update
operation,
are processed, with padding (if requested) being applied.
The result is stored in the output
buffer, starting at
outputOffset
.
The cipher is reset to its initial state (uninitialized) after this call.
input
- the input buffer inputOffset
- the offset in input
where the input
starts inputLen
- the input length output
- the buffer for the result outputOffset
- the offset in output
where the result
is stored output
javax.crypto.IllegalBlockSizeException
- if this cipher is a block cipher,
no padding has been requested (only in encryption mode), and the total
input length of the data processed by this cipher is not a multiple of
block size javax.crypto.ShortBufferException
- if the given output buffer is too small
to hold the result javax.crypto.BadPaddingException
- if this cipher is in decryption mode,
and (un)padding has been requested, but the decrypted data is not
bounded by the appropriate padding bytes engineGetKeySize
- protected int engineGetKeySize( java.security.Key key)
- throws java.security.InvalidKeyException
engineGetKeySize
in class javax.crypto.CipherSpi
key
- the key object. java.security.InvalidKeyException
- if key<.code> is invalid.
internalGetKeySize
- protected int internalGetKeySize( java.security.Key key)
- throws java.security.InvalidKeyException
key
- the key object. java.security.InvalidKeyException
- if key<.code> is invalid.
engineWrap
- protected byte[] engineWrap(java.security.Key key)
- throws javax.crypto.IllegalBlockSizeException
- java.security.InvalidKeyException
engineWrap
in class javax.crypto.CipherSpi
key
- the key to be wrapped. javax.crypto.IllegalBlockSizeException
- if this cipher is a block
cipher, no padding has been requested, and the length of the
encoding of the key to be wrapped is not a
multiple of the block size. java.security.InvalidKeyException
- if it is impossible or unsafe to
wrap the key with this cipher (e.g., a hardware protected key is
being passed to a software only cipher). internalWrap
- protected byte[] internalWrap(java.security.Key key)
- throws javax.crypto.IllegalBlockSizeException
- java.security.InvalidKeyException
key
- the key to be wrapped. javax.crypto.IllegalBlockSizeException
- if this cipher is a block
cipher, no padding has been requested, and the length of the
encoding of the key to be wrapped is not a
multiple of the block size. java.security.InvalidKeyException
- if it is impossible or unsafe to
wrap the key with this cipher (e.g., a hardware protected key is
being passed to a software only cipher). engineUnwrap
- protected java.security.Key engineUnwrap( byte[] wrappedKey,
- java.lang.String wrappedKeyAlgorithm,
- int wrappedKeyType)
- throws java.security.InvalidKeyException
- java.security.NoSuchAlgorithmException
engineUnwrap
in class javax.crypto.CipherSpi
wrappedKey
- the key to be unwrapped. wrappedKeyAlgorithm
- the algorithm the wrapped key is for. wrappedKeyType
- the type of the wrapped key.
This is one of Cipher.SECRET_KEY
,
Cipher.PRIVATE_KEY
, or Cipher.PUBLIC_KEY
. java.security.InvalidKeyException
- if wrappedKey
does not
represent a wrapped key, or if the algorithm associated with the
wrapped key is different from wrappedKeyAlgorithm
and/or its key type is different from wrappedKeyType
. java.security.NoSuchAlgorithmException
- if no installed providers
can create keys for the wrappedKeyAlgorithm
. internalUnwrap
- protected java.security.Key internalUnwrap( byte[] wrappedKey,
- java.lang.String wrappedKeyAlgorithm,
- int wrappedKeyType)
- throws java.security.InvalidKeyException
- java.security.NoSuchAlgorithmException
wrappedKey
- the key to be unwrapped. wrappedKeyAlgorithm
- the algorithm the wrapped key is for. wrappedKeyType
- the type of the wrapped key.
This is one of Cipher.SECRET_KEY
,
Cipher.PRIVATE_KEY
, or Cipher.PUBLIC_KEY
. java.security.InvalidKeyException
- if wrappedKey
does not
represent a wrapped key, or if the algorithm associated with the
wrapped key is different from wrappedKeyAlgorithm
and/or its key type is different from wrappedKeyType
. java.security.NoSuchAlgorithmException
- if no installed providers
can create keys for the wrappedKeyAlgorithm
.