auth

Documentation

Overview

Package auth handles auth

Index

• Constants
• Variables
• func AddAuthenticatedUserContext(c echo.Context, user *AuthenticatedUser) context.Context
• func AddOrganizationIDToContext(ctx context.Context, orgID string) error
• func AuthContextFromRequest(c echo.Context) (*context.Context, error)
• func ClearAuthCookies(w http.ResponseWriter)
• func CookieExpired(cookie *http.Cookie) bool
• func GetAccessToken(c echo.Context) (string, error)
• func GetAuthzSubjectType(ctx context.Context) string
• func GetContextName(key *ContextKey) string
• func GetOrganizationIDFromContext(ctx context.Context) (string, error)
• func GetOrganizationIDsFromContext(ctx context.Context) ([]string, error)
• func GetOrganizationNameFromContext(ctx context.Context) (string, error)
• func GetRefreshToken(c echo.Context) (string, error)
• func GetUserIDFromContext(ctx context.Context) (string, error)
• func GetUserNameFromContext(ctx context.Context) (string, error)
• func IsAPITokenAuthentication(ctx context.Context) bool
• func NewTestContextWithOrgID(sub, orgID string) (context.Context, error)
• func NewTestContextWithValidUser(subject string) (context.Context, error)
• func NewTestEchoContextWithOrgID(sub, orgID string) (echo.Context, error)
• func NewTestEchoContextWithValidUser(subject string) (echo.Context, error)
• func SetAuthCookies(w http.ResponseWriter, accessToken, refreshToken string)
• func SetAuthenticatedUserContext(c echo.Context, user *AuthenticatedUser)
• type AuthenticatedUser
  • func GetAuthenticatedUserContext(c context.Context) (*AuthenticatedUser, error)
• type AuthenticationType
  • func GetAuthTypeFromContext(ctx context.Context) AuthenticationType
  • func GetAuthTypeFromEchoContext(c echo.Context) AuthenticationType
• type ContextKey

Constants

const (
	// Authorization is the key used in HTTP headers or cookies to represent the authorization token
	Authorization = "Authorization"
	// AccessTokenCookie is the key used in cookies to represent the access token
	AccessTokenCookie = "access_token"
	// RefreshTokenCookie is the key used in cookies to represent the refresh token
	RefreshTokenCookie = "refresh_token"
)

const (
	// UserSubjectType is the subject type for user accounts
	UserSubjectType = "user"
	// ServiceSubjectType is the subject type for service accounts
	ServiceSubjectType = "service"
)

Variables

var (
	// ErrNoClaims is returned when no claims are found on the request context
	ErrNoClaims = errors.New("no claims found on the request context")

	// ErrNoUserInfo is returned when no user info is found on the request context
	ErrNoUserInfo = errors.New("no user info found on the request context")

	// ErrNoAuthUser is returned when no authenticated user is found on the request context
	ErrNoAuthUser = errors.New("could not identify authenticated user in request")

	// ErrUnverifiedUser is returned when the user is not verified
	ErrUnverifiedUser = errors.New("user is not verified")

	// ErrParseBearer is returned when the bearer token could not be parsed from the authorization header
	ErrParseBearer = errors.New("could not parse bearer token from authorization header")

	// ErrNoAuthorization is returned when no authorization header is found in the request
	ErrNoAuthorization = errors.New("no authorization header in request")

	// ErrNoRequest is returned when no request is found on the context
	ErrNoRequest = errors.New("no request found on the context")

	// ErrNoRefreshToken is returned when no refresh token is found on the request
	ErrNoRefreshToken = errors.New("no refresh token available on request")

	// ErrRefreshDisabled is returned when re-authentication with refresh tokens is disabled
	ErrRefreshDisabled = errors.New("re-authentication with refresh tokens disabled")

	// ErrUnableToConstructValidator is returned when the validator cannot be constructed
	ErrUnableToConstructValidator = errors.New("unable to construct validator")

	// ErrPasswordTooWeak is returned when the password is too weak
	ErrPasswordTooWeak = errors.New("password is too weak: use a combination of upper and lower case letters, numbers, and special characters")
)

var ContextAccessToken = &ContextKey{"access_token"}

ContextAccessToken is the context key for the access token

var ContextAuthenticatedUser = &ContextKey{"authenticated_user"}

ContextAuthenticatedUser is the context key for the user claims

var ContextRequestID = &ContextKey{"request_id"}

ContextRequestID is the context key for the request ID

Functions

func AddAuthenticatedUserContext

func AddAuthenticatedUserContext(c echo.Context, user *AuthenticatedUser) context.Context

AddAuthenticatedUserContext adds the authenticated user context and returns the context

func AddOrganizationIDToContext

func AddOrganizationIDToContext(ctx context.Context, orgID string) error

AddOrganizationIDToContext appends an authorized organization ID to the context. This generally should not be used, as the authorized organization should be determined by the claims or the token. This is only used in cases where the a user is newly authorized to an organization and the organization ID is not in the token claims

func AuthContextFromRequest

func AuthContextFromRequest(c echo.Context) (*context.Context, error)

AuthContextFromRequest creates a context from the echo request context, copying fields that may be required for forwarded requests. This method should be called by handlers which need to forward requests to other services and need to preserve data from the original request such as the user's credentials.

func ClearAuthCookies

func ClearAuthCookies(w http.ResponseWriter)

ClearAuthCookies is a helper function to clear authentication cookies on a echo request to effectively logger out a user.

func CookieExpired

func CookieExpired(cookie *http.Cookie) bool

CookieExpired checks to see if a cookie is expired

func GetAccessToken

func GetAccessToken(c echo.Context) (string, error)

GetAccessToken retrieves the bearer token from the authorization header and parses it to return only the JWT access token component of the header. Alternatively, if the authorization header is not present, then the token is fetched from cookies. If the header is missing or the token is not available, an error is returned.

NOTE: the authorization header takes precedence over access tokens in cookies.

func GetAuthzSubjectType

func GetAuthzSubjectType(ctx context.Context) string

GetAuthzSubjectType returns the subject type based on the authentication type

func GetContextName

func GetContextName(key *ContextKey) string

GetContextName returns the name of the context key

func GetOrganizationIDFromContext

func GetOrganizationIDFromContext(ctx context.Context) (string, error)

GetOrganizationIDFromContext returns the organization ID from context

func GetOrganizationIDsFromContext

func GetOrganizationIDsFromContext(ctx context.Context) ([]string, error)

GetOrganizationIDsFromContext returns the list of organization IDs from context

func GetOrganizationNameFromContext

func GetOrganizationNameFromContext(ctx context.Context) (string, error)

GetOrganizationNameFromContext returns the organization name from context

func GetRefreshToken

func GetRefreshToken(c echo.Context) (string, error)

GetRefreshToken retrieves the refresh token from the cookies in the request. If the cookie is not present or expired then an error is returned.

func GetUserIDFromContext

func GetUserIDFromContext(ctx context.Context) (string, error)

GetUserIDFromContext returns the actor subject from the context

func GetUserNameFromContext

func GetUserNameFromContext(ctx context.Context) (string, error)

GetUserNameFromContext returns the actor name from the context

func IsAPITokenAuthentication

func IsAPITokenAuthentication(ctx context.Context) bool

func NewTestContextWithOrgID

func NewTestContextWithOrgID(sub, orgID string) (context.Context, error)

func NewTestContextWithValidUser

func NewTestContextWithValidUser(subject string) (context.Context, error)

func NewTestEchoContextWithOrgID

func NewTestEchoContextWithOrgID(sub, orgID string) (echo.Context, error)

NewTestEchoContextWithOrgID creates an echo context with a fake orgID for testing purposes ONLY

func NewTestEchoContextWithValidUser

func NewTestEchoContextWithValidUser(subject string) (echo.Context, error)

NewTestEchoContextWithValidUser creates an echo context with a fake subject for testing purposes ONLY

func SetAuthCookies

func SetAuthCookies(w http.ResponseWriter, accessToken, refreshToken string)

SetAuthCookies is a helper function to set authentication cookies on a echo request. The access token cookie (access_token) is an http only cookie that expires when the access token expires. The refresh token cookie is not an http only cookie (it can be accessed by client-side scripts) and it expires when the refresh token expires. Both cookies require https and will not be set (silently) over http connections.

func SetAuthenticatedUserContext

func SetAuthenticatedUserContext(c echo.Context, user *AuthenticatedUser)

SetAuthenticatedUserContext sets the authenticated user context in the echo context

Types

type AuthenticatedUser

type AuthenticatedUser struct {
	// SubjectID is the user ID of the authenticated user or the api token ID if the user is an API token
	SubjectID string
	// SubjectName is the name of the authenticated user
	SubjectName string
	// OrganizationID is the organization ID of the authenticated user
	OrganizationID string
	// OrganizationName is the name of the organization the user is authenticated to
	OrganizationName string
	// OrganizationIDs is the list of organization IDs the user is authorized to access
	OrganizationIDs []string
	// AuthenticationType is the type of authentication used to authenticate the user (JWT, PAT, API Token)
	AuthenticationType AuthenticationType
}

AuthenticatedUser contains the user and organization ID for the authenticated user

func GetAuthenticatedUserContext

func GetAuthenticatedUserContext(c context.Context) (*AuthenticatedUser, error)

GetAuthenticatedUserContext gets the authenticated user context

type AuthenticationType

type AuthenticationType string

const (
	// JWTAuthentication is the authentication type for JWT tokens
	JWTAuthentication AuthenticationType = "jwt"
	// PATAuthentication is the authentication type for personal access tokens
	PATAuthentication AuthenticationType = "pat"
	// APITokenAuthentication is the authentication type for API tokens
	APITokenAuthentication AuthenticationType = "api_token"
)

func GetAuthTypeFromContext

func GetAuthTypeFromContext(ctx context.Context) AuthenticationType

GetAuthTypeFromEchoContext retrieves the authentication type from the context

func GetAuthTypeFromEchoContext

func GetAuthTypeFromEchoContext(c echo.Context) AuthenticationType

GetAuthTypeFromEchoContext retrieves the authentication type from the echo context

type ContextKey

type ContextKey struct {
	// contains filtered or unexported fields
}

ContextKey is the key name for the additional context