5 * DEBUG: section 53 AS Number handling
6 * AUTHOR: Duane Wessels, Kostas Anagnostakis
8 * SQUID Web Proxy Cache http://www.squid-cache.org/
9 * ----------------------------------------------------------
11 * Squid is the result of efforts by numerous individuals from
12 * the Internet community; see the CONTRIBUTORS file for full
13 * details. Many organizations have provided support for Squid's
14 * development; see the SPONSORS file for full details. Squid is
15 * Copyrighted (C) 2001 by the Regents of the University of
16 * California; see the COPYRIGHT file for full details. Squid
17 * incorporates software developed and/or copyrighted by other
18 * sources; see the CREDITS file for full details.
20 * This program is free software; you can redistribute it and/or modify
21 * it under the terms of the GNU General Public License as published by
22 * the Free Software Foundation; either version 2 of the License, or
23 * (at your option) any later version.
25 * This program is distributed in the hope that it will be useful,
26 * but WITHOUT ANY WARRANTY; without even the implied warranty of
27 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28 * GNU General Public License for more details.
30 * You should have received a copy of the GNU General Public License
31 * along with this program; if not, write to the Free Software
32 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
37 #include "mgr/Registration.h"
39 #include "HttpRequest.h"
40 #include "StoreClient.h"
44 #include "acl/Checklist.h"
45 #include "acl/SourceAsn.h"
46 #include "acl/DestinationAsn.h"
47 #include "acl/DestinationIp.h"
48 #include "HttpReply.h"
53 #define AS_REQBUF_SZ 4096
55 /* BEGIN of definitions for radix tree entries */
58 /* 32/128 bits address in memory with length */
65 m_ADDR() : len(sizeof(Ip::Address
)) {};
68 /* END of definitions for radix tree entries */
70 /* Head for ip to asn radix tree */
72 struct squid_radix_node_head
*AS_tree_head
;
74 /* explicit instantiation required for some systems */
76 /// \cond AUTODOCS-IGNORE
77 template cbdata_type CbDataList
<int>::CBDATA_CbDataList
;
81 * Structure for as number information. it could be simply
82 * a list but it's coded as a structure for future
83 * enhancements (e.g. expires)
86 CbDataList
<int> *as_number
;
87 time_t expires
; /* NOTUSED */
97 char reqbuf
[AS_REQBUF_SZ
];
101 /** entry into the radix tree */
103 struct squid_radix_node e_nodes
[2];
109 static int asnAddNet(char *, int);
111 static void asnCacheStart(int as
);
113 static STCB asHandleReply
;
116 #if defined(__cplusplus)
120 static int destroyRadixNode(struct squid_radix_node
*rn
, void *w
);
121 static int printRadixNode(struct squid_radix_node
*rn
, void *sentry
);
123 #if defined(__cplusplus)
127 void asnAclInitialize(ACL
* acls
);
129 static void asStateFree(void *data
);
131 static void destroyRadixNodeInfo(as_info
*);
133 static OBJH asnStats
;
138 asnMatchIp(CbDataList
<int> *data
, Ip::Address
&addr
)
140 struct squid_radix_node
*rn
;
143 CbDataList
<int> *a
= NULL
;
144 CbDataList
<int> *b
= NULL
;
146 debugs(53, 3, "asnMatchIp: Called for " << addr
);
148 if (AS_tree_head
== NULL
)
154 if (addr
.IsAnyAddr())
159 rn
= squid_rn_match(&m_addr
, AS_tree_head
);
162 debugs(53, 3, "asnMatchIp: Address not in as db.");
166 debugs(53, 3, "asnMatchIp: Found in db!");
167 e
= ((rtentry_t
*) rn
)->e_info
;
170 for (a
= data
; a
; a
= a
->next
)
171 for (b
= e
->as_number
; b
; b
= b
->next
)
172 if (a
->element
== b
->element
) {
173 debugs(53, 5, "asnMatchIp: Found a match!");
177 debugs(53, 5, "asnMatchIp: AS not in as db.");
182 ACLASN::prepareForUse()
184 for (CbDataList
<int> *i
= data
; i
; i
= i
->
186 asnCacheStart(i
->element
);
190 asnRegisterWithCacheManager(void)
192 Mgr::RegisterAction("asndb", "AS Number Database", asnStats
, 0, 1);
195 /* initialize the radix tree structure */
197 SQUIDCEXTERN
int squid_max_keylen
; /* yuck.. this is in lib/radix.c */
199 CBDATA_TYPE(ASState
);
203 static int inited
= 0;
204 squid_max_keylen
= 40;
205 CBDATA_INIT_TYPE(ASState
);
210 squid_rn_inithead(&AS_tree_head
, 8);
212 asnRegisterWithCacheManager();
218 squid_rn_walktree(AS_tree_head
, destroyRadixNode
, AS_tree_head
);
220 destroyRadixNode((struct squid_radix_node
*) 0, (void *) AS_tree_head
);
224 asnStats(StoreEntry
* sentry
)
226 storeAppendPrintf(sentry
, "Address \tAS Numbers\n");
227 squid_rn_walktree(AS_tree_head
, printRadixNode
, sentry
);
234 asnCacheStart(int as
)
236 LOCAL_ARRAY(char, asres
, 4096);
240 asState
= cbdataAlloc(ASState
);
241 asState
->dataRead
= 0;
242 debugs(53, 3, "asnCacheStart: AS " << as
);
243 snprintf(asres
, 4096, "whois://%s/!gAS%d", Config
.as_whois_server
, as
);
244 asState
->as_number
= as
;
245 req
= HttpRequest::CreateFromUrl(asres
);
247 asState
->request
= HTTPMSGLOCK(req
);
249 if ((e
= storeGetPublic(asres
, METHOD_GET
)) == NULL
) {
250 e
= storeCreateEntry(asres
, asres
, request_flags(), METHOD_GET
);
251 asState
->sc
= storeClientListAdd(e
, asState
);
252 Comm::ConnectionPointer nul
;
253 FwdState::fwdStart(nul
, e
, asState
->request
);
257 asState
->sc
= storeClientListAdd(e
, asState
);
263 StoreIOBuffer
readBuffer (AS_REQBUF_SZ
, asState
->offset
, asState
->reqbuf
);
264 storeClientCopy(asState
->sc
,
272 asHandleReply(void *data
, StoreIOBuffer result
)
274 ASState
*asState
= (ASState
*)data
;
275 StoreEntry
*e
= asState
->entry
;
278 char *buf
= asState
->reqbuf
;
281 debugs(53, 3, "asHandleReply: Called with size=" << (unsigned int)result
.length
);
282 debugs(53, 3, "asHandleReply: buffer='" << buf
<< "'");
284 /* First figure out whether we should abort the request */
286 if (EBIT_TEST(e
->flags
, ENTRY_ABORTED
)) {
287 asStateFree(asState
);
291 if (result
.length
== 0 && asState
->dataRead
) {
292 debugs(53, 3, "asHandleReply: Done: " << e
->url() );
293 asStateFree(asState
);
295 } else if (result
.flags
.error
) {
296 debugs(53, 1, "asHandleReply: Called with Error set and size=" << (unsigned int) result
.length
);
297 asStateFree(asState
);
299 } else if (HTTP_OK
!= e
->getReply()->sline
.status
) {
300 debugs(53, 1, "WARNING: AS " << asState
->as_number
<< " whois request failed");
301 asStateFree(asState
);
306 * Next, attempt to parse our request
307 * Remembering that the actual buffer size is retsize + reqofs!
311 while ((size_t)(s
- buf
) < result
.length
+ asState
->reqofs
&& *s
!= '\0') {
312 while (*s
&& xisspace(*s
))
315 for (t
= s
; *t
; t
++) {
321 /* oof, word should continue on next block */
326 debugs(53, 3, "asHandleReply: AS# " << s
<< " (" << asState
->as_number
<< ")");
327 asnAddNet(s
, asState
->as_number
);
329 asState
->dataRead
= 1;
333 * Next, grab the end of the 'valid data' in the buffer, and figure
334 * out how much data is left in our buffer, which we need to keep
335 * around for the next request
337 leftoversz
= (asState
->reqofs
+ result
.length
) - (s
- buf
);
339 assert(leftoversz
>= 0);
342 * Next, copy the left over data, from s to s + leftoversz to the
343 * beginning of the buffer
345 memmove(buf
, s
, leftoversz
);
348 * Next, update our offset and reqofs, and kick off a copy if required
350 asState
->offset
+= result
.length
;
352 asState
->reqofs
= leftoversz
;
354 debugs(53, 3, "asState->offset = " << asState
->offset
);
356 if (e
->store_status
== STORE_PENDING
) {
357 debugs(53, 3, "asHandleReply: store_status == STORE_PENDING: " << e
->url() );
358 StoreIOBuffer
tempBuffer (AS_REQBUF_SZ
- asState
->reqofs
,
360 asState
->reqbuf
+ asState
->reqofs
);
361 storeClientCopy(asState
->sc
,
367 StoreIOBuffer tempBuffer
;
368 debugs(53, 3, "asHandleReply: store complete, but data received " << e
->url() );
369 tempBuffer
.offset
= asState
->offset
;
370 tempBuffer
.length
= AS_REQBUF_SZ
- asState
->reqofs
;
371 tempBuffer
.data
= asState
->reqbuf
+ asState
->reqofs
;
372 storeClientCopy(asState
->sc
,
381 asStateFree(void *data
)
383 ASState
*asState
= (ASState
*)data
;
384 debugs(53, 3, "asnStateFree: " << asState
->entry
->url() );
385 storeUnregister(asState
->sc
, asState
->entry
, asState
);
386 asState
->entry
->unlock();
387 HTTPMSGUNLOCK(asState
->request
);
393 * add a network (addr, mask) to the radix tree, with matching AS number
396 asnAddNet(char *as_string
, int as_number
)
400 struct squid_radix_node
*rn
;
401 CbDataList
<int> **Tail
= NULL
;
402 CbDataList
<int> *q
= NULL
;
403 as_info
*asinfo
= NULL
;
410 t
= strchr(as_string
, '/');
413 debugs(53, 3, "asnAddNet: failed, invalid response from whois server.");
424 // INET6 TODO : find a better way of identifying the base IPA family for mask than this.
425 t
= strchr(as_string
, '.');
427 // generate Netbits Format Mask
429 mask
.ApplyMask(bitl
, (t
!=NULL
?AF_INET
:AF_INET6
) );
431 debugs(53, 3, "asnAddNet: called for " << addr
<< "/" << mask
);
433 e
= (rtentry_t
*)xmalloc(sizeof(rtentry_t
));
435 memset(e
, '\0', sizeof(rtentry_t
));
437 e
->e_addr
.addr
= addr
;
439 e
->e_mask
.addr
= mask
;
441 rn
= squid_rn_lookup(&e
->e_addr
, &e
->e_mask
, AS_tree_head
);
444 asinfo
= ((rtentry_t
*) rn
)->e_info
;
446 if (asinfo
->as_number
->find(as_number
)) {
447 debugs(53, 3, "asnAddNet: Ignoring repeated network '" << addr
<< "/" << bitl
<< "' for AS " << as_number
);
449 debugs(53, 3, "asnAddNet: Warning: Found a network with multiple AS numbers!");
451 for (Tail
= &asinfo
->as_number
; *Tail
; Tail
= &(*Tail
)->next
);
452 q
= new CbDataList
<int> (as_number
);
459 q
= new CbDataList
<int> (as_number
);
460 asinfo
= (as_info
*)xmalloc(sizeof(as_info
));
461 asinfo
->as_number
= q
;
462 rn
= squid_rn_addroute(&e
->e_addr
, &e
->e_mask
, AS_tree_head
, e
->e_nodes
);
463 rn
= squid_rn_match(&e
->e_addr
, AS_tree_head
);
468 if (rn
== 0) { /* assert might expand to nothing */
472 debugs(53, 3, "asnAddNet: Could not add entry.");
481 destroyRadixNode(struct squid_radix_node
*rn
, void *w
)
484 struct squid_radix_node_head
*rnh
= (struct squid_radix_node_head
*) w
;
486 if (rn
&& !(rn
->rn_flags
& RNF_ROOT
)) {
487 rtentry_t
*e
= (rtentry_t
*) rn
;
488 rn
= squid_rn_delete(rn
->rn_key
, rn
->rn_mask
, rnh
);
491 debugs(53, 3, "destroyRadixNode: internal screwup");
493 destroyRadixNodeInfo(e
->e_info
);
502 destroyRadixNodeInfo(as_info
* e_info
)
504 CbDataList
<int> *prev
= NULL
;
505 CbDataList
<int> *data
= e_info
->as_number
;
517 printRadixNode(struct squid_radix_node
*rn
, void *_sentry
)
519 StoreEntry
*sentry
= (StoreEntry
*)_sentry
;
520 rtentry_t
*e
= (rtentry_t
*) rn
;
523 char buf
[MAX_IPSTRLEN
];
529 addr
= e
->e_addr
.addr
;
530 mask
= e
->e_mask
.addr
;
531 storeAppendPrintf(sentry
, "%s/%d\t",
532 addr
.NtoA(buf
, MAX_IPSTRLEN
),
535 assert(asinfo
->as_number
);
537 for (q
= asinfo
->as_number
; q
; q
= q
->next
)
538 storeAppendPrintf(sentry
, " %d", q
->element
);
540 storeAppendPrintf(sentry
, "\n");
553 ACLASN::match(Ip::Address toMatch
)
555 return asnMatchIp(data
, toMatch
);
563 CbDataList
<int> *ldata
= data
;
565 while (ldata
!= NULL
) {
566 snprintf(buf
, sizeof(buf
), "%d", ldata
->element
);
567 wordlistAdd(&W
, buf
);
575 ACLASN::empty () const
583 CbDataList
<int> **curlist
= &data
;
584 CbDataList
<int> **Tail
;
585 CbDataList
<int> *q
= NULL
;
588 for (Tail
= curlist
; *Tail
; Tail
= &((*Tail
)->next
));
589 while ((t
= strtokFile())) {
590 q
= new CbDataList
<int> (atoi(t
));
596 ACLData
<Ip::Address
> *
597 ACLASN::clone() const
600 fatal ("cloning of ACLASN not implemented");
602 return new ACLASN(*this);
605 /* explicit template instantiation required for some systems */
607 template class ACLStrategised
<Ip::Address
>;
609 ACL::Prototype
ACLASN::SourceRegistryProtoype(&ACLASN::SourceRegistryEntry_
, "src_as");
611 ACLStrategised
<Ip::Address
> ACLASN::SourceRegistryEntry_(new ACLASN
, ACLSourceASNStrategy::Instance(), "src_as");
613 ACL::Prototype
ACLASN::DestinationRegistryProtoype(&ACLASN::DestinationRegistryEntry_
, "dst_as");
615 ACLStrategised
<Ip::Address
> ACLASN::DestinationRegistryEntry_(new ACLASN
, ACLDestinationASNStrategy::Instance(), "dst_as");
618 ACLSourceASNStrategy::match (ACLData
<Ip::Address
> * &data
, ACLFilledChecklist
*checklist
)
620 return data
->match(checklist
->src_addr
);
623 ACLSourceASNStrategy
*
624 ACLSourceASNStrategy::Instance()
629 ACLSourceASNStrategy
ACLSourceASNStrategy::Instance_
;
633 ACLDestinationASNStrategy::match (ACLData
<MatchType
> * &data
, ACLFilledChecklist
*checklist
)
635 const ipcache_addrs
*ia
= ipcache_gethostbyname(checklist
->request
->GetHost(), IP_LOOKUP_IF_MISS
);
638 for (int k
= 0; k
< (int) ia
->count
; k
++) {
639 if (data
->match(ia
->in_addrs
[k
]))
645 } else if (!checklist
->request
->flags
.destinationIPLookedUp()) {
646 /* No entry in cache, lookup not attempted */
647 /* XXX FIXME: allow accessing the acl name here */
648 debugs(28, 3, "asnMatchAcl: Can't yet compare '" << "unknown" /*name*/ << "' ACL for '" << checklist
->request
->GetHost() << "'");
649 checklist
->changeState (DestinationIPLookup::Instance());
653 return data
->match(noaddr
);
659 ACLDestinationASNStrategy
*
660 ACLDestinationASNStrategy::Instance()
665 ACLDestinationASNStrategy
ACLDestinationASNStrategy::Instance_
;