ngx_http_auth_request_module 模块

示例配置
指令
     auth_request
     auth_request_set

ngx_http_auth_request_module 模块(1.5.4+)根据子请求的结果实现客户端授权。如果子请求返回 2xx 响应代码,则允许访问。如果它返回 401 或 403,则使用相应的错误代码拒绝访问。子请求返回的任何其他响应代码都将被视为错误。

对于 401 错误,客户端还会从子请求响应中收到“WWW-Authenticate”标头。

此模块未默认构建,应使用 --with-http_auth_request_module 配置参数启用它。

该模块可以通过 satisfy 指令与其他访问模块结合使用,例如 ngx_http_access_modulengx_http_auth_basic_modulengx_http_auth_jwt_module

在 1.7.3 版本之前,无法缓存授权子请求的响应(使用 proxy_cacheproxy_store 等)。

示例配置

location /private/ {
    auth_request /auth;
    ...
}

location = /auth {
    proxy_pass ...
    proxy_pass_request_body off;
    proxy_set_header Content-Length "";
    proxy_set_header X-Original-URI $request_uri;
}

指令

语法 auth_request uri | off;
默认值
auth_request off;
上下文 httpserverlocation

根据子请求的结果启用授权,并设置将向其发送子请求的 URI。

语法 auth_request_set $variable value;
默认值
上下文 httpserverlocation

在授权请求完成后将请求 variable 设置为给定的 value。该值可能包含来自授权请求的变量,例如 $upstream_http_*