mirror of
https://github.com/labstack/echo.git
synced 2025-04-21 12:17:04 +02:00
parent
451b2ccc9f
commit
98d744b8fb
@ -50,12 +50,8 @@ type (
|
|||||||
CookieMaxAge int `json:"cookie_max_age"`
|
CookieMaxAge int `json:"cookie_max_age"`
|
||||||
|
|
||||||
// Indicates if CSRF cookie is secure.
|
// Indicates if CSRF cookie is secure.
|
||||||
|
// Optional. Default value false.
|
||||||
CookieSecure bool `json:"cookie_secure"`
|
CookieSecure bool `json:"cookie_secure"`
|
||||||
// Optional. Default value false.
|
|
||||||
|
|
||||||
// Indicates if CSRF cookie is HTTP only.
|
|
||||||
// Optional. Default value false.
|
|
||||||
CookieHTTPOnly bool `json:"cookie_http_only"`
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// csrfTokenExtractor defines a function that takes `echo.Context` and returns
|
// csrfTokenExtractor defines a function that takes `echo.Context` and returns
|
||||||
@ -68,7 +64,7 @@ var (
|
|||||||
DefaultCSRFConfig = CSRFConfig{
|
DefaultCSRFConfig = CSRFConfig{
|
||||||
TokenLookup: "header:" + echo.HeaderXCSRFToken,
|
TokenLookup: "header:" + echo.HeaderXCSRFToken,
|
||||||
ContextKey: "csrf",
|
ContextKey: "csrf",
|
||||||
CookieName: "csrf",
|
CookieName: "_csrf",
|
||||||
CookieMaxAge: 86400,
|
CookieMaxAge: 86400,
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
@ -122,6 +118,9 @@ func CSRFWithConfig(config CSRFConfig) echo.MiddlewareFunc {
|
|||||||
}
|
}
|
||||||
token := generateCSRFToken(config.Secret, salt)
|
token := generateCSRFToken(config.Secret, salt)
|
||||||
c.Set(config.ContextKey, token)
|
c.Set(config.ContextKey, token)
|
||||||
|
|
||||||
|
switch req.Method() {
|
||||||
|
case echo.GET, echo.HEAD, echo.OPTIONS, echo.TRACE:
|
||||||
cookie := new(echo.Cookie)
|
cookie := new(echo.Cookie)
|
||||||
cookie.SetName(config.CookieName)
|
cookie.SetName(config.CookieName)
|
||||||
cookie.SetValue(token)
|
cookie.SetValue(token)
|
||||||
@ -133,17 +132,19 @@ func CSRFWithConfig(config CSRFConfig) echo.MiddlewareFunc {
|
|||||||
}
|
}
|
||||||
cookie.SetExpires(time.Now().Add(time.Duration(config.CookieMaxAge) * time.Second))
|
cookie.SetExpires(time.Now().Add(time.Duration(config.CookieMaxAge) * time.Second))
|
||||||
cookie.SetSecure(config.CookieSecure)
|
cookie.SetSecure(config.CookieSecure)
|
||||||
cookie.SetHTTPOnly(config.CookieHTTPOnly)
|
cookie.SetHTTPOnly(true)
|
||||||
c.SetCookie(cookie)
|
c.SetCookie(cookie)
|
||||||
|
|
||||||
switch req.Method() {
|
|
||||||
case echo.GET, echo.HEAD, echo.OPTIONS, echo.TRACE:
|
|
||||||
default:
|
default:
|
||||||
token, err := extractor(c)
|
cookie, err := c.Cookie(config.CookieName)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
ok, err := validateCSRFToken(token, config.Secret)
|
serverToken := cookie.Value()
|
||||||
|
clientToken, err := extractor(c)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
ok, err := validateCSRFToken(serverToken, clientToken, config.Secret)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@ -194,16 +195,19 @@ func generateCSRFToken(secret, salt []byte) string {
|
|||||||
return fmt.Sprintf("%s:%s", hex.EncodeToString(h.Sum(nil)), hex.EncodeToString(salt))
|
return fmt.Sprintf("%s:%s", hex.EncodeToString(h.Sum(nil)), hex.EncodeToString(salt))
|
||||||
}
|
}
|
||||||
|
|
||||||
func validateCSRFToken(token string, secret []byte) (bool, error) {
|
func validateCSRFToken(serverToken, clientToken string, secret []byte) (bool, error) {
|
||||||
sep := strings.Index(token, ":")
|
if serverToken != clientToken {
|
||||||
|
return false, nil
|
||||||
|
}
|
||||||
|
sep := strings.Index(clientToken, ":")
|
||||||
if sep < 0 {
|
if sep < 0 {
|
||||||
return false, nil
|
return false, nil
|
||||||
}
|
}
|
||||||
salt, err := hex.DecodeString(token[sep+1:])
|
salt, err := hex.DecodeString(clientToken[sep+1:])
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return false, err
|
return false, err
|
||||||
}
|
}
|
||||||
return token == generateCSRFToken(secret, salt), nil
|
return clientToken == generateCSRFToken(secret, salt), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func generateSalt(len uint8) (salt []byte, err error) {
|
func generateSalt(len uint8) (salt []byte, err error) {
|
||||||
|
@ -18,8 +18,6 @@ func TestCSRF(t *testing.T) {
|
|||||||
c := e.NewContext(req, rec)
|
c := e.NewContext(req, rec)
|
||||||
csrf := CSRFWithConfig(CSRFConfig{
|
csrf := CSRFWithConfig(CSRFConfig{
|
||||||
Secret: []byte("secret"),
|
Secret: []byte("secret"),
|
||||||
CookiePath: "/",
|
|
||||||
CookieDomain: "labstack.com",
|
|
||||||
})
|
})
|
||||||
h := csrf(func(c echo.Context) error {
|
h := csrf(func(c echo.Context) error {
|
||||||
return c.String(http.StatusOK, "test")
|
return c.String(http.StatusOK, "test")
|
||||||
@ -32,19 +30,25 @@ func TestCSRF(t *testing.T) {
|
|||||||
|
|
||||||
// Generate CSRF token
|
// Generate CSRF token
|
||||||
h(c)
|
h(c)
|
||||||
assert.Contains(t, rec.Header().Get(echo.HeaderSetCookie), "csrf")
|
assert.Contains(t, rec.Header().Get(echo.HeaderSetCookie), "_csrf")
|
||||||
|
|
||||||
|
// Without CSRF cookie
|
||||||
|
req = test.NewRequest(echo.POST, "/", nil)
|
||||||
|
rec = test.NewResponseRecorder()
|
||||||
|
c = e.NewContext(req, rec)
|
||||||
|
assert.Error(t, h(c))
|
||||||
|
|
||||||
// Empty/invalid CSRF token
|
// Empty/invalid CSRF token
|
||||||
req = test.NewRequest(echo.POST, "/", nil)
|
req = test.NewRequest(echo.POST, "/", nil)
|
||||||
rec = test.NewResponseRecorder()
|
rec = test.NewResponseRecorder()
|
||||||
c = e.NewContext(req, rec)
|
c = e.NewContext(req, rec)
|
||||||
req.Header().Set(echo.HeaderXCSRFToken, "")
|
req.Header().Set(echo.HeaderXCSRFToken, "")
|
||||||
he := h(c).(*echo.HTTPError)
|
assert.Error(t, h(c))
|
||||||
assert.Equal(t, http.StatusForbidden, he.Code)
|
|
||||||
|
|
||||||
// Valid CSRF token
|
// Valid CSRF token
|
||||||
salt, _ := generateSalt(8)
|
salt, _ := generateSalt(8)
|
||||||
token := generateCSRFToken([]byte("secret"), salt)
|
token := generateCSRFToken([]byte("secret"), salt)
|
||||||
|
req.Header().Set(echo.HeaderCookie, "_csrf="+token)
|
||||||
req.Header().Set(echo.HeaderXCSRFToken, token)
|
req.Header().Set(echo.HeaderXCSRFToken, token)
|
||||||
if assert.NoError(t, h(c)) {
|
if assert.NoError(t, h(c)) {
|
||||||
assert.Equal(t, http.StatusOK, rec.Status())
|
assert.Equal(t, http.StatusOK, rec.Status())
|
||||||
|
Loading…
x
Reference in New Issue
Block a user