@sebastienrousseau/crypto-vue

Contents

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

• The Crypto Service ecosystem — full 18-package suite overview

Package reference

• Reference & Usage — features, configuration, and capabilities
• Examples — runnable sample code

Operational

• Development — build, lint, format, and test targets
• Security — vulnerability disclosure and cryptographic invariants
• Documentation — TypeDoc API docs and ecosystem guides
• Stability guarantees — SemVer axis and release policy
• License

Install

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

Requirements

• 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)

Quick Start

<script setup lang="ts">
import { useKeypair } from "@sebastienrousseau/crypto-vue";

const { publicKey, privateKey, generate, isGenerating } = useKeypair();
</script>

<template>
  <button @click="generate('ed25519')" :disabled="isGenerating">
    Generate Key Pair
  </button>
  <pre v-if="publicKey">{{ publicKey }}</pre>
</template>

The Crypto Service ecosystem

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

Overview

crypto-vue provides Vue 3 composables for client-side cryptographic operations. It wraps @sebastienrousseau/crypto-lib in a reactive API with composables for key generation, symmetric encryption, hashing, and digital signatures. An optional CryptoPlugin supplies global configuration (default key, server URL, API key) via Vue's provide/inject system.

CryptoPlugin

An optional Vue plugin that provides global configuration to all composables via inject/provide.

// main.ts
import { createApp } from "vue";
import { CryptoPlugin } from "@sebastienrousseau/crypto-vue";
import App from "./App.vue";

const app = createApp(App);

app.use(CryptoPlugin, {
  defaultKey: "your-256-bit-hex-key",
  serverUrl: "https://api.example.com",
  apiKey: "your-api-key",
});

app.mount("#app");

Composables Reference

useKeypair()

Reactive key pair generation for any supported algorithm.

Supported algorithms: ed25519, x25519, ed448, x448, p256, p384, ml-kem-512, ml-kem-768, ml-kem-1024, ml-dsa-44, ml-dsa-65, ml-dsa-87

useEncrypt()

Symmetric encryption and decryption using XChaCha20-Poly1305 (secretbox).

useHash()

Cryptographic hashing with multiple algorithms.

Supported algorithms: sha256, sha384, sha512, sha3-256, sha3-512, blake2b, blake3

useSignature()

Digital signature creation and verification.

Supported algorithms: ed25519, ed448, ecdsa-p256, ecdsa-p384, schnorr, ml-dsa-44, ml-dsa-65, ml-dsa-87

Examples

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

npx ts-node examples/<name>.ts

Development

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

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

Security

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.

Documentation

• Full Suite Documentation
• API Reference (TypeDoc)
• Developer Guide
• Security Policy
• Architecture & Design

Stability guarantees

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.

License

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

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