Forge Integration

Keysmith ships with a Forge extension adapter that handles DI registration, REST API route mounting, and database migration on startup.

Mounting the extension

import (
    "github.com/xraph/forge"
    "github.com/xraph/keysmith"
    "github.com/xraph/keysmith/extension"
    "github.com/xraph/keysmith/store/postgres"
    audithook "github.com/xraph/keysmith/audit_hook"
)

app := forge.New(
    forge.WithExtension(
        extension.New(
            extension.WithEngineOptions(
                keysmith.WithStore(pgStore),
            ),
            extension.WithHookExtension(audithook.New(recorder)),
        ),
    ),
)

What the extension does

On registration

1. Registers keysmith.Engine in the Forge DI container via vessel.Provide
2. Registers the API route handler

On start

1. Runs database migrations if a PostgreSQL store is configured
2. Starts any background processes (e.g., expired key cleanup)

On stop

1. Fires the Shutdown plugin hook
2. Closes the store connection

REST API routes

When mounted, the extension exposes the full Keysmith REST API:

Automatic tenant scoping

When running inside Forge, Keysmith automatically extracts the app ID and tenant ID from forge.Scope. No manual WithTenant call is needed.

DI integration

Access the engine from the Forge DI container:

// In a Forge handler
func myHandler(ctx forge.Context) error {
    eng := vessel.MustResolve[*keysmith.Engine](ctx.Vessel())
    // use eng...
}

Extension options