README
¶
Usage
Simple example:
package main
import (
"log/slog"
"github.com/casbin/casbin/v2"
casbin_mw "github.com/labstack/echo-contrib/v5/casbin"
"github.com/labstack/echo/v5"
)
func main() {
e := echo.New()
// Mediate the access for every request
enforcer, err := casbin.NewEnforcer("auth_model.conf", "auth_policy.csv")
if err != nil {
slog.Error("failed to load casbin enforcer", "error", err)
}
e.Use(casbin_mw.Middleware(enforcer))
if err := e.Start(":1323"); err != nil {
slog.Error("failed to start server", "error", err)
}
}
Advanced example:
package main
import (
"log/slog"
"github.com/casbin/casbin/v2"
casbin_mw "github.com/labstack/echo-contrib/v5/casbin"
"github.com/labstack/echo/v5"
)
func main() {
ce, _ := casbin.NewEnforcer("auth_model.conf", "")
ce.AddRoleForUser("alice", "admin")
ce.AddPolicy(...)
e := echo.New()
e.Use(casbin_mw.Middleware(ce))
if err := e.Start(":1323"); err != nil {
slog.Error("failed to start server", "error", err)
}
}
API Reference
See API Overview.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // DefaultConfig is the default CasbinAuth middleware config. DefaultConfig = Config{ Skipper: middleware.DefaultSkipper, UserGetter: func(c *echo.Context) (string, error) { username, _, _ := c.Request().BasicAuth() return username, nil }, ErrorHandler: func(c *echo.Context, internal error, proposedStatus int) error { return echo.NewHTTPError(proposedStatus, internal.Error()).Wrap(internal) }, } )
Functions ¶
func Middleware ¶
func Middleware(ce *casbin.Enforcer) echo.MiddlewareFunc
Middleware returns a CasbinAuth middleware.
For valid credentials it calls the next handler. For missing or invalid credentials, it sends "401 - Unauthorized" response.
func MiddlewareWithConfig ¶
func MiddlewareWithConfig(config Config) echo.MiddlewareFunc
MiddlewareWithConfig returns a CasbinAuth middleware with config. See `Middleware()`.
Types ¶
type Config ¶
type Config struct {
// Skipper defines a function to skip middleware.
Skipper middleware.Skipper
// Enforcer CasbinAuth main rule.
// One of Enforcer or EnforceHandler fields is required.
Enforcer *casbin.Enforcer
// EnforceHandler is custom callback to handle enforcing.
// One of Enforcer or EnforceHandler fields is required.
EnforceHandler func(c *echo.Context, user string) (bool, error)
// Method to get the username - defaults to using basic auth
UserGetter func(c *echo.Context) (string, error)
// Method to handle errors
ErrorHandler func(c *echo.Context, internal error, proposedStatus int) error
}
Config defines the config for CasbinAuth middleware.
Source Files
Click to show internal directories.
Click to hide internal directories.