aegis-aead 0.2.0 → 0.2.2

package/README.md

@@ -1,12 +1,38 @@
-# aegis-aead
+# AEGIS for JavaScript
 
 [![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)
 
+[View on npm](https://www.npmjs.com/package/aegis-aead)
+
 A compact, zero-dependency JavaScript/TypeScript implementation of [AEGIS](https://datatracker.ietf.org/doc/draft-irtf-cfrg-aegis-aead/), a family of fast, secure authenticated encryption algorithms.
 
 AEGIS provides both encryption with authentication and standalone MAC functionality, with a simple API that makes it hard to misuse.
 
+## Table of Contents
+
+- [AEGIS for JavaScript](#aegis-for-javascript)
+  - [Table of Contents](#table-of-contents)
+  - [Installation](#installation)
+  - [Quick Start](#quick-start)
+  - [Choosing an Algorithm](#choosing-an-algorithm)
+  - [Usage Examples](#usage-examples)
+    - [Combined Mode](#combined-mode)
+    - [Detached Mode](#detached-mode)
+    - [In-Place Mode](#in-place-mode)
+    - [MAC (Message Authentication Code)](#mac-message-authentication-code)
+  - [API Overview](#api-overview)
+    - [Functions](#functions)
+    - [Parameters](#parameters)
+    - [Constants](#constants)
+    - [Parallel Variants (AEGIS-128X / AEGIS-256X)](#parallel-variants-aegis-128x--aegis-256x)
+  - [Security Considerations](#security-considerations)
+    - [Nonce Safety](#nonce-safety)
+    - [Tag Lengths](#tag-lengths)
+    - [Bitsliced Variants](#bitsliced-variants)
+  - [Compatibility](#compatibility)
+  - [Browser Example](#browser-example)
+
 ## Installation
 
 ```bash
@@ -15,32 +41,62 @@ bun add aegis-aead
 npm install aegis-aead
 ```
 
-## Usage
-
-### Encryption and Decryption
+## Quick Start
 
 ```typescript
-import {
-  aegis128LCreateKey,
-  aegis128LEncrypt,
-  aegis128LDecrypt
-} from "aegis-aead";
+import { aegis128LCreateKey, aegis128LEncrypt, aegis128LDecrypt } from "aegis-aead";
 
-const key = aegis128LCreateKey(); // 16 random bytes
+const key = aegis128LCreateKey();
 const message = new TextEncoder().encode("Hello, world!");
 const associatedData = new TextEncoder().encode("metadata");
 
-// Encrypt - returns nonce || ciphertext || tag
-// A random nonce is generated automatically
+// Encrypt (nonce is generated automatically)
 const sealed = aegis128LEncrypt(message, associatedData, key);
 
 // Decrypt (returns null if authentication fails)
 const decrypted = aegis128LDecrypt(sealed, associatedData, key);
 ```
 
+## Choosing an Algorithm
+
+| Algorithm     | Key      | Nonce    | Best For                                 |
+| ------------- | -------- | -------- | ---------------------------------------- |
+| AEGIS-128L    | 16 bytes | 16 bytes | General use, high throughput             |
+| AEGIS-256     | 32 bytes | 32 bytes | Large nonce, unlimited messages          |
+| AEGIS-128X    | 16 bytes | 16 bytes | Interop with native SIMD implementations |
+| AEGIS-256X    | 32 bytes | 32 bytes | Interop + large nonce                    |
+| AEGIS-128L-BS | 16 bytes | 16 bytes | Side-channel protection                  |
+| AEGIS-256-BS  | 32 bytes | 32 bytes | Side-channel + large nonce               |
+
+Recommendations:
+
+- Default choice: AEGIS-128L offers excellent performance with safe random nonces up to 2^48 messages
+- Unlimited messages: AEGIS-256 when you need unlimited random nonces (32-byte nonce eliminates collision risk)
+- Interoperability: AEGIS-128X/256X when exchanging data with native implementations using these variants
+- Hostile environments: Bitsliced variants (-BS) when attackers may observe timing
+
+Note: The X variants are designed for SIMD parallelism in native code. In JavaScript they offer no speed benefit but are provided for interoperability.
+
+## Usage Examples
+
+### Combined Mode
+
+The simplest API: returns `nonce || ciphertext || tag` in one buffer.
+
+```typescript
+import { aegis128LCreateKey, aegis128LEncrypt, aegis128LDecrypt } from "aegis-aead";
+
+const key = aegis128LCreateKey();
+const message = new TextEncoder().encode("Hello, world!");
+const ad = new TextEncoder().encode("metadata");
+
+const sealed = aegis128LEncrypt(message, ad, key);
+const decrypted = aegis128LDecrypt(sealed, ad, key);
+```
+
 ### Detached Mode
 
-For applications that need separate access to the ciphertext and tag:
+When you need separate access to ciphertext and tag:
 
 ```typescript
 import {
@@ -53,278 +109,149 @@ import {
 const key = aegis128LCreateKey();
 const nonce = aegis128LCreateNonce();
 const message = new TextEncoder().encode("Hello, world!");
-const associatedData = new TextEncoder().encode("metadata");
-
-// Encrypt - returns ciphertext and tag separately
-const { ciphertext, tag } = aegis128LEncryptDetached(message, associatedData, key, nonce);
+const ad = new TextEncoder().encode("metadata");
 
-// Decrypt
-const decrypted = aegis128LDecryptDetached(ciphertext, tag, associatedData, key, nonce);
+const { ciphertext, tag } = aegis128LEncryptDetached(message, ad, key, nonce);
+const decrypted = aegis128LDecryptDetached(ciphertext, tag, ad, key, nonce);
 ```
 
-### MAC (Message Authentication Code)
+### In-Place Mode
+
+Zero-copy encryption that modifies the buffer directly:
 
 ```typescript
 import {
   aegis128LCreateKey,
-  aegis128LMac,
-  aegis128LMacVerify
+  aegis128LCreateNonce,
+  aegis128LEncryptDetachedInPlace,
+  aegis128LDecryptDetachedInPlace
 } from "aegis-aead";
 
 const key = aegis128LCreateKey();
-const data = new TextEncoder().encode("data to authenticate");
+const nonce = aegis128LCreateNonce();
+const data = new TextEncoder().encode("Hello, world!");
+const ad = new TextEncoder().encode("metadata");
 
-// Generate MAC (nonce defaults to zero if not provided)
-const tag = aegis128LMac(data, key);
+// Encrypt: data is modified, tag is returned
+const tag = aegis128LEncryptDetachedInPlace(data, ad, key, nonce);
 
-// Verify MAC
-const valid = aegis128LMacVerify(data, tag, key);
+// Decrypt: returns true if authentication succeeds
+const success = aegis128LDecryptDetachedInPlace(data, tag, ad, 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)  |
-| AEGIS-128L-BS | 16 bytes | 16 bytes   | 32 bytes   | Bitsliced                          |
-| AEGIS-256-BS  | 32 bytes | 32 bytes   | 16 bytes   | Bitsliced                          |
+### MAC (Message Authentication Code)
 
-### Bitsliced Variants
+Authenticate data without encrypting:
 
-The `-BS` (bitsliced) variants provide protection against cache-timing side-channel attacks at the cost of ~20% performance overhead. They process AES operations without lookup tables, making execution time independent of the key and data values.
+```typescript
+import { aegis128LCreateKey, aegis128LMac, aegis128LMacVerify } from "aegis-aead";
 
-Use the bitsliced variants when:
-- Adversaries may be able to observe timing information (shared hosting, cloud VMs)
-- The key holder may encrypt or decrypt attacker-controlled data
-- Maximum side-channel resistance is required
+const key = aegis128LCreateKey();
+const data = new TextEncoder().encode("data to authenticate");
 
-For most use cases, the standard implementations are safe since AEGIS's continuous state mixing makes practical timing attacks extremely difficult.
+const tag = aegis128LMac(data, key);
+const valid = aegis128LMacVerify(data, tag, key);
+```
 
-### Random Nonces
+## API Overview
 
-When using random nonces (the default for combined-mode functions):
+All AEGIS variants follow the same API pattern. Replace `aegis128L` with your chosen algorithm (`aegis256`, `aegis128X2`, `aegis128X4`, `aegis256X2`, `aegis256X4`, `aegis128LBs`, `aegis256Bs`).
 
-- AEGIS-128L/128X: Safe for up to 2^48 messages per key, regardless of their size
-- AEGIS-256/256X: No practical limits on the number of messages per key
+### Functions
 
-### Tag Lengths
+| Function                                                | Description                                        |
+| ------------------------------------------------------- | -------------------------------------------------- |
+| `createKey()`                                           | Generate a random key                              |
+| `createNonce()`                                         | Generate a random nonce                            |
+| `encrypt(msg, ad, key, nonce?, tagLen?)`                | Encrypt, returns `nonce \|\| ciphertext \|\| tag`  |
+| `decrypt(sealed, ad, key, tagLen?)`                     | Decrypt combined output, returns `null` on failure |
+| `encryptDetached(msg, ad, key, nonce, tagLen?)`         | Encrypt, returns `{ ciphertext, tag }`             |
+| `decryptDetached(ct, tag, ad, key, nonce)`              | Decrypt detached, returns `null` on failure        |
+| `encryptDetachedInPlace(data, ad, key, nonce, tagLen?)` | Encrypt in-place, returns tag                      |
+| `decryptDetachedInPlace(data, tag, ad, key, nonce)`     | Decrypt in-place, returns `boolean`                |
+| `mac(data, key, nonce?, tagLen?)`                       | Generate MAC tag                                   |
+| `macVerify(data, tag, key, nonce?)`                     | Verify MAC tag                                     |
 
-All algorithms support two tag lengths:
+### Parameters
 
-- 16 bytes (128-bit) - default
-- 32 bytes (256-bit) - pass `32` as the last parameter to encrypt/MAC functions
+- msg/data: `Uint8Array` - Data to encrypt/authenticate
+- ad: `Uint8Array` - Associated data (authenticated but not encrypted)
+- key: `Uint8Array` - Encryption key (16 or 32 bytes depending on algorithm)
+- nonce: `Uint8Array` - Number used once (auto-generated if omitted in combined mode)
+- tagLen: `number` - Authentication tag length: `16` (default) or `32`
 
-## API Reference
+### Constants
 
-### AEGIS-128L
+Each algorithm exports size constants:
 
 ```typescript
-// Key/Nonce generation
-aegis128LCreateKey(): Uint8Array   // 16 random bytes
-aegis128LCreateNonce(): Uint8Array // 16 random bytes
-
-// Combined (nonce || ciphertext || tag)
-aegis128LEncrypt(msg, ad, key, nonce?, tagLen?): Uint8Array
-aegis128LDecrypt(sealed, ad, key, tagLen?): Uint8Array | null
-
-// Detached (separate ciphertext and tag)
-aegis128LEncryptDetached(msg, ad, key, nonce, tagLen?): { ciphertext, tag }
-aegis128LDecryptDetached(ciphertext, tag, ad, key, nonce): Uint8Array | null
-
-// MAC (nonce is optional, defaults to zero)
-aegis128LMac(data, key, nonce?, tagLen?): Uint8Array
-aegis128LMacVerify(data, tag, key, nonce?): boolean
-
-// Constants
-AEGIS_128L_KEY_SIZE   // 16
-AEGIS_128L_NONCE_SIZE // 16
+import { AEGIS_128L_KEY_SIZE, AEGIS_128L_NONCE_SIZE } from "aegis-aead";
+// AEGIS_128L_KEY_SIZE = 16
+// AEGIS_128L_NONCE_SIZE = 16
 ```
 
-### AEGIS-256
-
-```typescript
-// Key/Nonce generation
-aegis256CreateKey(): Uint8Array   // 32 random bytes
-aegis256CreateNonce(): Uint8Array // 32 random bytes
-
-// Combined (nonce || ciphertext || tag)
-aegis256Encrypt(msg, ad, key, nonce?, tagLen?): Uint8Array
-aegis256Decrypt(sealed, ad, key, tagLen?): Uint8Array | null
+### Parallel Variants (AEGIS-128X / AEGIS-256X)
 
-// Detached (separate ciphertext and tag)
-aegis256EncryptDetached(msg, ad, key, nonce, tagLen?): { ciphertext, tag }
-aegis256DecryptDetached(ciphertext, tag, ad, key, nonce): Uint8Array | null
+The X variants support a configurable degree of parallelism:
 
-// MAC (nonce is optional, defaults to zero)
-aegis256Mac(data, key, nonce?, tagLen?): Uint8Array
-aegis256MacVerify(data, tag, key, nonce?): boolean
+```typescript
+// Pre-configured for degree 2 and 4
+import { aegis128X2Encrypt, aegis128X4Encrypt } from "aegis-aead";
 
-// Constants
-AEGIS_256_KEY_SIZE   // 32
-AEGIS_256_NONCE_SIZE // 32
+// Or use custom degree (typically 2 or 4)
+import { aegis128XEncrypt } from "aegis-aead";
+const sealed = aegis128XEncrypt(msg, ad, key, nonce, 16, 4); // degree=4
 ```
 
-### AEGIS-128X
+## Security Considerations
 
-Pre-configured variants for degree 2 and 4:
+### Nonce Safety
 
-```typescript
-// Key/Nonce generation
-aegis128XCreateKey(): Uint8Array   // 16 random bytes
-aegis128XCreateNonce(): Uint8Array // 16 random bytes
-aegis128X2CreateKey(): Uint8Array  // alias
-aegis128X2CreateNonce(): Uint8Array
-aegis128X4CreateKey(): Uint8Array  // alias
-aegis128X4CreateNonce(): Uint8Array
-
-// Combined (nonce || ciphertext || tag)
-aegis128X2Encrypt(msg, ad, key, nonce?, tagLen?): Uint8Array
-aegis128X2Decrypt(sealed, ad, key, tagLen?): Uint8Array | null
-aegis128X4Encrypt(msg, ad, key, nonce?, tagLen?): Uint8Array
-aegis128X4Decrypt(sealed, ad, key, tagLen?): Uint8Array | null
-
-// Detached (separate ciphertext and tag)
-aegis128X2EncryptDetached(msg, ad, key, nonce, tagLen?): { ciphertext, tag }
-aegis128X2DecryptDetached(ciphertext, tag, ad, key, nonce): Uint8Array | null
-aegis128X4EncryptDetached(msg, ad, key, nonce, tagLen?): { ciphertext, tag }
-aegis128X4DecryptDetached(ciphertext, tag, ad, key, nonce): Uint8Array | null
-
-// MAC (nonce is optional, defaults to zero)
-aegis128X2Mac(data, key, nonce?, tagLen?): Uint8Array
-aegis128X2MacVerify(data, tag, key, nonce?): boolean
-aegis128X4Mac(data, key, nonce?, tagLen?): Uint8Array
-aegis128X4MacVerify(data, tag, key, nonce?): boolean
-
-// Custom degree
-aegis128XEncrypt(msg, ad, key, nonce?, tagLen?, degree?): Uint8Array
-aegis128XDecrypt(sealed, ad, key, tagLen?, degree?): Uint8Array | null
-aegis128XEncryptDetached(msg, ad, key, nonce, tagLen?, degree?): { ciphertext, tag }
-aegis128XDecryptDetached(ciphertext, tag, ad, key, nonce, degree?): Uint8Array | null
-aegis128XMac(data, key, nonce?, tagLen?, degree?): Uint8Array
-aegis128XMacVerify(data, tag, key, nonce?, degree?): boolean
-
-// Constants
-AEGIS_128X_KEY_SIZE   // 16
-AEGIS_128X_NONCE_SIZE // 16
-```
+- Combined mode generates random nonces automatically
+- Detached mode requires you to provide nonces - never reuse a nonce with the same key
+- AEGIS-128L/128X: Safe for up to 2^48 messages per key with random nonces
+- AEGIS-256/256X: No practical limits on message count
 
-### AEGIS-256X
+### Tag Lengths
 
-Pre-configured variants for degree 2 and 4:
+All algorithms support 16-byte (128-bit) and 32-byte (256-bit) tags:
 
 ```typescript
-// Key/Nonce generation
-aegis256XCreateKey(): Uint8Array   // 32 random bytes
-aegis256XCreateNonce(): Uint8Array // 32 random bytes
-aegis256X2CreateKey(): Uint8Array  // alias
-aegis256X2CreateNonce(): Uint8Array
-aegis256X4CreateKey(): Uint8Array  // alias
-aegis256X4CreateNonce(): Uint8Array
-
-// Combined (nonce || ciphertext || tag)
-aegis256X2Encrypt(msg, ad, key, nonce?, tagLen?): Uint8Array
-aegis256X2Decrypt(sealed, ad, key, tagLen?): Uint8Array | null
-aegis256X4Encrypt(msg, ad, key, nonce?, tagLen?): Uint8Array
-aegis256X4Decrypt(sealed, ad, key, tagLen?): Uint8Array | null
-
-// Detached (separate ciphertext and tag)
-aegis256X2EncryptDetached(msg, ad, key, nonce, tagLen?): { ciphertext, tag }
-aegis256X2DecryptDetached(ciphertext, tag, ad, key, nonce): Uint8Array | null
-aegis256X4EncryptDetached(msg, ad, key, nonce, tagLen?): { ciphertext, tag }
-aegis256X4DecryptDetached(ciphertext, tag, ad, key, nonce): Uint8Array | null
-
-// MAC (nonce is optional, defaults to zero)
-aegis256X2Mac(data, key, nonce?, tagLen?): Uint8Array
-aegis256X2MacVerify(data, tag, key, nonce?): boolean
-aegis256X4Mac(data, key, nonce?, tagLen?): Uint8Array
-aegis256X4MacVerify(data, tag, key, nonce?): boolean
-
-// Custom degree
-aegis256XEncrypt(msg, ad, key, nonce?, tagLen?, degree?): Uint8Array
-aegis256XDecrypt(sealed, ad, key, tagLen?, degree?): Uint8Array | null
-aegis256XEncryptDetached(msg, ad, key, nonce, tagLen?, degree?): { ciphertext, tag }
-aegis256XDecryptDetached(ciphertext, tag, ad, key, nonce, degree?): Uint8Array | null
-aegis256XMac(data, key, nonce?, tagLen?, degree?): Uint8Array
-aegis256XMacVerify(data, tag, key, nonce?, degree?): boolean
-
-// Constants
-AEGIS_256X_KEY_SIZE   // 32
-AEGIS_256X_NONCE_SIZE // 32
+// 32-byte tag
+const sealed = aegis128LEncrypt(msg, ad, key, undefined, 32);
 ```
 
-### AEGIS-128L-BS (Bitsliced)
-
-```typescript
-// Key/Nonce generation
-aegis128LBsCreateKey(): Uint8Array   // 16 random bytes
-aegis128LBsCreateNonce(): Uint8Array // 16 random bytes
-
-// Combined (nonce || ciphertext || tag)
-aegis128LBsEncrypt(msg, ad, key, nonce?, tagLen?): Uint8Array
-aegis128LBsDecrypt(sealed, ad, key, tagLen?): Uint8Array | null
+### Bitsliced Variants
 
-// Detached (separate ciphertext and tag)
-aegis128LBsEncryptDetached(msg, ad, key, nonce, tagLen?): { ciphertext, tag }
-aegis128LBsDecryptDetached(ciphertext, tag, ad, key, nonce): Uint8Array | null
+The `-BS` variants use a constant-time bitsliced AES implementation that doesn't use lookup tables. This prevents cache-timing attacks at the cost of ~20% performance.
 
-// MAC (nonce is optional, defaults to zero)
-aegis128LBsMac(data, key, nonce?, tagLen?): Uint8Array
-aegis128LBsMacVerify(data, tag, key, nonce?): boolean
+Use bitsliced variants when:
+- Running on shared infrastructure (cloud VMs, containers)
+- Attackers may observe timing information
+- Processing attacker-controlled data with secret keys
 
-// Constants
-AEGIS_128L_BS_KEY_SIZE   // 16
-AEGIS_128L_BS_NONCE_SIZE // 16
-```
+For most applications, standard variants are safe since AEGIS's continuous state mixing makes timing attacks impractical.
 
-### AEGIS-256-BS (Bitsliced)
+## Compatibility
 
-```typescript
-// Key/Nonce generation
-aegis256BsCreateKey(): Uint8Array   // 32 random bytes
-aegis256BsCreateNonce(): Uint8Array // 32 random bytes
+Runtime Requirements:
 
-// Combined (nonce || ciphertext || tag)
-aegis256BsEncrypt(msg, ad, key, nonce?, tagLen?): Uint8Array
-aegis256BsDecrypt(sealed, ad, key, tagLen?): Uint8Array | null
+The library uses the Web Crypto API (`crypto.getRandomValues`) for key/nonce generation:
 
-// Detached (separate ciphertext and tag)
-aegis256BsEncryptDetached(msg, ad, key, nonce, tagLen?): { ciphertext, tag }
-aegis256BsDecryptDetached(ciphertext, tag, ad, key, nonce): Uint8Array | null
+- All modern browsers
+- Node.js 18+
+- Deno
+- Bun
 
-// MAC (nonce is optional, defaults to zero)
-aegis256BsMac(data, key, nonce?, tagLen?): Uint8Array
-aegis256BsMacVerify(data, tag, key, nonce?): boolean
+Interoperability:
 
-// Constants
-AEGIS_256_BS_KEY_SIZE   // 32
-AEGIS_256_BS_NONCE_SIZE // 32
-```
+This library implements the [AEGIS IETF draft specification](https://datatracker.ietf.org/doc/draft-irtf-cfrg-aegis-aead/) and interoperates with any compliant implementation. See the [full list of AEGIS implementations](https://github.com/cfrg/draft-irtf-cfrg-aegis-aead?tab=readme-ov-file#known-implementations).
 
 ## Browser Example
 
-A browser example is included in `examples/`. To build and run it:
+A browser demo is included:
 
 ```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.
-
-## Compatibility
-
-The key/nonce generation functions use the Web Crypto API (`globalThis.crypto.getRandomValues`) which is available in:
-
-- All modern browsers
-- Node.js 18+
-- Deno
-- Bun
-
-## Interoperability
-
-This library follows the [AEGIS IETF draft specification](https://datatracker.ietf.org/doc/draft-irtf-cfrg-aegis-aead/) and can exchange encrypted messages with any compliant implementation, including native libraries in C, Rust, Go, Zig, and more.
-
-See the [full list of AEGIS implementations](https://github.com/cfrg/draft-irtf-cfrg-aegis-aead?tab=readme-ov-file#known-implementations).

package/dist/aegis128l-bs.d.ts

@@ -4,37 +4,31 @@
  */
 /**
  * Bitsliced AEGIS-128L cipher state.
- * Uses 8 AES blocks (128 bytes) stored in bitsliced form (32 uint32 words).
+ * The state is kept in packed bitsliced form between operations so that
+ * pack/unpack does not need to be applied at every round.
  */
 export declare class Aegis128LBsState {
     private st;
     private st1;
+    private constantInput;
     private tmp0;
     private tmp1;
     private z0;
     private z1;
     constructor();
-    /**
-     * AEGIS round function: applies AES round to all blocks and rotates.
-     * st[i] = AES(st[i]) ^ st[(i-1) mod 8]
-     */
-    private aegisRound;
-    /**
-     * AEGIS round function with constant input (used in packed mode).
-     */
     private aegisRoundPacked;
-    /**
-     * Pack constant input for blocks 0 and 4.
-     */
     private packConstantInput;
     /**
-     * Absorb rate: XOR message blocks into state positions 0 and 4.
+     * Extract the keystream blocks z0 and z1 directly from the packed state.
+     *
+     *   z0 = S6 ^ S1 ^ (S2 & S3)
+     *   z1 = S2 ^ S5 ^ (S6 & S7)
+     *
+     * The formula is evaluated lane-wise on the packed state, the result is
+     * placed in positions 0 (z0) and 4 (z1), then unpack04 extracts the two
+     * AES blocks.
      */
-    private absorbRate;
-    /**
-     * Update state with two message blocks.
-     */
-    private update;
+    private keystreamPacked;
     /**
      * Initializes the state with a key and nonce.
      * @param key - 16-byte encryption key
@@ -70,6 +64,8 @@ export declare class Aegis128LBsState {
      * @returns 32-byte plaintext block
      */
     dec(ci: Uint8Array): Uint8Array;
+    encInPlace(block: Uint8Array): void;
+    decInPlace(block: Uint8Array): void;
     /**
      * Decrypts a partial (final) ciphertext block smaller than 32 bytes.
      * @param cn - Partial ciphertext block (1-31 bytes)
@@ -108,55 +104,34 @@ export declare function aegis128LBsEncryptDetached(msg: Uint8Array, ad: Uint8Arr
  * @returns Decrypted plaintext, or null if authentication fails
  */
 export declare function aegis128LBsDecryptDetached(ct: Uint8Array, tag: Uint8Array, ad: Uint8Array, key: Uint8Array, nonce: Uint8Array): Uint8Array | null;
+/**
+ * Encrypts a message in-place using bitsliced AEGIS-128L (detached mode).
+ */
+export declare function aegis128LBsEncryptDetachedInPlace(data: Uint8Array, ad: Uint8Array, key: Uint8Array, nonce: Uint8Array, tagLen?: 16 | 32): Uint8Array;
+/**
+ * Decrypts a message in-place using bitsliced AEGIS-128L (detached mode).
+ */
+export declare function aegis128LBsDecryptDetachedInPlace(data: Uint8Array, tag: Uint8Array, ad: Uint8Array, key: Uint8Array, nonce: Uint8Array): boolean;
 export declare const AEGIS_128L_BS_NONCE_SIZE = 16;
 export declare const AEGIS_128L_BS_KEY_SIZE = 16;
 /**
  * Encrypts a message using bitsliced AEGIS-128L.
  * Returns a single buffer containing nonce || ciphertext || tag.
- * @param msg - Plaintext message
- * @param ad - Associated data (authenticated but not encrypted)
- * @param key - 16-byte encryption key
- * @param nonce - 16-byte nonce (optional, generates random nonce if not provided)
- * @param tagLen - Authentication tag length: 16 or 32 bytes (default: 16)
- * @returns Concatenated nonce || ciphertext || tag
  */
 export declare function aegis128LBsEncrypt(msg: Uint8Array, ad: Uint8Array, key: Uint8Array, nonce?: Uint8Array | null, tagLen?: 16 | 32): Uint8Array;
 /**
  * Decrypts a message using bitsliced AEGIS-128L.
  * Expects input as nonce || ciphertext || tag.
- * @param sealed - Concatenated nonce || ciphertext || tag
- * @param ad - Associated data (must match what was used during encryption)
- * @param key - 16-byte encryption key
- * @param tagLen - Authentication tag length: 16 or 32 bytes (default: 16)
- * @returns Decrypted plaintext, or null if authentication fails
  */
 export declare function aegis128LBsDecrypt(sealed: Uint8Array, ad: Uint8Array, key: Uint8Array, tagLen?: 16 | 32): Uint8Array | null;
 /**
- * Computes a MAC (Message Authentication Code) using bitsliced AEGIS-128L.
- * @param data - Data to authenticate
- * @param key - 16-byte key
- * @param nonce - 16-byte nonce (optional, uses zero nonce if null)
- * @param tagLen - Tag length: 16 or 32 bytes (default: 16)
- * @returns Authentication tag
+ * Computes a MAC using bitsliced AEGIS-128L.
  */
 export declare function aegis128LBsMac(data: Uint8Array, key: Uint8Array, nonce?: Uint8Array | null, tagLen?: 16 | 32): Uint8Array;
 /**
  * Verifies a MAC computed using bitsliced AEGIS-128L.
- * @param data - Data to verify
- * @param tag - Expected authentication tag (16 or 32 bytes)
- * @param key - 16-byte key
- * @param nonce - 16-byte nonce (optional, uses zero nonce if null)
- * @returns True if the tag is valid, false otherwise
  */
 export declare function aegis128LBsMacVerify(data: Uint8Array, tag: Uint8Array, key: Uint8Array, nonce?: Uint8Array | null): boolean;
-/**
- * Generates a random 16-byte key for bitsliced AEGIS-128L.
- * @returns 16-byte encryption key
- */
 export declare function aegis128LBsCreateKey(): Uint8Array;
-/**
- * Generates a random 16-byte nonce for bitsliced AEGIS-128L.
- * @returns 16-byte nonce
- */
 export declare function aegis128LBsCreateNonce(): Uint8Array;
 //# sourceMappingURL=aegis128l-bs.d.ts.map

package/dist/aegis128l-bs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"aegis128l-bs.d.ts","sourceRoot":"","sources":["../src/aegis128l-bs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA+BH;;;GAGG;AACH,qBAAa,gBAAgB;IAC5B,OAAO,CAAC,EAAE,CAAY;IACtB,OAAO,CAAC,GAAG,CAAY;IACvB,OAAO,CAAC,IAAI,CAAW;IACvB,OAAO,CAAC,IAAI,CAAW;IACvB,OAAO,CAAC,EAAE,CAAW;IACrB,OAAO,CAAC,EAAE,CAAW;;IAWrB;;;OAGG;IACH,OAAO,CAAC,UAAU;IAkBlB;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAWxB;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAOzB;;OAEG;IACH,OAAO,CAAC,UAAU;IAalB;;OAEG;IACH,OAAO,CAAC,MAAM;IAKd;;;;OAIG;IACH,IAAI,CAAC,GAAG,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI;IA+B9C;;;OAGG;IACH,MAAM,CAAC,EAAE,EAAE,UAAU,GAAG,IAAI;IAQ5B;;;;OAIG;IACH,KAAK,CAAC,EAAE,EAAE,UAAU,EAAE,GAAG,EAAE,UAAU,GAAG,IAAI;IAoC5C;;;;OAIG;IACH,GAAG,CAAC,EAAE,EAAE,UAAU,GAAG,UAAU;IAM/B;;;;OAIG;IACH,KAAK,CAAC,EAAE,EAAE,UAAU,EAAE,GAAG,EAAE,UAAU,GAAG,IAAI;IA+B5C;;;;OAIG;IACH,GAAG,CAAC,EAAE,EAAE,UAAU,GAAG,UAAU;IAM/B;;;;OAIG;IACH,UAAU,CAAC,EAAE,EAAE,UAAU,GAAG,UAAU;IA0CtC;;;;;;OAMG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAE,EAAE,GAAG,EAAO,GAAG,UAAU;CA+DzE;AAED;;;;;;;;GAQG;AACH,wBAAgB,0BAA0B,CACzC,GAAG,EAAE,UAAU,EACf,EAAE,EAAE,UAAU,EACd,GAAG,EAAE,UAAU,EACf,KAAK,EAAE,UAAU,EACjB,MAAM,GAAE,EAAE,GAAG,EAAO,GAClB;IAAE,UAAU,EAAE,UAAU,CAAC;IAAC,GAAG,EAAE,UAAU,CAAA;CAAE,CAyB7C;AAED;;;;;;;;GAQG;AACH,wBAAgB,0BAA0B,CACzC,EAAE,EAAE,UAAU,EACd,GAAG,EAAE,UAAU,EACf,EAAE,EAAE,UAAU,EACd,GAAG,EAAE,UAAU,EACf,KAAK,EAAE,UAAU,GACf,UAAU,GAAG,IAAI,CA6BnB;AAED,eAAO,MAAM,wBAAwB,KAAK,CAAC;AAC3C,eAAO,MAAM,sBAAsB,KAAK,CAAC;AAEzC;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CACjC,GAAG,EAAE,UAAU,EACf,EAAE,EAAE,UAAU,EACd,GAAG,EAAE,UAAU,EACf,KAAK,GAAE,UAAU,GAAG,IAAW,EAC/B,MAAM,GAAE,EAAE,GAAG,EAAO,GAClB,UAAU,CAkBZ;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CACjC,MAAM,EAAE,UAAU,EAClB,EAAE,EAAE,UAAU,EACd,GAAG,EAAE,UAAU,EACf,MAAM,GAAE,EAAE,GAAG,EAAO,GAClB,UAAU,GAAG,IAAI,CASnB;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC7B,IAAI,EAAE,UAAU,EAChB,GAAG,EAAE,UAAU,EACf,KAAK,GAAE,UAAU,GAAG,IAAW,EAC/B,MAAM,GAAE,EAAE,GAAG,EAAO,GAClB,UAAU,CAUZ;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CACnC,IAAI,EAAE,UAAU,EAChB,GAAG,EAAE,UAAU,EACf,GAAG,EAAE,UAAU,EACf,KAAK,GAAE,UAAU,GAAG,IAAW,GAC7B,OAAO,CAIT;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,IAAI,UAAU,CAEjD;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,IAAI,UAAU,CAEnD"}
+{"version":3,"file":"aegis128l-bs.d.ts","sourceRoot":"","sources":["../src/aegis128l-bs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAgCH;;;;GAIG;AACH,qBAAa,gBAAgB;IAC5B,OAAO,CAAC,EAAE,CAAY;IACtB,OAAO,CAAC,GAAG,CAAY;IACvB,OAAO,CAAC,aAAa,CAAY;IACjC,OAAO,CAAC,IAAI,CAAW;IACvB,OAAO,CAAC,IAAI,CAAW;IACvB,OAAO,CAAC,EAAE,CAAW;IACrB,OAAO,CAAC,EAAE,CAAW;;IAYrB,OAAO,CAAC,gBAAgB;IAWxB,OAAO,CAAC,iBAAiB;IAQzB;;;;;;;;;OASG;IACH,OAAO,CAAC,eAAe;IAsBvB;;;;OAIG;IACH,IAAI,CAAC,GAAG,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI;IA6B9C;;;OAGG;IACH,MAAM,CAAC,EAAE,EAAE,UAAU,GAAG,IAAI;IAS5B;;;;OAIG;IACH,KAAK,CAAC,EAAE,EAAE,UAAU,EAAE,GAAG,EAAE,UAAU,GAAG,IAAI;IAmB5C;;;;OAIG;IACH,GAAG,CAAC,EAAE,EAAE,UAAU,GAAG,UAAU;IAM/B;;;;OAIG;IACH,KAAK,CAAC,EAAE,EAAE,UAAU,EAAE,GAAG,EAAE,UAAU,GAAG,IAAI;IAkB5C;;;;OAIG;IACH,GAAG,CAAC,EAAE,EAAE,UAAU,GAAG,UAAU;IAM/B,UAAU,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;IAInC,UAAU,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;IAInC;;;;OAIG;IACH,UAAU,CAAC,EAAE,EAAE,UAAU,GAAG,UAAU;IA4BtC;;;;;;OAMG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAE,EAAE,GAAG,EAAO,GAAG,UAAU;CAiEzE;AAED;;;;;;;;GAQG;AACH,wBAAgB,0BAA0B,CACzC,GAAG,EAAE,UAAU,EACf,EAAE,EAAE,UAAU,EACd,GAAG,EAAE,UAAU,EACf,KAAK,EAAE,UAAU,EACjB,MAAM,GAAE,EAAE,GAAG,EAAO,GAClB;IAAE,UAAU,EAAE,UAAU,CAAC;IAAC,GAAG,EAAE,UAAU,CAAA;CAAE,CAyB7C;AAED;;;;;;;;GAQG;AACH,wBAAgB,0BAA0B,CACzC,EAAE,EAAE,UAAU,EACd,GAAG,EAAE,UAAU,EACf,EAAE,EAAE,UAAU,EACd,GAAG,EAAE,UAAU,EACf,KAAK,EAAE,UAAU,GACf,UAAU,GAAG,IAAI,CA6BnB;AAED;;GAEG;AACH,wBAAgB,iCAAiC,CAChD,IAAI,EAAE,UAAU,EAChB,EAAE,EAAE,UAAU,EACd,GAAG,EAAE,UAAU,EACf,KAAK,EAAE,UAAU,EACjB,MAAM,GAAE,EAAE,GAAG,EAAO,GAClB,UAAU,CAwBZ;AAED;;GAEG;AACH,wBAAgB,iCAAiC,CAChD,IAAI,EAAE,UAAU,EAChB,GAAG,EAAE,UAAU,EACf,EAAE,EAAE,UAAU,EACd,GAAG,EAAE,UAAU,EACf,KAAK,EAAE,UAAU,GACf,OAAO,CA+BT;AAED,eAAO,MAAM,wBAAwB,KAAK,CAAC;AAC3C,eAAO,MAAM,sBAAsB,KAAK,CAAC;AAEzC;;;GAGG;AACH,wBAAgB,kBAAkB,CACjC,GAAG,EAAE,UAAU,EACf,EAAE,EAAE,UAAU,EACd,GAAG,EAAE,UAAU,EACf,KAAK,GAAE,UAAU,GAAG,IAAW,EAC/B,MAAM,GAAE,EAAE,GAAG,EAAO,GAClB,UAAU,CAkBZ;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CACjC,MAAM,EAAE,UAAU,EAClB,EAAE,EAAE,UAAU,EACd,GAAG,EAAE,UAAU,EACf,MAAM,GAAE,EAAE,GAAG,EAAO,GAClB,UAAU,GAAG,IAAI,CASnB;AAED;;GAEG;AACH,wBAAgB,cAAc,CAC7B,IAAI,EAAE,UAAU,EAChB,GAAG,EAAE,UAAU,EACf,KAAK,GAAE,UAAU,GAAG,IAAW,EAC/B,MAAM,GAAE,EAAE,GAAG,EAAO,GAClB,UAAU,CAUZ;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CACnC,IAAI,EAAE,UAAU,EAChB,GAAG,EAAE,UAAU,EACf,GAAG,EAAE,UAAU,EACf,KAAK,GAAE,UAAU,GAAG,IAAW,GAC7B,OAAO,CAIT;AAED,wBAAgB,oBAAoB,IAAI,UAAU,CAEjD;AAED,wBAAgB,sBAAsB,IAAI,UAAU,CAEnD"}