Bouncy Castle Cryptography Library 1.80 · org.bouncycastle.pqc.jcajce.provider.xmss.BCXMSSPrivateKey

Modifier and Type	Field and Description
private transient ASN1Set	attributes
private transient XMSSPrivateKeyParameters	keyParams References Deprecated `XMSSPrivateKeyParameters` is deprecated or references (maybe indirectly) at least one deprecated element.
private static final long	serialVersionUID Hides java.security.PrivateKey.serialVersionUID.
private transient ASN1ObjectIdentifier	treeDigest

Access	Constructor and Description
public	BCXMSSPrivateKey(ASN1ObjectIdentifier treeDigest, XMSSPrivateKeyParameters keyParams) References Deprecated `XMSSPrivateKeyParameters` is deprecated or references (maybe indirectly) at least one deprecated element.
public	BCXMSSPrivateKey(PrivateKeyInfo keyInfo)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public XMSSPrivateKey	extractKeyShard(int the number of usages the key should have. usageCount) Implements org.bouncycastle.pqc.jcajce.interfaces.XMSSPrivateKey.extractKeyShard. Return a key representing a shard of the key space that can be used usageCount times.
public String	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.
public int	getHeight() Implements org.bouncycastle.pqc.jcajce.interfaces.XMSSKey.getHeight.
public long	getIndex() Implements org.bouncycastle.pqc.jcajce.interfaces.XMSSPrivateKey.getIndex. Return the index of the next signature.
pack-priv CipherParameters	getKeyParams()
public String	getTreeDigest() Implements org.bouncycastle.pqc.jcajce.interfaces.XMSSKey.getTreeDigest.
pack-priv ASN1ObjectIdentifier	getTreeDigestOID()
public long	getUsagesRemaining() Implements org.bouncycastle.pqc.jcajce.interfaces.XMSSPrivateKey.getUsagesRemaining. Return the number of usages left for the private key.
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)
private void	writeObject(ObjectOutputStream out)

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

attributes	back to summary
private transient ASN1Set attributes

keyParams	back to summary
private transient XMSSPrivateKeyParameters keyParams References Deprecated `XMSSPrivateKeyParameters` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

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

treeDigest	back to summary
private transient ASN1ObjectIdentifier treeDigest

BCXMSSPrivateKey	back to summary
public BCXMSSPrivateKey(ASN1ObjectIdentifier treeDigest, XMSSPrivateKeyParameters keyParams) References Deprecated `XMSSPrivateKeyParameters` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

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

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object o) 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. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise.

public boolean equals(Object o)

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.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

extractKeyShard	back to summary
public XMSSPrivateKey extractKeyShard(int usageCount) Implements org.bouncycastle.pqc.jcajce.interfaces.XMSSPrivateKey.extractKeyShard. Doc from org.bouncycastle.pqc.jcajce.interfaces.XMSSPrivateKey.extractKeyShard. Return a key representing a shard of the key space that can be used usageCount times. Note this will use the range [index...index + usageCount) for the current key. Parameters usageCount:int the number of usages the key should have. Returns:XMSSPrivateKey a key based on the current key that can be used usageCount times.

extractKeyShard

back to summary

public XMSSPrivateKey extractKeyShard(int usageCount)

Implements org.bouncycastle.pqc.jcajce.interfaces.XMSSPrivateKey.extractKeyShard.

Doc from org.bouncycastle.pqc.jcajce.interfaces.XMSSPrivateKey.extractKeyShard.

Return a key representing a shard of the key space that can be used usageCount times.

Note

this will use the range [index...index + usageCount) for the current key.

Parameters

usageCount:int: the number of usages the key should have.

Returns:XMSSPrivateKey

a key based on the current key that can be used usageCount times.

getAlgorithm	back to summary
public 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 the name of the algorithm associated with this key.

getAlgorithm

back to summary

public 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: the name of the algorithm associated with this key.

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.

getHeight	back to summary
public int getHeight() Implements org.bouncycastle.pqc.jcajce.interfaces.XMSSKey.getHeight.

getIndex	back to summary
public long getIndex() Implements org.bouncycastle.pqc.jcajce.interfaces.XMSSPrivateKey.getIndex. Doc from org.bouncycastle.pqc.jcajce.interfaces.XMSSPrivateKey.getIndex. Return the index of the next signature. Returns:long the index number for the next signature.

getIndex

back to summary

public long getIndex()

Implements org.bouncycastle.pqc.jcajce.interfaces.XMSSPrivateKey.getIndex.

Doc from org.bouncycastle.pqc.jcajce.interfaces.XMSSPrivateKey.getIndex.

Return the index of the next signature.

Returns:long: the index number for the next signature.

getKeyParams	back to summary
pack-priv CipherParameters getKeyParams()

getTreeDigest	back to summary
public String getTreeDigest() Implements org.bouncycastle.pqc.jcajce.interfaces.XMSSKey.getTreeDigest.

getTreeDigestOID	back to summary
pack-priv ASN1ObjectIdentifier getTreeDigestOID()

getUsagesRemaining	back to summary
public long getUsagesRemaining() Implements org.bouncycastle.pqc.jcajce.interfaces.XMSSPrivateKey.getUsagesRemaining. Doc from org.bouncycastle.pqc.jcajce.interfaces.XMSSPrivateKey.getUsagesRemaining. Return the number of usages left for the private key. Returns:long the number of times the key can be used before it is exhausted.

getUsagesRemaining

back to summary

public long getUsagesRemaining()

Implements org.bouncycastle.pqc.jcajce.interfaces.XMSSPrivateKey.getUsagesRemaining.

Doc from org.bouncycastle.pqc.jcajce.interfaces.XMSSPrivateKey.getUsagesRemaining.

Return the number of usages left for the private key.

Returns:long: the number of times the key can be used before it is exhausted.

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

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

public Class BCXMSSPrivateKey

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail