Skip to content
AuthkestraPublic

About

Comprehensive documentation and architectural guides for Authkestra

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Authkestra

Authkestra Documentation Site (docs.authkestra.com)

Documentation Landing Page crates.io License Agent Skills Single-File Corpus

The official documentation site for Authkestra — The Compile-Time Safe Identity & AI Agent Authorization Engine for Rust.

Built with Astro and Starlight, deploying to https://docs.authkestra.com.


📖 What This Site Covers

Comprehensive guides, API specifications, and architectural documentation for:

  1. Getting Started:
    • Quickstart guides for Axum (authkestra-axum) and Actix-web (authkestra-actix).
    • The Typestate Builder Pattern (Engine<S, T>, AkWebAppEngine, AkApiEngine, AkEngine).
    • Wired endpoints vs. manual extractor integration.
  2. Authentication Flows & Passwordless:
    • FIDO2 Passkeys (WebAuthnAuthMethod) with mandatory Re-Proof Gating.
    • TOTP Authenticator Apps (RFC 6238), Magic Links, and Email/SMS OTP codes.
    • Stateless OAuth2 with AES-256-GCM encrypted cookies (AxumStatelessExt).
    • OIDC Client Discovery, Client Credentials, and RFC 8628 Device Flow.
    • Cloudflare Turnstile & hCaptcha bot protection.
    • Device Signatures & Proof-of-Possession (authkestra-devsig).
  3. AI Agent & MCP Tool Security (authkestra-mcp):
    • Three composable security tiers (Public, Scoped, HumanApproved).
    • RFC 8785 JSON Canonicalization Scheme (JCS) and deterministic SHA-256 challenge digests.
    • Human-in-the-Loop (HITL) Passkey step-up approvals and single-use AtomicConsume.
    • Zero-Trust Downstream Token Vault (DownstreamTokenBroker, EncryptedKvTokenVault).
  4. Enterprise Servers & Policy:
    • Full OpenID Provider (authkestra-op), RFC 8693 Token Exchange, and key rotation.
    • Resource Server API guard with RFC 9449 DPoP and RFC 8705 mTLS token binding.
    • Declarative AWS Cedar policy evaluation (authkestra-policy).
    • Continuous Access Evaluation Protocol (CAEP / SSF RFC 8417) via authkestra-ssf.
  5. AI Discoverability & Single-File Documentation:

🚀 Project Structure

.
├── public/                     # Favicons and static assets
├── src/
│   ├── content/
│   │   └── docs/               # Markdown/MDX documentation pages
│   ├── styles/
│   │   ├── tokens.css          # Immutable copy of canonical design tokens
│   │   └── custom.css          # Maps tokens.css onto Starlight's --sl-* variables
│   └── content.config.ts
├── astro.config.mjs            # Starlight configuration and sidebar navigation
├── package.json
└── tsconfig.json

🎨 Design Tokens

src/styles/tokens.css is a verbatim copy of authkestra/design/tokens.css in the core repository. Do not edit it here. src/styles/custom.css imports tokens.css and maps variables to Starlight's --sl-* properties. Typography is bundled locally via @fontsource-variable/inter and @fontsource-variable/jetbrains-mono for zero third-party font requests.


🧞 Development Commands

# Install dependencies
pnpm install

# Start local dev server (http://localhost:4321)
pnpm dev

# Build production site to ./dist/
pnpm build

# Preview build locally
pnpm preview

# Run Astro CLI checks
pnpm astro check

✍️ Documentation Contributions

When documenting public API signatures, verify them against authkestra/crates/ in the main repository. If a runnable example exists under crates/authkestra/examples/, reference it directly.


🌐 Ecosystem Links


📜 Licence

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

About

Comprehensive documentation and architectural guides for Authkestra

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages