README
¶
Caddy-authz
Caddy-authz is an authorization middleware for Caddy, it's based on https://github.com/casbin/casbin. It includes basicauth checks agains a bcrypt password file.
Installation
go get github.com/casbin/caddy-authz
Caddyfile syntax
http://localhost:80 {
authz "/folder/to/caddy_binary/authz_model.conf" /folder/to/caddy_binary/authz_policy.csv" AuthRealm authfile
...
}
The authz directive specifies the path to Casbin model file (.conf) and Casbin policy file (.csv). The Casbin model file describes access control models like ACL, RBAC, ABAC, etc. The Casbin policy file describes the authorization policy rules. For how to write these files, please refer to: https://github.com/casbin/casbin#get-started
A working example
-
cdinto the folder ofcaddybinary. -
Put your Casbin model file authz_model.conf and Casbin policy file authz_policy.csv into this folder.
-
Add
authzdirective to your Caddyfile like:
http://localhost:80 {
authz "authz_model.conf" "authz_policy.csv" MyRealm bcrypt.pass
root "/my-website.net"
}
- Run
caddyand enjoy.
Note: This plugin only supports HTTP basic authentication to get the logged-in user name, if you use other kinds of authentication like OAuth, LDAP, etc, you may need to customize this plugin.
How to control the access
The authorization determines a request based on {subject, object, action}, which means what subject can perform what action on what object. In this plugin, the meanings are:
subject: the logged-on user nameobject: the URL path for the web resource like "dataset1/item1"action: HTTP method like GET, POST, PUT, DELETE, or the high-level actions you defined like "read-file", "write-blog"
For how to write authorization policy and other details, please refer to the Casbin's documentation.
Getting Help
License
This project is under Apache 2.0 License. See the LICENSE file for the full license text.
Documentation
¶
Index ¶
Constants ¶
const ( // MustAuthenticate is returned if authentication is required. MustAuthenticate = 0 // AccessAllowed is returned if the user has access to the resource. AccessAllowed = 1 // AccessDenied is returned if the user has no access to the resource. AccessDenied = 2 // AnonymousAccess is returned if the access is authorized for anonymous access. AnonymousAccess = 1 // IdentifiedAccess is returned if the access is authorized for an identified user. IdentifiedAccess = 2 )
Variables ¶
This section is empty.
Functions ¶
func Setup ¶
func Setup(c *caddy.Controller) error
Setup parses the Casbin configuration and returns the middleware handler.
Types ¶
type Authorizer ¶
type Authorizer struct {
Next httpserver.Handler
Enforcer *casbin.Enforcer
Realm string
PasswordCheck authfile.IAuthenticationService
}
Authorizer is a middleware for filtering clients based on their ip or country's ISO code.
func (*Authorizer) CheckEnforce ¶
func (a *Authorizer) CheckEnforce(user, path, method string) (int, bool)
CheckEnforce verifies if the user has access to the resource. If no username is given, the check will be against "nobody" only.
func (*Authorizer) CheckPermission ¶
func (a *Authorizer) CheckPermission(r *http.Request) int
CheckPermission checks the user/method/path combination from the request. Returns true (permission granted) or false (permission forbidden)
func (*Authorizer) GetUserName ¶
func (a *Authorizer) GetUserName(r *http.Request) string
GetUserName gets the user name from the request. Currently, only HTTP basic authentication is supported
func (Authorizer) ServeHTTP ¶
func (a Authorizer) ServeHTTP(w http.ResponseWriter, r *http.Request) (int, error)
ServeHTTP serves the request.
Source Files