Module io.github.tonywasher.joceanus.gordianknot

Package io.github.tonywasher.joceanus.gordianknot.api.keypair

Class GordianXMSSKeySpec

java.lang.Object

io.github.tonywasher.joceanus.gordianknot.api.keypair.GordianXMSSKeySpec

public class GordianXMSSKeySpec
extends Object

XMSS KeySpec.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GordianXMSSKeySpec.GordianXMSSDigestType	XMSS digestType.
static enum	GordianXMSSKeySpec.GordianXMSSHeight	XMSS Height.
static enum	GordianXMSSKeySpec.GordianXMSSKeyType	XMSS keyTypes.
static enum	GordianXMSSKeySpec.GordianXMSSMTLayers	XMSSMT Layers.

Constructor Summary

Constructors

Constructor	Description
GordianXMSSKeySpec(GordianXMSSKeySpec.GordianXMSSDigestType pDigestType, GordianXMSSKeySpec.GordianXMSSHeight pHeight)	Constructor.
GordianXMSSKeySpec(GordianXMSSKeySpec.GordianXMSSDigestType pDigestType, GordianXMSSKeySpec.GordianXMSSHeight pHeight, GordianXMSSKeySpec.GordianXMSSMTLayers pLayers)	Constructor.
GordianXMSSKeySpec(GordianXMSSKeySpec.GordianXMSSKeyType pKeyType, GordianXMSSKeySpec.GordianXMSSDigestType pDigestType, GordianXMSSKeySpec.GordianXMSSHeight pHeight, GordianXMSSKeySpec.GordianXMSSMTLayers pLayers)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object pThat)
GordianXMSSKeySpec.GordianXMSSDigestType	getDigestType()	Obtain the digestType.
GordianXMSSKeySpec.GordianXMSSHeight	getHeight()	Obtain the height.
GordianXMSSKeySpec.GordianXMSSKeyType	getKeyType()	Obtain the keyType.
GordianXMSSKeySpec.GordianXMSSMTLayers	getLayers()	Obtain the layers.
int	hashCode()
boolean	isHigh()	Is the keySpec high (height > 15)?
boolean	isMT()	Is this key MT?
boolean	isValid()	Is the keySpec valid?
static List<GordianXMSSKeySpec>	listPossibleKeySpecs()	Obtain a list of all possible specs.
static List<GordianXMSSKeySpec>	listPossibleKeySpecs(GordianXMSSKeySpec.GordianXMSSDigestType pDigestType)	Obtain a list of all possible specs.
String	toString()
static GordianXMSSKeySpec	xmss(GordianXMSSKeySpec.GordianXMSSDigestType pDigestType, GordianXMSSKeySpec.GordianXMSSHeight pHeight)	Create XMSS keySpec.
static GordianXMSSKeySpec	xmssmt(GordianXMSSKeySpec.GordianXMSSDigestType pDigestType, GordianXMSSKeySpec.GordianXMSSHeight pHeight, GordianXMSSKeySpec.GordianXMSSMTLayers pLayers)	Create XMSS keySpec.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

GordianXMSSKeySpec

public GordianXMSSKeySpec(GordianXMSSKeySpec.GordianXMSSDigestType pDigestType,
 GordianXMSSKeySpec.GordianXMSSHeight pHeight)

Constructor.

Parameters:

pDigestType - the digestType

pHeight - the height

GordianXMSSKeySpec

public GordianXMSSKeySpec(GordianXMSSKeySpec.GordianXMSSDigestType pDigestType,
 GordianXMSSKeySpec.GordianXMSSHeight pHeight,
 GordianXMSSKeySpec.GordianXMSSMTLayers pLayers)

Constructor.

Parameters:

pDigestType - the digestType

pHeight - the height

pLayers - the layers

GordianXMSSKeySpec

public GordianXMSSKeySpec(GordianXMSSKeySpec.GordianXMSSKeyType pKeyType,
 GordianXMSSKeySpec.GordianXMSSDigestType pDigestType,
 GordianXMSSKeySpec.GordianXMSSHeight pHeight,
 GordianXMSSKeySpec.GordianXMSSMTLayers pLayers)

Constructor.

Parameters:

pKeyType - the keyType

pDigestType - the digestType

pHeight - the height

pLayers - the layers

Method Details

isMT

public boolean isMT()

Is this key MT?

Returns:

true/false

getKeyType

public GordianXMSSKeySpec.GordianXMSSKeyType getKeyType()

Obtain the keyType.

Returns:

the keyType

getDigestType

public GordianXMSSKeySpec.GordianXMSSDigestType getDigestType()

Obtain the digestType.

Returns:

the digestType

getHeight

public GordianXMSSKeySpec.GordianXMSSHeight getHeight()

Obtain the height.

Returns:

the height

getLayers

public GordianXMSSKeySpec.GordianXMSSMTLayers getLayers()

Obtain the layers.

Returns:

the layers

isValid

public boolean isValid()

Is the keySpec valid?

Returns:

true/false.

isHigh

public boolean isHigh()

Is the keySpec high (height > 15)?

Returns:

true/false.

xmss

public static GordianXMSSKeySpec xmss(GordianXMSSKeySpec.GordianXMSSDigestType pDigestType,
 GordianXMSSKeySpec.GordianXMSSHeight pHeight)

Create XMSS keySpec.

Parameters:

pDigestType - the digestType

pHeight - the height

Returns:

the keySpec

xmssmt

public static GordianXMSSKeySpec xmssmt(GordianXMSSKeySpec.GordianXMSSDigestType pDigestType,
 GordianXMSSKeySpec.GordianXMSSHeight pHeight,
 GordianXMSSKeySpec.GordianXMSSMTLayers pLayers)

Create XMSS keySpec.

Parameters:

pDigestType - the digestType

pHeight - the height

pLayers - the layers

Returns:

the keySpec

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object pThat)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

listPossibleKeySpecs

public static List<GordianXMSSKeySpec> listPossibleKeySpecs()

Obtain a list of all possible specs.

Returns:

the list

listPossibleKeySpecs

public static List<GordianXMSSKeySpec> listPossibleKeySpecs(GordianXMSSKeySpec.GordianXMSSDigestType pDigestType)

Obtain a list of all possible specs.

Parameters:

pDigestType - the digestType

Returns:

the list