@radzor/api-key-auth

API key authentication middleware. Generate, validate, hash, and revoke API keys.

Authenticationv0.1.0typescriptpythonServerapi-keyauthenticationmiddlewaresecurityauthby Radzor

Install

$npx radzor@latest add api-key-auth

⚠ Constraints: No external dependencies. Keys are hashed with SHA-256 — never store plain-text keys. Header name and prefix are configurable.

Inputs

Name	Type	Default	Description
headerName	string	—	HTTP header name for API key (default: 'x-api-key')
prefix	string	—	API key prefix (default: 'rz_')

headerNamestring

HTTP header name for API key (default: 'x-api-key')

prefixstring

API key prefix (default: 'rz_')

Outputs

Name	Type	Description
validationResult	{ valid: boolean; keyId: string \| null }	Result of the API key validation check.

{ "llm": { "constraints": "No external dependencies. Keys are hashed with SHA-256 — never store plain-text keys. Header name and prefix are configurable.", "usageExamples": "llm/examples.md", "integrationPrompt": "llm/integration.md" }, "name": "@radzor/api-key-auth", "tags": [ "api-key", "authentication", "middleware", "security", "auth" ], "events": [ { "name": "onValidated", "payload": { "keyId": "string", "prefix": "string" }, "description": "Fired when an API key is successfully validated." }, { "name": "onRevoked", "payload": { "keyId": "string" }, "description": "Fired when an API key is revoked." }, { "name": "onError", "payload": { "code": "string", "message": "string" }, "description": "Fired on auth error." } ], "inputs": [ { "name": "headerName", "type": "string", "required": false, "description": "HTTP header name for API key (default: 'x-api-key')" }, { "name": "prefix", "type": "string", "required": false, "description": "API key prefix (default: 'rz_')" } ], "radzor": "1.0.0", "actions": [ { "name": "generateKey", "params": [], "returns": "Promise<{ key: string; hash: string; keyId: string }>", "description": "Generate a new API key. Returns the raw key (shown once) and its hash for storage." }, { "name": "validateKey", "params": [ { "name": "key", "type": "string", "description": "Raw API key to validate." }, { "name": "storedHash", "type": "string", "description": "Stored hash to compare against." } ], "returns": "Promise<boolean>", "description": "Validate a raw API key against its stored hash." }, { "name": "hashKey", "params": [ { "name": "key", "type": "string", "description": "Raw API key to hash." } ], "returns": "string", "description": "Hash an API key for storage (SHA-256)." }, { "name": "revokeKey", "params": [ { "name": "keyId", "type": "string", "description": "ID of the key to revoke." } ], "returns": "Promise<void>", "description": "Revoke an API key by ID." } ], "outputs": [ { "name": "validationResult", "type": "{ valid: boolean; keyId: string | null }", "description": "Result of the API key validation check." } ], "runtime": "server", "version": "0.1.0", "category": "auth", "languages": [ "typescript", "python" ], "description": "API key authentication middleware. Generate, validate, hash, and revoke API keys.", "dependencies": { "packages": {} }, "composability": { "connectsTo": [ { "event": "onValidated", "description": "Log successful API key validations", "compatibleWith": [ "@radzor/event-tracker.action.track.eventName", "@radzor/log-aggregator.action.info.message" ] }, { "event": "onRevoked", "description": "Notify when API key is revoked", "compatibleWith": [ "@radzor/slack-bot.action.sendMessage.text", "@radzor/log-aggregator.action.warn.message" ] } ] } }

@radzor/api-key-auth

Install

Inputs

Outputs

Actions

Events

Composability

radzor.manifest.json

Version History