XMSSPrivateKey (Bouncy Castle Library 1.85 API Specification)
Date: 2026-07-12

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 {
                  platformSerialization [0] OCTET STRING
               } OPTIONAL
          }

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `XMSSPrivateKey(int index, byte[] secretKeySeed, byte[] secretKeyPRF, byte[] publicSeed, byte[] root, byte[] bdsState)`
    `XMSSPrivateKey(int index, byte[] secretKeySeed, byte[] secretKeyPRF, byte[] publicSeed, byte[] root, byte[] bdsState, int maxIndex)`

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `byte[]` | `getBdsState()`
    `int` | `getIndex()`
    `static XMSSPrivateKey` | `getInstance(java.lang.Object o)`
    `int` | `getMaxIndex()`
    `byte[]` | `getPublicSeed()`
    `byte[]` | `getRoot()`
    `byte[]` | `getSecretKeyPRF()`
    `byte[]` | `getSecretKeySeed()`
    `int` | `getVersion()`
    `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)

    - #### XMSSPrivateKey

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

  - ### 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()

    - #### 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.