Packages

case class InitOptions(secretShares: Int = 5, secretThreshold: Int = 3, pgpKeys: Option[Array[String]] = None, rootTokenPgpKey: Option[String] = None, recoveryShares: Option[Int] = None, recoveryThreshold: Option[Int] = None, recoveryPgpKeys: Option[Array[String]] = None, storedShares: Option[Int] = None) extends Product with Serializable

secretShares

Specifies the number of shares to split the master key into.

secretThreshold

Specifies the number of shares required to reconstruct the master key. This must be less than or equal secretShares. If using Vault HSM with auto-unsealing, this value must be the same as secretShares.

pgpKeys

Specifies an array of PGP public keys used to encrypt the output unseal keys. Ordering is preserved. The keys must be base64-encoded from their original binary representation. The size of this array must be the same as secretShares.

rootTokenPgpKey

Specifies a PGP public key used to encrypt the initial root token. The key must be base64-encoded from its original binary representation.

recoveryShares

Specifies the number of shares to split the recovery key into.

recoveryThreshold

Specifies the number of shares required to reconstruct the recovery key. This must be less than or equal to recoveryShares.

recoveryPgpKeys

Specifies an array of PGP public keys used to encrypt the output recovery keys. Ordering is preserved. The keys must be base64-encoded from their original binary representation. The size of this array must be the same as recoveryShares.

storedShares

Specifies the number of shares that should be encrypted by the HSM and stored for auto-unsealing. Currently must be the same as secretShares.

Source
InitOptions.scala
Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InitOptions
  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 InitOptions(secretShares: Int = 5, secretThreshold: Int = 3, pgpKeys: Option[Array[String]] = None, rootTokenPgpKey: Option[String] = None, recoveryShares: Option[Int] = None, recoveryThreshold: Option[Int] = None, recoveryPgpKeys: Option[Array[String]] = None, storedShares: Option[Int] = None)

    secretShares

    Specifies the number of shares to split the master key into.

    secretThreshold

    Specifies the number of shares required to reconstruct the master key. This must be less than or equal secretShares. If using Vault HSM with auto-unsealing, this value must be the same as secretShares.

    pgpKeys

    Specifies an array of PGP public keys used to encrypt the output unseal keys. Ordering is preserved. The keys must be base64-encoded from their original binary representation. The size of this array must be the same as secretShares.

    rootTokenPgpKey

    Specifies a PGP public key used to encrypt the initial root token. The key must be base64-encoded from its original binary representation.

    recoveryShares

    Specifies the number of shares to split the recovery key into.

    recoveryThreshold

    Specifies the number of shares required to reconstruct the recovery key. This must be less than or equal to recoveryShares.

    recoveryPgpKeys

    Specifies an array of PGP public keys used to encrypt the output recovery keys. Ordering is preserved. The keys must be base64-encoded from their original binary representation. The size of this array must be the same as recoveryShares.

    storedShares

    Specifies the number of shares that should be encrypted by the HSM and stored for auto-unsealing. Currently must be the same as secretShares.

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): (InitOptions, B)
    Implicit
    This member is added by an implicit conversion from InitOptions toArrowAssoc[InitOptions] 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. def ensuring(cond: (InitOptions) => Boolean, msg: => Any): InitOptions
    Implicit
    This member is added by an implicit conversion from InitOptions toEnsuring[InitOptions] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  8. def ensuring(cond: (InitOptions) => Boolean): InitOptions
    Implicit
    This member is added by an implicit conversion from InitOptions toEnsuring[InitOptions] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: Boolean, msg: => Any): InitOptions
    Implicit
    This member is added by an implicit conversion from InitOptions toEnsuring[InitOptions] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean): InitOptions
    Implicit
    This member is added by an implicit conversion from InitOptions toEnsuring[InitOptions] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  13. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from InitOptions toStringFormat[InitOptions] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. val pgpKeys: Option[Array[String]]
  20. def productElementNames: Iterator[String]
    Definition Classes
    Product
  21. val recoveryPgpKeys: Option[Array[String]]
  22. val recoveryShares: Option[Int]
  23. val recoveryThreshold: Option[Int]
  24. val rootTokenPgpKey: Option[String]
  25. val secretShares: Int
  26. val secretThreshold: Int
  27. val storedShares: Option[Int]
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def →[B](y: B): (InitOptions, B)
    Implicit
    This member is added by an implicit conversion from InitOptions toArrowAssoc[InitOptions] 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 fromInitOptions to StringFormat[InitOptions]

Inherited by implicit conversion Ensuring fromInitOptions to Ensuring[InitOptions]

Inherited by implicit conversion ArrowAssoc fromInitOptions to ArrowAssoc[InitOptions]

Ungrouped