Top Inners Fields Constructors Methods
org.bouncycastle.pqc.jcajce.provider.xmss

public Class XMSSSignatureSpi

extends Signature
implements StateAwareSignature
Class Inheritance
All Implemented Interfaces
org.bouncycastle.pqc.jcajce.interfaces.StateAwareSignature
Known Direct Subclasses
org.bouncycastle.pqc.jcajce.provider.xmss.XMSSSignatureSpi.generic, org.bouncycastle.pqc.jcajce.provider.xmss.XMSSSignatureSpi.withSha256, org.bouncycastle.pqc.jcajce.provider.xmss.XMSSSignatureSpi.withShake128, org.bouncycastle.pqc.jcajce.provider.xmss.XMSSSignatureSpi.withSha512, org.bouncycastle.pqc.jcajce.provider.xmss.XMSSSignatureSpi.withShake256, org.bouncycastle.pqc.jcajce.provider.xmss.XMSSSignatureSpi.withSha256andPrehash, org.bouncycastle.pqc.jcajce.provider.xmss.XMSSSignatureSpi.withShake128andPrehash, org.bouncycastle.pqc.jcajce.provider.xmss.XMSSSignatureSpi.withShake128_512andPrehash, org.bouncycastle.pqc.jcajce.provider.xmss.XMSSSignatureSpi.withSha512andPrehash, org.bouncycastle.pqc.jcajce.provider.xmss.XMSSSignatureSpi.withShake256andPrehash, org.bouncycastle.pqc.jcajce.provider.xmss.XMSSSignatureSpi.withShake256_1024andPrehash
Imports
java.security.InvalidKeyException, .PrivateKey, .PublicKey, .SecureRandom, .Signature, .SignatureException, java.security.spec.AlgorithmParameterSpec, org.bouncycastle.asn1.ASN1ObjectIdentifier, org.bouncycastle.crypto.CipherParameters, .Digest, org.bouncycastle.crypto.digests.NullDigest, .SHA256Digest, .SHA512Digest, .SHAKEDigest, org.bouncycastle.crypto.params.ParametersWithRandom, org.bouncycastle.pqc.crypto.xmss.XMSSPrivateKeyParameters, .XMSSSigner, org.bouncycastle.pqc.jcajce.interfaces.StateAwareSignature

Deprecated

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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
XMSSSignatureSpi.generic

Deprecated as a consequence of XMSSSignatureSpi being deprecated.
public static class
XMSSSignatureSpi.withSha256

Deprecated as a consequence of XMSSSignatureSpi being deprecated.
public static class
XMSSSignatureSpi.withSha256andPrehash

Deprecated as a consequence of XMSSSignatureSpi being deprecated.
public static class
XMSSSignatureSpi.withSha512

Deprecated as a consequence of XMSSSignatureSpi being deprecated.
public static class
XMSSSignatureSpi.withSha512andPrehash

Deprecated as a consequence of XMSSSignatureSpi being deprecated.
public static class
XMSSSignatureSpi.withShake128

Deprecated as a consequence of XMSSSignatureSpi being deprecated.
public static class
XMSSSignatureSpi.withShake128_512andPrehash

Deprecated as a consequence of XMSSSignatureSpi being deprecated.
public static class
XMSSSignatureSpi.withShake128andPrehash

Deprecated as a consequence of XMSSSignatureSpi being deprecated.
public static class
XMSSSignatureSpi.withShake256

Deprecated as a consequence of XMSSSignatureSpi being deprecated.
public static class
XMSSSignatureSpi.withShake256_1024andPrehash

Deprecated as a consequence of XMSSSignatureSpi being deprecated.
public static class
XMSSSignatureSpi.withShake256andPrehash

Deprecated as a consequence of XMSSSignatureSpi being deprecated.

Field Summary

Modifier and TypeField and Description
private Digest
digest

private SecureRandom
random

private XMSSSigner
signer

private ASN1ObjectIdentifier
treeDigest

Inherited from java.security.Signature:
SIGNstateUNINITIALIZEDVERIFY

Constructor Summary

AccessConstructor and Description
protected
XMSSSignatureSpi(String algorithm)

protected
XMSSSignatureSpi(String sigName, Digest digest, XMSSSigner signer)

Method Summary

Modifier and TypeMethod and Description
protected Object
engineGetParameter(String
the string name of the parameter.
param)

Implements abstract java.security.SignatureSpi.engineGetParameter.

Deprecated
Gets the value of the specified algorithm parameter.
protected void
engineInitSign(PrivateKey
the private key of the identity whose signature will be generated.
privateKey, SecureRandom
the source of randomness
random)

Overrides java.security.SignatureSpi.engineInitSign.

Initializes this Signature object with the specified private key and source of randomness for signing operations.
protected void
engineInitSign(PrivateKey
the private key of the identity whose signature will be generated.
privateKey)

Implements abstract java.security.SignatureSpi.engineInitSign.

Initializes this Signature object with the specified private key for signing operations.
protected void
engineInitVerify(PublicKey
the public key of the identity whose signature is going to be verified.
publicKey)

Implements abstract java.security.SignatureSpi.engineInitVerify.

Initializes this Signature object with the specified public key for verification operations.
protected void
engineSetParameter(AlgorithmParameterSpec
the parameters
params)

Overrides java.security.SignatureSpi.engineSetParameter.

Initializes this Signature object with the specified parameter values.
protected void
engineSetParameter(String
the string identifier of the parameter.
param, Object
the parameter value.
value)

Implements abstract java.security.SignatureSpi.engineSetParameter.

Deprecated replaced with #engineSetParameter(java.security.spec.AlgorithmParameterSpec)
Sets the specified algorithm parameter to the specified value.
protected byte[]
engineSign()

Implements abstract java.security.SignatureSpi.engineSign.

Returns the signature bytes of all the data updated so far.
protected void
engineUpdate(byte
the byte to use for the update.
b)

Implements abstract java.security.SignatureSpi.engineUpdate.

Updates the data to be signed or verified using the specified byte.
protected void
engineUpdate(byte[]
the array of bytes
b, int
the offset to start from in the array of bytes
off, int
the number of bytes to use, starting at offset
len)

Implements abstract java.security.SignatureSpi.engineUpdate.

Updates the data to be signed or verified, using the specified array of bytes, starting at the specified offset.
protected boolean
engineVerify(byte[]
the signature bytes to be verified.
sigBytes)

Implements abstract java.security.SignatureSpi.engineVerify.

Verifies the passed-in signature.
public PrivateKey
getUpdatedPrivateKey()

Implements org.bouncycastle.pqc.jcajce.interfaces.StateAwareSignature.getUpdatedPrivateKey.

Return the current version of the private key with the updated state.
public boolean
isSigningCapable()

Implements org.bouncycastle.pqc.jcajce.interfaces.StateAwareSignature.isSigningCapable.

Return true if this Signature object can be used for signing.
Inherited from java.security.Signature:
clonegetAlgorithmgetInstancegetInstancegetInstancegetParametergetParametersgetProviderinitSigninitSigninitVerifyinitVerifysetParametersetParametersignsigntoStringupdateupdateupdateupdateverifyverify

Field Detail

digestback to summary
private Digest digest
randomback to summary
private SecureRandom random
signerback to summary
private XMSSSigner signer
treeDigestback to summary
private ASN1ObjectIdentifier treeDigest

Constructor Detail

XMSSSignatureSpiback to summary
protected XMSSSignatureSpi(String algorithm)
XMSSSignatureSpiback to summary
protected XMSSSignatureSpi(String sigName, Digest digest, XMSSSigner signer)

Method Detail

engineGetParameterback to summary
protected Object engineGetParameter(String param)

Implements abstract java.security.SignatureSpi.engineGetParameter.

Doc from java.security.SignatureSpi.engineGetParameter.

Deprecated

Gets the value of the specified algorithm parameter. This method supplies a general-purpose mechanism through which it is possible to get the various parameters of this object. A parameter may be any settable parameter for the algorithm, such as a parameter size, or a source of random bits for signature generation (if appropriate), or an indication of whether to perform a specific but optional computation. A uniform algorithm-specific naming scheme for each parameter is desirable but left unspecified at this time.

Parameters
param:String

the string name of the parameter.

Returns:Object

the object that represents the parameter value, or null if there is none.

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

Overrides java.security.SignatureSpi.engineInitSign.

Doc from java.security.SignatureSpi.engineInitSign.

Initializes this Signature object with the specified private key and source of randomness for signing operations.

This concrete method has been added to this previously-defined abstract class. (For backwards compatibility, it cannot be abstract.)

Parameters
privateKey:PrivateKey

the private key of the identity whose signature will be generated.

random:SecureRandom

the source of randomness

Exceptions
InvalidKeyException:
if the key is improperly encoded, parameters are missing, and so on.
engineInitSignback to summary
protected void engineInitSign(PrivateKey privateKey) throws InvalidKeyException

Implements abstract java.security.SignatureSpi.engineInitSign.

Doc from java.security.SignatureSpi.engineInitSign.

Initializes this Signature object with the specified private key for signing operations.

Parameters
privateKey:PrivateKey

the private key of the identity whose signature will be generated.

Exceptions
InvalidKeyException:
if the key is improperly encoded, parameters are missing, and so on.
engineInitVerifyback to summary
protected void engineInitVerify(PublicKey publicKey) throws InvalidKeyException

Implements abstract java.security.SignatureSpi.engineInitVerify.

Doc from java.security.SignatureSpi.engineInitVerify.

Initializes this Signature object with the specified public key for verification operations.

Parameters
publicKey:PublicKey

the public key of the identity whose signature is going to be verified.

Exceptions
InvalidKeyException:
if the key is improperly encoded, parameters are missing, and so on.
engineSetParameterback to summary
protected void engineSetParameter(AlgorithmParameterSpec params)

Overrides java.security.SignatureSpi.engineSetParameter.

Doc from java.security.SignatureSpi.engineSetParameter.

Initializes this Signature object with the specified parameter values.

Parameters
params:AlgorithmParameterSpec

the parameters

engineSetParameterback to summary
protected void engineSetParameter(String param, Object value)

Implements abstract java.security.SignatureSpi.engineSetParameter.

Doc from java.security.SignatureSpi.engineSetParameter.

Deprecated

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

Sets the specified algorithm parameter to the specified value. This method supplies a general-purpose mechanism through which it is possible to set the various parameters of this object. A parameter may be any settable parameter for the algorithm, such as a parameter size, or a source of random bits for signature generation (if appropriate), or an indication of whether to perform a specific but optional computation. A uniform algorithm-specific naming scheme for each parameter is desirable but left unspecified at this time.

Parameters
param:String

the string identifier of the parameter.

value:Object

the parameter value.

engineSignback to summary
protected byte[] engineSign() throws SignatureException

Implements abstract java.security.SignatureSpi.engineSign.

Doc from java.security.SignatureSpi.engineSign.

Returns the signature bytes of all the data updated so far. The format of the signature depends on the underlying signature scheme.

Returns:byte[]

the signature bytes of the signing operation's result.

Exceptions
SignatureException:
if the engine is not initialized properly or if this signature algorithm is unable to process the input data provided.
engineUpdateback to summary
protected void engineUpdate(byte b) throws SignatureException

Implements abstract java.security.SignatureSpi.engineUpdate.

Doc from java.security.SignatureSpi.engineUpdate.

Updates the data to be signed or verified using the specified byte.

Parameters
b:byte

the byte to use for the update.

Exceptions
SignatureException:
if the engine is not initialized properly.
engineUpdateback to summary
protected void engineUpdate(byte[] b, int off, int len) throws SignatureException

Implements abstract java.security.SignatureSpi.engineUpdate.

Doc from java.security.SignatureSpi.engineUpdate.

Updates the data to be signed or verified, using the specified array of bytes, starting at the specified offset.

Parameters
b:byte[]

the array of bytes

off:int

the offset to start from in the array of bytes

len:int

the number of bytes to use, starting at offset

Exceptions
SignatureException:
if the engine is not initialized properly
engineVerifyback to summary
protected boolean engineVerify(byte[] sigBytes) throws SignatureException

Implements abstract java.security.SignatureSpi.engineVerify.

Doc from java.security.SignatureSpi.engineVerify.

Verifies the passed-in signature.

Parameters
sigBytes:byte[]

the signature bytes to be verified.

Returns:boolean

true if the signature was verified, false if not.

Exceptions
SignatureException:
if the engine is not initialized properly, the passed-in signature is improperly encoded or of the wrong type, if this signature algorithm is unable to process the input data provided, etc.
getUpdatedPrivateKeyback to summary
public PrivateKey getUpdatedPrivateKey()

Implements org.bouncycastle.pqc.jcajce.interfaces.StateAwareSignature.getUpdatedPrivateKey.

Doc from org.bouncycastle.pqc.jcajce.interfaces.StateAwareSignature.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:PrivateKey

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

isSigningCapableback to summary
public boolean isSigningCapable()

Implements org.bouncycastle.pqc.jcajce.interfaces.StateAwareSignature.isSigningCapable.

Doc from org.bouncycastle.pqc.jcajce.interfaces.StateAwareSignature.isSigningCapable.

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

Returns:boolean

true if we are capable of making signatures.

org.bouncycastle.pqc.jcajce.provider.xmss back to summary

public Class XMSSSignatureSpi.generic

extends XMSSSignatureSpi
Class Inheritance

Deprecated

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

Constructor Summary

AccessConstructor and Description
public
generic()

Method Summary

Inherited from org.bouncycastle.pqc.jcajce.provider.xmss.XMSSSignatureSpi:
engineGetParameterengineInitSignengineInitSignengineInitVerifyengineSetParameterengineSetParameterengineSignengineUpdateengineUpdateengineVerifygetUpdatedPrivateKeyisSigningCapable

Constructor Detail

genericback to summary
public generic()
org.bouncycastle.pqc.jcajce.provider.xmss back to summary

public Class XMSSSignatureSpi.withSha256

extends XMSSSignatureSpi
Class Inheritance

Deprecated

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

Constructor Summary

AccessConstructor and Description
public
withSha256()

Method Summary

Inherited from org.bouncycastle.pqc.jcajce.provider.xmss.XMSSSignatureSpi:
engineGetParameterengineInitSignengineInitSignengineInitVerifyengineSetParameterengineSetParameterengineSignengineUpdateengineUpdateengineVerifygetUpdatedPrivateKeyisSigningCapable

Constructor Detail

withSha256back to summary
public withSha256()
org.bouncycastle.pqc.jcajce.provider.xmss back to summary

public Class XMSSSignatureSpi.withSha256andPrehash

extends XMSSSignatureSpi
Class Inheritance

Deprecated

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

Constructor Summary

AccessConstructor and Description
public
withSha256andPrehash()

Method Summary

Inherited from org.bouncycastle.pqc.jcajce.provider.xmss.XMSSSignatureSpi:
engineGetParameterengineInitSignengineInitSignengineInitVerifyengineSetParameterengineSetParameterengineSignengineUpdateengineUpdateengineVerifygetUpdatedPrivateKeyisSigningCapable

Constructor Detail

withSha256andPrehashback to summary
public withSha256andPrehash()
org.bouncycastle.pqc.jcajce.provider.xmss back to summary

public Class XMSSSignatureSpi.withSha512

extends XMSSSignatureSpi
Class Inheritance

Deprecated

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

Constructor Summary

AccessConstructor and Description
public
withSha512()

Method Summary

Inherited from org.bouncycastle.pqc.jcajce.provider.xmss.XMSSSignatureSpi:
engineGetParameterengineInitSignengineInitSignengineInitVerifyengineSetParameterengineSetParameterengineSignengineUpdateengineUpdateengineVerifygetUpdatedPrivateKeyisSigningCapable

Constructor Detail

withSha512back to summary
public withSha512()
org.bouncycastle.pqc.jcajce.provider.xmss back to summary

public Class XMSSSignatureSpi.withSha512andPrehash

extends XMSSSignatureSpi
Class Inheritance

Deprecated

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

Constructor Summary

AccessConstructor and Description
public
withSha512andPrehash()

Method Summary

Inherited from org.bouncycastle.pqc.jcajce.provider.xmss.XMSSSignatureSpi:
engineGetParameterengineInitSignengineInitSignengineInitVerifyengineSetParameterengineSetParameterengineSignengineUpdateengineUpdateengineVerifygetUpdatedPrivateKeyisSigningCapable

Constructor Detail

withSha512andPrehashback to summary
public withSha512andPrehash()
org.bouncycastle.pqc.jcajce.provider.xmss back to summary

public Class XMSSSignatureSpi.withShake128

extends XMSSSignatureSpi
Class Inheritance

Deprecated

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

Constructor Summary

AccessConstructor and Description
public
withShake128()

Method Summary

Inherited from org.bouncycastle.pqc.jcajce.provider.xmss.XMSSSignatureSpi:
engineGetParameterengineInitSignengineInitSignengineInitVerifyengineSetParameterengineSetParameterengineSignengineUpdateengineUpdateengineVerifygetUpdatedPrivateKeyisSigningCapable

Constructor Detail

withShake128back to summary
public withShake128()
org.bouncycastle.pqc.jcajce.provider.xmss back to summary

public Class XMSSSignatureSpi.withShake128_512andPrehash

extends XMSSSignatureSpi
Class Inheritance

Deprecated

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

Constructor Summary

AccessConstructor and Description
public
withShake128_512andPrehash()

Method Summary

Inherited from org.bouncycastle.pqc.jcajce.provider.xmss.XMSSSignatureSpi:
engineGetParameterengineInitSignengineInitSignengineInitVerifyengineSetParameterengineSetParameterengineSignengineUpdateengineUpdateengineVerifygetUpdatedPrivateKeyisSigningCapable

Constructor Detail

withShake128_512andPrehashback to summary
public withShake128_512andPrehash()
org.bouncycastle.pqc.jcajce.provider.xmss back to summary

public Class XMSSSignatureSpi.withShake128andPrehash

extends XMSSSignatureSpi
Class Inheritance

Deprecated

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

Constructor Summary

AccessConstructor and Description
public
withShake128andPrehash()

Method Summary

Inherited from org.bouncycastle.pqc.jcajce.provider.xmss.XMSSSignatureSpi:
engineGetParameterengineInitSignengineInitSignengineInitVerifyengineSetParameterengineSetParameterengineSignengineUpdateengineUpdateengineVerifygetUpdatedPrivateKeyisSigningCapable

Constructor Detail

withShake128andPrehashback to summary
public withShake128andPrehash()
org.bouncycastle.pqc.jcajce.provider.xmss back to summary

public Class XMSSSignatureSpi.withShake256

extends XMSSSignatureSpi
Class Inheritance

Deprecated

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

Constructor Summary

AccessConstructor and Description
public
withShake256()

Method Summary

Inherited from org.bouncycastle.pqc.jcajce.provider.xmss.XMSSSignatureSpi:
engineGetParameterengineInitSignengineInitSignengineInitVerifyengineSetParameterengineSetParameterengineSignengineUpdateengineUpdateengineVerifygetUpdatedPrivateKeyisSigningCapable

Constructor Detail

withShake256back to summary
public withShake256()
org.bouncycastle.pqc.jcajce.provider.xmss back to summary

public Class XMSSSignatureSpi.withShake256_1024andPrehash

extends XMSSSignatureSpi
Class Inheritance

Deprecated

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

Constructor Summary

AccessConstructor and Description
public
withShake256_1024andPrehash()

Method Summary

Inherited from org.bouncycastle.pqc.jcajce.provider.xmss.XMSSSignatureSpi:
engineGetParameterengineInitSignengineInitSignengineInitVerifyengineSetParameterengineSetParameterengineSignengineUpdateengineUpdateengineVerifygetUpdatedPrivateKeyisSigningCapable

Constructor Detail

withShake256_1024andPrehashback to summary
public withShake256_1024andPrehash()
org.bouncycastle.pqc.jcajce.provider.xmss back to summary

public Class XMSSSignatureSpi.withShake256andPrehash

extends XMSSSignatureSpi
Class Inheritance

Deprecated

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

Constructor Summary

AccessConstructor and Description
public
withShake256andPrehash()

Method Summary

Inherited from org.bouncycastle.pqc.jcajce.provider.xmss.XMSSSignatureSpi:
engineGetParameterengineInitSignengineInitSignengineInitVerifyengineSetParameterengineSetParameterengineSignengineUpdateengineUpdateengineVerifygetUpdatedPrivateKeyisSigningCapable

Constructor Detail

withShake256andPrehashback to summary
public withShake256andPrehash()