feat: Add option to enable hsts header #6147
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
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,58 @@ | ||
| package httpmw | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "net/http" | ||
| "strings" | ||
|
|
||
| "golang.org/x/xerrors" | ||
| ) | ||
|
|
||
| const ( | ||
| hstsHeader = "Strict-Transport-Security" | ||
| ) | ||
|
|
||
| // HSTS will add the strict-transport-security header if enabled. This header | ||
| // forces a browser to always use https for the domain after it loads https once. | ||
| // Meaning: On first load of product.coder.com, they are redirected to https. On | ||
| // all subsequent loads, the client's local browser forces https. This prevents | ||
| // man in the middle. | ||
| // | ||
| // This header only makes sense if the app is using tls. | ||
| // | ||
| // Full header example: | ||
| // Strict-Transport-Security: max-age=63072000; includeSubDomains; preload | ||
| func HSTS(next http.Handler, maxAge int, options []string) (http.Handler, error) { | ||
| if maxAge <= 0 { | ||
| // No header, so no need to wrap the handler | ||
| return next, nil | ||
| } | ||
|
|
||
| // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security | ||
| var str strings.Builder | ||
| _, err := str.WriteString(fmt.Sprintf("max-age=%d", maxAge)) | ||
| if err != nil { | ||
| return nil, xerrors.Errorf("hsts: write max-age: %w", err) | ||
| } | ||
|
|
||
| for _, option := range options { | ||
| switch { | ||
| // Only allow valid options and fix any casing mistakes | ||
| case strings.EqualFold(option, "includeSubDomains"): | ||
| option = "includeSubDomains" | ||
| case strings.EqualFold(option, "preload"): | ||
| option = "preload" | ||
| default: | ||
| return nil, xerrors.Errorf("hsts: invalid option: %q. Must be 'preload' and/or 'includeSubDomains'", option) | ||
| } | ||
| _, err = str.WriteString("; " + option) | ||
| if err != nil { | ||
| return nil, xerrors.Errorf("hsts: write option: %w", err) | ||
| } | ||
| } | ||
|
|
||
| return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||
| w.Header().Set(hstsHeader, str.String()) | ||
| next.ServeHTTP(w, r) | ||
| }), nil | ||
| } |
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,102 @@ | ||
| package httpmw_test | ||
|
|
||
| import ( | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
|
|
||
| "github.com/coder/coder/coderd/httpmw" | ||
| ) | ||
|
|
||
| func TestHSTS(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| tests := []struct { | ||
| Name string | ||
| MaxAge int | ||
| Options []string | ||
|
|
||
| wantErr bool | ||
| expectHeader string | ||
| }{ | ||
| { | ||
| Name: "Empty", | ||
| MaxAge: 0, | ||
| Options: nil, | ||
| }, | ||
| { | ||
| Name: "NoAge", | ||
| MaxAge: 0, | ||
| Options: []string{"includeSubDomains"}, | ||
| }, | ||
| { | ||
| Name: "NegativeAge", | ||
| MaxAge: -100, | ||
| Options: []string{"includeSubDomains"}, | ||
| }, | ||
| { | ||
| Name: "Age", | ||
| MaxAge: 1000, | ||
| Options: []string{}, | ||
| expectHeader: "max-age=1000", | ||
| }, | ||
| { | ||
| Name: "AgeSubDomains", | ||
| MaxAge: 1000, | ||
| // Mess with casing | ||
| Options: []string{"INCLUDESUBDOMAINS"}, | ||
| expectHeader: "max-age=1000; includeSubDomains", | ||
| }, | ||
| { | ||
| Name: "AgePreload", | ||
| MaxAge: 1000, | ||
| Options: []string{"Preload"}, | ||
| expectHeader: "max-age=1000; preload", | ||
| }, | ||
| { | ||
| Name: "AllOptions", | ||
| MaxAge: 1000, | ||
| Options: []string{"preload", "includeSubDomains"}, | ||
| expectHeader: "max-age=1000; preload; includeSubDomains", | ||
| }, | ||
|
|
||
| // Error values | ||
| { | ||
| Name: "BadOption", | ||
| MaxAge: 100, | ||
| Options: []string{"not-valid"}, | ||
| wantErr: true, | ||
| }, | ||
| { | ||
| Name: "BadOptions", | ||
| MaxAge: 100, | ||
| Options: []string{"includeSubDomains", "not-valid", "still-not-valid"}, | ||
| wantErr: true, | ||
| }, | ||
| } | ||
| for _, tt := range tests { | ||
| tt := tt | ||
| t.Run(tt.Name, func(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||
| w.WriteHeader(http.StatusOK) | ||
| }) | ||
|
|
||
| got, err := httpmw.HSTS(handler, tt.MaxAge, tt.Options) | ||
| if tt.wantErr { | ||
| require.Error(t, err, "Expect error, HSTS(%v, %v)", tt.MaxAge, tt.Options) | ||
| return | ||
| } | ||
|
|
||
| require.NoError(t, err, "Expect no error, HSTS(%v, %v)", tt.MaxAge, tt.Options) | ||
| req := httptest.NewRequest("GET", "/", nil) | ||
| res := httptest.NewRecorder() | ||
|
|
||
| got.ServeHTTP(res, req) | ||
| require.Equal(t, tt.expectHeader, res.Header().Get("Strict-Transport-Security"), "expected header value") | ||
| }) | ||
| } | ||
| } |
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
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.
I think it would be good to explain that the number sets the maxAge here.
We could also consider splitting this up into an enable bool and explicit maxage option that's required when enabled.
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.
I added that in the message. If I add another flag, then it's 3 flags to turn this thing fully on :(. I figure anything >0 make sense to enable it.