http_auth_request module

Implements client authorization based on the result of a subrequest. If the subrequest returns a 2xx response code, the access is allowed. If it returns 401 or 403, the access is denied with the corresponding error code. Any other response code returned by the subrequest is considered an error.

For the 401 error, the client also receives the “WWW-Authenticate” header from the subrequest response.

When building from the source code, this module isn’t built by default; it should be enabled with the ‑‑with‑http_auth_request_module build option.

In packages and images from our repos, the module is included in the build.

The module may be combined with other access modules, such as http_access and auth_basic, via the satisfy directive.

Example Configuration

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;
}

Directives

auth_request

Syntax:

auth_request uri | off;

Default:

auth_request off;

Context:

http, server, location

Enables authorization based on the result of a subrequest and sets the URI to which the subrequest will be sent.

auth_request_set

Syntax:

auth_request_set $variable value;

Default:

—

Context:

http, server, location

Sets the request variable to the given value after the authorization request completes. The value may contain variables from the authorization request, such as $upstream_http_*.