5 * DEBUG: section 82 External ACL
6 * AUTHOR: Henrik Nordstrom, MARA Systems AB
8 * SQUID Web Proxy Cache http://www.squid-cache.org/
9 * ----------------------------------------------------------
11 * The contents of this file is Copyright (C) 2002 by MARA Systems AB,
12 * Sweden, unless otherwise is indicated in the specific function. The
13 * author gives his full permission to include this file into the Squid
14 * software product under the terms of the GNU General Public License as
15 * published by the Free Software Foundation; either version 2 of the
16 * License, or (at your option) any later version.
18 * Squid is the result of efforts by numerous individuals from
19 * the Internet community; see the CONTRIBUTORS file for full
20 * details. Many organizations have provided support for Squid's
21 * development; see the SPONSORS file for full details. Squid is
22 * Copyrighted (C) 2001 by the Regents of the University of
23 * California; see the COPYRIGHT file for full details. Squid
24 * incorporates software developed and/or copyrighted by other
25 * sources; see the CREDITS file for full details.
27 * This program is free software; you can redistribute it and/or modify
28 * it under the terms of the GNU General Public License as published by
29 * the Free Software Foundation; either version 2 of the License, or
30 * (at your option) any later version.
32 * This program is distributed in the hope that it will be useful,
33 * but WITHOUT ANY WARRANTY; without even the implied warranty of
34 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
35 * GNU General Public License for more details.
37 * You should have received a copy of the GNU General Public License
38 * along with this program; if not, write to the Free Software
39 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
44 #include "CacheManager.h"
45 #include "ExternalACL.h"
46 #include "ExternalACLEntry.h"
47 #include "auth/UserRequest.h"
48 #include "SquidTime.h"
51 #include "acl/FilledChecklist.h"
54 #include "ident/AclIdent.h"
56 #include "client_side.h"
57 #include "HttpRequest.h"
58 #include "HttpReply.h"
60 #include "auth/Gadgets.h"
64 #include "URLScheme.h"
67 #ifndef DEFAULT_EXTERNAL_ACL_TTL
68 #define DEFAULT_EXTERNAL_ACL_TTL 1 * 60 * 60
70 #ifndef DEFAULT_EXTERNAL_ACL_CHILDREN
71 #define DEFAULT_EXTERNAL_ACL_CHILDREN 5
74 typedef struct _external_acl_format external_acl_format
;
76 static char *makeExternalAclKey(ACLFilledChecklist
* ch
, external_acl_data
* acl_data
);
77 static void external_acl_cache_delete(external_acl
* def
, external_acl_entry
* entry
);
78 static int external_acl_entry_expired(external_acl
* def
, external_acl_entry
* entry
);
79 static int external_acl_grace_expired(external_acl
* def
, external_acl_entry
* entry
);
80 static void external_acl_cache_touch(external_acl
* def
, external_acl_entry
* entry
);
81 static external_acl_entry
*external_acl_cache_add(external_acl
* def
, const char *key
, ExternalACLEntryData
const &data
);
83 /******************************************************************
84 * external_acl directive
106 external_acl_format
*format
;
110 HelperChildConfig children
;
125 * Configuration flag. May only be altered by the configuration parser.
127 * Indicates that all uses of this external_acl_type helper require authentication
128 * details to be processed. If none are available its a fail match.
133 QUOTE_METHOD_SHELL
= 1,
137 Ip::Address local_addr
;
140 struct _external_acl_format
{
162 EXT_ACL_HEADER_REQUEST
,
163 EXT_ACL_HEADER_REQUEST_MEMBER
,
164 EXT_ACL_HEADER_REQUEST_ID
,
165 EXT_ACL_HEADER_REQUEST_ID_MEMBER
,
167 EXT_ACL_HEADER_REPLY
,
168 EXT_ACL_HEADER_REPLY_MEMBER
,
169 EXT_ACL_HEADER_REPLY_ID
,
170 EXT_ACL_HEADER_REPLY_ID_MEMBER
,
175 EXT_ACL_USER_CERT_RAW
,
176 EXT_ACL_USER_CERTCHAIN_RAW
,
181 external_acl_format
*next
;
185 http_hdr_type header_id
;
188 /* FIXME: These are not really cbdata, but it is an easy way
189 * to get them pooled, refcounted, accounted and freed properly...
191 CBDATA_TYPE(external_acl
);
192 CBDATA_TYPE(external_acl_format
);
195 free_external_acl_format(void *data
)
197 external_acl_format
*p
= static_cast<external_acl_format
*>(data
);
198 safe_free(p
->header
);
202 free_external_acl(void *data
)
204 external_acl
*p
= static_cast<external_acl
*>(data
);
208 external_acl_format
*f
= p
->format
;
213 wordlistDestroy(&p
->cmdline
);
216 helperShutdown(p
->theHelper
);
221 while (p
->lru_list
.tail
)
222 external_acl_cache_delete(p
, static_cast<external_acl_entry
*>(p
->lru_list
.tail
->data
));
224 hashFreeMemory(p
->cache
);
228 * Parse the External ACL format %<{.*} and %>{.*} token(s) to pass a specific
229 * request or reply header to external helper.
231 \param header - the token being parsed (without the identifying prefix)
232 \param type - format enum identifier for this element, pulled from identifying prefix
233 \param format - structure to contain all the info about this format element.
236 parse_header_token(external_acl_format
*format
, char *header
, const _external_acl_format::format_type type
)
241 /** Cut away the closing brace */
242 end
= strchr(header
, '}');
243 if (end
&& strlen(end
) == 1)
248 member
= strchr(header
, ':');
251 /* Split in header and member */
254 if (!xisalnum(*member
))
255 format
->separator
= *member
++;
257 format
->separator
= ',';
259 format
->member
= xstrdup(member
);
261 if (type
== _external_acl_format::EXT_ACL_HEADER_REQUEST
)
262 format
->type
= _external_acl_format::EXT_ACL_HEADER_REQUEST_MEMBER
;
264 format
->type
= _external_acl_format::EXT_ACL_HEADER_REQUEST_MEMBER
;
269 format
->header
= xstrdup(header
);
270 format
->header_id
= httpHeaderIdByNameDef(header
, strlen(header
));
272 if (format
->header_id
!= -1) {
274 if (type
== _external_acl_format::EXT_ACL_HEADER_REQUEST
)
275 format
->type
= _external_acl_format::EXT_ACL_HEADER_REQUEST_ID_MEMBER
;
277 format
->type
= _external_acl_format::EXT_ACL_HEADER_REPLY_ID_MEMBER
;
279 if (type
== _external_acl_format::EXT_ACL_HEADER_REQUEST
)
280 format
->type
= _external_acl_format::EXT_ACL_HEADER_REQUEST_ID
;
282 format
->type
= _external_acl_format::EXT_ACL_HEADER_REPLY_ID
;
288 parse_externalAclHelper(external_acl
** list
)
292 external_acl_format
**p
;
294 CBDATA_INIT_TYPE_FREECB(external_acl
, free_external_acl
);
295 CBDATA_INIT_TYPE_FREECB(external_acl_format
, free_external_acl_format
);
297 a
= cbdataAlloc(external_acl
);
300 a
->ttl
= DEFAULT_EXTERNAL_ACL_TTL
;
301 a
->negative_ttl
= -1;
302 a
->cache_size
= 256*1024;
303 a
->children
.n_max
= DEFAULT_EXTERNAL_ACL_CHILDREN
;
304 a
->children
.n_startup
= a
->children
.n_max
;
305 a
->children
.n_idle
= 1;
306 a
->local_addr
.SetLocalhost();
307 a
->quote
= external_acl::QUOTE_METHOD_URL
;
309 token
= strtok(NULL
, w_space
);
314 a
->name
= xstrdup(token
);
316 token
= strtok(NULL
, w_space
);
320 if (strncmp(token
, "ttl=", 4) == 0) {
321 a
->ttl
= atoi(token
+ 4);
322 } else if (strncmp(token
, "negative_ttl=", 13) == 0) {
323 a
->negative_ttl
= atoi(token
+ 13);
324 } else if (strncmp(token
, "children=", 9) == 0) {
325 a
->children
.n_max
= atoi(token
+ 9);
326 debugs(0, 0, "WARNING: external_acl_type option children=N has been deprecated in favor of children-max=N and children-startup=N");
327 } else if (strncmp(token
, "children-max=", 13) == 0) {
328 a
->children
.n_max
= atoi(token
+ 13);
329 } else if (strncmp(token
, "children-startup=", 17) == 0) {
330 a
->children
.n_startup
= atoi(token
+ 17);
331 } else if (strncmp(token
, "children-idle=", 14) == 0) {
332 a
->children
.n_idle
= atoi(token
+ 14);
333 } else if (strncmp(token
, "concurrency=", 12) == 0) {
334 a
->children
.concurrency
= atoi(token
+ 12);
335 } else if (strncmp(token
, "cache=", 6) == 0) {
336 a
->cache_size
= atoi(token
+ 6);
337 } else if (strncmp(token
, "grace=", 6) == 0) {
338 a
->grace
= atoi(token
+ 6);
339 } else if (strcmp(token
, "protocol=2.5") == 0) {
340 a
->quote
= external_acl::QUOTE_METHOD_SHELL
;
341 } else if (strcmp(token
, "protocol=3.0") == 0) {
342 a
->quote
= external_acl::QUOTE_METHOD_URL
;
343 } else if (strcmp(token
, "quote=url") == 0) {
344 a
->quote
= external_acl::QUOTE_METHOD_URL
;
345 } else if (strcmp(token
, "quote=shell") == 0) {
346 a
->quote
= external_acl::QUOTE_METHOD_SHELL
;
348 /* INET6: allow admin to configure some helpers explicitly to
349 bind to IPv4/v6 localhost port. */
350 } else if (strcmp(token
, "ipv4") == 0) {
351 if ( !a
->local_addr
.SetIPv4() ) {
352 debugs(3, 0, "WARNING: Error converting " << a
->local_addr
<< " to IPv4 in " << a
->name
);
354 } else if (strcmp(token
, "ipv6") == 0) {
356 debugs(3, 0, "WARNING: --enable-ipv6 required for external ACL helpers to use IPv6: " << a
->name
);
364 token
= strtok(NULL
, w_space
);
367 /* check that child startup value is sane. */
368 if (a
->children
.n_startup
> a
->children
.n_max
)
369 a
->children
.n_startup
= a
->children
.n_max
;
371 /* check that child idle value is sane. */
372 if (a
->children
.n_idle
> a
->children
.n_max
)
373 a
->children
.n_idle
= a
->children
.n_max
;
374 if (a
->children
.n_idle
< 1)
375 a
->children
.n_idle
= 1;
377 if (a
->negative_ttl
== -1)
378 a
->negative_ttl
= a
->ttl
;
384 external_acl_format
*format
;
386 /* stop on first non-format token found */
391 format
= cbdataAlloc(external_acl_format
);
393 if (strncmp(token
, "%{", 2) == 0) {
394 // deprecated. but assume the old configs all referred to request headers.
395 debugs(82, DBG_IMPORTANT
, "WARNING: external_acl_type format %{...} is being replaced by %>{...} for : " << token
);
396 parse_header_token(format
, (token
+2), _external_acl_format::EXT_ACL_HEADER_REQUEST
);
397 } else if (strncmp(token
, "%>{", 3) == 0) {
398 parse_header_token(format
, (token
+3), _external_acl_format::EXT_ACL_HEADER_REQUEST
);
399 } else if (strncmp(token
, "%<{", 3) == 0) {
400 parse_header_token(format
, (token
+3), _external_acl_format::EXT_ACL_HEADER_REPLY
);
401 } else if (strcmp(token
, "%LOGIN") == 0) {
402 format
->type
= _external_acl_format::EXT_ACL_LOGIN
;
403 a
->require_auth
= true;
407 else if (strcmp(token
, "%IDENT") == 0)
408 format
->type
= _external_acl_format::EXT_ACL_IDENT
;
412 else if (strcmp(token
, "%SRC") == 0)
413 format
->type
= _external_acl_format::EXT_ACL_SRC
;
414 else if (strcmp(token
, "%SRCPORT") == 0)
415 format
->type
= _external_acl_format::EXT_ACL_SRCPORT
;
417 else if (strcmp(token
, "%SRCEUI48") == 0)
418 format
->type
= _external_acl_format::EXT_ACL_SRCEUI48
;
419 else if (strcmp(token
, "%SRCEUI64") == 0)
420 format
->type
= _external_acl_format::EXT_ACL_SRCEUI64
;
422 else if (strcmp(token
, "%MYADDR") == 0)
423 format
->type
= _external_acl_format::EXT_ACL_MYADDR
;
424 else if (strcmp(token
, "%MYPORT") == 0)
425 format
->type
= _external_acl_format::EXT_ACL_MYPORT
;
426 else if (strcmp(token
, "%URI") == 0)
427 format
->type
= _external_acl_format::EXT_ACL_URI
;
428 else if (strcmp(token
, "%DST") == 0)
429 format
->type
= _external_acl_format::EXT_ACL_DST
;
430 else if (strcmp(token
, "%PROTO") == 0)
431 format
->type
= _external_acl_format::EXT_ACL_PROTO
;
432 else if (strcmp(token
, "%PORT") == 0)
433 format
->type
= _external_acl_format::EXT_ACL_PORT
;
434 else if (strcmp(token
, "%PATH") == 0)
435 format
->type
= _external_acl_format::EXT_ACL_PATH
;
436 else if (strcmp(token
, "%METHOD") == 0)
437 format
->type
= _external_acl_format::EXT_ACL_METHOD
;
440 else if (strcmp(token
, "%USER_CERT") == 0)
441 format
->type
= _external_acl_format::EXT_ACL_USER_CERT_RAW
;
442 else if (strcmp(token
, "%USER_CERTCHAIN") == 0)
443 format
->type
= _external_acl_format::EXT_ACL_USER_CERTCHAIN_RAW
;
444 else if (strncmp(token
, "%USER_CERT_", 11) == 0) {
445 format
->type
= _external_acl_format::EXT_ACL_USER_CERT
;
446 format
->header
= xstrdup(token
+ 11);
447 } else if (strncmp(token
, "%CA_CERT_", 11) == 0) {
448 format
->type
= _external_acl_format::EXT_ACL_USER_CERT
;
449 format
->header
= xstrdup(token
+ 11);
452 else if (strcmp(token
, "%EXT_USER") == 0)
453 format
->type
= _external_acl_format::EXT_ACL_EXT_USER
;
455 debugs(0,0, "ERROR: Unknown Format token " << token
);
461 token
= strtok(NULL
, w_space
);
464 /* There must be at least one format token */
472 wordlistAdd(&a
->cmdline
, token
);
475 parse_wordlist(&a
->cmdline
);
478 list
= &(*list
)->next
;
484 dump_externalAclHelper(StoreEntry
* sentry
, const char *name
, const external_acl
* list
)
486 const external_acl
*node
;
487 const external_acl_format
*format
;
488 const wordlist
*word
;
490 for (node
= list
; node
; node
= node
->next
) {
491 storeAppendPrintf(sentry
, "%s %s", name
, node
->name
);
493 if (!node
->local_addr
.IsIPv6())
494 storeAppendPrintf(sentry
, " ipv4");
496 storeAppendPrintf(sentry
, " ipv6");
498 if (node
->ttl
!= DEFAULT_EXTERNAL_ACL_TTL
)
499 storeAppendPrintf(sentry
, " ttl=%d", node
->ttl
);
501 if (node
->negative_ttl
!= node
->ttl
)
502 storeAppendPrintf(sentry
, " negative_ttl=%d", node
->negative_ttl
);
505 storeAppendPrintf(sentry
, " grace=%d", node
->grace
);
507 if (node
->children
.n_max
!= DEFAULT_EXTERNAL_ACL_CHILDREN
)
508 storeAppendPrintf(sentry
, " children-max=%d", node
->children
.n_max
);
510 if (node
->children
.n_startup
!= 1)
511 storeAppendPrintf(sentry
, " children-startup=%d", node
->children
.n_startup
);
513 if (node
->children
.n_idle
!= (node
->children
.n_max
+ node
->children
.n_startup
) )
514 storeAppendPrintf(sentry
, " children-idle=%d", node
->children
.n_idle
);
516 if (node
->children
.concurrency
)
517 storeAppendPrintf(sentry
, " concurrency=%d", node
->children
.concurrency
);
520 storeAppendPrintf(sentry
, " cache=%d", node
->cache_size
);
522 for (format
= node
->format
; format
; format
= format
->next
) {
523 switch (format
->type
) {
525 case _external_acl_format::EXT_ACL_HEADER_REQUEST
:
526 case _external_acl_format::EXT_ACL_HEADER_REQUEST_ID
:
527 storeAppendPrintf(sentry
, " %%>{%s}", format
->header
);
530 case _external_acl_format::EXT_ACL_HEADER_REQUEST_MEMBER
:
531 case _external_acl_format::EXT_ACL_HEADER_REQUEST_ID_MEMBER
:
532 storeAppendPrintf(sentry
, " %%>{%s:%s}", format
->header
, format
->member
);
535 case _external_acl_format::EXT_ACL_HEADER_REPLY
:
536 case _external_acl_format::EXT_ACL_HEADER_REPLY_ID
:
537 storeAppendPrintf(sentry
, " %%<{%s}", format
->header
);
540 case _external_acl_format::EXT_ACL_HEADER_REPLY_MEMBER
:
541 case _external_acl_format::EXT_ACL_HEADER_REPLY_ID_MEMBER
:
542 storeAppendPrintf(sentry
, " %%<{%s:%s}", format
->header
, format
->member
);
544 #define DUMP_EXT_ACL_TYPE(a) \
545 case _external_acl_format::EXT_ACL_##a: \
546 storeAppendPrintf(sentry, " %%%s", #a); \
549 DUMP_EXT_ACL_TYPE(LOGIN
);
552 DUMP_EXT_ACL_TYPE(IDENT
);
555 DUMP_EXT_ACL_TYPE(SRC
);
556 DUMP_EXT_ACL_TYPE(SRCPORT
);
558 DUMP_EXT_ACL_TYPE(SRCEUI48
);
559 DUMP_EXT_ACL_TYPE(SRCEUI64
);
562 DUMP_EXT_ACL_TYPE(MYADDR
);
563 DUMP_EXT_ACL_TYPE(MYPORT
);
564 DUMP_EXT_ACL_TYPE(URI
);
565 DUMP_EXT_ACL_TYPE(DST
);
566 DUMP_EXT_ACL_TYPE(PROTO
);
567 DUMP_EXT_ACL_TYPE(PORT
);
568 DUMP_EXT_ACL_TYPE(PATH
);
569 DUMP_EXT_ACL_TYPE(METHOD
);
572 case _external_acl_format::EXT_ACL_USER_CERT_RAW
:
573 storeAppendPrintf(sentry
, " %%USER_CERT");
576 case _external_acl_format::EXT_ACL_USER_CERTCHAIN_RAW
:
577 storeAppendPrintf(sentry
, " %%USER_CERTCHAIN");
580 case _external_acl_format::EXT_ACL_USER_CERT
:
581 storeAppendPrintf(sentry
, " %%USER_CERT_%s", format
->header
);
584 case _external_acl_format::EXT_ACL_CA_CERT
:
585 storeAppendPrintf(sentry
, " %%USER_CERT_%s", format
->header
);
589 DUMP_EXT_ACL_TYPE(EXT_USER
);
592 fatal("unknown external_acl format error");
597 for (word
= node
->cmdline
; word
; word
= word
->next
)
598 storeAppendPrintf(sentry
, " %s", word
->key
);
600 storeAppendPrintf(sentry
, "\n");
605 free_externalAclHelper(external_acl
** list
)
608 external_acl
*node
= *list
;
615 static external_acl
*
616 find_externalAclHelper(const char *name
)
620 for (node
= Config
.externalAclHelperList
; node
; node
= node
->next
) {
621 if (strcmp(node
->name
, name
) == 0)
631 (ExternalACLEntry
*anEntry
)
634 assert (anEntry
->def
== NULL
);
636 hash_join(cache
, anEntry
);
637 dlinkAdd(anEntry
, &anEntry
->lru
, &lru_list
);
642 external_acl::trimCache()
644 if (cache_size
&& cache_entries
>= cache_size
)
645 external_acl_cache_delete(this, static_cast<external_acl_entry
*>(lru_list
.tail
->data
));
649 /******************************************************************
653 struct _external_acl_data
{
658 CBDATA_TYPE(external_acl_data
);
660 free_external_acl_data(void *data
)
662 external_acl_data
*p
= static_cast<external_acl_data
*>(data
);
663 wordlistDestroy(&p
->arguments
);
664 cbdataReferenceDone(p
->def
);
675 CBDATA_INIT_TYPE_FREECB(external_acl_data
, free_external_acl_data
);
677 data
= cbdataAlloc(external_acl_data
);
679 token
= strtok(NULL
, w_space
);
684 data
->def
= cbdataReference(find_externalAclHelper(token
));
689 while ((token
= strtokFile())) {
690 wordlistAdd(&data
->arguments
, token
);
695 ACLExternal::valid () const
697 if (data
->def
->require_auth
) {
698 if (authenticateSchemeCount() == 0) {
699 debugs(28, 0, "Can't use proxy auth because no authentication schemes were compiled.");
703 if (authenticateActiveSchemeCount() == 0) {
704 debugs(28, 0, "Can't use proxy auth because no authentication schemes are fully configured.");
713 ACLExternal::empty () const
718 ACLExternal::~ACLExternal()
725 aclMatchExternal(external_acl_data
*acl
, ACLFilledChecklist
*ch
)
728 external_acl_entry
*entry
;
729 const char *key
= "";
730 debugs(82, 9, "aclMatchExternal: acl=\"" << acl
->def
->name
<< "\"");
731 entry
= ch
->extacl_entry
;
734 if (cbdataReferenceValid(entry
) && entry
->def
== acl
->def
&&
735 strcmp((char *)entry
->key
, key
) == 0) {
738 /* Not valid, or not ours.. get rid of it */
739 cbdataReferenceDone(ch
->extacl_entry
);
744 external_acl_message
= "MISSING REQUIRED INFORMATION";
747 if (acl
->def
->require_auth
) {
749 /* Make sure the user is authenticated */
750 debugs(82, 3, "aclMatchExternal: " << acl
->def
->name
<< " check user authenticated.");
752 if ((ti
= AuthenticateAcl(ch
)) != 1) {
753 debugs(82, 2, "aclMatchExternal: " << acl
->def
->name
<< " user not authenticated (" << ti
<< ")");
756 debugs(82, 3, "aclMatchExternal: " << acl
->def
->name
<< " user is authenticated.");
759 key
= makeExternalAclKey(ch
, acl
);
762 /* Not sufficient data to process */
766 entry
= static_cast<external_acl_entry
*>(hash_lookup(acl
->def
->cache
, key
));
768 if (!entry
|| external_acl_grace_expired(acl
->def
, entry
)) {
769 debugs(82, 2, "aclMatchExternal: " << acl
->def
->name
<< "(\"" << key
<< "\") = lookup needed");
770 debugs(82, 2, "aclMatchExternal: \"" << key
<< "\": entry=@" <<
771 entry
<< ", age=" << (entry
? (long int) squid_curtime
- entry
->date
: 0));
773 if (acl
->def
->theHelper
->stats
.queue_size
<= (int)acl
->def
->theHelper
->childs
.n_active
) {
774 debugs(82, 2, "aclMatchExternal: \"" << key
<< "\": queueing a call.");
775 ch
->changeState (ExternalACLLookup::Instance());
778 debugs(82, 2, "aclMatchExternal: \"" << key
<< "\": return -1.");
783 debugs(82, 1, "aclMatchExternal: '" << acl
->def
->name
<<
784 "' queue overload. Request rejected '" << key
<< "'.");
785 external_acl_message
= "SYSTEM TOO BUSY, TRY AGAIN LATER";
788 debugs(82, 1, "aclMatchExternal: '" << acl
->def
->name
<<
789 "' queue overload. Using stale result. '" << key
<< "'.");
790 /* Fall thru to processing below */
796 external_acl_cache_touch(acl
->def
, entry
);
797 result
= entry
->result
;
798 external_acl_message
= entry
->message
.termedBuf();
800 debugs(82, 2, "aclMatchExternal: " << acl
->def
->name
<< " = " << result
);
803 if (entry
->user
.size())
804 ch
->request
->extacl_user
= entry
->user
;
806 if (entry
->password
.size())
807 ch
->request
->extacl_passwd
= entry
->password
;
809 if (!ch
->request
->tag
.size())
810 ch
->request
->tag
= entry
->tag
;
812 if (entry
->log
.size())
813 ch
->request
->extacl_log
= entry
->log
;
815 if (entry
->message
.size())
816 ch
->request
->extacl_message
= entry
->message
;
823 ACLExternal::match(ACLChecklist
*checklist
)
825 return aclMatchExternal (data
, Filled(checklist
));
829 ACLExternal::dump() const
831 external_acl_data
const *acl
= data
;
832 wordlist
*result
= NULL
;
836 mb
.Printf("%s", acl
->def
->name
);
838 for (arg
= acl
->arguments
; arg
; arg
= arg
->next
) {
839 mb
.Printf(" %s", arg
->key
);
842 wordlistAdd(&result
, mb
.buf
);
847 /******************************************************************
852 external_acl_cache_touch(external_acl
* def
, external_acl_entry
* entry
)
854 dlinkDelete(&entry
->lru
, &def
->lru_list
);
855 dlinkAdd(entry
, &entry
->lru
, &def
->lru_list
);
859 makeExternalAclKey(ACLFilledChecklist
* ch
, external_acl_data
* acl_data
)
865 external_acl_format
*format
;
866 HttpRequest
*request
= ch
->request
;
867 HttpReply
*reply
= ch
->reply
;
870 for (format
= acl_data
->def
->format
; format
; format
= format
->next
) {
871 const char *str
= NULL
;
874 switch (format
->type
) {
876 case _external_acl_format::EXT_ACL_LOGIN
:
877 assert (ch
->auth_user_request
!= NULL
);
878 str
= ch
->auth_user_request
->username();
882 case _external_acl_format::EXT_ACL_IDENT
:
886 ch
->changeState(IdentLookup::Instance());
893 case _external_acl_format::EXT_ACL_SRC
:
894 str
= ch
->src_addr
.NtoA(buf
,sizeof(buf
));
897 case _external_acl_format::EXT_ACL_SRCPORT
:
898 snprintf(buf
, sizeof(buf
), "%d", request
->client_addr
.GetPort());
903 case _external_acl_format::EXT_ACL_SRCEUI48
:
904 if (request
->client_eui48
.encode(buf
, sizeof(buf
)))
908 case _external_acl_format::EXT_ACL_SRCEUI64
:
909 if (request
->client_eui64
.encode(buf
, sizeof(buf
)))
914 case _external_acl_format::EXT_ACL_MYADDR
:
915 str
= request
->my_addr
.NtoA(buf
, sizeof(buf
));
918 case _external_acl_format::EXT_ACL_MYPORT
:
919 snprintf(buf
, sizeof(buf
), "%d", request
->my_addr
.GetPort());
923 case _external_acl_format::EXT_ACL_URI
:
924 str
= urlCanonical(request
);
927 case _external_acl_format::EXT_ACL_DST
:
928 str
= request
->GetHost();
931 case _external_acl_format::EXT_ACL_PROTO
:
932 str
= ProtocolStr
[request
->protocol
];
935 case _external_acl_format::EXT_ACL_PORT
:
936 snprintf(buf
, sizeof(buf
), "%d", request
->port
);
940 case _external_acl_format::EXT_ACL_PATH
:
941 str
= request
->urlpath
.termedBuf();
944 case _external_acl_format::EXT_ACL_METHOD
:
945 str
= RequestMethodStr(request
->method
);
948 case _external_acl_format::EXT_ACL_HEADER_REQUEST
:
949 sb
= request
->header
.getByName(format
->header
);
950 str
= sb
.termedBuf();
953 case _external_acl_format::EXT_ACL_HEADER_REQUEST_ID
:
954 sb
= request
->header
.getStrOrList(format
->header_id
);
955 str
= sb
.termedBuf();
958 case _external_acl_format::EXT_ACL_HEADER_REQUEST_MEMBER
:
959 sb
= request
->header
.getByNameListMember(format
->header
, format
->member
, format
->separator
);
960 str
= sb
.termedBuf();
963 case _external_acl_format::EXT_ACL_HEADER_REQUEST_ID_MEMBER
:
964 sb
= request
->header
.getListMember(format
->header_id
, format
->member
, format
->separator
);
965 str
= sb
.termedBuf();
968 case _external_acl_format::EXT_ACL_HEADER_REPLY
:
970 sb
= reply
->header
.getByName(format
->header
);
971 str
= sb
.termedBuf();
975 case _external_acl_format::EXT_ACL_HEADER_REPLY_ID
:
977 sb
= reply
->header
.getStrOrList(format
->header_id
);
978 str
= sb
.termedBuf();
982 case _external_acl_format::EXT_ACL_HEADER_REPLY_MEMBER
:
984 sb
= reply
->header
.getByNameListMember(format
->header
, format
->member
, format
->separator
);
985 str
= sb
.termedBuf();
989 case _external_acl_format::EXT_ACL_HEADER_REPLY_ID_MEMBER
:
991 sb
= reply
->header
.getListMember(format
->header_id
, format
->member
, format
->separator
);
992 str
= sb
.termedBuf();
997 case _external_acl_format::EXT_ACL_USER_CERT_RAW
:
999 if (ch
->conn() != NULL
) {
1000 SSL
*ssl
= fd_table
[ch
->conn()->fd
].ssl
;
1003 str
= sslGetUserCertificatePEM(ssl
);
1008 case _external_acl_format::EXT_ACL_USER_CERTCHAIN_RAW
:
1010 if (ch
->conn() != NULL
) {
1011 SSL
*ssl
= fd_table
[ch
->conn()->fd
].ssl
;
1014 str
= sslGetUserCertificateChainPEM(ssl
);
1019 case _external_acl_format::EXT_ACL_USER_CERT
:
1021 if (ch
->conn() != NULL
) {
1022 SSL
*ssl
= fd_table
[ch
->conn()->fd
].ssl
;
1025 str
= sslGetUserAttribute(ssl
, format
->header
);
1030 case _external_acl_format::EXT_ACL_CA_CERT
:
1032 if (ch
->conn() != NULL
) {
1033 SSL
*ssl
= fd_table
[ch
->conn()->fd
].ssl
;
1036 str
= sslGetCAAttribute(ssl
, format
->header
);
1042 case _external_acl_format::EXT_ACL_EXT_USER
:
1043 str
= request
->extacl_user
.termedBuf();
1046 case _external_acl_format::EXT_ACL_UNKNOWN
:
1048 case _external_acl_format::EXT_ACL_END
:
1049 fatal("unknown external_acl format error");
1063 if (acl_data
->def
->quote
== external_acl::QUOTE_METHOD_URL
) {
1064 const char *quoted
= rfc1738_escape(str
);
1065 mb
.append(quoted
, strlen(quoted
));
1067 strwordquote(&mb
, str
);
1075 for (arg
= acl_data
->arguments
; arg
; arg
= arg
->next
) {
1079 if (acl_data
->def
->quote
== external_acl::QUOTE_METHOD_URL
) {
1080 const char *quoted
= rfc1738_escape(arg
->key
);
1081 mb
.append(quoted
, strlen(quoted
));
1083 strwordquote(&mb
, arg
->key
);
1093 external_acl_entry_expired(external_acl
* def
, external_acl_entry
* entry
)
1095 if (entry
->date
+ (entry
->result
== 1 ? def
->ttl
: def
->negative_ttl
) < squid_curtime
)
1102 external_acl_grace_expired(external_acl
* def
, external_acl_entry
* entry
)
1105 ttl
= entry
->result
== 1 ? def
->ttl
: def
->negative_ttl
;
1106 ttl
= (ttl
* (100 - def
->grace
)) / 100;
1108 if (entry
->date
+ ttl
< squid_curtime
)
1114 static external_acl_entry
*
1115 external_acl_cache_add(external_acl
* def
, const char *key
, ExternalACLEntryData
const & data
)
1117 ExternalACLEntry
*entry
= static_cast<ExternalACLEntry
*>(hash_lookup(def
->cache
, key
));
1118 debugs(82, 2, "external_acl_cache_add: Adding '" << key
<< "' = " << data
.result
);
1121 debugs(82, 3, "ExternalACLEntry::update: updating existing entry");
1122 entry
->update (data
);
1123 external_acl_cache_touch(def
, entry
);
1128 entry
= new ExternalACLEntry
;
1129 entry
->key
= xstrdup(key
);
1130 entry
->update (data
);
1139 external_acl_cache_delete(external_acl
* def
, external_acl_entry
* entry
)
1141 assert (entry
->def
== def
);
1142 hash_remove_link(def
->cache
, entry
);
1143 dlinkDelete(&entry
->lru
, &def
->lru_list
);
1144 def
->cache_entries
-= 1;
1148 /******************************************************************
1149 * external_acl helpers
1152 typedef struct _externalAclState externalAclState
;
1154 struct _externalAclState
{
1156 void *callback_data
;
1160 externalAclState
*queue
;
1163 CBDATA_TYPE(externalAclState
);
1165 free_externalAclState(void *data
)
1167 externalAclState
*state
= static_cast<externalAclState
*>(data
);
1168 safe_free(state
->key
);
1169 cbdataReferenceDone(state
->callback_data
);
1170 cbdataReferenceDone(state
->def
);
1174 * The helper program receives queries on stdin, one
1175 * per line, and must return the result on on stdout
1177 * General result syntax:
1179 * OK/ERR keyword=value ...
1183 * user= The users name (login)
1184 * message= Message describing the reason
1185 * tag= A string tag to be applied to the request that triggered the acl match.
1186 * applies to both OK and ERR responses.
1187 * Won't override existing request tags.
1188 * log= A string to be used in access logging
1190 * Other keywords may be added to the protocol later
1192 * value needs to be enclosed in quotes if it may contain whitespace, or
1193 * the whitespace escaped using \ (\ escaping obviously also applies to
1198 externalAclHandleReply(void *data
, char *reply
)
1200 externalAclState
*state
= static_cast<externalAclState
*>(data
);
1201 externalAclState
*next
;
1206 ExternalACLEntryData entryData
;
1207 entryData
.result
= 0;
1208 external_acl_entry
*entry
= NULL
;
1210 debugs(82, 2, "externalAclHandleReply: reply=\"" << reply
<< "\"");
1213 status
= strwordtok(reply
, &t
);
1215 if (status
&& strcmp(status
, "OK") == 0)
1216 entryData
.result
= 1;
1218 while ((token
= strwordtok(NULL
, &t
))) {
1219 value
= strchr(token
, '=');
1222 *value
++ = '\0'; /* terminate the token, and move up to the value */
1224 if (state
->def
->quote
== external_acl::QUOTE_METHOD_URL
)
1225 rfc1738_unescape(value
);
1227 if (strcmp(token
, "user") == 0)
1228 entryData
.user
= value
;
1229 else if (strcmp(token
, "message") == 0)
1230 entryData
.message
= value
;
1231 else if (strcmp(token
, "error") == 0)
1232 entryData
.message
= value
;
1233 else if (strcmp(token
, "tag") == 0)
1234 entryData
.tag
= value
;
1235 else if (strcmp(token
, "log") == 0)
1236 entryData
.log
= value
;
1237 else if (strcmp(token
, "password") == 0)
1238 entryData
.password
= value
;
1239 else if (strcmp(token
, "passwd") == 0)
1240 entryData
.password
= value
;
1241 else if (strcmp(token
, "login") == 0)
1242 entryData
.user
= value
;
1247 dlinkDelete(&state
->list
, &state
->def
->queue
);
1249 if (cbdataReferenceValid(state
->def
)) {
1251 entry
= external_acl_cache_add(state
->def
, state
->key
, entryData
);
1253 external_acl_entry
*oldentry
= (external_acl_entry
*)hash_lookup(state
->def
->cache
, state
->key
);
1256 external_acl_cache_delete(state
->def
, oldentry
);
1262 cbdataReferenceDone(state
->def
);
1264 if (state
->callback
&& cbdataReferenceValidDone(state
->callback_data
, &cbdata
))
1265 state
->callback(cbdata
, entry
);
1267 next
= state
->queue
;
1276 ACLExternal::ExternalAclLookup(ACLChecklist
*checklist
, ACLExternal
* me
, EAH
* callback
, void *callback_data
)
1279 external_acl_data
*acl
= me
->data
;
1280 external_acl
*def
= acl
->def
;
1281 externalAclState
*state
;
1283 externalAclState
*oldstate
= NULL
;
1286 ACLFilledChecklist
*ch
= Filled(checklist
);
1287 if (acl
->def
->require_auth
) {
1289 /* Make sure the user is authenticated */
1290 debugs(82, 3, "aclMatchExternal: " << acl
->def
->name
<< " check user authenticated.");
1292 if ((ti
= AuthenticateAcl(ch
)) != 1) {
1293 debugs(82, 1, "externalAclLookup: " << acl
->def
->name
<<
1294 " user authentication failure (" << ti
<< ", ch=" << ch
<< ")");
1295 callback(callback_data
, NULL
);
1298 debugs(82, 3, "aclMatchExternal: " << acl
->def
->name
<< " user is authenticated.");
1301 const char *key
= makeExternalAclKey(ch
, acl
);
1304 debugs(82, 1, "externalAclLookup: lookup in '" << def
->name
<<
1305 "', prerequisit failure (ch=" << ch
<< ")");
1306 callback(callback_data
, NULL
);
1310 debugs(82, 2, "externalAclLookup: lookup in '" << def
->name
<< "' for '" << key
<< "'");
1312 external_acl_entry
*entry
= static_cast<external_acl_entry
*>(hash_lookup(def
->cache
, key
));
1314 if (entry
&& external_acl_entry_expired(def
, entry
))
1317 /* Check for a pending lookup to hook into */
1318 for (node
= def
->queue
.head
; node
; node
= node
->next
) {
1319 externalAclState
*oldstatetmp
= static_cast<externalAclState
*>(node
->data
);
1321 if (strcmp(key
, oldstatetmp
->key
) == 0) {
1322 oldstate
= oldstatetmp
;
1327 if (entry
&& external_acl_grace_expired(def
, entry
)) {
1329 debugs(82, 4, "externalAclLookup: in grace period, but already pending lookup ('" << key
<< "', ch=" << ch
<< ")");
1330 callback(callback_data
, entry
);
1333 graceful
= 1; // grace expired, (neg)ttl did not, and we must start a new lookup.
1337 // The entry is in the cache, grace_ttl did not expired.
1338 if (!graceful
&& entry
&& !external_acl_grace_expired(def
, entry
)) {
1339 /* Should not really happen, but why not.. */
1340 callback(callback_data
, entry
);
1341 debugs(82, 4, "externalAclLookup: no lookup pending for '" << key
<< "', and grace not expired");
1342 debugs(82, 4, "externalAclLookup: (what tha' hell?)");
1346 /* No pending lookup found. Sumbit to helper */
1347 state
= cbdataAlloc(externalAclState
);
1349 state
->def
= cbdataReference(def
);
1351 state
->key
= xstrdup(key
);
1354 state
->callback
= callback
;
1355 state
->callback_data
= cbdataReference(callback_data
);
1359 /* Hook into pending lookup */
1360 state
->queue
= oldstate
->queue
;
1361 oldstate
->queue
= state
;
1363 /* Check for queue overload */
1365 if (def
->theHelper
->stats
.queue_size
>= (int)def
->theHelper
->childs
.n_running
) {
1366 debugs(82, 1, "externalAclLookup: '" << def
->name
<< "' queue overload (ch=" << ch
<< ")");
1368 callback(callback_data
, entry
);
1372 /* Send it off to the helper */
1375 buf
.Printf("%s\n", key
);
1377 debugs(82, 4, "externalAclLookup: looking up for '" << key
<< "' in '" << def
->name
<< "'.");
1379 helperSubmit(def
->theHelper
, buf
.buf
, externalAclHandleReply
, state
);
1381 dlinkAdd(state
, &state
->list
, &def
->queue
);
1387 /* No need to wait during grace period */
1388 debugs(82, 4, "externalAclLookup: no need to wait for the result of '" <<
1389 key
<< "' in '" << def
->name
<< "' (ch=" << ch
<< ").");
1390 debugs(82, 4, "externalAclLookup: using cached entry " << entry
);
1392 if (entry
!= NULL
) {
1393 debugs(82, 4, "externalAclLookup: entry = { date=" <<
1394 (long unsigned int) entry
->date
<< ", result=" <<
1395 entry
->result
<< ", user=" << entry
->user
<< " tag=" <<
1396 entry
->tag
<< " log=" << entry
->log
<< " }");
1400 callback(callback_data
, entry
);
1404 debugs(82, 4, "externalAclLookup: will wait for the result of '" << key
<<
1405 "' in '" << def
->name
<< "' (ch=" << ch
<< ").");
1409 externalAclStats(StoreEntry
* sentry
)
1413 for (p
= Config
.externalAclHelperList
; p
; p
= p
->next
) {
1414 storeAppendPrintf(sentry
, "External ACL Statistics: %s\n", p
->name
);
1415 storeAppendPrintf(sentry
, "Cache size: %d\n", p
->cache
->count
);
1416 helperStats(sentry
, p
->theHelper
);
1417 storeAppendPrintf(sentry
, "\n");
1422 externalAclRegisterWithCacheManager(void)
1424 CacheManager::GetInstance()->
1425 registerAction("external_acl",
1426 "External ACL stats",
1427 externalAclStats
, 0, 1);
1431 externalAclInit(void)
1433 static int firstTimeInit
= 1;
1436 for (p
= Config
.externalAclHelperList
; p
; p
= p
->next
) {
1438 p
->cache
= hash_create((HASHCMP
*) strcmp
, hashPrime(1024), hash4
);
1441 p
->theHelper
= new helper(p
->name
);
1443 p
->theHelper
->cmdline
= p
->cmdline
;
1445 p
->theHelper
->childs
= p
->children
;
1447 p
->theHelper
->ipc_type
= IPC_TCP_SOCKET
;
1449 p
->theHelper
->addr
= p
->local_addr
;
1451 helperOpenServers(p
->theHelper
);
1454 if (firstTimeInit
) {
1456 CBDATA_INIT_TYPE_FREECB(externalAclState
, free_externalAclState
);
1459 externalAclRegisterWithCacheManager();
1463 externalAclShutdown(void)
1467 for (p
= Config
.externalAclHelperList
; p
; p
= p
->next
) {
1468 helperShutdown(p
->theHelper
);
1472 ExternalACLLookup
ExternalACLLookup::instance_
;
1474 ExternalACLLookup::Instance()
1480 ExternalACLLookup::checkForAsync(ACLChecklist
*checklist
)const
1482 /* TODO: optimise this - we probably have a pointer to this
1483 * around somewhere */
1484 ACL
*acl
= ACL::FindByName(AclMatchedName
);
1486 ACLExternal
*me
= dynamic_cast<ACLExternal
*> (acl
);
1488 checklist
->asyncInProgress(true);
1489 ACLExternal::ExternalAclLookup(checklist
, me
, LookupDone
, checklist
);
1493 ExternalACLLookup::LookupDone(void *data
, void *result
)
1495 ACLFilledChecklist
*checklist
= Filled(static_cast<ACLChecklist
*>(data
));
1496 checklist
->extacl_entry
= cbdataReference((external_acl_entry
*)result
);
1497 checklist
->asyncInProgress(false);
1498 checklist
->changeState (ACLChecklist::NullState::Instance());
1502 /* This registers "external" in the registry. To do dynamic definitions
1503 * of external ACL's, rather than a static prototype, have a Prototype instance
1504 * prototype in the class that defines each external acl 'class'.
1505 * Then, then the external acl instance is created, it self registers under
1507 * Be sure that clone is fully functional for that acl class though!
1509 ACL::Prototype
ACLExternal::RegistryProtoype(&ACLExternal::RegistryEntry_
, "external");
1511 ACLExternal
ACLExternal::RegistryEntry_("external");
1514 ACLExternal::clone() const
1516 return new ACLExternal(*this);
1519 ACLExternal::ACLExternal (char const *theClass
) : data (NULL
), class_ (xstrdup (theClass
))
1522 ACLExternal::ACLExternal (ACLExternal
const & old
) : data (NULL
), class_ (old
.class_
? xstrdup (old
.class_
) : NULL
)
1524 /* we don't have copy constructors for the data yet */
1529 ACLExternal::typeString() const
1535 ACLExternal::isProxyAuth() const
1537 return data
->def
->require_auth
;