xref: /openbsd/usr.bin/ssh/addrmatch.c (revision 404b540a)
1 /*	$OpenBSD: addrmatch.c,v 1.4 2008/12/10 03:55:20 stevesk Exp $ */
2 
3 /*
4  * Copyright (c) 2004-2008 Damien Miller <djm@mindrot.org>
5  *
6  * Permission to use, copy, modify, and distribute this software for any
7  * purpose with or without fee is hereby granted, provided that the above
8  * copyright notice and this permission notice appear in all copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17  */
18 
19 #include <sys/types.h>
20 #include <sys/socket.h>
21 #include <netinet/in.h>
22 #include <arpa/inet.h>
23 
24 #include <netdb.h>
25 #include <string.h>
26 #include <stdlib.h>
27 #include <stdio.h>
28 #include <stdarg.h>
29 
30 #include "match.h"
31 #include "log.h"
32 #include "xmalloc.h"
33 
34 struct xaddr {
35 	sa_family_t	af;
36 	union {
37 		struct in_addr		v4;
38 		struct in6_addr		v6;
39 		u_int8_t		addr8[16];
40 		u_int32_t		addr32[4];
41 	} xa;		    /* 128-bit address */
42 	u_int32_t	scope_id;	/* iface scope id for v6 */
43 #define v4	xa.v4
44 #define v6	xa.v6
45 #define addr8	xa.addr8
46 #define addr32	xa.addr32
47 };
48 
49 static int
50 addr_unicast_masklen(int af)
51 {
52 	switch (af) {
53 	case AF_INET:
54 		return 32;
55 	case AF_INET6:
56 		return 128;
57 	default:
58 		return -1;
59 	}
60 }
61 
62 static inline int
63 masklen_valid(int af, u_int masklen)
64 {
65 	switch (af) {
66 	case AF_INET:
67 		return masklen <= 32 ? 0 : -1;
68 	case AF_INET6:
69 		return masklen <= 128 ? 0 : -1;
70 	default:
71 		return -1;
72 	}
73 }
74 
75 /*
76  * Convert struct sockaddr to struct xaddr
77  * Returns 0 on success, -1 on failure.
78  */
79 static int
80 addr_sa_to_xaddr(struct sockaddr *sa, socklen_t slen, struct xaddr *xa)
81 {
82 	struct sockaddr_in *in4 = (struct sockaddr_in *)sa;
83 	struct sockaddr_in6 *in6 = (struct sockaddr_in6 *)sa;
84 
85 	memset(xa, '\0', sizeof(*xa));
86 
87 	switch (sa->sa_family) {
88 	case AF_INET:
89 		if (slen < sizeof(*in4))
90 			return -1;
91 		xa->af = AF_INET;
92 		memcpy(&xa->v4, &in4->sin_addr, sizeof(xa->v4));
93 		break;
94 	case AF_INET6:
95 		if (slen < sizeof(*in6))
96 			return -1;
97 		xa->af = AF_INET6;
98 		memcpy(&xa->v6, &in6->sin6_addr, sizeof(xa->v6));
99 		xa->scope_id = in6->sin6_scope_id;
100 		break;
101 	default:
102 		return -1;
103 	}
104 
105 	return 0;
106 }
107 
108 /*
109  * Calculate a netmask of length 'l' for address family 'af' and
110  * store it in 'n'.
111  * Returns 0 on success, -1 on failure.
112  */
113 static int
114 addr_netmask(int af, u_int l, struct xaddr *n)
115 {
116 	int i;
117 
118 	if (masklen_valid(af, l) != 0 || n == NULL)
119 		return -1;
120 
121 	memset(n, '\0', sizeof(*n));
122 	switch (af) {
123 	case AF_INET:
124 		n->af = AF_INET;
125 		n->v4.s_addr = htonl((0xffffffff << (32 - l)) & 0xffffffff);
126 		return 0;
127 	case AF_INET6:
128 		n->af = AF_INET6;
129 		for (i = 0; i < 4 && l >= 32; i++, l -= 32)
130 			n->addr32[i] = 0xffffffffU;
131 		if (i < 4 && l != 0)
132 			n->addr32[i] = htonl((0xffffffff << (32 - l)) &
133 			    0xffffffff);
134 		return 0;
135 	default:
136 		return -1;
137 	}
138 }
139 
140 /*
141  * Perform logical AND of addresses 'a' and 'b', storing result in 'dst'.
142  * Returns 0 on success, -1 on failure.
143  */
144 static int
145 addr_and(struct xaddr *dst, const struct xaddr *a, const struct xaddr *b)
146 {
147 	int i;
148 
149 	if (dst == NULL || a == NULL || b == NULL || a->af != b->af)
150 		return -1;
151 
152 	memcpy(dst, a, sizeof(*dst));
153 	switch (a->af) {
154 	case AF_INET:
155 		dst->v4.s_addr &= b->v4.s_addr;
156 		return 0;
157 	case AF_INET6:
158 		dst->scope_id = a->scope_id;
159 		for (i = 0; i < 4; i++)
160 			dst->addr32[i] &= b->addr32[i];
161 		return 0;
162 	default:
163 		return -1;
164 	}
165 }
166 
167 /*
168  * Compare addresses 'a' and 'b'
169  * Return 0 if addresses are identical, -1 if (a < b) or 1 if (a > b)
170  */
171 static int
172 addr_cmp(const struct xaddr *a, const struct xaddr *b)
173 {
174 	int i;
175 
176 	if (a->af != b->af)
177 		return a->af == AF_INET6 ? 1 : -1;
178 
179 	switch (a->af) {
180 	case AF_INET:
181 		if (a->v4.s_addr == b->v4.s_addr)
182 			return 0;
183 		return ntohl(a->v4.s_addr) > ntohl(b->v4.s_addr) ? 1 : -1;
184 	case AF_INET6:
185 		for (i = 0; i < 16; i++)
186 			if (a->addr8[i] - b->addr8[i] != 0)
187 				return a->addr8[i] > b->addr8[i] ? 1 : -1;
188 		if (a->scope_id == b->scope_id)
189 			return 0;
190 		return a->scope_id > b->scope_id ? 1 : -1;
191 	default:
192 		return -1;
193 	}
194 }
195 
196 /*
197  * Parse string address 'p' into 'n'
198  * Returns 0 on success, -1 on failure.
199  */
200 static int
201 addr_pton(const char *p, struct xaddr *n)
202 {
203 	struct addrinfo hints, *ai;
204 
205 	memset(&hints, '\0', sizeof(hints));
206 	hints.ai_flags = AI_NUMERICHOST;
207 
208 	if (p == NULL || getaddrinfo(p, NULL, &hints, &ai) != 0)
209 		return -1;
210 
211 	if (ai == NULL || ai->ai_addr == NULL)
212 		return -1;
213 
214 	if (n != NULL &&
215 	    addr_sa_to_xaddr(ai->ai_addr, ai->ai_addrlen, n) == -1) {
216 		freeaddrinfo(ai);
217 		return -1;
218 	}
219 
220 	freeaddrinfo(ai);
221 	return 0;
222 }
223 
224 /*
225  * Perform bitwise negation of address
226  * Returns 0 on success, -1 on failure.
227  */
228 static int
229 addr_invert(struct xaddr *n)
230 {
231 	int i;
232 
233 	if (n == NULL)
234 		return (-1);
235 
236 	switch (n->af) {
237 	case AF_INET:
238 		n->v4.s_addr = ~n->v4.s_addr;
239 		return (0);
240 	case AF_INET6:
241 		for (i = 0; i < 4; i++)
242 			n->addr32[i] = ~n->addr32[i];
243 		return (0);
244 	default:
245 		return (-1);
246 	}
247 }
248 
249 /*
250  * Calculate a netmask of length 'l' for address family 'af' and
251  * store it in 'n'.
252  * Returns 0 on success, -1 on failure.
253  */
254 static int
255 addr_hostmask(int af, u_int l, struct xaddr *n)
256 {
257 	if (addr_netmask(af, l, n) == -1 || addr_invert(n) == -1)
258 		return (-1);
259 	return (0);
260 }
261 
262 /*
263  * Test whether address 'a' is all zeros (i.e. 0.0.0.0 or ::)
264  * Returns 0 on if address is all-zeros, -1 if not all zeros or on failure.
265  */
266 static int
267 addr_is_all0s(const struct xaddr *a)
268 {
269 	int i;
270 
271 	switch (a->af) {
272 	case AF_INET:
273 		return (a->v4.s_addr == 0 ? 0 : -1);
274 	case AF_INET6:;
275 		for (i = 0; i < 4; i++)
276 			if (a->addr32[i] != 0)
277 				return (-1);
278 		return (0);
279 	default:
280 		return (-1);
281 	}
282 }
283 
284 /*
285  * Test whether host portion of address 'a', as determined by 'masklen'
286  * is all zeros.
287  * Returns 0 on if host portion of address is all-zeros,
288  * -1 if not all zeros or on failure.
289  */
290 static int
291 addr_host_is_all0s(const struct xaddr *a, u_int masklen)
292 {
293 	struct xaddr tmp_addr, tmp_mask, tmp_result;
294 
295 	memcpy(&tmp_addr, a, sizeof(tmp_addr));
296 	if (addr_hostmask(a->af, masklen, &tmp_mask) == -1)
297 		return (-1);
298 	if (addr_and(&tmp_result, &tmp_addr, &tmp_mask) == -1)
299 		return (-1);
300 	return (addr_is_all0s(&tmp_result));
301 }
302 
303 /*
304  * Parse a CIDR address (x.x.x.x/y or xxxx:yyyy::/z).
305  * Return -1 on parse error, -2 on inconsistency or 0 on success.
306  */
307 static int
308 addr_pton_cidr(const char *p, struct xaddr *n, u_int *l)
309 {
310 	struct xaddr tmp;
311 	long unsigned int masklen = 999;
312 	char addrbuf[64], *mp, *cp;
313 
314 	/* Don't modify argument */
315 	if (p == NULL || strlcpy(addrbuf, p, sizeof(addrbuf)) > sizeof(addrbuf))
316 		return -1;
317 
318 	if ((mp = strchr(addrbuf, '/')) != NULL) {
319 		*mp = '\0';
320 		mp++;
321 		masklen = strtoul(mp, &cp, 10);
322 		if (*mp == '\0' || *cp != '\0' || masklen > 128)
323 			return -1;
324 	}
325 
326 	if (addr_pton(addrbuf, &tmp) == -1)
327 		return -1;
328 
329 	if (mp == NULL)
330 		masklen = addr_unicast_masklen(tmp.af);
331 	if (masklen_valid(tmp.af, masklen) == -1)
332 		return -2;
333 	if (addr_host_is_all0s(&tmp, masklen) != 0)
334 		return -2;
335 
336 	if (n != NULL)
337 		memcpy(n, &tmp, sizeof(*n));
338 	if (l != NULL)
339 		*l = masklen;
340 
341 	return 0;
342 }
343 
344 static int
345 addr_netmatch(const struct xaddr *host, const struct xaddr *net, u_int masklen)
346 {
347 	struct xaddr tmp_mask, tmp_result;
348 
349 	if (host->af != net->af)
350 		return -1;
351 
352 	if (addr_netmask(host->af, masklen, &tmp_mask) == -1)
353 		return -1;
354 	if (addr_and(&tmp_result, host, &tmp_mask) == -1)
355 		return -1;
356 	return addr_cmp(&tmp_result, net);
357 }
358 
359 /*
360  * Match "addr" against list pattern list "_list", which may contain a
361  * mix of CIDR addresses and old-school wildcards.
362  *
363  * If addr is NULL, then no matching is performed, but _list is parsed
364  * and checked for well-formedness.
365  *
366  * Returns 1 on match found (never returned when addr == NULL).
367  * Returns 0 on if no match found, or no errors found when addr == NULL.
368  * Returns -1 on negated match found (never returned when addr == NULL).
369  * Returns -2 on invalid list entry.
370  */
371 int
372 addr_match_list(const char *addr, const char *_list)
373 {
374 	char *list, *cp, *o;
375 	struct xaddr try_addr, match_addr;
376 	u_int masklen, neg;
377 	int ret = 0, r;
378 
379 	if (addr != NULL && addr_pton(addr, &try_addr) != 0) {
380 		debug2("%s: couldn't parse address %.100s", __func__, addr);
381 		return 0;
382 	}
383 	if ((o = list = strdup(_list)) == NULL)
384 		return -1;
385 	while ((cp = strsep(&list, ",")) != NULL) {
386 		neg = *cp == '!';
387 		if (neg)
388 			cp++;
389 		if (*cp == '\0') {
390 			ret = -2;
391 			break;
392 		}
393 		/* Prefer CIDR address matching */
394 		r = addr_pton_cidr(cp, &match_addr, &masklen);
395 		if (r == -2) {
396 			error("Inconsistent mask length for "
397 			    "network \"%.100s\"", cp);
398 			ret = -2;
399 			break;
400 		} else if (r == 0) {
401 			if (addr != NULL && addr_netmatch(&try_addr,
402                            &match_addr, masklen) == 0) {
403  foundit:
404 				if (neg) {
405 					ret = -1;
406 					break;
407 				}
408 				ret = 1;
409 			}
410 			continue;
411 		} else {
412 			/* If CIDR parse failed, try wildcard string match */
413 			if (addr != NULL && match_pattern(addr, cp) == 1)
414 				goto foundit;
415 		}
416 	}
417 	xfree(o);
418 
419 	return ret;
420 }
421