Bouncy Castle Cryptography Library 1.80 · org.bouncycastle.pqc.crypto.xmss.XMSS

Modifier and Type	Field and Description
private final XMSSParameters	params XMSS parameters.
private XMSSPrivateKeyParameters	privateKey References Deprecated `XMSSPrivateKeyParameters` is deprecated or references (maybe indirectly) at least one deprecated element. XMSS private key.
private SecureRandom	prng PRNG.
private XMSSPublicKeyParameters	publicKey References Deprecated `XMSSPublicKeyParameters` is deprecated or references (maybe indirectly) at least one deprecated element. XMSS public key.
private WOTSPlus	wotsPlus WOTS+ instance.

Access	Constructor and Description
public	XMSS(XMSSParameters XMSSParameters. params, SecureRandom prng) XMSS constructor...

Method Summary

Modifier and Type	Method and Description
public XMSSPrivateKeyParameters	Returns: XMSS private key. exportPrivateKey() References Deprecated `XMSSPrivateKeyParameters` is deprecated or references (maybe indirectly) at least one deprecated element. Export XMSS private key.
public XMSSPublicKeyParameters	Returns: XMSS public key. exportPublicKey() References Deprecated `XMSSPublicKeyParameters` is deprecated or references (maybe indirectly) at least one deprecated element. Export XMSS public key.
public void	generateKeys() Generate a new XMSS private key / public key pair.
public int	Returns: Index. getIndex() Getter XMSS index.
public XMSSParameters	Returns: XMSS params. getParams() Getter XMSS params.
public XMSSPrivateKeyParameters	getPrivateKey() References Deprecated `XMSSPrivateKeyParameters` is deprecated or references (maybe indirectly) at least one deprecated element.
public byte[]	Returns: Public seed. getPublicSeed() Getter XMSS public seed.
public byte[]	Returns: Root of binary tree. getRoot() Getter XMSS root.
protected WOTSPlus	Returns: WOTS+ instance. getWOTSPlus() Getter WOTS+.
public void	importState(XMSSPrivateKeyParameters privateKey, XMSSPublicKeyParameters publicKey) References Deprecated `XMSSPrivateKeyParameters` and `XMSSPublicKeyParameters` are deprecated or reference (maybe indirectly) at least one deprecated element.
public void	importState(byte[] XMSS private key. privateKey, byte[] XMSS public key. publicKey) Import XMSS private key / public key pair.
protected void	setIndex(int index)
protected void	setPublicSeed(byte[] publicSeed)
protected void	setRoot(byte[] root)
public byte[]	Returns: XMSS signature on digest of message. sign(byte[] Message to sign. message) Sign message.
public boolean	Returns: true if signature is valid false else. verifySignature(byte[] Message. message, byte[] XMSS signature. signature, byte[] XMSS public key. publicKey) Verify an XMSS signature.
protected WOTSPlusSignature	Returns: XMSS signature. wotsSign(byte[] Message digest of length n. messageDigest, OTSHashAddress OTS hash address. otsHashAddress) Generate a WOTS+ signature on a message without the corresponding authentication path

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

params	back to summary
private final XMSSParameters params XMSS parameters.

privateKey	back to summary
private XMSSPrivateKeyParameters privateKey References Deprecated `XMSSPrivateKeyParameters` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. XMSS private key.

prng	back to summary
private SecureRandom prng PRNG.

publicKey	back to summary
private XMSSPublicKeyParameters publicKey References Deprecated `XMSSPublicKeyParameters` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. XMSS public key.

wotsPlus	back to summary
private WOTSPlus wotsPlus WOTS+ instance.

Constructor Detail

XMSS	back to summary
public XMSS(XMSSParameters params, SecureRandom prng) XMSS constructor... Parameters params:XMSSParameters XMSSParameters.

XMSS

back to summary

public XMSS(XMSSParameters params, SecureRandom prng)

XMSS constructor...

Parameters

params:XMSSParameters: XMSSParameters.

Method Detail

exportPrivateKey back to summary

exportPrivateKey	back to summary
public XMSSPrivateKeyParameters exportPrivateKey() References Deprecated `XMSSPrivateKeyParameters` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Export XMSS private key. Returns:XMSSPrivateKeyParameters XMSS private key.

public XMSSPrivateKeyParameters exportPrivateKey()

References Deprecated

XMSSPrivateKeyParameters is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Export XMSS private key.

Returns:XMSSPrivateKeyParameters: XMSS private key.

exportPublicKey back to summary

exportPublicKey	back to summary
public XMSSPublicKeyParameters exportPublicKey() References Deprecated `XMSSPublicKeyParameters` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Export XMSS public key. Returns:XMSSPublicKeyParameters XMSS public key.

public XMSSPublicKeyParameters exportPublicKey()

References Deprecated

XMSSPublicKeyParameters is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Export XMSS public key.

Returns:XMSSPublicKeyParameters: XMSS public key.

generateKeys	back to summary
public void generateKeys() Generate a new XMSS private key / public key pair.

getIndex	back to summary
public int getIndex() Getter XMSS index. Returns:int Index.

getIndex

back to summary

public int getIndex()

Getter XMSS index.

Returns:int: Index.

getParams	back to summary
public XMSSParameters getParams() Getter XMSS params. Returns:XMSSParameters XMSS params.

getParams

back to summary

public XMSSParameters getParams()

Getter XMSS params.

Returns:XMSSParameters: XMSS params.

getPrivateKey	back to summary
public XMSSPrivateKeyParameters getPrivateKey() References Deprecated `XMSSPrivateKeyParameters` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

getPublicSeed	back to summary
public byte[] getPublicSeed() Getter XMSS public seed. Returns:byte[] Public seed.

getPublicSeed

back to summary

public byte[] getPublicSeed()

Getter XMSS public seed.

Returns:byte[]: Public seed.

getRoot	back to summary
public byte[] getRoot() Getter XMSS root. Returns:byte[] Root of binary tree.

getRoot

back to summary

public byte[] getRoot()

Getter XMSS root.

Returns:byte[]: Root of binary tree.

getWOTSPlus	back to summary
protected WOTSPlus getWOTSPlus() Getter WOTS+. Returns:WOTSPlus WOTS+ instance.

getWOTSPlus

back to summary

protected WOTSPlus getWOTSPlus()

Getter WOTS+.

Returns:WOTSPlus: WOTS+ instance.

importState	back to summary
public void importState(XMSSPrivateKeyParameters privateKey, XMSSPublicKeyParameters publicKey) References Deprecated `XMSSPrivateKeyParameters` and `XMSSPublicKeyParameters` are deprecated or reference (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

importState	back to summary
public void importState(byte[] privateKey, byte[] publicKey) Import XMSS private key / public key pair. Parameters privateKey:byte[] XMSS private key. publicKey:byte[] XMSS public key.

importState

back to summary

public void importState(byte[] privateKey, byte[] publicKey)

Import XMSS private key / public key pair.

Parameters

privateKey:byte[]: XMSS private key.
publicKey:byte[]: XMSS public key.

setIndex	back to summary
protected void setIndex(int index)

setPublicSeed	back to summary
protected void setPublicSeed(byte[] publicSeed)

setRoot	back to summary
protected void setRoot(byte[] root)

sign	back to summary
public byte[] sign(byte[] message) Sign message. Parameters message:byte[] Message to sign. Returns:byte[] XMSS signature on digest of message.

sign

back to summary

public byte[] sign(byte[] message)

Sign message.

Parameters

message:byte[]: Message to sign.

Returns:byte[]

XMSS signature on digest of message.

verifySignature	back to summary
public boolean verifySignature(byte[] message, byte[] signature, byte[] publicKey) throws ParseException Verify an XMSS signature. Parameters message:byte[] Message. signature:byte[] XMSS signature. publicKey:byte[] XMSS public key. Returns:boolean true if signature is valid false else.

verifySignature

back to summary

public boolean verifySignature(byte[] message, byte[] signature, byte[] publicKey) throws ParseException

Verify an XMSS signature.

Parameters

message:byte[]: Message.
signature:byte[]: XMSS signature.
publicKey:byte[]: XMSS public key.

Returns:boolean

true if signature is valid false else.

wotsSign	back to summary
protected WOTSPlusSignature wotsSign(byte[] messageDigest, OTSHashAddress otsHashAddress) Generate a WOTS+ signature on a message without the corresponding authentication path Parameters messageDigest:byte[] Message digest of length n. otsHashAddress:OTSHashAddress OTS hash address. Returns:WOTSPlusSignature XMSS signature.

wotsSign

back to summary

protected WOTSPlusSignature wotsSign(byte[] messageDigest, OTSHashAddress otsHashAddress)

Generate a WOTS+ signature on a message without the corresponding authentication path

Parameters

messageDigest:byte[]: Message digest of length n.
otsHashAddress:OTSHashAddress: OTS hash address.

Returns:WOTSPlusSignature

XMSS signature.

public Class XMSS

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail