auth

Documentation

Index

• func GetPrincipal(c *gin.Context) (jwt.User, bool)
• func MustGetPrincipal(c *gin.Context) (jwt.User, error)
• type RBAC
  • func NewRBAC(creds jwt.Credentials) RBAC
  • func (r *RBAC) Secure(requiredScope scope.Scope) gin.HandlerFunc

Functions

func GetPrincipal

func GetPrincipal(c *gin.Context) (jwt.User, bool)

GetPrincipal returns the authenticated user if exists.

func MustGetPrincipal

func MustGetPrincipal(c *gin.Context) (jwt.User, error)

MustGetPrincipal returns the authenticated user or an error if none exists.

Types

type RBAC

type RBAC struct {
	Verifier jwt.Verifier
}

RBAC adds role based access controll checks extracting roles from jwt.

func NewRBAC

func NewRBAC(creds jwt.Credentials) RBAC

NewRBAC creates a new RBAC struct with sane defaults.

func (*RBAC) Secure

func (r *RBAC) Secure(requiredScope scope.Scope) gin.HandlerFunc

Secure checks if a request was made with a jwt containing a specified list of roles.