accesscontrol

README

accesscontrol 访问控制中间件

访问控制，检查用户是否拥有访问接口的资源

安装

go get gitee.com/sparrow614/sparrow_cloud_go

配置前提

需要先配置JWT中间件，详见 JWT Middleware 接口添加auth认证，详见 AUTH Middleware

使用前注意

1. 必须提前配置jwt中间件
2. 必须初始化访问控制中间件的配置
3. 如果接口需要访问控制，则接口前必需先添加auth认证中间件，否则接口不通过
4. 如果配置跳过访问控制，仍然需要添加auth认证，因为之后变为不跳过访问控制后，必需用到user_id，该数据只能从auth中间件获得
5. 必须配置环境变量SC_ACCESS_CONTROL_SVC，访问控制服务的服务地址，例如：sparrow-access-control-svc:8001
6. 必须配置环境变量SC_ACCESS_CONTROL_API，访问控制服务的api，例如：/api/ac_i/verify/

初始化访问控制中间件配置

func InitACConf(serviceName string, skipAC bool)
参数含义：
serviceName: 你的服务的名字，例如：SparrowPromotion
skipAC: 是否跳过访问控制，设置为true则跳过访问控制，但是仍然需要认证；设置为false，则不跳过访问控制

使用方法

import (
	...
	"gitee.com/sparrow614/sparrow_cloud_go/middleware/jwt"
    "gitee.com/sparrow614/sparrow_cloud_go/middleware/auth"
	ac "gitee.com/sparrow614/sparrow_cloud_go/middleware/accesscontrol"
)

func main() {
    // 初始化iris app
    app := iris.New()
    // 配置jwt中间件
	app.Use(jwt.AutoServe)
    ...
    // 初始化访问控制中间件配置
    ac.InitACConf("SparrowPromotion", false)

    // /test 接口需要用户认证并拥有admin资源才可以访问
    app.Get("/test", auth.IsAuthenticated, ac.RequestSrc("admin"), processRequest)
    app.Listen("8081")
}

Documentation

Index

• Variables
• func ErrorHandler(ctx iris.Context, err error)
• func InitACConf(serviceName string, skipAC bool)
• func RequestSrc(resourceName string) func(iris.Context)
• type ACResponse
• type Config

Variables

var (
	// ErrResrouceMissing 未提供资源
	ErrResrouceMissing = errors.New("required resource not found")
	// ErrAuthMissing no auth
	ErrAuthMissing = errors.New("api needs authentication, ask developer to add auth middleware for this api")
	// ErrNoPermission user don't have resource
	ErrNoPermission = errors.New("you don't have permission to access the api")
)

Functions

func ErrorHandler

func ErrorHandler(ctx iris.Context, err error)

ErrorHandler is the default error handler. Use it to change the behavior for each error.

func InitACConf

func InitACConf(serviceName string, skipAC bool)

InitACConf constructs a new global access control configuration.

func RequestSrc

func RequestSrc(resourceName string) func(iris.Context)

RequestSrc is access control middleware auth middleware must be configured before this middleware

Types

type ACResponse

type ACResponse struct {
	HasPerm bool `json:"has_perm"`
}

ACResponse is access control response when reqeust ac service

type Config

type Config struct {
	// AccessControlService is access control service address:port
	AccessControlService string
	// APIPath
	APIPath string
	// ServiceName is the service name, used for app_name
	ServiceName string
	// SkipAccessContorl, true: skip the access control; false: check user's resource
	SkipAccessContorl bool
}

Config is a struct for specifying configuration options for the accesscontrol middleware.

var AccessControllConf Config

AccessControllConf is accesscontrol middleware configuration.