StateAwareSignature (Bouncy Castle Library 1.60 API Specification)

All Known Implementing Classes:

XMSSMTSignatureSpi, XMSSMTSignatureSpi.withSha256, XMSSMTSignatureSpi.withSha512, XMSSMTSignatureSpi.withShake128, XMSSMTSignatureSpi.withShake256, XMSSSignatureSpi, XMSSSignatureSpi.withSha256, XMSSSignatureSpi.withSha512, XMSSSignatureSpi.withShake128, XMSSSignatureSpi.withShake256
```
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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.lang.String`	`getAlgorithm()`
`java.security.PrivateKey`	`getUpdatedPrivateKey()`	Return the current version of the private key with the updated state.
`void`	`initSign(java.security.PrivateKey privateKey)`
`void`	`initSign(java.security.PrivateKey privateKey, java.security.SecureRandom random)`
`void`	`initVerify(java.security.cert.Certificate certificate)`
`void`	`initVerify(java.security.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(java.nio.ByteBuffer data)`
`boolean`	`verify(byte[] signature)`
`boolean`	`verify(byte[] signature, int offset, int length)`

Method Detail

initVerify

void initVerify(java.security.PublicKey publicKey)
         throws java.security.InvalidKeyException

Throws:: java.security.InvalidKeyException

initVerify

void initVerify(java.security.cert.Certificate certificate)
         throws java.security.InvalidKeyException

Throws:: java.security.InvalidKeyException

initSign

void initSign(java.security.PrivateKey privateKey)
       throws java.security.InvalidKeyException

Throws:: java.security.InvalidKeyException

initSign

void initSign(java.security.PrivateKey privateKey,
              java.security.SecureRandom random)
       throws java.security.InvalidKeyException

Throws:: java.security.InvalidKeyException

sign

byte[] sign()
     throws java.security.SignatureException

Throws:: java.security.SignatureException

sign

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

Throws:: java.security.SignatureException

verify

boolean verify(byte[] signature)
        throws java.security.SignatureException

Throws:: java.security.SignatureException

verify

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

Throws:: java.security.SignatureException

update

void update(byte b)
     throws java.security.SignatureException

Throws:: java.security.SignatureException

update

void update(byte[] data)
     throws java.security.SignatureException

Throws:: java.security.SignatureException

update

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

Throws:: java.security.SignatureException

update

void update(java.nio.ByteBuffer data)
     throws java.security.SignatureException

Throws:: java.security.SignatureException

getAlgorithm
```
java.lang.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
```
java.security.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.

Interface StateAwareSignature

Method Summary

Method Detail

initVerify

initVerify

initSign

initSign

sign

sign

verify

verify

update

update

update

update

getAlgorithm

isSigningCapable

getUpdatedPrivateKey