OpenJDK 27 · com.sun.crypto.provider.DHPrivateKey · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
private static class	DHPrivateKey.DHComponents

Modifier and Type	Field and Description
private byte[]	encodedKey
private final BigInteger	g
private byte[]	key
private final int	l
private final BigInteger	p
private static final BigInteger	PKCS8_VERSION
private static final long	serialVersionUID Hides java.security.PrivateKey.serialVersionUID, javax.crypto.interfaces.DHPrivateKey.serialVersionUID.
private final BigInteger	x

Access	Constructor and Description
pack-priv	DHPrivateKey(BigInteger the private value x, BigInteger the prime modulus p, BigInteger the base generator g) Make a DH private key out of a private value `x`, a prime modulus `p`, and a base generator `g`.
pack-priv	DHPrivateKey(BigInteger the private value x, BigInteger the prime modulus p, BigInteger the base generator g, int the private-value length l) Make a DH private key out of a private value `x`, a prime modulus `p`, a base generator `g`, and a private-value length `l`.
pack-priv	DHPrivateKey(byte[] the encoded key encodedKey) Make a DH private key from its DER encoding (PKCS #8).

Method Summary

Modifier and Type	Method and Description
private static DHPrivateKey.DHComponents	decode(byte[] encodedKey)
private static byte[]	encode(BigInteger p, BigInteger g, int l, byte[] key)
public boolean	equals(Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	getAlgorithm() Implements java.security.Key.getAlgorithm. Returns the name of the algorithm associated with this key: "DH"
public synchronized byte[]	getEncoded() Implements java.security.Key.getEncoded. Get the encoding of the key.
public String	getFormat() Implements java.security.Key.getFormat. Returns the encoding format of this key: "PKCS#8"
public DHParameterSpec	Returns: the key parameters getParams() Overrides default java.security.AsymmetricKey.getParams, javax.crypto.interfaces.DHPrivateKey.getParams. Returns the key parameters.
public BigInteger	Returns: the private value, `x` getX() Implements javax.crypto.interfaces.DHPrivateKey.getX. Returns the private value, `x`.
public int	hashCode() Overrides java.lang.Object.hashCode. Calculates a hash code value for the object.
private void	readObject(ObjectInputStream the `ObjectInputStream` from which data is read stream) Restores the state of this object from the stream.
private Object	Returns: the standard KeyRep object to be serialized writeReplace() Replace the DH private key to be serialized.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

Field Detail

encodedKey	back to summary
private byte[] encodedKey

g	back to summary
private final BigInteger g

key	back to summary
private byte[] key

l	back to summary
private final int l

p	back to summary
private final BigInteger p

PKCS8_VERSION	back to summary
private static final BigInteger PKCS8_VERSION

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.security.PrivateKey.serialVersionUID, javax.crypto.interfaces.DHPrivateKey.serialVersionUID. Annotations @Serial

x	back to summary
private final BigInteger x

Constructor Detail

DHPrivateKey back to summary

DHPrivateKey	back to summary
pack-priv DHPrivateKey(BigInteger x, BigInteger p, BigInteger g) throws InvalidKeyException Make a DH private key out of a private value `x`, a prime modulus `p`, and a base generator `g`. Parameters x:BigInteger the private value p:BigInteger the prime modulus g:BigInteger the base generator

pack-priv DHPrivateKey(BigInteger x, BigInteger p, BigInteger g) throws InvalidKeyException

Make a DH private key out of a private value x, a prime modulus p, and a base generator g.

Parameters

x:BigInteger: the private value
p:BigInteger: the prime modulus
g:BigInteger: the base generator

DHPrivateKey back to summary

DHPrivateKey	back to summary
pack-priv DHPrivateKey(BigInteger x, BigInteger p, BigInteger g, int l) Make a DH private key out of a private value `x`, a prime modulus `p`, a base generator `g`, and a private-value length `l`. Parameters x:BigInteger the private value p:BigInteger the prime modulus g:BigInteger the base generator l:int the private-value length

pack-priv DHPrivateKey(BigInteger x, BigInteger p, BigInteger g, int l)

Make a DH private key out of a private value x, a prime modulus p, a base generator g, and a private-value length l.

Parameters

x:BigInteger: the private value
p:BigInteger: the prime modulus
g:BigInteger: the base generator
l:int: the private-value length

DHPrivateKey	back to summary
pack-priv DHPrivateKey(byte[] encodedKey) throws InvalidKeyException Make a DH private key from its DER encoding (PKCS #8). Parameters encodedKey:byte[] the encoded key Exceptions InvalidKeyException: if the encoded key does not represent a Diffie-Hellman private key

DHPrivateKey

back to summary

pack-priv DHPrivateKey(byte[] encodedKey) throws InvalidKeyException

Make a DH private key from its DER encoding (PKCS #8).

Parameters

encodedKey:byte[]: the encoded key

Exceptions

InvalidKeyException:: if the encoded key does not represent a Diffie-Hellman private key

Method Detail

decode	back to summary
private static DHPrivateKey.DHComponents decode(byte[] encodedKey) throws IOException

encode	back to summary
private static byte[] encode(BigInteger p, BigInteger g, int l, byte[] key)

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@Override

getAlgorithm	back to summary
public String getAlgorithm() Implements java.security.Key.getAlgorithm. Returns the name of the algorithm associated with this key: "DH"

getAlgorithm

back to summary

public String getAlgorithm()

Implements java.security.Key.getAlgorithm.

Returns the name of the algorithm associated with this key: "DH"

getEncoded	back to summary
public synchronized byte[] getEncoded() Implements java.security.Key.getEncoded. Get the encoding of the key.

getEncoded

back to summary

public synchronized byte[] getEncoded()

Implements java.security.Key.getEncoded.

Get the encoding of the key.

getFormat	back to summary
public String getFormat() Implements java.security.Key.getFormat. Returns the encoding format of this key: "PKCS#8"

getFormat

back to summary

public String getFormat()

Implements java.security.Key.getFormat.

Returns the encoding format of this key: "PKCS#8"

getParams	back to summary
public DHParameterSpec getParams() Overrides default java.security.AsymmetricKey.getParams, javax.crypto.interfaces.DHPrivateKey.getParams. Returns the key parameters. Returns:DHParameterSpec the key parameters

getParams

back to summary

public DHParameterSpec getParams()

Overrides default java.security.AsymmetricKey.getParams, javax.crypto.interfaces.DHPrivateKey.getParams.

Returns the key parameters.

Returns:DHParameterSpec: the key parameters

getX back to summary

getX	back to summary
public BigInteger getX() Implements javax.crypto.interfaces.DHPrivateKey.getX. Returns the private value, `x`. Returns:BigInteger the private value, `x`

public BigInteger getX()

Implements javax.crypto.interfaces.DHPrivateKey.getX.

Returns the private value, x.

Returns:BigInteger: the private value, x

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Calculates a hash code value for the object. Objects that are equal will also have the same hashcode. Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Calculates a hash code value for the object. Objects that are equal will also have the same hashcode.

Annotations

@Override

readObject back to summary

readObject	back to summary
private void readObject(ObjectInputStream stream) throws IOException, ClassNotFoundException Restores the state of this object from the stream. JDK 1.5+ objects use `KeyRep`s instead. Parameters stream:ObjectInputStream the `ObjectInputStream` from which data is read Annotations @Serial Exceptions IOException: if an I/O error occurs ClassNotFoundException: if a serialized class cannot be loaded

private void readObject(ObjectInputStream stream) throws IOException, ClassNotFoundException

Restores the state of this object from the stream.

JDK 1.5+ objects use KeyReps instead.

Parameters

stream:ObjectInputStream: the ObjectInputStream from which data is read

Annotations

@Serial

Exceptions

IOException:: if an I/O error occurs
ClassNotFoundException:: if a serialized class cannot be loaded

writeReplace	back to summary
private Object writeReplace() throws ObjectStreamException Replace the DH private key to be serialized. Returns:Object the standard KeyRep object to be serialized Annotations @Serial Exceptions ObjectStreamException: if a new object representing this DH private key could not be created

writeReplace

back to summary

private Object writeReplace() throws ObjectStreamException

Replace the DH private key to be serialized.

Returns:Object

the standard KeyRep object to be serialized

Annotations

@Serial

Exceptions

ObjectStreamException:: if a new object representing this DH private key could not be created

Modifier and Type	Field and Description
pack-priv final BigInteger	g
pack-priv final byte[]	key
pack-priv final int	l
pack-priv final BigInteger	p
pack-priv final BigInteger	x

pack-priv final Class DHPrivateKey

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DHPrivateKey.DHComponents

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail