Crypto React
    Preparing search index...

    Crypto React

    crypto-react logo

    @sebastienrousseau/crypto-react

    React hooks and context provider for client-side cryptographic operations with zero boilerplate.

    Build Coverage Registry Docs OpenSSF Scorecard License: Apache-2.0 OR MIT Node.js 22 or newer React >= 18


    Getting started

    • Install — installation via pnpm, npm, or yarn
    • Requirements — runtime floor and environment prerequisites
    • Quick Start — minimal working usage sample

    The Crypto Service ecosystem

    Package reference

    Operational


    pnpm add @sebastienrousseau/crypto-react
    # or
    npm install @sebastienrousseau/crypto-react
    # or
    yarn add @sebastienrousseau/crypto-react

    Back to Top


    • Node.js: ^22.0.0 or >=24.0.0 (active and maintenance LTS releases)
    • Package Manager: pnpm >=9 (recommended) or npm >=10
    • TypeScript: >=5.0 (when compiling with TypeScript)

    Back to Top


    import {
    CryptoProvider,
    useKeypair,
    useEncrypt,
    useHash,
    useSignature,
    } from "@sebastienrousseau/crypto-react";

    function App() {
    return (
    <CryptoProvider defaultKey="deadbeef...64-hex-chars">
    <MyComponent />
    </CryptoProvider>
    );
    }

    function MyComponent() {
    const { generate, publicKey } = useKeypair("ed25519");
    const { encrypt, decrypt } = useEncrypt();
    const { hash, digest } = useHash("sha3-256");
    const { sign, verify } = useSignature();

    return (
    <div>
    <button onClick={() => generate()}>Generate Ed25519 Key Pair</button>
    {publicKey && <code>{publicKey}</code>}
    </div>
    );
    }

    Back to Top


    Crypto Service provides a complete cryptography stack across 14 specialized packages:

    Package Role Description
    @sebastienrousseau/crypto-api API docs Postman collection types and a Postman-to-Markdown converter; the server's API contract is its OpenAPI document.
    @sebastienrousseau/crypto-benchmarks Benchmarks Benchmarks comparing classical and post-quantum cryptography: ops/sec, latency and throughput.
    @sebastienrousseau/crypto-cbom CBOM Cryptographic Bill of Materials generator and auditor (CycloneDX 1.6, SPDX 3.0).
    @sebastienrousseau/crypto-cli Terminal CLI Command-line interface: hashing, key generation, encryption, signing, HPKE, Argon2id and CBOM scans, with an interactive menu.
    @sebastienrousseau/crypto-edge Edge Runtime Edge-runtime cryptographic operations using the Web Crypto API, optimized for Cloudflare Workers, Vercel Edge, and Deno.
    @sebastienrousseau/crypto-kms Cloud KMS Unified KMS interface: AWS KMS, Google Cloud KMS, Vault Transit and local providers; Azure is a stub.
    @sebastienrousseau/crypto-lib Core Library Core library: post-quantum ML-KEM, ML-DSA and SLH-DSA, plus classical, modern and OpenPGP cryptography for TypeScript.
    @sebastienrousseau/crypto-lsp IDE Analysis Language server that flags weak and quantum-vulnerable cryptography in the editor, with quick fixes.
    @sebastienrousseau/crypto-mcp AI Agents Model Context Protocol server exposing cryptography tools to AI assistants and agents.
    @sebastienrousseau/crypto-middleware Middleware Cryptographic middleware for Express and Fastify: decrypt requests, encrypt responses, verify HMAC signatures and JWTs.
    @sebastienrousseau/crypto-prisma ORM Adapter Transparent field-level encryption extension for Prisma Client, using XChaCha20-Poly1305.
    @sebastienrousseau/crypto-react (this package) React Hooks React hooks and context provider for client-side cryptographic operations with zero boilerplate.
    @sebastienrousseau/crypto-sdk Client SDK A zero-dependency, typed HTTP client for the Crypto Service REST API, with full post-quantum support.
    @sebastienrousseau/crypto-server HTTP API A hardened Fastify REST API for cryptographic operations, with rate limiting, OpenAPI schemas, and post-quantum endpoints.
    @sebastienrousseau/crypto-testing Test Support Deterministic keys, fast mocks, and test fixtures for crypto-lib
    @sebastienrousseau/crypto-typeorm ORM Adapter TypeORM column-level encryption with a single decorator, powered by crypto-lib.
    @sebastienrousseau/crypto-vue Vue Composables Vue 3 composables for client-side cryptography
    @sebastienrousseau/crypto-wasm Acceleration Placeholder for a WebAssembly accelerator; no WebAssembly module ships yet.

    Back to Top


    crypto-react provides React hooks for client-side cryptographic operations. It wraps @sebastienrousseau/crypto-lib in a reactive API with hooks for key generation, symmetric encryption, hashing, and digital signatures. A CryptoProvider component supplies shared configuration (default key, server URL, API key) to all hooks via React context.

    Back to Top

    Wrap your component tree with <CryptoProvider> to supply shared configuration to all hooks.

    <CryptoProvider defaultKey={keyTheUserUnlocked}>
    <App />
    </CryptoProvider>
    Prop Type Description
    defaultKey string Hex-encoded 256-bit key for useEncrypt
    serverUrl string Deprecated: no hook reads it
    apiKey string Deprecated: no hook reads it, and an API key in a browser is public
    children ReactNode Child components

    Everything these hooks hold runs in the browser. A key written into your bundle, such as a literal defaultKey, is public; pass keys the user supplies or unlocks at runtime. Keys in hook state, such as useKeypair's privateKey, can be read by any script on the page and by React DevTools, and JavaScript cannot wipe them: call clear() when you are done, and keep long-lived keys on a server (for example crypto-server's /v2/keys/generate, which never returns the private key unless asked).

    Access the context from any child via useCryptoContext().

    Back to Top

    Hook Purpose Returns
    useKeypair Key pair generation (all algorithms) { publicKey, privateKey, algorithm, generate, isGenerating, clear }
    useEncrypt Symmetric encryption (secretbox) { encrypt, decrypt, ciphertext, plaintext, isProcessing }
    useHash Cryptographic hashing { hash, digest, isHashing }
    useSignature Digital signatures (sign + verify) { sign, verify, signature, isValid, isProcessing }

    Back to Top

    Generate a key pair
    import { useKeypair } from "@sebastienrousseau/crypto-react";

    function KeygenPage() {
    const { publicKey, generate, isGenerating } = useKeypair("ed25519");

    return (
    <div>
    <button onClick={() => generate()} disabled={isGenerating}>
    Generate Ed25519
    </button>
    {publicKey && <code>{publicKey.slice(0, 64)}...</code>}
    </div>
    );
    }
    Encrypt and decrypt
    import { useEncrypt } from "@sebastienrousseau/crypto-react";

    function EncryptPage() {
    const { encrypt, decrypt, ciphertext, plaintext, isProcessing } =
    useEncrypt();

    return (
    <div>
    <button onClick={() => encrypt("secret message")} disabled={isProcessing}>
    Encrypt
    </button>
    {ciphertext && (
    <button onClick={() => decrypt(ciphertext)} disabled={isProcessing}>
    Decrypt
    </button>
    )}
    {plaintext && <p>Decrypted: {plaintext}</p>}
    </div>
    );
    }
    Hash data
    import { useHash } from "@sebastienrousseau/crypto-react";

    function HashPage() {
    const { hash, digest, isHashing } = useHash("sha3-256");

    return (
    <div>
    <button onClick={() => hash("Hello")} disabled={isHashing}>
    SHA3-256
    </button>
    {digest && <code>{digest}</code>}
    </div>
    );
    }
    Sign and verify
    import { useKeypair, useSignature } from "@sebastienrousseau/crypto-react";

    function SignPage() {
    const { publicKey, privateKey, generate } = useKeypair("ed25519");
    const { sign, verify, signature, isValid, isProcessing } = useSignature();

    return (
    <div>
    <button onClick={() => generate()}>Generate Keys</button>
    {privateKey && (
    <button
    onClick={() => sign(privateKey, "my message")}
    disabled={isProcessing}
    >
    Sign
    </button>
    )}
    {signature && publicKey && (
    <button
    onClick={() => verify(publicKey, "my message", signature)}
    disabled={isProcessing}
    >
    Verify
    </button>
    )}
    {isValid !== null && <p>Valid: {isValid ? "Yes" : "No"}</p>}
    </div>
    );
    }

    Back to Top

    All examples are self-contained TypeScript files in the examples/ directory. Run any example with:

    npx ts-node examples/<name>.ts
    
    Category Example Purpose
    Provider provider.ts CryptoProvider context setup and access
    Key Generation keygen.ts Generate Ed25519 and ML-DSA-65 key pairs
    Encryption encrypt.ts Secretbox encrypt and decrypt round-trip
    Hashing hash.ts SHA-256, SHA3-256, and BLAKE3 hashing
    Signing sign.ts Ed25519 sign and verify with tamper detection

    Back to Top

    Back to Top


    pnpm --filter @sebastienrousseau/crypto-react run build
    pnpm --filter @sebastienrousseau/crypto-react run test
    pnpm --filter @sebastienrousseau/crypto-react run lint
    pnpm --filter @sebastienrousseau/crypto-react run format

    All 18 packages in the Crypto Service workspace maintain a 100% coverage floor across statements, branches, functions, and lines.

    Back to Top


    Report vulnerabilities privately via GitHub Security Advisories or according to SECURITY.md. Never report security issues publicly.

    Cryptographic operations use the @noble/* libraries, Node.js crypto and OpenPGP.js. @noble/post-quantum has not been independently audited and does not guarantee constant-time execution, and no module in this suite is FIPS 140-3 validated. Key zeroization is limited: JavaScript strings and garbage-collected buffers cannot be reliably wiped. See SECURITY.md.

    Back to Top


    Back to Top


    Versions advance strictly one step at a time on the 0.0.x line (v0.0.1 → v0.0.2 → v0.0.3 ... → v0.0.999 → v0.1.0). Work for every release iteration begins on a dedicated feat/v<version> branch.

    All 18 packages in the workspace move in lockstep. Public API signatures, cipher output formats, and serialization schemas are strictly versioned. Breaking changes to serialized formats or algorithm defaults are considered major breaking changes. Minimum toolchain upgrades (e.g. Node.js LTS floor) are governed by POLICIES.md.

    Back to Top


    Dual-licensed under Apache 2.0 or MIT, at your option.

    Copyright (c) 2022-2026 Sebastien Rousseau and The Crypto Service Suite contributors.

    Back to Top