|
| 1 | +--- |
| 2 | +title: Casbin 認可 |
| 3 | +description: 小さなカスタムミドルウェアで Casbin アクセス制御ライブラリを使い、リクエストを認可します。 |
| 4 | +sidebar: |
| 5 | + order: 4 |
| 6 | +--- |
| 7 | + |
| 8 | +[Casbin](https://github.com/casbin/casbin) は、Go 向けの強力で効率的なオープンソース |
| 9 | +アクセス制御ライブラリです。多くのモデルで認可を強制できます。 |
| 10 | + |
| 11 | +- ACL（Access Control List） |
| 12 | +- スーパーユーザー付き ACL |
| 13 | +- ユーザーなし ACL：認証やユーザーログインがないシステムに有用 |
| 14 | +- リソースなし ACL：個別リソースではなく、リソース種別（例：`write-article`、`read-log`）を対象にする |
| 15 | +- RBAC（Role-Based Access Control） |
| 16 | +- リソースロール付き RBAC：ユーザーとリソースの両方がロールを持てる |
| 17 | +- ドメイン/テナント付き RBAC：ユーザーがドメイン/テナントごとに異なるロールセットを持てる |
| 18 | +- ABAC（Attribute-Based Access Control） |
| 19 | +- RESTful |
| 20 | +- Deny-override：allow と deny の両方のルールをサポートし、deny が allow を上書きする |
| 21 | + |
| 22 | +詳細は [API overview](https://casbin.org/docs/api-overview) と |
| 23 | +[Casbin documentation](https://casbin.org/docs/) を参照してください。 |
| 24 | + |
| 25 | +## 依存関係 |
| 26 | + |
| 27 | +```bash |
| 28 | +go get github.com/casbin/casbin/v3 |
| 29 | +``` |
| 30 | + |
| 31 | +```go |
| 32 | +import ( |
| 33 | + "github.com/casbin/casbin/v3" |
| 34 | +) |
| 35 | +``` |
| 36 | + |
| 37 | +## 実装 |
| 38 | + |
| 39 | +Echo には Casbin ミドルウェアは同梱されていません。この連携は Casbin enforcer の小さなラッパーです。 |
| 40 | + |
| 41 | +```go |
| 42 | +// NewCasbinMiddleware returns middleware for Casbin (https://casbin.org/). |
| 43 | +func NewCasbinMiddleware(enforcer *casbin.Enforcer, userGetter func(*echo.Context) (string, error)) echo.MiddlewareFunc { |
| 44 | + return func(next echo.HandlerFunc) echo.HandlerFunc { |
| 45 | + return func(c *echo.Context) error { |
| 46 | + username, err := userGetter(c) |
| 47 | + if err != nil { |
| 48 | + return echo.ErrUnauthorized.Wrap(err) |
| 49 | + } |
| 50 | + if pass, err := enforcer.Enforce(username, c.Request().URL.Path, c.Request().Method); err != nil { |
| 51 | + return echo.ErrInternalServerError.Wrap(err) |
| 52 | + } else if !pass { |
| 53 | + return echo.NewHTTPError(http.StatusForbidden, "access denied") |
| 54 | + } |
| 55 | + return next(c) |
| 56 | + } |
| 57 | + } |
| 58 | +} |
| 59 | +``` |
| 60 | + |
| 61 | +## 例 |
| 62 | + |
| 63 | +Casbin モデルファイル `auth_model.conf` を作成します。 |
| 64 | + |
| 65 | +```ini |
| 66 | +[request_definition] |
| 67 | +r = sub, obj, act |
| 68 | + |
| 69 | +[policy_definition] |
| 70 | +p = sub, obj, act |
| 71 | + |
| 72 | +[role_definition] |
| 73 | +g = _, _ |
| 74 | + |
| 75 | +[policy_effect] |
| 76 | +e = some(where (p.eft == allow)) |
| 77 | + |
| 78 | +[matchers] |
| 79 | +m = g(r.sub, p.sub) && keyMatch(r.obj, p.obj) && (r.act == p.act || p.act == "*") |
| 80 | +``` |
| 81 | + |
| 82 | +Casbin ポリシーファイル `auth_policy.csv` を作成します。 |
| 83 | + |
| 84 | +```csv |
| 85 | +p, 1234567890, /dataset1/*, GET |
| 86 | +p, alice, /dataset1/*, GET |
| 87 | +p, alice, /dataset1/resource1, POST |
| 88 | +p, bob, /dataset2/resource1, * |
| 89 | +p, bob, /dataset2/resource2, GET |
| 90 | +p, bob, /dataset2/folder1/*, POST |
| 91 | +p, dataset1_admin, /dataset1/*, * |
| 92 | +g, cathy, dataset1_admin |
| 93 | +``` |
| 94 | + |
| 95 | +認証と認可は別の関心事です。JWT や Basic Auth など別のミドルウェアでユーザーを認証し、 |
| 96 | +Casbin がリクエストを認可できるよう `userGetter` を渡します。 |
| 97 | + |
| 98 | +### JWT と使う |
| 99 | + |
| 100 | +```go |
| 101 | +e.Use(echojwt.JWT([]byte("secret"))) // JWT middleware does authentication |
| 102 | +jwtUser := func(c *echo.Context) (string, error) { // JWT user getter for Casbin authorization |
| 103 | + token, err := echo.ContextGet[*jwt.Token](c, "user") |
| 104 | + if err != nil { |
| 105 | + return "", err |
| 106 | + } |
| 107 | + return token.Claims.GetSubject() |
| 108 | +} |
| 109 | +e.Use(NewCasbinMiddleware(ce, jwtUser)) // Casbin does authorization |
| 110 | +``` |
| 111 | + |
| 112 | +次で試します。 |
| 113 | + |
| 114 | +```bash |
| 115 | +curl -v "http://localhost:8080/dataset1/any" -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ" |
| 116 | +``` |
| 117 | + |
| 118 | +### Basic Auth と使う |
| 119 | + |
| 120 | +```go |
| 121 | +// BasicAuth middleware does authentication |
| 122 | +e.Use(middleware.BasicAuth(func(c *echo.Context, user, password string) (bool, error) { |
| 123 | + return subtle.ConstantTimeCompare([]byte(user), []byte("alice")) == 1 && |
| 124 | + subtle.ConstantTimeCompare([]byte(password), []byte("password")) == 1, nil |
| 125 | +})) |
| 126 | +basicAuthUser := func(c *echo.Context) (string, error) { // Basic auth user getter for Casbin authorization |
| 127 | + username, _, _ := c.Request().BasicAuth() // password is verified by the BasicAuth middleware above |
| 128 | + return username, nil |
| 129 | +} |
| 130 | +e.Use(NewCasbinMiddleware(ce, basicAuthUser)) // Casbin does authorization |
| 131 | +``` |
| 132 | + |
| 133 | +次で試します。 |
| 134 | + |
| 135 | +```bash |
| 136 | +# should pass |
| 137 | +curl -v -u "alice:password" http://localhost:8080/dataset1/any |
| 138 | +# should fail |
| 139 | +curl -v -u "alice:password" http://localhost:8080/dataset2/resource2 |
| 140 | +``` |
| 141 | + |
| 142 | +### Casbin + JWT の完全な例 |
| 143 | + |
| 144 | +```go |
| 145 | +package main |
| 146 | + |
| 147 | +import ( |
| 148 | + "log/slog" |
| 149 | + "net/http" |
| 150 | + |
| 151 | + "github.com/casbin/casbin/v3" |
| 152 | + "github.com/golang-jwt/jwt/v5" |
| 153 | + echojwt "github.com/labstack/echo-jwt/v5" |
| 154 | + "github.com/labstack/echo/v5" |
| 155 | +) |
| 156 | + |
| 157 | +// NewCasbinMiddleware returns middleware for Casbin (https://casbin.org/). |
| 158 | +func NewCasbinMiddleware(enforcer *casbin.Enforcer, userGetter func(*echo.Context) (string, error)) echo.MiddlewareFunc { |
| 159 | + return func(next echo.HandlerFunc) echo.HandlerFunc { |
| 160 | + return func(c *echo.Context) error { |
| 161 | + username, err := userGetter(c) |
| 162 | + if err != nil { |
| 163 | + return echo.ErrUnauthorized.Wrap(err) |
| 164 | + } |
| 165 | + if pass, err := enforcer.Enforce(username, c.Request().URL.Path, c.Request().Method); err != nil { |
| 166 | + return echo.ErrInternalServerError.Wrap(err) |
| 167 | + } else if !pass { |
| 168 | + return echo.NewHTTPError(http.StatusForbidden, "access denied") |
| 169 | + } |
| 170 | + return next(c) |
| 171 | + } |
| 172 | + } |
| 173 | +} |
| 174 | + |
| 175 | +func main() { |
| 176 | + e := echo.New() |
| 177 | + |
| 178 | + ce, err := casbin.NewEnforcer("auth_model.conf", "auth_policy.csv") |
| 179 | + if err != nil { |
| 180 | + slog.Error("failed to initialize Casbin enforcer", "error", err) |
| 181 | + } |
| 182 | + |
| 183 | + e.Use(echojwt.JWT([]byte("secret"))) // JWT middleware does authentication |
| 184 | + jwtUser := func(c *echo.Context) (string, error) { // JWT user getter for Casbin authorization |
| 185 | + token, err := echo.ContextGet[*jwt.Token](c, "user") |
| 186 | + if err != nil { |
| 187 | + return "", err |
| 188 | + } |
| 189 | + return token.Claims.GetSubject() |
| 190 | + } |
| 191 | + e.Use(NewCasbinMiddleware(ce, jwtUser)) // Casbin does authorization |
| 192 | + |
| 193 | + e.GET("/*", func(c *echo.Context) error { |
| 194 | + return c.String(http.StatusOK, "Hello, World!") |
| 195 | + }) |
| 196 | + |
| 197 | + if err := e.Start(":8080"); err != nil { |
| 198 | + e.Logger.Error("failed to start server", "error", err) |
| 199 | + } |
| 200 | +} |
| 201 | +``` |
0 commit comments