forked from grafana/grafana
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Middleware: Fix IPv6 host parsing in CSRF check (grafana#45911)
- Also create tests for this middleware Co-authored-by: Kyle Brandt <kyle@grafana.com>
- Loading branch information
1 parent
e814e73
commit 06ed5ef
Showing
3 changed files
with
140 additions
and
5 deletions.
There are no files selected for viewing
This file contains 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 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 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,124 @@ | ||
package middleware | ||
|
||
import ( | ||
"net/http" | ||
"net/http/httptest" | ||
"testing" | ||
|
||
"github.com/grafana/grafana/pkg/infra/log" | ||
"github.com/stretchr/testify/require" | ||
) | ||
|
||
func TestMiddlewareCSRF(t *testing.T) { | ||
tests := []struct { | ||
name string | ||
cookieName string | ||
method string | ||
origin string | ||
host string | ||
code int | ||
}{ | ||
{ | ||
name: "mismatched origin and host is forbidden", | ||
cookieName: "foo", | ||
method: "GET", | ||
origin: "http://notLocalhost", | ||
host: "localhost", | ||
code: http.StatusForbidden, | ||
}, | ||
{ | ||
name: "mismatched origin and host is NOT forbidden with a 'Safe Method'", | ||
cookieName: "foo", | ||
method: "TRACE", | ||
origin: "http://notLocalhost", | ||
host: "localhost", | ||
code: http.StatusOK, | ||
}, | ||
{ | ||
name: "mismatched origin and host is NOT forbidden without a cookie", | ||
cookieName: "", | ||
method: "GET", | ||
origin: "http://notLocalhost", | ||
host: "localhost", | ||
code: http.StatusOK, | ||
}, | ||
{ | ||
name: "malformed host is a bad request", | ||
cookieName: "foo", | ||
method: "GET", | ||
host: "localhost:80:80", | ||
code: http.StatusBadRequest, | ||
}, | ||
{ | ||
name: "host works without port", | ||
cookieName: "foo", | ||
method: "GET", | ||
host: "localhost", | ||
origin: "http://localhost", | ||
code: http.StatusOK, | ||
}, | ||
{ | ||
name: "port does not have to match", | ||
cookieName: "foo", | ||
method: "GET", | ||
host: "localhost:80", | ||
origin: "http://localhost:3000", | ||
code: http.StatusOK, | ||
}, | ||
{ | ||
name: "IPv6 host works with port", | ||
cookieName: "foo", | ||
method: "GET", | ||
host: "[::1]:3000", | ||
origin: "http://[::1]:3000", | ||
code: http.StatusOK, | ||
}, | ||
{ | ||
name: "IPv6 host (with longer address) works with port", | ||
cookieName: "foo", | ||
method: "GET", | ||
host: "[2001:db8::1]:3000", | ||
origin: "http://[2001:db8::1]:3000", | ||
code: http.StatusOK, | ||
}, | ||
{ | ||
name: "IPv6 host (with longer address) works without port", | ||
cookieName: "foo", | ||
method: "GET", | ||
host: "[2001:db8::1]", | ||
origin: "http://[2001:db8::1]", | ||
code: http.StatusOK, | ||
}, | ||
} | ||
for _, tt := range tests { | ||
t.Run(tt.name, func(t *testing.T) { | ||
rr := csrfScenario(t, tt.cookieName, tt.method, tt.origin, tt.host) | ||
require.Equal(t, tt.code, rr.Code) | ||
}) | ||
} | ||
} | ||
|
||
func csrfScenario(t *testing.T, cookieName, method, origin, host string) *httptest.ResponseRecorder { | ||
req, err := http.NewRequest(method, "/", nil) | ||
if err != nil { | ||
t.Fatal(err) | ||
} | ||
req.AddCookie(&http.Cookie{ | ||
Name: cookieName, | ||
}) | ||
|
||
// Note: Not sure where host header populates req.Host, or how that works. | ||
req.Host = host | ||
req.Header.Set("HOST", host) | ||
|
||
req.Header.Set("ORIGIN", origin) | ||
|
||
testHandler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||
|
||
}) | ||
|
||
rr := httptest.NewRecorder() | ||
handler := CSRF(cookieName, log.New())(testHandler) | ||
handler.ServeHTTP(rr, req) | ||
return rr | ||
} |