Packages

case class RootGenerationProgress(started: Boolean, nonce: String, progress: Int, required: Int, complete: Boolean, encodedToken: String, encodedRootToken: String, pgpFingerprint: String, otp: String, otpLength: Int) extends Product with Serializable

started

whether a root generation attempt has been started.

nonce

the nonce for the current attempt.

progress

how many unseal keys have been provided for this generation attempt.

required

how many unseal keys must be provided to complete the generation attempt.

complete

whether the attempt is complete.

encodedToken

the encoded token. The token will either be encrypted using PGP or XOR'd using the OTP.

encodedRootToken

the encoded root token. The token will either be encrypted using PGP or XOR'd using the OTP.

pgpFingerprint

the PGP fingerprint used to encrypt the final root token. This will be an empty string unless a PGP key is being used to encrypt the final root token.

otp

the one-time-password (OTP) being used to encode the final root token. The OTP is a base64 string, with length of otpLength. The raw bytes (char codes) of the token will be XOR'd with this value before being returned as a response to the final unseal key, encoded as base64. This field will only be returned once, on the response to the start request.

otpLength

the size of the OTP.

Source
RootGenerationProgress.scala
Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RootGenerationProgress
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
Implicitly
  1. by StringFormat
  2. by Ensuring
  3. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new RootGenerationProgress(started: Boolean, nonce: String, progress: Int, required: Int, complete: Boolean, encodedToken: String, encodedRootToken: String, pgpFingerprint: String, otp: String, otpLength: Int)

    started

    whether a root generation attempt has been started.

    nonce

    the nonce for the current attempt.

    progress

    how many unseal keys have been provided for this generation attempt.

    required

    how many unseal keys must be provided to complete the generation attempt.

    complete

    whether the attempt is complete.

    encodedToken

    the encoded token. The token will either be encrypted using PGP or XOR'd using the OTP.

    encodedRootToken

    the encoded root token. The token will either be encrypted using PGP or XOR'd using the OTP.

    pgpFingerprint

    the PGP fingerprint used to encrypt the final root token. This will be an empty string unless a PGP key is being used to encrypt the final root token.

    otp

    the one-time-password (OTP) being used to encode the final root token. The OTP is a base64 string, with length of otpLength. The raw bytes (char codes) of the token will be XOR'd with this value before being returned as a response to the final unseal key, encoded as base64. This field will only be returned once, on the response to the start request.

    otpLength

    the size of the OTP.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def ->[B](y: B): (RootGenerationProgress, B)
    Implicit
    This member is added by an implicit conversion from RootGenerationProgress toArrowAssoc[RootGenerationProgress] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. val complete: Boolean
  8. def decode(otp: String = this.otp): Option[String]

    Decode the encodedRootToken of this RootGenerationProgress using the provided otp.

    Decode the encodedRootToken of this RootGenerationProgress using the provided otp. If a PGP key was passed at the start of the root generation attempt, this method will do nothing.

    returns

    the decoded root token. If encodedRootToken or otp are empty this method will return a None.

  9. val encodedRootToken: String
  10. val encodedToken: String
  11. def ensuring(cond: (RootGenerationProgress) => Boolean, msg: => Any): RootGenerationProgress
    Implicit
    This member is added by an implicit conversion from RootGenerationProgress toEnsuring[RootGenerationProgress] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (RootGenerationProgress) => Boolean): RootGenerationProgress
    Implicit
    This member is added by an implicit conversion from RootGenerationProgress toEnsuring[RootGenerationProgress] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: => Any): RootGenerationProgress
    Implicit
    This member is added by an implicit conversion from RootGenerationProgress toEnsuring[RootGenerationProgress] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): RootGenerationProgress
    Implicit
    This member is added by an implicit conversion from RootGenerationProgress toEnsuring[RootGenerationProgress] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  17. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from RootGenerationProgress toStringFormat[RootGenerationProgress] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def inProgress: Boolean

    Whether this root generation is in progress.

  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. val nonce: String
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. val otp: String
  26. val otpLength: Int
  27. val pgpFingerprint: String
  28. def productElementNames: Iterator[String]
    Definition Classes
    Product
  29. val progress: Int
  30. val required: Int
  31. val started: Boolean
  32. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def →[B](y: B): (RootGenerationProgress, B)
    Implicit
    This member is added by an implicit conversion from RootGenerationProgress toArrowAssoc[RootGenerationProgress] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringFormat fromRootGenerationProgress to StringFormat[RootGenerationProgress]

Inherited by implicit conversion Ensuring fromRootGenerationProgress to Ensuring[RootGenerationProgress]

Inherited by implicit conversion ArrowAssoc fromRootGenerationProgress to ArrowAssoc[RootGenerationProgress]

Ungrouped