generated from block/oss-project-template
-
Notifications
You must be signed in to change notification settings - Fork 5
fix: reject requests targeting a cachew playpen when not running as one #204
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+76
−0
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| selected_org: cash | ||
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,31 @@ | ||
| package httputil | ||
|
|
||
| import ( | ||
| "net/http" | ||
| "strings" | ||
| ) | ||
|
|
||
| // PlaypenGuardMiddleware rejects requests that target a playpen instance | ||
| // (via the Baggage header) when this instance is not a playpen. | ||
| // This prevents requests from silently falling through to staging. | ||
| func PlaypenGuardMiddleware(next http.Handler) http.Handler { | ||
| return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||
| if baggage := r.Header.Get("Baggage"); hasCachewPlaypenKey(baggage) { | ||
| http.Error(w, "no matching cachew playpen found — start one with: sq playpen sync", http.StatusServiceUnavailable) | ||
| return | ||
| } | ||
| next.ServeHTTP(w, r) | ||
| }) | ||
| } | ||
|
|
||
| func hasCachewPlaypenKey(baggage string) bool { | ||
| if baggage == "" { | ||
| return false | ||
| } | ||
| for entry := range strings.SplitSeq(baggage, ",") { | ||
| if strings.HasPrefix(strings.TrimSpace(entry), "cachew-playpen=") { | ||
| return true | ||
| } | ||
| } | ||
| return false | ||
| } |
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,41 @@ | ||
| package httputil_test | ||
|
|
||
| import ( | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "testing" | ||
|
|
||
| "github.com/alecthomas/assert/v2" | ||
|
|
||
| "github.com/block/cachew/internal/httputil" | ||
| ) | ||
|
|
||
| func TestPlaypenGuardMiddleware(t *testing.T) { | ||
| ok := http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) { | ||
| w.WriteHeader(http.StatusOK) | ||
| }) | ||
| guard := httputil.PlaypenGuardMiddleware(ok) | ||
|
|
||
| t.Run("allows normal requests", func(t *testing.T) { | ||
| req := httptest.NewRequest(http.MethodGet, "/", nil) | ||
| rr := httptest.NewRecorder() | ||
| guard.ServeHTTP(rr, req) | ||
| assert.Equal(t, http.StatusOK, rr.Code) | ||
| }) | ||
|
|
||
| t.Run("blocks requests with cachew playpen baggage", func(t *testing.T) { | ||
| req := httptest.NewRequest(http.MethodGet, "/", nil) | ||
| req.Header.Set("Baggage", "cachew-playpen=jrobotham") | ||
| rr := httptest.NewRecorder() | ||
| guard.ServeHTTP(rr, req) | ||
| assert.Equal(t, http.StatusServiceUnavailable, rr.Code) | ||
| }) | ||
|
|
||
| t.Run("allows requests with unrelated baggage", func(t *testing.T) { | ||
| req := httptest.NewRequest(http.MethodGet, "/", nil) | ||
| req.Header.Set("Baggage", "blox-playpen=jrobotham") | ||
| rr := httptest.NewRecorder() | ||
| guard.ServeHTTP(rr, req) | ||
| assert.Equal(t, http.StatusOK, rr.Code) | ||
| }) | ||
| } |
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.
What is this?