authz

README

CleverGo Authorization Middleware

Usage

import (
    "clevergo.tech/authz"
    "clevergo.tech/clevergo"
)

enforcer, _ := casbin.NewEnforcer("casbin_model.conf", "casbin_policy.csv")
userFunc := func(c *clevergo.Context) (id string, err error) {
    // returns the authenticated user ID.
    return
}
app := clevergo.New()
app.Use(authz.New(enforcer, userFunc))

Documentation

Index

• Variables
• func New(enforcer *casbin.Enforcer, userFunc UserFunc, opts ...Option) clevergo.MiddlewareFunc
• type Option
  • func WithSkipper(skipper clevergo.Skipper) Option
• type UserFunc

Variables

var (
	ErrUnauthorized = clevergo.NewError(http.StatusUnauthorized, errors.New(http.StatusText(http.StatusUnauthorized)))
	ErrForbidden    = clevergo.NewError(http.StatusForbidden, errors.New("you are not allowed to access this page"))
)

Errors

Functions

func New

func New(enforcer *casbin.Enforcer, userFunc UserFunc, opts ...Option) clevergo.MiddlewareFunc

New returns a middleware with the given enforcer, user function and optional options.

Types

type Option

type Option func(*authorization)

Option is a function that apply on authorization middleware.

func WithSkipper

func WithSkipper(skipper clevergo.Skipper) Option

WithSkipper is an option that set authorization's skipper.

type UserFunc

type UserFunc func(c *clevergo.Context) (id string, err error)

UserFunc is a function that returns a string which represents the authenticated user.