Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8085f39142 |
@@ -1,40 +0,0 @@
|
|||||||
// secheaders-devserver dient der manuellen/e2e-Verifikation von API-08
|
|
||||||
// (Pruefung 2: CSP blockiert Inline-Script) mit einem echten Browser.
|
|
||||||
// Zwei Pfade: /protected (mit Middleware) und /unprotected (ohne) — beide
|
|
||||||
// liefern dieselbe Seite mit einem Inline-Script, das ein DOM-Element
|
|
||||||
// aendert. Ein echter Browser zeigt den Unterschied.
|
|
||||||
package main
|
|
||||||
|
|
||||||
import (
|
|
||||||
"log"
|
|
||||||
"net/http"
|
|
||||||
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/internal/secheaders"
|
|
||||||
)
|
|
||||||
|
|
||||||
const page = `<!doctype html>
|
|
||||||
<html><body>
|
|
||||||
<div id="marker">BLOCKED</div>
|
|
||||||
<script>document.getElementById('marker').textContent = 'INLINE_RAN';</script>
|
|
||||||
</body></html>`
|
|
||||||
|
|
||||||
func servePage(w http.ResponseWriter, r *http.Request) {
|
|
||||||
w.Header().Set("Content-Type", "text/html; charset=utf-8")
|
|
||||||
_, _ = w.Write([]byte(page))
|
|
||||||
}
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
cfg := secheaders.DefaultConfig()
|
|
||||||
mux := http.NewServeMux()
|
|
||||||
// SetHeaders statt Middleware: dieser lokale Demo-Server laeuft ohne
|
|
||||||
// TLS-Terminierung, der HTTPS-Redirect-Teil von Middleware wuerde hier
|
|
||||||
// in eine Endlosschleife fuehren (siehe secheaders.go-Dokumentation).
|
|
||||||
mux.HandleFunc("/protected", func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
secheaders.SetHeaders(cfg, w)
|
|
||||||
servePage(w, r)
|
|
||||||
})
|
|
||||||
mux.HandleFunc("/unprotected", servePage)
|
|
||||||
|
|
||||||
log.Println("secheaders-devserver listening on :8086")
|
|
||||||
log.Fatal(http.ListenAndServe(":8086", mux))
|
|
||||||
}
|
|
||||||
@@ -12,6 +12,7 @@ import (
|
|||||||
type Server struct {
|
type Server struct {
|
||||||
mux *http.ServeMux
|
mux *http.ServeMux
|
||||||
issuer *auth.TokenIssuer
|
issuer *auth.TokenIssuer
|
||||||
|
routes []string
|
||||||
}
|
}
|
||||||
|
|
||||||
func NewServer(issuer *auth.TokenIssuer) *Server {
|
func NewServer(issuer *auth.TokenIssuer) *Server {
|
||||||
@@ -24,9 +25,20 @@ func NewServer(issuer *auth.TokenIssuer) *Server {
|
|||||||
// bestehende nicht (Akzeptanzkriterium 1 / Pruefung 3).
|
// bestehende nicht (Akzeptanzkriterium 1 / Pruefung 3).
|
||||||
func (s *Server) Handle(version, pattern string, h http.HandlerFunc) {
|
func (s *Server) Handle(version, pattern string, h http.HandlerFunc) {
|
||||||
full := "/api/" + version + pattern
|
full := "/api/" + version + pattern
|
||||||
|
s.routes = append(s.routes, full)
|
||||||
s.mux.HandleFunc(full, loggingMiddleware(authAndTenantContext(s.issuer, h)))
|
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.
|
// HandleV1 ist die Kurzform fuer die aktuelle Hauptversion.
|
||||||
func (s *Server) HandleV1(pattern string, h http.HandlerFunc) {
|
func (s *Server) HandleV1(pattern string, h http.HandlerFunc) {
|
||||||
s.Handle("v1", pattern, h)
|
s.Handle("v1", pattern, h)
|
||||||
|
|||||||
@@ -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,126 +0,0 @@
|
|||||||
// Package secheaders implementiert Core API-08: eine gemeinsame
|
|
||||||
// Security-Header-Middleware/Bibliothek, die jedes Modul-Frontend (DMS,
|
|
||||||
// Mail, Workflow, AI, Connect) einbindet, statt Header pro Modul erneut zu
|
|
||||||
// definieren (Akzeptanzkriterium 3) — dieselbe Konsolidierungslogik wie
|
|
||||||
// beim zentralen Rate-Limiting (API-03). Die tatsaechliche EINBINDUNG in
|
|
||||||
// jedes einzelne Modul-Frontend ist ausdruecklich NICHT Teil dieser Kachel
|
|
||||||
// (siehe Ticket "Nicht Bestandteil").
|
|
||||||
package secheaders
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"net/http"
|
|
||||||
"strings"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Config ist die Baseline-Konfiguration. DefaultConfig() liefert einen
|
|
||||||
// Ausgangspunkt OHNE 'unsafe-inline'/'unsafe-eval' (Akzeptanzkriterium 1)
|
|
||||||
// und mit angemessener HSTS-Laufzeit (Akzeptanzkriterium 2).
|
|
||||||
type Config struct {
|
|
||||||
// ContentSecurityPolicy wird unveraendert als Header-Wert gesendet.
|
|
||||||
ContentSecurityPolicy string
|
|
||||||
// HSTSMaxAge bestimmt die Gueltigkeitsdauer, die Browser sich merken.
|
|
||||||
HSTSMaxAge time.Duration
|
|
||||||
HSTSIncludeSubdomains bool
|
|
||||||
FrameOptions string
|
|
||||||
ReferrerPolicy string
|
|
||||||
ContentTypeNoSniff bool
|
|
||||||
}
|
|
||||||
|
|
||||||
// DefaultConfig liefert die dokumentierte Baseline: restriktive CSP ohne
|
|
||||||
// unsichere Direktiven, HSTS mit 180 Tagen (empfohlener Mindestwert fuer
|
|
||||||
// HSTS-Preloading-Listen liegt bei 1 Jahr — 180 Tage ist ein bewusst
|
|
||||||
// konservativer, aber bereits "angemessener" Ausgangswert, siehe
|
|
||||||
// Akzeptanzkriterium 2), Clickjacking- und MIME-Sniffing-Schutz.
|
|
||||||
func DefaultConfig() Config {
|
|
||||||
return Config{
|
|
||||||
ContentSecurityPolicy: strings.Join([]string{
|
|
||||||
"default-src 'self'",
|
|
||||||
"script-src 'self'",
|
|
||||||
"style-src 'self'",
|
|
||||||
"img-src 'self' data:",
|
|
||||||
"object-src 'none'",
|
|
||||||
"base-uri 'self'",
|
|
||||||
"frame-ancestors 'none'",
|
|
||||||
}, "; "),
|
|
||||||
HSTSMaxAge: 180 * 24 * time.Hour,
|
|
||||||
HSTSIncludeSubdomains: true,
|
|
||||||
FrameOptions: "DENY",
|
|
||||||
ReferrerPolicy: "strict-origin-when-cross-origin",
|
|
||||||
ContentTypeNoSniff: true,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// RequiredHeaders sind die von dieser Baseline gesetzten Header-Namen — die
|
|
||||||
// Referenzliste fuer CheckCoverage (Akzeptanzkriterium/Pruefung 1).
|
|
||||||
var RequiredHeaders = []string{
|
|
||||||
"Content-Security-Policy",
|
|
||||||
"Strict-Transport-Security",
|
|
||||||
"X-Frame-Options",
|
|
||||||
"Referrer-Policy",
|
|
||||||
"X-Content-Type-Options",
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c Config) hstsValue() string {
|
|
||||||
v := fmt.Sprintf("max-age=%d", int(c.HSTSMaxAge.Seconds()))
|
|
||||||
if c.HSTSIncludeSubdomains {
|
|
||||||
v += "; includeSubDomains"
|
|
||||||
}
|
|
||||||
return v
|
|
||||||
}
|
|
||||||
|
|
||||||
// Middleware setzt die Baseline-Header auf JEDER Antwort und erzwingt einen
|
|
||||||
// HTTP->HTTPS-Redirect, WENN die Anfrage nicht bereits ueber TLS ankam
|
|
||||||
// (Akzeptanzkriterium 2 / Pruefung 3) — serverseitig durchgesetzt, nicht nur
|
|
||||||
// dem Browser-HSTS-Cache ueberlassen (der erst nach dem ERSTEN sicheren
|
|
||||||
// Aufruf greift).
|
|
||||||
func Middleware(cfg Config, next http.HandlerFunc) http.HandlerFunc {
|
|
||||||
return func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
if !isSecure(r) {
|
|
||||||
target := "https://" + r.Host + r.URL.RequestURI()
|
|
||||||
http.Redirect(w, r, target, http.StatusMovedPermanently)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
SetHeaders(cfg, w)
|
|
||||||
next(w, r)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// SetHeaders setzt die Baseline-Header direkt, OHNE die HTTPS-Redirect-
|
|
||||||
// Pruefung von Middleware — nuetzlich fuer lokale Entwicklungs-/
|
|
||||||
// Demo-Umgebungen ohne TLS-Terminierung (siehe cmd/secheaders-devserver)
|
|
||||||
// und fuer Aufrufer, die den Redirect selbst schon anderweitig sicherstellen.
|
|
||||||
func SetHeaders(cfg Config, w http.ResponseWriter) {
|
|
||||||
w.Header().Set("Content-Security-Policy", cfg.ContentSecurityPolicy)
|
|
||||||
w.Header().Set("Strict-Transport-Security", cfg.hstsValue())
|
|
||||||
w.Header().Set("X-Frame-Options", cfg.FrameOptions)
|
|
||||||
w.Header().Set("Referrer-Policy", cfg.ReferrerPolicy)
|
|
||||||
if cfg.ContentTypeNoSniff {
|
|
||||||
w.Header().Set("X-Content-Type-Options", "nosniff")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// isSecure erkennt TLS direkt ODER ueber den ueblichen Reverse-Proxy-Header
|
|
||||||
// (X-Forwarded-Proto) — der Core-Dienst laeuft in der Praxis hinter einem
|
|
||||||
// TLS-terminierenden Proxy, sieht r.TLS also nie direkt gesetzt.
|
|
||||||
func isSecure(r *http.Request) bool {
|
|
||||||
if r.TLS != nil {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
return strings.EqualFold(r.Header.Get("X-Forwarded-Proto"), "https")
|
|
||||||
}
|
|
||||||
|
|
||||||
// CheckCoverage vergleicht die tatsaechlich gesetzten Header einer Antwort
|
|
||||||
// gegen RequiredHeaders und liefert die fehlenden — der "automatisierte
|
|
||||||
// Header-Scan" aus Pruefung 1, anwendbar auf jede Antwort eines beliebigen
|
|
||||||
// Modul-Frontends.
|
|
||||||
func CheckCoverage(headers http.Header) (missing []string) {
|
|
||||||
for _, name := range RequiredHeaders {
|
|
||||||
if headers.Get(name) == "" {
|
|
||||||
missing = append(missing, name)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return missing
|
|
||||||
}
|
|
||||||
@@ -1,113 +0,0 @@
|
|||||||
package secheaders
|
|
||||||
|
|
||||||
import (
|
|
||||||
"net/http"
|
|
||||||
"net/http/httptest"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
)
|
|
||||||
|
|
||||||
func secureRequest(method, target string) *http.Request {
|
|
||||||
req := httptest.NewRequest(method, target, nil)
|
|
||||||
req.Header.Set("X-Forwarded-Proto", "https")
|
|
||||||
return req
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 1: CSP definiert ohne unsafe-inline/unsafe-eval.
|
|
||||||
func TestDefaultConfig_CSPHasNoUnsafeDirectives(t *testing.T) {
|
|
||||||
cfg := DefaultConfig()
|
|
||||||
if strings.Contains(cfg.ContentSecurityPolicy, "unsafe-inline") {
|
|
||||||
t.Fatal("csp enthaelt 'unsafe-inline', erwartet keine unsicheren direktiven")
|
|
||||||
}
|
|
||||||
if strings.Contains(cfg.ContentSecurityPolicy, "unsafe-eval") {
|
|
||||||
t.Fatal("csp enthaelt 'unsafe-eval', erwartet keine unsicheren direktiven")
|
|
||||||
}
|
|
||||||
if !strings.Contains(cfg.ContentSecurityPolicy, "default-src 'self'") {
|
|
||||||
t.Fatal("erwartet restriktive default-src 'self' als ausgangspunkt")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 2: HSTS mit angemessener max-age gesetzt.
|
|
||||||
func TestMiddleware_SetsHSTSWithSufficientMaxAge(t *testing.T) {
|
|
||||||
cfg := DefaultConfig()
|
|
||||||
handler := Middleware(cfg, func(w http.ResponseWriter, r *http.Request) { w.WriteHeader(http.StatusOK) })
|
|
||||||
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
handler(rec, secureRequest(http.MethodGet, "https://example.test/"))
|
|
||||||
|
|
||||||
hsts := rec.Header().Get("Strict-Transport-Security")
|
|
||||||
if !strings.Contains(hsts, "max-age=") {
|
|
||||||
t.Fatalf("hsts-header fehlt max-age: %q", hsts)
|
|
||||||
}
|
|
||||||
// "Angemessen" heisst hier: mindestens 30 Tage (2592000s) — deutlich
|
|
||||||
// ueber dem bekannten Anti-Pattern kurzer/fehlender max-age-Werte.
|
|
||||||
if cfg.HSTSMaxAge.Seconds() < 2592000 {
|
|
||||||
t.Fatalf("konfigurierte hsts-max-age = %v, erwartet mindestens 30 tage", cfg.HSTSMaxAge)
|
|
||||||
}
|
|
||||||
if !strings.Contains(hsts, "includeSubDomains") {
|
|
||||||
t.Fatalf("erwartet includeSubDomains im hsts-header: %q", hsts)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 3 + Pruefung 1: EINE gemeinsame Middleware setzt ALLE
|
|
||||||
// Baseline-Header vollstaendig — automatisiert ueberprueft mit CheckCoverage.
|
|
||||||
func TestMiddleware_ProducesFullHeaderCoverage(t *testing.T) {
|
|
||||||
cfg := DefaultConfig()
|
|
||||||
handler := Middleware(cfg, func(w http.ResponseWriter, r *http.Request) { w.WriteHeader(http.StatusOK) })
|
|
||||||
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
handler(rec, secureRequest(http.MethodGet, "https://example.test/"))
|
|
||||||
|
|
||||||
if missing := CheckCoverage(rec.Header()); len(missing) != 0 {
|
|
||||||
t.Fatalf("erwartet vollstaendige header-abdeckung, fehlen: %v", missing)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Pruefung 1 (Kehrseite): CheckCoverage erkennt fehlende Header
|
|
||||||
// zuverlaessig — Voraussetzung dafuer, dass ein automatisierter Scan
|
|
||||||
// gegen ein Modul-Frontend OHNE eingebundene Middleware ueberhaupt etwas
|
|
||||||
// meldet.
|
|
||||||
func TestCheckCoverage_DetectsMissingHeadersOnBareHandler(t *testing.T) {
|
|
||||||
bareHandler := func(w http.ResponseWriter, r *http.Request) { w.WriteHeader(http.StatusOK) }
|
|
||||||
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
bareHandler(rec, httptest.NewRequest(http.MethodGet, "/", nil))
|
|
||||||
|
|
||||||
missing := CheckCoverage(rec.Header())
|
|
||||||
if len(missing) != len(RequiredHeaders) {
|
|
||||||
t.Fatalf("erwartet %d fehlende header bei unbehandeltem handler, habe %d: %v",
|
|
||||||
len(RequiredHeaders), len(missing), missing)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Akzeptanzkriterium 2 + Pruefung 3: ein Aufruf ueber (simuliertes) HTTP
|
|
||||||
// wird server-seitig auf HTTPS umgeleitet, statt sich allein auf den
|
|
||||||
// HSTS-Browser-Cache zu verlassen (der erst nach dem ersten sicheren
|
|
||||||
// Aufruf greift).
|
|
||||||
func TestMiddleware_RedirectsInsecureRequestToHTTPS(t *testing.T) {
|
|
||||||
cfg := DefaultConfig()
|
|
||||||
called := false
|
|
||||||
handler := Middleware(cfg, func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
called = true
|
|
||||||
w.WriteHeader(http.StatusOK)
|
|
||||||
})
|
|
||||||
|
|
||||||
req := httptest.NewRequest(http.MethodGet, "http://example.test/pfad?x=1", nil)
|
|
||||||
// Kein X-Forwarded-Proto, kein r.TLS -> unsicherer Aufruf.
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
handler(rec, req)
|
|
||||||
|
|
||||||
if rec.Code != http.StatusMovedPermanently {
|
|
||||||
t.Fatalf("status = %d, want 301 (redirect auf https)", rec.Code)
|
|
||||||
}
|
|
||||||
location := rec.Header().Get("Location")
|
|
||||||
if !strings.HasPrefix(location, "https://") {
|
|
||||||
t.Fatalf("location = %q, want https://-praefix", location)
|
|
||||||
}
|
|
||||||
if !strings.Contains(location, "/pfad?x=1") {
|
|
||||||
t.Fatalf("location = %q, erwartet erhaltenen pfad+query", location)
|
|
||||||
}
|
|
||||||
if called {
|
|
||||||
t.Fatal("eigentlicher handler haette bei unsicherem aufruf nicht erreicht werden duerfen")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Reference in New Issue
Block a user