auth

Documentation

Overview

auth provides common user authentication functions

Index

• Variables
• func ChangePassword(username, newPW string) error
• func CreateUser(username string, password string) error
• func DeleteUser(username string) error
• func Signin(w http.ResponseWriter, r *http.Request)
• func Signout(w http.ResponseWriter, r *http.Request)
• func ValidateSignin(next http.Handler) http.Handler

Variables

var (
	// ErrInvalidUsername is logged by the ValidateSignin middleware when the username
	// included on the http request does not meet username character requirements
	ErrInvalidUsername = errors.New(
		"username included on request body is invalid (regex validation failure)")
	ErrWrongMethod = errors.New("wrong method used to access endpoint in package 'auth'")
)

errors used by the auth package

Functions

func ChangePassword

func ChangePassword(username, newPW string) error

func CreateUser

func CreateUser(username string, password string) error

func DeleteUser

func DeleteUser(username string) error

func Signin

func Signin(w http.ResponseWriter, r *http.Request)

func Signout

func Signout(w http.ResponseWriter, r *http.Request)

func ValidateSignin

func ValidateSignin(next http.Handler) http.Handler