2 * Copyright (C) 1996-2014 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 byteCount
)
23 fatal ("ACLIP::operator new: unused");
28 ACLIP::operator delete (void *address
)
30 fatal ("ACLIP::operator delete: unused");
34 * Writes an IP ACL data into a buffer, then copies the buffer into the wordlist given
36 \param ip ACL data structure to display
37 \param state wordlist structure which is being generated
40 ACLIP::DumpIpListWalkee(acl_ip_data
* const & ip
, void *state
)
42 static_cast<SBufList
*>(state
)->push_back(ip
->toSBuf());
46 * print/format an acl_ip_data structure for debugging output.
48 \param buf string buffer to write to
49 \param len size of the buffer available
52 acl_ip_data::toStr(char *buf
, int len
) const
59 addr1
.toStr(b1
, len
- rlen
);
63 if (!addr2
.isAnyAddr()) {
66 addr2
.toStr(&(b2
[1]), len
- rlen
);
73 if (!mask
.isNoAddr()) {
76 int cidr
= mask
.cidr() - (addr1
.isIPv4()?96:0);
77 snprintf(&(b3
[1]), (len
-rlen
), "%u", (unsigned int)(cidr
<0?0:cidr
) );
83 acl_ip_data::toSBuf() const
85 const int bufsz
= MAX_IPSTRLEN
*2+6;
86 static char tmpbuf
[ bufsz
];
92 * aclIpAddrNetworkCompare - The guts of the comparison for IP ACLs
93 * matching checks. The first argument (p) is a "host" address,
94 * i.e. the IP address of a cache client. The second argument (q)
95 * is an entry in some address-based access control element. This
96 * function is called via ACLIP::match() and the splay library.
99 aclIpAddrNetworkCompare(acl_ip_data
* const &p
, acl_ip_data
* const &q
)
101 Ip::Address A
= p
->addr1
;
104 A
.applyMask(q
->mask
);
106 debugs(28,9, "aclIpAddrNetworkCompare: compare: " << p
->addr1
<< "/" << q
->mask
<< " (" << A
<< ") vs " <<
107 q
->addr1
<< "-" << q
->addr2
<< "/" << q
->mask
);
109 if (q
->addr2
.isAnyAddr()) { /* single address check */
111 return A
.matchIPAddr( q
->addr1
);
113 } else { /* range address check */
115 if ( (A
>= q
->addr1
) && (A
<= q
->addr2
) )
116 return 0; /* valid. inside range. */
118 return A
.matchIPAddr( q
->addr1
); /* outside of range, 'less than' */
123 * acl_ip_data::NetworkCompare - Compare two acl_ip_data entries. Strictly
124 * used by the splay insertion routine. It emits a warning if it
125 * detects a "collision" or overlap that would confuse the splay
126 * sorting algorithm. Much like aclDomainCompare.
127 * The first argument (p) is a "host" address, i.e. the IP address of a cache client.
128 * The second argument (b) is a "network" address that might have a subnet and/or range.
129 * We mask the host address bits with the network subnet mask.
132 acl_ip_data::NetworkCompare(acl_ip_data
* const & a
, acl_ip_data
* const &b
)
136 ret
= aclIpAddrNetworkCompare(b
, a
);
140 ret
= aclIpAddrNetworkCompare(a
, b
);
144 char buf_n1
[3*(MAX_IPSTRLEN
+1)];
145 char buf_n2
[3*(MAX_IPSTRLEN
+1)];
147 b
->toStr(buf_n1
, 3*(MAX_IPSTRLEN
+1));
148 a
->toStr(buf_n2
, 3*(MAX_IPSTRLEN
+1));
150 a
->toStr(buf_n1
, 3*(MAX_IPSTRLEN
+1));
151 b
->toStr(buf_n2
, 3*(MAX_IPSTRLEN
+1));
153 debugs(28, DBG_CRITICAL
, "WARNING: (" << (bina
?'B':'A') << ") '" << buf_n1
<< "' is a subnetwork of (" << (bina
?'A':'B') << ") '" << buf_n2
<< "'");
154 debugs(28, DBG_CRITICAL
, "WARNING: because of this '" << (bina
?buf_n2
:buf_n1
) << "' is ignored to keep splay tree searching predictable");
155 debugs(28, DBG_CRITICAL
, "WARNING: You should probably remove '" << buf_n1
<< "' from the ACL named '" << AclMatchedName
<< "'");
162 * Decode an ascii representation (asc) of a IP netmask address or CIDR,
163 * and place resulting information in mask.
164 * This function should NOT be called if 'asc' is a hostname!
167 acl_ip_data::DecodeMask(const char *asc
, Ip::Address
&mask
, int ctype
)
172 /* default is a mask that doesn't change any IP */
179 /* An int mask 128, 32 */
180 if ((sscanf(asc
, "%d%c", &a1
, &junk
)==1) &&
181 (a1
<= 128) && (a1
>= 0)
183 return mask
.applyMask(a1
, ctype
);
186 /* dotted notation */
187 /* assignment returns true if asc contained an IP address as text */
189 /* HACK: IPv4 netmasks don't cleanly map to IPv6 masks. */
190 debugs(28, DBG_CRITICAL
, "WARNING: Netmasks are deprecated. Please use CIDR masks instead.");
192 /* locate what CIDR mask was _probably_ meant to be in its native protocol format. */
193 /* this will completely crap out with a security fail-open if the admin is playing mask tricks */
194 /* however, thats their fault, and we do warn. see bug 2601 for the effects if we don't do this. */
195 unsigned int m
= mask
.cidr();
196 debugs(28, DBG_CRITICAL
, "WARNING: IPv4 netmasks are particularly nasty when used to compare IPv6 to IPv4 ranges.");
197 debugs(28, DBG_CRITICAL
, "WARNING: For now we will assume you meant to write /" << m
);
198 /* reset the mask completely, and crop to the CIDR boundary back properly. */
200 return mask
.applyMask(m
,AF_INET
);
208 /* Handle either type of address, IPv6 will be discarded with a warning if disabled */
209 #define SCAN_ACL1_6 "%[0123456789ABCDEFabcdef:]-%[0123456789ABCDEFabcdef:]/%[0123456789]"
210 #define SCAN_ACL2_6 "%[0123456789ABCDEFabcdef:]-%[0123456789ABCDEFabcdef:]%c"
211 #define SCAN_ACL3_6 "%[0123456789ABCDEFabcdef:]/%[0123456789]"
212 #define SCAN_ACL4_6 "%[0123456789ABCDEFabcdef:]/%c"
213 /* We DO need to know which is which though, for proper CIDR masking. */
214 #define SCAN_ACL1_4 "%[0123456789.]-%[0123456789.]/%[0123456789.]"
215 #define SCAN_ACL2_4 "%[0123456789.]-%[0123456789.]%c"
216 #define SCAN_ACL3_4 "%[0123456789.]/%[0123456789.]"
217 #define SCAN_ACL4_4 "%[0123456789.]/%c"
220 acl_ip_data::FactoryParse(const char *t
)
222 LOCAL_ARRAY(char, addr1
, 256);
223 LOCAL_ARRAY(char, addr2
, 256);
224 LOCAL_ARRAY(char, mask
, 256);
225 acl_ip_data
*r
= NULL
;
226 acl_ip_data
**Q
= NULL
;
229 unsigned int changed
;
230 acl_ip_data
*q
= new acl_ip_data
;
231 int iptype
= AF_UNSPEC
;
233 debugs(28, 5, "aclIpParseIpData: " << t
);
235 /* Special ACL RHS "all" matches entire Internet */
236 if (strcmp(t
, "all") == 0) {
237 debugs(28, 9, "aclIpParseIpData: magic 'all' found.");
238 q
->addr1
.setAnyAddr();
240 q
->mask
.setAnyAddr();
244 /* Detect some old broken strings equivalent to 'all'.
245 * treat them nicely. But be loud until its fixed. */
246 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 ||
247 strcmp(t
, "0.0.0.0-255.255.255.255") == 0 || strcmp(t
, "0.0.0.0-0.0.0.0/0") == 0) {
249 debugs(28,DBG_CRITICAL
, "ERROR: '" << t
<< "' needs to be replaced by the term 'all'.");
250 debugs(28,DBG_CRITICAL
, "SECURITY NOTICE: Overriding config setting. Using 'all' instead.");
251 q
->addr1
.setAnyAddr();
253 q
->mask
.setAnyAddr();
257 /* Special ACL RHS "ipv4" matches IPv4 Internet
258 * A nod to IANA; we include the entire class space in case
259 * they manage to find a way to recover and use it */
260 if (strcmp(t
, "ipv4") == 0) {
262 q
->mask
.applyMask(0, AF_INET
);
266 /* Special ACL RHS "ipv6" matches IPv6-Unicast Internet */
267 if (strcmp(t
, "ipv6") == 0) {
268 debugs(28, 9, "aclIpParseIpData: magic 'ipv6' found.");
269 r
= q
; // save head of the list for result.
271 /* 0000::/4 is a mix of localhost and obsolete IPv4-mapping space. Not valid outside this host. */
273 /* Future global unicast space: 1000::/4 */
276 q
->mask
.applyMask(4, AF_INET6
);
278 /* Current global unicast space: 2000::/4 = (2000::/4 - 3000::/4) */
279 q
->next
= new acl_ip_data
;
283 q
->mask
.applyMask(3, AF_INET6
);
285 /* Future global unicast space: 4000::/2 = (4000::/4 - 7000::/4) */
286 q
->next
= new acl_ip_data
;
290 q
->mask
.applyMask(2, AF_INET6
);
292 /* Future global unicast space: 8000::/2 = (8000::/4 - B000::/4) */
293 q
->next
= new acl_ip_data
;
297 q
->mask
.applyMask(2, AF_INET6
);
299 /* Future global unicast space: C000::/3 = (C000::/4 - D000::/4) */
300 q
->next
= new acl_ip_data
;
304 q
->mask
.applyMask(3, AF_INET6
);
306 /* Future global unicast space: E000::/4 */
307 q
->next
= new acl_ip_data
;
311 q
->mask
.applyMask(4, AF_INET6
);
313 /* F000::/4 is mostly reserved non-unicast. With some exceptions ... */
315 /* RFC 4193 Unique-Local unicast space: FC00::/7 */
316 q
->next
= new acl_ip_data
;
320 q
->mask
.applyMask(7, AF_INET6
);
322 /* Link-Local unicast space: FE80::/10 */
323 q
->next
= new acl_ip_data
;
327 q
->mask
.applyMask(10, AF_INET6
);
333 if (sscanf(t
, SCAN_ACL1_4
, addr1
, addr2
, mask
) == 3) {
334 debugs(28, 9, "aclIpParseIpData: '" << t
<< "' matched: SCAN1-v4: " << SCAN_ACL1_4
);
336 } else if (sscanf(t
, SCAN_ACL2_4
, addr1
, addr2
, &c
) >= 2) {
337 debugs(28, 9, "aclIpParseIpData: '" << t
<< "' matched: SCAN2-v4: " << SCAN_ACL2_4
);
340 } else if (sscanf(t
, SCAN_ACL3_4
, addr1
, mask
) == 2) {
341 debugs(28, 9, "aclIpParseIpData: '" << t
<< "' matched: SCAN3-v4: " << SCAN_ACL3_4
);
344 } else if (sscanf(t
, SCAN_ACL4_4
, addr1
,&c
) == 2) {
345 debugs(28, 9, "aclIpParseIpData: '" << t
<< "' matched: SCAN4-v4: " << SCAN_ACL4_4
);
351 } else if (sscanf(t
, SCAN_ACL1_6
, addr1
, addr2
, mask
) == 3) {
352 debugs(28, 9, "aclIpParseIpData: '" << t
<< "' matched: SCAN1-v6: " << SCAN_ACL1_6
);
354 } else if (sscanf(t
, SCAN_ACL2_6
, addr1
, addr2
, &c
) >= 2) {
355 debugs(28, 9, "aclIpParseIpData: '" << t
<< "' matched: SCAN2-v6: " << SCAN_ACL2_6
);
358 } else if (sscanf(t
, SCAN_ACL3_6
, addr1
, mask
) == 2) {
359 debugs(28, 9, "aclIpParseIpData: '" << t
<< "' matched: SCAN3-v6: " << SCAN_ACL3_6
);
362 } else if (sscanf(t
, SCAN_ACL4_6
, addr1
, mask
) == 2) {
363 debugs(28, 9, "aclIpParseIpData: '" << t
<< "' matched: SCAN4-v6: " << SCAN_ACL4_6
);
368 } else if (sscanf(t
, "%[^/]/%s", addr1
, mask
) == 2) {
369 debugs(28, 9, "aclIpParseIpData: '" << t
<< "' matched: non-IP pattern: %[^/]/%s");
371 } else if (sscanf(t
, "%s", addr1
) == 1) {
373 * Note, must use plain getaddrinfo() here because at startup
374 * ipcache hasn't been initialized
375 * TODO: offload this to one of the Ip::Address lookups.
378 debugs(28, 5, "aclIpParseIpData: Lookup Host/IP " << addr1
);
379 struct addrinfo
*hp
= NULL
, *x
= NULL
;
380 struct addrinfo hints
;
381 Ip::Address
*prev_addr
= NULL
;
383 memset(&hints
, 0, sizeof(struct addrinfo
));
385 int errcode
= getaddrinfo(addr1
,NULL
,&hints
,&hp
);
387 if (strcmp(addr1
, "::1") == 0) {
388 debugs(28, DBG_IMPORTANT
, "aclIpParseIpData: IPv6 has not been enabled in host DNS resolver.");
391 debugs(28, DBG_CRITICAL
, "aclIpParseIpData: Bad host/IP: '" << addr1
<<
392 "' in '" << t
<< "', flags=" << hints
.ai_flags
<<
393 " : (" << errcode
<< ") " << gai_strerror(errcode
) );
401 for (x
= hp
; x
!= NULL
;) {
402 if ((r
= *Q
) == NULL
)
403 r
= *Q
= new acl_ip_data
;
405 /* getaddrinfo given a host has a nasty tendency to return duplicate addr's */
406 /* BUT sorted fortunately, so we can drop most of them easily */
409 if ( prev_addr
&& r
->addr1
== *prev_addr
) {
410 debugs(28, 3, "aclIpParseIpData: Duplicate host/IP: '" << r
->addr1
<< "' dropped.");
415 prev_addr
= &r
->addr1
;
417 debugs(28, 3, "aclIpParseIpData: Located host/IP: '" << r
->addr1
<< "'");
419 r
->addr2
.setAnyAddr();
424 debugs(28, 3, "" << addr1
<< " --> " << r
->addr1
);
428 debugs(28, DBG_CRITICAL
, "aclIpParseIpData: Bad host/IP: '" << t
<< "'");
438 /* ignore IPv6 addresses when built with IPv4-only */
439 if ( iptype
== AF_INET6
&& !Ip::EnableIpv6
) {
440 debugs(28, DBG_IMPORTANT
, "aclIpParseIpData: IPv6 has not been enabled.");
446 if (!*addr1
|| !(q
->addr1
= addr1
)) {
447 debugs(28, DBG_CRITICAL
, "aclIpParseIpData: unknown first address in '" << t
<< "'");
455 q
->addr2
.setAnyAddr();
456 else if (!(q
->addr2
=addr2
) ) {
457 debugs(28, DBG_CRITICAL
, "aclIpParseIpData: unknown second address in '" << t
<< "'");
463 /* Decode mask (NULL or empty means a exact host mask) */
464 if (!DecodeMask(mask
, q
->mask
, iptype
)) {
465 debugs(28, DBG_CRITICAL
, "aclParseIpData: unknown netmask '" << mask
<< "' in '" << t
<< "'");
472 changed
+= q
->addr1
.applyMask(q
->mask
);
473 changed
+= q
->addr2
.applyMask(q
->mask
);
476 debugs(28, DBG_CRITICAL
, "aclIpParseIpData: WARNING: Netmask masks away part of the specified IP in '" << t
<< "'");
478 debugs(28,9, HERE
<< "Parsed: " << q
->addr1
<< "-" << q
->addr2
<< "/" << q
->mask
<< "(/" << q
->mask
.cidr() <<")");
480 /* 1.2.3.4/255.255.255.0 --> 1.2.3.0 */
481 /* Same as IPv6 (not so trivial to depict) */
490 while (char *t
= strtokFile()) {
491 acl_ip_data
*q
= acl_ip_data::FactoryParse(t
);
494 /* pop each result off the list and add it to the data tree individually */
495 acl_ip_data
*next_node
= q
->next
;
497 data
= data
->insert(q
, acl_ip_data::NetworkCompare
);
506 data
->destroy(IPSplay::DefaultFree
);
513 data
->walk(DumpIpListWalkee
, &sl
);
520 return data
->empty();
524 ACLIP::match(Ip::Address
&clientip
)
526 static acl_ip_data ClientAddress
;
528 * aclIpAddrNetworkCompare() takes two acl_ip_data pointers as
529 * arguments, so we must create a fake one for the client's IP
530 * address. Since we are scanning for a single IP mask and addr2
531 * MUST be set to empty.
533 ClientAddress
.addr1
= clientip
;
534 ClientAddress
.addr2
.setEmpty();
535 ClientAddress
.mask
.setEmpty();
537 data
= data
->splay(&ClientAddress
, aclIpAddrNetworkCompare
);
538 debugs(28, 3, "aclIpMatchIp: '" << clientip
<< "' " << (splayLastResult
? "NOT found" : "found"));
539 return !splayLastResult
;
542 acl_ip_data::acl_ip_data() :addr1(), addr2(), mask(), next (NULL
) {}
544 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
) {}