authz

README

Caddy-authz

Caddy-authz is an authorization middleware for Caddy, it's based on https://github.com/casbin/casbin.

Installation

go get github.com/casbin/caddy-authz

Caddyfile syntax

localhost {
    route { 
        authz "/folder/to/caddy_binary/authz_model.conf" "/folder/to/caddy_binary/authz_policy.csv"
    }
    respond "Hello, world!"
    ...
}

or

{
    order authz before respond
}

localhost {
	authz "/folder/to/caddy_binary/authz_model.conf" "/folder/to/caddy_binary/authz_policy.csv"
	respond "Hello, world!"
    ...
}

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

1. cd into the folder of caddy binary.

2. Put your Casbin model file authz_model.conf and Casbin policy file authz_policy.csv into this folder.

3. Add authz directive to your Caddyfile like:

localhost:666 {
    route { 
        authz "authz_model.conf" "authz_policy.csv"
    }
    respond "Hello, world!"
    ...
}

1. Run caddy and 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:

1. subject: the logged-on user name
2. object: the URL path for the web resource like "dataset1/item1"
3. 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

• Casbin

License

This project is under Apache 2.0 License. See the LICENSE file for the full license text.

Documentation

Index

• type Authorizer
  • func (Authorizer) CaddyModule() caddy.ModuleInfo
  • func (a *Authorizer) CheckPermission(r *http.Request) (bool, error)
  • func (a *Authorizer) GetUserName(r *http.Request) string
  • func (a *Authorizer) Provision(ctx caddy.Context) error
  • func (a Authorizer) ServeHTTP(w http.ResponseWriter, r *http.Request, next caddyhttp.Handler) error
  • func (a *Authorizer) UnmarshalCaddyfile(d *caddyfile.Dispenser) error
  • func (a *Authorizer) Validate() error

Types

type Authorizer

type Authorizer struct {
	AuthConfig struct {
		ModelPath  string
		PolicyPath string
	}
	Enforcer *casbin.Enforcer
}

func (Authorizer) CaddyModule

func (Authorizer) CaddyModule() caddy.ModuleInfo

CaddyModule returns the Caddy module information.

func (*Authorizer) CheckPermission

func (a *Authorizer) CheckPermission(r *http.Request) (bool, error)

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) Provision

func (a *Authorizer) Provision(ctx caddy.Context) error

Provision implements caddy.Provisioner.

func (Authorizer) ServeHTTP

func (a Authorizer) ServeHTTP(w http.ResponseWriter, r *http.Request, next caddyhttp.Handler) error

ServeHTTP implements caddyhttp.MiddlewareHandler.

func (*Authorizer) UnmarshalCaddyfile

func (a *Authorizer) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

UnmarshalCaddyfile implements caddyfile.Unmarshaler.

func (*Authorizer) Validate

func (a *Authorizer) Validate() error

Validate implements caddy.Validator.