@riao/iam - Readme

Installation

npm i @riao/iam

Encryption & Key Pairs

To use encryption and signing features, you need to generate a key pair. The KeyPairGenerator class supports generating RSA and Elliptic Curve key pairs.

Quick Start with Encryptor/Decryptor (Recommended)

The Encryptor and Decryptor classes provide a simple, object-oriented interface for managing encryption and decryption:

import { Encryptor, Decryptor, KeyPairGenerator } from '@riao/iam';

// Generate a key pair
const generator = new KeyPairGenerator({ algorithm: 'RS256' });
const keypair = generator.generate();

// Create Encryptor and Decryptor instances
const encryptor = new Encryptor(keypair.publicKey);
const decryptor = new Decryptor(keypair.privateKey);

// Encrypt and decrypt
const encrypted = encryptor.encrypt('Secret message');
const decrypted = decryptor.decrypt(encrypted);
console.log(decrypted.toString()); // 'Secret message'

JSON Web Tokens (JWT)

The Jwt class provides a secure way to generate and verify JSON Web Tokens for authentication and authorization. It supports both symmetric signing (using a shared secret) and asymmetric signing (using public/private key pairs).

Quick Start

import { Jwt } from '@riao/iam';

// Create a JWT manager with a shared secret
const jwtManager = new Jwt({
	secret: 'your-secret-key',
	algorithm: 'HS512',
	expiresIn: '1h',
});

// Generate a token
const { token } = await jwtManager.generateToken({
	userId: 'user-123',
	role: 'admin',
});

// Verify and decode a token
const payload = await jwtManager.decodeToken(token);
console.log(payload.userId); // 'user-123'

For detailed usage, algorithms, security best practices, and advanced patterns, see the JWT Guide.

Documentation

• Encryptor & Decryptor Guide - Recommended - Object-oriented encryption/decryption interface
• KeyPair Usage Guide - Learn how to use the KeyPairGenerator for cryptographic operations
• Encryption & Decryption Guide - Lower-level encrypt and decrypt functions (for advanced use cases)
• Hash Guide - Password hashing and verification with bcrypt
• JWT Guide - Generate and verify JSON Web Tokens for authentication and authorization

Contributing & Development

See contributing.md for information on how to develop or contribute to this project!