org.bouncycastle.crypto.engines

Class EthereumIESEngine

java.lang.Object

org.bouncycastle.crypto.engines.EthereumIESEngine

public class EthereumIESEngine
extends java.lang.Object

Support class for constructing integrated encryption ciphers for doing basic message exchanges on top of key agreement ciphers. Follows the description given in IEEE Std 1363a.

Some tweaks added to IESEngine to conform to the Ethereum encryption approach.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EthereumIESEngine.HandshakeKDFFunction Basic KDF generator for derived keys and ivs as defined by IEEE P1363a/ISO 18033 This implementation is based on ISO 18033/P1363a.

Constructor Summary

Constructors

Constructor and Description
EthereumIESEngine(BasicAgreement agree, DerivationFunction kdf, Mac mac, byte[] commonMac) Set up for use with stream mode, where the key derivation function is used to provide a stream of bytes to xor with the message.
EthereumIESEngine(BasicAgreement agree, DerivationFunction kdf, Mac mac, byte[] commonMac, BufferedBlockCipher cipher) Set up for use in conjunction with a block cipher to handle the message.

Method Summary

Modifier and Type	Method and Description
BufferedBlockCipher	getCipher()
protected byte[]	getLengthTag(byte[] p2)
Mac	getMac()
void	init(AsymmetricKeyParameter publicKey, CipherParameters params, EphemeralKeyPairGenerator ephemeralKeyPairGenerator) Initialise the decryptor.
void	init(AsymmetricKeyParameter privateKey, CipherParameters params, KeyParser publicKeyParser) Initialise the encryptor.
void	init(boolean forEncryption, CipherParameters privParam, CipherParameters pubParam, CipherParameters params) Initialise the encryptor.
byte[]	processBlock(byte[] in, int inOff, int inLen)

Methods inherited from class java.lang.Object

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

Constructor Detail

EthereumIESEngine

public EthereumIESEngine(BasicAgreement agree,
                         DerivationFunction kdf,
                         Mac mac,
                         byte[] commonMac)

Set up for use with stream mode, where the key derivation function is used to provide a stream of bytes to xor with the message.

Parameters:

agree - the key agreement used as the basis for the encryption

kdf - the key derivation function used for byte generation

mac - the message authentication code generator for the message

commonMac - the common MAC bytes to append to the mac

EthereumIESEngine

public EthereumIESEngine(BasicAgreement agree,
                         DerivationFunction kdf,
                         Mac mac,
                         byte[] commonMac,
                         BufferedBlockCipher cipher)

Set up for use in conjunction with a block cipher to handle the message. It is strongly recommended that the cipher is not in ECB mode.

Parameters:

agree - the key agreement used as the basis for the encryption

kdf - the key derivation function used for byte generation

mac - the message authentication code generator for the message

commonMac - the common MAC bytes to append to the mac

cipher - the cipher to used for encrypting the message

Method Detail

init

public void init(boolean forEncryption,
                 CipherParameters privParam,
                 CipherParameters pubParam,
                 CipherParameters params)

Initialise the encryptor.

Parameters:

forEncryption - whether or not this is encryption/decryption.

privParam - our private key parameters

pubParam - the recipient's/sender's public key parameters

params - encoding and derivation parameters, may be wrapped to include an IV for an underlying block cipher.

init

public void init(AsymmetricKeyParameter publicKey,
                 CipherParameters params,
                 EphemeralKeyPairGenerator ephemeralKeyPairGenerator)

Initialise the decryptor.

Parameters:

publicKey - the recipient's/sender's public key parameters

params - encoding and derivation parameters, may be wrapped to include an IV for an underlying block cipher.

ephemeralKeyPairGenerator - the ephemeral key pair generator to use.

init

public void init(AsymmetricKeyParameter privateKey,
                 CipherParameters params,
                 KeyParser publicKeyParser)

Initialise the encryptor.

Parameters:

privateKey - the recipient's private key.

params - encoding and derivation parameters, may be wrapped to include an IV for an underlying block cipher.

publicKeyParser - the parser for reading the ephemeral public key.

getCipher

public BufferedBlockCipher getCipher()

getMac

public Mac getMac()

processBlock

public byte[] processBlock(byte[] in,
                           int inOff,
                           int inLen)
                    throws InvalidCipherTextException

Throws:

InvalidCipherTextException

getLengthTag

protected byte[] getLengthTag(byte[] p2)