craterdog.security

Interface MessageEncryption

All Known Implementing Classes:

MessageCryptex

public interface MessageEncryption

This interface defines the methods needed to do message level symmetric key encryption when the sender and receiver have already exchanged their asymmetric public keys.

Author:

Derk Norton

Method Summary

Modifier and Type	Method and Description
String	encodeBytes(byte[] bytes) This method encodes a byte array into a base 64 string.
CipherOutputStream	encryptionOutputStream(SecretKey sharedKey, OutputStream output) This method generates an output stream that performs encryption on another output stream.
byte[]	encryptSharedKey(PublicKey certificate, SecretKey sharedKey) This method encrypts a shared key using the public certificate of the destination for a data stream that will be encrypted using the shared key.
void	encryptStream(SecretKey sharedKey, InputStream input, OutputStream output) This method encrypts a byte stream using a shared key.
byte[]	encryptString(SecretKey sharedKey, String string) This method encrypts a string using a shared key.
SecretKey	generateSharedKey() This method generates a shared (secret) key to be used for encrypting large amounts of data.
String	getAsymmetricEncryptionAlgorithm() This method returns the asymmetric encryption algorithm used by this cryptex.
String	getAsymmetricSignatureAlgorithm() This method returns the asymmetric signature algorithm used by this cryptex.
String	getEncodingType() This method returns the encoding type supported by this cryptex.
String	getHashAlgorithm() This method returns the hash algorithm.
String	getSymmetricEncryptionAlgorithm() This method returns the symmetric encryption algorithm used by this cryptex.
int	getSymmetricKeySize() This method returns the symmetric key size used by this cryptex.
String	hashString(String string) This method returns a base 64 encoded SHA256 one-way hash of the specified string.
byte[]	signBytes(PrivateKey privateKey, byte[] bytes) This method signs a byte array.

Method Detail

getEncodingType

String getEncodingType()

This method returns the encoding type supported by this cryptex.

Returns:

The HTTP encoding type.

getHashAlgorithm

String getHashAlgorithm()

This method returns the hash algorithm.

Returns:

The hash algorithm.

getAsymmetricSignatureAlgorithm

String getAsymmetricSignatureAlgorithm()

This method returns the asymmetric signature algorithm used by this cryptex.

Returns:

The name of the algorithm.

getAsymmetricEncryptionAlgorithm

String getAsymmetricEncryptionAlgorithm()

This method returns the asymmetric encryption algorithm used by this cryptex.

Returns:

The name of the algorithm.

getSymmetricEncryptionAlgorithm

String getSymmetricEncryptionAlgorithm()

This method returns the symmetric encryption algorithm used by this cryptex.

Returns:

The name of the algorithm.

getSymmetricKeySize

int getSymmetricKeySize()

This method returns the symmetric key size used by this cryptex.

Returns:

The size of the symmetric keys.

encodeBytes

String encodeBytes(byte[] bytes)

This method encodes a byte array into a base 64 string.

Parameters:

bytes - The byte array to be encoded.

Returns:

The base 64 encoded string for those bytes.

signBytes

byte[] signBytes(PrivateKey privateKey,
                 byte[] bytes)

This method signs a byte array.

Parameters:

privateKey - The private key used for signing.

bytes - The byte array to be signed.

Returns:

The resulting signature.

generateSharedKey

SecretKey generateSharedKey()

This method generates a shared (secret) key to be used for encrypting large amounts of data.

Returns:

The new shared (secret) key.

encryptSharedKey

byte[] encryptSharedKey(PublicKey certificate,
                        SecretKey sharedKey)

This method encrypts a shared key using the public certificate of the destination for a data stream that will be encrypted using the shared key. Shared key-based encryption is much faster than public/private key pair-based encryption. But the shared key must be passed to the destination for this to work so the shared key is first encrypted using public/private key encryption.

Parameters:

certificate - The public certificate of the destination.

sharedKey - The shared key to be encrypted.

Returns:

The encrypted shared key.

encryptString

byte[] encryptString(SecretKey sharedKey,
                     String string)

This method encrypts a string using a shared key.

Parameters:

sharedKey - The shared key used for the encryption.

string - The string to be encrypted.

Returns:

The encrypted string.

encryptStream

void encryptStream(SecretKey sharedKey,
                   InputStream input,
                   OutputStream output)
            throws IOException

This method encrypts a byte stream using a shared key.

Parameters:

sharedKey - The shared key used for the encryption.

input - The byte stream to be encrypted.

output - The encrypted output stream.

Throws:

IOException - Unable to encrypt the stream.

encryptionOutputStream

CipherOutputStream encryptionOutputStream(SecretKey sharedKey,
                                          OutputStream output)
                                   throws IOException

This method generates an output stream that performs encryption on another output stream.

Parameters:

sharedKey - The shared key used for the encryption.

output - The output stream to be encrypted.

Returns:

The encrypting output stream.

Throws:

IOException - Unable to create an encryption output stream.

hashString

String hashString(String string)

This method returns a base 64 encoded SHA256 one-way hash of the specified string.

Parameters:

string - The string to be hashed.

Returns:

A base 64 encoded one-way hash of the string.