claims

Documentation

Index

• Constants
• func IsAdmin(ctx context.Context) bool
• func IsUser(ctx context.Context, id string) bool
• func Set(ctx context.Context, claims Claims) context.Context
• type Claims
  • func Get(ctx context.Context) (Claims, error)

Constants

const (
	RoleAdmin = "ADMIN"
	RoleUser  = "USER"
)

These are the expected values for Claims.Roles.

Functions

func IsAdmin

func IsAdmin(ctx context.Context) bool

IsAdmin checks if the session contained in the context, if any, belongs to an administrator. Returns false if no session is found or if the user is not an administrator.

func IsUser

func IsUser(ctx context.Context, id string) bool

IsAdmin checks if the session contained in the context, if any, belongs to the passed user id. Returns false if no session is found or if the user is not equal to the same passed.

func Set

func Set(ctx context.Context, claims Claims) context.Context

Set stores the claims in the context.

Types

type Claims

type Claims struct {
	UserID string
	Role   string
}

Claims represents the authorization claims stored in the session.

func Get

func Get(ctx context.Context) (Claims, error)

Get returns the claims from the context.