# OPA 配置选项

OPA 插件与 Open Policy Agent 集成，可为 API 操作中的授权统一定义并实施策略。<!-- --> <!-- -->配置涵盖静态设置和插件参数。

## 静态配置[​](#静态配置 "静态配置的直接链接")

`apisix.max_request_headers_readable` 配置项控制 OPA 输入中包含的请求头数量。该配置项从 APISIX 3.20.0 和 API7 企业版 3.10.10 开始可用；较早版本固定为 100 个请求头。

配置位置取决于网关的部署方式：

* 主机或 Docker
* API7 网关 Helm

在持久化网关配置中设置上限：

config.yaml

```
apisix:

  max_request_headers_readable: 200  # 默认值：100；0 表示读取所有请求头。
```

更新 `config.yaml` 后，重新加载或重启每个网关实例。

使用 API7 网关 Helm Chart 3.10.19 或更高版本时，设置对应的 Chart 配置项：

values.yaml

```
apisix:

  maxRequestHeadersReadable: 200  # 默认值：100；0 表示读取所有请求头。
```

按照该网关 Helm release 的常规升级流程应用配置文件。

该配置项仅改变插件可见的请求头表，不改变 NGINX 的解析限制；超出插件可见上限的请求头仍可能到达上游。

## 参数[​](#参数 "参数的直接链接")

请参阅插件[通用配置](https://docs.apiseven.com/apisix/reference/plugin-common-configurations.md)，了解所有插件可用的配置选项。

* host

  string

  必填

  ***

  OPA 服务器的地址。

* policy

  string

  必填

  ***

  要评估的策略。

  例如，如果你想评估名为 `rbac` 的包中的所有规则，请将策略配置为 `rbac`。

  所选 OPA 文档必须返回包含 `allow` 决策的对象，例如 `{"allow": true}`。插件不支持仅返回布尔值 `true` 或 `false` 的文档。

  如果包中的规则返回所需对象，可以在包名后加上规则名来选中该规则，例如 `rbac/decision`。

* ssl\_verify

  boolean

  默认值：`true`

  ***

  如果为 true，则验证 OPA 服务器的 SSL 证书。

* timeout

  integer

  默认值：`3000`

  有效值：

  介于 1 和 60000 之间（含边界值）

  ***

  HTTP 调用的超时时间（毫秒）。

* keepalive

  boolean

  默认值：`true`

  ***

  如果为 true，则在多个请求之间保持连接。

* keepalive\_timeout

  integer

  默认值：`60000`

  有效值：

  大于或等于 1000

  ***

  连接关闭前的空闲时间（毫秒）。

* keepalive\_pool

  integer

  默认值：`5`

  有效值：

  大于或等于 1

  ***

  空闲连接数。

* with\_route

  boolean

  默认值：`false`

  ***

  如果为 true，则发送当前路由的信息。

* with\_service

  boolean

  默认值：`false`

  ***

  如果为 true，则发送当前服务的信息。

* with\_consumer

  boolean

  默认值：`false`

  ***

  如果为 true，则发送当前消费者的信息。

  注意，消费者信息可能包含敏感信息，如 API 密钥。仅当你确定安全时才将此选项设置为 `true`。

* send\_headers\_upstream

  array\[string]

  ***

  请求被允许时，由 OPA 响应控制的请求头名称。当 OPA 返回已配置的请求头时，网关会将其转发；当 OPA 未返回该请求头时，网关会清除客户端提供的同名值。
