File: mod_auth_file.html

package info (click to toggle)
proftpd-dfsg 1.3.0-19etch3
  • links: PTS
  • area: main
  • in suites: etch
  • size: 9,604 kB
  • ctags: 5,598
  • sloc: ansic: 59,475; sh: 18,832; perl: 1,474; makefile: 1,191
file content (134 lines) | stat: -rw-r--r-- 4,973 bytes parent folder | download | duplicates (4)
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
125
126
127
128
129
130
131
132
133
134
<html>
<head>
<title>ProFTPD module mod_auth_file</title>
</head>

<body bgcolor=white>

<hr>
<center>
<h2><b>ProFTPD module <code>mod_auth_file</code></b></h2>
</center>
<hr><br>

This module is contained in the <code>mod_auth_file.c</code> file for
ProFTPD 1.2, and is compiled by default.

<h2>Directives</h2>
<ul>
  <li><a href="#AuthGroupFile">AuthGroupFile</a>
  <li><a href="#AuthUserFile">AuthUserFile</a>
</ul>

<hr>
<h2><a name="AuthGroupFile"></a></h2>
<strong>Syntax:</strong> AuthGroupFile <em>path [id min-max] [name regex]</em><br>
<strong>Default:</strong> None<br>
<strong>Context:</strong> server config, <code>&lt;VirtualHost&gt;</code>, <code>&lt;Global&gt;</code><br>
<strong>Module:</strong> mod_auth_file<br>
<strong>Compatibility:</strong> 1.2.7rc2

<p>
The <code>AuthGroupFile</code> configures an alternate group file for providing
group membership information; the specified file must have the same format as
the system <code>/etc/group</code> file, and if specified is used during
authentication and group lookups for directory/access control operations. The
<em>path</em> argument should be the full path to the specified file. This
directive can be configured on a per-server basis, so that virtual FTP servers
can each have their own authentication file, often in conjunction with an
<a href="#AuthUserFile"><code>AuthUserFile</code></a>.

<p>
Note that this file does <i>not</i> need to reside inside a
<code>chroot()</code>ed directory structure for anonymous or
<code>DefaultRoot</code> logins, as it is held open for the duration of a
session.

<p>
The optional parameters are used to set restrictions on the contents of
the specified file.  The <em>id</em> restriction is used to specify a range
of GIDs that may appear in the file; when doing a lookup, if a group entry
has a GID that is less than the minimum or greater than the maximum is
encountered, that entry is ignored.  The <em>name</em> restriction is used
to specify a regular expression that is applied to the name of a group
entry.  If the group name does not match the regular expression, the group
entry is ignored.  A leading <code>!</code> in the regular expression can
be used to negate the given expression.

<p>
Example:
<pre>
  # This makes an AuthGroupFile that can only have GIDs 2000 to 4000, and
  # whose groups must start with 'cust'
  AuthGroupFile /etc/ftpd/group id 2000-4000 name ^cust
</pre>

<p>
<hr>
<h2><a name="AuthUserFile"></a></h2>
<strong>Syntax:</strong> AuthUserFile <em>path [id min-max] [home regex] [name regex]</em><br>
<strong>Default:</strong> None<br>
<strong>Context:</strong> server config, <code>&lt;VirtualHost&gt;</code>, <code>&lt;Global&gt;</code><br>
<strong>Module:</strong> mod_auth_file<br>
<strong>Compatibility:</strong> 1.2.7rc2

<p>
The <code>AuthUserFile</code> configures an alternate passwd file for providing
user account information; the specified file must have the same format as the
system <code>/etc/passwd</code> file, and if specified is used during
authentication and user lookups for directory/access control operations. The
<em>path</em> argument should be the full path to the specified file. This
directive can be configured on a per-server basis, so that virtual FTP servers
can each have their own authentication file, often in conjunction with an
<a href="#AuthGroupFile"><code>AuthGroupFile</code></a>.

<p>
Note that this file does <i>not</i> need to reside inside a
<code>chroot()</code>ed directory structure for anonymous or
<code>DefaultRoot</code> logins, as it is held open for the duration of a
session.

<p>
The optional parameters are used to set restrictions on the contents of
the specified file.  The <em>id</em> restriction is used to specify a range
of UIDs that may appear in the file; when doing a lookup, if a user entry
has a UID that is less than the minimum or greater than the maximum is
encountered, that entry is ignored.  The <em>home</em> restriction is used
to specify a regular expression that is applied to the home directory of a user
entry.  If the home does not match the regular expression, the user entry
is ignored.  The <em>name</em> restriction is used to specify a regular
expression that is applied to the name of a user entry.  If the user name does
not match the regular expression, the user entry is ignored.  A leading
<code>!</code> in these regular expressions can be used to negate the given
expression.

<p>
Example:
<pre>
  # This makes an AuthUserFile whose user names must start with 'ftp', and
  # whose homes cannot start with /home.
  AuthUserFile /etc/ftpd/passwd name ^ftp home !^/home
</pre>

<p>
<hr>
<h2><a name="Installation">Installation</a></h2>
The <code>mod_auth_file</code> module is compiled by default.

<p>
<hr><br>

Author: <i>$Author: castaglia $</i><br>
Last Updated: <i>$Date: 2004/04/16 00:36:57 $</i><br>

<br><hr>

<font size=2><b><i>
&copy; Copyright 2002<br>
 All Rights Reserved<br>
</i></b></font>

<hr><br>

</body>
</html>