summaryrefslogtreecommitdiff
blob: 262d07dd59bfec8d75a805cebdf22d50538335d6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
From: Marco Nenciarini <mnencia@debian.org>
Date: Sat, 10 Aug 2013 16:26:41 +0200
Subject: documentation

---
 mod_auth_pgsql.html | 47 ++++++++++++++++++++++++++++-------------------
 1 file changed, 28 insertions(+), 19 deletions(-)

diff --git a/mod_auth_pgsql.html b/mod_auth_pgsql.html
index 3269fe0..d35768b 100644
--- a/mod_auth_pgsql.html
+++ b/mod_auth_pgsql.html
@@ -48,18 +48,19 @@ Notes</a> |<a href="#Changelog"> Changelog</a> </p>
   <li><a href="#host">Auth_PG_host</a> </li>
   <li><a href="#port">Auth_PG_port</a> </li>
   <li><a href="#options">Auth_PG_options</a> </li>
-  <li><a href="#pwd_table">Auth_PG_database</a> </li>
-  <li><a href="#PGuser">Auth_PG_user</a> </li>
-  <li><a href="PGpwd">Auth_PG_pwd</a> </li>
-  <li><a href="#grp_table">Auth_PG_pwd_table</a> </li>
-  <li><a href="#uid_field">Auth_PG_grp_table</a> </li>
+  <li><a href="#database">Auth_PG_database</a> </li>
+  <li><a href="#user">Auth_PG_user</a> </li>
+  <li><a href="#pwd">Auth_PG_pwd</a> </li>
+  <li><a href="#pwd_table">Auth_PG_pwd_table</a> </li>
+  <li><a href="#grp_table">Auth_PG_grp_table</a> </li>
   <li><a href="#uid_field">Auth_PG_uid_field</a> </li>
   <li><a href="#pwd_field">Auth_PG_pwd_field</a> </li>
-  <li><a href="#gid_field">Auth_PG_gid_field</a> </li>
+  <li><a href="#grp_group_field">Auth_PG_grp_group_field</a> </li>
+  <li><a href="#grp_user_field">Auth_PG_grp_user_field</a> </li>
   <li><a href="#nopasswd">Auth_PG_nopasswd</a> </li>
   <li><a href="#authoritative">Auth_PG_authoritative</a> </li>
-  <li><a href="#lowercaseuid">Auth_PG_lowercase_uid</a> </li>
-  <li><a href="#uppercaseuid">Auth_PG_uppercase_uid</a></li>
+  <li><a href="#lowercase_uid">Auth_PG_lowercase_uid</a> </li>
+  <li><a href="#uppercase_uid">Auth_PG_uppercase_uid</a></li>
   <li><a href="#pwd_ignore_case">Auth_PG_pwd_ignore_case</a><br>
   </li>
   <li><a href="#encrypted">Auth_PG_encrypted</a> </li>
@@ -112,7 +113,7 @@ available options. </p>
 information.<br>
 <br>
 </p>
-<h2><a name="PGuser"></a> Auth_PG_user<br>
+<h2><a name="user"></a> Auth_PG_user<br>
 </h2>
 <b>Syntax:</b> Auth_PG_user <i>username</i><br>
 <b>Context:</b> directory, .htaccess <br>
@@ -125,7 +126,7 @@ access on all the log tables (if used).<br>
 Needed if the user who make the quey is differrent from the
 user runnig apache, or if the posmater is on a different server and you
 must autheticate with password<br>
-<h2><a name="PGpwd"></a> Auth_PG_pwd</h2>
+<h2><a name="pwd"></a> Auth_PG_pwd</h2>
 <p><b>Syntax:</b> Auth_PG_pwd <i>password</i><br>
 <b>Context:</b> directory, .htaccess <br>
 <b>Override:</b> AuthConfig <br>
@@ -169,17 +170,25 @@ in the Auth_PG_pwd_table relation. </p>
 <b>Override:</b> AuthConfig <br>
 <b>Status:</b> Extension
 <p>Specifies the attribute name of the field containing the encrypted
-(see Auth_PG_encrypted) password in the Auth_PGpwd_table relation.<br>
+(see Auth_PG_encrypted) password in the Auth_PG_pwd_table relation.<br>
 Please remember to use field of type varchar, not char for the password.<br>
 </p>
-<h2><a name="gid_field"></a> Auth_PG_gid_field</h2>
-<b>Syntax:</b> Auth_PG_gid_field <i>attribute name</i><br>
+<h2><a name="grp_group_field"></a> Auth_PG_grp_group_field</h2>
+<b>Syntax:</b> Auth_PG_grp_group_field <i>attribute name</i><br>
 <b>Context:</b> directory, .htaccess <br>
 <b>Override:</b> AuthConfig <br>
 <b>Status:</b> Extension
 <p>Specifies the attribute name of the field containing the group name
 in the Auth_PG_grp_table relation. This directive is only necessary if
 you want to authenticate by user groups. </p>
+<h2><a name="grp_user_field"></a> Auth_PG_grp_user_field</h2>
+<b>Syntax:</b> Auth_PG_grp_user_field <i>attribute name</i><br>
+<b>Context:</b> directory, .htaccess <br>
+<b>Override:</b> AuthConfig <br>
+<b>Status:</b> Extension
+<p>Specifies the attribute name of the field containing the user name
+in the Auth_PG_grp_table relation. This directive is only necessary if
+you want to authenticate by user groups. </p>
 <h2><a name="nopasswd"></a> Auth_PG_nopasswd</h2>
 <b>Syntax:</b> Auth_PG_nopasswd <i>on</i> or <i>off</i><br>
 <b>Context:</b> directory, .htaccess <br>
@@ -202,7 +211,7 @@ the PostgreSQL scheme, the parent directory scheme will be given
 the chance to try and authenticate the user. Exercise caution
 when turning this option off. It can be a security risk. Can be
 used to use two authentication schemes for the same dir. </p>
-<h2><a name="lowercaseuid"></a> Auth_PG_lowercase_uid</h2>
+<h2><a name="lowercase_uid"></a> Auth_PG_lowercase_uid</h2>
 <b>Syntax:</b> Auth_PG_lowercase_uid <i>on</i> or <i>off</i><br>
 <b>Context:</b> directory, .htaccess <br>
 <b>Override:</b> AuthConfig <br>
@@ -211,7 +220,7 @@ used to use two authentication schemes for the same dir. </p>
 user UIDs to lowercase before looking them up. When turned on this does
 not affect the case of the original user ID should this module decline
 to authenticate and a lower level is called.</p>
-<h2><a name="uppercaseuid"></a> Auth_PG_uppercase_uid</h2>
+<h2><a name="uppercase_uid"></a> Auth_PG_uppercase_uid</h2>
 <b>Syntax:</b> Auth_PG_uppercase_uid <i>on</i> or <i>off</i><br>
 <b>Context:</b> directory, .htaccess <br>
 <b>Override:</b> AuthConfig <br>
@@ -277,14 +286,14 @@ initial space .</em></p>
 <p>This option allows you to exercise greater control over the SQL code
 used to retrieve the group name and corresponding user from the
 database. You can use this to search for the group name
-using more attributes in the table than the gid_field. </p>
+using more attributes in the table than the grp_group_field. </p>
 <p>The basic SQL statement used to retrieve a group name and user name
 for checking looks like this: </p>
 <ul>
-select <i>&lt;uid_field&gt;</i> from <i>&lt;grp_table&gt;</i> where <i>
-&lt;gid_field&gt;</i> ='<i>&lt;required group&gt;</i> '
+select <i>&lt;grp_user_field&gt;</i> from <i>&lt;grp_table&gt;</i> where <i>
+&lt;grp_group_field&gt;</i> ='<i>&lt;required group&gt;</i> '
 </ul>
-The gid_whereclause will be added to the end of this statement
+The grp_whereclause will be added to the end of this statement
 and must fit logically. <em>The where clause must be double
 quoted.<br>
 <br>