csrf

package

v0.16.0 Latest Latest Go to latest Published: Nov 1, 2026 License: MIT Imports: 6 Imported by: 0

Details

Package csrf provides experimental CSRF token helpers for templates.

View Source

const DefaultTokenKey = "X-CSRF-Token"

DefaultTokenKey is the default form/header name used by fallback tokens.

This section is empty.

func FuncMap() template.FuncMap

FuncMap returns placeholders for the csrf template helper.

go-doc:funcmap

func Stage() partial.RenderStage

Stage gives templates the csrf helper from the render context. It is made only for the templates that call it.

func WithToken(ctx context.Context, token Token) context.Context

WithToken stores a Token on a context.

func WithTokenString(ctx context.Context, token string) context.Context

WithTokenString stores a raw token string on a context.

type Token interface {
	Token(ctx context.Context) string
	Key() string
}

Token describes the CSRF token exposed to templates.

func CSRF(ctx ...*partial.RenderContext) Token

CSRF returns the configured token for a render context.

go-doc:sig func() github.com/donseba/go-partial/exp/csrf.Token

func FromContext(ctx context.Context) Token

FromContext returns the configured Token or an invalid fallback token.