MongoDB Store

The store/mongo package implements Keysmith's store.Store interface using the grove ORM with the MongoDB driver. It stores keys, policies, scopes, usage records, and rotations as documents, making it a natural fit for deployments that already run MongoDB.

Usage

import (
    "github.com/xraph/grove"
    "github.com/xraph/grove/drivers/mongodriver"
    "github.com/xraph/keysmith/store/mongo"
)

db, err := grove.Open(mongodriver.Open("mongodb://localhost:27017", "keysmith"))
if err != nil {
    log.Fatal(err)
}

s := mongo.New(db)
if err := s.Migrate(ctx); err != nil {
    log.Fatal(err)
}

eng, err := keysmith.NewEngine(keysmith.WithStore(s))

Migrations

The store creates collections with JSON Schema validation (auto-generated from Grove model structs) and applies indexes on all Keysmith collections. Run them on startup:

if err := s.Migrate(ctx); err != nil {
    log.Fatal(err)
}

This creates indexes across seven collections:

Collection	Description
`keysmith_keys`	API keys with hash, state, and metadata
`keysmith_policies`	Policy definitions
`keysmith_scopes`	Scope definitions
`keysmith_key_scopes`	Key-scope junction table
`keysmith_usage`	Per-request usage records
`keysmith_usage_agg`	Aggregated usage (daily/monthly)
`keysmith_rotations`	Rotation history records

Migrations are idempotent and safe to run on every startup.

Internals

Aspect	Detail
Driver	grove ORM + mongodriver
Migrations	Grove migrations with JSON Schema validation + indexes
Transactions	MongoDB sessions (replica-set required for multi-doc txns)
Concurrency	MongoDB native concurrency model
Subsystems	keys, policies, scopes, usages, rotations

Health checks

if err := s.Ping(ctx); err != nil {
    log.Fatal("database unreachable:", err)
}

Usage with the engine

eng, err := keysmith.NewEngine(keysmith.WithStore(s))

Grove Migrations

The store exports a Migrations group for use with Grove's migration orchestrator. This enables tracked, versioned migrations across all stores in your application:

import mongostore "github.com/xraph/keysmith/store/mongo"

// mongostore.Migrations is a migrate.Group for the keysmith mongo store.
// Register it with the grove migration orchestrator for coordinated migrations.

When to use

Scenario	Recommended
Document-oriented workloads	Yes
Horizontally-scaled environments	Yes
Teams already running MongoDB	Yes
Single-node development	Possible -- SQLite may be simpler
Maximum SQL compatibility	No -- use PostgreSQL