Class XMSSMTSignatureSpi

java.lang.Object

java.security.SignatureSpi

java.security.Signature

org.bouncycastle.pqc.jcajce.provider.xmss.XMSSMTSignatureSpi

All Implemented Interfaces:

StateAwareSignature

Direct Known Subclasses:

XMSSMTSignatureSpi.generic, XMSSMTSignatureSpi.withSha256, XMSSMTSignatureSpi.withSha256andPrehash, XMSSMTSignatureSpi.withSha512, XMSSMTSignatureSpi.withSha512andPrehash, XMSSMTSignatureSpi.withShake128, XMSSMTSignatureSpi.withShake128_512andPrehash, XMSSMTSignatureSpi.withShake128andPrehash, XMSSMTSignatureSpi.withShake256, XMSSMTSignatureSpi.withShake256_1024andPrehash, XMSSMTSignatureSpi.withShake256andPrehash

public class XMSSMTSignatureSpi
extends Signature
implements StateAwareSignature

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XMSSMTSignatureSpi.generic
static class	XMSSMTSignatureSpi.withSha256
static class	XMSSMTSignatureSpi.withSha256andPrehash
static class	XMSSMTSignatureSpi.withSha512
static class	XMSSMTSignatureSpi.withSha512andPrehash
static class	XMSSMTSignatureSpi.withShake128
static class	XMSSMTSignatureSpi.withShake128_512andPrehash
static class	XMSSMTSignatureSpi.withShake128andPrehash
static class	XMSSMTSignatureSpi.withShake256
static class	XMSSMTSignatureSpi.withShake256_1024andPrehash
static class	XMSSMTSignatureSpi.withShake256andPrehash

Field Summary

Fields inherited from class Signature

SIGN, state, UNINITIALIZED, VERIFY

Fields inherited from class SignatureSpi

appRandom

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	XMSSMTSignatureSpi(String algorithm)
protected	XMSSMTSignatureSpi(String sigName, Digest digest, XMSSMTSigner signer)
protected	XMSSMTSignatureSpi(String sigName, Digest digest, XMSSMTSigner signer, ASN1ObjectIdentifier[] treeDigests)

Method Summary

Modifier and Type	Method	Description
protected Object	engineGetParameter(String param)	Deprecated.
protected void	engineInitSign(PrivateKey privateKey)
protected void	engineInitSign(PrivateKey privateKey, SecureRandom random)
protected void	engineInitVerify(PublicKey publicKey)
protected void	engineSetParameter(String param, Object value)	Deprecated. replaced with #engineSetParameter(java.security.spec.AlgorithmParameterSpec)
protected void	engineSetParameter(AlgorithmParameterSpec params)
protected byte[]	engineSign()
protected void	engineUpdate(byte b)
protected void	engineUpdate(byte[] b, int off, int len)
protected boolean	engineVerify(byte[] sigBytes)
PrivateKey	getUpdatedPrivateKey()	Return the current version of the private key with the updated state.
boolean	isSigningCapable()	Return true if this Signature object can be used for signing.

Methods inherited from class Signature

clone, getAlgorithm, getInstance, getInstance, getInstance, getParameter, getParameters, getProvider, initSign, initSign, initVerify, initVerify, setParameter, setParameter, sign, sign, toString, update, update, update, update, verify, verify

Methods inherited from class SignatureSpi

engineGetParameters, engineSign, engineUpdate, engineVerify

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface StateAwareSignature

getAlgorithm, initSign, initSign, initVerify, initVerify, sign, sign, update, update, update, update, verify, verify

Constructor Details

XMSSMTSignatureSpi

protected XMSSMTSignatureSpi(String algorithm)

XMSSMTSignatureSpi

protected XMSSMTSignatureSpi(String sigName,
 Digest digest,
 XMSSMTSigner signer)

XMSSMTSignatureSpi

protected XMSSMTSignatureSpi(String sigName,
 Digest digest,
 XMSSMTSigner signer,
 ASN1ObjectIdentifier[] treeDigests)

Method Details

engineInitVerify

protected void engineInitVerify(PublicKey publicKey)
                         throws InvalidKeyException

Specified by:

engineInitVerify in class SignatureSpi

Throws:

InvalidKeyException

engineInitSign

protected void engineInitSign(PrivateKey privateKey,
 SecureRandom random)
                       throws InvalidKeyException

Overrides:

engineInitSign in class SignatureSpi

Throws:

InvalidKeyException

engineInitSign

protected void engineInitSign(PrivateKey privateKey)
                       throws InvalidKeyException

Specified by:

engineInitSign in class SignatureSpi

Throws:

InvalidKeyException

engineUpdate

protected void engineUpdate(byte b)
                     throws SignatureException

Specified by:

engineUpdate in class SignatureSpi

Throws:

SignatureException

engineUpdate

protected void engineUpdate(byte[] b,
 int off,
 int len)
                     throws SignatureException

Specified by:

engineUpdate in class SignatureSpi

Throws:

SignatureException

engineSign

protected byte[] engineSign()
                     throws SignatureException

Specified by:

engineSign in class SignatureSpi

Throws:

SignatureException

engineVerify

protected boolean engineVerify(byte[] sigBytes)
                        throws SignatureException

Specified by:

engineVerify in class SignatureSpi

Throws:

SignatureException

engineSetParameter

protected void engineSetParameter(AlgorithmParameterSpec params)

Overrides:

engineSetParameter in class SignatureSpi

engineSetParameter

protected void engineSetParameter(String param,
 Object value)

Deprecated.

replaced with #engineSetParameter(java.security.spec.AlgorithmParameterSpec)

Specified by:

engineSetParameter in class SignatureSpi

engineGetParameter

protected Object engineGetParameter(String param)

Deprecated.

Specified by:

engineGetParameter in class SignatureSpi

isSigningCapable

public boolean isSigningCapable()

Description copied from interface: StateAwareSignature

Return true if this Signature object can be used for signing. False otherwise.

Specified by:

isSigningCapable in interface StateAwareSignature

Returns:

true if we are capable of making signatures.

getUpdatedPrivateKey

public PrivateKey getUpdatedPrivateKey()

Description copied from interface: StateAwareSignature

Return the current version of the private key with the updated state.

Note: what this leaves behind depends on whether a signature has been generated since initSign(). After one, the key handed back is the key that signature spent and the Signature object keeps nothing: it cannot generate another signature without a further call to initSign(), and a second call to this method throws. Before one, the object keeps a single usage to sign with and hands back the rest, so it remains capable of exactly one signature - that is the whole point of collecting first, since the state a caller is obliged to persist is then durable before the one-time key covering it is spent. A second call in that state hands back the same key again rather than a further shard.

Collecting first and then signing joins the two: the signature spends the one usage the object kept, and a collection after it throws rather than handing that spent shard over. Everything the caller has to store it was given by the first collection, and the shard adds nothing to it - so a caller that collects in a finally beside an explicit collection is refused instead of overwriting the remainder with a key reporting nothing remaining.

The key that comes back may report no usages remaining - a Signature object initialised on a spent key still has state its caller has to store - so a non-null return is not on its own a statement that anything is left to sign with. StateAwareSignature.isSigningCapable() is what answers that, and the two do differ in that case.

Specified by:

getUpdatedPrivateKey in interface StateAwareSignature

Returns:

an updated private key object, which can be used for later signature generation.