cookie

package
v0.2.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 18, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

View Source
const (
	AccessTokenName   = "access_token"
	RefreshTokenName  = "refresh_token"
	RegisterTokenName = "register_token"
	SessionIDName     = "session_id"
	CSRFTokenName     = "csrf_token"
)

Cookie names

View Source
const (
	AccessTokenMaxAge   = 60 * 60 * 24      // 24 hours
	RefreshTokenMaxAge  = 60 * 60 * 24 * 30 // 30 days
	RegisterTokenMaxAge = 60 * 60           // 1 hour
	SessionMaxAge       = 60 * 60 * 24      // 24 hours
	CSRFTokenMaxAge     = 60 * 60 * 24      // 24 hours
)

Cookie max ages (in seconds)

Variables

This section is empty.

Functions

func Clear

func Clear(w http.ResponseWriter)

Clear clears token cookies

func ClearAll

func ClearAll(w http.ResponseWriter)

ClearAll clears all authentication cookies

func ClearCSRFToken

func ClearCSRFToken(w http.ResponseWriter)

ClearCSRFToken clears CSRF token cookie

func ClearCookie

func ClearCookie(w http.ResponseWriter, name string, domain ...string)

ClearCookie clears a specific cookie

func ClearRegister

func ClearRegister(w http.ResponseWriter)

ClearRegister clears registration cookie

func ClearSessionID

func ClearSessionID(w http.ResponseWriter)

ClearSessionID clears session ID cookie

func Get

func Get(r *http.Request, key string) (string, error)

Get gets cookie value by name

func GetCSRFToken

func GetCSRFToken(r *http.Request) (string, error)

GetCSRFToken gets CSRF token from cookie

func GetRegister

func GetRegister(r *http.Request, key string) (string, error)

GetRegister gets registration cookie

func GetSessionID

func GetSessionID(r *http.Request) (string, error)

GetSessionID gets session ID from cookie

func GetTokenFromResult

func GetTokenFromResult(result *map[string]any, key string) (string, error)

GetTokenFromResult retrieves a token from the result map

func Set

func Set(w http.ResponseWriter, accessToken, refreshToken, domain string)

Set sets cookies

func SetAccessToken

func SetAccessToken(w http.ResponseWriter, accessToken, domain string)

SetAccessToken sets access token cookie

func SetCSRFToken

func SetCSRFToken(w http.ResponseWriter, csrfToken string, domain ...string) error

SetCSRFToken sets CSRF token cookie

func SetRefreshToken

func SetRefreshToken(w http.ResponseWriter, refreshToken string, domain ...string)

SetRefreshToken sets refresh token cookie

func SetRegister

func SetRegister(w http.ResponseWriter, registerToken, domain string)

SetRegister sets registration token cookie

func SetRegisterTokenFromResult

func SetRegisterTokenFromResult(w http.ResponseWriter, r *http.Request, result *map[string]any, domain ...string) error

SetRegisterTokenFromResult sets registration token from result map

func SetSecureCookie

func SetSecureCookie(w http.ResponseWriter, name, value string, maxAge int, domain ...string)

SetSecureCookie sets a secure cookie with common security settings

func SetSessionFromResult

func SetSessionFromResult(w http.ResponseWriter, r *http.Request, result *map[string]any, domain ...string) error

SetSessionFromResult sets session ID cookie from result map

func SetSessionID

func SetSessionID(w http.ResponseWriter, sessionID string, domain ...string) error

SetSessionID sets session ID cookie for web authentication

func SetTokensFromResult

func SetTokensFromResult(w http.ResponseWriter, r *http.Request, result *map[string]any, domain ...string) error

SetTokensFromResult sets access and refresh tokens from result map

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL