Do not allow umtx_sleep() to restart on a restartable signal. We want to
[dragonfly.git] / libexec / ftpd / ftpchroot.5
1 .\" Copyright (c) 2003 FreeBSD Project
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\"
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 .\" SUCH DAMAGE.
24 .\"
25 .\" $FreeBSD: src/libexec/ftpd/ftpchroot.5,v 1.2.2.1 2003/02/11 14:28:28 yar Exp $
26 .\" $DragonFly: src/libexec/ftpd/ftpchroot.5,v 1.4 2007/05/17 08:19:01 swildner Exp $
27 .\"
28 .Dd January 26, 2003
29 .Dt FTPCHROOT 5
30 .Os
31 .Sh NAME
32 .Nm ftpchroot
33 .Nd list users and groups subject to FTP access restrictions
34 .Sh DESCRIPTION
35 The file
36 .Nm
37 is read by
38 .Xr ftpd 8
39 at the beginning of an FTP session, after having authenticated the user.
40 Each line in
41 .Nm
42 corresponds to a user or group.  If a line in
43 .Nm
44 matches the current user or a group he is a member of,
45 access restrictions will be applied to this
46 session by changing its root directory with
47 .Xr chroot 2
48 to that specified on the line or to the user's login directory.
49 .Pp
50 The order of records in
51 .Nm
52 is important because the first match will be used.
53 Fields on each line are separated by tabs or spaces.
54 .Pp
55 The first field specifies a user or group name.
56 If it is prefixed by an
57 .Qq at
58 sign,
59 .Ql \&@ ,
60 it specifies a group name;
61 the line will match each user who is a member of this group.
62 As a special case, a single
63 .Ql \&@
64 in this field will match any user.
65 A username is specified otherwise.
66 .Pp
67 The optional second field describes the directory for the user
68 or each member of the group to be locked up in using
69 .Xr chroot 2 .
70 Be it omitted, the user's login directory will be used.
71 If it is not an absolute pathname, then it will be relative
72 to the user's login directory.
73 If it contains the
74 .Qq \&/./
75 separator,
76 .Xr ftpd 8
77 will treat its left-hand side as the name of the directory to do
78 .Xr chroot 2
79 to, and its right-hand side to change the current directory to afterwards.
80 .Sh FILES
81 .Bl -tag -width /etc/ftpchroot -compact
82 .It Pa /etc/ftpchroot
83 .El
84 .Sh EXAMPLES
85 These lines in
86 .Nm
87 will lock up the user
88 .Qq webuser
89 and each member of the group
90 .Qq hostee
91 in their respective login directories:
92 .Bd -literal -offset indent
93 webuser
94 @hostee
95 .Ed
96 .Pp
97 And this line will tell
98 .Xr ftpd 8
99 to lock up the user
100 .Qq joe
101 in
102 .Pa /var/spool/ftp
103 and then to change the current directory to
104 .Pa /joe ,
105 which is relative to the session's new root:
106 .Bd -literal -offset indent
107 joe     /var/spool/ftp/./joe
108 .Ed
109 .Pp
110 And finally the following line will lock up every user connecting
111 through FTP in his respective
112 .Pa \&~/public_html ,
113 thus lowering possible impact on the system
114 from intrinsic insecurity of FTP:
115 .Bd -literal -offset indent
116 @       public_html
117 .Ed
118 .Sh SEE ALSO
119 .Xr chroot 2 ,
120 .Xr group 5 ,
121 .Xr passwd 5 ,
122 .Xr ftpd 8