sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ KMS/ VerifyMac.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 VerifyMacRequest extends Omit<kms.VerifyMacRequest, "KeyId"> {}

/**
 * Runtime binding for `kms:VerifyMac`.
 *
 * Bind this operation to an HMAC KMS {@link Key} (or the `alias/...` name of
 * a pre-existing key) to get a callable that automatically injects the
 * `KeyId`. A mismatched MAC surfaces as the typed
 * `KMSInvalidMacException` — a valid MAC returns `MacValid: true`.
 *
 * ### Message Authentication
 * **Example:** Verify an HMAC
 * ```typescript
 * const verifyMac = yield* AWS.KMS.VerifyMac(hmacKey);
 *
 * const { MacValid } = yield* verifyMac({
 *   Message: new TextEncoder().encode("session-token-payload"),
 *   Mac: mac,
 *   MacAlgorithm: "HMAC_SHA_256",
 * });
 * ```
 *
 * **Example:** Treat a Bad MAC as a Value
 * ```typescript
 * const valid = yield* verifyMac({ Message, Mac, MacAlgorithm }).pipe(
 *   Effect.map(() => true),
 *   Effect.catchTag("KMSInvalidMacException", () => Effect.succeed(false)),
 * );
 * ```
 *
 * @binding
 */
export interface VerifyMac extends Binding.Service<
  VerifyMac,
  "AWS.KMS.VerifyMac",
  (
    key: Key | AliasName,
  ) => Effect.Effect<
    (request: VerifyMacRequest) => Effect.Effect<kms.VerifyMacResponse, kms.VerifyMacError>
  >
> {}

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