xsrf

Documentation

Overview

Package xsrf provides simple routines for creating and retrieving XSRF tokens with the Angular framework.

Index

• Constants
• func Cookie(t tokens.AuthToken) *http.Cookie
• func FromHeader(h http.Header) (t tokens.AuthToken, err error)
• func FromRequest(r *http.Request) (t tokens.AuthToken, err error)
• func Hash(t tokens.AuthToken) []byte

Constants

const CookieName = "XSRF-TOKEN"

CookieName is the name of the cookie angular checks to determine whether it should send an "X-XSRF-TOKEN" header.

Functions

func Cookie

func Cookie(t tokens.AuthToken) *http.Cookie

Cookie returns an http.Cookie with the Name and Value fields set.

func FromHeader

func FromHeader(h http.Header) (t tokens.AuthToken, err error)

FromHeader fetches the Token from the X-XSRF-TOKEN header, if it exists.

func FromRequest

func FromRequest(r *http.Request) (t tokens.AuthToken, err error)

FromRequest fetches the Token from the X-XSRF-TOKEN header, if it exists.

func Hash

func Hash(t tokens.AuthToken) []byte

Hash returns the SHAKE-256 hash of the token. Hash should be used when storing the XSRF token on the backend and comparisons should be done in constant-time function, using a function like those found in crypto/subtle.