Class CryptoClient

Typed HTTP client for the Crypto Service Suite v2 API.

Example

const client = new CryptoClient({ baseUrl: 'http://localhost:3000' });
const { data } = await client.hash({ algorithm: 'sha256', data: 'hello' });
console.log(data.digest);

Constructors

constructor

new CryptoClient(options: ClientOptions): CryptoClient
Parameters
- options: ClientOptions
Returns CryptoClient
- Defined in index.ts:479

Methods

encrypt

encrypt(
params: { key: string; plaintext: string },
): Promise<ApiResponse<AeadResult>>
Encrypt plaintext using AEAD (AES-GCM or XChaCha20-Poly1305).
Parameters
- params: { key: string; plaintext: string }
Returns Promise<ApiResponse<AeadResult>>
- Defined in index.ts:516

decrypt

decrypt(
params: { key: string; ciphertext: string },
): Promise<ApiResponse<{ plaintext: string }>>
Decrypt ciphertext and return the original plaintext.
Parameters
- params: { key: string; ciphertext: string }
Returns Promise<ApiResponse<{ plaintext: string }>>
- Defined in index.ts:524

hash

hash(
params: { algorithm: string; data: string },
): Promise<ApiResponse<HashResult>>
Compute a cryptographic hash digest.
Parameters
- params: { algorithm: string; data: string }
Returns Promise<ApiResponse<HashResult>>
- Defined in index.ts:536

kdf

kdf(
    params: {
        algorithm: string;
        password: string;
        salt?: string;
        keyLength?: number;
        params?: Record<string, unknown>;
    },
): Promise<ApiResponse<KdfResult>>
Derive a key from a password using a KDF algorithm.
Parameters
- params: {
      algorithm: string;
      password: string;
      salt?: string;
      keyLength?: number;
      params?: Record<string, unknown>;
  }
Returns Promise<ApiResponse<KdfResult>>
- Defined in index.ts:546

mac

mac(
params: { algorithm: string; key: string; data: string },
): Promise<ApiResponse<MacResult>>
Compute a message authentication code (HMAC or KMAC).
Parameters
- params: { algorithm: string; key: string; data: string }
Returns Promise<ApiResponse<MacResult>>
- Defined in index.ts:559

macVerify

macVerify(
params: { algorithm: string; key: string; data: string; mac: string },
): Promise<ApiResponse<{ valid: boolean }>>
Verify a message authentication code.
Parameters
- params: { algorithm: string; key: string; data: string; mac: string }
Returns Promise<ApiResponse<{ valid: boolean }>>
- Defined in index.ts:568

passwordHash

passwordHash(
    params: {
        password: string;
        variant?: string;
        timeCost?: number;
        memoryCost?: number;
        parallelism?: number;
    },
): Promise<ApiResponse<PasswordHashResult>>
Hash a password using Argon2.
Parameters
- params: {
      password: string;
      variant?: string;
      timeCost?: number;
      memoryCost?: number;
      parallelism?: number;
  }
Returns Promise<ApiResponse<PasswordHashResult>>
- Defined in index.ts:585

passwordVerify

passwordVerify(
    params: {
        password: string;
        hash: string;
        salt: string;
        params: { t: number; m: number; p: number };
        variant?: string;
    },
): Promise<ApiResponse<{ valid: boolean }>>
Verify a password against a stored Argon2 hash.
Parameters
- params: {
      password: string;
      hash: string;
      salt: string;
      params: { t: number; m: number; p: number };
      variant?: string;
  }
Returns Promise<ApiResponse<{ valid: boolean }>>
- Defined in index.ts:596

generateKeyPair

generateKeyPair(
params?: { algorithm?: string; metadata?: Record<string, string> },
): Promise<ApiResponse<KeyGenerateResult>>
Generate a new asymmetric key pair.
Parameters
- Optionalparams: { algorithm?: string; metadata?: Record<string, string> }
Returns Promise<ApiResponse<KeyGenerateResult>>
- Defined in index.ts:614

sign

sign(
params: { privateKey: string; message: string },
): Promise<ApiResponse<SignResult>>
Sign a message with a private key.
Parameters
- params: { privateKey: string; message: string }
Returns Promise<ApiResponse<SignResult>>
- Defined in index.ts:626

verify

verify(
params: { publicKey: string; message: string; signature: string },
): Promise<ApiResponse<VerifyResult>>
Verify a digital signature against a public key.
Parameters
- params: { publicKey: string; message: string; signature: string }
Returns Promise<ApiResponse<VerifyResult>>
- Defined in index.ts:634

pqGenerateKeyPair

pqGenerateKeyPair(): Promise<ApiResponse<HybridKeyPair>>
Generate a hybrid X25519+ML-KEM key pair.

Returns Promise<ApiResponse<HybridKeyPair>>
- Defined in index.ts:645

pqEncapsulate

pqEncapsulate(
params: { x25519PublicKey: string; mlKemPublicKey: string },
): Promise<ApiResponse<HybridEncapsulateResult>>
Encapsulate a shared secret using hybrid KEM.
Parameters
- params: { x25519PublicKey: string; mlKemPublicKey: string }
Returns Promise<ApiResponse<HybridEncapsulateResult>>
- Defined in index.ts:650

pqDecapsulate

pqDecapsulate(
    params: {
        x25519PrivateKey: string;
        mlKemSecretKey: string;
        x25519EphemeralPublic: string;
        mlKemCiphertext: string;
    },
): Promise<ApiResponse<{ sharedSecret: string; algorithm: string }>>
Decapsulate a shared secret using hybrid KEM.
Parameters
- params: {
      x25519PrivateKey: string;
      mlKemSecretKey: string;
      x25519EphemeralPublic: string;
      mlKemCiphertext: string;
  }
Returns Promise<ApiResponse<{ sharedSecret: string; algorithm: string }>>
- Defined in index.ts:658

pqSign

pqSign(
params: { level: 44 | 65 | 87; secretKey: string; message: string },
): Promise<ApiResponse<MlDsaSignResult>>
Sign a message using ML-DSA (FIPS 204).
Parameters
- params: { level: 44 | 65 | 87; secretKey: string; message: string }
Returns Promise<ApiResponse<MlDsaSignResult>>
- Defined in index.ts:677

pqVerify

pqVerify(
    params: {
        level: 44 | 65 | 87;
        publicKey: string;
        message: string;
        signature: string;
    },
): Promise<ApiResponse<MlDsaVerifyResult>>
Verify an ML-DSA signature.
Parameters
- params: { level: 44 | 65 | 87; publicKey: string; message: string; signature: string }
Returns Promise<ApiResponse<MlDsaVerifyResult>>
- Defined in index.ts:686

pqSignKeygen

pqSignKeygen(
params: { level: 44 | 65 | 87 },
): Promise<ApiResponse<MlDsaKeyPair>>
Generate an ML-DSA key pair.
Parameters
- params: { level: 44 | 65 | 87 }
Returns Promise<ApiResponse<MlDsaKeyPair>>
- Defined in index.ts:696

pqHashSign

pqHashSign(
params: { variant: string; secretKey: string; message: string },
): Promise<ApiResponse<SlhDsaSignResult>>
Sign a message using SLH-DSA (FIPS 205).
Parameters
- params: { variant: string; secretKey: string; message: string }
Returns Promise<ApiResponse<SlhDsaSignResult>>
- Defined in index.ts:705

pqHashVerify

pqHashVerify(
    params: {
        variant: string;
        publicKey: string;
        message: string;
        signature: string;
    },
): Promise<ApiResponse<SlhDsaVerifyResult>>
Verify an SLH-DSA signature.
Parameters
- params: { variant: string; publicKey: string; message: string; signature: string }
Returns Promise<ApiResponse<SlhDsaVerifyResult>>
- Defined in index.ts:714

pqHashSignKeygen

pqHashSignKeygen(
params: { variant: string },
): Promise<ApiResponse<SlhDsaKeyPair>>
Generate an SLH-DSA key pair.
Parameters
- params: { variant: string }
Returns Promise<ApiResponse<SlhDsaKeyPair>>
- Defined in index.ts:724

secretboxSeal

secretboxSeal(
params: { key: string; plaintext: string; aad?: string },
): Promise<ApiResponse<SecretboxSealResult>>
Seal plaintext with symmetric authenticated encryption (XChaCha20-Poly1305).
Parameters
- params: { key: string; plaintext: string; aad?: string }
Returns Promise<ApiResponse<SecretboxSealResult>>
- Defined in index.ts:733

secretboxOpen

secretboxOpen(
params: { key: string; ciphertext: string; aad?: string },
): Promise<ApiResponse<{ plaintext: string }>>
Open a secretbox sealed ciphertext.
Parameters
- params: { key: string; ciphertext: string; aad?: string }
Returns Promise<ApiResponse<{ plaintext: string }>>
- Defined in index.ts:742

sealedboxSeal

sealedboxSeal(
params: { recipientPublicKey: string; plaintext: string },
): Promise<ApiResponse<SealedboxSealResult>>
Seal plaintext with anonymous public-key encryption.
Parameters
- params: { recipientPublicKey: string; plaintext: string }
Returns Promise<ApiResponse<SealedboxSealResult>>
- Defined in index.ts:758

sealedboxOpen

sealedboxOpen(
params: { recipientSecretKey: string; sealed: string },
): Promise<ApiResponse<{ plaintext: string }>>
Open a sealed box ciphertext with the recipient's secret key.
Parameters
- params: { recipientSecretKey: string; sealed: string }
Returns Promise<ApiResponse<{ plaintext: string }>>
- Defined in index.ts:766

passwordEncrypt

passwordEncrypt(
params: { password: string; plaintext: string },
): Promise<ApiResponse<PasswordEncryptResult>>
Encrypt plaintext with a password (Argon2 + AEAD).
Parameters
- params: { password: string; plaintext: string }
Returns Promise<ApiResponse<PasswordEncryptResult>>
- Defined in index.ts:781

passwordDecrypt

passwordDecrypt(
params: { password: string; ciphertext: string },
): Promise<ApiResponse<{ plaintext: string }>>
Decrypt password-encrypted ciphertext.
Parameters
- params: { password: string; ciphertext: string }
Returns Promise<ApiResponse<{ plaintext: string }>>
- Defined in index.ts:789

keyWrap

keyWrap(
    params: {
        kek: string;
        keyToWrap: string;
        algorithm?: "aes-kw" | "aes-kwp";
    },
): Promise<ApiResponse<KeyWrapResult>>
Wrap (encrypt) a key with a key-encryption key.
Parameters
- params: { kek: string; keyToWrap: string; algorithm?: "aes-kw" | "aes-kwp" }
Returns Promise<ApiResponse<KeyWrapResult>>
- Defined in index.ts:804

keyUnwrap

keyUnwrap(
    params: {
        kek: string;
        wrappedKey: string;
        algorithm?: "aes-kw" | "aes-kwp";
    },
): Promise<ApiResponse<{ key: string }>>
Unwrap (decrypt) a wrapped key.
Parameters
- params: { kek: string; wrappedKey: string; algorithm?: "aes-kw" | "aes-kwp" }
Returns Promise<ApiResponse<{ key: string }>>
- Defined in index.ts:813

algorithms

algorithms(): Promise<ApiResponse<Record<string, string[]>>>
List all supported algorithms by category.

Returns Promise<ApiResponse<Record<string, string[]>>>
- Defined in index.ts:829

health

health(): Promise<{ statusCode: number }>
Check API server health.

Returns Promise<{ statusCode: number }>
- Defined in index.ts:834

Class CryptoClient

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CryptoClient

Methods

encrypt

Parameters

Returns Promise<ApiResponse<AeadResult>>

decrypt

Parameters

Returns Promise<ApiResponse<{ plaintext: string }>>

hash

Parameters

Returns Promise<ApiResponse<HashResult>>

kdf

Parameters

Returns Promise<ApiResponse<KdfResult>>

mac

Parameters

Returns Promise<ApiResponse<MacResult>>

macVerify

Parameters

Returns Promise<ApiResponse<{ valid: boolean }>>

passwordHash

Parameters

Returns Promise<ApiResponse<PasswordHashResult>>

passwordVerify

Parameters

Returns Promise<ApiResponse<{ valid: boolean }>>

generateKeyPair

Parameters

Returns Promise<ApiResponse<KeyGenerateResult>>

sign

Parameters

Returns Promise<ApiResponse<SignResult>>

verify

Parameters

Returns Promise<ApiResponse<VerifyResult>>

pqGenerateKeyPair

Returns Promise<ApiResponse<HybridKeyPair>>

pqEncapsulate

Parameters

Returns Promise<ApiResponse<HybridEncapsulateResult>>

pqDecapsulate

Parameters

Returns Promise<ApiResponse<{ sharedSecret: string; algorithm: string }>>

pqSign

Parameters

Returns Promise<ApiResponse<MlDsaSignResult>>

pqVerify

Parameters

Returns Promise<ApiResponse<MlDsaVerifyResult>>

pqSignKeygen

Parameters

Returns Promise<ApiResponse<MlDsaKeyPair>>

pqHashSign

Parameters

Returns Promise<ApiResponse<SlhDsaSignResult>>

pqHashVerify

Parameters

Returns Promise<ApiResponse<SlhDsaVerifyResult>>

pqHashSignKeygen

Parameters

Returns Promise<ApiResponse<SlhDsaKeyPair>>

secretboxSeal

Parameters

Returns Promise<ApiResponse<SecretboxSealResult>>

secretboxOpen

Parameters

Returns Promise<ApiResponse<{ plaintext: string }>>

sealedboxSeal

Parameters

Returns Promise<ApiResponse<SealedboxSealResult>>

sealedboxOpen

Parameters