Documentation
¶
Index ¶
Constants ¶
const ( RouteUnlock = "unlock" RouteLock = "lock" RouteStatus = "status" RouteList = "list" RouteGet = "get" RouteSet = "set" RouteDelete = "delete" RouteRotate = "rotate" RouteRotateSalt = "rotate-salt" RouteBackup = "backup" )
RouteNames is the set of valid Hook.Route values, one per built-in endpoint.
Variables ¶
This section is empty.
Functions ¶
func Mount ¶
Mount registers all keeper HTTP endpoints on mux under the configured prefix. The default prefix is "/keeper". All routes follow Go 1.22+ method+pattern syntax so they work with stdlib http.ServeMux directly.
Endpoints registered:
POST {prefix}/unlock — unlock the store with a passphrase
POST {prefix}/lock — lock the store
GET {prefix}/status — locked/enabled state (safe to poll)
GET {prefix}/keys — list all secret keys
GET {prefix}/keys/{key} — retrieve a secret value
POST {prefix}/keys — store a secret
DELETE {prefix}/keys/{key} — delete a secret
POST {prefix}/rotate — rotate the master passphrase
POST {prefix}/rotate/salt — rotate the KDF salt
GET {prefix}/backup — stream a database backup
Authentication is entirely the caller's responsibility. Apply middleware to mux, or use WithGuard for principal-level checks on built-in routes.
Types ¶
type AfterFunc ¶
AfterFunc runs after the built-in handler has finished.
If Hook.CaptureBody is true, status and body contain the captured response. If Hook.CaptureBody is false, body is always nil and status is always 0 (the response has already been flushed; capturing is not possible without the recorder overhead).
AfterFunc must not write to w — the response has already been sent. Use it for audit logging, metrics, or cache invalidation.
type BeforeFunc ¶
BeforeFunc runs before the built-in handler executes.
Returning (true, nil) lets the request proceed normally. Returning (false, nil) aborts the request; the BeforeFunc is responsible for writing a complete HTTP response (status + body) before returning. Returning (false, err) aborts the request; the handler writes a 500 JSON error using err.Error() as the message, so the BeforeFunc must NOT have written anything to w yet.
type GuardFunc ¶
GuardFunc is an optional access-control function injected via WithGuard. It is called on every protected route after the built-in locked-check passes, before the route handler body executes.
Returning true allows the request to proceed. Returning false signals that the GuardFunc has already written a complete HTTP response (status + body) and the route handler must abort.
route is one of the RouteXxx constants so the guard can apply per-route logic (e.g. allow list but deny get for a read-restricted principal).
type Hook ¶
type Hook struct {
// Route is one of the RouteXxx constants (e.g. RouteGet, RouteSet).
Route string
// Before is called before the built-in handler. May be nil.
Before BeforeFunc
// After is called after the built-in handler. May be nil.
After AfterFunc
// CaptureBody controls whether the response body is buffered so that
// AfterFunc receives it. Buffering costs one allocation and a copy per
// request — set this to false (the default) when only the status code
// is needed in AfterFunc.
CaptureBody bool
}
Hook attaches lifecycle functions to a single named built-in route.
keephandler.WithHooks(keephandler.Hook{
Route: keephandler.RouteGet,
Before: func(w http.ResponseWriter, r *http.Request) (bool, error) {
principal := r.Header.Get("X-Principal")
key := r.PathValue("key")
if !acl.Allow(principal, "read", key) {
http.Error(w, `{"error":"forbidden"}`, http.StatusForbidden)
return false, nil
}
return true, nil
},
After: func(r *http.Request, status int, body []byte) { audit.Log(r, status) },
CaptureBody: false, // status-only is cheaper; no responseRecorder needed
})
type Option ¶
type Option func(*config)
Option configures the behaviour of Mount.
func WithEncoder ¶
func WithEncoder(enc ResponseEncoder) Option
WithEncoder replaces the default JSON response writer with enc. enc is called by every route handler instead of the built-in jsonOK / jsonError. Use this to add envelope fields, redact values, or change the response shape. If enc is nil the option is ignored.
func WithGuard ¶
WithGuard attaches a principal-level access check that runs on every protected route (all routes except status and unlock) after the built-in locked-check passes. If fn is nil the option is ignored.
func WithHooks ¶
WithHooks attaches Before/After hooks to named built-in routes. Multiple calls to WithHooks are additive — hooks are appended in order. See Hook for the full contract.
func WithLogger ¶
func WithLogger(l logger) Option
WithLogger attaches a custom logger. If nil the option is ignored.
func WithPrefix ¶
WithPrefix sets the URL prefix under which all endpoints are registered. Default is "/keeper". The prefix must start with "/" and must not end with "/".
func WithRoutes ¶
WithRoutes registers additional handlers on the same mux after all built-in routes have been registered. Use this to extend the handler with application-specific endpoints (e.g. TOTP, webhooks) without reimplementing the core routes.
type ResponseEncoder ¶
type ResponseEncoder func(w http.ResponseWriter, route string, status int, data any)
ResponseEncoder writes the HTTP response for a route. It is called by every route handler instead of the built-in jsonOK / jsonError.
route is one of the RouteXxx constants. status is the intended HTTP status code. data is the payload; for errors it is map[string]string{"error": msg}.
The encoder is responsible for setting Content-Type, writing the status code, and writing the body. The default encoder writes flat JSON.
Source Files