Skip to content

Commit 4efa394

Browse files
committed
fix: documentation on new encryption capabilities
1 parent d1eecde commit 4efa394

4 files changed

Lines changed: 20 additions & 9 deletions

File tree

.github/workflows/cd.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,8 @@ jobs:
9595
test -f README.md || (echo "❌ Missing README.md" && exit 1)
9696
test -f CONTRIBUTING.md || (echo "❌ Missing CONTRIBUTING.md" && exit 1)
9797
test -f docs/getting-started.md || (echo "❌ Missing getting-started.md" && exit 1)
98-
test -f docs/core-concepts.md || (echo "❌ Missing core-concepts.md" && exit 1)
99-
test -f docs/usage-guide.md || (echo "❌ Missing usage-guide.md" && exit 1)
98+
test -f docs/user-guide/core-concepts.md || (echo "❌ Missing user-guide/core-concepts.md" && exit 1)
99+
test -f docs/user-guide/usage-guide.md || (echo "❌ Missing user-guide/usage-guide.md" && exit 1)
100100
test -f docs/security-guide.md || (echo "❌ Missing security-guide.md" && exit 1)
101101
echo "✓ All required documentation exists"
102102

THIRD_PARTY_LICENSES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,4 +76,4 @@ This script:
7676

7777
---
7878

79-
**Last generated**: 2026-03-05
79+
**Last generated**: 2026-03-07

docs/architecture/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# <img src="../images/archlette-stainedglassA-light.png" alt="" height="28" width="28" style="vertical-align:middle"> flarelette-jwt-kit
22

33
**Architecture Documentation**
4-
Generated 2026-03-05 17:59:12
4+
Generated 2026-03-06 18:21:58
55

66
## Overview
77

docs/user-guide/core-concepts.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,20 @@ Understanding how Flarelette JWT Kit makes cryptographic and architectural decis
44

55
## Algorithm Selection
66

7-
The kit supports **HS512** (symmetric) and **EdDSA** (asymmetric) as its two primary signing algorithms, plus **ES512** (ECDSA P-521) for TypeScript explicit-API signing. Verification supports **EdDSA, ECDSA (ES256/ES384/ES512), and RSA** for external OIDC tokens. Mode is detected automatically from your environment.
7+
The kit supports **HS512** (symmetric) and **EdDSA** (asymmetric) via environment-driven mode detection, plus **ES512** (ECDSA P-521) via explicit API. Verification supports **EdDSA, ECDSA (ES256/ES384/ES512), and RSA** for external OIDC tokens.
88

9-
**Signing:** HS512 for symmetric trust, EdDSA for asymmetric trust. ES512 available via TypeScript explicit API.
9+
**Signing:** HS512 for simple symmetric trust, EdDSA for asymmetric trust, ES512 for explicit internal mesh profiles.
1010

11-
**Verification:** HS512 and EdDSA for internal tokens; ECDSA and RSA for external OIDC providers.
11+
**Verification:** Internal tokens can use HS512, EdDSA, or ES512; external OIDC providers may use EdDSA, ECDSA, or RSA.
12+
13+
## Configuration Sources
14+
15+
Algorithm selection comes from one of two configuration sources:
16+
17+
- **Environment variables** for auto-detected HS512/EdDSA flows (`envMode`).
18+
- **Explicit config objects** for deterministic algorithm selection across supported algorithms (including ES512 internal mesh profiles and external OIDC verification profiles).
19+
20+
In practice: your deployment chooses the source (env or config object), and that source determines which algorithm is used.
1221

1322
### HS512 (Symmetric)
1423

@@ -25,7 +34,7 @@ The kit supports **HS512** (symmetric) and **EdDSA** (asymmetric) as its two pri
2534
- ~256-bit security with 64-byte keys
2635
- Symmetric: same secret signs and verifies
2736
- Fast signing and verification
28-
- No key rotation complexity
37+
- Secret rotation requires coordinated rollout across producers and consumers
2938

3039
**Environment detection:**
3140

@@ -117,7 +126,7 @@ JWT_JWKS_CACHE_TTL_SECONDS=300 # Optional: default 5 minutes
117126

118127
## Mode Detection
119128

120-
The kit automatically detects which algorithm to use based on environment variables. No manual configuration needed.
129+
The kit automatically detects which algorithm to use based on environment variables for HS512/EdDSA flows.
121130

122131
**Detection logic:**
123132

@@ -133,6 +142,8 @@ Consumer (verification):
133142

134143
**Note:** Asymmetric mode supports EdDSA (Ed25519), ECDSA (ES256/ES384/ES512), and RSA (RS256/384/512) verification. The actual algorithm is auto-detected from the JWK structure or token header.
135144

145+
**Important:** ES512 signing is explicit-API driven, not env auto-detected.
146+
136147
**Verification in code:**
137148

138149
**TypeScript:**

0 commit comments

Comments
 (0)