org.bouncycastle.pqc.jcajce.interfaces

Interface StateAwareSignature

All Known Implementing Classes:

XMSSMTSignatureSpi, XMSSMTSignatureSpi.withSha256, XMSSMTSignatureSpi.withSha256andPrehash, XMSSMTSignatureSpi.withSha512, XMSSMTSignatureSpi.withSha512andPrehash, XMSSMTSignatureSpi.withShake128, XMSSMTSignatureSpi.withShake128andPrehash, XMSSMTSignatureSpi.withShake256, XMSSMTSignatureSpi.withShake256andPrehash, XMSSSignatureSpi, XMSSSignatureSpi.withSha256, XMSSSignatureSpi.withSha256andPrehash, XMSSSignatureSpi.withSha512, XMSSSignatureSpi.withSha512andPrehash, XMSSSignatureSpi.withShake128, XMSSSignatureSpi.withShake128andPrehash, XMSSSignatureSpi.withShake256, XMSSSignatureSpi.withShake256andPrehash

public interface StateAwareSignature

This interface is implemented by Signature classes returned by the PQC provider where the signature algorithm is one where the private key is updated for each signature generated. Examples of these are algorithms such as GMSS, XMSS, and XMSS^MT.

Method Summary

Modifier and Type	Method and Description
String	getAlgorithm()
PrivateKey	getUpdatedPrivateKey() Return the current version of the private key with the updated state.
void	initSign(PrivateKey privateKey)
void	initSign(PrivateKey privateKey, SecureRandom random)
void	initVerify(Certificate certificate)
void	initVerify(PublicKey publicKey)
boolean	isSigningCapable() Return true if this Signature object can be used for signing.
byte[]	sign()
int	sign(byte[] outbuf, int offset, int len)
void	update(byte b)
void	update(byte[] data)
void	update(byte[] data, int off, int len)
void	update(ByteBuffer data)
boolean	verify(byte[] signature)
boolean	verify(byte[] signature, int offset, int length)

Method Detail

initVerify

void initVerify(PublicKey publicKey)
         throws InvalidKeyException

Throws:

InvalidKeyException

initVerify

void initVerify(Certificate certificate)
         throws InvalidKeyException

Throws:

InvalidKeyException

initSign

void initSign(PrivateKey privateKey)
       throws InvalidKeyException

Throws:

InvalidKeyException

initSign

void initSign(PrivateKey privateKey,
              SecureRandom random)
       throws InvalidKeyException

Throws:

InvalidKeyException

sign

byte[] sign()
     throws SignatureException

Throws:

SignatureException

sign

int sign(byte[] outbuf,
         int offset,
         int len)
  throws SignatureException

Throws:

SignatureException

verify

boolean verify(byte[] signature)
        throws SignatureException

Throws:

SignatureException

verify

boolean verify(byte[] signature,
               int offset,
               int length)
        throws SignatureException

Throws:

SignatureException

update

void update(byte b)
     throws SignatureException

Throws:

SignatureException

update

void update(byte[] data)
     throws SignatureException

Throws:

SignatureException

update

void update(byte[] data,
            int off,
            int len)
     throws SignatureException

Throws:

SignatureException

update

void update(ByteBuffer data)
     throws SignatureException

Throws:

SignatureException

getAlgorithm

String getAlgorithm()

isSigningCapable

boolean isSigningCapable()

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

Returns:

true if we are capable of making signatures.

getUpdatedPrivateKey

PrivateKey getUpdatedPrivateKey()

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

Note: calling this method will effectively disable the Signature object from being used for further signature generation without another call to initSign().

Returns:

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