# Keysmith

> Documentation for Keysmith, version 1.x.
> Every entry links to the page's markdown source.

Repository: https://github.com/xraph/keysmith
Site: https://www.xraph.com/docs/keysmith

## Pages

- [Go Package Reference](https://www.xraph.com/docs/keysmith/api-reference/go-packages.md): Complete Go package index for Keysmith.
- [REST API](https://www.xraph.com/docs/keysmith/api-reference/rest-api.md): Keysmith REST API endpoints for key management.
- [Architecture](https://www.xraph.com/docs/keysmith/architecture.md): How Keysmith's packages fit together.
- [Configuration](https://www.xraph.com/docs/keysmith/concepts/configuration.md): Configuring a Keysmith engine instance.
- [Entities](https://www.xraph.com/docs/keysmith/concepts/entities.md): Core data types used across Keysmith.
- [Error Handling](https://www.xraph.com/docs/keysmith/concepts/errors.md): Sentinel errors for all Keysmith operations.
- [Identity (TypeID)](https://www.xraph.com/docs/keysmith/concepts/identity.md): How Keysmith uses prefix-qualified, globally unique identifiers for every entity.
- [Multi-Tenancy](https://www.xraph.com/docs/keysmith/concepts/multi-tenancy.md): Context-based tenant isolation across all subsystems.
- [Getting Started](https://www.xraph.com/docs/keysmith/getting-started.md): Install Keysmith and create your first API key in under five minutes.
- [Custom Store](https://www.xraph.com/docs/keysmith/guides/custom-store.md): Implementing a custom Keysmith store backend.
- [Forge Integration](https://www.xraph.com/docs/keysmith/guides/forge-extension.md): Using Keysmith with the Forge framework.
- [Full Example](https://www.xraph.com/docs/keysmith/guides/full-example.md): End-to-end example using key creation, validation, rotation, policies, and scopes.
- [HTTP Middleware](https://www.xraph.com/docs/keysmith/guides/middleware.md): Protecting routes with API key validation and scope checks.
- [Introduction](https://www.xraph.com/docs/keysmith.md): Composable API key management for the Forge ecosystem.
- [Memory Store](https://www.xraph.com/docs/keysmith/stores/memory.md): In-memory store for development and testing.
- [MongoDB Store](https://www.xraph.com/docs/keysmith/stores/mongo.md): MongoDB store for document-oriented and horizontally-scalable deployments.
- [PostgreSQL Store](https://www.xraph.com/docs/keysmith/stores/postgres.md): Production PostgreSQL backend using grove ORM with pgdriver.
- [SQLite Store](https://www.xraph.com/docs/keysmith/stores/sqlite.md): Lightweight SQLite store for development, testing, and single-node deployments.
- [Keys](https://www.xraph.com/docs/keysmith/subsystems/keys.md): API key creation, validation, rotation, and lifecycle management.
- [Observability](https://www.xraph.com/docs/keysmith/subsystems/observability.md): Metrics counters for monitoring Keysmith operations.
- [Plugin System](https://www.xraph.com/docs/keysmith/subsystems/plugins.md): Opt-in lifecycle hooks for audit, metrics, and authorization.
- [Policies](https://www.xraph.com/docs/keysmith/subsystems/policies.md): Rate limits, IP allowlists, and key lifetime constraints.
- [Key Rotation](https://www.xraph.com/docs/keysmith/subsystems/rotation.md): Zero-downtime API key rotation with configurable grace periods.
- [Scopes](https://www.xraph.com/docs/keysmith/subsystems/scopes.md): Hierarchical permission scopes for API keys.
- [Usage Analytics](https://www.xraph.com/docs/keysmith/subsystems/usage.md): Per-request usage recording with daily and monthly aggregation.