xref: /netbsd/lib/libwrap/hosts_access.c (revision c4a72b64)
1 /*	$NetBSD: hosts_access.c,v 1.16 2002/06/22 11:52:40 itojun Exp $	*/
2 
3  /*
4   * This module implements a simple access control language that is based on
5   * host (or domain) names, NIS (host) netgroup names, IP addresses (or
6   * network numbers) and daemon process names. When a match is found the
7   * search is terminated, and depending on whether PROCESS_OPTIONS is defined,
8   * a list of options is executed or an optional shell command is executed.
9   *
10   * Host and user names are looked up on demand, provided that suitable endpoint
11   * information is available as sockaddr_in structures or TLI netbufs. As a
12   * side effect, the pattern matching process may change the contents of
13   * request structure fields.
14   *
15   * Diagnostics are reported through syslog(3).
16   *
17   * Compile with -DNETGROUP if your library provides support for netgroups.
18   *
19   * Author: Wietse Venema, Eindhoven University of Technology, The Netherlands.
20   */
21 
22 #include <sys/cdefs.h>
23 #ifndef lint
24 #if 0
25 static char sccsid[] = "@(#) hosts_access.c 1.21 97/02/12 02:13:22";
26 #else
27 __RCSID("$NetBSD: hosts_access.c,v 1.16 2002/06/22 11:52:40 itojun Exp $");
28 #endif
29 #endif
30 
31 /* System libraries. */
32 
33 #include <sys/types.h>
34 #include <sys/param.h>
35 #ifdef INET6
36 #include <sys/socket.h>
37 #endif
38 #include <netinet/in.h>
39 #include <arpa/inet.h>
40 #include <stdio.h>
41 #include <stdlib.h>
42 #include <syslog.h>
43 #include <ctype.h>
44 #include <errno.h>
45 #include <setjmp.h>
46 #include <string.h>
47 #include <netdb.h>
48 #ifdef  NETGROUP
49 #include <netgroup.h>
50 #include <rpcsvc/ypclnt.h>
51 #endif
52 
53 /* Local stuff. */
54 
55 #include "tcpd.h"
56 
57 /* Error handling. */
58 
59 extern jmp_buf tcpd_buf;
60 
61 /* Delimiters for lists of daemons or clients. */
62 
63 static char sep[] = ", \t\r\n";
64 
65 /* Constants to be used in assignments only, not in comparisons... */
66 
67 #define	YES		1
68 #define	NO		0
69 
70  /*
71   * These variables are globally visible so that they can be redirected in
72   * verification mode.
73   */
74 
75 char   *hosts_allow_table = HOSTS_ALLOW;
76 char   *hosts_deny_table = HOSTS_DENY;
77 int     hosts_access_verbose = 0;
78 
79  /*
80   * In a long-running process, we are not at liberty to just go away.
81   */
82 
83 int     resident = (-1);		/* -1, 0: unknown; +1: yes */
84 
85 /* Forward declarations. */
86 
87 static int table_match __P((char *, struct request_info *));
88 static int list_match __P((char *, struct request_info *,
89     int (*)(char *, struct request_info *)));
90 static int server_match __P((char *, struct request_info *));
91 static int client_match __P((char *, struct request_info *));
92 static int host_match __P((char *, struct host_info *));
93 static int rbl_match __P((char *, char *));
94 static int string_match __P((char *, char *));
95 static int masked_match __P((char *, char *, char *));
96 static int masked_match4 __P((char *, char *, char *));
97 #ifdef INET6
98 static int masked_match6 __P((char *, char *, char *));
99 #endif
100 
101 /* Size of logical line buffer. */
102 
103 #define	BUFLEN 2048
104 
105 /* hosts_access - host access control facility */
106 
107 int     hosts_access(request)
108 struct request_info *request;
109 {
110     int     verdict;
111 
112     /*
113      * If the (daemon, client) pair is matched by an entry in the file
114      * /etc/hosts.allow, access is granted. Otherwise, if the (daemon,
115      * client) pair is matched by an entry in the file /etc/hosts.deny,
116      * access is denied. Otherwise, access is granted. A non-existent
117      * access-control file is treated as an empty file.
118      *
119      * After a rule has been matched, the optional language extensions may
120      * decide to grant or refuse service anyway. Or, while a rule is being
121      * processed, a serious error is found, and it seems better to play safe
122      * and deny service. All this is done by jumping back into the
123      * hosts_access() routine, bypassing the regular return from the
124      * table_match() function calls below.
125      */
126 
127     if (resident <= 0)
128 	resident++;
129     verdict = setjmp(tcpd_buf);
130     if (verdict != 0)
131 	return (verdict == AC_PERMIT);
132     if (table_match(hosts_allow_table, request))
133 	return (YES);
134     if (table_match(hosts_deny_table, request))
135 	return (NO);
136     return (YES);
137 }
138 
139 /* table_match - match table entries with (daemon, client) pair */
140 
141 static int table_match(table, request)
142 char   *table;
143 struct request_info *request;
144 {
145     FILE   *fp;
146     char    sv_list[BUFLEN];		/* becomes list of daemons */
147     char   *cl_list;			/* becomes list of clients */
148     char   *sh_cmd = NULL;		/* becomes optional shell command */
149     int     match = NO;
150     struct tcpd_context saved_context;
151 
152     saved_context = tcpd_context;		/* stupid compilers */
153 
154     /*
155      * Between the fopen() and fclose() calls, avoid jumps that may cause
156      * file descriptor leaks.
157      */
158 
159     if ((fp = fopen(table, "r")) != 0) {
160 	tcpd_context.file = table;
161 	tcpd_context.line = 0;
162 	while (match == NO && xgets(sv_list, sizeof(sv_list), fp) != 0) {
163 	    if (sv_list[strlen(sv_list) - 1] != '\n') {
164 		tcpd_warn("missing newline or line too long");
165 		continue;
166 	    }
167 	    if (sv_list[0] == '#' || sv_list[strspn(sv_list, " \t\r\n")] == 0)
168 		continue;
169 	    if ((cl_list = split_at(sv_list, ':')) == 0) {
170 		tcpd_warn("missing \":\" separator");
171 		continue;
172 	    }
173 	    sh_cmd = split_at(cl_list, ':');
174 	    match = list_match(sv_list, request, server_match)
175 		&& list_match(cl_list, request, client_match);
176 	}
177 	(void) fclose(fp);
178     } else if (errno != ENOENT) {
179 	tcpd_warn("cannot open %s: %m", table);
180     }
181     if (match) {
182 	if (hosts_access_verbose > 1)
183 	    syslog(LOG_DEBUG, "matched:  %s line %d",
184 		   tcpd_context.file, tcpd_context.line);
185 	if (sh_cmd) {
186 #ifdef PROCESS_OPTIONS
187 	    process_options(sh_cmd, request);
188 #else
189 	    char    cmd[BUFSIZ];
190 	    shell_cmd(percent_x(cmd, sizeof(cmd), sh_cmd, request));
191 #endif
192 	}
193     }
194     tcpd_context = saved_context;
195     return (match);
196 }
197 
198 /* list_match - match a request against a list of patterns with exceptions */
199 
200 static int list_match(list, request, match_fn)
201 char   *list;
202 struct request_info *request;
203 int   (*match_fn) __P((char *, struct request_info *));
204 {
205     char   *tok, *last;
206     int l;
207 
208     /*
209      * Process tokens one at a time. We have exhausted all possible matches
210      * when we reach an "EXCEPT" token or the end of the list. If we do find
211      * a match, look for an "EXCEPT" list and recurse to determine whether
212      * the match is affected by any exceptions.
213      */
214 
215     for (tok = strtok_r(list, sep, &last); tok != 0;
216       tok = strtok_r(NULL, sep, &last)) {
217 	if (STR_EQ(tok, "EXCEPT"))		/* EXCEPT: give up */
218 	    return (NO);
219 	l = strlen(tok);
220 	if (*tok == '[' && tok[l - 1] == ']') {
221 	    tok[l - 1] = '\0';
222 	    tok++;
223 	}
224 	if (match_fn(tok, request)) {		/* YES: look for exceptions */
225 	    while ((tok = strtok_r(NULL, sep, &last)) && STR_NE(tok, "EXCEPT"))
226 		 /* VOID */ ;
227 	    return (tok == 0 || list_match(NULL, request, match_fn) == 0);
228 	}
229     }
230     return (NO);
231 }
232 
233 /* server_match - match server information */
234 
235 static int server_match(tok, request)
236 char   *tok;
237 struct request_info *request;
238 {
239     char   *host;
240 
241     if ((host = split_at(tok + 1, '@')) == 0) {	/* plain daemon */
242 	return (string_match(tok, eval_daemon(request)));
243     } else {					/* daemon@host */
244 	return (string_match(tok, eval_daemon(request))
245 		&& host_match(host, request->server));
246     }
247 }
248 
249 /* client_match - match client information */
250 
251 static int client_match(tok, request)
252 char   *tok;
253 struct request_info *request;
254 {
255     char   *host;
256 
257     if ((host = split_at(tok + 1, '@')) == 0) {	/* plain host */
258 	return (host_match(tok, request->client));
259     } else {					/* user@host */
260 	return (host_match(host, request->client)
261 		&& string_match(tok, eval_user(request)));
262     }
263 }
264 
265 /* host_match - match host name and/or address against pattern */
266 
267 static int host_match(tok, host)
268 char   *tok;
269 struct host_info *host;
270 {
271     char   *mask;
272 
273     /*
274      * This code looks a little hairy because we want to avoid unnecessary
275      * hostname lookups.
276      *
277      * The KNOWN pattern requires that both address AND name be known; some
278      * patterns are specific to host names or to host addresses; all other
279      * patterns are satisfied when either the address OR the name match.
280      */
281 
282     if (tok[0] == '@') {			/* netgroup: look it up */
283 #ifdef  NETGROUP
284 	static char *mydomain = 0;
285 	if (mydomain == 0)
286 	    yp_get_default_domain(&mydomain);
287 	return (innetgr(tok + 1, eval_hostname(host), NULL, mydomain));
288 #else
289 	tcpd_warn("netgroup support is disabled");	/* not tcpd_jump() */
290 	return (NO);
291 #endif
292     } else if (STR_EQ(tok, "KNOWN")) {		/* check address and name */
293 	char   *name = eval_hostname(host);
294 	return (STR_NE(eval_hostaddr(host), unknown) && HOSTNAME_KNOWN(name));
295     } else if (STR_EQ(tok, "LOCAL")) {		/* local: no dots in name */
296 	char   *name = eval_hostname(host);
297 	return (strchr(name, '.') == 0 && HOSTNAME_KNOWN(name));
298     } else if (strncmp(tok, "{RBL}.", 6) == 0) { /* RBL lookup in domain */
299 	return rbl_match(tok+6, eval_hostaddr(host));
300     } else if ((mask = split_at(tok, '/')) != 0) {	/* net/mask */
301 	return (masked_match(tok, mask, eval_hostaddr(host)));
302     } else {					/* anything else */
303 	return (string_match(tok, eval_hostaddr(host))
304 	    || (NOT_INADDR(tok) && string_match(tok, eval_hostname(host))));
305     }
306 }
307 
308 /* rbl_match() - match host by looking up in RBL domain */
309 
310 static int rbl_match(rbl_domain, rbl_hostaddr)
311 char   *rbl_domain;				/* RBL domain */
312 char   *rbl_hostaddr;				/* hostaddr */
313 {
314     char *rbl_name;
315     unsigned long host_address;
316     int ret = NO;
317     size_t len = strlen(rbl_domain) + (4 * 4) + 2;
318 
319     if (dot_quad_addr(rbl_hostaddr, &host_address) != 0) {
320 	tcpd_warn("unable to convert %s to address", rbl_hostaddr);
321 	return (NO);
322     }
323     /*  construct the rbl name to look up */
324     if ((rbl_name = malloc(len)) == NULL) {
325 	tcpd_jump("not enough memory to build RBL name for %s in %s", rbl_hostaddr, rbl_domain);
326 	/* NOTREACHED */
327     }
328     snprintf(rbl_name, len, "%u.%u.%u.%u.%s",
329 	    (unsigned int) ((host_address) & 0xff),
330 	    (unsigned int) ((host_address >> 8) & 0xff),
331 	    (unsigned int) ((host_address >> 16) & 0xff),
332 	    (unsigned int) ((host_address >> 24) & 0xff),
333 	    rbl_domain);
334     /* look it up */
335     if (gethostbyname(rbl_name) != NULL) {
336 	/* successful lookup - they're on the RBL list */
337 	ret = YES;
338     }
339     free(rbl_name);
340 
341     return ret;
342 }
343 
344 /* string_match - match string against pattern */
345 
346 static int string_match(tok, string)
347 char   *tok;
348 char   *string;
349 {
350     int     n;
351 
352     if (tok[0] == '.') {			/* suffix */
353 	n = strlen(string) - strlen(tok);
354 	return (n > 0 && STR_EQ(tok, string + n));
355     } else if (STR_EQ(tok, "ALL")) {		/* all: match any */
356 	return (YES);
357     } else if (STR_EQ(tok, "KNOWN")) {		/* not unknown */
358 	return (STR_NE(string, unknown));
359     } else if (tok[(n = strlen(tok)) - 1] == '.') {	/* prefix */
360 	return (STRN_EQ(tok, string, n));
361     } else {					/* exact match */
362 	return (STR_EQ(tok, string));
363     }
364 }
365 
366 /* masked_match - match address against netnumber/netmask */
367 
368 static int masked_match(net_tok, mask_tok, string)
369 char   *net_tok;
370 char   *mask_tok;
371 char   *string;
372 {
373 #ifndef INET6
374     return masked_match4(net_tok, mask_tok, string);
375 #else
376     /*
377      * masked_match4() is kept just for supporting shortened IPv4 address form.
378      * If we could get rid of shortened IPv4 form, we could just always use
379      * masked_match6().
380      */
381     if (dot_quad_addr(net_tok, NULL) != INADDR_NONE &&
382         dot_quad_addr(mask_tok, NULL) != INADDR_NONE &&
383         dot_quad_addr(string, NULL) != INADDR_NONE) {
384 	return masked_match4(net_tok, mask_tok, string);
385     } else
386 	return masked_match6(net_tok, mask_tok, string);
387 #endif
388 }
389 
390 static int masked_match4(net_tok, mask_tok, string)
391 char   *net_tok;
392 char   *mask_tok;
393 char   *string;
394 {
395     unsigned long net;
396     unsigned long mask;
397     unsigned long addr;
398 
399     /*
400      * Disallow forms other than dotted quad: the treatment that inet_addr()
401      * gives to forms with less than four components is inconsistent with the
402      * access control language. John P. Rouillard <rouilj@cs.umb.edu>.
403      */
404 
405     if (dot_quad_addr(string, &addr) != 0)
406 	return (NO);
407     if (dot_quad_addr(net_tok, &net) != 0 ||
408         dot_quad_addr(mask_tok, &mask) != 0) {
409 	tcpd_warn("bad net/mask expression: %s/%s", net_tok, mask_tok);
410 	return (NO);				/* not tcpd_jump() */
411     }
412 
413     if ((net & ~mask) != 0)
414 	tcpd_warn("host bits not all zero in %s/%s", net_tok, mask_tok);
415 
416     return ((addr & mask) == net);
417 }
418 
419 #ifdef INET6
420 static int masked_match6(net_tok, mask_tok, string)
421 char   *net_tok;
422 char   *mask_tok;
423 char   *string;
424 {
425     union {
426 	struct sockaddr sa;
427 	struct sockaddr_in sin;
428 	struct sockaddr_in6 sin6;
429     } net, mask, addr;
430     struct addrinfo hints, *res;
431     unsigned long masklen;
432     char *ep;
433     int i;
434     char *np, *mp, *ap;
435     int alen;
436 
437     memset(&hints, 0, sizeof(hints));
438     hints.ai_family = PF_UNSPEC;
439     hints.ai_socktype = SOCK_DGRAM;	/*dummy*/
440     hints.ai_flags = AI_NUMERICHOST;
441     if (getaddrinfo(net_tok, "0", &hints, &res) == 0) {
442 	if (res->ai_addrlen > sizeof(net) || res->ai_next) {
443 	    freeaddrinfo(res);
444 	    return NO;
445 	}
446 	memcpy(&net, res->ai_addr, res->ai_addrlen);
447 	freeaddrinfo(res);
448     } else
449 	return NO;
450 
451     memset(&hints, 0, sizeof(hints));
452     hints.ai_family = net.sa.sa_family;
453     hints.ai_socktype = SOCK_DGRAM;	/*dummy*/
454     hints.ai_flags = AI_NUMERICHOST;
455     ep = NULL;
456     if (getaddrinfo(mask_tok, "0", &hints, &res) == 0) {
457 	if (res->ai_family == AF_INET6 &&
458 	    ((struct sockaddr_in6 *)res->ai_addr)->sin6_scope_id) {
459 	    freeaddrinfo(res);
460 	    return NO;
461 	}
462 	if (res->ai_addrlen > sizeof(mask) || res->ai_next) {
463 	    freeaddrinfo(res);
464 	    return NO;
465 	}
466 	memcpy(&mask, res->ai_addr, res->ai_addrlen);
467 	freeaddrinfo(res);
468     } else {
469 	ep = NULL;
470 	masklen = strtoul(mask_tok, &ep, 10);
471 	if (ep && !*ep) {
472 	    memset(&mask, 0, sizeof(mask));
473 	    mask.sa.sa_family = net.sa.sa_family;
474 	    mask.sa.sa_len = net.sa.sa_len;
475 	    switch (mask.sa.sa_family) {
476 	    case AF_INET:
477 		mp = (char *)&mask.sin.sin_addr;
478 		alen = sizeof(mask.sin.sin_addr);
479 		break;
480 	    case AF_INET6:
481 		mp = (char *)&mask.sin6.sin6_addr;
482 		alen = sizeof(mask.sin6.sin6_addr);
483 		break;
484 	    default:
485 		return NO;
486 	    }
487 	    if (masklen / 8 > alen)
488 		return NO;
489 	    memset(mp, 0xff, masklen / 8);
490 	    if (masklen % 8)
491 		mp[masklen / 8] = 0xff00 >> (masklen % 8);
492 	} else
493 	    return NO;
494     }
495 
496     memset(&hints, 0, sizeof(hints));
497     hints.ai_family = PF_UNSPEC;
498     hints.ai_socktype = SOCK_DGRAM;	/*dummy*/
499     hints.ai_flags = AI_NUMERICHOST;
500     if (getaddrinfo(string, "0", &hints, &res) == 0) {
501 	if (res->ai_addrlen > sizeof(addr) || res->ai_next) {
502 	    freeaddrinfo(res);
503 	    return NO;
504 	}
505 	/* special case - IPv4 mapped address */
506 	if (net.sa.sa_family == AF_INET && res->ai_family == AF_INET6 &&
507 	    IN6_IS_ADDR_V4MAPPED(&((struct sockaddr_in6 *)res->ai_addr)->sin6_addr)) {
508 	    memset(&addr, 0, sizeof(addr));
509 	    addr.sa.sa_family = net.sa.sa_family;
510 	    addr.sa.sa_len = net.sa.sa_len;
511 	    memcpy(&addr.sin.sin_addr,
512 	        &((struct sockaddr_in6 *)res->ai_addr)->sin6_addr.s6_addr[12],
513 		sizeof(addr.sin.sin_addr));
514 	} else
515 	    memcpy(&addr, res->ai_addr, res->ai_addrlen);
516 	freeaddrinfo(res);
517     } else
518 	return NO;
519 
520     if (net.sa.sa_family != mask.sa.sa_family ||
521         net.sa.sa_family != addr.sa.sa_family) {
522 	return NO;
523     }
524 
525     switch (net.sa.sa_family) {
526     case AF_INET:
527 	np = (char *)&net.sin.sin_addr;
528 	mp = (char *)&mask.sin.sin_addr;
529 	ap = (char *)&addr.sin.sin_addr;
530 	alen = sizeof(net.sin.sin_addr);
531 	break;
532     case AF_INET6:
533 	np = (char *)&net.sin6.sin6_addr;
534 	mp = (char *)&mask.sin6.sin6_addr;
535 	ap = (char *)&addr.sin6.sin6_addr;
536 	alen = sizeof(net.sin6.sin6_addr);
537 	break;
538     default:
539 	return NO;
540     }
541 
542     for (i = 0; i < alen; i++)
543 	if (np[i] & ~mp[i]) {
544 	    tcpd_warn("host bits not all zero in %s/%s", net_tok, mask_tok);
545 	    break;
546 	}
547 
548     for (i = 0; i < alen; i++)
549 	ap[i] &= mp[i];
550 
551     if (addr.sa.sa_family == AF_INET6 && addr.sin6.sin6_scope_id &&
552         addr.sin6.sin6_scope_id != net.sin6.sin6_scope_id)
553 	return NO;
554     return (memcmp(ap, np, alen) == 0);
555 }
556 #endif
557