Package org.symphonyoss.s2.common.crypto.cipher

Interface ISymmetricCipherSuite

All Superinterfaces:

ICipherSuite

public interface ISymmetricCipherSuite
extends ICipherSuite

Method Summary

Modifier and Type	Method	Description
IDecryptedInputStream	createDecryptedInputStream(javax.crypto.SecretKey key, byte[] encryptedData)
IEncryptedOutputStream	createEncryptedOutputStream(javax.crypto.SecretKey key)
byte[]	decrypt(javax.crypto.SecretKey key, byte[] cipherText)	Decrypt the given Base64 encoded cipher test using the given key.
byte[]	encrypt(javax.crypto.SecretKey secretKey, byte[] data)	Encrypt the given binary data with the given key and return a Base64 encoded String containing the encrypted form.
javax.crypto.SecretKey	generateKey()
SymmetricCipher	getId()	Get the unique ID for this cipher suite.
int	getKeySize(javax.crypto.SecretKey key)
java.security.PrivateKey	unwrap(byte[] cipherText, javax.crypto.SecretKey userKey, IAsymmetricCipherSuite cipherSuite)	Unwrap the given encrypted PrivateKey
byte[]	wrap(java.security.PrivateKey key, javax.crypto.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

javax.crypto.SecretKey generateKey()

encrypt

byte[] encrypt(javax.crypto.SecretKey secretKey,
               byte[] data)
        throws java.security.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:

java.security.GeneralSecurityException

decrypt

byte[] decrypt(javax.crypto.SecretKey key,
               byte[] cipherText)
        throws java.security.GeneralSecurityException

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

Parameters:

key - Decryption key.

cipherText - ciphertext.

Returns:

Plaintext.

Throws:

java.security.GeneralSecurityException

createDecryptedInputStream

IDecryptedInputStream createDecryptedInputStream(javax.crypto.SecretKey key,
                                                 byte[] encryptedData)
                                          throws java.security.GeneralSecurityException,
                                                 java.io.IOException

Throws:

java.security.GeneralSecurityException

java.io.IOException

createEncryptedOutputStream

IEncryptedOutputStream createEncryptedOutputStream(javax.crypto.SecretKey key)
                                            throws java.io.IOException

Throws:

java.io.IOException

wrap

byte[] wrap(java.security.PrivateKey key,
            javax.crypto.SecretKey userKey)
     throws java.security.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:

java.security.GeneralSecurityException

unwrap

java.security.PrivateKey unwrap(byte[] cipherText,
                                javax.crypto.SecretKey userKey,
                                IAsymmetricCipherSuite cipherSuite)
                         throws java.security.GeneralSecurityException

Unwrap the given encrypted PrivateKey

Parameters:

cipherText - Encrypted key to be unwrapped.

userKey - Wrapping key.

cipherSuite - Wrapping cipherSuite

Returns:

The SecretKey.

Throws:

java.security.GeneralSecurityException

getKeySize

int getKeySize(javax.crypto.SecretKey key)