Caddy-authz is a middleware for Caddy that blocks or allows requests based on access control policies.
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore Ignore IDEA files. May 27, 2017
.travis.yml Add Travis CI and coverage. May 27, 2017
Caddyfile Remove casbin.conf Jun 29, 2017
LICENSE Initial commit May 27, 2017
README.md Remove casbin.conf in README. Jun 29, 2017
authz.go Remove casbin.conf Jun 29, 2017
authz_model.conf Add the plugin code. May 27, 2017
authz_policy.csv Add the plugin code. May 27, 2017
authz_test.go Improve the code format. May 27, 2017

README.md

Caddy-authz Build Status Coverage Status GoDoc

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

http://localhost:80 {
    authz "/folder/to/caddy_binary/authz_model.conf" /folder/to/caddy_binary/authz_policy.csv"
    ...
}

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:

http://localhost:80 {
    authz "authz_model.conf" "authz_policy.csv"
    root "/my-website.net"
}
  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

License

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