Casbin

Casbin

  • 文档
  • API
  • 编辑器
  • JetBrains 插件
  • Dashboard
  • 论坛
  • OA
  • 趋势
  • 云服务
  • 帮助
  • 博客
  • Languages icon中文
    • English
    • 한국어
    • 参与翻译
  • GitHub

›管理

基础知识

  • 概述
  • 开始使用
  • 工作原理
  • 教程

Model

  • 支持的Models
  • Model语法
  • 函数
  • 基于角色的访问控制
  • 域内RBAC
  • ABAC

存储

  • Model存储
  • Policy存储
  • 政策子集加载

扩充功能

  • 适配器
  • 观察者
  • 调度器
  • 角色管理器
  • 中间件

API

  • 管理 API
  • RBAC API

高级用法。

  • 多线程
  • 基准测试

管理

  • 管理员门户
  • Casbin 服务
  • 日志 & 错误处理
  • 在线编辑器
  • Frontend Usage

更多

  • 本项目使用者
  • 隐私政策
  • 服务条款
Translate

日志 & 错误处理

日志

Casbin uses the built-in log to print logs to console by default like:

2017/07/15 19:43:56 [Request: alice, data1, read ---> true]

The logging is not enabled by default. You can toggle it via Enforcer.EnableLog() or the last parameter of NewEnforcer().

note

We already support logging the model, enforce request, role, policy in Golang. You can define your own log for logging Casbin.

Use different logger for different enforcer

Every enforcer could have its own logger to log info, and it could be changed at run-time.

And you could use a proper logger via the last paramter of NewEnforcer(), if you using this way to initialize your enforcer, you needn't use the enabled parameter, cause the priority of the enabled field in logger is higher.

// Set a default logger as enforcer e1's logger.
// This operation could also be seen as changing the logger of e1 at run-time.
e1.SetLogger(&Log.DefaultLogger{})

// Set another logger as enforcer e2's logger.
e2.SetLogger(&YouOwnLogger)

// Set your logger when initialize enforcer e3.
e3, _ := casbin.NewEnforcer("examples/rbac_model.conf", a, logger)

Supported loggers

We provide some loggers to help you log information.

Go
LoggerAuthorDescription
Defatule logger (built-in)CasbinThe default logger using golang log.
Zap loggerCasbinUsing zap, provide json encoded log and you could customize more with your own zap-logger.

How to write a logger

Your logger should implement the Logger interface.

MethodTypeDescription
EnableLog()mandatoryControl whether print the message.
IsEnabled()mandatoryShow the current logger's enabled status.
LogModel()mandatoryLog info related to model.
LogEnforce()mandatoryLog info related to enforce.
LogRole()mandatoryLog info related to role.
LogPolicy()mandatoryLog info related to policy.

You can pass your custom logger to Enforcer.SetLogger().

Here is an example about how to customize a logger for Golang:

import (
    "fmt"
    "log"
    "strings"
)

// DefaultLogger is the implementation for a Logger using golang log.
type DefaultLogger struct {
    enabled bool
}

func (l *DefaultLogger) EnableLog(enable bool) {
    l.enabled = enable
}

func (l *DefaultLogger) IsEnabled() bool {
    return l.enabled
}

func (l *DefaultLogger) LogModel(model [][]string) {
    if !l.enabled {
        return
    }
    var str strings.Builder
    str.WriteString("Model: ")
    for _, v := range model {
        str.WriteString(fmt.Sprintf("%v\n", v))
    }

    log.Println(str.String())
}

func (l *DefaultLogger) LogEnforce(matcher string, request []interface{}, result bool, explains [][]string) {
    if !l.enabled {
        return
    }

    var reqStr strings.Builder
    reqStr.WriteString("Request: ")
    for i, rval := range request {
        if i != len(request)-1 {
            reqStr.WriteString(fmt.Sprintf("%v, ", rval))
        } else {
            reqStr.WriteString(fmt.Sprintf("%v", rval))
        }
    }
    reqStr.WriteString(fmt.Sprintf(" ---> %t\n", result))

    reqStr.WriteString("Hit Policy: ")
    for i, pval := range explains {
        if i != len(explains)-1 {
            reqStr.WriteString(fmt.Sprintf("%v, ", pval))
        } else {
            reqStr.WriteString(fmt.Sprintf("%v \n", pval))
        }
    }

    log.Println(reqStr.String())
}

func (l *DefaultLogger) LogPolicy(policy map[string][][]string) {
    if !l.enabled {
        return
    }

    var str strings.Builder
    str.WriteString("Policy: ")
    for k, v := range policy {
        str.WriteString(fmt.Sprintf("%s : %v\n", k, v))
    }

    log.Println(str.String())
}

func (l *DefaultLogger) LogRole(roles []string) {
    if !l.enabled {
        return
    }

    log.Println("Roles: ", roles)
}

错误处理

Error or panic may happen when you use Casbin for reasons like:

  1. model文件 (. file) 中的语法有误。
  2. policy文件 (. csv) 中的语法有误。
  3. 来adapter的自定义错误信息(譬如连接MySQL失败)。
  4. Casbin的bug。

There are five main functions you may need to care about for error or panic:

FunctionBehavior on error
NewEnforcer()Return error
LoadModel()Return error
LoadPolicy()Return error
SavePolicy()Return error
Enforce()Return error
note

NewEnforcer() calls LoadModel() and LoadPolicy() inside. So you don't have to call the latter two calls when using NewEnforcer().

Enforcer的启用和禁用

The enforcer can be disabled via the Enforcer.EnableEnforce() function. When it's disabled, Enforcer.Enforce() will always return true. Other operations like adding or removing policy is not affected. Here's an example:

e := casbin.NewEnforcer("examples/basic_model.conf", "examples/basic_policy.csv")

// Will return false.
// By default, the enforcer is enabled.
e.Enforce("non-authorized-user", "data1", "read")

// Disable the enforcer at run-time.
e.EnableEnforce(false)

// Will return true for any request.
e.Enforce("non-authorized-user", "data1", "read")

// Enable the enforcer again.
e.EnableEnforce(true)

// Will return false.
e.Enforce("non-authorized-user", "data1", "read")
← Casbin 服务在线编辑器 →
  • 日志
    • Use different logger for different enforcer
  • 错误处理
  • Enforcer的启用和禁用
Casbin
Docs
Getting StartedManagement APIRBAC APIMiddlewares
Community
Who's using Casbin?ForumStack OverflowProject Chat
Casbin          jCasbin
Node-Casbin   PHP-CasbinPyCasbin          Casbin.NETCasbin-CPP        Casbin-RS
Follow @CasbinNews
Copyright © 2021 Casbin contributors.