BlockCipherProxyCipher (IAIK XML Security Toolkit (XSECT))

java.lang.Object
- javax.crypto.CipherSpi
- - iaik.xml.crypto.alg.cipher.ProxyCipher
  - - iaik.xml.crypto.alg.cipher.BlockCipherProxyCipher

Direct Known Subclasses:

AESProxyCipher, CamelliaProxyCipher, DESedeProxyCipher
```
public abstract class BlockCipherProxyCipher
extends ProxyCipher
```
This Cipher extends the ProxyCipher and appends the initialization vector (IV) for the block encryption to the cipher text and reads the IV from the cipher text in decrypt mode.

Field Summary

Fields
Modifier and Type	Field and Description
`protected byte[]`	`iv_` The initialization vector of the block encryption.
`protected int`	`ivLength_` The length of the initialization vector (IV).
`protected int`	`ivPos_` The position of the last read/wrote byte of the IV.
`protected Key`	`key_` The key for encryption/decryption.
`protected int`	`opmode_` The mode of operation of this Cipher.
`protected SecureRandom`	`random_` The source of randomness.

Fields inherited from class iaik.xml.crypto.alg.cipher.ProxyCipher
cipher_

Constructor Summary

Constructors
Constructor and Description

BlockCipherProxyCipher()
Creates a new instance of this AESProxyCipher.

Constructors
Constructor and Description
`BlockCipherProxyCipher()` Creates a new instance of this `AESProxyCipher`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected byte[]`	`concatenate(byte[] a, byte[] b)` Concatenates the two given byte arrays `a` and `b`.
`protected byte[]`	`engineDoFinal(byte[] input, int inputOffset, int inputLen)`
`protected int`	`engineDoFinal(byte[] input, int inputOffset, int inputLen, byte[] output, int outputOffset)`
`protected void`	`engineInit(int opmode, Key key, AlgorithmParameterSpec params, SecureRandom random)`
`protected void`	`engineInit(int opmode, Key key, AlgorithmParameters params, SecureRandom random)`
`protected void`	`engineInit(int opmode, Key key, SecureRandom random)`
`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 byte[]`	`engineWrap(Key key)`
`protected int`	`readIV(byte[] input, int inputOffset, int inputLen)` Reads the IV from the given `input` and re-initializes the underlying `Cipher` engine with this IV when the complete IV has been read.
`protected byte[]`	`writeIV()` Returns the bytes from the IV that have not been written yet.
`protected int`	`writeIV(byte[] output, int outputOffset)` Writes the bytes from the IV to `output` that have not been written yet.

Methods inherited from class iaik.xml.crypto.alg.cipher.ProxyCipher
engineGetBlockSize, engineGetIV, engineGetOutputSize, engineGetParameters, engineSetMode, engineSetPadding, getAlgorithmInstance, getAlgorithmInstanceUncaught, getCipherName, getInstance

Methods inherited from class javax.crypto.CipherSpi
engineDoFinal, engineGetKeySize, engineUpdate, engineUpdateAAD, engineUpdateAAD

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- ivLength_
```
protected int ivLength_
```
  The length of the initialization vector (IV).
- iv_
```
protected byte[] iv_
```
  The initialization vector of the block encryption.
- ivPos_
```
protected int ivPos_
```
  The position of the last read/wrote byte of the IV.
- opmode_
```
protected int opmode_
```
  The mode of operation of this Cipher.
- key_
```
protected Key key_
```
  The key for encryption/decryption.
- random_
```
protected SecureRandom random_
```
  The source of randomness.

Constructor Detail

BlockCipherProxyCipher

public BlockCipherProxyCipher()
                       throws NoSuchAlgorithmException,
                              NoSuchProviderException,
                              NoSuchPaddingException

Creates a new instance of this AESProxyCipher.

Throws:: NoSuchAlgorithmException; NoSuchPaddingException; NoSuchProviderException

Method Detail

engineInit

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

Overrides:: engineInit in class ProxyCipher
Throws:: InvalidKeyException; InvalidAlgorithmParameterException
See Also:: CipherSpi.engineInit(int, java.security.Key, java.security.AlgorithmParameters, java.security.SecureRandom)

engineInit

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

Overrides:: engineInit in class ProxyCipher
Throws:: InvalidKeyException; InvalidAlgorithmParameterException
See Also:: CipherSpi.engineInit(int, java.security.Key, java.security.spec.AlgorithmParameterSpec, java.security.SecureRandom)

engineInit

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

Overrides:: engineInit in class ProxyCipher
Throws:: InvalidKeyException
See Also:: CipherSpi.engineInit(int, java.security.Key, java.security.SecureRandom)

engineUpdate

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

Overrides:: engineUpdate in class ProxyCipher
Throws:: ShortBufferException
See Also:: CipherSpi.engineUpdate(byte[], int, int, byte[], int)

engineUpdate

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

Overrides:: engineUpdate in class ProxyCipher
See Also:: CipherSpi.engineUpdate(byte[], int, int)

engineDoFinal

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

Overrides:: engineDoFinal in class ProxyCipher
Throws:: ShortBufferException; IllegalBlockSizeException; BadPaddingException
See Also:: CipherSpi.engineDoFinal(byte[], int, int, byte[], int)

engineDoFinal

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

Overrides:: engineDoFinal in class ProxyCipher
Throws:: IllegalBlockSizeException; BadPaddingException
See Also:: CipherSpi.engineDoFinal(byte[], int, int)

engineWrap

protected byte[] engineWrap(Key key)
                     throws IllegalBlockSizeException,
                            InvalidKeyException

Overrides:: engineWrap in class ProxyCipher
Throws:: IllegalBlockSizeException; InvalidKeyException
See Also:: CipherSpi.engineWrap(java.security.Key)

engineUnwrap

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

Overrides:: engineUnwrap in class ProxyCipher
Throws:: InvalidKeyException; NoSuchAlgorithmException
See Also:: CipherSpi.engineUnwrap(byte[], java.lang.String, int)

concatenate
```
protected byte[] concatenate(byte[] a,
                             byte[] b)
```
Concatenates the two given byte arrays a and b.

Parameters:

a - the byte[] a

b - the byte[] b

Returns:

a new byte[] of length (a.length + b.length) containing a copy of the bytes of a followed by a copy of the bytes of b .

readIV
```
protected int readIV(byte[] input,
                     int inputOffset,
                     int inputLen)
```
Reads the IV from the given input and re-initializes the underlying Cipher engine with this IV when the complete IV has been read.

Parameters:

input - the input buffer

inputOffset - the offset in input where the input starts

inputLen - the input length

Returns:

the number of IV bytes read from input

writeIV
```
protected byte[] writeIV()
```
Returns the bytes from the IV that have not been written yet.

Returns:

the bytes form the IV that have not been written yet

writeIV
```
protected int writeIV(byte[] output,
                      int outputOffset)
               throws ShortBufferException
```
Writes the bytes from the IV to output that have not been written yet.

Parameters:

output - the output buffer

outputOffset - the offset in output

Returns:

the number of bytes written to output

Throws:

ShortBufferException - if the given output is to small to hold the result

Class BlockCipherProxyCipher

Field Summary

Fields inherited from class iaik.xml.crypto.alg.cipher.ProxyCipher

Constructor Summary

Method Summary

Methods inherited from class iaik.xml.crypto.alg.cipher.ProxyCipher

Methods inherited from class javax.crypto.CipherSpi

Methods inherited from class java.lang.Object

Field Detail

ivLength_

iv_

ivPos_

opmode_

key_

random_

Constructor Detail

BlockCipherProxyCipher

Method Detail

engineInit

engineInit

engineInit

engineUpdate

engineUpdate

engineDoFinal

engineDoFinal

engineWrap

engineUnwrap

concatenate

readIV

writeIV

writeIV