Class

com.banno.vault.transit

TransitClient

Related Doc: package transit

Permalink

final class TransitClient[F[_]] extends AnyRef

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.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TransitClient
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TransitClient(client: Client[F], vaultUri: Uri, token: String, key: KeyName)(implicit F: Sync[F])

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )

  6. def decrypt(cipherText: CipherText): F[PlainText]

    Permalink

    https://www.vaultproject.io/api/secret/transit/index.html#decrypt-data

  7. def decryptBatch(inputs: NonEmptyList[CipherText]): F[NonEmptyList[Or[PlainText]]]

    Permalink

    Decrypts a batch of input ciphertexts using a single round-trip to the Vault server.

    Decrypts a batch of input ciphertexts using a single round-trip to the Vault server. Returns a list where each entry is the attempted result of decrypting the ciphertext at the same position. That result may be either a Transit error or the plaintext, if it failed or succeeded for that ciphertext.

    https://www.vaultproject.io/api/secret/transit/index.html#batch_input-2

  8. def decryptInContext(cipherText: CipherText, context: Context): F[PlainText]

    Permalink

    https://www.vaultproject.io/api/secret/transit/index.html#decrypt-data

  9. def decryptInContextBatch(inputs: NonEmptyList[(CipherText, Context)]): F[NonEmptyList[Or[PlainText]]]

    Permalink

    Decrypts a batch of input pairs (ciphertexts and contexts) using a single round-trip to the Vault server.

    Decrypts a batch of input pairs (ciphertexts and contexts) using a single round-trip to the Vault server. Returns a list where each entry is the attempted result of decrypting the input at the same position. That result may be either a Transit error or the plaintext.

    https://www.vaultproject.io/api/secret/transit/index.html#batch_input-2

  10. def encrypt(plaintext: PlainText): F[CipherText]

    Permalink

    Function to encrypt data, given the name of the secret

    Function to encrypt data, given the name of the secret

    https://www.vaultproject.io/api/secret/transit/index.html#encrypt-data

  11. def encryptBatch(plaintexts: NonEmptyList[PlainText]): F[NonEmptyList[Or[CipherText]]]

    Permalink

    Function to encrypt a batch of data, without any context.

    Function to encrypt a batch of data, without any context.

    When encrypting a batch of data, transit may work ok for some inputs, but fail for others. That is why the result is a list where each element is either a failed message or a CipherText

    https://www.vaultproject.io/api/secret/transit/index.html#batch_input

  12. def encryptInContext(plaintext: PlainText, context: Context): F[CipherText]

    Permalink

    Function to encrypt data, adding a context for key derivation.

    Function to encrypt data, adding a context for key derivation.

    https://www.vaultproject.io/api/secret/transit/index.html#encrypt-data

  13. def encryptInContextBatch(inputs: NonEmptyList[(PlainText, Context)]): F[NonEmptyList[Or[CipherText]]]

    Permalink

    Function to encrypt a batch of context-plaintext pairs in a single trip.

    Function to encrypt a batch of context-plaintext pairs in a single trip.

    https://www.vaultproject.io/api/secret/transit/index.html#batch_input

  14. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  15. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  19. val keyDetails: F[KeyDetails]

    Permalink

    Function to access the details of a transit Key

    Function to access the details of a transit Key

    https://www.vaultproject.io/api/secret/transit/index.html#read-key

  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

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

    Permalink
    Definition Classes
    AnyRef

  24. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  26. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  27. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Ungrouped