Vault

Type Members

final case class InvalidRequirement(message: String) extends Throwable with Product with Serializable
final case class NonRenewableSecret(leaseId: String) extends Throwable with Product with Serializable
final case class NonRenewableToken(leaseId: String) extends Throwable with Product with Serializable

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def generateCertificate[F[_]](client: Client[F], vaultUri: Uri)(token: String, secretPath: String, payload: CertificateRequest)(implicit F: Sync[F]): F[VaultSecret[CertificateData]]

https://www.vaultproject.io/api/secret/pki/index.html#generate-certificate
def generateSecret[F[_], A, B](client: Client[F], vaultUri: Uri)(token: String, secretPath: String, payload: A)(implicit arg0: Encoder[A], arg1: Decoder[B], F: Sync[F]): F[VaultSecret[B]]
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def keepLoginAndSecretLeased[F[_], A](client: Client[F], vaultUri: Uri)(token: VaultToken, secretPath: String, duration: FiniteDuration, waitInterval: FiniteDuration)(implicit arg0: Concurrent[F], arg1: Decoder[A], T: Timer[F]): Stream[F, A]

This function logs in, requests a secret and then continually asks for a duration extension of the lease after each waitInterval
def keepLoginRenewed[F[_]](client: Client[F], vaultUri: Uri)(token: VaultToken, tokenLeaseExtension: FiniteDuration)(implicit arg0: Concurrent[F], T: Timer[F]): Stream[F, String]

This function logs into the Vault server given by the vaultUri, to obtain a loginToken.
This function logs into the Vault server given by the vaultUri, to obtain a loginToken. It then also provides a Stream that continuously renews the token when it is about to finish.
- keeps the token constantly renewed
- Upon termination of the Stream (from the using application) revokes the token.
def kubernetesLogin[F[_]](client: Client[F], vaultUri: Uri)(role: String, jwt: String)(implicit F: Sync[F]): F[VaultToken]

https://www.vaultproject.io/api/auth/kubernetes/index.html#login
def login[F[_]](client: Client[F], vaultUri: Uri)(roleId: String)(implicit F: Sync[F]): F[VaultToken]

https://www.vaultproject.io/api/auth/approle/index.html#login-with-approle
def loginAndKeep[F[_]](client: Client[F], vaultUri: Uri)(roleId: String, tokenLeaseExtension: FiniteDuration)(implicit arg0: Concurrent[F], T: Timer[F]): Stream[F, String]
def loginAndKeepSecretLeased[F[_], A](client: Client[F], vaultUri: Uri)(roleId: String, secretPath: String, duration: FiniteDuration, waitInterval: FiniteDuration)(implicit arg0: Concurrent[F], arg1: Decoder[A], T: Timer[F]): Stream[F, A]
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
def readSecret[F[_], A](client: Client[F], vaultUri: Uri)(token: String, secretPath: String)(implicit F: Sync[F], D: Decoder[A]): F[VaultSecret[A]]

https://www.vaultproject.io/api/secret/kv/index.html#read-secret
def readSecretAndRetain[F[_], A](client: Client[F], vaultUri: Uri, clientToken: String)(secretPath: String, leaseExtension: FiniteDuration)(implicit arg0: Concurrent[F], arg1: Decoder[A], T: Timer[F]): Stream[F, A]
def renewLease[F[_]](client: Client[F], vaultUri: Uri)(leaseId: String, newLeaseDuration: FiniteDuration, token: String)(implicit F: Sync[F]): F[VaultSecretRenewal]

https://www.vaultproject.io/api/system/leases.html#renew-lease
def renewSelfToken[F[_]](client: Client[F], vaultUri: Uri)(token: VaultToken, newLeaseDuration: FiniteDuration)(implicit F: Sync[F]): F[VaultToken]

https://www.vaultproject.io/api/auth/token/index.html#renew-a-token-self-
def revokeLease[F[_]](client: Client[F], vaultUri: Uri)(clientToken: String, leaseId: String)(implicit F: Sync[F]): F[Unit]

https://www.vaultproject.io/api/system/leases.html#revoke-lease
def revokeSelfToken[F[_]](client: Client[F], vaultUri: Uri)(token: VaultToken)(implicit F: Sync[F]): F[Unit]

https://www.vaultproject.io/api/auth/token/index.html#revoke-a-token-self-
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Related Doc: package vault

object Vault

Type Members

final case class InvalidRequirement(message: String) extends Throwable with Product with Serializable

final case class NonRenewableSecret(leaseId: String) extends Throwable with Product with Serializable

final case class NonRenewableToken(leaseId: String) extends Throwable with Product with Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def generateCertificate[F[_]](client: Client[F], vaultUri: Uri)(token: String, secretPath: String, payload: CertificateRequest)(implicit F: Sync[F]): F[VaultSecret[CertificateData]]

def generateSecret[F[_], A, B](client: Client[F], vaultUri: Uri)(token: String, secretPath: String, payload: A)(implicit arg0: Encoder[A], arg1: Decoder[B], F: Sync[F]): F[VaultSecret[B]]

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def keepLoginAndSecretLeased[F[_], A](client: Client[F], vaultUri: Uri)(token: VaultToken, secretPath: String, duration: FiniteDuration, waitInterval: FiniteDuration)(implicit arg0: Concurrent[F], arg1: Decoder[A], T: Timer[F]): Stream[F, A]

def keepLoginRenewed[F[_]](client: Client[F], vaultUri: Uri)(token: VaultToken, tokenLeaseExtension: FiniteDuration)(implicit arg0: Concurrent[F], T: Timer[F]): Stream[F, String]

def kubernetesLogin[F[_]](client: Client[F], vaultUri: Uri)(role: String, jwt: String)(implicit F: Sync[F]): F[VaultToken]

def login[F[_]](client: Client[F], vaultUri: Uri)(roleId: String)(implicit F: Sync[F]): F[VaultToken]

def loginAndKeep[F[_]](client: Client[F], vaultUri: Uri)(roleId: String, tokenLeaseExtension: FiniteDuration)(implicit arg0: Concurrent[F], T: Timer[F]): Stream[F, String]

def loginAndKeepSecretLeased[F[_], A](client: Client[F], vaultUri: Uri)(roleId: String, secretPath: String, duration: FiniteDuration, waitInterval: FiniteDuration)(implicit arg0: Concurrent[F], arg1: Decoder[A], T: Timer[F]): Stream[F, A]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def readSecret[F[_], A](client: Client[F], vaultUri: Uri)(token: String, secretPath: String)(implicit F: Sync[F], D: Decoder[A]): F[VaultSecret[A]]

def readSecretAndRetain[F[_], A](client: Client[F], vaultUri: Uri, clientToken: String)(secretPath: String, leaseExtension: FiniteDuration)(implicit arg0: Concurrent[F], arg1: Decoder[A], T: Timer[F]): Stream[F, A]

def renewLease[F[_]](client: Client[F], vaultUri: Uri)(leaseId: String, newLeaseDuration: FiniteDuration, token: String)(implicit F: Sync[F]): F[VaultSecretRenewal]

def renewSelfToken[F[_]](client: Client[F], vaultUri: Uri)(token: VaultToken, newLeaseDuration: FiniteDuration)(implicit F: Sync[F]): F[VaultToken]

def revokeLease[F[_]](client: Client[F], vaultUri: Uri)(clientToken: String, leaseId: String)(implicit F: Sync[F]): F[Unit]

def revokeSelfToken[F[_]](client: Client[F], vaultUri: Uri)(token: VaultToken)(implicit F: Sync[F]): F[Unit]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def wait(): Unit

Deprecated Value Members

def finalize(): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped