com.safenetinc.luna.provider.cipher

Class LunaCipher

java.lang.Object

javax.crypto.CipherSpi

com.safenetinc.luna.provider.cipher.LunaCipher

Direct Known Subclasses:

LunaCipherAESCbc, LunaCipherAEScbcISO10126Pad, LunaCipherAESCbcPad, LunaCipherAESCfb128, LunaCipherAESCfb8, LunaCipherAESCtr, LunaCipherAESEcb, LunaCipherAESGcm, LunaCipherAESKw, LunaCipherAESKwp, LunaCipherAESOfb, LunaCipherARIACbc, LunaCipherARIAcbcISO10126Pad, LunaCipherARIACbcPad, LunaCipherARIACfb128, LunaCipherARIACfb8, LunaCipherARIACtr, LunaCipherARIAEcb, LunaCipherARIAOfb, LunaCipherDES3Cbc, LunaCipherDES3CbcISO10126Pad, LunaCipherDES3CbcPad, LunaCipherDES3Ctr, LunaCipherDES3Ecb, LunaCipherDESCbc, LunaCipherDESCbcPad, LunaCipherDESEcb, LunaCipherECIES, LunaCipherPBE, LunaCipherRC2Cbc, LunaCipherRC2CbcPad, LunaCipherRC2Ecb, LunaCipherRC4, LunaCipherRC5Cbc, LunaCipherRC5CbcPad, LunaCipherRC5Ecb, LunaCipherRSAOAEP, LunaCipherRSAPKCS, LunaCipherRSAX509, LunaCipherSM4Cbc, LunaCipherSM4CbcPad, LunaCipherSM4Ecb

public abstract class LunaCipher
extends javax.crypto.CipherSpi

The LunaCipher abstract class serves as a base class for all cipher engine classes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	LunaCipher.Padding padding options

Field Summary

Fields

Modifier and Type	Field and Description
protected int	AES_GCM_GENERATED_IV_LENGTH
protected int	bytesCached
protected int	keySizeBytes
protected static java.util.logging.Logger	LOGGER
protected byte[]	mAccumulator
protected java.security.AlgorithmParameters	mAlgParams
protected int	mBlockSize
protected boolean	mHsmOperationActive
protected LunaKey	mKey
protected long	mMechType
protected int	mOpMode
protected LunaCipher.Padding	mPadding
protected boolean	mStandardSpec
protected static java.security.SecureRandom	rand

Constructor Summary

Constructors

Constructor and Description
LunaCipher(long mechType, java.lang.String keyAlg, java.lang.String padding, int blockSize, boolean singlePart, boolean standardSpec)

Method Summary

Methods

Modifier and Type	Method and Description
protected byte[]	engineDoFinal(byte[] input, int inputOffset, int inputLen)
protected int	engineDoFinal(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset)
protected int	engineGetBlockSize()
protected int	engineGetFinalOutputSize(int inputLen)
protected byte[]	engineGetIV()
protected int	engineGetKeySize(java.security.Key key) Returns the key size of the given key object in bits.
protected int	engineGetOutputSize(int inputLen)
protected java.security.AlgorithmParameters	engineGetParameters()
protected int	engineGetUpdateOutputSize(int inputLen)
protected void	engineInit(int opmode, java.security.Key key, java.security.SecureRandom random)
protected void	engineSetMode(java.lang.String mode)
protected void	engineSetPadding(java.lang.String padding)
protected java.security.Key	engineUnwrap(byte[] wrappedKey, java.lang.String wrappedKeyAlgorithm, int wrappedKeyType) Unwrap a previously wrapped key.
protected byte[]	engineUpdate(byte[] input, int inputOffset, int inputLen)
protected int	engineUpdate(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset)
protected void	engineUpdateAAD(byte[] src, int offset, int len) Appends authenticated additional data for Authenticated Encryption, Authenticated Decryption for AES GCM.
protected byte[]	engineWrap(java.security.Key key)
protected void	finalize()

Methods inherited from class javax.crypto.CipherSpi

engineDoFinal, engineInit, engineInit, engineUpdate, engineUpdateAAD

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

protected static final java.util.logging.Logger LOGGER

mMechType

protected long mMechType

mBlockSize

protected int mBlockSize

mStandardSpec

protected final boolean mStandardSpec

mAlgParams

protected java.security.AlgorithmParameters mAlgParams

mOpMode

protected int mOpMode

mKey

protected LunaKey mKey

keySizeBytes

protected int keySizeBytes

mAccumulator

protected byte[] mAccumulator

mPadding

protected LunaCipher.Padding mPadding

bytesCached

protected int bytesCached

AES_GCM_GENERATED_IV_LENGTH

protected final int AES_GCM_GENERATED_IV_LENGTH

See Also:

Constant Field Values

mHsmOperationActive

protected boolean mHsmOperationActive

rand

protected static final java.security.SecureRandom rand

Constructor Detail

LunaCipher

public LunaCipher(long mechType,
          java.lang.String keyAlg,
          java.lang.String padding,
          int blockSize,
          boolean singlePart,
          boolean standardSpec)

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

engineSetMode

protected void engineSetMode(java.lang.String mode)
                      throws java.security.NoSuchAlgorithmException

Specified by:

engineSetMode in class javax.crypto.CipherSpi

Throws:

java.security.NoSuchAlgorithmException

engineSetPadding

protected void engineSetPadding(java.lang.String padding)
                         throws javax.crypto.NoSuchPaddingException

Specified by:

engineSetPadding in class javax.crypto.CipherSpi

Throws:

javax.crypto.NoSuchPaddingException

engineGetIV

protected byte[] engineGetIV()

Specified by:

engineGetIV in class javax.crypto.CipherSpi

engineGetOutputSize

protected int engineGetOutputSize(int inputLen)

Specified by:

engineGetOutputSize in class javax.crypto.CipherSpi

engineGetUpdateOutputSize

protected int engineGetUpdateOutputSize(int inputLen)

engineGetFinalOutputSize

protected int engineGetFinalOutputSize(int inputLen)

engineGetBlockSize

protected int engineGetBlockSize()

Specified by:

engineGetBlockSize in class javax.crypto.CipherSpi

engineGetParameters

protected java.security.AlgorithmParameters engineGetParameters()

Specified by:

engineGetParameters in class javax.crypto.CipherSpi

engineInit

protected void engineInit(int opmode,
              java.security.Key key,
              java.security.SecureRandom random)
                   throws java.security.InvalidKeyException

Specified by:

engineInit in class javax.crypto.CipherSpi

Throws:

java.security.InvalidKeyException

engineUpdate

protected byte[] engineUpdate(byte[] input,
                  int inputOffset,
                  int inputLen)

Specified by:

engineUpdate in class javax.crypto.CipherSpi

engineUpdate

protected int engineUpdate(byte[] input,
               int inputOffset,
               int inputLen,
               byte[] output,
               int outputOffset)
                    throws java.lang.IllegalStateException,
                           javax.crypto.ShortBufferException

Specified by:

engineUpdate in class javax.crypto.CipherSpi

Throws:

java.lang.IllegalStateException

javax.crypto.ShortBufferException

engineDoFinal

protected byte[] engineDoFinal(byte[] input,
                   int inputOffset,
                   int inputLen)
                        throws javax.crypto.IllegalBlockSizeException,
                               javax.crypto.BadPaddingException

Specified by:

engineDoFinal in class javax.crypto.CipherSpi

Throws:

javax.crypto.IllegalBlockSizeException

javax.crypto.BadPaddingException

engineDoFinal

protected int engineDoFinal(byte[] input,
                int inputOffset,
                int inputLen,
                byte[] output,
                int outputOffset)
                     throws javax.crypto.ShortBufferException,
                            javax.crypto.IllegalBlockSizeException,
                            javax.crypto.BadPaddingException

Specified by:

engineDoFinal in class javax.crypto.CipherSpi

Throws:

javax.crypto.ShortBufferException

javax.crypto.IllegalBlockSizeException

javax.crypto.BadPaddingException

engineGetKeySize

protected int engineGetKeySize(java.security.Key key)
                        throws java.security.InvalidKeyException

Returns the key size of the given key object in bits.

Overrides:

engineGetKeySize in class javax.crypto.CipherSpi

Parameters:

key - the key to size up

Returns:

the key size of the key, in bits

Throws:

java.security.InvalidKeyException - if the key type is not a Luna or RAW secret key, or an RSA key

engineUnwrap

protected java.security.Key engineUnwrap(byte[] wrappedKey,
                             java.lang.String wrappedKeyAlgorithm,
                             int wrappedKeyType)
                                  throws java.security.InvalidKeyException

Unwrap a previously wrapped key.

Overrides:

engineUnwrap in class javax.crypto.CipherSpi

Throws:

java.security.InvalidKeyException - if wrappedKey cannot be unwrapped properly

LunaException - if the algorithm parameters can't be used for this unwrap operation

engineWrap

protected byte[] engineWrap(java.security.Key key)
                     throws javax.crypto.IllegalBlockSizeException,
                            java.security.InvalidKeyException

Overrides:

engineWrap in class javax.crypto.CipherSpi

Throws:

javax.crypto.IllegalBlockSizeException

java.security.InvalidKeyException

engineUpdateAAD

protected void engineUpdateAAD(byte[] src,
                   int offset,
                   int len)

Appends authenticated additional data for Authenticated Encryption, Authenticated Decryption for AES GCM.

Overrides:

engineUpdateAAD in class javax.crypto.CipherSpi

Parameters:

src - buffer with AAD data

offset - the starting offset from which to copy AAD

len - the number of bytes to copy.