authc

README

authj

authc is an authorization middleware for net/http, it's based on casbin.

Installation

go get github.com/thinkgos/authc

Simple Example

package main

import (
    "net/http"

    "github.com/casbin/casbin/v2"
    "github.com/thinkgos/authc"
)

func main() {
    // load the casbin model and policy from files, database is also supported.
    e ,err := casbin.NewEnforcer("authz_model.conf", "authz_policy.csv")
    if err!= nil{
        panic(err)    
    }
    // define your router, and use the Casbin authc middleware.
    // the access that is denied by authz will return HTTP 403 error.
    // before you use middleware2 your should use middleware1 to set subject 
    middleware1 := func(next http.HandlerFunc) http.HandlerFunc{
        return func(w http.ResponseWriter, r *http.Request) {
            next.ServeHTTP(w, r.WithContext(authc.ContextWithSubject(r.Context(), "admin")))
        }
    }
    middleware2 := authc.NewAuthorizer(e,authc.ContextSubject)
}

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

• Gin-authz
• Gin-authj

License

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

Documentation

Index

• Variables
• func ContextSubject(r *http.Request) string
• func ContextWithSubject(ctx context.Context, subject string) context.Context
• func NewAuthorizer(e *casbin.Enforcer, s Subject) func(next http.HandlerFunc) http.HandlerFunc
• type Subject

Variables

var SubjectCtxKey = &contextKey{"subject"}

SubjectCtxKey subject context key

Functions

func ContextSubject

func ContextSubject(r *http.Request) string

ContextSubject returns the value associated with this context for SubjectCtxKey,

func ContextWithSubject

func ContextWithSubject(ctx context.Context, subject string) context.Context

ContextWithSubject return a copy of parent in which the value associated with SubjectCtxKey is subject.

func NewAuthorizer

func NewAuthorizer(e *casbin.Enforcer, s Subject) func(next http.HandlerFunc) http.HandlerFunc

NewAuthorizer returns the authorizer uses a Casbin enforcer and Subject function as input

Types

type Subject

type Subject func(r *http.Request) string

Subject function get subject