README

Authz

Build Status codecov Go Report Card GoDoc

Authz is an authorization middleware for Gin, it's based on https://github.com/casbin/casbin.

Installation

go get github.com/gin-contrib/authz

Simple Example

package main

import (
    "net/http"

    "github.com/casbin/casbin"
    "github.com/gin-contrib/authz"
    "github.com/gin-gonic/gin"
)

func main() {
    // load the casbin model and policy from files, database is also supported.
    e := casbin.NewEnforcer("authz_model.conf", "authz_policy.csv")

    // define your router, and use the Casbin authz middleware.
    // the access that is denied by authz will return HTTP 403 error.
    router := gin.New()
    router.Use(authz.NewAuthorizer(e))
}

Documentation

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 MIT License. See the LICENSE file for the full license text.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewAuthorizer

func NewAuthorizer(e *casbin.Enforcer) gin.HandlerFunc

    NewAuthorizer returns the authorizer, uses a Casbin enforcer as input

    Types

    type BasicAuthorizer

    type BasicAuthorizer struct {
    	// contains filtered or unexported fields
    }

      BasicAuthorizer stores the casbin handler

      func (*BasicAuthorizer) CheckPermission

      func (a *BasicAuthorizer) CheckPermission(r *http.Request) bool

        CheckPermission checks the user/method/path combination from the request. Returns true (permission granted) or false (permission forbidden)

        func (*BasicAuthorizer) GetUserName

        func (a *BasicAuthorizer) GetUserName(r *http.Request) string

          GetUserName gets the user name from the request. Currently, only HTTP basic authentication is supported

          func (*BasicAuthorizer) RequirePermission

          func (a *BasicAuthorizer) RequirePermission(c *gin.Context)

            RequirePermission returns the 403 Forbidden to the client

            Source Files