sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ KMS/ DeriveSharedSecret.ts

import type * as kms from "@distilled.cloud/aws/kms";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";
import type { AliasName } from "./Alias.ts";
import type { Key } from "./Key.ts";

export interface DeriveSharedSecretRequest extends Omit<kms.DeriveSharedSecretRequest, "KeyId"> {}

/**
 * Runtime binding for `kms:DeriveSharedSecret`.
 *
 * Bind this operation to a KEY_AGREEMENT KMS {@link Key} (or the `alias/...`
 * name of a pre-existing key) to get a callable that automatically injects
 * the `KeyId`. Runs ECDH between the bound key's private key (inside KMS)
 * and a peer's public key, returning the raw shared secret for use with a
 * key-derivation function.
 *
 * The `SharedSecret` in the response is wrapped in `Redacted` so it never
 * leaks into logs — unwrap with `Redacted.value(...)` at the point of use.
 *
 * ### Key Agreement
 * **Example:** Derive a Shared Secret
 * ```typescript
 * const deriveSharedSecret = yield* AWS.KMS.DeriveSharedSecret(agreementKey);
 *
 * const { SharedSecret } = yield* deriveSharedSecret({
 *   KeyAgreementAlgorithm: "ECDH",
 *   PublicKey: peerPublicKeyDer, // DER-encoded SubjectPublicKeyInfo
 * });
 * ```
 *
 * @binding
 */
export interface DeriveSharedSecret extends Binding.Service<
  DeriveSharedSecret,
  "AWS.KMS.DeriveSharedSecret",
  (
    key: Key | AliasName,
  ) => Effect.Effect<
    (
      request: DeriveSharedSecretRequest,
    ) => Effect.Effect<kms.DeriveSharedSecretResponse, kms.DeriveSharedSecretError>
  >
> {}

export const DeriveSharedSecret = Binding.Service<DeriveSharedSecret>("AWS.KMS.DeriveSharedSecret");