A B C D E F G H I K N P R S T U V W

A

addProvider() - Static method in class com.github.davidcarboni.cryptolite.SecurityProvider

Attempts to add the provider specified by SecurityProvider.providerClassName.

ALGORITHM - Static variable in class com.github.davidcarboni.cryptolite.DigitalSignature

The digital signature algorithm to use: "SHA256withRSAandMGF1".

ALGORITHM - Static variable in class com.github.davidcarboni.cryptolite.HashMac

The algorithm used for computing HMACs.

ALGORITHM - Static variable in class com.github.davidcarboni.cryptolite.Password

The password hashing function.

ALGORITHM - Static variable in class com.github.davidcarboni.cryptolite.Random

The algorithm for the SecureRandom instance: "SHA1PRNG".

ASYMMETRIC_ALGORITHM - Static variable in class com.github.davidcarboni.cryptolite.Keys

The asymmetric encryption algorithm: "RSA".

ASYMMETRIC_KEY_SIZE - Static variable in class com.github.davidcarboni.cryptolite.Keys

The key size for asymmetric keys: 3072.

B

ByteArray - Class in com.github.davidcarboni.cryptolite

This class provides the ability to convert Strings, Base-64 and hexadecimal to a byte array and vice versa.

ByteArray() - Constructor for class com.github.davidcarboni.cryptolite.ByteArray

bytes(int) - Static method in class com.github.davidcarboni.cryptolite.Random

Convenience method to instantiate and populate a byte array of the specified length.

C

canUseStrongKeys() - Static method in class com.github.davidcarboni.cryptolite.Keys

Tests whether the "Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files" are correctly installed.

CIPHER_ALGORITHM - Static variable in class com.github.davidcarboni.cryptolite.Crypto

The name of the cipher algorithm to use for symmetric cryptographic operations.

CIPHER_ALGORITHM - Static variable in class com.github.davidcarboni.cryptolite.KeyExchange

The name of the cipher algorithm to use for asymmetric cryptographic operations.

CIPHER_MODE - Static variable in class com.github.davidcarboni.cryptolite.Crypto

The name of the cipher mode to use for symmetric cryptographic operations.

CIPHER_MODE - Static variable in class com.github.davidcarboni.cryptolite.KeyExchange

The name of the cipher mode to use for asymmetric cryptographic operations.

CIPHER_NAME - Static variable in class com.github.davidcarboni.cryptolite.Crypto

The full name of the Cipher to use for cryptographic operations, in a format suitable for passing to the JCE.

CIPHER_PADDING - Static variable in class com.github.davidcarboni.cryptolite.Crypto

The name of the padding type to use for symmetric cryptographic operations.

CIPHER_PADDING - Static variable in class com.github.davidcarboni.cryptolite.KeyExchange

The name of the padding type to use for asymmetric cryptographic operations.

com.github.davidcarboni.cryptolite - package com.github.davidcarboni.cryptolite

Crypto - Class in com.github.davidcarboni.cryptolite

This class provides simple encryption and decryption of Strings and streams.

Crypto() - Constructor for class com.github.davidcarboni.cryptolite.Crypto

Initialises the instance by getting and caching a Cipher instance for "AES/CTR/NoPadding".

Crypto(String) - Constructor for class com.github.davidcarboni.cryptolite.Crypto

This constructor is protected so that, should you need a different algorithm (e.g.

D

decodePublicKey(String) - Static method in class com.github.davidcarboni.cryptolite.KeyWrapper

Decodes the given encoded PublicKey.

decrypt(String, String) - Method in class com.github.davidcarboni.cryptolite.Crypto

This method decrypts the given String and returns the plain text.

decrypt(String, SecretKey) - Method in class com.github.davidcarboni.cryptolite.Crypto

This method decrypts the given String and returns the plain text.

decrypt(byte[], byte[], SecretKey) - Method in class com.github.davidcarboni.cryptolite.Crypto

This method decrypts the given bytes and returns the plain text.

decrypt(InputStream, String) - Method in class com.github.davidcarboni.cryptolite.Crypto

This method wraps the source InputStream with a CipherInputStream.

decrypt(InputStream, SecretKey) - Method in class com.github.davidcarboni.cryptolite.Crypto

This method wraps the source InputStream with a CipherInputStream.

decryptKey(String, PrivateKey) - Method in class com.github.davidcarboni.cryptolite.KeyExchange

This method decrypts the given encrypted SecretKey using our PrivateKey.

digest(String) - Method in class com.github.davidcarboni.cryptolite.HashMac

Computes an HMAC for the given message, using the key passed to the constructor.

DigitalSignature - Class in com.github.davidcarboni.cryptolite

This class provides a public-private key digital signature capability.

DigitalSignature() - Constructor for class com.github.davidcarboni.cryptolite.DigitalSignature

The default constructor initialises the instance with the "SHA256withRSAandMGF1" algorithm.

DigitalSignature(String) - Constructor for class com.github.davidcarboni.cryptolite.DigitalSignature

This constructor is protected so that, should you need a different algorithm (e.g.

E

encodePublicKey(PublicKey) - Static method in class com.github.davidcarboni.cryptolite.KeyWrapper

Encodes the given PublicKey without wrapping.

ENCODING - Static variable in class com.github.davidcarboni.cryptolite.ByteArray

The encoding to use for string operations.

encrypt(String, String) - Method in class com.github.davidcarboni.cryptolite.Crypto

This method encrypts the given String, returning a base-64 encoded String.

encrypt(String, SecretKey) - Method in class com.github.davidcarboni.cryptolite.Crypto

This method encrypts the given String, returning a base-64 encoded String.

encrypt(byte[], byte[], SecretKey) - Method in class com.github.davidcarboni.cryptolite.Crypto

This method encrypts a byte array.

encrypt(OutputStream, String) - Method in class com.github.davidcarboni.cryptolite.Crypto

This method wraps the destination OutputStream with a CipherOutputStream.

encrypt(OutputStream, SecretKey) - Method in class com.github.davidcarboni.cryptolite.Crypto

This method wraps the destination OutputStream with a CipherOutputStream.

encrypt(InputStream, SecretKey) - Method in class com.github.davidcarboni.cryptolite.Crypto

This method wraps the source InputStream with a CipherInputStream.

encryptKey(SecretKey, PublicKey) - Method in class com.github.davidcarboni.cryptolite.KeyExchange

This method encrypts the given SecretKey with the destination user's PublicKey so that it can be safely sent to them.

F

fromBase64String(String) - Static method in class com.github.davidcarboni.cryptolite.ByteArray

Decodes the given base-64 string into a byte array.

fromHexString(String) - Static method in class com.github.davidcarboni.cryptolite.ByteArray

With thanks to StackOverflow: Convert a string representation of a hex dump to a byte array using Java?

fromString(String) - Static method in class com.github.davidcarboni.cryptolite.ByteArray

Converts the given String to a byte array using "UTF8".

G

generateSecretKey(String, String) - Static method in class com.github.davidcarboni.cryptolite.Keys

This method generates a new secret (or symmetric) key for the "AES" algorithm, using the given password and salt values.

getCipher() - Method in class com.github.davidcarboni.cryptolite.Crypto

getInstance() - Static method in class com.github.davidcarboni.cryptolite.Random

getIvSize() - Method in class com.github.davidcarboni.cryptolite.Crypto

getSignature() - Method in class com.github.davidcarboni.cryptolite.DigitalSignature

getSymmetricKeySize() - Static method in class com.github.davidcarboni.cryptolite.Keys

H

hash(String) - Static method in class com.github.davidcarboni.cryptolite.Password

Produces a good hash of the given password, using "PBKDF2WithHmacSHA1", an iteration count of 1024 and a random salt value of bytes.

HASH_SIZE - Static variable in class com.github.davidcarboni.cryptolite.Password

The number of bytes to produce in the hash.

HashMac - Class in com.github.davidcarboni.cryptolite

Provides a simple way to generate a Hash MAC (HMAC) using "HmacSHA256".

HashMac(String) - Constructor for class com.github.davidcarboni.cryptolite.HashMac

This constructor provides parity with PHP's hash_hmac("sha256", "message", "key") function.

HashMac(SecretKey) - Constructor for class com.github.davidcarboni.cryptolite.HashMac

This constructor allows you to use a SecretKey to generate an HMAC.

HashMac(byte[], String) - Constructor for class com.github.davidcarboni.cryptolite.HashMac

This constructor is protected so that, should you need a different algorithm (e.g.

I

id() - Static method in class com.github.davidcarboni.cryptolite.Random

ID_BITS - Static variable in class com.github.davidcarboni.cryptolite.Random

The length of IDs: 256.

initCipher(int, SecretKey, byte[]) - Method in class com.github.davidcarboni.cryptolite.Crypto

This method returns a Cipher instance, for "AES" in "CTR" mode, with padding "NoPadding".

inputStream(long) - Static method in class com.github.davidcarboni.cryptolite.Random

Convenience method to instantiate an InputStream of random data of the specified length.

ITERATION_COUNT - Static variable in class com.github.davidcarboni.cryptolite.Password

The iteration count for the function.

K

KeyExchange - Class in com.github.davidcarboni.cryptolite

This class provides for key exchange, using public-private key encryption (also known as asymmetric encryption).

KeyExchange() - Constructor for class com.github.davidcarboni.cryptolite.KeyExchange

Initialises the instance with the recommended setting of .

KeyExchange(String) - Constructor for class com.github.davidcarboni.cryptolite.KeyExchange

This constructor is protected so that, should you need a different algorithm (e.g.

Keys - Class in com.github.davidcarboni.cryptolite

This class generates cryptographic keys.

Keys() - Constructor for class com.github.davidcarboni.cryptolite.Keys

KeyWrapper - Class in com.github.davidcarboni.cryptolite

This class provides secure "wrapping" of keys.

KeyWrapper(String, String) - Constructor for class com.github.davidcarboni.cryptolite.KeyWrapper

This is the constructor you should typically use.

KeyWrapper(SecretKey) - Constructor for class com.github.davidcarboni.cryptolite.KeyWrapper

This constructor sets the wrap key directly, rather than generating it from a password and salt as KeyWrapper.KeyWrapper(String, String) does.

N

newKeyPair() - Static method in class com.github.davidcarboni.cryptolite.Keys

This method generates a new public-private (or asymmetric) key pair, using the "RSA" algorithm and a key size of 3072 bits.

newSecretKey() - Static method in class com.github.davidcarboni.cryptolite.Keys

This method generates a new secret (or symmetric) key for the "AES" algorithm with a key size of symmetricKeySize bits.

P

Password - Class in com.github.davidcarboni.cryptolite

This class provides password hashing and verification.

Password() - Constructor for class com.github.davidcarboni.cryptolite.Password

password(int) - Static method in class com.github.davidcarboni.cryptolite.Random

Convenience method to generate a random password.

PBKD_ITERATIONS - Static variable in class com.github.davidcarboni.cryptolite.KeyWrapper

The number of iterations to perform when doing the password-based key derivation to generate the wrapping key: 1024.

providerClassName - Static variable in class com.github.davidcarboni.cryptolite.SecurityProvider

The name of an additional security provider class.

providerName - Static variable in class com.github.davidcarboni.cryptolite.SecurityProvider

The name of an additional security provider.

R

Random - Class in com.github.davidcarboni.cryptolite

This class provides random functions, such as Salt, ID and password generation.

Random() - Constructor for class com.github.davidcarboni.cryptolite.Random

S

salt() - Static method in class com.github.davidcarboni.cryptolite.Random

Generates a random salt value.

SALT_BYTES - Static variable in class com.github.davidcarboni.cryptolite.Random

The length of salt values: 16.

SecurityProvider - Class in com.github.davidcarboni.cryptolite

SecurityProvider() - Constructor for class com.github.davidcarboni.cryptolite.SecurityProvider

setSymmetricKeySize(int) - Static method in class com.github.davidcarboni.cryptolite.Keys

Sets the key size for symmetric keys.

sign(String, PrivateKey) - Method in class com.github.davidcarboni.cryptolite.DigitalSignature

Generates a digital signature for the given string.

sign(InputStream, PrivateKey) - Method in class com.github.davidcarboni.cryptolite.DigitalSignature

Generates a digital signature for the given InputStream.

SYMMETRIC_ALGORITHM - Static variable in class com.github.davidcarboni.cryptolite.Keys

The symmetric encryption algorithm: "AES".

SYMMETRIC_KEY_SIZE_STANDARD - Static variable in class com.github.davidcarboni.cryptolite.Keys

By default, the JVM will only allow "AES" up to 128 bit keys.

SYMMETRIC_KEY_SIZE_UNLIMITED - Static variable in class com.github.davidcarboni.cryptolite.Keys

If the "Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files" are correctly installed for your JVM, it's possible to use 256 bit keys.

SYMMETRIC_PASSWORD_ALGORITHM - Static variable in class com.github.davidcarboni.cryptolite.Keys

The algorithm to use to generate password-based secret keys: "PBKDF2WithHmacSHA1".

SYMMETRIC_PASSWORD_ITERATIONS - Static variable in class com.github.davidcarboni.cryptolite.Keys

The number of iterations to use for password-based key derivation: 1024.

T

toBase64String(byte[]) - Static method in class com.github.davidcarboni.cryptolite.ByteArray

Encodes the given byte array as a base-64 String.

toHexString(byte[]) - Static method in class com.github.davidcarboni.cryptolite.ByteArray

Renders the given byte array as a hex String.

toString(byte[]) - Static method in class com.github.davidcarboni.cryptolite.ByteArray

Converts the given byte array to a String using "UTF8".

U

unwrapKeyPair(String, String) - Method in class com.github.davidcarboni.cryptolite.KeyWrapper

Convenience method to unwrap a public-private key pain in a single call.

unwrapPrivateKey(String) - Method in class com.github.davidcarboni.cryptolite.KeyWrapper

Unwraps the given encoded PrivateKey, using WRAP_ALGORITHM_ASYMMETRIC.

unwrapSecretKey(String) - Method in class com.github.davidcarboni.cryptolite.KeyWrapper

Unwraps the given encoded SecretKey, using WRAP_ALGORITHM_SYMMETRIC.

V

verify(String, PublicKey, String) - Method in class com.github.davidcarboni.cryptolite.DigitalSignature

Verifies whether the given content matches the given signature.

verify(InputStream, PublicKey, String) - Method in class com.github.davidcarboni.cryptolite.DigitalSignature

verify(String, String) - Static method in class com.github.davidcarboni.cryptolite.Password

Verifies the given plaintext password against a value that Password.hash(String) produced.

W

wrapPrivateKey(PrivateKey) - Method in class com.github.davidcarboni.cryptolite.KeyWrapper

Wraps the given SecretKey using .

wrapSecretKey(SecretKey) - Method in class com.github.davidcarboni.cryptolite.KeyWrapper

Wraps the given SecretKey using .

A B C D E F G H I K N P R S T U V W