@request-seal/core API
    Preparing search index...

    Interface KeyManagementHandle

    Caller-owned custodian primitives. RSA private and AES keys never escape as CryptoKey references. Primitive decrypt releases bytes only after authentication.

    interface KeyManagementHandle {
        algorithm: string;
        decrypt(
            encryptedKey: unknown,
            header: JoseProtectedHeader,
            context?: Readonly<{ deadline: number; signal: AbortSignal }>,
        ): Promise<Result<Uint8Array<ArrayBuffer>>>;
        release(): Promise<Result<true>>;
        toJSON(): unknown;
        unwrap(
            encryptedKey: unknown,
            header: JoseProtectedHeader,
            context?: Readonly<{ deadline: number; signal: AbortSignal }>,
        ): Promise<
            Result<
                Readonly<
                    {
                        decrypt: (
                            ciphertext: unknown,
                            options: unknown,
                            context: Context,
                        ) => Promise<Result<Uint8Array<ArrayBuffer>>>;
                        length: 128 | 256;
                        release: () => Promise<Result<true>>;
                    },
                >,
            >,
        >;
        wrap(
            algorithm: unknown,
            content: unknown,
            context?: Readonly<{ deadline: number; signal: AbortSignal }>,
        ): Promise<
            Result<
                Readonly<
                    {
                        encrypted_key: Uint8Array<ArrayBuffer>;
                        header: JoseProtectedHeader;
                    },
                >,
            >,
        >;
    }
    Index
    algorithm
    decrypt release toJSON unwrap wrap
    algorithm: string

    • Authenticate and decrypt content using the bound direct-encryption key.

      Parameters

      • encryptedKey: unknown
      • header: JoseProtectedHeader
      • Optionalcontext: Readonly<{ deadline: number; signal: AbortSignal }>

      Returns Promise<Result<Uint8Array<ArrayBuffer>>>

    • Return a bounded public inspection view without retained cryptographic bytes.

      Returns unknown

    • Confine an unwrapped content-encryption key in a decryption capability.

      Parameters

      • encryptedKey: unknown
      • header: JoseProtectedHeader
      • Optionalcontext: Readonly<{ deadline: number; signal: AbortSignal }>

      Returns Promise<
          Result<
              Readonly<
                  {
                      decrypt: (
                          ciphertext: unknown,
                          options: unknown,
                          context: Context,
                      ) => Promise<Result<Uint8Array<ArrayBuffer>>>;
                      length: 128 | 256;
                      release: () => Promise<Result<true>>;
                  },
              >,
          >,
      >

    • Wrap a generated content-encryption key with the bound key-management algorithm.

      Parameters

      • algorithm: unknown
      • content: unknown
      • Optionalcontext: Readonly<{ deadline: number; signal: AbortSignal }>

      Returns Promise<
          Result<
              Readonly<
                  {
                      encrypted_key: Uint8Array<ArrayBuffer>;
                      header: JoseProtectedHeader;
                  },
              >,
          >,
      >

    Settings
    Member Visibility

    On This Page
    Properties
    Methods