com.rockaport.alice

Class Alice

java.lang.Object

com.rockaport.alice.Alice

public class Alice
extends java.lang.Object

The main Alice API for encryption and decryption of byte arrays and files.

Constructor Summary

Constructors

Constructor and Description
Alice(AliceContext context) Initializes a new Alice object for encryption and decryption.

Method Summary

Modifier and Type	Method and Description
byte[]	decrypt(byte[] input, char[] password) Decrypts a byte array using the supplied password
void	decrypt(java.io.File input, java.io.File output, char[] password) Decrypts an input file using the supplied password
void	decrypt(java.io.InputStream input, java.io.OutputStream output, char[] password) Decrypts an input stream using the supplied password
byte[]	encrypt(byte[] input, char[] password) Encrypts a byte array using the supplied password
void	encrypt(java.io.File input, java.io.File output, char[] password) Encrypts the input file using the supplied password
void	encrypt(java.io.InputStream input, java.io.OutputStream output, char[] password) Encrypts the input stream using the supplied password
static byte[]	generateKey(AliceContext.Algorithm algorithm, AliceContext.KeyLength keyLength) Generates an AES, DES, or 3DES key

Methods inherited from class java.lang.Object

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

Constructor Detail

Alice

public Alice(AliceContext context)

Initializes a new Alice object for encryption and decryption. See AliceContext for an explanation of options.

Parameters:

context - an AliceContext

Method Detail

generateKey

public static byte[] generateKey(AliceContext.Algorithm algorithm,
                                 AliceContext.KeyLength keyLength)
                          throws java.security.GeneralSecurityException

Generates an AES, DES, or 3DES key

Parameters:

algorithm - the key will be used with

keyLength - length of key

Returns:

a byte array

Throws:

java.security.GeneralSecurityException - if either initialization or generation fails

encrypt

public byte[] encrypt(byte[] input,
                      char[] password)
               throws java.security.GeneralSecurityException,
                      java.io.IOException

Encrypts a byte array using the supplied password

Parameters:

input - the byte array input

password - the password

Returns:

an encrypted byte array

Throws:

java.security.GeneralSecurityException - if initialization or encryption fails

java.io.IOException - if there's a problem constructing the result

encrypt

public void encrypt(java.io.File input,
                    java.io.File output,
                    char[] password)
             throws java.security.GeneralSecurityException,
                    java.io.IOException

Encrypts the input file using the supplied password

Parameters:

input - the input file

output - the output file

password - the password

Throws:

java.security.GeneralSecurityException - if initialization or encryption fails

java.io.IOException - if there's a failure to read/write from/to the input/output file

encrypt

public void encrypt(java.io.InputStream input,
                    java.io.OutputStream output,
                    char[] password)
             throws java.security.GeneralSecurityException,
                    java.io.IOException

Encrypts the input stream using the supplied password

Parameters:

input - the input file

output - the output file

password - the password

Throws:

java.security.GeneralSecurityException - if initialization or encryption fails

java.io.IOException - if there's a failure to read/write from/to the input/output stream

decrypt

public byte[] decrypt(byte[] input,
                      char[] password)
               throws java.security.GeneralSecurityException

Decrypts a byte array using the supplied password

Parameters:

input - the byte array input

password - the password

Returns:

a decrypted byte array

Throws:

java.security.GeneralSecurityException - if initialization, decryption, or the MAC comparison fails

decrypt

public void decrypt(java.io.File input,
                    java.io.File output,
                    char[] password)
             throws java.security.GeneralSecurityException,
                    java.io.IOException

Decrypts an input file using the supplied password

Parameters:

input - the input file

output - the output file

password - the password

Throws:

java.security.GeneralSecurityException - if initialization or decryption fails

java.io.IOException - if there's a failure to read/write from/to the input/output file

decrypt

public void decrypt(java.io.InputStream input,
                    java.io.OutputStream output,
                    char[] password)
             throws java.security.GeneralSecurityException,
                    java.io.IOException

Decrypts an input stream using the supplied password

Parameters:

input - the input file

output - the output file

password - the password

Throws:

java.security.GeneralSecurityException - if initialization or decryption fails

java.io.IOException - if there's a failure to read/write from/to the input/output stream