Class LMSPrivateKeyParameters
- All Implemented Interfaces:
Destroyable, CipherParameters, LMSContextBasedSigner, Encodable
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedLMSPrivateKeyParameters(LMSigParameters sigParameters, LMOtsParameters otsParameters, int maxQ) Deprecated.This class is not intended to be subclassed; the constructor will be removed.LMSPrivateKeyParameters(LMSigParameters sigParameters, LMOtsParameters otsParameters, int q, byte[] I, int maxQ, byte[] masterSecret) An LMS private key positioned at one-time key q of the tree named by I (RFC 8554 sec. -
Method Summary
Modifier and TypeMethodDescriptionvoiddestroy()Destroy this key, zeroizing the master secret it holds.booleanextractKeyShard(int usageCount) Return a key that can be used usageCount times.static LMSPrivateKeyParametersgenerate(LMSParameters lmsParameters, SecureRandom random) A fresh LMS private key (RFC 8554 sec.byte[]generateSignature(LMSContext context) byte[]Return a byte array representing the implementing object.byte[]getI()intgetIndex()Return the key index (the q value).intstatic LMSPrivateKeyParametersgetInstance(byte[] privEnc, byte[] pubEnc) static LMSPrivateKeyParametersgetInstance(Object src) byte[]Deprecated.usegetEncoded()instead.The public key of this tree, derived on first use and kept thereafter.longinthashCode()booleanMethods inherited from class AsymmetricKeyParameter
isPrivate
-
Constructor Details
-
LMSPrivateKeyParameters
public LMSPrivateKeyParameters(LMSigParameters sigParameters, LMOtsParameters otsParameters, int q, byte[] I, int maxQ, byte[] masterSecret) An LMS private key positioned at one-time key q of the tree named by I (RFC 8554 sec. 5.2, Algorithm 5). The identifier and master secret are copied, so the caller keeps its arrays. -
LMSPrivateKeyParameters
@Deprecated protected LMSPrivateKeyParameters(LMSigParameters sigParameters, LMOtsParameters otsParameters, int maxQ) Deprecated.This class is not intended to be subclassed; the constructor will be removed.A key with no position, identifier or seed of its own - the placeholder an HSS hierarchy is built with for the levels below the root, each of which resetKeyToIndex replaces from the level above before the key is used. The sentinel values are deliberately ones the public constructor refuses, so a placeholder can never be mistaken for a key that was merely built carelessly, and the key itself refuses to sign, publish, encode or derive from itself.
-
-
Method Details
-
generate
A fresh LMS private key (RFC 8554 sec. 5.2, Algorithm 5): the SEED (m bytes) and then the identifier I (16 bytes) are drawn from the random, in that order, and the key starts at q = 0 with all 2^h one-time keys available. -
getInstance
- Throws:
IOException
-
getInstance
- Throws:
IOException
-
getIndex
public int getIndex()Return the key index (the q value).- Returns:
- private key index number.
-
generateLMSContext
- Specified by:
generateLMSContextin interfaceLMSContextBasedSigner
-
generateSignature
- Specified by:
generateSignaturein interfaceLMSContextBasedSigner
-
extractKeyShard
Return a key that can be used usageCount times.Note: this will use the range [index...index + usageCount) for the current key.
- Parameters:
usageCount- the number of usages the key should have.- Returns:
- a key based on the current key that can be used usageCount times.
-
getLMSParameters
-
getSigParameters
-
getOtsParameters
-
getI
public byte[] getI() -
getMasterSecret
Deprecated.usegetEncoded()instead. A seed handed out alone is a second copy of the key with no index attached - the state duplication SP 800-208 rules out - whereas the encoding carries the index, usage limit and tree cache with it.Return a copy of the master seed of this tree. -
destroy
public void destroy()Destroy this key, zeroizing the master secret it holds.The key identifier I, the parameter sets, the index and the cached Merkle tree nodes are retained - none of them is secret, and the public key stays derivable where the tree's root is already cached. After destruction
isDestroyed()returns true andgetMasterSecret(),getEncoded(),generateLMSContext()and the derivation of child trees throwIllegalStateException; a signature attempt fails before its one-time index is claimed. Note: keys repositioned within this tree or split off it withextractKeyShard(int)share its master secret array, so destroying this key invalidates them too.- Specified by:
destroyin interfaceDestroyable
-
isDestroyed
public boolean isDestroyed()- Specified by:
isDestroyedin interfaceDestroyable
-
getIndexLimit
public int getIndexLimit() -
getUsagesRemaining
public long getUsagesRemaining()- Specified by:
getUsagesRemainingin interfaceLMSContextBasedSigner
-
getPublicKey
The public key of this tree, derived on first use and kept thereafter.Deliberately not taken under the key's monitor: the root node is a function of the identifier, the master secret and the parameter sets and not of q, so nothing the monitor guards takes part in deriving it, and holding the monitor for a tree build (up to 2^h leaf derivations) would stall every one-time key claim on the key for its duration. Concurrent callers race harmlessly -
findT(int)already dedupes the expensive per-node work, so a second caller finds the tree built - and they publish equal keys. -
equals
-
hashCode
-
getEncoded
Description copied from interface:EncodableReturn a byte array representing the implementing object.- Specified by:
getEncodedin interfaceEncodable- Specified by:
getEncodedin classLMSKeyParameters- Returns:
- a byte array representing the encoding.
- Throws:
IOException- if an issue arises generation the encoding.
-