gate

Documentation

Index

• func Admin(g Gate) echo.MiddlewareFunc
• func Member(g Gate, idparam string) echo.MiddlewareFunc
• func MemberF(g Gate, idfunc func(echo.Context, string) (string, error)) echo.MiddlewareFunc
• func Mod(g Gate, idparam string) echo.MiddlewareFunc
• func ModF(g Gate, idfunc func(echo.Context, string) (string, error)) echo.MiddlewareFunc
• func Owner(g Gate, idparam string) echo.MiddlewareFunc
• func OwnerF(g Gate, idfunc func(echo.Context, string) (string, error)) echo.MiddlewareFunc
• func OwnerOrAdmin(g Gate, idparam string) echo.MiddlewareFunc
• func OwnerOrAdminF(g Gate, idfunc func(echo.Context, string) (string, error)) echo.MiddlewareFunc
• func OwnerOrMemberF(g Gate, idfunc func(echo.Context, string) (string, string, error)) echo.MiddlewareFunc
• func System(g Gate) echo.MiddlewareFunc
• func User(g Gate) echo.MiddlewareFunc
• func UserOrBan(g Gate, idparam string) echo.MiddlewareFunc
• func UserOrBanF(g Gate, idfunc func(echo.Context, string) (string, error)) echo.MiddlewareFunc
• type Claims
• type Gate
• type Intersector
• type Service
  • func New(roles role.Role, tokenizer token.Tokenizer) Service
• type Validator

Functions

func Admin

func Admin(g Gate) echo.MiddlewareFunc

Admin is a middleware function to validate if a user is an admin

func Member

func Member(g Gate, idparam string) echo.MiddlewareFunc

Member is a middleware function to validate if the request is made by a member of a group and check if the user is banned from the group

func MemberF

func MemberF(g Gate, idfunc func(echo.Context, string) (string, error)) echo.MiddlewareFunc

MemberF is a middleware function to validate if the request is made by a member of a group and check if the user is banned from the group

idfunc should return the group_tag

func Mod

func Mod(g Gate, idparam string) echo.MiddlewareFunc

Mod is a middleware function to validate if the request is made by the moderator of a group or an admin

func ModF

func ModF(g Gate, idfunc func(echo.Context, string) (string, error)) echo.MiddlewareFunc

ModF is a middleware function to validate if the request is made by the moderator of a group or an admin

idfunc should return the group_tag

func Owner

func Owner(g Gate, idparam string) echo.MiddlewareFunc

Owner is a middleware function to validate if a user owns the accessed resource

func OwnerF

func OwnerF(g Gate, idfunc func(echo.Context, string) (string, error)) echo.MiddlewareFunc

OwnerF is a middleware function to validate if a user owns the accessed resource

idfunc should return the userid

func OwnerOrAdmin

func OwnerOrAdmin(g Gate, idparam string) echo.MiddlewareFunc

OwnerOrAdmin is a middleware function to validate if the request is made by the owner or an admin

func OwnerOrAdminF

func OwnerOrAdminF(g Gate, idfunc func(echo.Context, string) (string, error)) echo.MiddlewareFunc

OwnerOrAdminF is a middleware function to validate if the request is made by the owner or an admin

idfunc should return the userid

func OwnerOrMemberF

func OwnerOrMemberF(g Gate, idfunc func(echo.Context, string) (string, string, error)) echo.MiddlewareFunc

OwnerOrMemberF is a middleware function to validate if the request is made by the owner or a group member

idfunc should return the userid and the group_tag

func System

func System(g Gate) echo.MiddlewareFunc

System is a middleware function to validate if the request is made by a system

func User

func User(g Gate) echo.MiddlewareFunc

User is a middleware function to validate if the request is made by a user

func UserOrBan

func UserOrBan(g Gate, idparam string) echo.MiddlewareFunc

UserOrBan is a middleware function to validate if the request is made by a user and check if the user is banned from the group

func UserOrBanF

func UserOrBanF(g Gate, idfunc func(echo.Context, string) (string, error)) echo.MiddlewareFunc

UserOrBanF is a middleware function to validate if the request is made by a user and check if the user is banned from the group

idfunc should return the group_tag

Types

type Claims

type Claims struct {
	token.Claims
}

type Gate

type Gate interface {
	Authenticate(v Validator, subject string) echo.MiddlewareFunc
}

Gate creates new middleware to gate routes

type Intersector

type Intersector interface {
	Userid() string
	Intersect(roles rank.Rank) (rank.Rank, bool)
	Context() echo.Context
}

Intersector is a function that returns roles needed to validate a user

type Service

type Service interface {
	governor.Service
	Gate
}

func New

func New(roles role.Role, tokenizer token.Tokenizer) Service

New returns a new Gate

type Validator

type Validator func(r Intersector) bool

Validator is a function to check the authorization of a user