Packages

c

pt.tecnico.dsi.vault.sys

GenerateRoot

final class GenerateRoot[F[_]] extends AnyRef

Source
GenerateRoot.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GenerateRoot
  2. AnyRef
  3. 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 GenerateRoot(path: String, uri: Uri)(implicit arg0: Concurrent[F], arg1: Client[F])

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): (GenerateRoot[F], B)
    Implicit
    This member is added by an implicit conversion from GenerateRoot[F] toArrowAssoc[GenerateRoot[F]] 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. val cancel: F[Unit]

    Cancels any in-progress root generation attempt.

    Cancels any in-progress root generation attempt. This clears any progress made. This must be called to change the OTP or PGP key being used.

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def ensuring(cond: (GenerateRoot[F]) => Boolean, msg: => Any): GenerateRoot[F]
    Implicit
    This member is added by an implicit conversion from GenerateRoot[F] toEnsuring[GenerateRoot[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (GenerateRoot[F]) => Boolean): GenerateRoot[F]
    Implicit
    This member is added by an implicit conversion from GenerateRoot[F] toEnsuring[GenerateRoot[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): GenerateRoot[F]
    Implicit
    This member is added by an implicit conversion from GenerateRoot[F] toEnsuring[GenerateRoot[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): GenerateRoot[F]
    Implicit
    This member is added by an implicit conversion from GenerateRoot[F] toEnsuring[GenerateRoot[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from GenerateRoot[F] toStringFormat[GenerateRoot[F]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. val path: String
  22. val progress: F[RootGenerationProgress]

    returns

    the configuration and progress of the current root generation attempt.

  23. def put(keyShare: String, nonce: String): F[RootGenerationProgress]

    This endpoint is used to enter a single master key share to progress the root generation attempt.

    This endpoint is used to enter a single master key share to progress the root generation attempt. If the threshold number of master key shares is reached, Vault will complete the root generation and issue the new token. Otherwise, this API must be called multiple times until that threshold is met. The attempt nonce must be provided with each call.

    keyShare

    Specifies a single master key share.

    nonce

    Specifies the nonce of the attempt.

  24. def start(pgpKey: Option[String] = None): F[RootGenerationProgress]

    Start a new root generation attempt.

    Start a new root generation attempt. Only a single root generation attempt can take place at a time.

    pgpKey

    Specifies a base64-encoded PGP public key. The raw bytes of the token will be encrypted with this value before being returned to the final unseal key provider.

    returns

    the configuration and progress of the current root generation attempt.

  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. val uri: Uri
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def [B](y: B): (GenerateRoot[F], B)
    Implicit
    This member is added by an implicit conversion from GenerateRoot[F] toArrowAssoc[GenerateRoot[F]] 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 AnyRef

Inherited from Any

Inherited by implicit conversion StringFormat fromGenerateRoot[F] to StringFormat[GenerateRoot[F]]

Inherited by implicit conversion Ensuring fromGenerateRoot[F] to Ensuring[GenerateRoot[F]]

Inherited by implicit conversion ArrowAssoc fromGenerateRoot[F] to ArrowAssoc[GenerateRoot[F]]

Ungrouped