Modifier and Type	Class and Description
private static class	LMSPrivateKeyParameters.CacheKey

Modifier and Type	Field and Description
private final byte[]	I
private static LMSPrivateKeyParameters.CacheKey[]	internedKeys
private final byte[]	masterSecret
private final int	maxCacheR
private final int	maxQ
private final LMOtsParameters	otsParameters
private final LMSigParameters	parameters
private LMSPublicKeyParameters	publicKey
private int	q
private static LMSPrivateKeyParameters.CacheKey	T1
private final Map<LMSPrivateKeyParameters.CacheKey, byte[]>	tCache
private final Digest	tDigest

Access	Constructor and Description
public	LMSPrivateKeyParameters(LMSigParameters lmsParameter, LMOtsParameters otsParameters, int q, byte[] I, int maxQ, byte[] masterSecret)
private	LMSPrivateKeyParameters(LMSPrivateKeyParameters parent, int q, int maxQ)

Method Summary

Modifier and Type	Method and Description
private byte[]	calcT(int r)
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 LMSPrivateKeyParameters	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.
pack-priv byte[]	findT(int r)
private byte[]	findT(LMSPrivateKeyParameters.CacheKey key)
public LMSContext	generateLMSContext() Implements org.bouncycastle.pqc.crypto.lms.LMSContextBasedSigner.generateLMSContext.
public byte[]	generateSignature(LMSContext context) Implements org.bouncycastle.pqc.crypto.lms.LMSContextBasedSigner.generateSignature.
pack-priv LMOtsPrivateKey	getCurrentOTSKey()
public 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 byte[]	getI()
public synchronized int	Returns: private key index number. getIndex() Return the key index (the q value).
public int	getIndexLimit()
public static LMSPrivateKeyParameters	getInstance(byte[] privEnc, byte[] pubEnc)
public static LMSPrivateKeyParameters	getInstance(Object src)
public byte[]	getMasterSecret()
pack-priv LMOtsPrivateKey	getNextOtsPrivateKey()
public LMOtsParameters	getOtsParameters()
public LMSPublicKeyParameters	getPublicKey()
public LMSigParameters	getSigParameters()
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 this object.
pack-priv synchronized void	incIndex()

Field Detail

I	back to summary
private final byte[] I

internedKeys	back to summary
private static LMSPrivateKeyParameters.CacheKey[] internedKeys

masterSecret	back to summary
private final byte[] masterSecret

maxCacheR	back to summary
private final int maxCacheR

maxQ	back to summary
private final int maxQ

otsParameters	back to summary
private final LMOtsParameters otsParameters

parameters	back to summary
private final LMSigParameters parameters

publicKey	back to summary
private LMSPublicKeyParameters publicKey

q	back to summary
private int q

T1	back to summary
private static LMSPrivateKeyParameters.CacheKey T1

tCache	back to summary
private final Map<LMSPrivateKeyParameters.CacheKey, byte[]> tCache

tDigest	back to summary
private final Digest tDigest

Constructor Detail

LMSPrivateKeyParameters	back to summary
public LMSPrivateKeyParameters(LMSigParameters lmsParameter, LMOtsParameters otsParameters, int q, byte[] I, int maxQ, byte[] masterSecret)

LMSPrivateKeyParameters	back to summary
private LMSPrivateKeyParameters(LMSPrivateKeyParameters parent, int q, int maxQ)

Method Detail

calcT	back to summary
private byte[] calcT(int r)

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 LMSPrivateKeyParameters 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:LMSPrivateKeyParameters a key based on the current key that can be used usageCount times.

extractKeyShard

back to summary

public LMSPrivateKeyParameters 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:LMSPrivateKeyParameters

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

findT	back to summary
pack-priv byte[] findT(int r)

findT	back to summary
private byte[] findT(LMSPrivateKeyParameters.CacheKey key)

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.

getCurrentOTSKey	back to summary
pack-priv LMOtsPrivateKey getCurrentOTSKey()

getEncoded	back to summary
public 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. Exceptions IOException: if an issue arises generation the encoding.

getEncoded

back to summary

public 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.

Exceptions

IOException:: if an issue arises generation the encoding.

getI	back to summary
public byte[] getI()

getIndex	back to summary
public synchronized int getIndex() Return the key index (the q value). Returns:int private key index number.

getIndex

back to summary

public synchronized int getIndex()

Return the key index (the q value).

Returns:int: private key index number.

getIndexLimit	back to summary
public int getIndexLimit()

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

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

getMasterSecret	back to summary
public byte[] getMasterSecret()

getNextOtsPrivateKey	back to summary
pack-priv LMOtsPrivateKey getNextOtsPrivateKey()

getOtsParameters	back to summary
public LMOtsParameters getOtsParameters()

getPublicKey	back to summary
public LMSPublicKeyParameters getPublicKey()

getSigParameters	back to summary
public LMSigParameters getSigParameters()

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

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

Annotations

@Override

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

org.bouncycastle.pqc.crypto.lms back to summary

private Class LMSPrivateKeyParameters.CacheKey

Class Inheritance

extends Object

java.lang.Object
org.bouncycastle.pqc.crypto.lms.LMSPrivateKeyParameters.CacheKey

Field Summary

Modifier and Type	Field and Description
private final int	index

Constructor Summary

Access	Constructor and Description
pack-priv	CacheKey(int index)

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 int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.

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

Field Detail

index	back to summary
private final int index

Constructor Detail

CacheKey	back to summary
pack-priv CacheKey(int index)

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.

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.

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

public Class LMSPrivateKeyParameters

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class LMSPrivateKeyParameters.CacheKey

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail