mirror of
https://github.com/mudler/LocalAI.git
synced 2026-06-04 23:06:22 -04:00
3a932a9803
* feat(distributed): NATS JWT auth, TLS/mTLS options, and e2e coverage Mint per-node NATS user JWTs at registration when LOCALAI_NATS_ACCOUNT_SEED is set, and connect workers with scoped credentials from the register response. Add optional LOCALAI_NATS_TLS_CA/CERT/KEY for private CA and mTLS alongside tls:// URLs, plus test-e2e-distributed and NatsJWT container e2e specs. Document JWT setup (nats-auth-setup.sh) and TLS env vars in distributed-mode. Assisted-by: Grok:grok grok-build Signed-off-by: Richard Palethorpe <io@richiejp.com> * fix(distributed): correct NATS JWT scoping and harden client auth The JWT-auth path added in 46467cc7 had several gaps that fail silently under LOCALAI_NATS_REQUIRE_AUTH: - Agent-worker minted JWTs did not allow the subjects the agent worker actually subscribes to (jobs.mcp-ci.new and nodes.<id>.backend.stop), so MCP-CI jobs and backend-stop session cleanup were silently dropped. Scope the agent permission set to those subjects. - NATS subscription permission violations were swallowed (Subscribe returned a live-but-dead subscription). Confirm subscriptions with a server round-trip so a denial surfaces synchronously, and log async permission errors. - The backend worker connected anonymously when given a JWT without its paired seed; reject the unpaired credential instead. - The documented service-user permissions in nats-auth-setup.sh omitted prefixcache.>, which the frontend publishes and subscribes; add it. Also: add a credential-provider hook to the messaging client (consumed by the follow-up credential-lifecycle change), drop the always-nil error from NatsMessagingOptions, run go mod tidy (jwt/v2 and nkeys are now direct), and gofmt the feature's files. Tests: an agent-JWT e2e spec that connects to the enforcing NATS server and exercises every subscription the agent worker makes, plus permission allow-list coverage unit tests. Assisted-by: Claude:claude-opus-4-8 [Claude Code] Signed-off-by: Richard Palethorpe <io@richiejp.com> * feat(distributed): acquire and auto-refresh worker NATS credentials Workers fetched NATS credentials once at startup, which broke two cases under JWT auth: a worker that registered while still pending admin approval never received a minted JWT (it connected unauthenticated and gave up), and a long-running worker's 24h JWT expired with no way to renew it. Introduce workerregistry.NATSCredentialManager, built on idempotent re-registration (the frontend preserves the node row and mints a fresh JWT each call): - Acquire re-registers through admin approval until the node is approved and credentials are minted (or returns the first success when auth is not required, preserving anonymous-NATS behavior). - RefreshLoop re-registers before the JWT expires (~75% of its lifetime), updating the credentials served to the connection. - Both are bounded (default 100 attempts / consecutive failures) and return an error on exhaustion, so an unapprovable or unrenewable worker exits non-zero and surfaces the problem instead of hanging or drifting toward an expired credential. The messaging client gains WithUserJWTProvider, fetching credentials on each (re)connect so the connection transparently adopts a refreshed JWT when the server expires the old one. RegisterFull exposes the approval status and full response; Register delegates to it. Both the backend worker and the agent worker are wired to this: explicit env credentials are used as-is, minted credentials are acquired-with-wait and refreshed, and a permanent refresh failure shuts the worker down so it restarts and re-acquires. Tests cover Acquire (wait-through-pending, bounded give-up, context cancel), RefreshLoop (refresh-before-expiry, bounded failure, no-expiry exit) and jwtExpiry decoding. Docs updated in distributed-mode.md. Assisted-by: Claude:claude-opus-4-8 [Claude Code] Signed-off-by: Richard Palethorpe <io@richiejp.com> --------- Signed-off-by: Richard Palethorpe <io@richiejp.com>
49 lines
1.9 KiB
Bash
Executable File
49 lines
1.9 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
# Generate NATS account + service user JWTs for LocalAI distributed mode.
|
|
#
|
|
# Requires: nsc (https://docs.nats.io/running-a-nats-service/configuration/securing_nats/auth_intro/nsc)
|
|
#
|
|
# Usage:
|
|
# ./scripts/nats-auth-setup.sh
|
|
#
|
|
# Outputs operator/account seeds and a service user JWT suitable for:
|
|
# LOCALAI_NATS_ACCOUNT_SEED
|
|
# LOCALAI_NATS_SERVICE_JWT
|
|
#
|
|
# Per-node worker JWTs are minted automatically by the frontend at registration
|
|
# when LOCALAI_NATS_ACCOUNT_SEED is set.
|
|
|
|
set -euo pipefail
|
|
|
|
if ! command -v nsc >/dev/null 2>&1; then
|
|
echo "nsc is required. Install from https://github.com/nats-io/nsc/releases" >&2
|
|
exit 1
|
|
fi
|
|
|
|
OPERATOR="${NATS_OPERATOR_NAME:-localai-operator}"
|
|
ACCOUNT="${NATS_ACCOUNT_NAME:-localai}"
|
|
SERVICE_USER="${NATS_SERVICE_USER:-localai-frontend}"
|
|
|
|
nsc add operator -n "$OPERATOR" --generate-signing-key
|
|
nsc add account -n "$ACCOUNT"
|
|
nsc add user -n "$SERVICE_USER" --account "$ACCOUNT"
|
|
|
|
# Broad publish for frontend control plane (tighten with custom claims in production).
|
|
nsc edit user -n "$SERVICE_USER" --account "$ACCOUNT" \
|
|
--allow-pub "nodes.>,gallery.>,agent.>,jobs.>,mcp.>,cache.>,prefixcache.>,finetune.>" \
|
|
--allow-sub "nodes.>,gallery.>,agent.>,jobs.>,mcp.>,cache.>,prefixcache.>,_INBOX.>"
|
|
|
|
KEYS_DIR="${NATS_KEYS_DIR:-./nats-keys}"
|
|
mkdir -p "$KEYS_DIR"
|
|
nsc generate creds -a "$ACCOUNT" -n "$SERVICE_USER" -o "$KEYS_DIR"
|
|
|
|
ACCOUNT_SEED=$(nsc describe account "$ACCOUNT" -o json | jq -r '.nats.private_key')
|
|
SERVICE_JWT=$(cat "$KEYS_DIR/${ACCOUNT}/${SERVICE_USER}.jwt" 2>/dev/null || cat "$KEYS_DIR/${SERVICE_USER}.jwt")
|
|
|
|
echo ""
|
|
echo "=== LocalAI NATS auth material ==="
|
|
echo "LOCALAI_NATS_ACCOUNT_SEED=${ACCOUNT_SEED}"
|
|
echo "LOCALAI_NATS_SERVICE_JWT=${SERVICE_JWT}"
|
|
echo ""
|
|
echo "Configure the NATS server with the generated operator/account JWTs under $KEYS_DIR"
|
|
echo "and set LOCALAI_NATS_REQUIRE_AUTH=true on frontends and workers in production." |