auth

Documentation

Index

• Constants
• func GetAuthenticatedOrgMemberNoFail(ginctx *gin.Context) dbmodels.IOrganizationMember
• func NewJwtMiddleware(db *gorm.DB) (*jwt.GinJWTMiddleware, error)
• func NewOrgMemberLookupMiddleware(db *gorm.DB, testing bool) gin.HandlerFunc

Constants

const OrgMemberContextKey = "authenticated_organization_member"

Functions

func GetAuthenticatedOrgMemberNoFail

func GetAuthenticatedOrgMemberNoFail(ginctx *gin.Context) dbmodels.IOrganizationMember

GetAuthenticatedOrgMemberNoFail returns the OrganizationMember that's authenticated with the current request.

It assumes that the `NewOrgMemberLookupMiddleware()` middleware has already run, hence this function never returns an error.

func NewJwtMiddleware

func NewJwtMiddleware(db *gorm.DB) (*jwt.GinJWTMiddleware, error)

func NewOrgMemberLookupMiddleware

func NewOrgMemberLookupMiddleware(db *gorm.DB, testing bool) gin.HandlerFunc

NewOrgMemberLookupMiddleware returns a Gin middleware which finds out which organization member is authenticated with the current request, looks up its record from the database, and associates that record with the current request.

If `testing` is true, then it determines which organization member is authenticated by looking at the HTTP headers `TestOrgID`, `TestOrgMemberType` and `TestOrgMemberID`.

If `testing` is false, or if no HTTP headers specify which organization member to authenticate as, then it looks at the JWT authorization token. This requires that the `NewJwtMiddleware()` middleware has already run.

You can get the looked up record using `GetAuthenticatedOrgMemberNoFail()`.

If no OrganizationMember is found at the end, or if some other error occurs, then this middleware aborts the request with an error.