Add CSRF middleware implementation and update go.mod/go.sum for dependencies

This commit is contained in:
Christian Galo 2025-04-28 20:26:17 -05:00
parent b0a8ec88b3
commit 8cf7841f20
4 changed files with 219 additions and 22 deletions

5
go.mod
View File

@ -8,7 +8,10 @@ require (
github.com/spf13/viper v1.19.0
)
require github.com/rs/cors v1.11.1 // indirect
require (
github.com/gorilla/csrf v1.7.3 // indirect
github.com/rs/cors v1.11.1 // indirect
)
require (
github.com/coreos/go-oidc/v3 v3.12.0

2
go.sum
View File

@ -17,6 +17,8 @@ github.com/google/gofuzz v1.2.0 h1:xRy4A+RhZaiKjJ1bPfwQ8sedCA+YS2YcCHW6ec7JMi0=
github.com/google/gofuzz v1.2.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
github.com/gorilla/csrf v1.7.3 h1:BHWt6FTLZAb2HtWT5KDBf6qgpZzvtbp9QWDRKZMXJC0=
github.com/gorilla/csrf v1.7.3/go.mod h1:F1Fj3KG23WYHE6gozCmBAezKookxbIvUJT+121wTuLk=
github.com/gorilla/securecookie v1.1.2 h1:YCIWL56dvtr73r6715mJs5ZvhtnY73hBvEF8kXD8ePA=
github.com/gorilla/securecookie v1.1.2/go.mod h1:NfCASbcHqRSY+3a8tlWJwsQap2VX5pwzwo4h3eOamfo=
github.com/gorilla/sessions v1.4.0 h1:kpIYOp/oi6MG/p5PgxApU8srsSw9tuFbt46Lt7auzqQ=

213
internal/middleware/csrf.go Normal file
View File

@ -0,0 +1,213 @@
package middleware
import (
"html/template"
"net/http"
"github.com/gorilla/csrf"
)
// CSRFConfig defines the configuration options for CSRF middleware
type CSRFConfig struct {
// Secret is the 32-byte secret key used to generate tokens
Secret []byte
// Cookie defines cookie options
Cookie struct {
// Name of the CSRF cookie
Name string
// Path where the cookie is valid
Path string
// Domain where the cookie is valid
Domain string
// MaxAge in seconds for the CSRF cookie
MaxAge int
// Secure sets the Secure flag on the cookie
Secure bool
// HttpOnly sets the HttpOnly flag on the cookie
HttpOnly bool
// SameSite sets the SameSite attribute on the cookie
SameSite csrf.SameSiteMode
}
// ErrorHandler to call when CSRF validation fails
ErrorHandler http.Handler
// FieldName is the name of the hidden input field used by frontend
FieldName string
// RequestHeader is the name of header used in AJAX requests
RequestHeader string
// TrustedOrigins lists additional origins that are trusted
TrustedOrigins []string
// Path defines URL paths where CSRF protection applies
// If empty, all paths are protected
Path string
// Ignore functions determine if a request should skip CSRF protection
Ignore []func(r *http.Request) bool
}
// DefaultCSRFConfig returns a default configuration for CSRF middleware
func DefaultCSRFConfig() CSRFConfig {
config := CSRFConfig{
Secret: nil, // Must be set by the application
FieldName: "gorilla.csrf.Token",
RequestHeader: "X-CSRF-Token",
Path: "",
Ignore: []func(r *http.Request) bool{},
}
config.Cookie.Name = "_csrf"
config.Cookie.Path = "/"
config.Cookie.MaxAge = 86400 // 24 hours
config.Cookie.Secure = true
config.Cookie.HttpOnly = true
config.Cookie.SameSite = csrf.SameSiteStrictMode
return config
}
// CSRF middleware provides Cross-Site Request Forgery protection
func CSRF(config CSRFConfig) Middleware {
options := []csrf.Option{
csrf.CookieName(config.Cookie.Name),
csrf.Path(config.Cookie.Path),
csrf.MaxAge(config.Cookie.MaxAge),
csrf.FieldName(config.FieldName),
csrf.RequestHeader(config.RequestHeader),
csrf.Secure(config.Cookie.Secure),
csrf.HttpOnly(config.Cookie.HttpOnly),
csrf.SameSite(config.Cookie.SameSite),
}
if config.Cookie.Domain != "" {
options = append(options, csrf.Domain(config.Cookie.Domain))
}
if config.ErrorHandler != nil {
options = append(options, csrf.ErrorHandler(config.ErrorHandler))
}
if len(config.TrustedOrigins) > 0 {
options = append(options, csrf.TrustedOrigins(config.TrustedOrigins))
}
// Create CSRF protection middleware
csrfHandler := csrf.Protect(config.Secret, options...)
return func(next http.Handler) http.Handler {
// Handle protection path
if config.Path != "" {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.URL.Path == config.Path || (len(r.URL.Path) >= len(config.Path) &&
r.URL.Path[:len(config.Path)] == config.Path) {
// Check if the request should be ignored
for _, ignoreFunc := range config.Ignore {
if ignoreFunc(r) {
next.ServeHTTP(w, r)
return
}
}
csrfHandler(next).ServeHTTP(w, r)
return
}
next.ServeHTTP(w, r)
})
}
// Handle ignore functions
if len(config.Ignore) > 0 {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
for _, ignoreFunc := range config.Ignore {
if ignoreFunc(r) {
next.ServeHTTP(w, r)
return
}
}
csrfHandler(next).ServeHTTP(w, r)
})
}
// Apply CSRF to all routes if no path or ignores specified
return csrfHandler(next)
}
}
// CSRFToken gets the CSRF token from the request context
func CSRFToken(r *http.Request) string {
return csrf.Token(r)
}
// CSRFTemplateField gets the hidden input field containing the CSRF token
func CSRFTemplateField(r *http.Request) template.HTML {
return csrf.TemplateField(r)
}
/* Usage example:
1. Create a secure key for CSRF protection:
key := make([]byte, 32)
_, err := rand.Read(key)
if err != nil {
log.Fatal(err)
}
2. Create CSRF middleware with default configuration:
csrfConfig := middleware.DefaultCSRFConfig()
csrfConfig.Secret = key
csrfMiddleware := middleware.CSRF(csrfConfig)
3. Add the middleware to your routing (example with standard http):
handler := middleware.CreateStack(
middleware.RequestID(),
middleware.Logging(logger),
middleware.CORS(corsConfig),
middleware.CSRF(csrfConfig), // Add CSRF protection
)(router)
4. In your HTML templates, include the CSRF token in forms:
<form method="post" action="/protected">
{{ .CSRFField }}
<input type="text" name="username">
<button type="submit">Submit</button>
</form>
Where .CSRFField is provided to the template as:
data := map[string]interface{}{
"CSRFField": middleware.CSRFTemplateField(r),
}
5. For AJAX requests, include the CSRF token in the request header:
// JavaScript example
fetch('/api/protected', {
method: 'POST',
headers: {
'X-CSRF-Token': document.querySelector('meta[name="csrf-token"]').getAttribute('content'),
},
body: JSON.stringify(data)
})
// Include meta tag in your HTML:
// <meta name="csrf-token" content="{{ .CSRFToken }}">
Where .CSRFToken is provided to the template as:
data := map[string]interface{}{
"CSRFToken": middleware.CSRFToken(r),
}
*/

View File

@ -2,8 +2,6 @@ package middleware
import (
"net/http"
"github.com/gorilla/sessions"
)
// SecurityHeaders adds security and cache-control headers to all responses
@ -54,25 +52,6 @@ func SecureHeaders() Middleware {
}
}
// middleware/csrf.go
func CSRFMiddleware(store sessions.Store) Middleware {
return func(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.Method == "POST" {
session, _ := store.Get(r, "auth-session")
csrfToken := session.Values["csrf_token"].(string)
formToken := r.FormValue("_csrf")
if csrfToken != formToken {
http.Error(w, "Invalid CSRF token", http.StatusForbidden)
return
}
}
next.ServeHTTP(w, r)
})
}
}
// MaxBodySize limits the maximum size of request bodies
// size parameter is in bytes
func MaxBodySize(maxSize int64) Middleware {