org.kocakosm.pitaya.security

Class KDFs

java.lang.Object

org.kocakosm.pitaya.security.KDFs

public final class KDFs
extends Object

Somme commonly used key derivation function algorithms.

Author:

Osman KOCAK

Method Summary

Methods

Modifier and Type	Method and Description
static KDF	hkdf(Algorithm<MAC> mac, byte[] info, int dkLen) Creates and returns a new immutable KDF instance implementing the HKDF algorithm (RFC 5869).
static KDF	pbkdf1(Algorithm<Digest> digest, int iterationCount, int dkLen) Creates and returns a new immutable KDF instance implementing the PBKDF1 algorithm (RFC 2898).
static KDF	pbkdf2(Algorithm<MAC> mac, int iterationCount, int dkLen) Creates and returns a new immutable KDF instance implementing the PBKDF2 algorithm (RFC 2898).
static KDF	scrypt(int r, int n, int p, int dkLen) Creates and returns a new immutable KDF instance implementing the SCrypt algorithm as specified by the Internet Engineering Task Force.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

pbkdf1

public static KDF pbkdf1(Algorithm<Digest> digest,
         int iterationCount,
         int dkLen)

Creates and returns a new immutable KDF instance implementing the PBKDF1 algorithm (RFC 2898).

Parameters:

digest - the digest algorithm to use.

iterationCount - the desired number of iterations.

dkLen - the desired length for derived keys, in bytes.

Returns:

the created KDF instance.

Throws:

NullPointerException - if digest is null.

IllegalArgumentException - if iterationCount or dkLen is negative, or if dkLen is greater than the digest algorithm's output length, or if the digest algorithm is unknown.

pbkdf2

public static KDF pbkdf2(Algorithm<MAC> mac,
         int iterationCount,
         int dkLen)

Creates and returns a new immutable KDF instance implementing the PBKDF2 algorithm (RFC 2898).

Parameters:

mac - the MAC algorithm to use.

iterationCount - the desired number of iterations.

dkLen - the desired length for derived keys, in bytes.

Returns:

the created KDF instance.

Throws:

NullPointerException - if mac is null.

IllegalArgumentException - if iterationCount or dkLen is negative, or if the MAC algorithm is unknown.

hkdf

public static KDF hkdf(Algorithm<MAC> mac,
       byte[] info,
       int dkLen)

Creates and returns a new immutable KDF instance implementing the HKDF algorithm (RFC 5869).

Parameters:

mac - the MAC algorithm to use.

info - optional context and application specific information, may be null or empty.

dkLen - the desired length for derived keys, in bytes.

Returns:

the created KDF instance.

Throws:

NullPointerException - if mac is null.

IllegalArgumentException - if dkLen is negative, or if the MAC algorithm is unknown, or if dkLen is greater than 255 * MAC algorithm's output length.

scrypt

public static KDF scrypt(int r,
         int n,
         int p,
         int dkLen)

Creates and returns a new immutable KDF instance implementing the SCrypt algorithm as specified by the Internet Engineering Task Force. See http://tools.ietf.org/html/draft-josefsson-scrypt-kdf-01 for more information.

Parameters:

r - the block size parameter.

n - the CPU/Memory cost parameter.

p - the parallelization parameter.

dkLen - the desired length for derived keys, in bytes.

Returns:

the created KDF instance.

Throws:

IllegalArgumentException - if r, dkLen or p is negative, or if n is not greater than 1 or if it is not a power of 2 or if it is not less than 2 ^ (128 * r / 8), or if p is greater than ((2 ^ 32 - 1) * 32) / (128 * r).