]> git.ipfire.org Git - thirdparty/squid.git/blob - src/acl/Ip.cc
protos.h refactoring, part one.
[thirdparty/squid.git] / src / acl / Ip.cc
1 /*
2 * $Id$
3 *
4 * DEBUG: section 28 Access Control
5 * AUTHOR: Duane Wessels
6 *
7 * SQUID Web Proxy Cache http://www.squid-cache.org/
8 * ----------------------------------------------------------
9 *
10 * Squid is the result of efforts by numerous individuals from
11 * the Internet community; see the CONTRIBUTORS file for full
12 * details. Many organizations have provided support for Squid's
13 * development; see the SPONSORS file for full details. Squid is
14 * Copyrighted (C) 2001 by the Regents of the University of
15 * California; see the COPYRIGHT file for full details. Squid
16 * incorporates software developed and/or copyrighted by other
17 * sources; see the CREDITS file for full details.
18 *
19 * This program is free software; you can redistribute it and/or modify
20 * it under the terms of the GNU General Public License as published by
21 * the Free Software Foundation; either version 2 of the License, or
22 * (at your option) any later version.
23 *
24 * This program is distributed in the hope that it will be useful,
25 * but WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 * GNU General Public License for more details.
28 *
29 * You should have received a copy of the GNU General Public License
30 * along with this program; if not, write to the Free Software
31 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
32 *
33 * Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
34 */
35
36 #include "squid.h"
37 #include "acl/Ip.h"
38 #include "acl/Checklist.h"
39 #include "cache_cf.h"
40 #include "Debug.h"
41 #include "ip/tools.h"
42 #include "MemBuf.h"
43 #include "protos.h"
44 #include "wordlist.h"
45
46 void *
47 ACLIP::operator new (size_t byteCount)
48 {
49 fatal ("ACLIP::operator new: unused");
50 return (void *)1;
51 }
52
53 void
54 ACLIP::operator delete (void *address)
55 {
56 fatal ("ACLIP::operator delete: unused");
57 }
58
59 /**
60 * Writes an IP ACL data into a buffer, then copies the buffer into the wordlist given
61 *
62 \param ip ACL data structure to display
63 \param state wordlist structure which is being generated
64 */
65 void
66 ACLIP::DumpIpListWalkee(acl_ip_data * const & ip, void *state)
67 {
68 char tmpbuf[ ((MAX_IPSTRLEN*2)+6) ]; // space for 2 IPs and a CIDR mask(3) and seperators(3).
69 MemBuf mb;
70 wordlist **W = static_cast<wordlist **>(state);
71 tmpbuf[0] = '\0';
72
73 mb.init();
74 assert(mb.max_capacity > 0 && 1==1 );
75
76 ip->toStr(tmpbuf, sizeof(tmpbuf) );
77 assert(mb.max_capacity > 0 && 2==2 );
78 mb.append(tmpbuf, strlen(tmpbuf) );
79 assert(mb.max_capacity > 0 && 3==3);
80 wordlistAdd(W, mb.buf);
81 mb.clean();
82 }
83
84 /**
85 * print/format an acl_ip_data structure for debugging output.
86 *
87 \param buf string buffer to write to
88 \param len size of the buffer available
89 */
90 void
91 acl_ip_data::toStr(char *buf, int len) const
92 {
93 char *b1 = buf;
94 char *b2 = NULL;
95 char *b3 = NULL;
96 int rlen = 0;
97
98 addr1.NtoA(b1, len - rlen );
99 rlen = strlen(buf);
100 b2 = buf + rlen;
101
102 if (!addr2.IsAnyAddr()) {
103 b2[0] = '-';
104 ++rlen;
105 addr2.NtoA(&(b2[1]), len - rlen );
106 rlen = strlen(buf);
107 } else
108 b2[0] = '\0';
109
110 b3 = buf + rlen;
111
112 if (!mask.IsNoAddr()) {
113 b3[0] = '/';
114 ++rlen;
115 int cidr = mask.GetCIDR() - (addr1.IsIPv4()?96:0);
116 snprintf(&(b3[1]), (len-rlen), "%u", (unsigned int)(cidr<0?0:cidr) );
117 } else
118 b3[0] = '\0';
119 }
120
121 /*
122 * aclIpAddrNetworkCompare - The guts of the comparison for IP ACLs
123 * matching checks. The first argument (p) is a "host" address,
124 * i.e. the IP address of a cache client. The second argument (q)
125 * is an entry in some address-based access control element. This
126 * function is called via ACLIP::match() and the splay library.
127 */
128 int
129 aclIpAddrNetworkCompare(acl_ip_data * const &p, acl_ip_data * const &q)
130 {
131 Ip::Address A = p->addr1;
132
133 /* apply netmask */
134 A.ApplyMask(q->mask);
135
136 debugs(28,9, "aclIpAddrNetworkCompare: compare: " << p->addr1 << "/" << q->mask << " (" << A << ") vs " <<
137 q->addr1 << "-" << q->addr2 << "/" << q->mask);
138
139 if (q->addr2.IsAnyAddr()) { /* single address check */
140
141 return A.matchIPAddr( q->addr1 );
142
143 } else { /* range address check */
144
145 if ( (A >= q->addr1) && (A <= q->addr2) )
146 return 0; /* valid. inside range. */
147 else
148 return A.matchIPAddr( q->addr1 ); /* outside of range, 'less than' */
149 }
150 }
151
152 /*
153 * acl_ip_data::NetworkCompare - Compare two acl_ip_data entries. Strictly
154 * used by the splay insertion routine. It emits a warning if it
155 * detects a "collision" or overlap that would confuse the splay
156 * sorting algorithm. Much like aclDomainCompare.
157 * The first argument (p) is a "host" address, i.e. the IP address of a cache client.
158 * The second argument (b) is a "network" address that might have a subnet and/or range.
159 * We mask the host address bits with the network subnet mask.
160 */
161 int
162 acl_ip_data::NetworkCompare(acl_ip_data * const & a, acl_ip_data * const &b)
163 {
164 int ret;
165 bool bina = true;
166 ret = aclIpAddrNetworkCompare(b, a);
167
168 if (ret != 0) {
169 bina = false;
170 ret = aclIpAddrNetworkCompare(a, b);
171 }
172
173 if (ret == 0) {
174 char buf_n1[3*(MAX_IPSTRLEN+1)];
175 char buf_n2[3*(MAX_IPSTRLEN+1)];
176 if (bina) {
177 b->toStr(buf_n1, 3*(MAX_IPSTRLEN+1));
178 a->toStr(buf_n2, 3*(MAX_IPSTRLEN+1));
179 } else {
180 a->toStr(buf_n1, 3*(MAX_IPSTRLEN+1));
181 b->toStr(buf_n2, 3*(MAX_IPSTRLEN+1));
182 }
183 debugs(28, DBG_CRITICAL, "WARNING: (" << (bina?'B':'A') << ") '" << buf_n1 << "' is a subnetwork of (" << (bina?'A':'B') << ") '" << buf_n2 << "'");
184 debugs(28, DBG_CRITICAL, "WARNING: because of this '" << (bina?buf_n2:buf_n1) << "' is ignored to keep splay tree searching predictable");
185 debugs(28, DBG_CRITICAL, "WARNING: You should probably remove '" << buf_n1 << "' from the ACL named '" << AclMatchedName << "'");
186 }
187
188 return ret;
189 }
190
191 /**
192 * Decode an ascii representation (asc) of a IP netmask address or CIDR,
193 * and place resulting information in mask.
194 * This function should NOT be called if 'asc' is a hostname!
195 */
196 bool
197 acl_ip_data::DecodeMask(const char *asc, Ip::Address &mask, int ctype)
198 {
199 char junk;
200 int a1 = 0;
201
202 /* default is a mask that doesn't change any IP */
203 mask.SetNoAddr();
204
205 if (!asc || !*asc) {
206 return true;
207 }
208
209 /* An int mask 128, 32 */
210 if ((sscanf(asc, "%d%c", &a1, &junk)==1) &&
211 (a1 <= 128) && (a1 >= 0)
212 ) {
213 return mask.ApplyMask(a1, ctype);
214 }
215
216 /* dotted notation */
217 /* assignment returns true if asc contained an IP address as text */
218 if ((mask = asc)) {
219 /* HACK: IPv4 netmasks don't cleanly map to IPv6 masks. */
220 debugs(28, DBG_CRITICAL, "WARNING: Netmasks are deprecated. Please use CIDR masks instead.");
221 if (mask.IsIPv4()) {
222 /* locate what CIDR mask was _probably_ meant to be in its native protocol format. */
223 /* this will completely crap out with a security fail-open if the admin is playing mask tricks */
224 /* however, thats their fault, and we do warn. see bug 2601 for the effects if we don't do this. */
225 unsigned int m = mask.GetCIDR();
226 debugs(28, DBG_CRITICAL, "WARNING: IPv4 netmasks are particularly nasty when used to compare IPv6 to IPv4 ranges.");
227 debugs(28, DBG_CRITICAL, "WARNING: For now we will assume you meant to write /" << m);
228 /* reset the mask completely, and crop to the CIDR boundary back properly. */
229 mask.SetNoAddr();
230 return mask.ApplyMask(m,AF_INET);
231 }
232 return true;
233 }
234
235 return false;
236 }
237
238 /* Handle either type of address, IPv6 will be discarded with a warning if disabled */
239 #define SCAN_ACL1_6 "%[0123456789ABCDEFabcdef:]-%[0123456789ABCDEFabcdef:]/%[0123456789]"
240 #define SCAN_ACL2_6 "%[0123456789ABCDEFabcdef:]-%[0123456789ABCDEFabcdef:]%c"
241 #define SCAN_ACL3_6 "%[0123456789ABCDEFabcdef:]/%[0123456789]"
242 #define SCAN_ACL4_6 "%[0123456789ABCDEFabcdef:]/%c"
243 /* We DO need to know which is which though, for proper CIDR masking. */
244 #define SCAN_ACL1_4 "%[0123456789.]-%[0123456789.]/%[0123456789.]"
245 #define SCAN_ACL2_4 "%[0123456789.]-%[0123456789.]%c"
246 #define SCAN_ACL3_4 "%[0123456789.]/%[0123456789.]"
247 #define SCAN_ACL4_4 "%[0123456789.]/%c"
248
249 acl_ip_data *
250 acl_ip_data::FactoryParse(const char *t)
251 {
252 LOCAL_ARRAY(char, addr1, 256);
253 LOCAL_ARRAY(char, addr2, 256);
254 LOCAL_ARRAY(char, mask, 256);
255 acl_ip_data *r = NULL;
256 acl_ip_data **Q = NULL;
257 Ip::Address temp;
258 char c;
259 unsigned int changed;
260 acl_ip_data *q = new acl_ip_data;
261 int iptype = AF_UNSPEC;
262
263 debugs(28, 5, "aclIpParseIpData: " << t);
264
265 /* Special ACL RHS "all" matches entire Internet */
266 if (strcasecmp(t, "all") == 0) {
267 debugs(28, 9, "aclIpParseIpData: magic 'all' found.");
268 q->addr1.SetAnyAddr();
269 q->addr2.SetEmpty();
270 q->mask.SetAnyAddr();
271 return q;
272 }
273
274 /* Detect some old broken strings equivalent to 'all'.
275 * treat them nicely. But be loud until its fixed. */
276 if (strcasecmp(t, "0/0") == 0 || strcasecmp(t, "0.0.0.0/0") == 0 || strcasecmp(t, "0.0.0.0/0.0.0.0") == 0 ||
277 strcasecmp(t, "0.0.0.0-255.255.255.255") == 0 || strcasecmp(t, "0.0.0.0-0.0.0.0/0") == 0) {
278
279 debugs(28,DBG_CRITICAL, "ERROR: '" << t << "' needs to be replaced by the term 'all'.");
280 debugs(28,DBG_CRITICAL, "SECURITY NOTICE: Overriding config setting. Using 'all' instead.");
281 q->addr1.SetAnyAddr();
282 q->addr2.SetEmpty();
283 q->mask.SetAnyAddr();
284 return q;
285 }
286
287 /* Special ACL RHS "ipv4" matches IPv4 Internet
288 * A nod to IANA; we include the entire class space in case
289 * they manage to find a way to recover and use it */
290 if (strcasecmp(t, "ipv4") == 0) {
291 q->mask.SetNoAddr();
292 q->mask.ApplyMask(0, AF_INET);
293 return q;
294 }
295
296 /* Special ACL RHS "ipv6" matches IPv6-Unicast Internet */
297 if (strcasecmp(t, "ipv6") == 0) {
298 debugs(28, 9, "aclIpParseIpData: magic 'ipv6' found.");
299 r = q; // save head of the list for result.
300
301 /* 0000::/4 is a mix of localhost and obsolete IPv4-mapping space. Not valid outside this host. */
302
303 /* Future global unicast space: 1000::/4 */
304 q->addr1 = "1000::";
305 q->mask.SetNoAddr();
306 q->mask.ApplyMask(4, AF_INET6);
307
308 /* Current global unicast space: 2000::/4 = (2000::/4 - 3000::/4) */
309 q->next = new acl_ip_data;
310 q = q->next;
311 q->addr1 = "2000::";
312 q->mask.SetNoAddr();
313 q->mask.ApplyMask(3, AF_INET6);
314
315 /* Future global unicast space: 4000::/2 = (4000::/4 - 7000::/4) */
316 q->next = new acl_ip_data;
317 q = q->next;
318 q->addr1 = "4000::";
319 q->mask.SetNoAddr();
320 q->mask.ApplyMask(2, AF_INET6);
321
322 /* Future global unicast space: 8000::/2 = (8000::/4 - B000::/4) */
323 q->next = new acl_ip_data;
324 q = q->next;
325 q->addr1 = "8000::";
326 q->mask.SetNoAddr();
327 q->mask.ApplyMask(2, AF_INET6);
328
329 /* Future global unicast space: C000::/3 = (C000::/4 - D000::/4) */
330 q->next = new acl_ip_data;
331 q = q->next;
332 q->addr1 = "C000::";
333 q->mask.SetNoAddr();
334 q->mask.ApplyMask(3, AF_INET6);
335
336 /* Future global unicast space: E000::/4 */
337 q->next = new acl_ip_data;
338 q = q->next;
339 q->addr1 = "E000::";
340 q->mask.SetNoAddr();
341 q->mask.ApplyMask(4, AF_INET6);
342
343 /* F000::/4 is mostly reserved non-unicast. With some exceptions ... */
344
345 /* RFC 4193 Unique-Local unicast space: FC00::/7 */
346 q->next = new acl_ip_data;
347 q = q->next;
348 q->addr1 = "FC00::";
349 q->mask.SetNoAddr();
350 q->mask.ApplyMask(7, AF_INET6);
351
352 /* Link-Local unicast space: FE80::/10 */
353 q->next = new acl_ip_data;
354 q = q->next;
355 q->addr1 = "FE80::";
356 q->mask.SetNoAddr();
357 q->mask.ApplyMask(10, AF_INET6);
358
359 return r;
360 }
361
362 // IPv4
363 if (sscanf(t, SCAN_ACL1_4, addr1, addr2, mask) == 3) {
364 debugs(28, 9, "aclIpParseIpData: '" << t << "' matched: SCAN1-v4: " << SCAN_ACL1_4);
365 iptype=AF_INET;
366 } else if (sscanf(t, SCAN_ACL2_4, addr1, addr2, &c) >= 2) {
367 debugs(28, 9, "aclIpParseIpData: '" << t << "' matched: SCAN2-v4: " << SCAN_ACL2_4);
368 mask[0] = '\0';
369 iptype=AF_INET;
370 } else if (sscanf(t, SCAN_ACL3_4, addr1, mask) == 2) {
371 debugs(28, 9, "aclIpParseIpData: '" << t << "' matched: SCAN3-v4: " << SCAN_ACL3_4);
372 addr2[0] = '\0';
373 iptype=AF_INET;
374 } else if (sscanf(t, SCAN_ACL4_4, addr1,&c) == 2) {
375 debugs(28, 9, "aclIpParseIpData: '" << t << "' matched: SCAN4-v4: " << SCAN_ACL4_4);
376 addr2[0] = '\0';
377 mask[0] = '\0';
378 iptype=AF_INET;
379
380 // IPv6
381 } else if (sscanf(t, SCAN_ACL1_6, addr1, addr2, mask) == 3) {
382 debugs(28, 9, "aclIpParseIpData: '" << t << "' matched: SCAN1-v6: " << SCAN_ACL1_6);
383 iptype=AF_INET6;
384 } else if (sscanf(t, SCAN_ACL2_6, addr1, addr2, &c) >= 2) {
385 debugs(28, 9, "aclIpParseIpData: '" << t << "' matched: SCAN2-v6: " << SCAN_ACL2_6);
386 mask[0] = '\0';
387 iptype=AF_INET6;
388 } else if (sscanf(t, SCAN_ACL3_6, addr1, mask) == 2) {
389 debugs(28, 9, "aclIpParseIpData: '" << t << "' matched: SCAN3-v6: " << SCAN_ACL3_6);
390 addr2[0] = '\0';
391 iptype=AF_INET6;
392 } else if (sscanf(t, SCAN_ACL4_6, addr1, mask) == 2) {
393 debugs(28, 9, "aclIpParseIpData: '" << t << "' matched: SCAN4-v6: " << SCAN_ACL4_6);
394 addr2[0] = '\0';
395 iptype=AF_INET6;
396
397 // Neither
398 } else if (sscanf(t, "%[^/]/%s", addr1, mask) == 2) {
399 debugs(28, 9, "aclIpParseIpData: '" << t << "' matched: non-IP pattern: %[^/]/%s");
400 addr2[0] = '\0';
401 } else if (sscanf(t, "%s", addr1) == 1) {
402 /*
403 * Note, must use plain getaddrinfo() here because at startup
404 * ipcache hasn't been initialized
405 * TODO: offload this to one of the Ip::Address lookups.
406 */
407
408 debugs(28, 5, "aclIpParseIpData: Lookup Host/IP " << addr1);
409 struct addrinfo *hp = NULL, *x = NULL;
410 struct addrinfo hints;
411 Ip::Address *prev_addr = NULL;
412
413 memset(&hints, 0, sizeof(struct addrinfo));
414
415 if ( iptype != AF_UNSPEC ) {
416 hints.ai_flags |= AI_NUMERICHOST;
417 }
418
419 #if 0
420 if (Ip::EnableIpv6&IPV6_SPECIAL_V4MAPPING)
421 hints.ai_flags |= AI_V4MAPPED | AI_ALL;
422 #endif
423
424 int errcode = getaddrinfo(addr1,NULL,&hints,&hp);
425 if (hp == NULL) {
426 debugs(28, DBG_CRITICAL, "aclIpParseIpData: Bad host/IP: '" << addr1 <<
427 "' in '" << t << "', flags=" << hints.ai_flags <<
428 " : (" << errcode << ") " << gai_strerror(errcode) );
429 self_destruct();
430 return NULL;
431 }
432
433 Q = &q;
434
435 for (x = hp; x != NULL;) {
436 if ((r = *Q) == NULL)
437 r = *Q = new acl_ip_data;
438
439 /* getaddrinfo given a host has a nasty tendency to return duplicate addr's */
440 /* BUT sorted fortunately, so we can drop most of them easily */
441 r->addr1 = *x;
442 x = x->ai_next;
443 if ( prev_addr && r->addr1 == *prev_addr) {
444 debugs(28, 3, "aclIpParseIpData: Duplicate host/IP: '" << r->addr1 << "' dropped.");
445 delete r;
446 *Q = NULL;
447 continue;
448 } else
449 prev_addr = &r->addr1;
450
451 debugs(28, 3, "aclIpParseIpData: Located host/IP: '" << r->addr1 << "'");
452
453 r->addr2.SetAnyAddr();
454 r->mask.SetNoAddr();
455
456 Q = &r->next;
457
458 debugs(28, 3, "" << addr1 << " --> " << r->addr1 );
459 }
460
461 if (*Q != NULL) {
462 debugs(28, DBG_CRITICAL, "aclIpParseIpData: Bad host/IP: '" << t << "'");
463 self_destruct();
464 return NULL;
465 }
466
467 freeaddrinfo(hp);
468
469 return q;
470 }
471
472 /* ignore IPv6 addresses when built with IPv4-only */
473 if ( iptype == AF_INET6 && !Ip::EnableIpv6) {
474 debugs(28, DBG_IMPORTANT, "aclIpParseIpData: IPv6 has not been enabled.");
475 return NULL;
476 }
477
478 /* Decode addr1 */
479 if (!*addr1 || !(q->addr1 = addr1)) {
480 debugs(28, DBG_CRITICAL, "aclIpParseIpData: unknown first address in '" << t << "'");
481 delete q;
482 self_destruct();
483 return NULL;
484 }
485
486 /* Decode addr2 */
487 if (!*addr2)
488 q->addr2.SetAnyAddr();
489 else if (!(q->addr2=addr2) ) {
490 debugs(28, DBG_CRITICAL, "aclIpParseIpData: unknown second address in '" << t << "'");
491 delete q;
492 self_destruct();
493 return NULL;
494 }
495
496 /* Decode mask (NULL or empty means a exact host mask) */
497 if (!DecodeMask(mask, q->mask, iptype)) {
498 debugs(28, DBG_CRITICAL, "aclParseIpData: unknown netmask '" << mask << "' in '" << t << "'");
499 delete q;
500 self_destruct();
501 return NULL;
502 }
503
504 changed = 0;
505 changed += q->addr1.ApplyMask(q->mask);
506 changed += q->addr2.ApplyMask(q->mask);
507
508 if (changed)
509 debugs(28, DBG_CRITICAL, "aclIpParseIpData: WARNING: Netmask masks away part of the specified IP in '" << t << "'");
510
511 debugs(28,9, HERE << "Parsed: " << q->addr1 << "-" << q->addr2 << "/" << q->mask << "(/" << q->mask.GetCIDR() <<")");
512
513 /* 1.2.3.4/255.255.255.0 --> 1.2.3.0 */
514 /* Same as IPv6 (not so trivial to depict) */
515 return q;
516 }
517
518 void
519 ACLIP::parse()
520 {
521 char *t = NULL;
522
523 while ((t = strtokFile())) {
524 acl_ip_data *q = acl_ip_data::FactoryParse(t);
525
526 while (q != NULL) {
527 /* pop each result off the list and add it to the data tree individually */
528 acl_ip_data *next_node = q->next;
529 q->next = NULL;
530 data = data->insert(q, acl_ip_data::NetworkCompare);
531 q = next_node;
532 }
533 }
534 }
535
536 ACLIP::~ACLIP()
537 {
538 if (data)
539 data->destroy(IPSplay::DefaultFree);
540 }
541
542 wordlist *
543 ACLIP::dump() const
544 {
545 wordlist *w = NULL;
546 data->walk (DumpIpListWalkee, &w);
547 return w;
548 }
549
550 bool
551 ACLIP::empty () const
552 {
553 return data->empty();
554 }
555
556 int
557 ACLIP::match(Ip::Address &clientip)
558 {
559 static acl_ip_data ClientAddress;
560 /*
561 * aclIpAddrNetworkCompare() takes two acl_ip_data pointers as
562 * arguments, so we must create a fake one for the client's IP
563 * address. Since we are scanning for a single IP mask and addr2
564 * MUST be set to empty.
565 */
566 ClientAddress.addr1 = clientip;
567 ClientAddress.addr2.SetEmpty();
568 ClientAddress.mask.SetEmpty();
569
570 data = data->splay(&ClientAddress, aclIpAddrNetworkCompare);
571 debugs(28, 3, "aclIpMatchIp: '" << clientip << "' " << (splayLastResult ? "NOT found" : "found"));
572 return !splayLastResult;
573 }
574
575 acl_ip_data::acl_ip_data () :addr1(), addr2(), mask(), next (NULL) {}
576
577 acl_ip_data::acl_ip_data (Ip::Address const &anAddress1, Ip::Address const &anAddress2, Ip::Address const &aMask, acl_ip_data *aNext) : addr1(anAddress1), addr2(anAddress2), mask(aMask), next(aNext) {}