Class GnuDHPrivateKey

public GnuDHPrivateKey(int preferredFormat,
                       BigInteger q,
                       BigInteger p,
                       BigInteger g,
                       BigInteger x)

Constructs a new instance of GnuDHPrivateKey given the designated parameters.

Parameters:

preferredFormat - the identifier of the encoding format to use by default when externalizing the key.

q - a prime divisor of p-1.

p - the public prime.

g - the generator of the group.

x - the private value x.

public GnuDHPrivateKey(BigInteger q,
                       BigInteger p,
                       BigInteger g,
                       BigInteger x)

Convenience constructor. Calls the constructor with five arguments passing Registry.RAW_ENCODING_ID as the value of its first argument.

Parameters:

q - a prime divisor of p-1.

p - the public prime.

g - the generator of the group.

x - the private value x.

public boolean equals(Object obj)

Returns true if the designated object is an instance of DHPrivateKey and has the same parameter values as this one.

Overrides:

equals in interface GnuDHKey

Parameters:

obj - the other non-null DH key to compare to.

Returns:

true if the designated object is of the same type and value as this one.

public byte[] getEncoded(int format)

Returns the encoded form of this private key according to the designated format.

Overrides:

getEncoded in interface GnuDHKey

Parameters:

format - the desired format identifier of the resulting encoding.

Returns:

the byte sequence encoding this key according to the designated format.

Throws:

IllegalArgumentException - if the format is not supported.

See Also:

DHKeyPairRawCodec

public BigInteger getX()

Returns the private value x.

Specified by:

getX in interface DHPrivateKey

Returns:

The private value x.

public String toString()

Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() and such.

It is typical, but not required, to ensure that this method never completes abruptly with a RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

Overrides:

toString in interface GnuDHKey

Returns:

the String representing this Object, which may be null

See Also:

getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)

public static GnuDHPrivateKey valueOf(byte[] k)

A class method that takes the output of the encodePrivateKey() method of a DH keypair codec object (an instance implementing IKeyPairCodec for DH keys, and re-constructs an instance of this object.

Parameters:

k - the contents of a previously encoded instance of this object.

Throws:

ArrayIndexOutOfBoundsException - if there is not enough bytes, in k, to represent a valid encoding of an instance of this object.

IllegalArgumentException - if the byte sequence does not represent a valid encoding of an instance of this object.