feat: add Content-Security-Policy and opt-in HSTS, fix healthz routing #449
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "testing" | ||
| ) | ||
|
|
||
| func TestComposeMux_HealthzReachesAPIHandlerNotSPAFallback(t *testing.T) { | ||
| apiHit := false | ||
| apiHandler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||
| apiHit = true | ||
| if r.URL.Path != "/healthz" { | ||
| t.Errorf("apiHandler saw path %q, want /healthz unchanged", r.URL.Path) | ||
| } | ||
| w.WriteHeader(http.StatusOK) | ||
| _, _ = w.Write([]byte(`{"status":"ok"}`)) | ||
| }) | ||
| webHandler := http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) { | ||
| w.WriteHeader(http.StatusOK) | ||
| _, _ = w.Write([]byte("<html>spa shell</html>")) | ||
| }) | ||
|
|
||
| mux := composeMux(apiHandler, nil, webHandler) | ||
|
|
||
| rec := httptest.NewRecorder() | ||
| req := httptest.NewRequest(http.MethodGet, "/healthz", nil) | ||
| mux.ServeHTTP(rec, req) | ||
|
|
||
| if !apiHit { | ||
| t.Fatal("GET /healthz did not reach apiHandler, want it exact-matched ahead of the \"/\" SPA fallback") | ||
| } | ||
| if body := rec.Body.String(); body != `{"status":"ok"}` { | ||
| t.Errorf("body = %q, want the API handler's JSON, not the SPA shell", body) | ||
| } | ||
| } | ||
|
|
||
| func TestComposeMux_APIPrefixReachesAPIHandlerWithFullPath(t *testing.T) { | ||
| var gotPath string | ||
| apiHandler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||
| gotPath = r.URL.Path | ||
| w.WriteHeader(http.StatusOK) | ||
| }) | ||
| webHandler := http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) { | ||
| w.WriteHeader(http.StatusOK) | ||
| }) | ||
|
|
||
| mux := composeMux(apiHandler, nil, webHandler) | ||
|
|
||
| rec := httptest.NewRecorder() | ||
| req := httptest.NewRequest(http.MethodGet, "/api/v1/brand", nil) | ||
| mux.ServeHTTP(rec, req) | ||
|
|
||
| if gotPath != "/api/v1/brand" { | ||
| t.Errorf("apiHandler saw path %q, want the full original path unchanged", gotPath) | ||
| } | ||
| } | ||
|
|
||
| func TestComposeMux_UnmatchedPathFallsBackToWebHandler(t *testing.T) { | ||
| apiHandler := http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) { | ||
| w.WriteHeader(http.StatusOK) | ||
| _, _ = w.Write([]byte("api")) | ||
| }) | ||
| webHandler := http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) { | ||
| w.WriteHeader(http.StatusOK) | ||
| _, _ = w.Write([]byte("spa")) | ||
| }) | ||
|
|
||
| mux := composeMux(apiHandler, nil, webHandler) | ||
|
|
||
| rec := httptest.NewRecorder() | ||
| req := httptest.NewRequest(http.MethodGet, "/apps/my-app", nil) | ||
| mux.ServeHTTP(rec, req) | ||
|
|
||
| if got := rec.Body.String(); got != "spa" { | ||
| t.Errorf("body = %q, want the SPA fallback to serve an unmatched client-side route", got) | ||
| } | ||
| } | ||
|
|
||
| func TestComposeMux_NilWebhookHandler_NoWebhookRoute(t *testing.T) { | ||
| apiHandler := http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) { | ||
| w.WriteHeader(http.StatusOK) | ||
| }) | ||
| webHandler := http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) { | ||
| w.WriteHeader(http.StatusOK) | ||
| _, _ = w.Write([]byte("spa")) | ||
| }) | ||
|
|
||
| mux := composeMux(apiHandler, nil, webHandler) | ||
|
|
||
| rec := httptest.NewRecorder() | ||
| req := httptest.NewRequest(http.MethodPost, "/webhook", nil) | ||
| mux.ServeHTTP(rec, req) | ||
|
|
||
| if got := rec.Body.String(); got != "spa" { | ||
| t.Errorf("POST /webhook body = %q, want the SPA fallback since no webhookHandler was configured", got) | ||
| } | ||
| } | ||
|
|
||
| func TestComposeMux_WebhookHandlerConfigured_ReceivesPost(t *testing.T) { | ||
| webhookHit := false | ||
| webhookHandler := http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) { | ||
| webhookHit = true | ||
| w.WriteHeader(http.StatusOK) | ||
| }) | ||
| apiHandler := http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) { w.WriteHeader(http.StatusOK) }) | ||
| webHandler := http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) { w.WriteHeader(http.StatusOK) }) | ||
|
|
||
| mux := composeMux(apiHandler, webhookHandler, webHandler) | ||
|
|
||
| rec := httptest.NewRecorder() | ||
| req := httptest.NewRequest(http.MethodPost, "/webhook", nil) | ||
| mux.ServeHTTP(rec, req) | ||
|
|
||
| if !webhookHit { | ||
| t.Error("POST /webhook did not reach webhookHandler") | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
composeMuxsends/healthzand/api/throughrt.Handler(), where the security middleware is installed, but sends/and static assets directly throughweb.Handler(). As a result, the dashboard HTML does not receive the new Content-Security-Policy, so the policy does not restrict script execution on the page it is meant to protect.How this was verified:
GET /is routed directly to the unwrapped web handler, whereas the CSP middleware exists only inside the API handler.