com.sun.jbi.security

Interface KeyStoreUtil

public interface KeyStoreUtil

KeyStoreUtil provides helper methods for encrypting and decrypting Strings and/or byte arrays. An implementation is generally expected to provide at least one default key for use in encrypting and decrypting. The algorithm used for encrypting and decrypting messages is chosen by the implementation; keys must match the algorithm used by the implementation, so it's important that the implementation also be the generator of the keys! The current interface purposely tries to limit flexibility by not allowing the user to use any key or any algorithm when invoking the encrypt and decrypt methods.

Version:

$Revision: 1.5 $

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	decrypt(byte[] cipherText) Decrypts a message using a default key
String	decrypt(String base64EncodedCipherText) Decrypts a message using the key identified by keyName.
byte[]	encrypt(byte[] clearText) Encrypts a message using a default key.
String	encrypt(String clearText) Encrypts a message using a default key.

Method Detail

encrypt

byte[] encrypt(byte[] clearText)
               throws KeyStoreException

Encrypts a message using a default key.

Parameters:

clearText - the byte array that will be encrypted

Returns:

the encrypted byte array

Throws:

KeyStoreException - if any error occurs retrieving the key to be used

decrypt

byte[] decrypt(byte[] cipherText)
               throws KeyStoreException

Decrypts a message using a default key

Parameters:

cipherText - the byte array with the encrypted data

Returns:

the unencrypted byte array

Throws:

KeyStoreException - if any error occurs retrieving the key to be used

encrypt

String encrypt(String clearText)
               throws KeyStoreException

Encrypts a message using a default key. The result is a Base64-encoded string.

Parameters:

clearText - a String representing the message to be encrypted

Returns:

a Base64-encoded string representing the encrypted message

Throws:

KeyStoreException - if any error occurs retrieving the key to be used

decrypt

String decrypt(String base64EncodedCipherText)
               throws KeyStoreException

Decrypts a message using the key identified by keyName. The second argument must be a Base-64 encoded string

Parameters:

base64EncodedCipherText - a Base-64 Encoded string

Returns:

the decrypted message as a String

Throws:

KeyStoreException - if any error occurs retrieving the key to be used