Documentation
¶
Overview ¶
Package auth provides user authentication.
Index ¶
- Constants
- func BearerTokenFromContext(ctx context.Context) string
- func CreateNewTempSession(s *database.SessionStore, userID int64) (accessToken string, expiresIn int32, err error)
- func GenerateKey() (string, error)
- func GetAuthErrorCodeFromError(err error) int
- func GetOAuthConfig(config *viper.Viper) *oauth2.Config
- func MockUserMiddleware(user *database.User) func(next http.Handler) http.Handler
- func UserFromContext(ctx context.Context) *database.User
- func UserMiddleware(service GetStorer) func(next http.Handler) http.Handler
- func ValidatesUserAuthentication(service GetStorer, w http.ResponseWriter, r *http.Request) (context.Context, bool, error)
- type GetStorer
- type SessionCookieAttributes
Constants ¶
const TemporaryUserSessionLifetimeInSeconds = int32(2 * time.Hour / time.Second) // 2 hours (7200 seconds)
TemporaryUserSessionLifetimeInSeconds specifies the lifetime of the access token for a temporary user.
Variables ¶
This section is empty.
Functions ¶
func BearerTokenFromContext ¶
BearerTokenFromContext retrieves a bearer token from a context set by the middleware.
func CreateNewTempSession ¶
func CreateNewTempSession(s *database.SessionStore, userID int64) ( accessToken string, expiresIn int32, err error, )
CreateNewTempSession creates a new session for a temporary user.
func GenerateKey ¶
GenerateKey generate a random string that can be used as an access token for a temporary user's session. The entropy of the generated string (assuming "crypto/rand" is well implemented) is 36^32, so ~165 bits.
func GetAuthErrorCodeFromError ¶ added in v1.9.3
GetAuthErrorCodeFromError gets the HTTP error code.
func GetOAuthConfig ¶
GetOAuthConfig generates the OAuth2 config from a configuration.
func MockUserMiddleware ¶
MockUserMiddleware is a middleware to be used to mock a fixed user in the context.
func UserFromContext ¶
UserFromContext retrieves a user from a context set by the middleware.
func UserMiddleware ¶
UserMiddleware is a middleware retrieving a user from the request content. It takes the access token from the 'Authorization' header and loads the user info from the DB.
func ValidatesUserAuthentication ¶ added in v1.9.0
func ValidatesUserAuthentication(service GetStorer, w http.ResponseWriter, r *http.Request) (context.Context, bool, error)
ValidatesUserAuthentication checks the authentication in the Authorization header and in the "access_token" cookie. It returns:
- A request context with the user authenticated on success
- Whether the authentication was a success
- The reason why the user couldn't be authenticated
Types ¶
type GetStorer ¶ added in v1.3.0
GetStorer is an interface allowing to get a data store bound to the context of the given request.
type SessionCookieAttributes ¶
type SessionCookieAttributes struct {
UseCookie bool
Secure bool
SameSite bool
Domain string
Path string
}
SessionCookieAttributes represents attributes of the session cookie.
func ParseSessionCookie ¶
func ParseSessionCookie(r *http.Request) (accessToken string, cookieAttributes SessionCookieAttributes)
ParseSessionCookie parses the 'access_token' cookie (if given) and returns the access token among with cookie attributes.
func SessionCookieAttributesFromContext ¶
func SessionCookieAttributesFromContext(ctx context.Context) *SessionCookieAttributes
SessionCookieAttributesFromContext retrieves session cookie attributes from a context set by the middleware. The nil result means the middleware hasn't been called.
func (*SessionCookieAttributes) SessionCookie ¶
func (attributes *SessionCookieAttributes) SessionCookie(token string, secondsUntilExpiry int32) *http.Cookie
SessionCookie constructs a session cookie with the given attributes.
Source Files