4 * DEBUG: section 28 Access Control
5 * AUTHOR: Duane Wessels
7 * SQUID Web Proxy Cache http://www.squid-cache.org/
8 * ----------------------------------------------------------
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.
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.
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.
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.
33 * Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
38 #include "acl/Checklist.h"
46 ACLIP::operator new (size_t byteCount
)
48 fatal ("ACLIP::operator new: unused");
53 ACLIP::operator delete (void *address
)
55 fatal ("ACLIP::operator delete: unused");
59 * Writes an IP ACL data into a buffer, then copies the buffer into the wordlist given
61 \param ip ACL data structure to display
62 \param state wordlist structure which is being generated
65 ACLIP::DumpIpListWalkee(acl_ip_data
* const & ip
, void *state
)
67 char tmpbuf
[ ((MAX_IPSTRLEN
*2)+6) ]; // space for 2 IPs and a CIDR mask(3) and seperators(3).
69 wordlist
**W
= static_cast<wordlist
**>(state
);
73 assert(mb
.max_capacity
> 0 && 1==1 );
75 ip
->toStr(tmpbuf
, sizeof(tmpbuf
) );
76 assert(mb
.max_capacity
> 0 && 2==2 );
77 mb
.append(tmpbuf
, strlen(tmpbuf
) );
78 assert(mb
.max_capacity
> 0 && 3==3);
79 wordlistAdd(W
, mb
.buf
);
84 * print/format an acl_ip_data structure for debugging output.
86 \param buf string buffer to write to
87 \param len size of the buffer available
90 acl_ip_data::toStr(char *buf
, int len
) const
97 addr1
.NtoA(b1
, len
- rlen
);
101 if (!addr2
.IsAnyAddr()) {
104 addr2
.NtoA(&(b2
[1]), len
- rlen
);
111 if (!mask
.IsNoAddr()) {
114 int cidr
= mask
.GetCIDR() - (addr1
.IsIPv4()?96:0);
115 snprintf(&(b3
[1]), (len
-rlen
), "%u", (unsigned int)(cidr
<0?0:cidr
) );
121 * aclIpAddrNetworkCompare - The guts of the comparison for IP ACLs
122 * matching checks. The first argument (p) is a "host" address,
123 * i.e. the IP address of a cache client. The second argument (q)
124 * is an entry in some address-based access control element. This
125 * function is called via ACLIP::match() and the splay library.
128 aclIpAddrNetworkCompare(acl_ip_data
* const &p
, acl_ip_data
* const &q
)
130 Ip::Address A
= p
->addr1
;
133 A
.ApplyMask(q
->mask
);
135 debugs(28,9, "aclIpAddrNetworkCompare: compare: " << p
->addr1
<< "/" << q
->mask
<< " (" << A
<< ") vs " <<
136 q
->addr1
<< "-" << q
->addr2
<< "/" << q
->mask
);
138 if (q
->addr2
.IsAnyAddr()) { /* single address check */
140 return A
.matchIPAddr( q
->addr1
);
142 } else { /* range address check */
144 if ( (A
>= q
->addr1
) && (A
<= q
->addr2
) )
145 return 0; /* valid. inside range. */
147 return A
.matchIPAddr( q
->addr1
); /* outside of range, 'less than' */
152 * acl_ip_data::NetworkCompare - Compare two acl_ip_data entries. Strictly
153 * used by the splay insertion routine. It emits a warning if it
154 * detects a "collision" or overlap that would confuse the splay
155 * sorting algorithm. Much like aclDomainCompare.
156 * The first argument (p) is a "host" address, i.e. the IP address of a cache client.
157 * The second argument (b) is a "network" address that might have a subnet and/or range.
158 * We mask the host address bits with the network subnet mask.
161 acl_ip_data::NetworkCompare(acl_ip_data
* const & a
, acl_ip_data
* const &b
)
165 ret
= aclIpAddrNetworkCompare(b
, a
);
169 ret
= aclIpAddrNetworkCompare(a
, b
);
173 char buf_n1
[3*(MAX_IPSTRLEN
+1)];
174 char buf_n2
[3*(MAX_IPSTRLEN
+1)];
176 b
->toStr(buf_n1
, 3*(MAX_IPSTRLEN
+1));
177 a
->toStr(buf_n2
, 3*(MAX_IPSTRLEN
+1));
179 a
->toStr(buf_n1
, 3*(MAX_IPSTRLEN
+1));
180 b
->toStr(buf_n2
, 3*(MAX_IPSTRLEN
+1));
182 debugs(28, DBG_CRITICAL
, "WARNING: (" << (bina
?'B':'A') << ") '" << buf_n1
<< "' is a subnetwork of (" << (bina
?'A':'B') << ") '" << buf_n2
<< "'");
183 debugs(28, DBG_CRITICAL
, "WARNING: because of this '" << (bina
?buf_n2
:buf_n1
) << "' is ignored to keep splay tree searching predictable");
184 debugs(28, DBG_CRITICAL
, "WARNING: You should probably remove '" << buf_n1
<< "' from the ACL named '" << AclMatchedName
<< "'");
191 * Decode an ascii representation (asc) of a IP netmask address or CIDR,
192 * and place resulting information in mask.
193 * This function should NOT be called if 'asc' is a hostname!
196 acl_ip_data::DecodeMask(const char *asc
, Ip::Address
&mask
, int ctype
)
201 /* default is a mask that doesn't change any IP */
208 /* An int mask 128, 32 */
209 if ((sscanf(asc
, "%d%c", &a1
, &junk
)==1) &&
210 (a1
<= 128) && (a1
>= 0)
212 return mask
.ApplyMask(a1
, ctype
);
215 /* dotted notation */
216 /* assignment returns true if asc contained an IP address as text */
218 /* HACK: IPv4 netmasks don't cleanly map to IPv6 masks. */
219 debugs(28, DBG_CRITICAL
, "WARNING: Netmasks are deprecated. Please use CIDR masks instead.");
221 /* locate what CIDR mask was _probably_ meant to be in its native protocol format. */
222 /* this will completely crap out with a security fail-open if the admin is playing mask tricks */
223 /* however, thats their fault, and we do warn. see bug 2601 for the effects if we don't do this. */
224 unsigned int m
= mask
.GetCIDR();
225 debugs(28, DBG_CRITICAL
, "WARNING: IPv4 netmasks are particularly nasty when used to compare IPv6 to IPv4 ranges.");
226 debugs(28, DBG_CRITICAL
, "WARNING: For now we will assume you meant to write /" << m
);
227 /* reset the mask completely, and crop to the CIDR boundary back properly. */
229 return mask
.ApplyMask(m
,AF_INET
);
237 /* Handle either type of address, IPv6 will be discarded with a warning if disabled */
238 #define SCAN_ACL1_6 "%[0123456789ABCDEFabcdef:]-%[0123456789ABCDEFabcdef:]/%[0123456789]"
239 #define SCAN_ACL2_6 "%[0123456789ABCDEFabcdef:]-%[0123456789ABCDEFabcdef:]%c"
240 #define SCAN_ACL3_6 "%[0123456789ABCDEFabcdef:]/%[0123456789]"
241 #define SCAN_ACL4_6 "%[0123456789ABCDEFabcdef:]/%c"
242 /* We DO need to know which is which though, for proper CIDR masking. */
243 #define SCAN_ACL1_4 "%[0123456789.]-%[0123456789.]/%[0123456789.]"
244 #define SCAN_ACL2_4 "%[0123456789.]-%[0123456789.]%c"
245 #define SCAN_ACL3_4 "%[0123456789.]/%[0123456789.]"
246 #define SCAN_ACL4_4 "%[0123456789.]/%c"
249 acl_ip_data::FactoryParse(const char *t
)
251 LOCAL_ARRAY(char, addr1
, 256);
252 LOCAL_ARRAY(char, addr2
, 256);
253 LOCAL_ARRAY(char, mask
, 256);
254 acl_ip_data
*r
= NULL
;
255 acl_ip_data
**Q
= NULL
;
258 unsigned int changed
;
259 acl_ip_data
*q
= new acl_ip_data
;
260 int iptype
= AF_UNSPEC
;
262 debugs(28, 5, "aclIpParseIpData: " << t
);
264 /* Special ACL RHS "all" matches entire Internet */
265 if (strcasecmp(t
, "all") == 0) {
266 debugs(28, 9, "aclIpParseIpData: magic 'all' found.");
267 q
->addr1
.SetAnyAddr();
269 q
->mask
.SetAnyAddr();
273 /* Detect some old broken strings equivalent to 'all'.
274 * treat them nicely. But be loud until its fixed. */
275 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 ||
276 strcasecmp(t
, "0.0.0.0-255.255.255.255") == 0 || strcasecmp(t
, "0.0.0.0-0.0.0.0/0") == 0) {
278 debugs(28,DBG_CRITICAL
, "ERROR: '" << t
<< "' needs to be replaced by the term 'all'.");
279 debugs(28,DBG_CRITICAL
, "SECURITY NOTICE: Overriding config setting. Using 'all' instead.");
280 q
->addr1
.SetAnyAddr();
282 q
->mask
.SetAnyAddr();
286 /* Special ACL RHS "ipv4" matches IPv4 Internet
287 * A nod to IANA; we include the entire class space in case
288 * they manage to find a way to recover and use it */
289 if (strcasecmp(t
, "ipv4") == 0) {
291 q
->mask
.ApplyMask(0, AF_INET
);
295 /* Special ACL RHS "ipv6" matches IPv6-Unicast Internet */
296 if (strcasecmp(t
, "ipv6") == 0) {
297 debugs(28, 9, "aclIpParseIpData: magic 'ipv6' found.");
298 r
= q
; // save head of the list for result.
300 /* 0000::/4 is a mix of localhost and obsolete IPv4-mapping space. Not valid outside this host. */
302 /* Future global unicast space: 1000::/4 */
305 q
->mask
.ApplyMask(4, AF_INET6
);
307 /* Current global unicast space: 2000::/4 = (2000::/4 - 3000::/4) */
308 q
->next
= new acl_ip_data
;
312 q
->mask
.ApplyMask(3, AF_INET6
);
314 /* Future global unicast space: 4000::/2 = (4000::/4 - 7000::/4) */
315 q
->next
= new acl_ip_data
;
319 q
->mask
.ApplyMask(2, AF_INET6
);
321 /* Future global unicast space: 8000::/2 = (8000::/4 - B000::/4) */
322 q
->next
= new acl_ip_data
;
326 q
->mask
.ApplyMask(2, AF_INET6
);
328 /* Future global unicast space: C000::/3 = (C000::/4 - D000::/4) */
329 q
->next
= new acl_ip_data
;
333 q
->mask
.ApplyMask(3, AF_INET6
);
335 /* Future global unicast space: E000::/4 */
336 q
->next
= new acl_ip_data
;
340 q
->mask
.ApplyMask(4, AF_INET6
);
342 /* F000::/4 is mostly reserved non-unicast. With some exceptions ... */
344 /* RFC 4193 Unique-Local unicast space: FC00::/7 */
345 q
->next
= new acl_ip_data
;
349 q
->mask
.ApplyMask(7, AF_INET6
);
351 /* Link-Local unicast space: FE80::/10 */
352 q
->next
= new acl_ip_data
;
356 q
->mask
.ApplyMask(10, AF_INET6
);
362 if (sscanf(t
, SCAN_ACL1_4
, addr1
, addr2
, mask
) == 3) {
363 debugs(28, 9, "aclIpParseIpData: '" << t
<< "' matched: SCAN1-v4: " << SCAN_ACL1_4
);
365 } else if (sscanf(t
, SCAN_ACL2_4
, addr1
, addr2
, &c
) >= 2) {
366 debugs(28, 9, "aclIpParseIpData: '" << t
<< "' matched: SCAN2-v4: " << SCAN_ACL2_4
);
369 } else if (sscanf(t
, SCAN_ACL3_4
, addr1
, mask
) == 2) {
370 debugs(28, 9, "aclIpParseIpData: '" << t
<< "' matched: SCAN3-v4: " << SCAN_ACL3_4
);
373 } else if (sscanf(t
, SCAN_ACL4_4
, addr1
,&c
) == 2) {
374 debugs(28, 9, "aclIpParseIpData: '" << t
<< "' matched: SCAN4-v4: " << SCAN_ACL4_4
);
380 } else if (sscanf(t
, SCAN_ACL1_6
, addr1
, addr2
, mask
) == 3) {
381 debugs(28, 9, "aclIpParseIpData: '" << t
<< "' matched: SCAN1-v6: " << SCAN_ACL1_6
);
383 } else if (sscanf(t
, SCAN_ACL2_6
, addr1
, addr2
, &c
) >= 2) {
384 debugs(28, 9, "aclIpParseIpData: '" << t
<< "' matched: SCAN2-v6: " << SCAN_ACL2_6
);
387 } else if (sscanf(t
, SCAN_ACL3_6
, addr1
, mask
) == 2) {
388 debugs(28, 9, "aclIpParseIpData: '" << t
<< "' matched: SCAN3-v6: " << SCAN_ACL3_6
);
391 } else if (sscanf(t
, SCAN_ACL4_6
, addr1
, mask
) == 2) {
392 debugs(28, 9, "aclIpParseIpData: '" << t
<< "' matched: SCAN4-v6: " << SCAN_ACL4_6
);
397 } else if (sscanf(t
, "%[^/]/%s", addr1
, mask
) == 2) {
398 debugs(28, 9, "aclIpParseIpData: '" << t
<< "' matched: non-IP pattern: %[^/]/%s");
400 } else if (sscanf(t
, "%s", addr1
) == 1) {
402 * Note, must use plain getaddrinfo() here because at startup
403 * ipcache hasn't been initialized
404 * TODO: offload this to one of the Ip::Address lookups.
407 debugs(28, 5, "aclIpParseIpData: Lookup Host/IP " << addr1
);
408 struct addrinfo
*hp
= NULL
, *x
= NULL
;
409 struct addrinfo hints
;
410 Ip::Address
*prev_addr
= NULL
;
412 memset(&hints
, 0, sizeof(struct addrinfo
));
414 if ( iptype
!= AF_UNSPEC
) {
415 hints
.ai_flags
|= AI_NUMERICHOST
;
419 if (Ip::EnableIpv6
&IPV6_SPECIAL_V4MAPPING
)
420 hints
.ai_flags
|= AI_V4MAPPED
| AI_ALL
;
423 int errcode
= getaddrinfo(addr1
,NULL
,&hints
,&hp
);
425 debugs(28, DBG_CRITICAL
, "aclIpParseIpData: Bad host/IP: '" << addr1
<<
426 "' in '" << t
<< "', flags=" << hints
.ai_flags
<<
427 " : (" << errcode
<< ") " << gai_strerror(errcode
) );
434 for (x
= hp
; x
!= NULL
;) {
435 if ((r
= *Q
) == NULL
)
436 r
= *Q
= new acl_ip_data
;
438 /* getaddrinfo given a host has a nasty tendency to return duplicate addr's */
439 /* BUT sorted fortunately, so we can drop most of them easily */
442 if ( prev_addr
&& r
->addr1
== *prev_addr
) {
443 debugs(28, 3, "aclIpParseIpData: Duplicate host/IP: '" << r
->addr1
<< "' dropped.");
448 prev_addr
= &r
->addr1
;
450 debugs(28, 3, "aclIpParseIpData: Located host/IP: '" << r
->addr1
<< "'");
452 r
->addr2
.SetAnyAddr();
457 debugs(28, 3, "" << addr1
<< " --> " << r
->addr1
);
461 debugs(28, DBG_CRITICAL
, "aclIpParseIpData: Bad host/IP: '" << t
<< "'");
471 /* ignore IPv6 addresses when built with IPv4-only */
472 if ( iptype
== AF_INET6
&& !Ip::EnableIpv6
) {
473 debugs(28, DBG_IMPORTANT
, "aclIpParseIpData: IPv6 has not been enabled.");
478 if (!*addr1
|| !(q
->addr1
= addr1
)) {
479 debugs(28, DBG_CRITICAL
, "aclIpParseIpData: unknown first address in '" << t
<< "'");
487 q
->addr2
.SetAnyAddr();
488 else if (!(q
->addr2
=addr2
) ) {
489 debugs(28, DBG_CRITICAL
, "aclIpParseIpData: unknown second address in '" << t
<< "'");
495 /* Decode mask (NULL or empty means a exact host mask) */
496 if (!DecodeMask(mask
, q
->mask
, iptype
)) {
497 debugs(28, DBG_CRITICAL
, "aclParseIpData: unknown netmask '" << mask
<< "' in '" << t
<< "'");
504 changed
+= q
->addr1
.ApplyMask(q
->mask
);
505 changed
+= q
->addr2
.ApplyMask(q
->mask
);
508 debugs(28, DBG_CRITICAL
, "aclIpParseIpData: WARNING: Netmask masks away part of the specified IP in '" << t
<< "'");
510 debugs(28,9, HERE
<< "Parsed: " << q
->addr1
<< "-" << q
->addr2
<< "/" << q
->mask
<< "(/" << q
->mask
.GetCIDR() <<")");
512 /* 1.2.3.4/255.255.255.0 --> 1.2.3.0 */
513 /* Same as IPv6 (not so trivial to depict) */
522 while ((t
= strtokFile())) {
523 acl_ip_data
*q
= acl_ip_data::FactoryParse(t
);
526 /* pop each result off the list and add it to the data tree individually */
527 acl_ip_data
*next_node
= q
->next
;
529 data
= data
->insert(q
, acl_ip_data::NetworkCompare
);
538 data
->destroy(IPSplay::DefaultFree
);
545 data
->walk (DumpIpListWalkee
, &w
);
550 ACLIP::empty () const
552 return data
->empty();
556 ACLIP::match(Ip::Address
&clientip
)
558 static acl_ip_data ClientAddress
;
560 * aclIpAddrNetworkCompare() takes two acl_ip_data pointers as
561 * arguments, so we must create a fake one for the client's IP
562 * address. Since we are scanning for a single IP mask and addr2
563 * MUST be set to empty.
565 ClientAddress
.addr1
= clientip
;
566 ClientAddress
.addr2
.SetEmpty();
567 ClientAddress
.mask
.SetEmpty();
569 data
= data
->splay(&ClientAddress
, aclIpAddrNetworkCompare
);
570 debugs(28, 3, "aclIpMatchIp: '" << clientip
<< "' " << (splayLastResult
? "NOT found" : "found"));
571 return !splayLastResult
;
574 acl_ip_data::acl_ip_data () :addr1(), addr2(), mask(), next (NULL
) {}
576 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
) {}