gnu.javax.crypto.mode

Class EAX

Implemented Interfaces:
Cloneable, IAuthenticatedMode, IBlockCipher, IMac, IMode

public class EAX
extends Object
implements IAuthenticatedMode

A conventional two-pass authenticated-encrypted mode, EAX. EAX is a Authenticated Encryption with Additional Data (AEAD) scheme, which provides protection and authentication for the message, and provides authentication of an (optional) header. EAX is composed of the counter mode (CTR) and the one-key CBC MAC (OMAC).

This class makes full use of the IAuthenticatedMode interface, that is, all methods of both IMode and IMac can be used as specified in the IAuthenticatedMode interface.

References:

  1. M. Bellare, P. Rogaway, and D. Wagner; A Conventional Authenticated-Encryption Mode.

Fields inherited from interface gnu.javax.crypto.cipher.IBlockCipher

CIPHER_BLOCK_SIZE, KEY_MATERIAL

Fields inherited from interface gnu.javax.crypto.mac.IMac

MAC_KEY_MATERIAL, TRUNCATED_SIZE

Fields inherited from interface gnu.javax.crypto.mode.IMode

DECRYPTION, ENCRYPTION, IV, MODE_BLOCK_SIZE, STATE

Constructor Summary

EAX(IBlockCipher cipher, int cipherBlockSize)

Method Summary

Iterator<E>
blockSizes()
Returns an Iterator over the supported block sizes.
Object
clone()
Returns a clone copy of this instance.
int
currentBlockSize()
Returns the currently set block size for this instance.
void
decryptBlock(byte[] in, int inOff, byte[] out, int outOff)
Decrypts exactly one block of ciphertext.
int
defaultBlockSize()
Returns the default value, in bytes, of the algorithm's block size.
int
defaultKeySize()
Returns the default value, in bytes, of the algorithm's key size.
byte[]
digest()
Completes the MAC by performing final operations such as padding and resetting the instance.
void
digest(byte[] out, int outOffset)
void
encryptBlock(byte[] in, int inOff, byte[] out, int outOff)
Encrypts exactly one block of plaintext.
void
init(Map<K,V> attrib)
Initialises the algorithm with designated attributes.
Iterator<E>
keySizes()
Returns an Iterator over the supported key sizes.
int
macSize()
Returns the output length in bytes of this MAC algorithm.
String
name()
Returns the canonical name of this algorithm.
void
reset()
Resets the algorithm instance for re-initialisation and use with other characteristics.
boolean
selfTest()
A basic test.
void
update(byte b)
Continues a MAC operation using the input byte.
void
update(byte[] in, int inOff, byte[] out, int outOff)
A convenience method.
void
update(byte[] buf, int off, int len)
Continues a MAC operation, by filling the buffer, processing data in the algorithm's MAC_SIZE-bit block(s), updating the context and count, and buffering the remaining bytes in buffer for the next operation.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EAX

public EAX(IBlockCipher cipher,
           int cipherBlockSize)

Method Details

blockSizes

public Iterator<E> blockSizes()
Returns an Iterator over the supported block sizes. Each element returned by this object is an Integer.
Specified by:
blockSizes in interface IBlockCipher
Returns:
an Iterator over the supported block sizes.

clone

public Object clone()
Returns a clone copy of this instance.
Specified by:
clone in interface IBlockCipher
clone in interface IMac
Overrides:
clone in interface Object
Returns:
a clone copy of this instance.

currentBlockSize

public int currentBlockSize()
Returns the currently set block size for this instance.
Specified by:
currentBlockSize in interface IBlockCipher
Returns:
the current block size for this instance.
Throws:
IllegalStateException - if the instance is not initialised.

decryptBlock

public void decryptBlock(byte[] in,
                         int inOff,
                         byte[] out,
                         int outOff)
Decrypts exactly one block of ciphertext.
Specified by:
decryptBlock in interface IBlockCipher
Parameters:
in - the plaintext.
out - the ciphertext.
Throws:
IllegalStateException - if the instance is not initialised.

defaultBlockSize

public int defaultBlockSize()
Returns the default value, in bytes, of the algorithm's block size.
Specified by:
defaultBlockSize in interface IBlockCipher
Returns:
the default value, in bytes, of the algorithm's block size.

defaultKeySize

public int defaultKeySize()
Returns the default value, in bytes, of the algorithm's key size.
Specified by:
defaultKeySize in interface IBlockCipher
Returns:
the default value, in bytes, of the algorithm's key size.

digest

public byte[] digest()
Completes the MAC by performing final operations such as padding and resetting the instance.
Specified by:
digest in interface IMac
Returns:
the array of bytes representing the MAC value.

digest

public void digest(byte[] out,
                   int outOffset)

encryptBlock

public void encryptBlock(byte[] in,
                         int inOff,
                         byte[] out,
                         int outOff)
Encrypts exactly one block of plaintext.
Specified by:
encryptBlock in interface IBlockCipher
Parameters:
in - the plaintext.
out - the ciphertext.
Throws:
IllegalStateException - if the instance is not initialised.

init

public void init(Map<K,V> attrib)
            throws InvalidKeyException
Initialises the algorithm with designated attributes. Permissible names and values are described in the class documentation above.
Specified by:
init in interface IBlockCipher
init in interface IMac
Parameters:
Throws:
InvalidKeyException - if the key data is invalid.
IllegalStateException - if the instance is already initialised.

keySizes

public Iterator<E> keySizes()
Returns an Iterator over the supported key sizes. Each element returned by this object is an Integer.
Specified by:
keySizes in interface IBlockCipher
Returns:
an Iterator over the supported key sizes.

macSize

public int macSize()
Returns the output length in bytes of this MAC algorithm.
Specified by:
macSize in interface IMac
Returns:
the output length in bytes of this MAC algorithm.

name

public String name()
Returns the canonical name of this algorithm.
Specified by:
name in interface IBlockCipher
name in interface IMac
Returns:
the canonical name of this algorithm.

reset

public void reset()
Resets the algorithm instance for re-initialisation and use with other characteristics. This method always succeeds.
Specified by:
reset in interface IBlockCipher
reset in interface IMac

selfTest

public boolean selfTest()
A basic test. Ensures that the MAC of a pre-determined message is equal to a known pre-computed value.
Specified by:
selfTest in interface IBlockCipher
selfTest in interface IMac
Returns:
true if the implementation passes a basic self-test. Returns false otherwise.

update

public void update(byte b)
Continues a MAC operation using the input byte.
Specified by:
update in interface IMac
Parameters:
b - the input byte to digest.

update

public void update(byte[] in,
                   int inOff,
                   byte[] out,
                   int outOff)
A convenience method. Effectively invokes the encryptBlock() or decryptBlock() method depending on the operational state of the instance.
Specified by:
update in interface IMode
Parameters:
in - the plaintext.
out - the ciphertext.
Throws:
IllegalStateException - if the instance is not initialised.

update

public void update(byte[] buf,
                   int off,
                   int len)
Continues a MAC operation, by filling the buffer, processing data in the algorithm's MAC_SIZE-bit block(s), updating the context and count, and buffering the remaining bytes in buffer for the next operation.
Specified by:
update in interface IMac
Parameters:

EAX.java -- Copyright (C) 2004, 2006 Free Software Foundation, Inc. This file is a part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.