Krypto-Ticker
Krypto-Ticker
Abschnitt betitelt „Krypto-Ticker“Bauen Sie einen Echtzeit-Crypto-Ticker mit API-Schlüssel-Authentifizierung und WebSocket-Streaming. Dieses Tutorial demonstriert Token-basierte Sicherheit, Middleware-Konfiguration und prozessbasiertes WebSocket-Handling.
Überblick
Abschnitt betitelt „Überblick“- API-Schlüssel-Austausch — POST eines API-Schlüssels liefert ein HMAC-signiertes Bearer-Token
- Token-Middleware — Schützt WebSocket-Upgrades über den Token-Store
- WebSocket-Fan-Out — Ein Ticker-Prozess sendet an viele Verbindungs-Handler
- Statische Assets —
http.staticliefert den Browser-Client aus - SQLite — Speichert API-Schlüssel; ein Memory-Store trägt den Token-Store
Projektstruktur
Abschnitt betitelt „Projektstruktur“auth-ticker/├── wippy.lock└── src/ ├── _index.yaml ├── auth_token.lua ├── ws_ticker.lua ├── ws_handler.lua ├── ticker.lua ├── migrate.lua └── public/ └── index.htmlArchitektur
Abschnitt betitelt „Architektur“flowchart TB subgraph Clients Browser[Browser-Client] API[API-Client] end
subgraph "HTTP Layer" Server[http.server<br/>gateway :8081] Static[http.static<br/>public/]
subgraph "Public Router" CORS1[cors middleware] AuthEndpoint[auth_token<br/>POST /auth/token] end
subgraph "WS Router /ws" CORS2[cors middleware] TokenAuth[token_auth middleware] WSEndpoint[ws_ticker<br/>GET /ws/ticker] WSRelay[websocket_relay] end end
subgraph "Security Layer" TokenStore[security.token_store<br/>tokens] Policy[security.policy<br/>user_policy] MemStore[store.memory<br/>token_data] end
subgraph "Storage" DB[db.sql.sqlite<br/>auth.db] end
subgraph "Process Layer" Supervisor[process.supervisor<br/>processes] WSHandler[ws_handler<br/>per-connection] Ticker[ticker<br/>singleton] end
subgraph "External" CryptoAPI[Crypto Price API] end
%% Client-Verbindungen Browser -->|"GET /"| Static API -->|"POST /auth/token"| CORS1 Browser -->|"WS /ws/ticker"| CORS2
%% API-Flow CORS1 --> AuthEndpoint AuthEndpoint -->|validate| TokenStore AuthEndpoint -->|"issue token"| API
%% WS-Flow CORS2 --> TokenAuth TokenAuth -->|validate| TokenStore TokenAuth --> WSEndpoint WSEndpoint -->|spawn| Supervisor Supervisor --> WSHandler WSEndpoint --> WSRelay WSRelay <-->|"messages"| WSHandler
%% Token-Store-Abhängigkeiten MemStore --> TokenStore Policy -->|attached to token| TokenStore
%% Auth verwendet DB für API-Schlüssel AuthEndpoint -->|lookup API key| DB
%% Prozess-Kommunikation WSHandler -->|subscribe| Ticker Ticker -->|broadcast| WSHandler WSRelay <-->|"ws frames"| Browser
%% Extern Ticker -->|fetch prices| CryptoAPISicherheits-Flow
Abschnitt betitelt „Sicherheits-Flow“-
API-Schlüssel-Austausch: Client sendet API-Schlüssel per POST an
/auth/token. Handler validiert gegen Datenbank, erstellt einen Actor mit deruser_policyund stellt einen HMAC-signierten Token aus. -
Token-Authentifizierung: WebSocket-Verbindungen durchlaufen
token_authMiddleware, die den Bearer-Token validiert und den Sicherheitskontext (Actor + Policies) wiederherstellt. -
Prozess-Spawning: Der WebSocket-Endpunkt startet einen Handler-Prozess. Da der Token die
user_policyenthält, ist der Spawn autorisiert. -
Message-Routing: Die
websocket_relayMiddleware routet WebSocket-Frames an den Handler-Prozess als Nachrichten.
Konfiguration
Abschnitt betitelt „Konfiguration“Vollständige _index.yaml:
version: "1.0"namespace: app
entries: # Datenbank für API-Schlüssel - name: db kind: db.sql.sqlite file: "./data/auth.db" lifecycle: auto_start: true
# Token-Backing-Store - name: token_data kind: store.memory lifecycle: auto_start: true
# Token-Store mit HMAC-Signierung - name: tokens kind: security.token_store store: app:token_data token_length: 32 default_expiration: "1h" token_key: "demo-secret-key-change-in-production"
# Sicherheits-Policy für authentifizierte Benutzer - name: user_policy kind: security.policy policy: actions: "*" resources: "*" effect: allow groups: - user
# Prozess-Host - name: processes kind: process.host lifecycle: auto_start: true
# Datenbank-Migration - name: migrate kind: process.lua source: file://migrate.lua method: main modules: [sql, logger, crypto]
- name: migrate-service kind: process.service process: app:migrate host: app:processes lifecycle: auto_start: true
# Ticker-Broadcaster - name: ticker kind: process.lua source: file://ticker.lua method: main modules: [logger, time, json, crypto]
- name: ticker-service kind: process.service process: app:ticker host: app:processes lifecycle: auto_start: true
# WebSocket-Handler (pro Verbindung gestartet) - name: ws_handler kind: process.lua source: file://ws_handler.lua method: main modules: [logger, json]
# HTTP-Server - name: gateway kind: http.service addr: ":8081" lifecycle: auto_start: true
# Öffentlicher Router (ohne Auth) - name: public_router kind: http.router meta: server: app:gateway middleware: - cors options: cors.allow.origins: "*"
# WebSocket-Router (mit Auth) - name: ws_router kind: http.router meta: server: app:gateway prefix: /ws middleware: - cors - token_auth options: cors.allow.origins: "*" token_auth.store: "app:tokens" post_middleware: - websocket_relay post_options: wsrelay.allowed.origins: "*"
# Statische Dateien - name: public_fs kind: fs.directory directory: ./public
- name: static kind: http.static meta: server: app:gateway path: / fs: app:public_fs static_options: spa: true index: index.html
# Auth-Token-Austausch - name: auth_token kind: function.lua source: file://auth_token.lua method: handler modules: [http, sql, crypto, security, json]
- name: auth_token.endpoint kind: http.endpoint meta: router: app:public_router method: POST path: /auth/token func: app:auth_token
# WebSocket-Ticker-Endpunkt - name: ws_ticker kind: function.lua source: file://ws_ticker.lua method: handler modules: [http, json, security, logger]
- name: ws_ticker.endpoint kind: http.endpoint meta: router: app:ws_router method: GET path: /ticker func: app:ws_tickerFür Produktion verwenden Sie token_key_env um den HMAC-Schlüssel aus einer Umgebungsvariable zu lesen statt ihn hartzukodieren. Siehe Umgebungssystem.
Token-Austausch
Abschnitt betitelt „Token-Austausch“auth_token.lua - validiert API-Schlüssel und stellt HMAC-signierte Token aus:
local http = require("http")local sql = require("sql")local security = require("security")
local function handler() local req = http.request() local res = http.response()
local body, parse_err = req:body_json() if parse_err then res:set_status(http.STATUS.BAD_REQUEST) res:write_json({error = "invalid JSON"}) return end
local api_key = body.api_key if not api_key or #api_key == 0 then res:set_status(http.STATUS.BAD_REQUEST) res:write_json({error = "api_key required"}) return end
local db, db_err = sql.get("app:db") if db_err then res:set_status(http.STATUS.INTERNAL_ERROR) res:write_json({error = "database unavailable"}) return end
local rows, query_err = db:query( "SELECT user_id, role FROM api_keys WHERE api_key = ?", {api_key} ) db:release()
if query_err then res:set_status(http.STATUS.INTERNAL_ERROR) res:write_json({error = "lookup failed"}) return end if #rows == 0 then res:set_status(http.STATUS.UNAUTHORIZED) res:write_json({error = "invalid API key"}) return end
local user = rows[1]
-- Actor mit Benutzer-Identität erstellen local actor = security.new_actor("user:" .. user.user_id, { role = user.role, user_id = user.user_id })
-- user_policy an Scope anhängen local policy, _ = security.policy("app:user_policy") local scope = policy and security.new_scope({policy}) or security.new_scope()
-- HMAC-signierten Token ausstellen local store, store_err = security.token_store("app:tokens") if store_err then res:set_status(http.STATUS.INTERNAL_ERROR) res:write_json({error = "token store unavailable"}) return end
local token, token_err = store:create(actor, scope, { expiration = "1h", meta = {ip = req:remote_addr()} }) store:close()
if token_err then res:set_status(http.STATUS.INTERNAL_ERROR) res:write_json({error = "token creation failed"}) return end
res:write_json({ token = token, user_id = user.user_id, role = user.role, expires_in = 3600 })end
return { handler = handler }WebSocket-Endpunkt
Abschnitt betitelt „WebSocket-Endpunkt“ws_ticker.lua - startet einen Handler-Prozess für jede authentifizierte Verbindung:
local http = require("http")local json = require("json")local security = require("security")local logger = require("logger")
local function handler() local req = http.request() local res = http.response()
if req:method() ~= http.METHOD.GET then res:set_status(http.STATUS.METHOD_NOT_ALLOWED) res:write_json({error = "method not allowed"}) return end
-- Actor wird von token_auth Middleware gesetzt local actor = security.actor() if not actor then res:set_status(http.STATUS.UNAUTHORIZED) res:write_json({error = "authentication required"}) return end
local user_id = actor:id()
-- Handler-Prozess starten (autorisiert durch user_policy im Token) local pid, err = process.spawn("app:ws_handler", "app:processes", user_id) if err then logger:error("spawn failed", {error = tostring(err)}) res:set_status(http.STATUS.INTERNAL_ERROR) res:write_json({error = "failed to create handler"}) return end
-- websocket_relay konfigurieren um Nachrichten an Handler zu routen res:set_header("X-WS-Relay", json.encode({ target_pid = tostring(pid), metadata = {user_id = user_id, auth_time = os.time()} }))end
return { handler = handler }Verbindungs-Handler
Abschnitt betitelt „Verbindungs-Handler“Die websocket_relay Middleware sendet automatisch Lebenszyklus-Nachrichten an den Handler-Prozess:
ws.join- Verbindung hergestellt, enthältclient_pidzum Senden von Antwortenws.message- Client hat Nachricht gesendetws.leave- Verbindung geschlossen (wird automatisch bei Disconnect gesendet)
ws_handler.lua - behandelt diese Lebenszyklus-Nachrichten:
local logger = require("logger")local json = require("json")
local function main(user_id) local inbox = process.inbox() local client_pid = nil local subscribed = false
logger:info("handler started", {user_id = user_id})
while true do local msg, ok = inbox:receive() if not ok then break end
local topic = msg:topic() local data = msg:payload():data()
if topic == "ws.join" then client_pid = data.client_pid
-- Mit unserer PID für Crash-Monitoring abonnieren process.send("ticker", "subscribe", { client_pid = client_pid, handler_pid = process.pid() }) subscribed = true
-- Willkommen senden process.send(client_pid, "ws.send", { type = "text", data = json.encode({type = "welcome", user_id = user_id}) })
logger:info("client joined", {user_id = user_id, client_pid = client_pid})
elseif topic == "ws.message" then local content = json.decode(data.data) if content and content.type == "ping" then process.send(client_pid, "ws.send", { type = "text", data = json.encode({type = "pong"}) }) end
elseif topic == "ws.leave" then -- Relay sendet dies automatisch bei Disconnect logger:info("client left", {user_id = user_id, reason = data.reason}) if subscribed then process.send("ticker", "unsubscribe", {handler_pid = process.pid()}) end break end end
return 0end
return { main = main }Broadcasting
Abschnitt betitelt „Broadcasting“ticker.lua - verwaltet Subscriptions und broadcastet Preis-Updates:
local logger = require("logger")local time = require("time")local json = require("json")local crypto = require("crypto")
-- handler_pid -> client_pid Mappinglocal subscriptions = {}
local prices = { ["BTC-USD"] = 42000.00, ["ETH-USD"] = 2500.00, ["SOL-USD"] = 95.00}
local function broadcast(message) local data = json.encode(message) for _, client_pid in pairs(subscriptions) do process.send(client_pid, "ws.send", {type = "text", data = data}) endend
local function update_prices() for symbol, price in pairs(prices) do local bytes = crypto.random.bytes(2) local rand = (bytes:byte(1) * 256 + bytes:byte(2)) / 65535.0 local factor = (rand - 0.5) * 0.002 prices[symbol] = price * (1 + factor) prices[symbol] = tonumber(string.format("%.2f", prices[symbol])) endend
local function get_updates() local updates = {} for symbol, price in pairs(prices) do table.insert(updates, {symbol = symbol, price = price, timestamp = os.time()}) end return updatesend
local function main() local inbox = process.inbox() local events = process.events()
local ticker, ticker_err = time.ticker("1s") if ticker_err then logger:error("failed to create ticker", {error = tostring(ticker_err)}) return 1 end local tick_ch = ticker:response()
process.registry.register("ticker") logger:info("ticker started", {pid = process.pid()})
while true do local r = channel.select { inbox:case_receive(), events:case_receive(), tick_ch:case_receive() }
if r.channel == tick_ch then update_prices() if next(subscriptions) then broadcast({type = "ticker", data = get_updates()}) end
elseif r.channel == events then local event = r.value if event.kind == process.event.EXIT then -- Handler beendet, Subscription entfernen if subscriptions[event.from] then logger:info("handler exited", {handler_pid = event.from}) subscriptions[event.from] = nil end end
else local msg = r.value local topic = msg:topic() local data = msg:payload():data()
if topic == "subscribe" then local handler_pid = data.handler_pid local client_pid = data.client_pid
subscriptions[handler_pid] = client_pid process.monitor(handler_pid)
logger:info("subscribed", {handler_pid = handler_pid, client_pid = client_pid})
process.send(client_pid, "ws.send", { type = "text", data = json.encode({type = "ticker", data = get_updates()}) })
elseif topic == "unsubscribe" then subscriptions[data.handler_pid] = nil logger:info("unsubscribed", {handler_pid = data.handler_pid}) end end endend
return { main = main }Datenbank-Migration
Abschnitt betitelt „Datenbank-Migration“migrate.lua - erstellt die API-Schlüssel-Tabelle und generiert einen Demo-Schlüssel:
local sql = require("sql")local logger = require("logger")local crypto = require("crypto")
local function main() local db, err = sql.get("app:db") if err then logger:error("failed to connect", {error = tostring(err)}) return 1 end
local _, exec_err = db:execute([[ CREATE TABLE IF NOT EXISTS api_keys ( id INTEGER PRIMARY KEY AUTOINCREMENT, api_key TEXT UNIQUE NOT NULL, user_id TEXT NOT NULL, role TEXT NOT NULL DEFAULT 'user', created_at INTEGER NOT NULL ) ]])
if exec_err then db:release() logger:error("migration failed", {error = tostring(exec_err)}) return 1 end
-- Prüfen ob Demo-Schlüssel existiert local rows, _ = db:query("SELECT api_key FROM api_keys WHERE user_id = ?", {"demo"}) if #rows == 0 then local demo_key, key_err = crypto.random.string(32) if key_err then db:release() return 1 end
db:execute( "INSERT INTO api_keys (api_key, user_id, role, created_at) VALUES (?, ?, ?, ?)", {demo_key, "demo", "user", os.time()} ) logger:info("demo API key created", {api_key = demo_key}) else logger:info("demo API key exists", {api_key = rows[1].api_key}) end
db:release() return 0end
return { main = main }Ausführen
Abschnitt betitelt „Ausführen“wippy initwippy runÖffnen Sie http://localhost:8081 und geben Sie den Demo-API-Schlüssel ein, der in den Logs angezeigt wird.
Nächste Schritte
Abschnitt betitelt „Nächste Schritte“- WebSocket-Relay - Middleware-Konfiguration
- Sicherheits-Modul - Actors, Policies, Token-Stores
- Prozess-Verwaltung - Spawning und Messaging