Package org.bouncycastle.pqc.asn1

Class XMSSPrivateKey

java.lang.Object

org.bouncycastle.asn1.ASN1Object

org.bouncycastle.pqc.asn1.XMSSPrivateKey

All Implemented Interfaces:

ASN1Encodable, Encodable

public class XMSSPrivateKey
extends ASN1Object

XMMSPrivateKey

     XMMSPrivateKey ::= SEQUENCE {
         version INTEGER -- 0, or 1 if maxIndex is present
         keyData SEQUENCE {
            index         INTEGER
            secretKeySeed OCTET STRING
            secretKeyPRF  OCTET STRING
            publicSeed    OCTET STRING
            root          OCTET STRING
            maxIndex      [0] INTEGER OPTIONAL
         }
         bdsState CHOICE {
             legacyBdsState [0] OCTET STRING,
             binaryBdsState [1] OCTET STRING
         } OPTIONAL
             -- opaque, implementation-specific traversal state. [0] carries the
             -- legacy Java serialization, [1] the versioned binary BDS state.
    }
 

Constructor Summary

Constructors

Constructor	Description
XMSSPrivateKey(int index, byte[] secretKeySeed, byte[] secretKeyPRF, byte[] publicSeed, byte[] root, byte[] bdsState)	Base constructor. bdsState is written in the binary [1] alternative; the legacy Java serialization is accepted on parsing but is no longer generated.
XMSSPrivateKey(int index, byte[] secretKeySeed, byte[] secretKeyPRF, byte[] publicSeed, byte[] root, byte[] bdsState, int maxIndex)	Base constructor for a key carrying maxIndex. bdsState is written in the binary [1] alternative; the legacy Java serialization is accepted on parsing but is no longer generated.

Method Summary

Modifier and Type	Method	Description
byte[]	getBdsState()
int	getIndex()
static XMSSPrivateKey	getInstance(java.lang.Object o)
int	getMaxIndex()
byte[]	getPublicSeed()
byte[]	getRoot()
byte[]	getSecretKeyPRF()
byte[]	getSecretKeySeed()
int	getVersion()
boolean	hasBinaryBdsState()	Return true if bdsState was carried in the versioned binary BDS state alternative ([1]), false if it was carried in the legacy Java serialization alternative ([0]).
ASN1Primitive	toASN1Primitive()	Method providing a primitive representation of this object suitable for encoding.

Methods inherited from class org.bouncycastle.asn1.ASN1Object

encodeTo, encodeTo, equals, getEncoded, getEncoded, hasEncodedTagValue, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

XMSSPrivateKey

public XMSSPrivateKey(int index,
                      byte[] secretKeySeed,
                      byte[] secretKeyPRF,
                      byte[] publicSeed,
                      byte[] root,
                      byte[] bdsState)

Base constructor. bdsState is written in the binary [1] alternative; the legacy Java serialization is accepted on parsing but is no longer generated.

XMSSPrivateKey

public XMSSPrivateKey(int index,
                      byte[] secretKeySeed,
                      byte[] secretKeyPRF,
                      byte[] publicSeed,
                      byte[] root,
                      byte[] bdsState,
                      int maxIndex)

Base constructor for a key carrying maxIndex. bdsState is written in the binary [1] alternative; the legacy Java serialization is accepted on parsing but is no longer generated.

Method Detail

getInstance

public static XMSSPrivateKey getInstance(java.lang.Object o)

getVersion

public int getVersion()

getIndex

public int getIndex()

getMaxIndex

public int getMaxIndex()

getSecretKeySeed

public byte[] getSecretKeySeed()

getSecretKeyPRF

public byte[] getSecretKeyPRF()

getPublicSeed

public byte[] getPublicSeed()

getRoot

public byte[] getRoot()

getBdsState

public byte[] getBdsState()

hasBinaryBdsState

public boolean hasBinaryBdsState()

Return true if bdsState was carried in the versioned binary BDS state alternative ([1]), false if it was carried in the legacy Java serialization alternative ([0]).

toASN1Primitive

public ASN1Primitive toASN1Primitive()

Description copied from class: ASN1Object

Method providing a primitive representation of this object suitable for encoding.

Specified by:

toASN1Primitive in interface ASN1Encodable

Specified by:

toASN1Primitive in class ASN1Object

Returns:

a primitive representation of this object.