freenet.crypt

Class CryptByteBuffer

java.lang.Object

freenet.crypt.CryptByteBuffer

All Implemented Interfaces:

java.io.Serializable

public final class CryptByteBuffer
extends java.lang.Object
implements java.io.Serializable

CryptByteBuffer will encrypt and decrypt both byte[]s and BitSets with a specified algorithm, key, and also an iv if the algorithm requires one. Note that the input and the output are the same length, i.e. these are either stream ciphers or non-padded block ciphers (where it must be called with whole blocks). For a stream cipher, once a CryptByteBuffer is initialised, processed bytes will be treated as a single stream, i.e. repeatedly encrypting the same data will give different results.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CryptByteBuffer(CryptByteBufferType type, byte[] key) Creates an instance of CryptByteBuffer that will be able to encrypt and decrypt sets of bytes using the specified algorithm type with the given key.
CryptByteBuffer(CryptByteBufferType type, byte[] key, byte[] iv) Creates an instance of CryptByteBuffer that will be able to encrypt and decrypt sets of bytes using the specified algorithm type with the given key and iv.
CryptByteBuffer(CryptByteBufferType type, byte[] key, byte[] iv, int offset) Creates an instance of CryptByteBuffer that will be able to encrypt and decrypt sets of bytes using the specified algorithm type with the given key and iv.
CryptByteBuffer(CryptByteBufferType type, java.nio.ByteBuffer key) Creates an instance of CryptByteBuffer that will be able to encrypt and decrypt sets of bytes using the specified algorithm type with the given key.
CryptByteBuffer(CryptByteBufferType type, java.nio.ByteBuffer key, java.nio.ByteBuffer iv) Creates an instance of CryptByteBuffer that will be able to encrypt and decrypt sets of bytes using the specified algorithm type with the given key and iv.
CryptByteBuffer(CryptByteBufferType type, javax.crypto.SecretKey key) Creates an instance of CryptByteBuffer that will be able to encrypt and decrypt sets of bytes using the specified algorithm type with the given key.
CryptByteBuffer(CryptByteBufferType type, javax.crypto.SecretKey key, byte[] iv) Creates an instance of CryptByteBuffer that will be able to encrypt and decrypt sets of bytes using the specified algorithm type with the given key and iv.
CryptByteBuffer(CryptByteBufferType type, javax.crypto.SecretKey key, byte[] iv, int offset) Creates an instance of CryptByteBuffer that will be able to encrypt and decrypt sets of bytes using the specified algorithm type with the given key and iv.
CryptByteBuffer(CryptByteBufferType type, javax.crypto.SecretKey key, java.nio.ByteBuffer iv) Creates an instance of CryptByteBuffer that will be able to encrypt and decrypt sets of bytes using the specified algorithm type with the given key and iv.
CryptByteBuffer(CryptByteBufferType type, javax.crypto.SecretKey key, javax.crypto.spec.IvParameterSpec iv) Creates an instance of CryptByteBuffer that will be able to encrypt and decrypt sets of bytes using the specified algorithm type with the given key.

Method Summary

Modifier and Type	Method and Description
void	decrypt(byte[] input, int offset, int len) Decrypt the specified section of the provided byte[] in-place
void	decrypt(byte[] input, int offset, int len, byte[] output, int outputOffset) Decrypt the specified section of the provided byte[] to the output byte[], without modifying the input.
void	decrypt(java.nio.ByteBuffer input, java.nio.ByteBuffer output) Get bytes from one ByteBuffer and encrypt them and put them into the other ByteBuffer.
byte[]	decryptCopy(byte[] input) Decrypts the provided byte[].
byte[]	decryptCopy(byte[] input, int offset, int len) Decrypts the specified section of provided byte[] into an array which is returned as a ByteBuffer.
java.nio.ByteBuffer	decryptCopy(java.nio.ByteBuffer input) Decrypts the provided ByteBuffer, returning a new ByteBuffer.
void	encrypt(byte[] input, int offset, int len) Encrypt the specified section of the provided byte[] in-place
void	encrypt(byte[] input, int offset, int len, byte[] output, int outputOffset) Encrypt the specified section of the provided byte[] to the output byte[], without modifying the input.
void	encrypt(java.nio.ByteBuffer input, java.nio.ByteBuffer output) Get bytes from one ByteBuffer and encrypt them and put them into the other ByteBuffer.
byte[]	encryptCopy(byte[] input) Encrypts the provided byte[].
byte[]	encryptCopy(byte[] input, int offset, int len) Encrypts the specified section of provided byte[] into a new array returned as a ByteBuffer.
java.nio.ByteBuffer	encryptCopy(java.nio.ByteBuffer input) Encrypts the provided ByteBuffer, returning a new ByteBuffer.
javax.crypto.spec.IvParameterSpec	genIV() Generates a new IV to be used and initializes the cipher instances with the new iv.
javax.crypto.spec.IvParameterSpec	getIV() Gets the IV being used.
void	setIV(javax.crypto.spec.IvParameterSpec iv) Changes the current iv to the provided iv and initializes the cipher instances with the new iv.

Methods inherited from class java.lang.Object

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

Constructor Detail

CryptByteBuffer

public CryptByteBuffer(CryptByteBufferType type,
                       javax.crypto.SecretKey key,
                       javax.crypto.spec.IvParameterSpec iv)
                throws java.security.InvalidKeyException,
                       java.security.InvalidAlgorithmParameterException

Creates an instance of CryptByteBuffer that will be able to encrypt and decrypt sets of bytes using the specified algorithm type with the given key. If the algorithm requires an iv, it will either use the one passed in, or if that is null, it will generate a random one.

Parameters:

type - The symmetric algorithm, mode, and key and block size to use

key - The key that will be used for encryption

iv - The iv that will be used for encryption.

Throws:

java.security.InvalidAlgorithmParameterException

java.security.InvalidKeyException

CryptByteBuffer

public CryptByteBuffer(CryptByteBufferType type,
                       javax.crypto.SecretKey key)
                throws java.security.GeneralSecurityException

Creates an instance of CryptByteBuffer that will be able to encrypt and decrypt sets of bytes using the specified algorithm type with the given key. If the algorithm requires an iv, it will generate a random one.

Parameters:

type - The symmetric algorithm, mode, and key and block size to use

key - The key that will be used for encryption

Throws:

java.security.InvalidAlgorithmParameterException

java.security.InvalidKeyException

java.security.GeneralSecurityException

CryptByteBuffer

public CryptByteBuffer(CryptByteBufferType type,
                       byte[] key)
                throws java.security.GeneralSecurityException

Creates an instance of CryptByteBuffer that will be able to encrypt and decrypt sets of bytes using the specified algorithm type with the given key. If the algorithm requires an iv, it will generate a random one.

Parameters:

type - The symmetric algorithm, mode, and key and block size to use

key - The key that will be used for encryption

Throws:

java.security.InvalidAlgorithmParameterException

java.security.InvalidKeyException

java.security.GeneralSecurityException

CryptByteBuffer

public CryptByteBuffer(CryptByteBufferType type,
                       java.nio.ByteBuffer key)
                throws java.security.GeneralSecurityException

Creates an instance of CryptByteBuffer that will be able to encrypt and decrypt sets of bytes using the specified algorithm type with the given key. If the algorithm requires an iv, it will generate a random one.

Parameters:

type - The symmetric algorithm, mode, and key and block size to use

key - The key that will be used for encryption

Throws:

java.security.InvalidAlgorithmParameterException

java.security.InvalidKeyException

java.security.GeneralSecurityException

CryptByteBuffer

public CryptByteBuffer(CryptByteBufferType type,
                       javax.crypto.SecretKey key,
                       byte[] iv,
                       int offset)
                throws java.security.InvalidKeyException,
                       java.security.InvalidAlgorithmParameterException

Creates an instance of CryptByteBuffer that will be able to encrypt and decrypt sets of bytes using the specified algorithm type with the given key and iv. The iv will be extracted from the passed in byte[] starting at the offset using the length provided by type.ivSize

Parameters:

type - The symmetric algorithm, mode, and key and block size to use

key - The key that will be used for encryption

iv - The byte[] containing the iv

offset - Where in the byte[] the iv starts

Throws:

java.security.InvalidKeyException

java.security.InvalidAlgorithmParameterException

CryptByteBuffer

public CryptByteBuffer(CryptByteBufferType type,
                       javax.crypto.SecretKey key,
                       byte[] iv)
                throws java.security.InvalidKeyException,
                       java.security.InvalidAlgorithmParameterException

Creates an instance of CryptByteBuffer that will be able to encrypt and decrypt sets of bytes using the specified algorithm type with the given key and iv.

Parameters:

type - The symmetric algorithm, mode, and key and block size to use

key - The key that will be used for encryption

iv - The iv that will be used for encryption.

Throws:

java.security.InvalidAlgorithmParameterException

java.security.InvalidKeyException

CryptByteBuffer

public CryptByteBuffer(CryptByteBufferType type,
                       javax.crypto.SecretKey key,
                       java.nio.ByteBuffer iv)
                throws java.security.InvalidKeyException,
                       java.security.InvalidAlgorithmParameterException

Creates an instance of CryptByteBuffer that will be able to encrypt and decrypt sets of bytes using the specified algorithm type with the given key and iv.

Parameters:

type - The symmetric algorithm, mode, and key and block size to use

key - The key that will be used for encryption

iv - The iv that will be used for encryption.

Throws:

java.security.InvalidAlgorithmParameterException

java.security.InvalidKeyException

CryptByteBuffer

public CryptByteBuffer(CryptByteBufferType type,
                       byte[] key,
                       byte[] iv,
                       int offset)
                throws java.security.InvalidKeyException,
                       java.security.InvalidAlgorithmParameterException

Creates an instance of CryptByteBuffer that will be able to encrypt and decrypt sets of bytes using the specified algorithm type with the given key and iv. The iv will be extracted from the passed in byte[] starting at the offset using the length provided by type.ivSize

Parameters:

type - The symmetric algorithm, mode, and key and block size to use

key - The key that will be used for encryption

iv - The byte[] containing the iv

offset - Where in the byte[] the iv starts

Throws:

java.security.InvalidKeyException

java.security.InvalidAlgorithmParameterException

CryptByteBuffer

public CryptByteBuffer(CryptByteBufferType type,
                       byte[] key,
                       byte[] iv)
                throws java.security.InvalidKeyException,
                       java.security.InvalidAlgorithmParameterException

Creates an instance of CryptByteBuffer that will be able to encrypt and decrypt sets of bytes using the specified algorithm type with the given key and iv.

Parameters:

type - The symmetric algorithm, mode, and key and block size to use

key - The key that will be used for encryption

iv - The iv that will be used for encryption.

Throws:

java.security.InvalidAlgorithmParameterException

java.security.InvalidKeyException

CryptByteBuffer

public CryptByteBuffer(CryptByteBufferType type,
                       java.nio.ByteBuffer key,
                       java.nio.ByteBuffer iv)
                throws java.security.InvalidKeyException,
                       java.security.InvalidAlgorithmParameterException

Creates an instance of CryptByteBuffer that will be able to encrypt and decrypt sets of bytes using the specified algorithm type with the given key and iv.

Parameters:

type - The symmetric algorithm, mode, and key and block size to use

key - The key that will be used for encryption

iv - The iv that will be used for encryption.

Throws:

java.security.InvalidAlgorithmParameterException

java.security.InvalidKeyException

Method Detail

encrypt

public void encrypt(byte[] input,
                    int offset,
                    int len,
                    byte[] output,
                    int outputOffset)

Encrypt the specified section of the provided byte[] to the output byte[], without modifying the input.

encrypt

public void encrypt(byte[] input,
                    int offset,
                    int len)

Encrypt the specified section of the provided byte[] in-place

encryptCopy

public byte[] encryptCopy(byte[] input,
                          int offset,
                          int len)

Encrypts the specified section of provided byte[] into a new array returned as a ByteBuffer. Does not modify the original array. If you are using a RijndaelECB alg then len must equal the block size.

Parameters:

input - The bytes to be encrypted. Contents will not be modified.

offset - The position of input to start encrypting at

len - The number of bytes after offset to encrypt

Returns:

Returns a new array containing the ciphertext encoding the specified range.

encryptCopy

public byte[] encryptCopy(byte[] input)

Encrypts the provided byte[]. If you are using a RijndaelECB alg then the length of input must equal the block size.

Parameters:

input - The byte[] to be encrypted

Returns:

The encrypted data. The original data will be unchanged.

encryptCopy

public java.nio.ByteBuffer encryptCopy(java.nio.ByteBuffer input)

Encrypts the provided ByteBuffer, returning a new ByteBuffer. Only reads the bytes that are actually readable, i.e. from position to limit, so equivalent to get()ing into a buffer, encrypting that and returning. If you are using a RijndaelECB alg then the length of input must equal the block size.

Parameters:

input - The byte[] to be encrypted

Returns:

A new ByteBuffer containing the ciphertext. It will have a backing array and its arrayOffset() will be 0, its position will be 0 and its capacity will be the length of the input data.

encrypt

public void encrypt(java.nio.ByteBuffer input,
                    java.nio.ByteBuffer output)

Get bytes from one ByteBuffer and encrypt them and put them into the other ByteBuffer.

decrypt

public void decrypt(byte[] input,
                    int offset,
                    int len,
                    byte[] output,
                    int outputOffset)

Decrypt the specified section of the provided byte[] to the output byte[], without modifying the input.

decrypt

public void decrypt(byte[] input,
                    int offset,
                    int len)

Decrypt the specified section of the provided byte[] in-place

decryptCopy

public byte[] decryptCopy(byte[] input,
                          int offset,
                          int len)

Decrypts the specified section of provided byte[] into an array which is returned as a ByteBuffer. Does not modify the original array. If you are using a RijndaelECB alg then len must equal the block size.

Parameters:

input - The bytes to be decrypted. Contents will not be modified.

offset - The position of input to start decrypting at

len - The number of bytes after offset to decrypt

Returns:

Returns the decrypted plaintext, a newly allocated byte array of the same length as the input data.

decryptCopy

public byte[] decryptCopy(byte[] input)

Decrypts the provided byte[]. If you are using a RijndaelECB alg then the length of input must equal the block size.

Parameters:

input - The byte[] to be decrypted

Returns:

The decrypted plaintext bytes.

decryptCopy

public java.nio.ByteBuffer decryptCopy(java.nio.ByteBuffer input)

Decrypts the provided ByteBuffer, returning a new ByteBuffer. Only reads the bytes that are actually readable, i.e. from position to limit, so equivalent to get()ing into a buffer, decrypting that and returning. If you are using a RijndaelECB alg then the length of input must equal the block size.

Parameters:

input - The buffer to be decrypted

Returns:

A new ByteBuffer containing the plaintext. It will have a backing array and its arrayOffset() will be 0, its position will be 0 and its capacity will be the length of the input data.

decrypt

public void decrypt(java.nio.ByteBuffer input,
                    java.nio.ByteBuffer output)

Get bytes from one ByteBuffer and encrypt them and put them into the other ByteBuffer.

setIV

public void setIV(javax.crypto.spec.IvParameterSpec iv)
           throws java.security.InvalidAlgorithmParameterException

Changes the current iv to the provided iv and initializes the cipher instances with the new iv. Only works with algorithms that support IVs, not RijndaelPCFB.

Parameters:

iv - The new iv to use as IvParameterSpec

Throws:

java.security.InvalidAlgorithmParameterException

genIV

public javax.crypto.spec.IvParameterSpec genIV()

Generates a new IV to be used and initializes the cipher instances with the new iv. Only works with algorithms that support IVs, not RijndaelPCFB.

Returns:

The generated IV

getIV

public javax.crypto.spec.IvParameterSpec getIV()

Gets the IV being used. Only works with algorithms that support IVs.

Returns:

Returns the iv as a IvParameterSpec