https://engine.speedle.io/zh/tags/v0.1.0/ Recent content in V0.1.0 on Speedle Hugo -- gohugo.io zh-cn Fri, 18 Jan 2019 21:19:44 +0800 https://engine.speedle.io/zh/docs/api/ Mon, 01 Jan 0001 00:00:00 +0000 https://engine.speedle.io/zh/docs/api/ Java、Python、Go、.NET、Rust 和 Node.js/TypeScript 的客户端库见 SDK。 REST API 这些接口说明面向你配置的 PMS、ADS 或断言服务端点。speedle.io 提供文档与浏览器 Playground，不托管 PMS/ADS 后端。发送 JSON 时必须设置 Content-Type: application/json，并配置 TLS/mTLS 与调用方访问控制。 策略管理 API 授权决策 API 令牌断言 webhook 策略和角色策略的 ID 是字符串，PMS 返回扁平对象；授权权限字段为复数 permissions。REST 决策请求使用带类型的属性数组，诊断响应及断言 webhook 的属性则为对象。 gRPC API PMS proto：pb.PolicyManager ADS proto：pb.Evaluator 当前 proto 必须与生成客户端配套使用。PMS 的服务名为 pb.PolicyManager，ADS 为 pb.Evaluator。这两份历史协议重用了消息名，应分别生成和加载，不要合并进同一 descriptor set。默认不启用 gRPC；需通过 --grpc-endpoint 显式开启，其 TLS 配置与 REST 相同。 历史 gRPC 的 ContextRequest.attributes 是字符串 map，不是 REST 的带类型属性数组，也不提供同样的数值、布尔、日期类型。条件需要这些类型时，应使用 REST 或嵌入式 Go，除非你的 gRPC 适配层明确实现了相应转换。 https://engine.speedle.io/zh/docs/api/decision_api/ Mon, 01 Jan 0001 00:00:00 +0000 https://engine.speedle.io/zh/docs/api/decision_api/ 已配置 ADS 的接口参考。请求属性是带类型的数组，诊断响应属性是对象。 请配置安全连接与端点访问控制。这是接口契约，speedle.io 不托管授权后端。 (function() { var url = "\/swagger\/policy-check.zh.yaml"; const ui = SwaggerUIBundle({ url: url, dom_id: '#swagger-ui', deepLinking: true, presets: [ SwaggerUIBundle.presets.apis ], plugins: [ SwaggerUIBundle.plugins.DownloadUrl ], validatorUrl: null, layout: "BaseLayout" }) window.ui = ui })(); https://engine.speedle.io/zh/docs/api/management_api/ Mon, 01 Jan 0001 00:00:00 +0000 https://engine.speedle.io/zh/docs/api/management_api/ 已配置 PMS 的接口参考。请求与响应使用 JSON，策略 ID 为字符串，响应为扁平对象。 请配置安全连接与端点访问控制。这是接口契约，speedle.io 不托管授权后端。 (function() { var url = "\/swagger\/policy-manage.zh.yaml"; const ui = SwaggerUIBundle({ url: url, dom_id: '#swagger-ui', deepLinking: true, presets: [ SwaggerUIBundle.presets.apis ], plugins: [ SwaggerUIBundle.plugins.DownloadUrl ], validatorUrl: null, layout: "BaseLayout" }) window.ui = ui })(); https://engine.speedle.io/zh/docs/spdl/ Mon, 01 Jan 0001 00:00:00 +0000 https://engine.speedle.io/zh/docs/spdl/ 基本的策略定义语言 保留关键字 grant、deny、user、group、entity、role、from、on、if、in 在各自语法位置有特定含义，策略语句的关键字大小写不敏感；条件成员运算使用 in 或 IN，函数名区分大小写。主体、操作和资源名称也区分大小写。当前解析器在部分名称位置可接受类似关键字的名称，不能把“所有位置都禁止关键字”当作验证规则。为便于审查与客户端互通，建议避免这类名称。 命名规范 推荐使用简明、稳定的标识符；名称包含空格或分隔符时使用解析器支持的单引号或双引号形式，并测试实际输入。不应把历史 Java 正则字符类当作当前 Go 解析器的严格校验。资源前缀 expr: 表示 Go 正则表达式，不是 shell 通配符。条件的属性与函数名称另见下文。 语法 POLICY = EFFECT SUBJECT ACTION RESOURCE [if CONDITION] EFFECT = grant | deny SUBJECT = AND_PRINCIPALS (, AND_PRINCIPALS)* AND_PRINCIPALS = PRINCIPAL | \( PRINCIPAL_LIST \) PRINCIPAL_LIST = PRINCIPAL (, PRINCIPAL)* PRINCIPAL = PRINCIPAL_TYPE PRINCIPAL_NAME [PRINCIPAL_IDD] PRINCIPAL_TYPE = user|group|entity|role PRINCIPAL_IDD = from IDD_IDENTIFIER IDD_IDENTIFIER = NAME ACTION = (ACTION_IDENTIFIER)(, ACTION_IDENTIFIER)* RESOURCE = RESOURCE_IDENTIFIER PRINCIPAL_NAME = NAME ACTION_IDENTIFIER = NAME RESOURCE_IDENTIFIER = NAME ROLE_POLICY = EFFECT SUBJECT ROLE (on RESOURCE)? https://engine.speedle.io/zh/docs/pms/ Fri, 18 Jan 2019 21:19:44 +0800 https://engine.speedle.io/zh/docs/pms/ Policy Management Global Policy Policy Discovery Policy Diagnosis https://engine.speedle.io/zh/docs/api/asserter_api/ Mon, 01 Jan 0001 00:00:00 +0000 https://engine.speedle.io/zh/docs/api/asserter_api/ 令牌断言 webhook 参考。errCode 为整数，attributes 为对象。实际端点由 ADS 断言配置指定。 请配置安全连接与端点访问控制。这是接口契约，speedle.io 不托管授权后端。 (function() { var url = "\/swagger\/asserter.zh.yaml"; const ui = SwaggerUIBundle({ url: url, dom_id: '#swagger-ui', deepLinking: true, presets: [ SwaggerUIBundle.presets.apis ], plugins: [ SwaggerUIBundle.plugins.DownloadUrl ], validatorUrl: null, layout: "BaseLayout" }) window.ui = ui })(); https://engine.speedle.io/zh/docs/logging/ Mon, 01 Jan 0001 00:00:00 +0000 https://engine.speedle.io/zh/docs/logging/ 概述 Speedle 使用了下面两个开源项目来处理日志, 1. https://github.com/sirupsen/logrus 2. https://github.com/natefinch/lumberjack Logrus 是一个针对 go 语言的结构化的日志处理器，它与 go 语言标准的 logger 库完全 API 兼容。因为 logrus 不支持对日志循环滚动处理（rotation），所以我们引入了另外一个开源项目 lumberjack。Logrus 与 lumberjack 之间通过 io.Writer 接口交互，如下图所示, 日志配置 可以通过两种方式对 Speedle 的日志模块进行配置，即命令行参数或者配置文件。 通过命令行参数配置日志 所有的命令行参数如下所示。level、formatter、reportcaller 配置 logrus，文件与滚动相关设置配置 lumberjack。 --log-level string --log-formatter string --log-reportcaller bool --log-filename string --log-maxsize int --log-maxbackups int --log-maxage int --log-localtime bool --log-compress bool 上面每一个参数的详细信息包含在下面的表格中。所有的参数都收可选的。 如果所有参数都没有配置，那么日志消息默认会输出到标准错误输出（stderr），而且默认的日志级别是 info。 配置项 描述 默认值 –log-level 日志级别, 有效的日志级别包括：panic、fatal、error、warn、info、debug info –log-formatter 日志格式, 有效的日志格式包括：text、json text –log-reportcaller 用于控制是否将调用信息 (文件名, 行数和函数名)包含在日志消息中 false –log-filename 日志文件名 没有默认值。 如果没有配置，那么日志消息默认会输出到标准错误输出（stderr） –log-maxsize 每个日志文件的最大尺寸。 注意该参数只有在”–log-filename”已经配置的情况下才有效 100M –log-maxbackups 历史日志文件保留的最大数量。 注意该参数只有在”–log-filename”已经配置的情况下才有效 0, 保留所有历史日志文件（注意历史日志文件可能由于达到了 maxAge 设定的时间限制而被删除） –log-maxage 历史日志文件保留的最多天数。注意该参数只有在”–log-filename”已经配置的情况下才有效 0, 不删除任何历史日志文件（注意历史日志文件可能由于达到了 maxbackups 的限制而被删除） –log-localtime 用于控制在生成滚动日志文件时是否使用本地时间。注意该参数只有在”–log-filename”已经配置的情况下才有效 false, 使用 UTC 时间 –log-compress 用于控制在生成滚动日志文件时是否需要压缩。注意该参数只有在”–log-filename”已经配置的情况下才有效 false, 不压缩 下面是两个日志消息的示例，第一个使用 text 格式输出，第二个则是使用 json 格式输出，