跳到主要内容

JWE Decrypt 配置选项

JWE Decrypt 插件解密 JWE 紧凑序列化 Token,并在配置的请求头中转发明文。 配置涵盖消费者字段和路由和服务字段。

参数​

请参阅 插件通用配置 了解所有插件可用的配置选项。

消费者​

以下是可在消费者上配置的插件属性。

  • key

    string

    必填


    标识 Consumer 凭据的唯一 Key。

  • secret

    string

    必填

    有效值:

    32 字节

    用于 A256GCM 的共享对称密钥。明文字面值必须恰好为 32 字节。如果 is_base64_encoded 为 true,该值必须使用 base64url 编码,且解码后为 32 字节。也可以使用网关 $env:// 或 $secret:// 引用;解析后的值(而非引用字符串)必须满足相同要求。引用可以在解析前被接受,但如果解析出的密钥长度不符合要求,解密会失败。

  • is_base64_encoded

    boolean

    默认值:false


    如果 Secret 使用 base64url 编码,则设置为 true。解码后的 Secret 仍必须为 32 字节。

路由或服务​

以下是可在路由或服务上配置的插件属性。

  • header

    string

    必填

    默认值:Authorization


    从中获取 Token 的请求头。

  • forward_header

    string

    必填

    默认值:Authorization


    将明文传递给上游的请求头名称。

    在 APISIX 3.20.0 和 API7 Enterprise 3.10.10 中,网关会在转发解密后的明文或继续处理可选 Token 的请求之前,移除客户端提供的任何同名请求头值。当 strict 为 false 且未提供 Token 时,上游既不会收到解密值,也不会收到客户端提供的值。

  • strict

    boolean

    默认值:true


    如果为 true,则在缺少加密插件 Token 时返回 403 错误。如果为 false,则在未找到 Token 时继续处理请求。