transit

Type Members

1. final class Base64 extends AnyVal

   

   A String wrapper class, to ensure that the string inside is a valid Base64 string, as those used in Vault to represent plaintext and context.

2. final case class CipherText(ciphertext: String) extends AnyVal with Product with Serializable

   

   In the Vault Transit, cipher-texts are Base64 strings preceded by the "vault:v1:" prefix text.

   In the Vault Transit, cipher-texts are Base64 strings preceded by the "vault:v1:" prefix text. We our special wrapper class to represent Base64 Strings.

3. final case class Context(context: Base64) extends Product with Serializable

   

   A tagged-like newtype used to indicate that a Base64 value is the user-supplied context used in key derivation.

   A tagged-like newtype used to indicate that a Base64 value is the user-supplied context used in key derivation. "Key derivation allows the same key to be used for multiple purposes by deriving a new key based on a user-supplied context value

   https://www.vaultproject.io/docs/secrets/transit/index.html#transit-secrets-engine

4. final case class EncryptRequest(plaintext: PlainText, context: Option[Context]) extends Product with Serializable

   

5. final case class KeyDetails(name: String, isConvergent: Boolean, isDerived: Boolean, versions: Map[Int, Instant], cipher: String) extends Product with Serializable

   

6. final case class KeyName(name: String) extends Product with Serializable

   

7. final case class PlainText(plaintext: Base64) extends Product with Serializable

   

   A tagged-like newtype used to indicate that a Base64 value is a plaintext we want to encrypt.

8. final class TransitClient[F[_]] extends AnyRef

   

   A TransitClient represents an authenticated connection to a vault transit service.

   A TransitClient represents an authenticated connection to a vault transit service. The way we see to use it is that, in your application you may have a certain type of data that you want to encrypt or decrypt using Vault transit, with a key that is fixed for that data.

9. final case class TransitError(error: String) extends Product with Serializable