org.bouncycastle.crypto.params

Class XMSSMTParameters

java.lang.Object

org.bouncycastle.crypto.params.XMSSMTParameters

All Implemented Interfaces:

PQCParameters

public final class XMSSMTParameters
extends java.lang.Object
implements PQCParameters

XMSS^MT Parameters.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_HEIGHT The tallest hypertree whose leaves a long index can count.

Constructor Summary

Constructors

Constructor and Description
XMSSMTParameters(int height, int layers, ASN1ObjectIdentifier digestOID) XMSSMT constructor...
XMSSMTParameters(int height, int layers, ASN1ObjectIdentifier digestOID, int n) XMSSMT constructor with explicit security parameter n.
XMSSMTParameters(int height, int layers, Digest digest) XMSSMT constructor...

Method Summary

Modifier and Type	Method and Description
int	getClassicalSecurityStrength() Return the classical security strength of this parameter set, as for XMSSParameters.getClassicalSecurityStrength().
int	getHeight() Getter height.
int	getLayers() Getter layers.
int	getLen()
int	getParameterSetOID() Return the RFC 8391 / SP 800-208 parameter-set identifier for this parameter set (the 4-octet value carried at the start of an RFC 9802 encoded key), or 0 if these parameters do not correspond to a standard set (for example a non-standard tree height).
int	getSecurityCategory() Return the NIST security category of this parameter set, as for XMSSParameters.getSecurityCategory().
java.lang.String	getTreeDigest()
ASN1ObjectIdentifier	getTreeDigestOID() Return the tree digest OID.
int	getTreeDigestSize() Getter digest size.
int	getWinternitzParameter() Getter Winternitz parameter.
XMSSParameters	getXMSSParameters()
static XMSSMTParameters	lookupByOID(int oid)

Methods inherited from class java.lang.Object

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

Field Detail

MAX_HEIGHT

public static final int MAX_HEIGHT

The tallest hypertree whose leaves a long index can count. The per layer trees are bounded separately, and more tightly, by XMSSParameters.MAX_HEIGHT.

See Also:

Constant Field Values

Constructor Detail

XMSSMTParameters

public XMSSMTParameters(int height,
                        int layers,
                        Digest digest)

XMSSMT constructor...

Parameters:

height - Height of tree.

layers - Amount of layers.

digest - Digest to use.

XMSSMTParameters

public XMSSMTParameters(int height,
                        int layers,
                        ASN1ObjectIdentifier digestOID)

XMSSMT constructor...

Parameters:

height - Height of tree.

layers - Amount of layers.

digestOID - Object identifier of digest to use.

XMSSMTParameters

public XMSSMTParameters(int height,
                        int layers,
                        ASN1ObjectIdentifier digestOID,
                        int n)

XMSSMT constructor with explicit security parameter n.

Parameters:

height - Height of tree.

layers - Amount of layers.

digestOID - Object identifier of digest to use.

n - Security parameter (digest output size in bytes), or -1 to derive from digest.

Method Detail

getHeight

public int getHeight()

Getter height.

Returns:

XMSSMT height.

getLayers

public int getLayers()

Getter layers.

Returns:

XMSSMT layers.

getXMSSParameters

public XMSSParameters getXMSSParameters()

getTreeDigest

public java.lang.String getTreeDigest()

getTreeDigestSize

public int getTreeDigestSize()

Getter digest size.

Returns:

Digest size.

getSecurityCategory

public int getSecurityCategory()

Return the NIST security category of this parameter set, as for XMSSParameters.getSecurityCategory().

Specified by:

getSecurityCategory in interface PQCParameters

Returns:

the security category, as given in NIST IR 8547 Tables 3 and 5.

getClassicalSecurityStrength

public int getClassicalSecurityStrength()

Return the classical security strength of this parameter set, as for XMSSParameters.getClassicalSecurityStrength().

Specified by:

getClassicalSecurityStrength in interface PQCParameters

Returns:

the classical security strength in bits.

getTreeDigestOID

public ASN1ObjectIdentifier getTreeDigestOID()

Return the tree digest OID.

Returns:

OID for digest used to build the tree.

getParameterSetOID

public int getParameterSetOID()

Return the RFC 8391 / SP 800-208 parameter-set identifier for this parameter set (the 4-octet value carried at the start of an RFC 9802 encoded key), or 0 if these parameters do not correspond to a standard set (for example a non-standard tree height).

Returns:

the 4-octet parameter-set identifier, or 0 if none.

getWinternitzParameter

public int getWinternitzParameter()

Getter Winternitz parameter.

Returns:

Winternitz parameter.

getLen

public int getLen()

lookupByOID

public static XMSSMTParameters lookupByOID(int oid)