org.bouncycastle.pqc.crypto.xmss

Class XMSS

java.lang.Object

org.bouncycastle.pqc.crypto.xmss.XMSS

public class XMSS
extends java.lang.Object

XMSS.

Constructor Summary

Constructors

Constructor and Description
XMSS(XMSSParameters params) XMSS constructor...

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	exportPrivateKey() Export XMSS private key.
byte[]	exportPublicKey() Export XMSS public key.
void	generateKeys() Generate a new XMSS private key / public key pair.
protected BDS	getBDSState()
int	getIndex() Getter XMSS index.
protected KeyedHashFunctions	getKhf()
XMSSParameters	getParams() Getter XMSS params.
byte[]	getPublicSeed() Getter XMSS public seed.
byte[]	getRoot() Getter XMSS root.
protected XMSSNode	getRootNodeFromSignature(byte[] messageDigest, XMSSReducedSignature signature, OTSHashAddress otsHashAddress) Compute a root node from a tree signature.
protected WOTSPlus	getWOTSPlus() Getter WOTS+.
protected byte[]	getWOTSPlusSecretKey(OTSHashAddress otsHashAddress) Derive WOTS+ secret key for specific index as in XMSS ref impl Andreas Huelsing.
void	importState(byte[] privateKey, byte[] publicKey) Import XMSS private key / public key pair.
protected XMSSNode	lTree(WOTSPlusPublicKeyParameters publicKey, LTreeAddress address) Compresses a WOTS+ public key to a single n-byte string.
protected XMSSNode	randomizeHash(XMSSNode left, XMSSNode right, XMSSAddress address) Randomization of nodes in binary tree.
protected void	setIndex(int index)
protected void	setPublicSeed(byte[] publicSeed)
protected void	setRoot(byte[] root)
byte[]	sign(byte[] message) Sign message.
boolean	verifySignature(byte[] message, byte[] signature, byte[] publicKey) Verify an XMSS signature.
protected WOTSPlusSignature	wotsSign(byte[] messageDigest, OTSHashAddress otsHashAddress) Generate a WOTS+ signature on a message without the corresponding authentication path

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XMSS

public XMSS(XMSSParameters params)

XMSS constructor...

Parameters:

params - XMSSParameters.

Method Detail

generateKeys

public void generateKeys()

Generate a new XMSS private key / public key pair.

importState

public void importState(byte[] privateKey,
               byte[] publicKey)
                 throws java.text.ParseException,
                        java.lang.ClassNotFoundException,
                        java.io.IOException

Import XMSS private key / public key pair.

Parameters:

privateKey - XMSS private key.

publicKey - XMSS public key.

Throws:

java.text.ParseException

java.lang.ClassNotFoundException

java.io.IOException

sign

public byte[] sign(byte[] message)

Sign message.

Parameters:

message - Message to sign.

Returns:

XMSS signature on digest of message.

verifySignature

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

Verify an XMSS signature.

Parameters:

message - Message.

signature - XMSS signature.

publicKey - XMSS public key.

Returns:

true if signature is valid false else.

Throws:

java.text.ParseException

exportPrivateKey

public byte[] exportPrivateKey()

Export XMSS private key.

Returns:

XMSS private key.

exportPublicKey

public byte[] exportPublicKey()

Export XMSS public key.

Returns:

XMSS public key.

randomizeHash

protected XMSSNode randomizeHash(XMSSNode left,
                     XMSSNode right,
                     XMSSAddress address)

Randomization of nodes in binary tree.

Parameters:

left - Left node.

right - Right node.

address - Address.

Returns:

Randomized hash of parent of left / right node.

lTree

protected XMSSNode lTree(WOTSPlusPublicKeyParameters publicKey,
             LTreeAddress address)

Compresses a WOTS+ public key to a single n-byte string.

Parameters:

publicKey - WOTS+ public key to compress.

address - Address.

Returns:

Compressed n-byte string of public key.

wotsSign

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

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

Parameters:

messageDigest - Message digest of length n.

otsHashAddress - OTS hash address.

Returns:

XMSS signature.

getRootNodeFromSignature

protected XMSSNode getRootNodeFromSignature(byte[] messageDigest,
                                XMSSReducedSignature signature,
                                OTSHashAddress otsHashAddress)

Compute a root node from a tree signature.

Parameters:

messageDigest - Message digest.

signature - XMSS signature.

Returns:

Root node calculated from signature.

getWOTSPlusSecretKey

protected byte[] getWOTSPlusSecretKey(OTSHashAddress otsHashAddress)

Derive WOTS+ secret key for specific index as in XMSS ref impl Andreas Huelsing.

Parameters:

otsHashAddress -

Returns:

WOTS+ secret key at index.

getParams

public XMSSParameters getParams()

Getter XMSS params.

Returns:

XMSS params.

getWOTSPlus

protected WOTSPlus getWOTSPlus()

Getter WOTS+.

Returns:

WOTS+ instance.

getKhf

protected KeyedHashFunctions getKhf()

getRoot

public byte[] getRoot()

Getter XMSS root.

Returns:

Root of binary tree.

setRoot

protected void setRoot(byte[] root)

getIndex

public int getIndex()

Getter XMSS index.

Returns:

Index.

setIndex

protected void setIndex(int index)

getPublicSeed

public byte[] getPublicSeed()

Getter XMSS public seed.

Returns:

Public seed.

setPublicSeed

protected void setPublicSeed(byte[] publicSeed)

getBDSState

protected BDS getBDSState()