token

Documentation

Index

• Constants
• func CheckCsrf(r *http.Request, fn SecretFunc) error
• type SecretFunc
• type Token
  • func New(kind, text string) *Token
  • func Parse(raw string, fn SecretFunc) (*Token, error)
  • func ParseRequest(r *http.Request, fn SecretFunc) (*Token, error)
  • func (t *Token) Sign(secret string) (string, error)
  • func (t *Token) SignExpires(secret string, exp int64) (string, error)

Constants

const (
	// UserToken is the name of the user token.
	UserToken = "user"

	// SessToken is the name of the session token.
	SessToken = "sess"

	// HookToken is the name of the hook token.
	HookToken = "hook"

	// CsrfToken is the name of the CSRF token.
	CsrfToken = "csrf"
)

const SignerAlgo = "HS256"

SignerAlgo defines the default algorithm used to sign JWT tokens.

Functions

func CheckCsrf

func CheckCsrf(r *http.Request, fn SecretFunc) error

CheckCsrf checks the validity of the JWT.

Types

type SecretFunc

type SecretFunc func(*Token) (string, error)

SecretFunc is the definition of the required secret retrieval function.

type Token

type Token struct {
	Kind string
	Text string
}

Token represents our simple JWT.

func New

func New(kind, text string) *Token

New initializes a new JWT.

func Parse

func Parse(raw string, fn SecretFunc) (*Token, error)

Parse parses a raw JWT.

func ParseRequest

func ParseRequest(r *http.Request, fn SecretFunc) (*Token, error)

ParseRequest parses a JWT from the request.

func (*Token) Sign

func (t *Token) Sign(secret string) (string, error)

Sign signs the token using the given secret hash and returns the string value.

func (*Token) SignExpires

func (t *Token) SignExpires(secret string, exp int64) (string, error)

SignExpires signs the token using the given secret hash with an expiration date.