Skip to content

Access Control ​

Added: v1.6.0

Zen provides access control strategies checked via middleware after authentication. Roles are the single source of permissions - a user is granted permissions through the roles they hold.

Strategies ​

StrategyScopeCheck
RBACRoles ("admin", "editor")RequireRole("admin")
PBACGranular permissions ("read:users")RequirePermission("read:users"), RequireAnyPermission(...), RequireAllPermissions(...)
ClaimsSpecific claim valuesRequireClaim("tenant", "acme")

See the dedicated RBAC and PBAC pages for usage details.

Setting Roles ​

Roles are defined in an RBAC config file (r.EnableRBAC) and assigned on the User struct returned by your authenticator:

json
{
  "roles": [
    { "name": "admin", "permissions": ["read:users", "write:users"], "inheritsFrom": ["editor"] },
    { "name": "editor", "permissions": ["write:reports"], "inheritsFrom": ["viewer"] },
    { "name": "viewer", "permissions": ["read:reports"] }
  ]
}
go
func MyAuthenticator(r *http.Request) (*zen.User, error) {
    return &zen.User{
        ID:     "123",
        Username: "john",
        Roles:  []string{"admin"},
    }, nil
}

Claim-Based Enforcement ​

Use RequireClaim when access should depend on a specific claim value:

go
r.EnableAuth(jwtAuth)
r.Use(zen.RequireClaim("tenant", "acme"))

Enforcement Order ​

Apply EnableAuth first, then the access control middleware:

go
r.EnableAuth(jwtAuth)
r.Use(zen.RequireRole("admin"))
r.Use(zen.RequirePermission("read:users"))
r.Use(zen.RequireClaim("tenant", "acme"))

Released under the MIT License.