Remove building with NOCRYPTO option
[minix3.git] / lib / libwrap / hosts_access.5
blob97ce5f2b96d26b5278a6f886f6cefe6d9be91463
1 .TH HOSTS_ACCESS 5
2 .SH NAME
3 hosts_access,
4 hosts.allow,
5 hosts.deny \- format of host access control files
6 .SH DESCRIPTION
7 This manual page describes a simple access control language that is
8 based on client (host name/address, user name), and server (process
9 name, host name/address) patterns.
10 Examples are given at the end.
11 The impatient reader is encouraged to skip to the EXAMPLES section for a
12 quick introduction.
13 .PP
14 Note that in a `stock' installation of the tcp_wrappers package, a
15 program called \fItcpd\fR is called from \fI/etc/inetd.conf\fR, and
16 this program performs the wrapper checks and then executes the daemon.
17 In NetBSD \fIinetd\fR(8) has been modified to perform this check
18 internally, and so tcpd is neither used nor supplied.
19 .PP
20 Also note that libwrap under NetBSD uses the extensions to the access
21 control language as described in the \fIhosts_options\fR(5).
22 .PP
23 In the following text, \fIdaemon\fR is the process name of a
24 network daemon process, and \fIclient\fR is the name and/or address of
25 a host requesting service.
26 Network daemon process names are specified in the inetd configuration file.
27 .SH "ACCESS CONTROL FILES"
28 The access control software consults two files.
29 The search stops at the first match:
30 .IP \(bu
31 Access will be granted when a (daemon,client) pair matches an entry in
32 the \fI/etc/hosts.allow\fR file.
33 .IP \(bu
34 Otherwise, access will be denied when a (daemon,client) pair matches an
35 entry in the \fI/etc/hosts.deny\fR file.
36 .IP \(bu
37 Otherwise, access will be granted.
38 .PP
39 A non-existing access control file is treated as if it were an empty
40 file.
41 Thus, access control can be turned off by providing no access
42 control files.
43 .SH "ACCESS CONTROL RULES"
44 Each access control file consists of zero or more lines of text.
45 These lines are processed in order of appearance.
46 The search terminates when a match is found.
47 .IP \(bu
48 A newline character is ignored when it is preceded by a backslash character.
49 This permits you to break up long lines so that they are easier to edit.
50 \fBWARNING:\fP  The total length of an entry can be no
51 more than 2047 characters long including the final newline.
52 .IP \(bu
53 Blank lines or lines that begin with a `#\' character are ignored.
54 This permits you to insert comments and whitespace so that the tables
55 are easier to read.
56 .IP \(bu
57 All other lines should satisfy the following format, things between []
58 being optional:
59 .sp
60 .ti +3
61 daemon_list : client_list : option : option ...
62 .PP
63 \fIdaemon_list\fR is a list of one or more daemon process names
64 (argv[0] values) or wildcards (see below).
65 .PP
66 \fIclient_list\fR is a list
67 of one or more host names, host addresses, patterns or wildcards (see
68 below) that will be matched against the client host name or address.
69 When a client_list item needs to include colon character (for IPv6 addresses),
70 the item needs to be wrapped with square bracket.
71 .PP
72 The more complex forms \fIdaemon@host\fR and \fIuser@host\fR are
73 explained in the sections on server endpoint patterns and on client
74 username lookups, respectively.
75 .PP
76 List elements should be separated by blanks and/or commas.
77 .PP
78 With the exception of NIS (YP) netgroup lookups, all access control
79 checks are case insensitive.
80 .ne 4
81 .SH PATTERNS
82 The access control language implements the following patterns:
83 .IP \(bu
84 A string that begins with a `.\' character.
85 A host name is matched if
86 the last components of its name match the specified pattern.
87 For example, the pattern `.tue.nl\' matches the host name
88 `wzv.win.tue.nl\'.
89 .IP \(bu
90 A string that ends with a `.\' character.
91 A host address is matched if
92 its first numeric fields match the given string.
93 For example, the
94 pattern `131.155.\' matches the address of (almost) every host on the
95 Eind\%hoven University network (131.155.x.x).
96 .IP \(bu
97 A string that begins with an `@\' character is treated as an NIS
98 (formerly YP) netgroup name.
99 A host name is matched if it is a host member of the specified netgroup.
100 Netgroup matches are not supported
101 for daemon process names or for client user names.
102 .IP \(bu
103 An expression of the form `n.n.n.n/m.m.m.m\' is interpreted as a
104 `net/mask\' pair.
105 A host address is matched if `net\' is equal to the
106 bitwise AND of the address and the `mask\'.
107 For example, the net/mask
108 pattern `131.155.72.0/255.255.254.0\' matches every address in the
109 range `131.155.72.0\' through `131.155.73.255\'.
110 Note that `m.m.m.m\' portion must always be specified.
111 .IP \(bu
112 An expression of the form `ipv6-addr/ipv6-mask\' is interpreted as
113 masked IPv6 address match, just like masked IPv4 address match (see above).
114 Note that `ipv6-mask\' portion must always be specified.
115 .IP \(bu
116 An expression of the form `ipv6-addr/prefixlen\' is interpreted as
117 masked IPv6 address match (with mask specified by numeric prefixlen),
118 just like masked IPv4 address match (see above).
119 Note that `prefixlen\' portion must always be specified.
120 .IP \(bu
121 A string that begins with a `/\' character is treated as a file
122 name. A host name or address is matched if it matches any host name
123 or address pattern listed in the named file. The file format is
124 zero or more lines with zero or more host name or address patterns
125 separated by whitespace.  A file name pattern can be used anywhere
126 a host name or address pattern can be used.
127 .SH WILDCARDS
128 The access control language supports explicit wildcards:
129 .IP ALL
130 The universal wildcard, always matches.
131 .IP LOCAL
132 Matches any host whose name does not contain a dot character.
133 .IP UNKNOWN
134 Matches any user whose name is unknown, and matches any host whose name
135 \fIor\fR address are unknown.
136 This pattern should be used with care:
137 host names may be unavailable due to temporary name server problems.
138 A network address will be unavailable when the software cannot figure out
139 what type of network it is talking to.
140 .IP KNOWN
141 Matches any user whose name is known, and matches any host whose name
142 \fIand\fR address are known.
143 This pattern should be used with care:
144 host names may be unavailable due to temporary name server problems.
145 A network address will be unavailable when the software cannot figure out
146 what type of network it is talking to.
147 .IP PARANOID
148 Matches any host whose name does not match its address.
149 Note that unlike the default mode of \fItcpd\fR, NetBSD \fIinetd\fR
150 does not automatically drop these requests; you must explicitly
151 drop them in your \fI/etc/hosts.allow\fR or \fI/etc/hosts.deny\fR file.
152 .IP "{RBL}.\fIdomain\fR"
153 Matches any host whose reversed address appears in the DNS under
154 \fIdomain\fR.
155 The primary such domain used for blocking unsolicited
156 commercial e-mail (spam) is `.rbl.maps.vix.com\'.
157 .ne 6
158 .SH OPERATORS
159 .IP EXCEPT
160 Intended use is of the form: `list_1 EXCEPT list_2\'; this construct
161 matches anything that matches \fIlist_1\fR unless it matches
162 \fIlist_2\fR.
163 The EXCEPT operator can be used in daemon_lists and in client_lists.
164 The EXCEPT operator can be nested: if the control
165 language would permit the use of parentheses, `a EXCEPT b EXCEPT c\'
166 would parse as `(a EXCEPT (b EXCEPT c))\'.
168 .ne 6
169 .SH % EXPANSIONS
170 The following expansions are available within some options:
171 .IP "%a (%A)"
172 The client (server) host address.
173 .IP %c
174 Client information: user@host, user@address, a host name, or just an
175 address, depending on how much information is available.
176 .IP %d
177 The daemon process name (argv[0] value).
178 .IP "%h (%H)"
179 The client (server) host name or address, if the host name is
180 unavailable.
181 .IP "%n (%N)"
182 The client (server) host name (or "unknown" or "paranoid").
183 .IP %p
184 The daemon process id.
185 .IP %s
186 Server information: daemon@host, daemon@address, or just a daemon name,
187 depending on how much information is available.
188 .IP %u
189 The client user name (or "unknown").
190 .IP %%
191 Expands to a single `%\' character.
193 Characters in % expansions that may confuse the shell are replaced by
194 underscores.
195 .SH "SERVER ENDPOINT PATTERNS"
196 In order to distinguish clients by the network address that they
197 connect to, use patterns of the form:
199 .ti +3
200 process_name@host_pattern : client_list ...
202 Patterns like these can be used when the machine has different internet
203 addresses with different internet hostnames.
204 Service providers can use
205 this facility to offer FTP, GOPHER or WWW archives with internet names
206 that may even belong to different organizations.
207 See also the `twist' option in the hosts_options(5) document.
208 Some systems (Solaris, FreeBSD, NetBSD) can have more than one
209 internet address on one physical interface; with other systems
210 you may have to resort to SLIP or PPP pseudo interfaces that
211 live in a dedicated network address space.
213 The host_pattern obeys the same syntax rules as host names and
214 addresses in client_list context.
215 Usually, server endpoint information
216 is available only with connection-oriented services.
217 .SH "CLIENT USERNAME LOOKUP"
218 When the client host supports the RFC 931 protocol or one of its
219 descendants (TAP, IDENT, RFC 1413) the wrapper programs can retrieve
220 additional information about the owner of a connection.
221 Client username information, when available,
222 is logged together with the client host
223 name, and can be used to match patterns like:
225 .ti +3
226 daemon_list : ... user_pattern@host_pattern ...
228 The daemon wrappers can be configured at compile time to perform
229 rule-driven username lookups (default) or to always interrogate the
230 client host.
231 In the case of rule-driven username lookups, the above
232 rule would cause username lookup only when both the \fIdaemon_list\fR
233 and the \fIhost_pattern\fR match.
235 A user pattern has the same syntax as a daemon process pattern, so the
236 same wildcards apply (netgroup membership is not supported).
237 One should not get carried away with username lookups, though.
238 .IP \(bu
239 The client username information cannot be trusted when it is needed
240 most, i.e. when the client system has been compromised.
241 In general,
242 ALL and (UN)KNOWN are the only user name patterns that make sense.
243 .IP \(bu
244 Username lookups are possible only with TCP-based services, and only
245 when the client host runs a suitable daemon; in all other cases the
246 result is "unknown".
247 .IP \(bu
248 A well-known UNIX kernel bug may cause loss of service when username
249 lookups are blocked by a firewall.
250 The wrapper README document
251 describes a procedure to find out if your kernel has this bug.
252 .IP \(bu
253 Username lookups may cause noticeable delays for non-UNIX users.
254 The default timeout for username lookups is 10 seconds: too short to cope
255 with slow networks, but long enough to irritate PC users.
257 Selective username lookups can alleviate the last problem.
258 For example, a rule like:
260 .ti +3
261 daemon_list : @pcnetgroup ALL@ALL
263 would match members of the pc netgroup without doing username lookups,
264 but would perform username lookups with all other systems.
265 .SH "DETECTING ADDRESS SPOOFING ATTACKS"
266 A flaw in the sequence number generator of many TCP/IP implementations
267 allows intruders to easily impersonate trusted hosts and to break in
268 via, for example, the remote shell service.
269 The IDENT (RFC 931 etc.) service can be used to detect such and
270 other host address spoofing attacks.
272 Before accepting a client request, the wrappers can use the IDENT
273 service to find out that the client did not send the request at all.
274 When the client host provides IDENT service, a negative IDENT lookup
275 result (the client matches `UNKNOWN@host') is strong evidence of a host
276 spoofing attack.
278 A positive IDENT lookup result (the client matches `KNOWN@host') is
279 less trustworthy.
280 It is possible for an intruder to spoof both the
281 client connection and the IDENT lookup, although doing so is much
282 harder than spoofing just a client connection.
283 It may also be that the client\'s IDENT server is lying.
285 Note: IDENT lookups don\'t work with UDP services.
286 .SH EXAMPLES
287 The language is flexible enough that different types of access control
288 policy can be expressed with a minimum of fuss.
289 Although the language
290 uses two access control tables, the most common policies can be
291 implemented with one of the tables being trivial or even empty.
293 When reading the examples below it is important to realize that the
294 allow table is scanned before the deny table, that the search
295 terminates when a match is found, and that access is granted when no
296 match is found at all.
298 The examples use host and domain names.
299 They can be improved by
300 including address and/or network/netmask information, to reduce the
301 impact of temporary name server lookup failures.
302 .SH "MOSTLY CLOSED"
303 In this case, access is denied by default.
304 Only explicitly authorized hosts are permitted access.
306 The default policy (no access) is implemented with a trivial deny file:
308 .ne 2
309 /etc/hosts.deny:
310 .in +3
311 ALL: ALL
313 This denies all service to all hosts, unless they are permitted access
314 by entries in the allow file.
316 The explicitly authorized hosts are listed in the allow file.
317 For example:
319 .ne 2
320 /etc/hosts.allow:
321 .in +3
322 ALL: LOCAL @some_netgroup
324 ALL: .foobar.edu EXCEPT terminalserver.foobar.edu
326 The first rule permits access from hosts in the local domain (no `.\'
327 in the host name) and from members of the \fIsome_netgroup\fP netgroup.
328 The second rule permits access from all hosts in the
329 \fIfoobar.edu\fP domain (notice the leading dot), with the exception of
330 \fIterminalserver.foobar.edu\fP.
331 .SH "MOSTLY OPEN"
332 Here, access is granted by default; only explicitly specified hosts are
333 refused service.
335 The default policy (access granted) makes the allow file redundant so
336 that it can be omitted.
337 The explicitly non-authorized hosts are listed in the deny file.
338 For example:
340 /etc/hosts.deny:
341 .in +3
342 ALL: some.host.name, .some.domain
344 ALL EXCEPT in.fingerd: other.host.name, .other.domain
346 The first rule denies some hosts and domains all services; the second
347 rule still permits finger requests from other hosts and domains.
348 .SH "BOOBY TRAPS"
349 The next example permits tftp requests from hosts in the local domain
350 (notice the leading dot).
351 Requests from any other hosts are denied.
352 Instead of the requested file, a finger probe is sent to the offending host.
353 The result is mailed to the superuser.
355 .ne 2
356 /etc/hosts.allow:
357 .in +3
359 in.tftpd: LOCAL, .my.domain
361 .ne 2
362 /etc/hosts.deny:
363 .in +3
365 in.tftpd: ALL: spawn (/some/where/safe_finger -l @%h | \\
366         /usr/ucb/mail -s %d-%h root) \*[Am]
369 (The safe_finger command can be gotten from the tcp_wrappers package and
370 installed in a suitable place.
371 It limits possible damage from data sent by the remote finger server.
372 It gives better protection than the standard finger command.)
374 The expansion of the %h (client host) and %d (service name) sequences
375 is described in the section on shell commands.
377 Warning: do not booby-trap your finger daemon, unless you are prepared
378 for infinite finger loops.
380 On network firewall systems this trick can be carried even further.
381 The typical network firewall only provides a limited set of services to
382 the outer world.
383 All other services can be "bugged" just like the above tftp example.
384 The result is an excellent early-warning system.
386 .ne 4
387 .SH DIAGNOSTICS
388 An error is reported when a syntax error is found in a host access
389 control rule; when the length of an access control rule exceeds the
390 capacity of an internal buffer; when an access control rule is not
391 terminated by a newline character; when the result of %\*[Lt]letter\*[Gt]
392 expansion would overflow an internal buffer; when a system call fails
393 that shouldn\'t.
394 All problems are reported via the syslog daemon.
395 .SH FILES
398 /etc/hosts.allow, (daemon,client) pairs that are granted access.
399 /etc/hosts.deny, (daemon,client) pairs that are denied access.
402 .SH "SEE ALSO"
404 hosts_options(5), hosts_access(3)
405 tcpdchk(8), tcpdmatch(8), test programs.
406 .SH BUGS
407 If a name server lookup times out, the host name will not be available
408 to the access control software, even though the host is registered.
410 Domain name server lookups are case insensitive; NIS (formerly YP)
411 netgroup lookups are case sensitive.
413 The total length of an entry can be no more than 2047 characters long,
414 including the final newline.
415 .SH AUTHOR
418 Wietse Venema (wietse@wzv.win.tue.nl)
419 Department of Mathematics and Computing Science
420 Eindhoven University of Technology
421 Den Dolech 2, P.O. Box 513,
422 5600 MB Eindhoven, The Netherlands
423 .\" @(#) hosts_access.5 1.20 95/01/30 19:51:46
424 .\"     $NetBSD: hosts_access.5,v 1.16 2008/12/18 20:16:52 christos Exp $