external_acl.cc File Reference

#include "squid.h"
#include "acl/Acl.h"
#include "acl/FilledChecklist.h"
#include "cache_cf.h"
#include "client_side.h"
#include "client_side_request.h"
#include "comm/Connection.h"
#include "ConfigParser.h"
#include "ExternalACL.h"
#include "ExternalACLEntry.h"
#include "fde.h"
#include "format/Token.h"
#include "helper.h"
#include "helper/Reply.h"
#include "http/Stream.h"
#include "HttpHeaderTools.h"
#include "HttpReply.h"
#include "HttpRequest.h"
#include "ip/tools.h"
#include "MemBuf.h"
#include "mgr/Registration.h"
#include "rfc1738.h"
#include "SquidConfig.h"
#include "SquidString.h"
#include "SquidTime.h"
#include "Store.h"
#include "tools.h"
#include "wordlist.h"
#include "ssl/ServerBump.h"
#include "ssl/support.h"
#include "auth/Acl.h"
#include "auth/Gadgets.h"
#include "auth/UserRequest.h"
#include "ident/AclIdent.h"

Include dependency graph for external_acl.cc:

Go to the source code of this file.

Classes
class	external_acl
class	external_acl_data
class	externalAclState

Macros
#define	DEFAULT_EXTERNAL_ACL_TTL   1 * 60 * 60
#define	DEFAULT_EXTERNAL_ACL_CHILDREN   5

Functions
static char *	makeExternalAclKey (ACLFilledChecklist *ch, external_acl_data *acl_data)
static void	external_acl_cache_delete (external_acl *def, const ExternalACLEntryPointer &entry)
static int	external_acl_entry_expired (external_acl *def, const ExternalACLEntryPointer &entry)
static int	external_acl_grace_expired (external_acl *def, const ExternalACLEntryPointer &entry)
static void	external_acl_cache_touch (external_acl *def, const ExternalACLEntryPointer &entry)
static ExternalACLEntryPointer	external_acl_cache_add (external_acl *def, const char *key, ExternalACLEntryData const &data)
void	parse_externalAclHelper (external_acl **list)
void	dump_externalAclHelper (StoreEntry *sentry, const char *name, const external_acl *list)
void	free_externalAclHelper (external_acl **list)
static external_acl *	find_externalAclHelper (const char *name)
static void	copyResultsFromEntry (HttpRequest *req, const ExternalACLEntryPointer &entry)
static allow_t	aclMatchExternal (external_acl_data *acl, ACLFilledChecklist *ch)
static void	externalAclHandleReply (void *data, const Helper::Reply &reply)
static void	externalAclStats (StoreEntry *sentry)
static void	externalAclRegisterWithCacheManager (void)
void	externalAclInit (void)
void	externalAclShutdown (void)

Macro Definition Documentation

DEFAULT_EXTERNAL_ACL_CHILDREN

#define DEFAULT_EXTERNAL_ACL_CHILDREN   5

Definition at line 56 of file external_acl.cc.

Referenced by dump_externalAclHelper().

DEFAULT_EXTERNAL_ACL_TTL

#define DEFAULT_EXTERNAL_ACL_TTL   1 * 60 * 60

Definition at line 53 of file external_acl.cc.

Referenced by dump_externalAclHelper().

Function Documentation

aclMatchExternal()

static allow_t aclMatchExternal ( external_acl_data *  acl, ACLFilledChecklist *  ch  )

static

Definition at line 598 of file external_acl.cc.

References ACCESS_DUNNO, allow_t::allowed(), AuthenticateAcl(), external_acl::cache, copyResultsFromEntry(), ExternalACLEntry::date, DBG_IMPORTANT, debugs, ExternalACLEntry::def, external_acl_data::def, ACLFilledChecklist::extacl_entry, external_acl_cache_touch(), external_acl_entry_expired(), external_acl_grace_expired(), external_acl_message, ACLChecklist::goAsync(), hash_lookup(), HERE(), ExternalACLLookup::Instance(), hash_link::key, ExternalACLEntry::log, makeExternalAclKey(), ExternalACLEntry::message, external_acl::name, NULL, ACLFilledChecklist::request, external_acl::require_auth, ExternalACLEntry::result, ExternalACLLookup::Start(), ExternalACLEntry::tag, String::termedBuf(), external_acl::theHelper, ExternalACLEntry::user, and helper::willOverload().

Referenced by ACLExternal::match().

copyResultsFromEntry()

static void copyResultsFromEntry ( HttpRequest *  req, const ExternalACLEntryPointer &  entry  )

static

Definition at line 573 of file external_acl.cc.

References HttpRequest::clientConnectionManager, HttpRequest::extacl_log, HttpRequest::extacl_message, HttpRequest::extacl_passwd, HttpRequest::extacl_user, CbcPointer< Cbc >::get(), ExternalACLEntry::log, ExternalACLEntry::message, ExternalACLEntry::notes, ExternalACLEntry::password, String::size(), ExternalACLEntry::tag, HttpRequest::tag, UpdateRequestNotes(), and ExternalACLEntry::user.

Referenced by aclMatchExternal().

dump_externalAclHelper()

void dump_externalAclHelper	(	StoreEntry *	sentry,
		const char *	name,
		const external_acl *	list
	)

Definition at line 375 of file external_acl.cc.

References external_acl::cache, external_acl::cache_size, external_acl::children, external_acl::cmdline, Helper::ChildConfig::concurrency, DEFAULT_EXTERNAL_ACL_CHILDREN, DEFAULT_EXTERNAL_ACL_TTL, Format::Format::dump(), external_acl::format, external_acl::grace, Ip::Address::isIPv6(), wordlist::key, external_acl::local_addr, Format::LOG_QUOTE_SHELL, Helper::ChildConfig::n_idle, Helper::ChildConfig::n_max, Helper::ChildConfig::n_startup, external_acl::name, external_acl::negative_ttl, wordlist::next, external_acl::next, NULL, external_acl::quote, storeAppendPrintf(), and external_acl::ttl.

external_acl_cache_add()

static ExternalACLEntryPointer external_acl_cache_add ( external_acl *  def, const char *  key, ExternalACLEntryData const &  data  )

static

Definition at line 845 of file external_acl.cc.

References ACCESS_DUNNO, external_acl::add(), external_acl::cache, debugs, ExternalACLEntry::def, external_acl_cache_delete(), external_acl_cache_touch(), hash_lookup(), HERE(), hash_link::key, external_acl::maybeCacheable(), NULL, ExternalACLEntryData::result, ExternalACLEntry::update(), and xstrdup.

Referenced by externalAclHandleReply().

external_acl_cache_delete()

static void external_acl_cache_delete ( external_acl *  def, const ExternalACLEntryPointer &  entry  )

static

Definition at line 883 of file external_acl.cc.

References assert, external_acl::cache, external_acl::cache_entries, external_acl::cache_size, ExternalACLEntry::def, dlinkDelete(), RefCount< C >::getRaw(), hash_remove_link(), ExternalACLEntry::lru, external_acl::lru_list, and NULL.

Referenced by external_acl_cache_add(), external_acl::trimCache(), and external_acl::~external_acl().

external_acl_cache_touch()

static void external_acl_cache_touch ( external_acl *  def, const ExternalACLEntryPointer &  entry  )

static

Definition at line 750 of file external_acl.cc.

References dlinkAdd(), dlinkDelete(), RefCount< C >::getRaw(), ExternalACLEntry::lru, external_acl::lru_list, external_acl::maybeCacheable(), and ExternalACLEntry::result.

Referenced by aclMatchExternal(), and external_acl_cache_add().

external_acl_entry_expired()

static int external_acl_entry_expired ( external_acl *  def, const ExternalACLEntryPointer &  entry  )

static

Definition at line 817 of file external_acl.cc.

References ACCESS_DUNNO, allow_t::allowed(), external_acl::cache_size, ExternalACLEntry::date, external_acl::negative_ttl, ExternalACLEntry::result, squid_curtime, and external_acl::ttl.

Referenced by aclMatchExternal().

external_acl_grace_expired()

static int external_acl_grace_expired ( external_acl *  def, const ExternalACLEntryPointer &  entry  )

static

Definition at line 829 of file external_acl.cc.

References ACCESS_DUNNO, allow_t::allowed(), external_acl::cache_size, ExternalACLEntry::date, external_acl::grace, external_acl::negative_ttl, ExternalACLEntry::result, squid_curtime, and external_acl::ttl.

Referenced by aclMatchExternal().

externalAclHandleReply()

static void externalAclHandleReply ( void *  data, const Helper::Reply &  reply  )

static

Definition at line 952 of file external_acl.cc.

References ACCESS_ALLOWED, ACCESS_DENIED, ACCESS_DUNNO, NotePairs::append(), externalAclState::callback, externalAclState::callback_data, cbdataReferenceValid(), cbdataReferenceValidDone, data, debugs, externalAclState::def, dlinkDelete(), Helper::Error, external_acl_cache_add(), NotePairs::findFirst(), HERE(), externalAclState::key, externalAclState::list, ExternalACLEntryData::log, ExternalACLEntryData::message, external_acl::next, ExternalACLEntryData::notes, Helper::Reply::notes, NULL, Helper::Okay, ExternalACLEntryData::password, external_acl::queue, externalAclState::queue, ExternalACLEntryData::result, Helper::Reply::result, ExternalACLEntryData::tag, and ExternalACLEntryData::user.

Referenced by ExternalACLLookup::Start().

externalAclInit()

void externalAclInit

(

void

)

Definition at line 1110 of file external_acl.cc.

References Config, SquidConfig::externalAclHelperList, externalAclRegisterWithCacheManager(), hash4, hash_create(), hashPrime(), helperOpenServers(), IPC_TCP_SOCKET, and p.

Referenced by mainInitialize(), mainReconfigureFinish(), and mainRotate().

externalAclRegisterWithCacheManager()

static void externalAclRegisterWithCacheManager ( void  )

static

Definition at line 1102 of file external_acl.cc.

References externalAclStats(), and Mgr::RegisterAction().

Referenced by externalAclInit().

externalAclShutdown()

void externalAclShutdown

(

void

)

Definition at line 1134 of file external_acl.cc.

References Config, SquidConfig::externalAclHelperList, helperShutdown(), ExternalACLLookup::instance_, external_acl::next, p, and external_acl::theHelper.

Referenced by mainReconfigureStart(), mainRotate(), and SquidShutdown().

externalAclStats()

static void externalAclStats ( StoreEntry *  sentry )

static

Definition at line 1090 of file external_acl.cc.

References assert, Config, SquidConfig::externalAclHelperList, p, and storeAppendPrintf().

Referenced by externalAclRegisterWithCacheManager().

find_externalAclHelper()

static external_acl* find_externalAclHelper ( const char *  name )

static

Definition at line 432 of file external_acl.cc.

References Config, SquidConfig::externalAclHelperList, external_acl::name, external_acl::next, and NULL.

Referenced by ACLExternal::parse().

free_externalAclHelper()

void free_externalAclHelper

(

external_acl **

list

)

Definition at line 425 of file external_acl.cc.

References NULL.

makeExternalAclKey()

static char * makeExternalAclKey ( ACLFilledChecklist *  ch, external_acl_data *  acl_data  )

static

Definition at line 762 of file external_acl.cc.

References ACLFilledChecklist::al, SBuf::append(), arg, external_acl_data::arguments, Format::Format::assemble(), MemBuf::buf, MemBuf::clean(), external_acl_data::def, Format::Format::format, external_acl::format, ACLChecklist::goAsync(), MemBuf::init(), IdentLookup::Instance(), AccessLogEntry::lastAclData, AccessLogEntry::lastAclName, SBuf::length(), Format::LFT_EXT_ACL_DATA, Format::LFT_EXT_ACL_NAME, Format::LFT_USER_IDENT, Format::LOG_QUOTE_URL, external_acl_data::name, Format::Token::next, NULL, external_acl::quote, MemBuf::reset(), rfc1738_escape, ACLFilledChecklist::rfc931, safe_free, sb, MemBuf::size, strwordquote(), and xstrdup.

Referenced by aclMatchExternal(), and ExternalACLLookup::Start().

parse_externalAclHelper()

void parse_externalAclHelper

(

external_acl **

list

)

Definition at line 180 of file external_acl.cc.