Top Fields Constructors Methods
org.bouncycastle.pqc.crypto.xmss

public Class XMSSSigner

extends Object
implements StateAwareMessageSigner
Class Inheritance
All Implemented Interfaces
org.bouncycastle.pqc.crypto.StateAwareMessageSigner, org.bouncycastle.pqc.crypto.MessageSigner
Imports
org.bouncycastle.crypto.CipherParameters, org.bouncycastle.crypto.params.AsymmetricKeyParameter, org.bouncycastle.pqc.crypto.ExhaustedPrivateKeyException, .StateAwareMessageSigner, org.bouncycastle.util.Arrays

Field Summary

Modifier and TypeField and Description
private boolean
hasGenerated

private boolean
initSign

private KeyedHashFunctions
khf

private XMSSParameters
params

private XMSSPrivateKeyParameters
privateKey

Deprecated as a consequence of XMSSPrivateKeyParameters being deprecated.
private XMSSPublicKeyParameters
publicKey

Deprecated as a consequence of XMSSPublicKeyParameters being deprecated.
private WOTSPlus
wotsPlus

Constructor Summary

AccessConstructor and Description
public
XMSSSigner()

Method Summary

Modifier and TypeMethod and Description
public byte[]
generateSignature(byte[]
the message to be signed.
message)

Implements org.bouncycastle.pqc.crypto.MessageSigner.generateSignature.

sign the passed in message (usually the output of a hash function).
public AsymmetricKeyParameter
getUpdatedPrivateKey()

Implements org.bouncycastle.pqc.crypto.StateAwareMessageSigner.getUpdatedPrivateKey.

Return the current version of the private key with the updated state.
public long
getUsagesRemaining()

public void
init(boolean
true if we are generating a signature, false otherwise.
forSigning, CipherParameters
key parameters for signature generation.
param)

Implements org.bouncycastle.pqc.crypto.MessageSigner.init.

initialise the signer for signature generation or signature verification.
public boolean
verifySignature(byte[]
the message that was supposed to have been signed.
message, byte[]
the signature of the message
signature)

Implements org.bouncycastle.pqc.crypto.MessageSigner.verifySignature.

verify the message message against the signature value.
private WOTSPlusSignature
wotsSign(byte[] messageDigest, OTSHashAddress otsHashAddress)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

hasGeneratedback to summary
private boolean hasGenerated
initSignback to summary
private boolean initSign
khfback to summary
private KeyedHashFunctions khf
paramsback to summary
private XMSSParameters params
privateKeyback to summary
private XMSSPrivateKeyParameters privateKey

Deprecated

as a consequence of XMSSPrivateKeyParameters being deprecated. See corresponding docs for further information.

publicKeyback to summary
private XMSSPublicKeyParameters publicKey

Deprecated

as a consequence of XMSSPublicKeyParameters being deprecated. See corresponding docs for further information.

wotsPlusback to summary
private WOTSPlus wotsPlus

Constructor Detail

XMSSSignerback to summary
public XMSSSigner()

Method Detail

generateSignatureback to summary
public byte[] generateSignature(byte[] message)

Implements org.bouncycastle.pqc.crypto.MessageSigner.generateSignature.

Doc from org.bouncycastle.pqc.crypto.MessageSigner.generateSignature.

sign the passed in message (usually the output of a hash function).

Parameters
message:byte[]

the message to be signed.

Returns:byte[]

the signature of the message

getUpdatedPrivateKeyback to summary
public AsymmetricKeyParameter getUpdatedPrivateKey()

Implements org.bouncycastle.pqc.crypto.StateAwareMessageSigner.getUpdatedPrivateKey.

Doc from org.bouncycastle.pqc.crypto.StateAwareMessageSigner.getUpdatedPrivateKey.

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

Note

calling this method will effectively disable the Signer from being used for further signature generation without another call to init().

Returns:AsymmetricKeyParameter

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

getUsagesRemainingback to summary
public long getUsagesRemaining()
initback to summary
public void init(boolean forSigning, CipherParameters param)

Implements org.bouncycastle.pqc.crypto.MessageSigner.init.

Doc from org.bouncycastle.pqc.crypto.MessageSigner.init.

initialise the signer for signature generation or signature verification.

Parameters
forSigning:boolean

true if we are generating a signature, false otherwise.

param:CipherParameters

key parameters for signature generation.

verifySignatureback to summary
public boolean verifySignature(byte[] message, byte[] signature)

Implements org.bouncycastle.pqc.crypto.MessageSigner.verifySignature.

Doc from org.bouncycastle.pqc.crypto.MessageSigner.verifySignature.

verify the message message against the signature value.

Parameters
message:byte[]

the message that was supposed to have been signed.

signature:byte[]

the signature of the message

wotsSignback to summary
private WOTSPlusSignature wotsSign(byte[] messageDigest, OTSHashAddress otsHashAddress)