Bouncy Castle Provider 1.77 · org.bouncycastle.pqc.crypto.lms.HSSPrivateKeyParameters

Modifier and Type	Field and Description
private long	index
private final long	indexLimit
private final boolean	isShard
private List<LMSPrivateKeyParameters>	keys
private final int	l
private HSSPublicKeyParameters	publicKey
private List<LMSSignature>	sig

Access	Constructor and Description
public	HSSPrivateKeyParameters(int l, List<LMSPrivateKeyParameters> keys, List<LMSSignature> sig, long index, long indexLimit)
private	HSSPrivateKeyParameters(int l, List<LMSPrivateKeyParameters> keys, List<LMSSignature> sig, long index, long indexLimit, boolean isShard)

Method Summary

Modifier and Type	Method and Description
protected Object	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
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 HSSPrivateKeyParameters	Returns: a key based on the current key that can be used usageCount times. extractKeyShard(int the number of usages the key should have. usageCount) Return a key that can be used usageCount times.
public LMSContext	generateLMSContext() Implements org.bouncycastle.pqc.crypto.lms.LMSContextBasedSigner.generateLMSContext.
public byte[]	generateSignature(LMSContext context) Implements org.bouncycastle.pqc.crypto.lms.LMSContextBasedSigner.generateSignature.
public synchronized byte[]	getEncoded() Implements abstract org.bouncycastle.pqc.crypto.lms.LMSKeyParameters.getEncoded. Implements org.bouncycastle.util.Encodable.getEncoded. Return a byte array representing the implementing object.
public synchronized long	getIndex()
pack-priv long	getIndexLimit()
public static HSSPrivateKeyParameters	getInstance(byte[] privEnc, byte[] pubEnc)
public static HSSPrivateKeyParameters	getInstance(Object src)
pack-priv synchronized List<LMSPrivateKeyParameters>	getKeys()
public int	getL()
public synchronized LMSParameters[]	getLMSParameters()
public synchronized HSSPublicKeyParameters	getPublicKey()
pack-priv LMSPrivateKeyParameters	getRootKey()
pack-priv synchronized List<LMSSignature>	getSig()
public long	getUsagesRemaining() Implements org.bouncycastle.pqc.crypto.lms.LMSContextBasedSigner.getUsagesRemaining.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
pack-priv synchronized void	incIndex()
pack-priv boolean	isShard()
private static HSSPrivateKeyParameters	makeCopy(HSSPrivateKeyParameters privateKeyParameters)
pack-priv void	replaceConsumedKey(int d)
pack-priv void	resetKeyToIndex() Reset to index will ensure that all LMS keys are correct for a given HSS index value.
protected void	updateHierarchy(LMSPrivateKeyParameters[] newKeys, LMSSignature[] newSig)

index	back to summary
private long index

indexLimit	back to summary
private final long indexLimit

isShard	back to summary
private final boolean isShard

keys	back to summary
private List<LMSPrivateKeyParameters> keys

l	back to summary
private final int l

publicKey	back to summary
private HSSPublicKeyParameters publicKey

sig	back to summary
private List<LMSSignature> sig

HSSPrivateKeyParameters	back to summary
public HSSPrivateKeyParameters(int l, List<LMSPrivateKeyParameters> keys, List<LMSSignature> sig, long index, long indexLimit)

HSSPrivateKeyParameters	back to summary
private HSSPrivateKeyParameters(int l, List<LMSPrivateKeyParameters> keys, List<LMSSignature> sig, long index, long indexLimit, boolean isShard)

Method Detail

clone back to summary

clone	back to summary
protected Object clone() throws CloneNotSupportedException Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:Object a clone of this instance. Annotations @Override Exceptions CloneNotSupportedException: if the object's class does not support the `Cloneable` interface. Subclasses that override the `clone` method can also throw this exception to indicate that an instance cannot be cloned.

protected Object clone() throws CloneNotSupportedException

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:Object

a clone of this instance.

Annotations

@Override

Exceptions

CloneNotSupportedException:: if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.

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. Annotations @Override

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.

Annotations

@Override

extractKeyShard	back to summary
public HSSPrivateKeyParameters extractKeyShard(int usageCount) Return a key 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:HSSPrivateKeyParameters a key based on the current key that can be used usageCount times.

extractKeyShard

back to summary

public HSSPrivateKeyParameters extractKeyShard(int usageCount)

Return a key 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:HSSPrivateKeyParameters

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

generateLMSContext	back to summary
public LMSContext generateLMSContext() Implements org.bouncycastle.pqc.crypto.lms.LMSContextBasedSigner.generateLMSContext.

generateSignature	back to summary
public byte[] generateSignature(LMSContext context) Implements org.bouncycastle.pqc.crypto.lms.LMSContextBasedSigner.generateSignature.

getEncoded	back to summary
public synchronized byte[] getEncoded() throws IOException Implements abstract org.bouncycastle.pqc.crypto.lms.LMSKeyParameters.getEncoded. Implements org.bouncycastle.util.Encodable.getEncoded. Doc from org.bouncycastle.util.Encodable.getEncoded. Return a byte array representing the implementing object. Returns:byte[] a byte array representing the encoding. Annotations @Override Exceptions IOException: if an issue arises generation the encoding.

getEncoded

back to summary

public synchronized byte[] getEncoded() throws IOException

Implements abstract org.bouncycastle.pqc.crypto.lms.LMSKeyParameters.getEncoded.

Implements org.bouncycastle.util.Encodable.getEncoded.

Doc from org.bouncycastle.util.Encodable.getEncoded.

Return a byte array representing the implementing object.

Returns:byte[]

a byte array representing the encoding.

Annotations

@Override

Exceptions

IOException:: if an issue arises generation the encoding.

getIndex	back to summary
public synchronized long getIndex()

getIndexLimit	back to summary
pack-priv long getIndexLimit()

getInstance	back to summary
public static HSSPrivateKeyParameters getInstance(byte[] privEnc, byte[] pubEnc) throws IOException

getInstance	back to summary
public static HSSPrivateKeyParameters getInstance(Object src) throws IOException

getKeys	back to summary
pack-priv synchronized List<LMSPrivateKeyParameters> getKeys()

getL	back to summary
public int getL()

getLMSParameters	back to summary
public synchronized LMSParameters[] getLMSParameters()

getPublicKey	back to summary
public synchronized HSSPublicKeyParameters getPublicKey()

getRootKey	back to summary
pack-priv LMSPrivateKeyParameters getRootKey()

getSig	back to summary
pack-priv synchronized List<LMSSignature> getSig()

getUsagesRemaining	back to summary
public long getUsagesRemaining() Implements org.bouncycastle.pqc.crypto.lms.LMSContextBasedSigner.getUsagesRemaining.

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 the 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. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the 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.

Annotations

@Override

incIndex	back to summary
pack-priv synchronized void incIndex()

isShard	back to summary
pack-priv boolean isShard()

makeCopy	back to summary
private static HSSPrivateKeyParameters makeCopy(HSSPrivateKeyParameters privateKeyParameters)

replaceConsumedKey	back to summary
pack-priv void replaceConsumedKey(int d)

resetKeyToIndex	back to summary
pack-priv void resetKeyToIndex() Reset to index will ensure that all LMS keys are correct for a given HSS index value. Normally LMS keys updated in sync with their parent HSS key but in cases of sharding the normal monotonic updating does not apply and the state of the LMS keys needs to be reset to match the current HSS index.

updateHierarchy	back to summary
protected void updateHierarchy(LMSPrivateKeyParameters[] newKeys, LMSSignature[] newSig)

public Class HSSPrivateKeyParameters

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail