com.nimbusds.srp6

Class SRP6CryptoParams

java.lang.Object

com.nimbusds.srp6.SRP6CryptoParams

All Implemented Interfaces:

Serializable

public class SRP6CryptoParams
extends Object
implements Serializable

The crypto parameters for the SRP-6a protocol. These must be agreed between client and server before authentication and consist of a large safe prime 'N', a corresponding generator 'g' and a hash function algorithm 'H'.

The practical approach is to have the server manage these and make them available to clients on request. This way, the client does not need to anticipate or otherwise keep track of which parameters are used for which users or servers; it only needs to verify their validity, which can be done mathematically or by simple table lookup.

For convenience this class includes a set of precomputed parameters.

Author:

Vladimir Dzhuvinov, Bernard Wittwer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
BigInteger	g The corresponding generator 'g'.
static BigInteger	g_common Generator 'g' parameter for N_256, N_512, N_768, N_1024, N_1536, and N_2048 as decimal.
String	H The hash algorithm 'H'.
BigInteger	N The safe prime 'N'.
static BigInteger	N_1024 Precomputed safe 1024-bit prime 'N', as decimal.
static BigInteger	N_1536 Precomputed safe 1536-bit prime 'N', as decimal.
static BigInteger	N_2048 Precomputed safe 2048-bit prime 'N', as decimal.
static BigInteger	N_256 Precomputed safe 256-bit prime 'N', as decimal.
static BigInteger	N_512 Precomputed safe 512-bit prime 'N', as decimal.
static BigInteger	N_768 Precomputed safe 768-bit prime 'N', as decimal.

Constructor Summary

Constructors

Constructor and Description
SRP6CryptoParams(BigInteger N, BigInteger g, String H) Creates a new SRP-6a crypto parameters instance.

Method Summary

Modifier and Type	Method and Description
static SRP6CryptoParams	getInstance() Returns an SRP-6a crypto parameters instance with precomputed 512-bit prime 'N', matching 'g' value and "SHA-1" hash algorithm.
static SRP6CryptoParams	getInstance(int bitsize, String H) Returns an SRP-6a crypto parameters instance with precomputed 'N' and 'g' values and the specified hash algorithm 'H'.
MessageDigest	getMessageDigestInstance() Returns a new message digest instance for the hash algorithm 'H'.
static boolean	isSupportedHashAlgorithm(String H) Checks if the specified hash algorithm 'H' is supported by the default security provider of the underlying Java runtime.

Methods inherited from class java.lang.Object

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

Field Detail

N_256

public static final BigInteger N_256

Precomputed safe 256-bit prime 'N', as decimal. Origin SRP-6a demo at http://srp.stanford.edu/demo/demo.html.

N_512

public static final BigInteger N_512

Precomputed safe 512-bit prime 'N', as decimal. Origin SRP-6a demo at http://srp.stanford.edu/demo/demo.html.

N_768

public static final BigInteger N_768

Precomputed safe 768-bit prime 'N', as decimal. Origin SRP-6a demo at http://srp.stanford.edu/demo/demo.html.

N_1024

public static final BigInteger N_1024

Precomputed safe 1024-bit prime 'N', as decimal. Origin RFC 5054, appendix A.

N_1536

public static final BigInteger N_1536

Precomputed safe 1536-bit prime 'N', as decimal. Origin RFC 5054, appendix A.

N_2048

public static final BigInteger N_2048

Precomputed safe 2048-bit prime 'N', as decimal. Origin RFC 5054, appendix A.

g_common

public static final BigInteger g_common

Generator 'g' parameter for N_256, N_512, N_768, N_1024, N_1536, and N_2048 as decimal.

N

public final BigInteger N

The safe prime 'N'.

g

public final BigInteger g

The corresponding generator 'g'.

H

public final String H

The hash algorithm 'H'.

Constructor Detail

SRP6CryptoParams

public SRP6CryptoParams(BigInteger N,
                        BigInteger g,
                        String H)

Creates a new SRP-6a crypto parameters instance. Note that the 'N' and 'g' values are not validated, nor is the 'H' support by the default security provider of the underlying Java runtime.

Parameters:

N - A large safe prime for the 'N' parameter. Must not be null.

g - A corresponding generator for the 'g' parameter. Must not be null.

H - A hash algorithm. Must by supported by the default security provider of the underlying Java runtime. Must not be null.

Method Detail

getInstance

public static SRP6CryptoParams getInstance(int bitsize,
                                           String H)

Returns an SRP-6a crypto parameters instance with precomputed 'N' and 'g' values and the specified hash algorithm 'H'.

Parameters:

bitsize - The preferred prime number bitsize. Must exist as a precomputed constant.

H - The preferred hash algorithm. Must be supported by the default security provider of the underlying Java runtime.

Returns:

The matching SRP-6a crypto parameters instance, or null if no matching constants or hash algorithm provider could be found.

getInstance

public static SRP6CryptoParams getInstance()

Returns an SRP-6a crypto parameters instance with precomputed 512-bit prime 'N', matching 'g' value and "SHA-1" hash algorithm.

Returns:

SRP-6a crypto parameters instance with 512-bit prime 'N', matching 'g' value and "SHA-1" hash algorithm.

isSupportedHashAlgorithm

public static boolean isSupportedHashAlgorithm(String H)

Checks if the specified hash algorithm 'H' is supported by the default security provider of the underlying Java runtime.

Parameters:

H - The hash algorithm to check, e.g. "SHA-1".

Returns:

true if the hash algorightm is supported, else false.

getMessageDigestInstance

public MessageDigest getMessageDigestInstance()

Returns a new message digest instance for the hash algorithm 'H'.

Returns:

A new message digest instance or null if not supported by the default security provider of the underlying Java runtime.