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
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. val pgpKeys: Option[Array[String]]
  2. def productElementNames: Iterator[String]
    Definition Classes
    Product
  3. val recoveryPgpKeys: Option[Array[String]]
  4. val recoveryShares: Option[Int]
  5. val recoveryThreshold: Option[Int]
  6. val rootTokenPgpKey: Option[String]
  7. val secretShares: Int
  8. val secretThreshold: Int
  9. val storedShares: Option[Int]