ch.rgw.crypt
Interface Cryptologist

All Known Implementing Classes:

GnuPG, JCECrypter

public interface Cryptologist

A Cryptologist knows how to create keys and certificates, and encrypt, decrypt, sign and verify byte arrays and Streams.

Author:

gerry

Nested Class Summary

static class	Cryptologist.SYMM_ALGOS Algorithms for symmetric encryption
static class	Cryptologist.VERIFY_RESULT

Method Summary

boolean	addCertificate(byte[] certEncoded)
boolean	addCertificate(java.security.cert.X509Certificate cert)
Result<byte[]>	decrypt(byte[] encrypted) decrypt a byte array
void	decrypt(java.io.InputStream source, java.io.OutputStream dest)
void	decrypt(java.io.InputStream source, java.io.OutputStream dest, byte[] key) Decrypt a symmetrically encrypted stream
byte[]	encrypt(byte[] source, java.lang.String receiverKeyName) encrypt a byte array asymmetrically
void	encrypt(java.io.InputStream source, java.io.OutputStream dest, Cryptologist.SYMM_ALGOS algo, byte[] key) Encrypt a stream symmetrically with the provided key.
void	encrypt(java.io.InputStream source, java.io.OutputStream dest, java.lang.String receiverKeyName) enctrypt a Stream asymmetrically for the receiver
java.security.cert.X509Certificate	generateCertificate(java.security.PublicKey pk, java.lang.String alias, TimeTool validFrom, TimeTool validUntil)
java.security.KeyPair	generateKeys(java.lang.String alias, char[] pwd, TimeTool validFrom, TimeTool validUntil)
java.security.cert.X509Certificate	getCertificate(java.lang.String alias)
byte[]	getCertificateEncoded(java.lang.String alias)
java.lang.String	getUser()
boolean	hasCertificateOf(java.lang.String alias)
boolean	hasKeyOf(java.lang.String alias)
boolean	isFunctional()
boolean	removeCertificate(java.lang.String alias)
byte[]	sign(byte[] source) Sign a byte array (create and sign a MAC)
Cryptologist.VERIFY_RESULT	verify(byte[] data, byte[] signature, java.lang.String signerKeyName) Verify a MAC

Method Detail

encrypt

byte[] encrypt(byte[] source,
               java.lang.String receiverKeyName)

encrypt a byte array asymmetrically

Parameters:

source - the plain bytes

receiverKeyName - name of the receiver's public key

Returns:

the encrypted bytes or null if encryption failed

encrypt

void encrypt(java.io.InputStream source,
             java.io.OutputStream dest,
             java.lang.String receiverKeyName)
             throws CryptologistException

enctrypt a Stream asymmetrically for the receiver

Parameters:

source -

dest -

receiverKeyName -

Throws:

CryptologistException

encrypt

void encrypt(java.io.InputStream source,
             java.io.OutputStream dest,
             Cryptologist.SYMM_ALGOS algo,
             byte[] key)
             throws CryptologistException

Encrypt a stream symmetrically with the provided key.

Parameters:

source - the unencrypte source

dest - the encrypted destination

algo - the algorithm to use

key - the key in byte-encoded format. Must match the algorithm

Throws:

java.lang.Exception

CryptologistException

sign

byte[] sign(byte[] source)

Sign a byte array (create and sign a MAC)

Parameters:

source - the bytes to sign

Returns:

the signature

decrypt

Result<byte[]> decrypt(byte[] encrypted)

decrypt a byte array

Parameters:

encrypted - the encrypted bytes

Returns:

the plain array or null of decryption failed

decrypt

void decrypt(java.io.InputStream source,
             java.io.OutputStream dest)
             throws CryptologistException

Throws:

CryptologistException

decrypt

void decrypt(java.io.InputStream source,
             java.io.OutputStream dest,
             byte[] key)
             throws CryptologistException

Decrypt a symmetrically encrypted stream

Parameters:

source - the encrypted origin

dest - the decrypted destination

key - the key to use (must be in approprioate format for encryption method. The Method will be read from the Stream header)

Throws:

CryptologistException

java.io.IOException

verify

Cryptologist.VERIFY_RESULT verify(byte[] data,
                                  byte[] signature,
                                  java.lang.String signerKeyName)

Verify a MAC

Parameters:

data - the signed data

signature - the signed digest

signerKeyName - name of the signer's public key

Returns:

hasCertificateOf

boolean hasCertificateOf(java.lang.String alias)

hasKeyOf

boolean hasKeyOf(java.lang.String alias)

addCertificate

boolean addCertificate(java.security.cert.X509Certificate cert)

addCertificate

boolean addCertificate(byte[] certEncoded)

removeCertificate

boolean removeCertificate(java.lang.String alias)

generateKeys

java.security.KeyPair generateKeys(java.lang.String alias,
                                   char[] pwd,
                                   TimeTool validFrom,
                                   TimeTool validUntil)

getCertificate

java.security.cert.X509Certificate getCertificate(java.lang.String alias)

generateCertificate

java.security.cert.X509Certificate generateCertificate(java.security.PublicKey pk,
                                                       java.lang.String alias,
                                                       TimeTool validFrom,
                                                       TimeTool validUntil)

getUser

java.lang.String getUser()

isFunctional

boolean isFunctional()

getCertificateEncoded

byte[] getCertificateEncoded(java.lang.String alias)
                             throws CryptologistException

Throws:

CryptologistException