HttpAuthBasicModule - Revision history

Ensiferous: /* auth_basic_user_file */

2013-02-08T20:59:53Z

‎auth_basic_user_file

Ensiferous: /* auth_basic_user_file */

2013-02-08T20:59:16Z

‎auth_basic_user_file

Admin: /* Directives */

2012-05-02T19:26:25Z

‎Directives

Admin: /* Directives */

2012-04-30T06:48:19Z

‎Directives

VBart: /* References */ Update link to the original documentation

2012-04-21T15:17:25Z

‎References: Update link to the original documentation

Admin: /* auth_basic_user_file */

2012-02-03T05:51:18Z

‎auth_basic_user_file

Citrin: /* auth_basic_user_file */ - note about "$apr1", "{PLAIN}" and "{SSHA}" password schemes

2011-09-23T11:17:30Z

‎auth_basic_user_file: - note about "$apr1", "{PLAIN}" and "{SSHA}" password schemes

New page

= Synopsis =
You can use this module to protect your site or parts of it with username and password based on HTTP Basic Authentication.

Example configuration
<geshi lang="nginx">
location / {
auth_basic "Restricted";
auth_basic_user_file htpasswd;
}
</geshi>

= Directives =

== auth_basic ==

{{Directive|name=auth_basic|args=realm {{!}} off|default=off|context=http, server, location, limit_except|phase=access|vars=no}}

This directive includes testing name and password with HTTP Basic Authentication.
The assigned parameter is used as authentication realm.
A value of "off" makes it possible to override the action for the inheritable from a lower-level directive.

== auth_basic_user_file ==

{{Directive|name=auth_basic_user_file|args=file|default=none|context=http, server, location, limit_except|phase=access|vars=no}}

This directive sets the htpasswd filename for the authentication realm. Since version 0.6.7 the filename path is relative to directory of nginx configuration file nginx.conf, but not to nginx prefix directory.

The format of file is the following:
<pre>
user:pass
user2:pass2:comment
user3:pass3
</pre>

Passwords must be encoded by function crypt(3). If Apache is installed, you can create the password file using the htpasswd program included. Note: Apache uses MD5 for encryption.

Since version 1.0.3 nginx supports "$apr1", "{PLAIN}" and "{SSHA}" password encryption methods.

This file should be readable by workers, running from unprivileged [[CoreModule#user|user]]. E. g. when nginx run from ''www'' you can set permissions as
<pre>
chown root:nobody htpasswd_file
chmod 640 htpasswd_file
</pre>

See also: [[Faq#How_do_I_generate_an_htpasswd_file_without_having_Apache_tools_installed.3F]]

= References =
[http://sysoev.ru/nginx/docs/http/ngx_http_auth_basic_module.html Original Documentation]

[http://kbeezie.com/view/protecting-folders-with-nginx/ Protecting Folders with Auth_Basic]

@@ Line 35: / Line 35: @@
 Passwords must be encoded by function crypt(3). If Apache is installed, you can create the password file using the htpasswd program included. Note: Apache uses MD5 for encryption.
 As of version 1.0.3 nginx supports "$apr1", "{PLAIN}" and "{SSHA}" password encryption methods.
 As of version 1.3.13 nginx supports "{SHA}" encryption as well. Plain SHA1 encryption should be considered for migration purposes only and should whenever possible be avoided for security reasons.
 This file should be readable by workers, running from unprivileged [[CoreModule#user|user]]. E. g. when nginx run from ''www'' you can set permissions as

@@ Line 15: / Line 15: @@
 == auth_basic ==
-<include wikitext nopre src="http://wiki.nginx.org/nginx.org/ngx_http_auth_basic_module/auth_basic.txt" />
+<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_auth_basic_module/auth_basic.txt" />
 This directive includes testing name and password with HTTP Basic Authentication.
@@ Line 23: / Line 23: @@
 == auth_basic_user_file ==
-<include wikitext nopre src="http://wiki.nginx.org/nginx.org/ngx_http_auth_basic_module/auth_basic_user_file.txt" />
+<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_auth_basic_module/auth_basic_user_file.txt" />
 This directive sets the htpasswd filename for the authentication realm. Since version 0.6.7 the filename path is relative to directory of nginx configuration file nginx.conf, but not to nginx prefix directory.

@@ Line 49: / Line 49: @@
 = References =
-[http://sysoev.ru/nginx/docs/http/ngx_http_auth_basic_module.html Original Documentation]
+[http://nginx.org/en/docs/http/ngx_http_auth_basic_module.html Original Documentation]
 [http://kbeezie.com/view/protecting-folders-with-nginx/ Protecting Folders with Auth_Basic]

@@ Line 46: / Line 46: @@
 </pre>
-See also: [[Faq#How_do_I_generate_an_htpasswd_file_without_having_Apache_tools_installed.3F]]
+See also: [[Faq#How_do_I_generate_an_htpasswd_file_without_having_Apache_tools_installed.3F|How do I generate an htpasswd file without having Apache tools installed?]]
 = References =