Compare commits
2
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8085f39142 | ||
|
|
27f9866264 |
@@ -0,0 +1,20 @@
|
|||||||
|
package apiserver
|
||||||
|
|
||||||
|
import "context"
|
||||||
|
|
||||||
|
type contextKey int
|
||||||
|
|
||||||
|
const requestContextKey contextKey = iota
|
||||||
|
|
||||||
|
// RequestContext ist der Tenant-/Benutzerkontext, den die Middleware-Kette
|
||||||
|
// fuer nachgelagerte Handler bereitstellt (Akzeptanzkriterium 3).
|
||||||
|
type RequestContext struct {
|
||||||
|
UserID string
|
||||||
|
TenantSlug string
|
||||||
|
}
|
||||||
|
|
||||||
|
// FromContext liest den von der Middleware gesetzten Kontext.
|
||||||
|
func FromContext(ctx context.Context) (RequestContext, bool) {
|
||||||
|
rc, ok := ctx.Value(requestContextKey).(RequestContext)
|
||||||
|
return rc, ok
|
||||||
|
}
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
// Package apiserver implementiert Core API-01: das REST-Grundgerüst mit
|
||||||
|
// URL-Versionierung, einheitlichem Fehlerformat und Middleware-Kette
|
||||||
|
// (Auth, Tenant-/Benutzerkontext, Logging).
|
||||||
|
package apiserver
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"net/http"
|
||||||
|
)
|
||||||
|
|
||||||
|
// errorBody ist das EINE Fehlerschema fuer alle Endpunkte unter /api/{version}/
|
||||||
|
// (Akzeptanzkriterium 2).
|
||||||
|
type errorBody struct {
|
||||||
|
Error struct {
|
||||||
|
Code string `json:"code"`
|
||||||
|
Message string `json:"message"`
|
||||||
|
} `json:"error"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// WriteError schreibt einen Fehler im einheitlichen Schema. code ist ein
|
||||||
|
// stabiler, maschinenlesbarer Bezeichner (z.B. "unauthenticated"), message
|
||||||
|
// ein fuer Menschen lesbarer deutscher Text.
|
||||||
|
func WriteError(w http.ResponseWriter, status int, code, message string) {
|
||||||
|
var body errorBody
|
||||||
|
body.Error.Code = code
|
||||||
|
body.Error.Message = message
|
||||||
|
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
w.WriteHeader(status)
|
||||||
|
_ = json.NewEncoder(w).Encode(body)
|
||||||
|
}
|
||||||
@@ -0,0 +1,56 @@
|
|||||||
|
package apiserver
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"log/slog"
|
||||||
|
"net/http"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/internal/auth"
|
||||||
|
)
|
||||||
|
|
||||||
|
// authAndTenantContext prueft die Session (wiederverwendet auth.TokenIssuer.Verify
|
||||||
|
// aus IAM-02 — keine zweite JWT-Implementierung) und setzt bei Erfolg
|
||||||
|
// RequestContext fuer nachgelagerte Handler (Akzeptanzkriterium 3). Anders
|
||||||
|
// als auth.RequireAuth (Klartext-Fehler) antwortet diese Middleware im
|
||||||
|
// einheitlichen API-01-Fehlerschema (Akzeptanzkriterium 2), damit ALLE
|
||||||
|
// Endpunkte unter /api/{version}/ dasselbe Format liefern, auch bei
|
||||||
|
// Auth-Fehlern.
|
||||||
|
func authAndTenantContext(issuer *auth.TokenIssuer, next http.HandlerFunc) http.HandlerFunc {
|
||||||
|
return func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
cookie, err := r.Cookie(auth.CookieName)
|
||||||
|
if err != nil {
|
||||||
|
WriteError(w, http.StatusUnauthorized, "unauthenticated", "nicht angemeldet")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
claims, err := issuer.Verify(cookie.Value)
|
||||||
|
if err != nil {
|
||||||
|
WriteError(w, http.StatusUnauthorized, "unauthenticated", "nicht angemeldet")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
rc := RequestContext{UserID: claims.UserID, TenantSlug: claims.TenantSlug}
|
||||||
|
next(w, r.WithContext(context.WithValue(r.Context(), requestContextKey, rc)))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
type statusRecorder struct {
|
||||||
|
http.ResponseWriter
|
||||||
|
status int
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *statusRecorder) WriteHeader(code int) {
|
||||||
|
s.status = code
|
||||||
|
s.ResponseWriter.WriteHeader(code)
|
||||||
|
}
|
||||||
|
|
||||||
|
// loggingMiddleware protokolliert jede Anfrage strukturiert.
|
||||||
|
func loggingMiddleware(next http.HandlerFunc) http.HandlerFunc {
|
||||||
|
return func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
rec := &statusRecorder{ResponseWriter: w, status: http.StatusOK}
|
||||||
|
start := time.Now()
|
||||||
|
next(rec, r)
|
||||||
|
slog.Info("api-anfrage", "method", r.Method, "path", r.URL.Path, "status", rec.status, "dauer", time.Since(start))
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,49 @@
|
|||||||
|
package apiserver
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/internal/auth"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Server registriert versionierte API-Routen (Akzeptanzkriterium 1: unter
|
||||||
|
// /api/{version}/...) und verdrahtet fuer jede Route dieselbe Middleware-
|
||||||
|
// Kette (Logging -> Auth+Tenantkontext -> Handler).
|
||||||
|
type Server struct {
|
||||||
|
mux *http.ServeMux
|
||||||
|
issuer *auth.TokenIssuer
|
||||||
|
routes []string
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewServer(issuer *auth.TokenIssuer) *Server {
|
||||||
|
return &Server{mux: http.NewServeMux(), issuer: issuer}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Handle registriert pattern unter der angegebenen Version, z.B.
|
||||||
|
// Handle("v1", "/things", h) -> erreichbar unter /api/v1/things. Verschiedene
|
||||||
|
// Versionen sind unabhaengige Pfade — eine neue Version beeintraechtigt
|
||||||
|
// bestehende nicht (Akzeptanzkriterium 1 / Pruefung 3).
|
||||||
|
func (s *Server) Handle(version, pattern string, h http.HandlerFunc) {
|
||||||
|
full := "/api/" + version + pattern
|
||||||
|
s.routes = append(s.routes, full)
|
||||||
|
s.mux.HandleFunc(full, loggingMiddleware(authAndTenantContext(s.issuer, h)))
|
||||||
|
}
|
||||||
|
|
||||||
|
// RegisteredPaths liefert alle ueber Handle/HandleV1 tatsaechlich
|
||||||
|
// registrierten Pfade — die einzige Quelle der Wahrheit fuer den
|
||||||
|
// Drift-Abgleich mit dem OpenAPI-Dokument (API-04, siehe internal/openapi).
|
||||||
|
// Rein additive Buchfuehrung, keine Verhaltensaenderung von Handle.
|
||||||
|
func (s *Server) RegisteredPaths() []string {
|
||||||
|
out := make([]string, len(s.routes))
|
||||||
|
copy(out, s.routes)
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// HandleV1 ist die Kurzform fuer die aktuelle Hauptversion.
|
||||||
|
func (s *Server) HandleV1(pattern string, h http.HandlerFunc) {
|
||||||
|
s.Handle("v1", pattern, h)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Server) Handler() http.Handler {
|
||||||
|
return s.mux
|
||||||
|
}
|
||||||
@@ -0,0 +1,149 @@
|
|||||||
|
package apiserver
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/internal/auth"
|
||||||
|
)
|
||||||
|
|
||||||
|
func newTestServer() (*Server, *auth.TokenIssuer) {
|
||||||
|
issuer := auth.NewTokenIssuer("test-secret-nur-fuer-tests")
|
||||||
|
return NewServer(issuer), issuer
|
||||||
|
}
|
||||||
|
|
||||||
|
func withAuthCookie(req *http.Request, token string) *http.Request {
|
||||||
|
req.AddCookie(&http.Cookie{Name: auth.CookieName, Value: token})
|
||||||
|
return req
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 1: API unter versioniertem Pfad erreichbar.
|
||||||
|
func TestHandleV1_RegistersUnderVersionedPath(t *testing.T) {
|
||||||
|
srv, issuer := newTestServer()
|
||||||
|
srv.HandleV1("/things", func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
})
|
||||||
|
|
||||||
|
token, err := issuer.Issue("user-1", "acme")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("issue: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
req := withAuthCookie(httptest.NewRequest(http.MethodGet, "/api/v1/things", nil), token)
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
srv.Handler().ServeHTTP(rec, req)
|
||||||
|
if rec.Code != http.StatusOK {
|
||||||
|
t.Fatalf("status = %d, want 200", rec.Code)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 2 + Pruefung 1 (Stichprobe): mehrere Endpunkte liefern
|
||||||
|
// bei fehlerhafter Anfrage dasselbe Fehlerschema.
|
||||||
|
func TestErrorFormat_ConsistentAcrossEndpoints(t *testing.T) {
|
||||||
|
srv, _ := newTestServer()
|
||||||
|
srv.HandleV1("/endpunkt-a", func(w http.ResponseWriter, r *http.Request) { w.WriteHeader(http.StatusOK) })
|
||||||
|
srv.HandleV1("/endpunkt-b", func(w http.ResponseWriter, r *http.Request) { w.WriteHeader(http.StatusOK) })
|
||||||
|
|
||||||
|
for _, path := range []string{"/api/v1/endpunkt-a", "/api/v1/endpunkt-b"} {
|
||||||
|
req := httptest.NewRequest(http.MethodGet, path, nil) // ohne cookie -> 401
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
srv.Handler().ServeHTTP(rec, req)
|
||||||
|
|
||||||
|
if rec.Code != http.StatusUnauthorized {
|
||||||
|
t.Fatalf("%s: status = %d, want 401", path, rec.Code)
|
||||||
|
}
|
||||||
|
var body errorBody
|
||||||
|
if err := json.Unmarshal(rec.Body.Bytes(), &body); err != nil {
|
||||||
|
t.Fatalf("%s: fehlerantwort nicht im erwarteten json-schema: %v (body: %s)", path, err, rec.Body.String())
|
||||||
|
}
|
||||||
|
if body.Error.Code == "" || body.Error.Message == "" {
|
||||||
|
t.Fatalf("%s: erwartet nicht-leeren code/message, habe %+v", path, body)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 3 + Pruefung 2: Middleware-Kette setzt Tenant-/
|
||||||
|
// Benutzerkontext zuverlaessig, nachweislich fuer mehrere Endpunkte.
|
||||||
|
func TestMiddleware_SetsRequestContextForEveryEndpoint(t *testing.T) {
|
||||||
|
srv, issuer := newTestServer()
|
||||||
|
|
||||||
|
var gotA, gotB RequestContext
|
||||||
|
srv.HandleV1("/kontext-a", func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
gotA, _ = FromContext(r.Context())
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
})
|
||||||
|
srv.HandleV1("/kontext-b", func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
gotB, _ = FromContext(r.Context())
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
})
|
||||||
|
|
||||||
|
token, err := issuer.Issue("user-42", "tenant-x")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("issue: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
for path, got := range map[string]*RequestContext{"/api/v1/kontext-a": &gotA, "/api/v1/kontext-b": &gotB} {
|
||||||
|
req := withAuthCookie(httptest.NewRequest(http.MethodGet, path, nil), token)
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
srv.Handler().ServeHTTP(rec, req)
|
||||||
|
if rec.Code != http.StatusOK {
|
||||||
|
t.Fatalf("%s: status = %d, want 200", path, rec.Code)
|
||||||
|
}
|
||||||
|
if got.UserID != "user-42" || got.TenantSlug != "tenant-x" {
|
||||||
|
t.Fatalf("%s: request-context unerwartet: %+v", path, *got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 1 + Pruefung 3: eine neue v2-Route laesst sich anlegen,
|
||||||
|
// ohne v1 zu beeintraechtigen.
|
||||||
|
func TestVersioning_V2DoesNotAffectV1(t *testing.T) {
|
||||||
|
srv, issuer := newTestServer()
|
||||||
|
srv.HandleV1("/things", func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.Write([]byte("v1-antwort"))
|
||||||
|
})
|
||||||
|
srv.Handle("v2", "/things", func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.Write([]byte("v2-antwort"))
|
||||||
|
})
|
||||||
|
|
||||||
|
token, err := issuer.Issue("user-1", "acme")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("issue: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
reqV1 := withAuthCookie(httptest.NewRequest(http.MethodGet, "/api/v1/things", nil), token)
|
||||||
|
recV1 := httptest.NewRecorder()
|
||||||
|
srv.Handler().ServeHTTP(recV1, reqV1)
|
||||||
|
if recV1.Body.String() != "v1-antwort" {
|
||||||
|
t.Fatalf("v1 antwort = %q, want v1-antwort", recV1.Body.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
reqV2 := withAuthCookie(httptest.NewRequest(http.MethodGet, "/api/v2/things", nil), token)
|
||||||
|
recV2 := httptest.NewRecorder()
|
||||||
|
srv.Handler().ServeHTTP(recV2, reqV2)
|
||||||
|
if recV2.Body.String() != "v2-antwort" {
|
||||||
|
t.Fatalf("v2 antwort = %q, want v2-antwort", recV2.Body.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
// v1 nach dem Anlegen von v2 erneut pruefen — unveraendert.
|
||||||
|
reqV1Again := withAuthCookie(httptest.NewRequest(http.MethodGet, "/api/v1/things", nil), token)
|
||||||
|
recV1Again := httptest.NewRecorder()
|
||||||
|
srv.Handler().ServeHTTP(recV1Again, reqV1Again)
|
||||||
|
if recV1Again.Body.String() != "v1-antwort" {
|
||||||
|
t.Fatalf("v1 antwort nach v2-anlage = %q, want weiterhin v1-antwort", recV1Again.Body.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAuthAndTenantContext_RejectsInvalidToken(t *testing.T) {
|
||||||
|
srv, _ := newTestServer()
|
||||||
|
srv.HandleV1("/geschuetzt", func(w http.ResponseWriter, r *http.Request) { w.WriteHeader(http.StatusOK) })
|
||||||
|
|
||||||
|
req := withAuthCookie(httptest.NewRequest(http.MethodGet, "/api/v1/geschuetzt", nil), "kaputtes.token.hier")
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
srv.Handler().ServeHTTP(rec, req)
|
||||||
|
if rec.Code != http.StatusUnauthorized {
|
||||||
|
t.Fatalf("status = %d, want 401", rec.Code)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,42 @@
|
|||||||
|
package openapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
)
|
||||||
|
|
||||||
|
// DocumentHandler liefert das OpenAPI-Dokument als JSON — der Endpunkt, den
|
||||||
|
// Swagger UI/Postman/etc. importieren (Akzeptanzkriterium 3).
|
||||||
|
func DocumentHandler(doc Document) http.HandlerFunc {
|
||||||
|
return func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
_ = json.NewEncoder(w).Encode(doc)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// SwaggerUIHandler liefert eine minimale HTML-Seite, die Swagger UI ueber
|
||||||
|
// ein CDN laedt und gegen docURL rendert — Standardmuster fuer
|
||||||
|
// "in gaengigen Tools darstellbar" (Akzeptanzkriterium 3), ohne eine eigene
|
||||||
|
// Swagger-UI-Distribution einzubetten.
|
||||||
|
func SwaggerUIHandler(docURL string) http.HandlerFunc {
|
||||||
|
page := fmt.Sprintf(`<!doctype html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<title>NEXARCH Core API</title>
|
||||||
|
<link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist/swagger-ui.css" />
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="swagger-ui"></div>
|
||||||
|
<script src="https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js"></script>
|
||||||
|
<script>
|
||||||
|
window.onload = () => SwaggerUIBundle({ url: %q, dom_id: "#swagger-ui" });
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
</html>`, docURL)
|
||||||
|
|
||||||
|
return func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.Header().Set("Content-Type", "text/html; charset=utf-8")
|
||||||
|
_, _ = w.Write([]byte(page))
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,158 @@
|
|||||||
|
// Package openapi implementiert Core API-04: eine OpenAPI-3.x-Beschreibung
|
||||||
|
// der Core-API, die automatisiert gegen die tatsaechlich registrierten
|
||||||
|
// Routen von internal/apiserver.Server geprueft wird (Akzeptanzkriterium 2)
|
||||||
|
// — kein manuell gepflegtes Dokument, das unbemerkt vom Code abweichen kann.
|
||||||
|
package openapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"sort"
|
||||||
|
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/internal/apiserver"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Entry beschreibt EINEN dokumentierten Endpunkt inklusive eines
|
||||||
|
// Beispielaufrufs (Akzeptanzkriterium 2 / Pruefung 2: "Beispielaufrufe aus
|
||||||
|
// dem Dokument gegen die echte API erfolgreich ausgefuehrt").
|
||||||
|
type Entry struct {
|
||||||
|
// Path ist der VOLLSTAENDIGE, versionierte Pfad (z.B. "/api/v1/things"),
|
||||||
|
// identisch zu dem, was apiserver.Server.RegisteredPaths() liefert.
|
||||||
|
Path string
|
||||||
|
Method string
|
||||||
|
Summary string
|
||||||
|
Description string
|
||||||
|
// ExampleRequest wird von CheckExamples tatsaechlich gegen den Server
|
||||||
|
// ausgefuehrt (Cookie, Body etc. sind Sache des Aufrufers, siehe
|
||||||
|
// openapi_test.go) — dieses Paket fuehrt nur die HTTP-Anfrage aus und
|
||||||
|
// prueft ExpectStatus.
|
||||||
|
ExampleRequest ExampleRequest
|
||||||
|
ExpectStatus int
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExampleRequest ist minimal genug, um sowohl in das OpenAPI-Dokument als
|
||||||
|
// auch als tatsaechliche HTTP-Anfrage verwendet zu werden — EIN Beispiel,
|
||||||
|
// zwei Verwendungen, damit Dokument und Test nie auseinanderlaufen koennen.
|
||||||
|
type ExampleRequest struct {
|
||||||
|
Method string
|
||||||
|
Path string
|
||||||
|
Description string
|
||||||
|
}
|
||||||
|
|
||||||
|
// Document ist eine bewusst schlanke OpenAPI-3.0-Repraesentation — genug,
|
||||||
|
// um valide zu sein und von Swagger UI/Postman importiert zu werden
|
||||||
|
// (Akzeptanzkriterium 3), ohne eine vollstaendige OpenAPI-Bibliothek zu
|
||||||
|
// integrieren.
|
||||||
|
type Document struct {
|
||||||
|
OpenAPI string `json:"openapi"`
|
||||||
|
Info Info `json:"info"`
|
||||||
|
Paths map[string]PathItem `json:"paths"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type Info struct {
|
||||||
|
Title string `json:"title"`
|
||||||
|
Version string `json:"version"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type PathItem map[string]Operation
|
||||||
|
|
||||||
|
type Operation struct {
|
||||||
|
Summary string `json:"summary"`
|
||||||
|
Description string `json:"description,omitempty"`
|
||||||
|
Responses map[string]Response `json:"responses"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type Response struct {
|
||||||
|
Description string `json:"description"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// BuildDocument erzeugt das OpenAPI-Dokument AUS denselben Entries, die auch
|
||||||
|
// fuer den Drift-Abgleich (CheckNoDrift) und die Beispielausfuehrung
|
||||||
|
// (siehe openapi_test.go) verwendet werden — eine einzige Quelle statt
|
||||||
|
// eines separat gepflegten Dokuments.
|
||||||
|
func BuildDocument(title, version string, entries []Entry) Document {
|
||||||
|
paths := make(map[string]PathItem)
|
||||||
|
for _, e := range entries {
|
||||||
|
item, ok := paths[e.Path]
|
||||||
|
if !ok {
|
||||||
|
item = PathItem{}
|
||||||
|
}
|
||||||
|
item[toLowerMethod(e.Method)] = Operation{
|
||||||
|
Summary: e.Summary,
|
||||||
|
Description: e.Description,
|
||||||
|
Responses: map[string]Response{
|
||||||
|
fmt.Sprintf("%d", e.ExpectStatus): {Description: "Beispielhafte Antwort"},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
paths[e.Path] = item
|
||||||
|
}
|
||||||
|
return Document{
|
||||||
|
OpenAPI: "3.0.3",
|
||||||
|
Info: Info{Title: title, Version: version},
|
||||||
|
Paths: paths,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func toLowerMethod(m string) string {
|
||||||
|
switch m {
|
||||||
|
case "GET", "get":
|
||||||
|
return "get"
|
||||||
|
case "POST", "post":
|
||||||
|
return "post"
|
||||||
|
case "PUT", "put":
|
||||||
|
return "put"
|
||||||
|
case "DELETE", "delete":
|
||||||
|
return "delete"
|
||||||
|
case "PATCH", "patch":
|
||||||
|
return "patch"
|
||||||
|
default:
|
||||||
|
return "get"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ErrDrift wird von CheckNoDrift geliefert, wenn dokumentierte und
|
||||||
|
// tatsaechlich registrierte Pfade auseinanderlaufen (Akzeptanzkriterium 2 /
|
||||||
|
// Pruefung 1).
|
||||||
|
type ErrDrift struct {
|
||||||
|
MissingInDocument []string // registriert, aber nicht dokumentiert
|
||||||
|
MissingAsRoute []string // dokumentiert, aber nicht (mehr) registriert
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *ErrDrift) Error() string {
|
||||||
|
return fmt.Sprintf("openapi: drift erkannt — nicht dokumentiert: %v, nicht (mehr) registriert: %v",
|
||||||
|
e.MissingInDocument, e.MissingAsRoute)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CheckNoDrift vergleicht die tatsaechlich registrierten Pfade eines
|
||||||
|
// Servers mit den in entries dokumentierten Pfaden — vollstaendige
|
||||||
|
// Uebereinstimmung der PATH-Menge (nicht Methode je Pfad, da
|
||||||
|
// apiserver.Server.Handle methodenunabhaengig registriert). Ein absichtlich
|
||||||
|
// entfernter Eintrag auf beiden Seiten (siehe Tests) macht diese Funktion
|
||||||
|
// fehlschlagen, das ist der geforderte Drift-Nachweis.
|
||||||
|
func CheckNoDrift(server *apiserver.Server, entries []Entry) error {
|
||||||
|
registered := make(map[string]bool)
|
||||||
|
for _, p := range server.RegisteredPaths() {
|
||||||
|
registered[p] = true
|
||||||
|
}
|
||||||
|
documented := make(map[string]bool)
|
||||||
|
for _, e := range entries {
|
||||||
|
documented[e.Path] = true
|
||||||
|
}
|
||||||
|
|
||||||
|
var missingInDoc, missingAsRoute []string
|
||||||
|
for p := range registered {
|
||||||
|
if !documented[p] {
|
||||||
|
missingInDoc = append(missingInDoc, p)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for p := range documented {
|
||||||
|
if !registered[p] {
|
||||||
|
missingAsRoute = append(missingAsRoute, p)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(missingInDoc) == 0 && len(missingAsRoute) == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
sort.Strings(missingInDoc)
|
||||||
|
sort.Strings(missingAsRoute)
|
||||||
|
return &ErrDrift{MissingInDocument: missingInDoc, MissingAsRoute: missingAsRoute}
|
||||||
|
}
|
||||||
@@ -0,0 +1,142 @@
|
|||||||
|
package openapi
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/internal/apiserver"
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/internal/auth"
|
||||||
|
)
|
||||||
|
|
||||||
|
func newTestServerWithRoutes() (*apiserver.Server, *auth.TokenIssuer) {
|
||||||
|
issuer := auth.NewTokenIssuer("test-secret-nur-fuer-tests")
|
||||||
|
srv := apiserver.NewServer(issuer)
|
||||||
|
srv.HandleV1("/things", func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
})
|
||||||
|
srv.HandleV1("/other", func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
})
|
||||||
|
return srv, issuer
|
||||||
|
}
|
||||||
|
|
||||||
|
func testEntries() []Entry {
|
||||||
|
return []Entry{
|
||||||
|
{Path: "/api/v1/things", Method: "GET", Summary: "Dinge auflisten", ExpectStatus: http.StatusOK},
|
||||||
|
{Path: "/api/v1/other", Method: "GET", Summary: "Anderes abrufen", ExpectStatus: http.StatusOK},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 1: das Dokument deckt alle tatsaechlich registrierten
|
||||||
|
// Endpunkte ab.
|
||||||
|
func TestCheckNoDrift_PassesWhenDocumentMatchesRoutes(t *testing.T) {
|
||||||
|
srv, _ := newTestServerWithRoutes()
|
||||||
|
if err := CheckNoDrift(srv, testEntries()); err != nil {
|
||||||
|
t.Fatalf("erwartet keinen drift, habe: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 2 + Pruefung 1: automatisierter Abgleich schlaegt bei
|
||||||
|
// Drift fehl — hier absichtlich eine Route aus dem Dokument entfernt, waehrend
|
||||||
|
// der Server sie weiterhin registriert hat.
|
||||||
|
func TestCheckNoDrift_FailsWhenRouteMissingFromDocument(t *testing.T) {
|
||||||
|
srv, _ := newTestServerWithRoutes()
|
||||||
|
entries := []Entry{testEntries()[0]} // "/api/v1/other" absichtlich entfernt
|
||||||
|
|
||||||
|
err := CheckNoDrift(srv, entries)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("erwartet drift-fehler, da eine registrierte route nicht dokumentiert ist")
|
||||||
|
}
|
||||||
|
driftErr, ok := err.(*ErrDrift)
|
||||||
|
if !ok {
|
||||||
|
t.Fatalf("erwartet *ErrDrift, habe %T", err)
|
||||||
|
}
|
||||||
|
if len(driftErr.MissingInDocument) != 1 || driftErr.MissingInDocument[0] != "/api/v1/other" {
|
||||||
|
t.Fatalf("erwartet '/api/v1/other' als nicht dokumentiert, habe: %v", driftErr.MissingInDocument)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Symmetrischer Fall: Dokument nennt eine Route, die es beim Server gar
|
||||||
|
// nicht (mehr) gibt (z.B. nach Entfernen eines Endpunkts im Code).
|
||||||
|
func TestCheckNoDrift_FailsWhenDocumentedRouteNoLongerExists(t *testing.T) {
|
||||||
|
srv, _ := newTestServerWithRoutes()
|
||||||
|
entries := append(testEntries(), Entry{Path: "/api/v1/entfernt", Method: "GET", ExpectStatus: http.StatusOK})
|
||||||
|
|
||||||
|
err := CheckNoDrift(srv, entries)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("erwartet drift-fehler fuer dokumentierte, aber nicht registrierte route")
|
||||||
|
}
|
||||||
|
driftErr := err.(*ErrDrift)
|
||||||
|
if len(driftErr.MissingAsRoute) != 1 || driftErr.MissingAsRoute[0] != "/api/v1/entfernt" {
|
||||||
|
t.Fatalf("erwartet '/api/v1/entfernt' als nicht (mehr) registriert, habe: %v", driftErr.MissingAsRoute)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 2 + Pruefung 2: Beispielaufrufe aus dem Dokument
|
||||||
|
// werden GEGEN DIE ECHTE API (httptest, echte Middleware-Kette) ausgefuehrt.
|
||||||
|
func TestExamples_ExecuteSuccessfullyAgainstRealServer(t *testing.T) {
|
||||||
|
srv, issuer := newTestServerWithRoutes()
|
||||||
|
token, err := issuer.Issue("user-1", "acme")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("issue: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, e := range testEntries() {
|
||||||
|
req := httptest.NewRequest(e.Method, e.Path, nil)
|
||||||
|
req.AddCookie(&http.Cookie{Name: auth.CookieName, Value: token})
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
srv.Handler().ServeHTTP(rec, req)
|
||||||
|
|
||||||
|
if rec.Code != e.ExpectStatus {
|
||||||
|
t.Fatalf("beispielaufruf %s %s: status = %d, want %d", e.Method, e.Path, rec.Code, e.ExpectStatus)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 3: Dokument ist ueber einen Endpunkt abrufbar und
|
||||||
|
// valides JSON, das Tools wie Swagger UI importieren koennen.
|
||||||
|
func TestDocumentHandler_ServesValidJSONWithAllPaths(t *testing.T) {
|
||||||
|
doc := BuildDocument("NEXARCH Core API", "v1", testEntries())
|
||||||
|
|
||||||
|
req := httptest.NewRequest(http.MethodGet, "/api/v1/openapi.json", nil)
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
DocumentHandler(doc)(rec, req)
|
||||||
|
|
||||||
|
if rec.Code != http.StatusOK {
|
||||||
|
t.Fatalf("status = %d, want 200", rec.Code)
|
||||||
|
}
|
||||||
|
|
||||||
|
var decoded Document
|
||||||
|
if err := json.Unmarshal(rec.Body.Bytes(), &decoded); err != nil {
|
||||||
|
t.Fatalf("dokument nicht als json lesbar: %v", err)
|
||||||
|
}
|
||||||
|
if decoded.OpenAPI == "" {
|
||||||
|
t.Fatal("erwartet gesetztes openapi-versionsfeld")
|
||||||
|
}
|
||||||
|
for _, e := range testEntries() {
|
||||||
|
if _, ok := decoded.Paths[e.Path]; !ok {
|
||||||
|
t.Fatalf("pfad %s fehlt im dekodierten dokument", e.Path)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSwaggerUIHandler_ServesHTMLReferencingDocumentURL(t *testing.T) {
|
||||||
|
req := httptest.NewRequest(http.MethodGet, "/api/v1/docs", nil)
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
SwaggerUIHandler("/api/v1/openapi.json")(rec, req)
|
||||||
|
|
||||||
|
if rec.Code != http.StatusOK {
|
||||||
|
t.Fatalf("status = %d, want 200", rec.Code)
|
||||||
|
}
|
||||||
|
ct := rec.Header().Get("Content-Type")
|
||||||
|
if ct == "" {
|
||||||
|
t.Fatal("erwartet gesetzten Content-Type-Header")
|
||||||
|
}
|
||||||
|
body := rec.Body.String()
|
||||||
|
if !strings.Contains(body, "/api/v1/openapi.json") {
|
||||||
|
t.Fatal("erwartet referenz auf das openapi-dokument in der swagger-ui-seite")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,151 +0,0 @@
|
|||||||
// Package serviceaccount implementiert Core IAM-09: Service-Accounts als
|
|
||||||
// eigenstaendige Identitaeten (getrennt von menschlichen Benutzern, siehe
|
|
||||||
// internal/user) sowie API-Token mit Scopes und optionaler Ablaufzeit zur
|
|
||||||
// programmatischen Authentifizierung.
|
|
||||||
package serviceaccount
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"crypto/rand"
|
|
||||||
"crypto/sha256"
|
|
||||||
"encoding/hex"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5"
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
ErrTokenInvalid = errors.New("serviceaccount: token ungueltig, widerrufen oder abgelaufen")
|
|
||||||
ErrScopeInsufficient = errors.New("serviceaccount: token hat nicht den erforderlichen scope")
|
|
||||||
ErrServiceAccountNotFound = errors.New("serviceaccount: nicht gefunden")
|
|
||||||
)
|
|
||||||
|
|
||||||
type ServiceAccount struct {
|
|
||||||
ID string
|
|
||||||
Name string
|
|
||||||
}
|
|
||||||
|
|
||||||
type Token struct {
|
|
||||||
ID string
|
|
||||||
ServiceAccountID string
|
|
||||||
Scopes []string
|
|
||||||
ExpiresAt *time.Time
|
|
||||||
}
|
|
||||||
|
|
||||||
type Store struct {
|
|
||||||
pool *pgxpool.Pool
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewStore(pool *pgxpool.Pool) *Store {
|
|
||||||
return &Store{pool: pool}
|
|
||||||
}
|
|
||||||
|
|
||||||
// CreateServiceAccount legt eine neue, eigenstaendige Identitaet an
|
|
||||||
// (Akzeptanzkriterium 1) — lebt in service_accounts, nicht in users.
|
|
||||||
func (s *Store) CreateServiceAccount(ctx context.Context, name string) (ServiceAccount, error) {
|
|
||||||
if name == "" {
|
|
||||||
return ServiceAccount{}, errors.New("serviceaccount: name darf nicht leer sein")
|
|
||||||
}
|
|
||||||
var sa ServiceAccount
|
|
||||||
sa.Name = name
|
|
||||||
if err := s.pool.QueryRow(ctx, `
|
|
||||||
INSERT INTO service_accounts (name) VALUES ($1) RETURNING id
|
|
||||||
`, name).Scan(&sa.ID); err != nil {
|
|
||||||
return ServiceAccount{}, fmt.Errorf("service-account anlegen: %w", err)
|
|
||||||
}
|
|
||||||
return sa, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// IssueToken erzeugt ein neues API-Token fuer einen Service-Account.
|
|
||||||
// scopes beschraenkt, wofuer das Token verwendet werden darf; ttl ist
|
|
||||||
// optional (nil = kein Ablauf) — beides Akzeptanzkriterium 2. Der
|
|
||||||
// Klartext-Token wird NUR hier zurueckgegeben, gespeichert wird ausschliesslich
|
|
||||||
// der Hash (Akzeptanzkriterium 1 / Pruefung 1).
|
|
||||||
func (s *Store) IssueToken(ctx context.Context, serviceAccountID string, scopes []string, ttl *time.Duration) (id, plaintext string, err error) {
|
|
||||||
plaintext, err = randomToken()
|
|
||||||
if err != nil {
|
|
||||||
return "", "", fmt.Errorf("token erzeugen: %w", err)
|
|
||||||
}
|
|
||||||
hash := hashToken(plaintext)
|
|
||||||
if scopes == nil {
|
|
||||||
scopes = []string{}
|
|
||||||
}
|
|
||||||
|
|
||||||
var expiresAt *time.Time
|
|
||||||
if ttl != nil {
|
|
||||||
t := time.Now().Add(*ttl)
|
|
||||||
expiresAt = &t
|
|
||||||
}
|
|
||||||
|
|
||||||
err = s.pool.QueryRow(ctx, `
|
|
||||||
INSERT INTO api_tokens (service_account_id, token_hash, scopes, expires_at)
|
|
||||||
VALUES ($1, $2, $3, $4)
|
|
||||||
RETURNING id
|
|
||||||
`, serviceAccountID, hash, scopes, expiresAt).Scan(&id)
|
|
||||||
if err != nil {
|
|
||||||
return "", "", fmt.Errorf("token speichern: %w", err)
|
|
||||||
}
|
|
||||||
return id, plaintext, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Verify prueft ein Token gegen einen benoetigten Scope. Widerruf und Ablauf
|
|
||||||
// werden bei JEDEM Aufruf direkt gegen die Datenbank geprueft — es gibt
|
|
||||||
// keinen Cache, ein widerrufenes Token wird beim naechsten Request sofort
|
|
||||||
// abgewiesen (Akzeptanzkriterium 3). requiredScope == "" ueberspringt die
|
|
||||||
// Scope-Pruefung.
|
|
||||||
func (s *Store) Verify(ctx context.Context, tokenString, requiredScope string) (Token, error) {
|
|
||||||
hash := hashToken(tokenString)
|
|
||||||
|
|
||||||
var tok Token
|
|
||||||
err := s.pool.QueryRow(ctx, `
|
|
||||||
SELECT id, service_account_id, scopes, expires_at
|
|
||||||
FROM api_tokens
|
|
||||||
WHERE token_hash = $1 AND revoked_at IS NULL AND (expires_at IS NULL OR expires_at > now())
|
|
||||||
`, hash).Scan(&tok.ID, &tok.ServiceAccountID, &tok.Scopes, &tok.ExpiresAt)
|
|
||||||
if err != nil {
|
|
||||||
if errors.Is(err, pgx.ErrNoRows) {
|
|
||||||
return Token{}, ErrTokenInvalid
|
|
||||||
}
|
|
||||||
return Token{}, fmt.Errorf("token pruefen: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if requiredScope != "" && !hasScope(tok.Scopes, requiredScope) {
|
|
||||||
return Token{}, ErrScopeInsufficient
|
|
||||||
}
|
|
||||||
return tok, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Revoke widerruft ein Token sofort — Verify schlaegt ab dem naechsten
|
|
||||||
// Aufruf fehl (Akzeptanzkriterium 3 / Pruefung 2).
|
|
||||||
func (s *Store) Revoke(ctx context.Context, tokenID string) error {
|
|
||||||
_, err := s.pool.Exec(ctx, `UPDATE api_tokens SET revoked_at = now() WHERE id = $1`, tokenID)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("token widerrufen: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func hasScope(scopes []string, want string) bool {
|
|
||||||
for _, s := range scopes {
|
|
||||||
if s == want {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
func randomToken() (string, error) {
|
|
||||||
buf := make([]byte, 32)
|
|
||||||
if _, err := rand.Read(buf); err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
return hex.EncodeToString(buf), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func hashToken(token string) []byte {
|
|
||||||
sum := sha256.Sum256([]byte(token))
|
|
||||||
return sum[:]
|
|
||||||
}
|
|
||||||
@@ -1,163 +0,0 @@
|
|||||||
package serviceaccount
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"os"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
func setupTest(t *testing.T) (*Store, *pgxpool.Pool, func()) {
|
|
||||||
t.Helper()
|
|
||||||
adminDSN := os.Getenv("TEST_ADMIN_DSN")
|
|
||||||
if adminDSN == "" {
|
|
||||||
t.Skip("TEST_ADMIN_DSN nicht gesetzt, Integrationstest uebersprungen")
|
|
||||||
}
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
pool, err := pgxpool.New(ctx, adminDSN)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("pool: %v", err)
|
|
||||||
}
|
|
||||||
if _, err := pool.Exec(ctx, `
|
|
||||||
CREATE TABLE IF NOT EXISTS service_accounts (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(), name TEXT NOT NULL,
|
|
||||||
status TEXT NOT NULL DEFAULT 'active', created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
CREATE TABLE IF NOT EXISTS api_tokens (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(), service_account_id UUID NOT NULL REFERENCES service_accounts(id),
|
|
||||||
token_hash BYTEA NOT NULL UNIQUE, scopes TEXT[] NOT NULL DEFAULT '{}',
|
|
||||||
expires_at TIMESTAMPTZ, revoked_at TIMESTAMPTZ, created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
`); err != nil {
|
|
||||||
t.Fatalf("schema: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
cleanup := func() { pool.Close() }
|
|
||||||
return NewStore(pool), pool, cleanup
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 1: Service-Account anlegen, eigenes gehashtes Token erhalten.
|
|
||||||
// Akzeptanzkriterium 1 + Pruefung 1: Token ausschliesslich gehasht gespeichert.
|
|
||||||
func TestIssueToken_StoresOnlyHash(t *testing.T) {
|
|
||||||
store, pool, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
sa, err := store.CreateServiceAccount(ctx, "ci-pipeline")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("create service account: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
tokenID, plaintext, err := store.IssueToken(ctx, sa.ID, []string{"read"}, nil)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("issue token: %v", err)
|
|
||||||
}
|
|
||||||
if plaintext == "" {
|
|
||||||
t.Fatal("erwartet nicht-leeren klartext-token")
|
|
||||||
}
|
|
||||||
|
|
||||||
var storedHash []byte
|
|
||||||
if err := pool.QueryRow(ctx, `SELECT token_hash FROM api_tokens WHERE id = $1`, tokenID).Scan(&storedHash); err != nil {
|
|
||||||
t.Fatalf("hash lesen: %v", err)
|
|
||||||
}
|
|
||||||
if string(storedHash) == plaintext {
|
|
||||||
t.Fatal("token_hash enthaelt den klartext-token — verstoss gegen akzeptanzkriterium 1")
|
|
||||||
}
|
|
||||||
if len(storedHash) != 32 { // sha256
|
|
||||||
t.Fatalf("erwartet 32-byte sha256-hash, habe %d bytes", len(storedHash))
|
|
||||||
}
|
|
||||||
|
|
||||||
tok, err := store.Verify(ctx, plaintext, "")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("verify: %v", err)
|
|
||||||
}
|
|
||||||
if tok.ServiceAccountID != sa.ID {
|
|
||||||
t.Fatalf("service account id = %q, want %q", tok.ServiceAccountID, sa.ID)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 2 + Pruefung 3: Scope-Verletzung wird abgewiesen.
|
|
||||||
func TestVerify_RejectsInsufficientScope(t *testing.T) {
|
|
||||||
store, _, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
sa, err := store.CreateServiceAccount(ctx, "readonly-bot")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("create service account: %v", err)
|
|
||||||
}
|
|
||||||
_, plaintext, err := store.IssueToken(ctx, sa.ID, []string{"read"}, nil)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("issue token: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if _, err := store.Verify(ctx, plaintext, "read"); err != nil {
|
|
||||||
t.Fatalf("erwartet erfolg fuer passenden scope: %v", err)
|
|
||||||
}
|
|
||||||
if _, err := store.Verify(ctx, plaintext, "write"); !errors.Is(err, ErrScopeInsufficient) {
|
|
||||||
t.Fatalf("erwartet ErrScopeInsufficient fuer fehlenden scope, habe %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 2: optionale zeitliche Befristung wird durchgesetzt.
|
|
||||||
func TestVerify_RejectsExpiredToken(t *testing.T) {
|
|
||||||
store, _, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
sa, err := store.CreateServiceAccount(ctx, "temp-bot")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("create service account: %v", err)
|
|
||||||
}
|
|
||||||
ttl := -1 * time.Second // sofort abgelaufen
|
|
||||||
_, plaintext, err := store.IssueToken(ctx, sa.ID, nil, &ttl)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("issue token: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if _, err := store.Verify(ctx, plaintext, ""); !errors.Is(err, ErrTokenInvalid) {
|
|
||||||
t.Fatalf("erwartet ErrTokenInvalid bei abgelaufenem token, habe %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 3 + Pruefung 2: widerrufenes Token wird sofort abgewiesen.
|
|
||||||
func TestRevoke_TakesEffectImmediately(t *testing.T) {
|
|
||||||
store, _, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
sa, err := store.CreateServiceAccount(ctx, "revoke-bot")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("create service account: %v", err)
|
|
||||||
}
|
|
||||||
tokenID, plaintext, err := store.IssueToken(ctx, sa.ID, nil, nil)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("issue token: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if _, err := store.Verify(ctx, plaintext, ""); err != nil {
|
|
||||||
t.Fatalf("verify vor widerruf: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := store.Revoke(ctx, tokenID); err != nil {
|
|
||||||
t.Fatalf("revoke: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if _, err := store.Verify(ctx, plaintext, ""); !errors.Is(err, ErrTokenInvalid) {
|
|
||||||
t.Fatalf("erwartet ErrTokenInvalid sofort nach widerruf, habe %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestVerify_RejectsUnknownToken(t *testing.T) {
|
|
||||||
store, _, cleanup := setupTest(t)
|
|
||||||
defer cleanup()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
if _, err := store.Verify(ctx, "niemals-ausgestelltes-token", ""); !errors.Is(err, ErrTokenInvalid) {
|
|
||||||
t.Fatalf("erwartet ErrTokenInvalid, habe %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,2 +0,0 @@
|
|||||||
DROP TABLE IF EXISTS api_tokens;
|
|
||||||
DROP TABLE IF EXISTS service_accounts;
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
-- Service-Accounts & API-Token (IAM-09, siehe core-kanban/tickets/IAM-09.md).
|
|
||||||
-- Service-Accounts sind eine eigenstaendige Identitaetsklasse neben
|
|
||||||
-- menschlichen Benutzern (users), nicht dieselbe Tabelle (Zitadel-Vorbild).
|
|
||||||
CREATE TABLE service_accounts (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
||||||
name TEXT NOT NULL,
|
|
||||||
status TEXT NOT NULL DEFAULT 'active',
|
|
||||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
|
|
||||||
-- token_hash enthaelt NIEMALS den Klartext-Token, nur dessen SHA-256-Hash.
|
|
||||||
CREATE TABLE api_tokens (
|
|
||||||
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
||||||
service_account_id UUID NOT NULL REFERENCES service_accounts(id),
|
|
||||||
token_hash BYTEA NOT NULL UNIQUE,
|
|
||||||
scopes TEXT[] NOT NULL DEFAULT '{}',
|
|
||||||
expires_at TIMESTAMPTZ,
|
|
||||||
revoked_at TIMESTAMPTZ,
|
|
||||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
);
|
|
||||||
@@ -1,11 +1,16 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
set -euo pipefail
|
set -euo pipefail
|
||||||
|
|
||||||
PASS="${NEXARCH_TEST_DB_PASSWORD:?Setze NEXARCH_TEST_DB_PASSWORD vor dem Aufruf}"
|
PASS="${NEXARCH_TEST_DB_PASSWORD:?Setze NEXARCH_TEST_DB_PASSWORD vor dem Aufruf}"
|
||||||
ROLE="nexarch_test"
|
ROLE="nexarch_test"
|
||||||
|
|
||||||
export PGPASSWORD="$PASS"
|
export PGPASSWORD="$PASS"
|
||||||
|
|
||||||
psql -h localhost -U "$ROLE" -d postgres -v ON_ERROR_STOP=1 -c "DROP TABLE IF EXISTS tenants CASCADE;"
|
psql -h localhost -U "$ROLE" -d postgres -v ON_ERROR_STOP=1 -c "DROP TABLE IF EXISTS tenants CASCADE;"
|
||||||
|
|
||||||
dbs=$(psql -h localhost -U "$ROLE" -d postgres -tAc "SELECT datname FROM pg_database WHERE datname LIKE 'tenant\_%' ESCAPE '\'")
|
dbs=$(psql -h localhost -U "$ROLE" -d postgres -tAc "SELECT datname FROM pg_database WHERE datname LIKE 'tenant\_%' ESCAPE '\'")
|
||||||
for db in $dbs; do
|
for db in $dbs; do
|
||||||
psql -h localhost -U "$ROLE" -d postgres -v ON_ERROR_STOP=1 -c "DROP DATABASE IF EXISTS \"${db}\";"
|
psql -h localhost -U "$ROLE" -d postgres -v ON_ERROR_STOP=1 -c "DROP DATABASE IF EXISTS \"${db}\";"
|
||||||
done
|
done
|
||||||
|
|
||||||
echo "Testumgebung zurueckgesetzt: registry-tabelle + $(echo "$dbs" | grep -c . || true) tenant-datenbank(en) entfernt."
|
echo "Testumgebung zurueckgesetzt: registry-tabelle + $(echo "$dbs" | grep -c . || true) tenant-datenbank(en) entfernt."
|
||||||
|
|||||||
@@ -1,12 +1,18 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
set -euo pipefail
|
set -euo pipefail
|
||||||
|
|
||||||
PASS="${NEXARCH_TEST_DB_PASSWORD:?Setze NEXARCH_TEST_DB_PASSWORD vor dem Aufruf}"
|
PASS="${NEXARCH_TEST_DB_PASSWORD:?Setze NEXARCH_TEST_DB_PASSWORD vor dem Aufruf}"
|
||||||
cd "$(dirname "$0")/.."
|
cd "$(dirname "$0")/.."
|
||||||
|
|
||||||
NEXARCH_TEST_DB_PASSWORD="$PASS" bash scripts/reset-test-env.sh
|
NEXARCH_TEST_DB_PASSWORD="$PASS" bash scripts/reset-test-env.sh
|
||||||
|
|
||||||
export TEST_ADMIN_DSN="postgresql://nexarch_test:${PASS}@localhost:5432/postgres?sslmode=disable"
|
export TEST_ADMIN_DSN="postgresql://nexarch_test:${PASS}@localhost:5432/postgres?sslmode=disable"
|
||||||
|
|
||||||
echo "== go build =="
|
echo "== go build =="
|
||||||
go build ./...
|
go build ./...
|
||||||
|
|
||||||
echo "== go vet =="
|
echo "== go vet =="
|
||||||
go vet ./...
|
go vet ./...
|
||||||
|
|
||||||
echo "== go test (-p 1) =="
|
echo "== go test (-p 1) =="
|
||||||
go test ./... -p 1 -count=1
|
go test ./... -p 1 -count=1
|
||||||
|
|||||||
Reference in New Issue
Block a user