org.owasp.esapi
Class Encryptor

java.lang.Object
  org.owasp.esapi.Encryptor

All Implemented Interfaces:

IEncryptor

public class Encryptor

extends java.lang.Object

implements IEncryptor

Reference implementation of the IEncryptor interface. This implementation layers on the JCE provided cryptographic package. Algorithms used are configurable in the ESAPI.properties file.

Since:

June 1, 2007

Author:

Jeff Williams (jeff.williams .at. aspectsecurity.com) Aspect Security

See Also:

IEncryptor

Constructor Summary

Encryptor()

Method Summary

java.lang.String	decrypt(java.lang.String ciphertext) Decrypts the provided ciphertext string (encrypted with the encrypt method) and returns a plaintext string.
java.lang.String	encrypt(java.lang.String plaintext) Encrypts the provided plaintext and returns a ciphertext string.
long	getRelativeTimeStamp(long offset) Gets a timestamp representing an offset from the current time to be used by other functions in the library.
long	getTimeStamp() Gets a timestamp representing the current date and time to be used by other functions in the library.
java.lang.String	hash(java.lang.String plaintext, java.lang.String salt) Hashes the data using the specified algorithm and the Java MessageDigest class.
java.lang.String	seal(java.lang.String data, long expiration) Creates a seal that binds a set of data and an expiration timestamp.
java.lang.String	sign(java.lang.String data) Create a digital signature for the provided data and return it in a string.
java.lang.String	unseal(java.lang.String seal) Unseals data (created with the seal method) and throws an exception describing any of the various problems that could exist with a seal, such as an invalid seal format, expired timestamp, or decryption error.
boolean	verifySeal(java.lang.String seal) Verifies a seal (created with the seal method) and throws an exception describing any of the various problems that could exist with a seal, such as an invalid seal format, expired timestamp, or data mismatch.
boolean	verifySignature(java.lang.String signature, java.lang.String data) Verifies a digital signature (created with the sign method) and returns the boolean result.

Methods inherited from class java.lang.Object

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

Constructor Detail

Encryptor

public Encryptor()

Method Detail

hash

public java.lang.String hash(java.lang.String plaintext,
                             java.lang.String salt)
                      throws EncryptionException

Hashes the data using the specified algorithm and the Java MessageDigest class. This method first adds the salt, then the data, and then rehashes 1024 times to help strengthen weak passwords.

Specified by:

hash in interface IEncryptor

Parameters:

plaintext - the plaintext

salt - the salt

Returns:

the string

Throws:

EncryptionException - the encryption exception

See Also:

IEncryptor.hash(java.lang.String,java.lang.String)

encrypt

public java.lang.String encrypt(java.lang.String plaintext)
                         throws EncryptionException

Description copied from interface: IEncryptor

Encrypts the provided plaintext and returns a ciphertext string.

Specified by:

encrypt in interface IEncryptor

Parameters:

plaintext - the plaintext

Returns:

the string

Throws:

EncryptionException - the encryption exception

decrypt

public java.lang.String decrypt(java.lang.String ciphertext)
                         throws EncryptionException

Description copied from interface: IEncryptor

Decrypts the provided ciphertext string (encrypted with the encrypt method) and returns a plaintext string.

Specified by:

decrypt in interface IEncryptor

Parameters:

ciphertext - the ciphertext

Returns:

the string

Throws:

EncryptionException - the encryption exception

sign

public java.lang.String sign(java.lang.String data)
                      throws EncryptionException

Description copied from interface: IEncryptor

Create a digital signature for the provided data and return it in a string.

Specified by:

sign in interface IEncryptor

Parameters:

data - the data

Returns:

the string

Throws:

EncryptionException - the encryption exception

verifySignature

public boolean verifySignature(java.lang.String signature,
                               java.lang.String data)

Description copied from interface: IEncryptor

Verifies a digital signature (created with the sign method) and returns the boolean result.

Specified by:

verifySignature in interface IEncryptor

Parameters:

signature - the signature

data - the data

Returns:

true, if successful

seal

public java.lang.String seal(java.lang.String data,
                             long expiration)
                      throws IntegrityException

Description copied from interface: IEncryptor

Creates a seal that binds a set of data and an expiration timestamp.

Specified by:

seal in interface IEncryptor

Parameters:

data - the data

expiration - the timestamp of the expiration date of the data.

Returns:

the string

Throws:

IntegrityException

unseal

public java.lang.String unseal(java.lang.String seal)
                        throws EncryptionException

Description copied from interface: IEncryptor

Unseals data (created with the seal method) and throws an exception describing any of the various problems that could exist with a seal, such as an invalid seal format, expired timestamp, or decryption error.

Specified by:

unseal in interface IEncryptor

Parameters:

seal - the seal

Throws:

EncryptionException

verifySeal

public boolean verifySeal(java.lang.String seal)

Description copied from interface: IEncryptor

Verifies a seal (created with the seal method) and throws an exception describing any of the various problems that could exist with a seal, such as an invalid seal format, expired timestamp, or data mismatch.

Specified by:

verifySeal in interface IEncryptor

Parameters:

seal - the seal

getTimeStamp

public long getTimeStamp()

Description copied from interface: IEncryptor

Gets a timestamp representing the current date and time to be used by other functions in the library.

Specified by:

getTimeStamp in interface IEncryptor

Returns:

the timestamp

getRelativeTimeStamp

public long getRelativeTimeStamp(long offset)

Description copied from interface: IEncryptor

Gets a timestamp representing an offset from the current time to be used by other functions in the library.

Specified by:

getRelativeTimeStamp in interface IEncryptor

Returns:

the timestamp