sailfork / t3code-github / .repos/ alchemy-effect/ packages/ fly/ src/ Decrypt.ts

import type { DecryptSecretKeyError } from "@distilled.cloud/fly-io/machines";
import * as Binding from "alchemy/Binding";
import type { RuntimeContext } from "alchemy/RuntimeContext";
import type * as Effect from "effect/Effect";
import type * as Redacted from "effect/Redacted";
import type { SecretKey } from "./SecretKey.ts";

export interface DecryptRequest {
  /** Ciphertext produced by {@link Encrypt}. */
  ciphertext: Uint8Array | ArrayLike<number>;
  /** Optional AEAD associated data. Must match encryption. */
  associatedData?: Uint8Array | ArrayLike<number>;
}

export interface DecryptResult {
  /** Plaintext, wrapped so it never logs. Unwrap with `Redacted.value`. */
  plaintext: Redacted.Redacted<Uint8Array>;
}

/**
 * Decrypt with a Fly {@link SecretKey}. The App and key name are fixed
 * by `Decrypt(key)`.
 *
 *
 * ### Decrypt a payload
 * Provide {@link DecryptHttp}. Plaintext comes back `Redacted`. Unwrap
 * with `Redacted.value` only where you need the raw bytes.
 *
 * **Example:** Decrypt
 * ```typescript
 * import * as Redacted from "effect/Redacted";
 *
 * const decrypt = yield* Fly.Decrypt(Box);
 * const { plaintext } = yield* decrypt({ ciphertext });
 * const bytes = Redacted.value(plaintext);
 * ```
 *
 * ### Associated data
 * `associatedData` must match the bytes passed to {@link Encrypt}.
 *
 * **Example:** AEAD
 * ```typescript
 * const { plaintext } = yield* decrypt({
 *   ciphertext,
 *   associatedData: nonce,
 * });
 * ```
 *
 * @binding
 * @product Secret Key
 */
export interface Decrypt extends Binding.Service<
  Decrypt,
  "Fly.Decrypt",
  (
    key: SecretKey,
  ) => Effect.Effect<
    (request: DecryptRequest) => Effect.Effect<DecryptResult, DecryptSecretKeyError, RuntimeContext>
  >
> {}

export const Decrypt = Binding.Service<Decrypt>("Fly.Decrypt");