com.virgilsecurity.sdk.crypto

Interface Crypto

All Known Implementing Classes:

VirgilCrypto

public interface Crypto

This interface describes generic Crypto functionality.

Author:

Andrii Iakovenko

Method Summary

Modifier and Type	Method and Description
Fingerprint	calculateFingerprint(byte[] content) Calculate fingerprint.
byte[]	computeHash(byte[] data, HashAlgorithm algorithm) Compute data hash with algorithm specified.
byte[]	decrypt(byte[] data, PrivateKey privateKey) Decrypt byte array with private key.
void	decrypt(InputStream inputStream, OutputStream outputStream, PrivateKey privateKey) Decrypt stream data with private key.
byte[]	decryptThenVerify(byte[] cipherData, PrivateKey privateKey, PublicKey publicKey) Decrypt data and verify.
byte[]	encrypt(byte[] data, PublicKey recipient) Encrypt byte array for single recipient.
byte[]	encrypt(byte[] data, PublicKey[] recipients) Encrypt byte array with public key set.
void	encrypt(InputStream inputStream, OutputStream outputStream, PublicKey recipient) Encrypt stream data with public key.
void	encrypt(InputStream inputStream, OutputStream outputStream, PublicKey[] recipients) Encrypt stream data with public key set.
byte[]	exportPrivateKey(PrivateKey privateKey) Export private key as byte array.
byte[]	exportPrivateKey(PrivateKey privateKey, String password) Export private key as byte array.
byte[]	exportPublicKey(PublicKey publicKey) Export public key as byte array.
PublicKey	extractPublicKey(PrivateKey privateKey) Extract public key from private key.
KeyPair	generateKeys() Generate key pair.
PrivateKey	importPrivateKey(byte[] keyData) Import private key from byte array.
PrivateKey	importPrivateKey(byte[] keyData, String password) Import private key from byte array.
PublicKey	importPublicKey(byte[] publicKey) Import public key from byte array.
byte[]	sign(byte[] data, PrivateKey privateKey) Sign byte array data with private key.
byte[]	sign(InputStream inputStream, PrivateKey privateKey) Sign stream data with private key.
byte[]	signThenEncrypt(byte[] data, PrivateKey privateKey, PublicKey recipient) Sign data and encrypt.
byte[]	signThenEncrypt(byte[] data, PrivateKey privateKey, PublicKey[] recipients) Sign data and encrypt.
boolean	verify(byte[] data, byte[] signature, PublicKey signer) Verify byte array with signature.
boolean	verify(InputStream inputStream, byte[] signature, PublicKey signer) Verify stream data with signature.

Method Detail

calculateFingerprint

Fingerprint calculateFingerprint(byte[] content)

Calculate fingerprint.

Parameters:

content - The data to calculate fingerprint for.

Returns:

the fingerprint as String.

computeHash

byte[] computeHash(byte[] data,
                   HashAlgorithm algorithm)

Compute data hash with algorithm specified.

Parameters:

data - the data for hashing.

algorithm - the algorithm to be used for hash calculation.

Returns:

the hash code.

decrypt

byte[] decrypt(byte[] data,
               PrivateKey privateKey)

Decrypt byte array with private key.

Parameters:

data - the data to be decrypted.

privateKey - the recipients private key.

Returns:

the decrypted data as byte array.

decrypt

void decrypt(InputStream inputStream,
             OutputStream outputStream,
             PrivateKey privateKey)

Decrypt stream data with private key.

Parameters:

inputStream - the input stream to be decrypted.

outputStream - the decrypted data as stream.

privateKey - the recipients private key.

Throws:

DecryptionException

See Also:

PublicKey, PrivateKey

encrypt

byte[] encrypt(byte[] data,
               PublicKey recipient)

Encrypt byte array for single recipient.

Parameters:

data - the data to be encrypted.

recipient - the recipient's public key.

Returns:

the encrypted data as byte array.

See Also:

PublicKey

encrypt

byte[] encrypt(byte[] data,
               PublicKey[] recipients)

Encrypt byte array with public key set.

Parameters:

data - the data to be encrypted.

recipients - the recipients public key set.

Returns:

the encrypted data as byte array.

See Also:

PublicKey

encrypt

void encrypt(InputStream inputStream,
             OutputStream outputStream,
             PublicKey recipient)

Encrypt stream data with public key.

Parameters:

inputStream - the input stream to be encrypted.

outputStream - the output stream encrypted data written to.

recipient - the recipient's public key.

Throws:

EncryptionException - if encryption failed.

encrypt

void encrypt(InputStream inputStream,
             OutputStream outputStream,
             PublicKey[] recipients)

Encrypt stream data with public key set.

Parameters:

inputStream - the input stream to be encrypted.

outputStream - the output stream encrypted data written to.

recipients - the recipients public key set.

Throws:

EncryptionException - if encryption failed.

exportPrivateKey

byte[] exportPrivateKey(PrivateKey privateKey)

Export private key as byte array.

Parameters:

privateKey - the private key.

Returns:

the exported private key as byte array.

See Also:

PrivateKey

exportPrivateKey

byte[] exportPrivateKey(PrivateKey privateKey,
                        String password)

Export private key as byte array.

Parameters:

privateKey - the private key.

password - the private key password.

Returns:

the exported private key as byte array.

See Also:

PrivateKey

exportPublicKey

byte[] exportPublicKey(PublicKey publicKey)

Export public key as byte array.

Parameters:

publicKey - the public key.

Returns:

the exported public key as byte array.

See Also:

PublicKey

extractPublicKey

PublicKey extractPublicKey(PrivateKey privateKey)

Extract public key from private key.

Parameters:

privateKey - the private key.

Returns:

the extracted public key.

generateKeys

KeyPair generateKeys()

Generate key pair.

Returns:

the generated key pair.

See Also:

PrivateKey, PublicKey

importPrivateKey

PrivateKey importPrivateKey(byte[] keyData)

Import private key from byte array.

Parameters:

keyData - the Base64 encoded private key.

Returns:

the private key.

Throws:

CryptoException - if private key couldn't be imported.

See Also:

PrivateKey

importPrivateKey

PrivateKey importPrivateKey(byte[] keyData,
                            String password)

Import private key from byte array.

Parameters:

keyData - the Base64 encoded private key.

password - the private key password.

Returns:

the private key.

Throws:

CryptoException - if private key couldn't be imported.

See Also:

PrivateKey

importPublicKey

PublicKey importPublicKey(byte[] publicKey)

Import public key from byte array.

Parameters:

publicKey - the public key.

Returns:

the public key.

See Also:

PublicKey

sign

byte[] sign(byte[] data,
            PrivateKey privateKey)

Sign byte array data with private key.

Parameters:

data - the data to be signed.

privateKey - the signer's private key.

Returns:

the signature.

See Also:

PrivateKey

sign

byte[] sign(InputStream inputStream,
            PrivateKey privateKey)

Sign stream data with private key.

Parameters:

inputStream - the input stream to be signed.

privateKey - the signer's private key.

Returns:

the signature.

Throws:

SigningException - if stream couldn't be signed.

See Also:

PrivateKey

verify

boolean verify(byte[] data,
               byte[] signature,
               PublicKey signer)

Verify byte array with signature.

Parameters:

data - the data to be verified.

signature - the signature.

signer - the signer's public key.

Returns:

true if signature is valid. false in other case.

Throws:

VerificationException - if data couldn't be verified.

verify

boolean verify(InputStream inputStream,
               byte[] signature,
               PublicKey signer)

Verify stream data with signature.

Parameters:

inputStream - the input stream to be verified.

signature - the signature.

signer - the signer's public key.

Returns:

true if signature is valid. false in other case.

Throws:

VerificationException - if data couldn't be verified.

signThenEncrypt

byte[] signThenEncrypt(byte[] data,
                       PrivateKey privateKey,
                       PublicKey recipient)

Sign data and encrypt.

Parameters:

data - the data to be signed and encrypted.

privateKey - the private key used for signing.

recipient - the recipient's public key.

Returns:

the signed and encrypted data.

signThenEncrypt

byte[] signThenEncrypt(byte[] data,
                       PrivateKey privateKey,
                       PublicKey[] recipients)

Sign data and encrypt.

Parameters:

data - the data to be signed and encrypted.

privateKey - the private key used for signing.

recipients - the recipient public keys.

Returns:

the signed and encrypted data.

decryptThenVerify

byte[] decryptThenVerify(byte[] cipherData,
                         PrivateKey privateKey,
                         PublicKey publicKey)

Decrypt data and verify.

Parameters:

cipherData - the encrypted data to be decrypted.

privateKey - the private key used for decryption.

publicKey - the public key used for verify.

Returns:

the decrypted data.