Package org.forgerock.secrets.gcpkms

Class GoogleKmsAesCipher

java.lang.Object

javax.crypto.CipherSpi

org.forgerock.secrets.gcpkms.GoogleKmsAesCipher

public final class GoogleKmsAesCipher
extends CipherSpi

A Cipher implementation using Google KMS symmetric encryption/decryption. This is a variant of AES-GCM, but uses a proprietary Google-specific padding scheme so is not directly compatible with standard AES/GCM/NoPadding. This cipher implementation is therefore advertised using the name AES/GCM/GoogleKmsPadding and cannot be used for JWT encryption or other standard modes. It is mainly useful for encrypting and decrypting data locally.

Constructor Summary

Constructors

Constructor	Description
GoogleKmsAesCipher()

Method Summary

Modifier and Type	Method	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 byte[]	engineGetIV()
protected int	engineGetKeySize(Key key)
protected int	engineGetOutputSize(int inputLen)
protected AlgorithmParameters	engineGetParameters()
protected void	engineInit(int opmode, Key key, AlgorithmParameters params, SecureRandom random)
protected void	engineInit(int opmode, Key key, SecureRandom random)
protected void	engineInit(int opmode, Key key, AlgorithmParameterSpec params, SecureRandom random)
protected void	engineSetMode(String mode)
protected void	engineSetPadding(String padding)
protected Key	engineUnwrap(byte[] wrappedKey, String wrappedKeyAlgorithm, int wrappedKeyType)
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)
protected void	engineUpdateAAD(ByteBuffer src)
protected byte[]	engineWrap(Key keyToWrap)

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

GoogleKmsAesCipher

public GoogleKmsAesCipher()

Method Detail

engineWrap

protected byte[] engineWrap(Key keyToWrap)
                     throws InvalidKeyException

Overrides:

engineWrap in class CipherSpi

Throws:

InvalidKeyException

engineUnwrap

protected Key engineUnwrap(byte[] wrappedKey,
                           String wrappedKeyAlgorithm,
                           int wrappedKeyType)
                    throws InvalidKeyException,
                           NoSuchAlgorithmException

Overrides:

engineUnwrap in class CipherSpi

Throws:

InvalidKeyException

NoSuchAlgorithmException

engineGetKeySize

protected int engineGetKeySize(Key key)
                        throws InvalidKeyException

Overrides:

engineGetKeySize in class CipherSpi

Throws:

InvalidKeyException

engineSetMode

protected void engineSetMode(String mode)
                      throws NoSuchAlgorithmException

Specified by:

engineSetMode in class CipherSpi

Throws:

NoSuchAlgorithmException

engineSetPadding

protected void engineSetPadding(String padding)
                         throws NoSuchPaddingException

Specified by:

engineSetPadding in class CipherSpi

Throws:

NoSuchPaddingException

engineGetBlockSize

protected int engineGetBlockSize()

Specified by:

engineGetBlockSize in class CipherSpi

engineGetOutputSize

protected int engineGetOutputSize(int inputLen)

Specified by:

engineGetOutputSize in class CipherSpi

engineGetIV

protected byte[] engineGetIV()

Specified by:

engineGetIV in class CipherSpi

engineGetParameters

protected AlgorithmParameters engineGetParameters()

Specified by:

engineGetParameters in class CipherSpi

engineInit

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

Specified by:

engineInit in class CipherSpi

Throws:

InvalidKeyException

engineInit

protected void engineInit(int opmode,
                          Key key,
                          AlgorithmParameterSpec params,
                          SecureRandom random)
                   throws InvalidKeyException,
                          InvalidAlgorithmParameterException

Specified by:

engineInit in class CipherSpi

Throws:

InvalidKeyException

InvalidAlgorithmParameterException

engineInit

protected void engineInit(int opmode,
                          Key key,
                          AlgorithmParameters params,
                          SecureRandom random)
                   throws InvalidKeyException,
                          InvalidAlgorithmParameterException

Specified by:

engineInit in class CipherSpi

Throws:

InvalidKeyException

InvalidAlgorithmParameterException

engineUpdate

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

Specified by:

engineUpdate in class CipherSpi

engineUpdate

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

Specified by:

engineUpdate in class CipherSpi

engineUpdateAAD

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

Overrides:

engineUpdateAAD in class CipherSpi

engineUpdateAAD

protected void engineUpdateAAD(ByteBuffer src)

Overrides:

engineUpdateAAD in class CipherSpi

engineDoFinal

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

Specified by:

engineDoFinal in class CipherSpi

engineDoFinal

protected int engineDoFinal(byte[] input,
                            int inputOffset,
                            int inputLen,
                            byte[] output,
                            int outputOffset)
                     throws ShortBufferException

Specified by:

engineDoFinal in class CipherSpi

Throws:

ShortBufferException