vikunja-api/vendor/github.com/labstack/echo/middleware/csrf.go

211 lines
5.7 KiB
Go
Raw Normal View History

2018-06-10 11:11:41 +02:00
package middleware
import (
"crypto/subtle"
"errors"
"net/http"
"strings"
"time"
"github.com/labstack/echo"
"github.com/labstack/gommon/random"
)
type (
// CSRFConfig defines the config for CSRF middleware.
CSRFConfig struct {
// Skipper defines a function to skip middleware.
Skipper Skipper
// TokenLength is the length of the generated token.
2018-11-03 16:05:45 +01:00
TokenLength uint8 `yaml:"token_length"`
2018-06-10 11:11:41 +02:00
// Optional. Default value 32.
// TokenLookup is a string in the form of "<source>:<key>" that is used
// to extract token from the request.
// Optional. Default value "header:X-CSRF-Token".
// Possible values:
// - "header:<name>"
// - "form:<name>"
// - "query:<name>"
2018-11-03 16:05:45 +01:00
TokenLookup string `yaml:"token_lookup"`
2018-06-10 11:11:41 +02:00
// Context key to store generated CSRF token into context.
// Optional. Default value "csrf".
2018-11-03 16:05:45 +01:00
ContextKey string `yaml:"context_key"`
2018-06-10 11:11:41 +02:00
// Name of the CSRF cookie. This cookie will store CSRF token.
// Optional. Default value "csrf".
2018-11-03 16:05:45 +01:00
CookieName string `yaml:"cookie_name"`
2018-06-10 11:11:41 +02:00
// Domain of the CSRF cookie.
// Optional. Default value none.
2018-11-03 16:05:45 +01:00
CookieDomain string `yaml:"cookie_domain"`
2018-06-10 11:11:41 +02:00
// Path of the CSRF cookie.
// Optional. Default value none.
2018-11-03 16:05:45 +01:00
CookiePath string `yaml:"cookie_path"`
2018-06-10 11:11:41 +02:00
// Max age (in seconds) of the CSRF cookie.
// Optional. Default value 86400 (24hr).
2018-11-03 16:05:45 +01:00
CookieMaxAge int `yaml:"cookie_max_age"`
2018-06-10 11:11:41 +02:00
// Indicates if CSRF cookie is secure.
// Optional. Default value false.
2018-11-03 16:05:45 +01:00
CookieSecure bool `yaml:"cookie_secure"`
2018-06-10 11:11:41 +02:00
// Indicates if CSRF cookie is HTTP only.
// Optional. Default value false.
2018-11-03 16:05:45 +01:00
CookieHTTPOnly bool `yaml:"cookie_http_only"`
2018-06-10 11:11:41 +02:00
}
// csrfTokenExtractor defines a function that takes `echo.Context` and returns
// either a token or an error.
csrfTokenExtractor func(echo.Context) (string, error)
)
var (
// DefaultCSRFConfig is the default CSRF middleware config.
DefaultCSRFConfig = CSRFConfig{
Skipper: DefaultSkipper,
TokenLength: 32,
TokenLookup: "header:" + echo.HeaderXCSRFToken,
ContextKey: "csrf",
CookieName: "_csrf",
CookieMaxAge: 86400,
}
)
// CSRF returns a Cross-Site Request Forgery (CSRF) middleware.
// See: https://en.wikipedia.org/wiki/Cross-site_request_forgery
func CSRF() echo.MiddlewareFunc {
c := DefaultCSRFConfig
return CSRFWithConfig(c)
}
// CSRFWithConfig returns a CSRF middleware with config.
// See `CSRF()`.
func CSRFWithConfig(config CSRFConfig) echo.MiddlewareFunc {
// Defaults
if config.Skipper == nil {
config.Skipper = DefaultCSRFConfig.Skipper
}
if config.TokenLength == 0 {
config.TokenLength = DefaultCSRFConfig.TokenLength
}
if config.TokenLookup == "" {
config.TokenLookup = DefaultCSRFConfig.TokenLookup
}
if config.ContextKey == "" {
config.ContextKey = DefaultCSRFConfig.ContextKey
}
if config.CookieName == "" {
config.CookieName = DefaultCSRFConfig.CookieName
}
if config.CookieMaxAge == 0 {
config.CookieMaxAge = DefaultCSRFConfig.CookieMaxAge
}
// Initialize
parts := strings.Split(config.TokenLookup, ":")
extractor := csrfTokenFromHeader(parts[1])
switch parts[0] {
case "form":
extractor = csrfTokenFromForm(parts[1])
case "query":
extractor = csrfTokenFromQuery(parts[1])
}
return func(next echo.HandlerFunc) echo.HandlerFunc {
return func(c echo.Context) error {
if config.Skipper(c) {
return next(c)
}
req := c.Request()
k, err := c.Cookie(config.CookieName)
token := ""
2018-11-03 16:05:45 +01:00
// Generate token
2018-06-10 11:11:41 +02:00
if err != nil {
token = random.String(config.TokenLength)
} else {
// Reuse token
token = k.Value
}
switch req.Method {
2019-03-24 10:13:40 +01:00
case http.MethodGet, http.MethodHead, http.MethodOptions, http.MethodTrace:
2018-06-10 11:11:41 +02:00
default:
// Validate token only for requests which are not defined as 'safe' by RFC7231
clientToken, err := extractor(c)
if err != nil {
return echo.NewHTTPError(http.StatusBadRequest, err.Error())
}
if !validateCSRFToken(token, clientToken) {
2018-11-03 16:05:45 +01:00
return echo.NewHTTPError(http.StatusForbidden, "invalid csrf token")
2018-06-10 11:11:41 +02:00
}
}
// Set CSRF cookie
cookie := new(http.Cookie)
cookie.Name = config.CookieName
cookie.Value = token
if config.CookiePath != "" {
cookie.Path = config.CookiePath
}
if config.CookieDomain != "" {
cookie.Domain = config.CookieDomain
}
cookie.Expires = time.Now().Add(time.Duration(config.CookieMaxAge) * time.Second)
cookie.Secure = config.CookieSecure
cookie.HttpOnly = config.CookieHTTPOnly
c.SetCookie(cookie)
// Store token in the context
c.Set(config.ContextKey, token)
// Protect clients from caching the response
c.Response().Header().Add(echo.HeaderVary, echo.HeaderCookie)
return next(c)
}
}
}
// csrfTokenFromForm returns a `csrfTokenExtractor` that extracts token from the
// provided request header.
func csrfTokenFromHeader(header string) csrfTokenExtractor {
return func(c echo.Context) (string, error) {
return c.Request().Header.Get(header), nil
}
}
// csrfTokenFromForm returns a `csrfTokenExtractor` that extracts token from the
// provided form parameter.
func csrfTokenFromForm(param string) csrfTokenExtractor {
return func(c echo.Context) (string, error) {
token := c.FormValue(param)
if token == "" {
2018-11-03 16:05:45 +01:00
return "", errors.New("missing csrf token in the form parameter")
2018-06-10 11:11:41 +02:00
}
return token, nil
}
}
// csrfTokenFromQuery returns a `csrfTokenExtractor` that extracts token from the
// provided query parameter.
func csrfTokenFromQuery(param string) csrfTokenExtractor {
return func(c echo.Context) (string, error) {
token := c.QueryParam(param)
if token == "" {
2018-11-03 16:05:45 +01:00
return "", errors.New("missing csrf token in the query string")
2018-06-10 11:11:41 +02:00
}
return token, nil
}
}
func validateCSRFToken(token, clientToken string) bool {
return subtle.ConstantTimeCompare([]byte(token), []byte(clientToken)) == 1
}