org.symphonyoss.s2.common.crypto.cipher

Interface ISymmetricCipherSuite

All Superinterfaces:

ICipherSuite

public interface ISymmetricCipherSuite
extends ICipherSuite

Method Summary

Modifier and Type	Method and Description
IDecryptedInputStream	createDecryptedInputStream(SecretKey key, byte[] encryptedData)
IEncryptedOutputStream	createEncryptedOutputStream(SecretKey key)
byte[]	decrypt(SecretKey key, byte[] cipherText) Decrypt the given Base64 encoded cipher test using the given key.
byte[]	encrypt(SecretKey secretKey, byte[] data) Encrypt the given binary data with the given key and return a Base64 encoded String containing the encrypted form.
SecretKey	generateKey()
SymmetricCipher	getId() Get the unique ID for this cipher suite.
int	getKeySize(SecretKey key)
PrivateKey	unwrap(byte[] cipherText, SecretKey userKey, IAsymmetricCipherSuite cipherSuite) Unwrap the given encrypted PrivateKey
byte[]	wrap(PrivateKey key, SecretKey userKey) Wrap the given asymmetric key by encrypting with the given user's secret key.

Methods inherited from interface org.symphonyoss.s2.common.crypto.cipher.ICipherSuite

getCipher, getKeyAlgorithm, getKeySize

Method Detail

getId

SymmetricCipher getId()

Get the unique ID for this cipher suite.

Returns:

The unique ID of this cipher suite.

generateKey

SecretKey generateKey()

encrypt

byte[] encrypt(SecretKey secretKey,
               byte[] data)
        throws GeneralSecurityException

Encrypt the given binary data with the given key and return a Base64 encoded String containing the encrypted form.

Parameters:

secretKey - Encryption key

data - Plain text.

Returns:

ciphertext

Throws:

GeneralSecurityException

decrypt

byte[] decrypt(SecretKey key,
               byte[] cipherText)
        throws GeneralSecurityException

Decrypt the given Base64 encoded cipher test using the given key.

Parameters:

key - Decryption key.

cipherText - ciphertext.

Returns:

Plaintext.

Throws:

GeneralSecurityException

createDecryptedInputStream

IDecryptedInputStream createDecryptedInputStream(SecretKey key,
                                                 byte[] encryptedData)
                                          throws GeneralSecurityException,
                                                 IOException

Throws:

GeneralSecurityException

IOException

createEncryptedOutputStream

IEncryptedOutputStream createEncryptedOutputStream(SecretKey key)
                                            throws IOException

Throws:

IOException

wrap

byte[] wrap(PrivateKey key,
            SecretKey userKey)
     throws GeneralSecurityException

Wrap the given asymmetric key by encrypting with the given user's secret key.

Parameters:

key - Key to be wrapped.

userKey - Secret key of user for whom it is wrapped.

Returns:

ciphertext of wrapped key.

Throws:

GeneralSecurityException

unwrap

PrivateKey unwrap(byte[] cipherText,
                  SecretKey userKey,
                  IAsymmetricCipherSuite cipherSuite)
           throws GeneralSecurityException

Unwrap the given encrypted PrivateKey

Parameters:

cipherText - Encrypted key to be unwrapped.

userKey - Wrapping key.

cipherSuite - Wrapping cipherSuite

Returns:

The SecretKey.

Throws:

GeneralSecurityException

getKeySize

int getKeySize(SecretKey key)