2 * Copyright (C) 1996-2015 The Squid Software Foundation and contributors
4 * Squid software is distributed under GPLv2+ license and includes
5 * contributions from numerous individuals and organizations.
6 * Please see the COPYING and CONTRIBUTORS files for details.
9 /* DEBUG: section 28 Access Control */
12 #include "acl/Checklist.h"
21 ACLIP::operator new (size_t)
23 fatal ("ACLIP::operator new: unused");
28 ACLIP::operator delete (void *)
30 fatal ("ACLIP::operator delete: unused");
34 * print/format an acl_ip_data structure for debugging output.
36 \param buf string buffer to write to
37 \param len size of the buffer available
40 acl_ip_data::toStr(char *buf
, int len
) const
47 addr1
.toStr(b1
, len
- rlen
);
51 if (!addr2
.isAnyAddr()) {
54 addr2
.toStr(&(b2
[1]), len
- rlen
);
61 if (!mask
.isNoAddr()) {
64 int cidr
= mask
.cidr() - (addr1
.isIPv4()?96:0);
65 snprintf(&(b3
[1]), (len
-rlen
), "%u", (unsigned int)(cidr
<0?0:cidr
) );
71 acl_ip_data::toSBuf() const
73 const int bufsz
= MAX_IPSTRLEN
*2+6;
74 static char tmpbuf
[ bufsz
];
80 * aclIpAddrNetworkCompare - The guts of the comparison for IP ACLs
81 * matching checks. The first argument (p) is a "host" address,
82 * i.e. the IP address of a cache client. The second argument (q)
83 * is an entry in some address-based access control element. This
84 * function is called via ACLIP::match() and the splay library.
87 aclIpAddrNetworkCompare(acl_ip_data
* const &p
, acl_ip_data
* const &q
)
89 Ip::Address A
= p
->addr1
;
94 debugs(28,9, "aclIpAddrNetworkCompare: compare: " << p
->addr1
<< "/" << q
->mask
<< " (" << A
<< ") vs " <<
95 q
->addr1
<< "-" << q
->addr2
<< "/" << q
->mask
);
97 if (q
->addr2
.isAnyAddr()) { /* single address check */
99 return A
.matchIPAddr( q
->addr1
);
101 } else { /* range address check */
103 if ( (A
>= q
->addr1
) && (A
<= q
->addr2
) )
104 return 0; /* valid. inside range. */
106 return A
.matchIPAddr( q
->addr1
); /* outside of range, 'less than' */
111 * acl_ip_data::NetworkCompare - Compare two acl_ip_data entries. Strictly
112 * used by the splay insertion routine. It emits a warning if it
113 * detects a "collision" or overlap that would confuse the splay
114 * sorting algorithm. Much like aclDomainCompare.
115 * The first argument (p) is a "host" address, i.e. the IP address of a cache client.
116 * The second argument (b) is a "network" address that might have a subnet and/or range.
117 * We mask the host address bits with the network subnet mask.
120 acl_ip_data::NetworkCompare(acl_ip_data
* const & a
, acl_ip_data
* const &b
)
124 ret
= aclIpAddrNetworkCompare(b
, a
);
128 ret
= aclIpAddrNetworkCompare(a
, b
);
132 char buf_n1
[3*(MAX_IPSTRLEN
+1)];
133 char buf_n2
[3*(MAX_IPSTRLEN
+1)];
135 b
->toStr(buf_n1
, 3*(MAX_IPSTRLEN
+1));
136 a
->toStr(buf_n2
, 3*(MAX_IPSTRLEN
+1));
138 a
->toStr(buf_n1
, 3*(MAX_IPSTRLEN
+1));
139 b
->toStr(buf_n2
, 3*(MAX_IPSTRLEN
+1));
141 debugs(28, DBG_CRITICAL
, "WARNING: (" << (bina
?'B':'A') << ") '" << buf_n1
<< "' is a subnetwork of (" << (bina
?'A':'B') << ") '" << buf_n2
<< "'");
142 debugs(28, DBG_CRITICAL
, "WARNING: because of this '" << (bina
?buf_n2
:buf_n1
) << "' is ignored to keep splay tree searching predictable");
143 debugs(28, DBG_CRITICAL
, "WARNING: You should probably remove '" << buf_n1
<< "' from the ACL named '" << AclMatchedName
<< "'");
150 * Decode an ascii representation (asc) of a IP netmask address or CIDR,
151 * and place resulting information in mask.
152 * This function should NOT be called if 'asc' is a hostname!
155 acl_ip_data::DecodeMask(const char *asc
, Ip::Address
&mask
, int ctype
)
160 /* default is a mask that doesn't change any IP */
167 /* An int mask 128, 32 */
168 if ((sscanf(asc
, "%d%c", &a1
, &junk
)==1) &&
169 (a1
<= 128) && (a1
>= 0)
171 return mask
.applyMask(a1
, ctype
);
174 /* dotted notation */
175 /* assignment returns true if asc contained an IP address as text */
177 /* HACK: IPv4 netmasks don't cleanly map to IPv6 masks. */
178 debugs(28, DBG_CRITICAL
, "WARNING: Netmasks are deprecated. Please use CIDR masks instead.");
180 /* locate what CIDR mask was _probably_ meant to be in its native protocol format. */
181 /* this will completely crap out with a security fail-open if the admin is playing mask tricks */
182 /* however, thats their fault, and we do warn. see bug 2601 for the effects if we don't do this. */
183 unsigned int m
= mask
.cidr();
184 debugs(28, DBG_CRITICAL
, "WARNING: IPv4 netmasks are particularly nasty when used to compare IPv6 to IPv4 ranges.");
185 debugs(28, DBG_CRITICAL
, "WARNING: For now we will assume you meant to write /" << m
);
186 /* reset the mask completely, and crop to the CIDR boundary back properly. */
188 return mask
.applyMask(m
,AF_INET
);
196 /* Handle either type of address, IPv6 will be discarded with a warning if disabled */
197 #define SCAN_ACL1_6 "%[0123456789ABCDEFabcdef:]-%[0123456789ABCDEFabcdef:]/%[0123456789]"
198 #define SCAN_ACL2_6 "%[0123456789ABCDEFabcdef:]-%[0123456789ABCDEFabcdef:]%c"
199 #define SCAN_ACL3_6 "%[0123456789ABCDEFabcdef:]/%[0123456789]"
200 #define SCAN_ACL4_6 "%[0123456789ABCDEFabcdef:]/%c"
201 /* We DO need to know which is which though, for proper CIDR masking. */
202 #define SCAN_ACL1_4 "%[0123456789.]-%[0123456789.]/%[0123456789.]"
203 #define SCAN_ACL2_4 "%[0123456789.]-%[0123456789.]%c"
204 #define SCAN_ACL3_4 "%[0123456789.]/%[0123456789.]"
205 #define SCAN_ACL4_4 "%[0123456789.]/%c"
208 acl_ip_data::FactoryParse(const char *t
)
210 LOCAL_ARRAY(char, addr1
, 256);
211 LOCAL_ARRAY(char, addr2
, 256);
212 LOCAL_ARRAY(char, mask
, 256);
213 acl_ip_data
*r
= NULL
;
214 acl_ip_data
**Q
= NULL
;
217 unsigned int changed
;
218 acl_ip_data
*q
= new acl_ip_data
;
219 int iptype
= AF_UNSPEC
;
221 debugs(28, 5, "aclIpParseIpData: " << t
);
223 /* Special ACL RHS "all" matches entire Internet */
224 if (strcmp(t
, "all") == 0) {
225 debugs(28, 9, "aclIpParseIpData: magic 'all' found.");
226 q
->addr1
.setAnyAddr();
228 q
->mask
.setAnyAddr();
232 /* Detect some old broken strings equivalent to 'all'.
233 * treat them nicely. But be loud until its fixed. */
234 if (strcmp(t
, "0/0") == 0 || strcmp(t
, "0.0.0.0/0") == 0 || strcmp(t
, "0.0.0.0/0.0.0.0") == 0 ||
235 strcmp(t
, "0.0.0.0-255.255.255.255") == 0 || strcmp(t
, "0.0.0.0-0.0.0.0/0") == 0) {
237 debugs(28,DBG_CRITICAL
, "ERROR: '" << t
<< "' needs to be replaced by the term 'all'.");
238 debugs(28,DBG_CRITICAL
, "SECURITY NOTICE: Overriding config setting. Using 'all' instead.");
239 q
->addr1
.setAnyAddr();
241 q
->mask
.setAnyAddr();
245 /* Special ACL RHS "ipv4" matches IPv4 Internet
246 * A nod to IANA; we include the entire class space in case
247 * they manage to find a way to recover and use it */
248 if (strcmp(t
, "ipv4") == 0) {
250 q
->mask
.applyMask(0, AF_INET
);
254 /* Special ACL RHS "ipv6" matches IPv6-Unicast Internet */
255 if (strcmp(t
, "ipv6") == 0) {
256 debugs(28, 9, "aclIpParseIpData: magic 'ipv6' found.");
257 r
= q
; // save head of the list for result.
259 /* 0000::/4 is a mix of localhost and obsolete IPv4-mapping space. Not valid outside this host. */
261 /* Future global unicast space: 1000::/4 */
264 q
->mask
.applyMask(4, AF_INET6
);
266 /* Current global unicast space: 2000::/4 = (2000::/4 - 3000::/4) */
267 q
->next
= new acl_ip_data
;
271 q
->mask
.applyMask(3, AF_INET6
);
273 /* Future global unicast space: 4000::/2 = (4000::/4 - 7000::/4) */
274 q
->next
= new acl_ip_data
;
278 q
->mask
.applyMask(2, AF_INET6
);
280 /* Future global unicast space: 8000::/2 = (8000::/4 - B000::/4) */
281 q
->next
= new acl_ip_data
;
285 q
->mask
.applyMask(2, AF_INET6
);
287 /* Future global unicast space: C000::/3 = (C000::/4 - D000::/4) */
288 q
->next
= new acl_ip_data
;
292 q
->mask
.applyMask(3, AF_INET6
);
294 /* Future global unicast space: E000::/4 */
295 q
->next
= new acl_ip_data
;
299 q
->mask
.applyMask(4, AF_INET6
);
301 /* F000::/4 is mostly reserved non-unicast. With some exceptions ... */
303 /* RFC 4193 Unique-Local unicast space: FC00::/7 */
304 q
->next
= new acl_ip_data
;
308 q
->mask
.applyMask(7, AF_INET6
);
310 /* Link-Local unicast space: FE80::/10 */
311 q
->next
= new acl_ip_data
;
315 q
->mask
.applyMask(10, AF_INET6
);
321 if (sscanf(t
, SCAN_ACL1_4
, addr1
, addr2
, mask
) == 3) {
322 debugs(28, 9, "aclIpParseIpData: '" << t
<< "' matched: SCAN1-v4: " << SCAN_ACL1_4
);
324 } else if (sscanf(t
, SCAN_ACL2_4
, addr1
, addr2
, &c
) >= 2) {
325 debugs(28, 9, "aclIpParseIpData: '" << t
<< "' matched: SCAN2-v4: " << SCAN_ACL2_4
);
328 } else if (sscanf(t
, SCAN_ACL3_4
, addr1
, mask
) == 2) {
329 debugs(28, 9, "aclIpParseIpData: '" << t
<< "' matched: SCAN3-v4: " << SCAN_ACL3_4
);
332 } else if (sscanf(t
, SCAN_ACL4_4
, addr1
,&c
) == 2) {
333 debugs(28, 9, "aclIpParseIpData: '" << t
<< "' matched: SCAN4-v4: " << SCAN_ACL4_4
);
339 } else if (sscanf(t
, SCAN_ACL1_6
, addr1
, addr2
, mask
) == 3) {
340 debugs(28, 9, "aclIpParseIpData: '" << t
<< "' matched: SCAN1-v6: " << SCAN_ACL1_6
);
342 } else if (sscanf(t
, SCAN_ACL2_6
, addr1
, addr2
, &c
) >= 2) {
343 debugs(28, 9, "aclIpParseIpData: '" << t
<< "' matched: SCAN2-v6: " << SCAN_ACL2_6
);
346 } else if (sscanf(t
, SCAN_ACL3_6
, addr1
, mask
) == 2) {
347 debugs(28, 9, "aclIpParseIpData: '" << t
<< "' matched: SCAN3-v6: " << SCAN_ACL3_6
);
350 } else if (sscanf(t
, SCAN_ACL4_6
, addr1
, mask
) == 2) {
351 debugs(28, 9, "aclIpParseIpData: '" << t
<< "' matched: SCAN4-v6: " << SCAN_ACL4_6
);
356 } else if (sscanf(t
, "%[^/]/%s", addr1
, mask
) == 2) {
357 debugs(28, 9, "aclIpParseIpData: '" << t
<< "' matched: non-IP pattern: %[^/]/%s");
359 } else if (sscanf(t
, "%s", addr1
) == 1) {
361 * Note, must use plain getaddrinfo() here because at startup
362 * ipcache hasn't been initialized
363 * TODO: offload this to one of the Ip::Address lookups.
366 debugs(28, 5, "aclIpParseIpData: Lookup Host/IP " << addr1
);
367 struct addrinfo
*hp
= NULL
, *x
= NULL
;
368 struct addrinfo hints
;
369 Ip::Address
*prev_addr
= NULL
;
371 memset(&hints
, 0, sizeof(struct addrinfo
));
373 int errcode
= getaddrinfo(addr1
,NULL
,&hints
,&hp
);
375 if (strcmp(addr1
, "::1") == 0) {
376 debugs(28, DBG_IMPORTANT
, "aclIpParseIpData: IPv6 has not been enabled in host DNS resolver.");
379 debugs(28, DBG_CRITICAL
, "aclIpParseIpData: Bad host/IP: '" << addr1
<<
380 "' in '" << t
<< "', flags=" << hints
.ai_flags
<<
381 " : (" << errcode
<< ") " << gai_strerror(errcode
) );
389 for (x
= hp
; x
!= NULL
;) {
390 if ((r
= *Q
) == NULL
)
391 r
= *Q
= new acl_ip_data
;
393 /* getaddrinfo given a host has a nasty tendency to return duplicate addr's */
394 /* BUT sorted fortunately, so we can drop most of them easily */
397 if ( prev_addr
&& r
->addr1
== *prev_addr
) {
398 debugs(28, 3, "aclIpParseIpData: Duplicate host/IP: '" << r
->addr1
<< "' dropped.");
403 prev_addr
= &r
->addr1
;
405 debugs(28, 3, "aclIpParseIpData: Located host/IP: '" << r
->addr1
<< "'");
407 r
->addr2
.setAnyAddr();
412 debugs(28, 3, "" << addr1
<< " --> " << r
->addr1
);
416 debugs(28, DBG_CRITICAL
, "aclIpParseIpData: Bad host/IP: '" << t
<< "'");
426 /* ignore IPv6 addresses when built with IPv4-only */
427 if ( iptype
== AF_INET6
&& !Ip::EnableIpv6
) {
428 debugs(28, DBG_IMPORTANT
, "aclIpParseIpData: IPv6 has not been enabled.");
434 if (!*addr1
|| !(q
->addr1
= addr1
)) {
435 debugs(28, DBG_CRITICAL
, "aclIpParseIpData: unknown first address in '" << t
<< "'");
443 q
->addr2
.setAnyAddr();
444 else if (!(q
->addr2
=addr2
) ) {
445 debugs(28, DBG_CRITICAL
, "aclIpParseIpData: unknown second address in '" << t
<< "'");
451 /* Decode mask (NULL or empty means a exact host mask) */
452 if (!DecodeMask(mask
, q
->mask
, iptype
)) {
453 debugs(28, DBG_CRITICAL
, "aclParseIpData: unknown netmask '" << mask
<< "' in '" << t
<< "'");
460 changed
+= q
->addr1
.applyMask(q
->mask
);
461 changed
+= q
->addr2
.applyMask(q
->mask
);
464 debugs(28, DBG_CRITICAL
, "aclIpParseIpData: WARNING: Netmask masks away part of the specified IP in '" << t
<< "'");
466 debugs(28,9, HERE
<< "Parsed: " << q
->addr1
<< "-" << q
->addr2
<< "/" << q
->mask
<< "(/" << q
->mask
.cidr() <<")");
468 /* 1.2.3.4/255.255.255.0 --> 1.2.3.0 */
469 /* Same as IPv6 (not so trivial to depict) */
477 data
= new IPSplay();
481 while (char *t
= strtokFile()) {
482 acl_ip_data
*q
= acl_ip_data::FactoryParse(t
);
485 /* pop each result off the list and add it to the data tree individually */
486 acl_ip_data
*next_node
= q
->next
;
488 if (!data
->find(q
,acl_ip_data::NetworkCompare
))
489 data
->insert(q
, acl_ip_data::NetworkCompare
);
503 struct IpAclDumpVisitor
{
505 void operator() (acl_ip_data
* const & ip
) {
506 contents
.push_back(ip
->toSBuf());
513 IpAclDumpVisitor visitor
;
514 data
->visit(visitor
);
515 return visitor
.contents
;
521 return data
->empty();
525 ACLIP::match(Ip::Address
&clientip
)
527 static acl_ip_data ClientAddress
;
529 * aclIpAddrNetworkCompare() takes two acl_ip_data pointers as
530 * arguments, so we must create a fake one for the client's IP
531 * address. Since we are scanning for a single IP mask and addr2
532 * MUST be set to empty.
534 ClientAddress
.addr1
= clientip
;
535 ClientAddress
.addr2
.setEmpty();
536 ClientAddress
.mask
.setEmpty();
538 const acl_ip_data
* const * result
= data
->find(&ClientAddress
, aclIpAddrNetworkCompare
);
539 debugs(28, 3, "aclIpMatchIp: '" << clientip
<< "' " << (result
? "found" : "NOT found"));
540 return (result
!= NULL
);
543 acl_ip_data::acl_ip_data() :addr1(), addr2(), mask(), next (NULL
) {}
545 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
) {}