aegis-aead 0.1.1 → 0.2.0

package/src/index.ts

@@ -1,40 +1,106 @@
 export {
+	AEGIS_128L_KEY_SIZE,
+	AEGIS_128L_NONCE_SIZE,
+	aegis128LCreateKey,
+	aegis128LCreateNonce,
 	aegis128LDecrypt,
+	aegis128LDecryptDetached,
 	aegis128LEncrypt,
+	aegis128LEncryptDetached,
 	aegis128LMac,
 	aegis128LMacVerify,
 } from "./aegis128l.js";
 export {
+	AEGIS_128L_BS_KEY_SIZE,
+	AEGIS_128L_BS_NONCE_SIZE,
+	Aegis128LBsState,
+	aegis128LBsCreateKey,
+	aegis128LBsCreateNonce,
+	aegis128LBsDecrypt,
+	aegis128LBsDecryptDetached,
+	aegis128LBsEncrypt,
+	aegis128LBsEncryptDetached,
+	aegis128LBsMac,
+	aegis128LBsMacVerify,
+} from "./aegis128l-bs.js";
+export {
+	AEGIS_128X_KEY_SIZE,
+	AEGIS_128X_NONCE_SIZE,
+	aegis128X2CreateKey,
+	aegis128X2CreateNonce,
 	aegis128X2Decrypt,
+	aegis128X2DecryptDetached,
 	aegis128X2Encrypt,
+	aegis128X2EncryptDetached,
 	aegis128X2Mac,
 	aegis128X2MacVerify,
+	aegis128X4CreateKey,
+	aegis128X4CreateNonce,
 	aegis128X4Decrypt,
+	aegis128X4DecryptDetached,
 	aegis128X4Encrypt,
+	aegis128X4EncryptDetached,
 	aegis128X4Mac,
 	aegis128X4MacVerify,
+	aegis128XCreateKey,
+	aegis128XCreateNonce,
 	aegis128XDecrypt,
+	aegis128XDecryptDetached,
 	aegis128XEncrypt,
+	aegis128XEncryptDetached,
 	aegis128XMac,
 	aegis128XMacVerify,
 } from "./aegis128x.js";
 export {
+	AEGIS_256_KEY_SIZE,
+	AEGIS_256_NONCE_SIZE,
+	aegis256CreateKey,
+	aegis256CreateNonce,
 	aegis256Decrypt,
+	aegis256DecryptDetached,
 	aegis256Encrypt,
+	aegis256EncryptDetached,
 	aegis256Mac,
 	aegis256MacVerify,
 } from "./aegis256.js";
 export {
+	AEGIS_256_BS_KEY_SIZE,
+	AEGIS_256_BS_NONCE_SIZE,
+	Aegis256BsState,
+	aegis256BsCreateKey,
+	aegis256BsCreateNonce,
+	aegis256BsDecrypt,
+	aegis256BsDecryptDetached,
+	aegis256BsEncrypt,
+	aegis256BsEncryptDetached,
+	aegis256BsMac,
+	aegis256BsMacVerify,
+} from "./aegis256-bs.js";
+export {
+	AEGIS_256X_KEY_SIZE,
+	AEGIS_256X_NONCE_SIZE,
+	aegis256X2CreateKey,
+	aegis256X2CreateNonce,
 	aegis256X2Decrypt,
+	aegis256X2DecryptDetached,
 	aegis256X2Encrypt,
+	aegis256X2EncryptDetached,
 	aegis256X2Mac,
 	aegis256X2MacVerify,
+	aegis256X4CreateKey,
+	aegis256X4CreateNonce,
 	aegis256X4Decrypt,
+	aegis256X4DecryptDetached,
 	aegis256X4Encrypt,
+	aegis256X4EncryptDetached,
 	aegis256X4Mac,
 	aegis256X4MacVerify,
+	aegis256XCreateKey,
+	aegis256XCreateNonce,
 	aegis256XDecrypt,
+	aegis256XDecryptDetached,
 	aegis256XEncrypt,
+	aegis256XEncryptDetached,
 	aegis256XMac,
 	aegis256XMacVerify,
 } from "./aegis256x.js";

package/src/random.ts

@@ -0,0 +1,41 @@
+/**
+ * Cross-platform cryptographically secure random byte generation.
+ *
+ * Uses the Web Crypto API (globalThis.crypto.getRandomValues) which is available in:
+ * - All modern browsers
+ * - Node.js 19+
+ * - Deno
+ * - Bun
+ *
+ * For older Node.js versions, you can polyfill:
+ * ```
+ * globalThis.crypto = require('crypto').webcrypto;
+ * ```
+ */
+
+function getCrypto(): Crypto {
+	if (
+		typeof globalThis !== "undefined" &&
+		globalThis.crypto &&
+		typeof globalThis.crypto.getRandomValues === "function"
+	) {
+		return globalThis.crypto;
+	}
+	throw new Error(
+		"No cryptographic random source available. " +
+			"In older Node.js versions, use: globalThis.crypto = require('crypto').webcrypto",
+	);
+}
+
+/**
+ * Generates cryptographically secure random bytes.
+ * @param length - Number of random bytes to generate
+ * @returns Uint8Array of random bytes
+ * @throws Error if no cryptographic random source is available
+ */
+export function randomBytes(length: number): Uint8Array {
+	const crypto = getCrypto();
+	const bytes = new Uint8Array(length);
+	crypto.getRandomValues(bytes);
+	return bytes;
+}

package/README.md~

@@ -1,154 +0,0 @@
-# aegis-aead
-
-[![npm](https://img.shields.io/npm/v/aegis-aead)](https://www.npmjs.com/package/aegis-aead)
-[![CI](https://github.com/jedisct1/js-aegis-aead/actions/workflows/ci.yml/badge.svg)](https://github.com/jedisct1/js-aegis-aead/actions/workflows/ci.yml)
-
-JavaScript / TypeScript implementation of the [AEGIS authenticated encryption algorithms](https://datatracker.ietf.org/doc/draft-irtf-cfrg-aegis-aead/).
-
-AEGIS is a family of fast authenticated encryption algorithms built on AES round functions. It provides both encryption with authentication and standalone MAC functionality.
-
-## Installation
-
-```bash
-bun add aegis-aead
-# or
-npm install aegis-aead
-```
-
-## Usage
-
-### Encryption and Decryption
-
-```typescript
-import { aegis128LEncrypt, aegis128LDecrypt } from "aegis-aead";
-
-const key = crypto.getRandomValues(new Uint8Array(16));
-const nonce = crypto.getRandomValues(new Uint8Array(16));
-const message = new TextEncoder().encode("Hello, world!");
-const associatedData = new TextEncoder().encode("metadata");
-
-// Encrypt
-const { ciphertext, tag } = aegis128LEncrypt(message, associatedData, key, nonce);
-
-// Decrypt (returns null if authentication fails)
-const decrypted = aegis128LDecrypt(ciphertext, tag, associatedData, key, nonce);
-```
-
-### MAC (Message Authentication Code)
-
-```typescript
-import { aegis128LMac, aegis128LMacVerify } from "aegis-aead";
-
-const key = crypto.getRandomValues(new Uint8Array(16));
-const nonce = crypto.getRandomValues(new Uint8Array(16));
-const data = new TextEncoder().encode("data to authenticate");
-
-// Generate MAC
-const tag = aegis128LMac(data, key, nonce);
-
-// Verify MAC
-const valid = aegis128LMacVerify(data, tag, key, nonce);
-```
-
-## Algorithms
-
-| Algorithm  | Key Size | Nonce Size | Block Size | Use Case                           |
-| ---------- | -------- | ---------- | ---------- | ---------------------------------- |
-| AEGIS-128L | 16 bytes | 16 bytes   | 32 bytes   | High throughput on 64-bit CPUs     |
-| AEGIS-256  | 32 bytes | 32 bytes   | 16 bytes   | 256-bit security level             |
-| AEGIS-128X | 16 bytes | 16 bytes   | 32×D bytes | Multi-lane AEGIS-128L (D = degree) |
-| AEGIS-256X | 32 bytes | 32 bytes   | 16×D bytes | Multi-lane AEGIS-256 (D = degree)  |
-
-### Tag Lengths
-
-All algorithms support two tag lengths:
-- 16 bytes (128-bit) - default
-- 32 bytes (256-bit) - pass `32` as the last parameter to encrypt/MAC functions
-
-## API Reference
-
-### AEGIS-128L
-
-```typescript
-aegis128LEncrypt(msg, ad, key, nonce, tagLen?): { ciphertext, tag }
-aegis128LDecrypt(ciphertext, tag, ad, key, nonce): Uint8Array | null
-aegis128LMac(data, key, nonce, tagLen?): Uint8Array
-aegis128LMacVerify(data, tag, key, nonce): boolean
-```
-
-### AEGIS-256
-
-```typescript
-aegis256Encrypt(msg, ad, key, nonce, tagLen?): { ciphertext, tag }
-aegis256Decrypt(ciphertext, tag, ad, key, nonce): Uint8Array | null
-aegis256Mac(data, key, nonce, tagLen?): Uint8Array
-aegis256MacVerify(data, tag, key, nonce): boolean
-```
-
-### AEGIS-128X
-
-Pre-configured variants for degree 2 and 4:
-
-```typescript
-// Degree 2
-aegis128X2Encrypt(msg, ad, key, nonce, tagLen?): { ciphertext, tag }
-aegis128X2Decrypt(ciphertext, tag, ad, key, nonce): Uint8Array | null
-aegis128X2Mac(data, key, nonce, tagLen?): Uint8Array
-aegis128X2MacVerify(data, tag, key, nonce): boolean
-
-// Degree 4
-aegis128X4Encrypt(msg, ad, key, nonce, tagLen?): { ciphertext, tag }
-aegis128X4Decrypt(ciphertext, tag, ad, key, nonce): Uint8Array | null
-aegis128X4Mac(data, key, nonce, tagLen?): Uint8Array
-aegis128X4MacVerify(data, tag, key, nonce): boolean
-
-// Custom degree
-aegis128XEncrypt(msg, ad, key, nonce, tagLen?, degree?): { ciphertext, tag }
-aegis128XDecrypt(ciphertext, tag, ad, key, nonce, degree?): Uint8Array | null
-aegis128XMac(data, key, nonce, tagLen?, degree?): Uint8Array
-aegis128XMacVerify(data, tag, key, nonce, degree?): boolean
-```
-
-### AEGIS-256X
-
-Pre-configured variants for degree 2 and 4:
-
-```typescript
-// Degree 2
-aegis256X2Encrypt(msg, ad, key, nonce, tagLen?): { ciphertext, tag }
-aegis256X2Decrypt(ciphertext, tag, ad, key, nonce): Uint8Array | null
-aegis256X2Mac(data, key, nonce, tagLen?): Uint8Array
-aegis256X2MacVerify(data, tag, key, nonce): boolean
-
-// Degree 4
-aegis256X4Encrypt(msg, ad, key, nonce, tagLen?): { ciphertext, tag }
-aegis256X4Decrypt(ciphertext, tag, ad, key, nonce): Uint8Array | null
-aegis256X4Mac(data, key, nonce, tagLen?): Uint8Array
-aegis256X4MacVerify(data, tag, key, nonce): boolean
-
-// Custom degree
-aegis256XEncrypt(msg, ad, key, nonce, tagLen?, degree?): { ciphertext, tag }
-aegis256XDecrypt(ciphertext, tag, ad, key, nonce, degree?): Uint8Array | null
-aegis256XMac(data, key, nonce, tagLen?, degree?): Uint8Array
-aegis256XMacVerify(data, tag, key, nonce, degree?): boolean
-```
-
-## Browser Example
-
-A browser example is included in `examples/`. To build and run it:
-
-```bash
-bun run build:example
-open examples/index.html
-```
-
-The example demonstrates encryption/decryption with a simple UI where you can enter a message, encrypt it, and decrypt it back.
-
-## Security Notes
-
-- Never reuse a nonce with the same key
-- Decryption returns `null` on authentication failure; do not use any partial output
-
-## License
-
-MIT