Skip to content

iij/ngx_auth_mod

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Japanese documents is here.

ngx_auth_mod

ngx_auth_mod is a set of modules that provides authentication processing for nginx auth request module.

Getting started

See the Getting Started document.

Module specifications

ngx_ldap_auth

ngx_ldap_auth is a module that authenticates entities using the LDAP bind operation.

The LDAP authentication process provided by ngx_ldap_auth is shown in the diagram below.

ngx_ldap_auth diagram

Read more ngx_ldap_auth specification.

ngx_ldap_path_auth

ngx_ldap_path_auth is a module that authenticates entities using the LDAP bind operation, and authorizes based on the file path.

The LDAP authentication process and authorization process using the group information provided by ngx_ldap_path_auth is shown in the diagram below.

ngx_ldap_path_auth diagram

Read more ngx_ldap_path_auth specification.

ngx_header_path_auth

ngx_header_path_auth is a module that uses the username and filepath passed in the HTTP headers for authorization processing.

The authorization process using the group information provided by ngx_header_path_auth is shown in the diagram below.

ngx_header_path_auth diagram

Read more ngx_header_path_auth specification.

ngx_ldap_path2ldap_auth

ngx_ldap_path2ldap_auth is a module that authenticates entities using the LDAP bind operation, and authorizes by file path and LDAP information.

The LDAP authentication process and authorization process using the LDAP information provided by ngx_ldap_path2ldap_auth is shown in the diagram below.

ngx_ldap_path2ldap_auth diagram

Read more ngx_ldap_path2ldap_auth specification.

ngx_rewrite_auth

ngx_rewrite_auth is an authentication module that calls for another authentication on the rewritten request. This module can also convert from Basic authentication to authentication for nginx auth request module.
Only when the called authentication is successful will this authentication be successful.

ngx_rewrite_auth calls an external authentication module as shown in the following diagram.

ngx_rewrite_auth diagram

This module is flexible and can be used in a variety of ways, including:

  • Reusing authentication from another site.
    • Basic authentication on another site can be converted to authentication for the nginx auth request module.
  • Authentication proxy.
  • Authentication by email address.
    • Email addresses can be converted to usernames. (ex. user@example.com -> user)
  • Username restrictions.
    • Usernames that are authenticated by regular expressions can be filtered.
  • Customize cache settings.
    • The header for cache can be overridden.

Read more ngx_rewrite_auth specification.

ngx_rewrite_and_auth

ngx_rewrite_and_auth is an authentication module that calls for multiple authentications with rewritten requests. This module can also convert from Basic authentication to authentication for nginx auth request module.
Only when all the called authentications are successful will this authentication be successful.

ngx_rewrite_and_auth calls an external authentication module as shown in the following diagram.

ngx_rewrite_and_auth diagram

This module is flexible and can be used in a variety of ways, including:

  • Authentication and authorization separation.
    • The systems can be separated according to usage.
    • For example, ngx_ldap_auth and ngx_header_auth can be combined.
  • Replacement of the authorization part.
    • Authorization process can be reused.
  • Multiple authorizations combining.
    • Authentications to be combined can be selected.

Read more ngx_rewrite_and_auth specification.

ngx_rewrite_switch_auth

ngx_rewrite_switch_auth is an authentication module that calls the chosen authentication based on a username pattern. This module can also convert from Basic authentication to authentication for nginx auth request module.
Only if the authentication chosen for the username pattern is successful will this authentication be successful.

ngx_rewrite_switch_auth calls an external authentication module as shown in the following diagram.

ngx_rewrite_switch_auth diagram

This module is flexible and can be used in a variety of ways, including:

  • Authentication of multiple organizations.
    • Authentication process can be switched by email domain.
  • Multi-form authentication.
    • Both email addresses and usernames can be authenticated.

Read more ngx_rewrite_switch_auth specification.

check_ldap

check_ldap is a command to check the operation of LDAP authentication process using the ngx_ldap_auth or ngx_ldap_path_auth configuration file.

check_ldap diagram

Read more check_ldap specification.

ngx_simple_auth

ngx_simple_auth is a module that authenticates with the account information in the configuration file.

ngx_simple_auth diagram

ngx_simple_auth authenticates without external data, so it can be used to check nginx auth request module configuration.

Read more ngx_simple_auth specification.

About

Modules that provides authentication processing for nginx auth request module.

Topics

Resources

License

Stars

Watchers

Forks

Contributors