https://github.com/catap/ngx_http_auth_request_module

https://github.com/catap/ngx_http_auth_request_module

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/catap/ngx_http_auth_request_module
• Owner: catap
• License: other
• Created: 2011-04-21T22:14:16.000Z (over 15 years ago)
• Default Branch: master
• Last Pushed: 2011-04-21T22:16:48.000Z (over 15 years ago)
• Last Synced: 2025-01-17T12:56:58.668Z (over 1 year ago)
• Language: C
• Homepage:
• Size: 88.9 KB
• Stars: 3
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README
  • Changelog: CHANGES
  • License: LICENSE

Awesome Lists containing this project

README

          
Auth request module for nginx.

This module allows authorization based on subrequest result.  Once subrequest

returns 2xx status - access is allowed, on 401 or 403 - disabled with

appropriate status.  Anything else is considered to be an error.

For 401 status WWW-Authenticate header from subrequest response will be

passed to client.

Module works at access phase and therefore may be combined nicely with other

access modules (access, auth_basic) via satisfy directive.

Configuration directives:

    auth_request |off

        Context: http, server, location

        Default: off

        Switches auth request module on and sets uri which will be asked for

        authorization.

    auth_request_set  

        Context: http, server, location

        Default: none

        Set request variable to the given value after auth request completion.

        Value may contain variables from auth request, e.g. $upstream_http_*.

Usage:

    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;

    }

Note: it is not currently possible to use proxy_cache/proxy_store (and 

fastcgi_cache/fastcgi_store) for requests initiated by auth request

module.

To compile nginx with auth request module, use "--add-module " option

to nginx configure.

Development of this module was sponsored by Openstat (http://www.openstat.com/).