Bouncy Castle Cryptography Library 1.80 · org.bouncycastle.jcajce.provider.asymmetric.mlkem.BCMLKEMPrivateKey

Modifier and Type	Field and Description
private transient String	algorithm
private transient ASN1Set	attributes
private transient MLKEMPrivateKeyParameters	params
private static final long	serialVersionUID Hides java.security.PrivateKey.serialVersionUID, java.security.Key.serialVersionUID.

Access	Constructor and Description
public	BCMLKEMPrivateKey(MLKEMPrivateKeyParameters params)
public	BCMLKEMPrivateKey(PrivateKeyInfo keyInfo)

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: the result of the comparison equals(Object the other object o) Overrides java.lang.Object.equals. Compare this ML-KEM private key with another object.
public final String	Returns: name of the algorithm - "ML-KEM" getAlgorithm() Implements java.security.Key.getAlgorithm. Returns the standard algorithm name for this key.
public byte[]	getEncoded() Implements java.security.Key.getEncoded. Returns the key in its primary encoding format, or `null` if this key does not support encoding.
public String	getFormat() Implements java.security.Key.getFormat. Returns the name of the primary encoding format of this key, or `null` if this key does not support encoding.
pack-priv MLKEMPrivateKeyParameters	getKeyParams()
public MLKEMParameterSpec	getParameterSpec() Implements org.bouncycastle.jcajce.interfaces.MLKEMKey.getParameterSpec. Return the parameters for this key.
public byte[]	getPrivateData() Implements org.bouncycastle.jcajce.interfaces.MLKEMPrivateKey.getPrivateData. Return the long form private data for the ML-KEM private key.
public MLKEMPublicKey	getPublicKey() Implements org.bouncycastle.jcajce.interfaces.MLKEMPrivateKey.getPublicKey. Return the public key corresponding to this private key.
public byte[]	getSeed() Implements org.bouncycastle.jcajce.interfaces.MLKEMPrivateKey.getSeed. Return the seed the private key was generated from (if available).
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
private void	init(PrivateKeyInfo keyInfo)
private void	readObject(ObjectInputStream in)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
private void	writeObject(ObjectOutputStream out)

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

algorithm	back to summary
private transient String algorithm

attributes	back to summary
private transient ASN1Set attributes

params	back to summary
private transient MLKEMPrivateKeyParameters params

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.security.PrivateKey.serialVersionUID, java.security.Key.serialVersionUID.

BCMLKEMPrivateKey	back to summary
public BCMLKEMPrivateKey(MLKEMPrivateKeyParameters params)

BCMLKEMPrivateKey	back to summary
public BCMLKEMPrivateKey(PrivateKeyInfo keyInfo) throws IOException

Method Detail

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Compare this ML-KEM private key with another object. Parameters o:Object the other object Returns:boolean the result of the comparison

equals

back to summary

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Compare this ML-KEM private key with another object.

Parameters

o:Object: the other object

Returns:boolean

the result of the comparison

getAlgorithm	back to summary
public final String getAlgorithm() Implements java.security.Key.getAlgorithm. Doc from java.security.Key.getAlgorithm. Returns the standard algorithm name for this key. For example, "DSA" would indicate that this key is a DSA key. See the key related sections (KeyFactory, KeyGenerator, KeyPairGenerator, and SecretKeyFactory) in the Java Security Standard Algorithm Names Specification for information about standard key algorithm names. Returns:String name of the algorithm - "ML-KEM"

getAlgorithm

back to summary

public final String getAlgorithm()

Implements java.security.Key.getAlgorithm.

Doc from java.security.Key.getAlgorithm.

Returns the standard algorithm name for this key. For example, "DSA" would indicate that this key is a DSA key. See the key related sections (KeyFactory, KeyGenerator, KeyPairGenerator, and SecretKeyFactory) in the Java Security Standard Algorithm Names Specification for information about standard key algorithm names.

Returns:String: name of the algorithm - "ML-KEM"

getEncoded back to summary

getEncoded	back to summary
public byte[] getEncoded() Implements java.security.Key.getEncoded. Doc from java.security.Key.getEncoded. Returns the key in its primary encoding format, or `null` if this key does not support encoding. Returns:byte[] the encoded key, or `null` if the key does not support encoding.

public byte[] getEncoded()

Implements java.security.Key.getEncoded.

Doc from java.security.Key.getEncoded.

Returns the key in its primary encoding format, or null if this key does not support encoding.

Returns:byte[]: the encoded key, or null if the key does not support encoding.

getFormat back to summary

getFormat	back to summary
public String getFormat() Implements java.security.Key.getFormat. Doc from java.security.Key.getFormat. Returns the name of the primary encoding format of this key, or `null` if this key does not support encoding. The primary encoding format is named in terms of the appropriate ASN.1 data format, if an ASN.1 specification for this key exists. For example, the name of the ASN.1 data format for public keys is SubjectPublicKeyInfo, as defined by the X.509 standard; in this case, the returned format is `"X.509"`. Similarly, the name of the ASN.1 data format for private keys is PrivateKeyInfo, as defined by the PKCS #8 standard; in this case, the returned format is `"PKCS#8"`. Returns:String the primary encoding format of the key.

public String getFormat()

Implements java.security.Key.getFormat.

Doc from java.security.Key.getFormat.

Returns the name of the primary encoding format of this key, or null if this key does not support encoding. The primary encoding format is named in terms of the appropriate ASN.1 data format, if an ASN.1 specification for this key exists. For example, the name of the ASN.1 data format for public keys is SubjectPublicKeyInfo, as defined by the X.509 standard; in this case, the returned format is "X.509". Similarly, the name of the ASN.1 data format for private keys is PrivateKeyInfo, as defined by the PKCS #8 standard; in this case, the returned format is "PKCS#8".

Returns:String: the primary encoding format of the key.

getKeyParams	back to summary
pack-priv MLKEMPrivateKeyParameters getKeyParams()

getParameterSpec	back to summary
public MLKEMParameterSpec getParameterSpec() Implements org.bouncycastle.jcajce.interfaces.MLKEMKey.getParameterSpec. Doc from org.bouncycastle.jcajce.interfaces.MLKEMKey.getParameterSpec. Return the parameters for this key. Returns:MLKEMParameterSpec a MLKEMParameterSpec

getParameterSpec

back to summary

public MLKEMParameterSpec getParameterSpec()

Implements org.bouncycastle.jcajce.interfaces.MLKEMKey.getParameterSpec.

Doc from org.bouncycastle.jcajce.interfaces.MLKEMKey.getParameterSpec.

Return the parameters for this key.

Returns:MLKEMParameterSpec: a MLKEMParameterSpec

getPrivateData	back to summary
public byte[] getPrivateData() Implements org.bouncycastle.jcajce.interfaces.MLKEMPrivateKey.getPrivateData. Doc from org.bouncycastle.jcajce.interfaces.MLKEMPrivateKey.getPrivateData. Return the long form private data for the ML-KEM private key. Returns:byte[] long form private data for private key. Annotations @Override

getPrivateData

back to summary

public byte[] getPrivateData()

Implements org.bouncycastle.jcajce.interfaces.MLKEMPrivateKey.getPrivateData.

Doc from org.bouncycastle.jcajce.interfaces.MLKEMPrivateKey.getPrivateData.

Return the long form private data for the ML-KEM private key.

Returns:byte[]

long form private data for private key.

Annotations

@Override

getPublicKey	back to summary
public MLKEMPublicKey getPublicKey() Implements org.bouncycastle.jcajce.interfaces.MLKEMPrivateKey.getPublicKey. Doc from org.bouncycastle.jcajce.interfaces.MLKEMPrivateKey.getPublicKey. Return the public key corresponding to this private key. Returns:MLKEMPublicKey a ML-KEM Public Key

getPublicKey

back to summary

public MLKEMPublicKey getPublicKey()

Implements org.bouncycastle.jcajce.interfaces.MLKEMPrivateKey.getPublicKey.

Doc from org.bouncycastle.jcajce.interfaces.MLKEMPrivateKey.getPublicKey.

Return the public key corresponding to this private key.

Returns:MLKEMPublicKey: a ML-KEM Public Key

getSeed	back to summary
public byte[] getSeed() Implements org.bouncycastle.jcajce.interfaces.MLKEMPrivateKey.getSeed. Doc from org.bouncycastle.jcajce.interfaces.MLKEMPrivateKey.getSeed. Return the seed the private key was generated from (if available). Returns:byte[] the seed for the private key, null if not available. Annotations @Override

getSeed

back to summary

public byte[] getSeed()

Implements org.bouncycastle.jcajce.interfaces.MLKEMPrivateKey.getSeed.

Doc from org.bouncycastle.jcajce.interfaces.MLKEMPrivateKey.getSeed.

Return the seed the private key was generated from (if available).

Returns:byte[]

the seed for the private key, null if not available.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int: a hash code value for this object

init	back to summary
private void init(PrivateKeyInfo keyInfo) throws IOException

readObject	back to summary
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String: a string representation of the object

writeObject	back to summary
private void writeObject(ObjectOutputStream out) throws IOException

public Class BCMLKEMPrivateKey

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail