ACLExternal Class Reference

#include <ExternalACL.h>

Inheritance diagram for ACLExternal:

Collaboration diagram for ACLExternal:

Public Member Functions
	ACLExternal (char const *)
	ACLExternal (ACLExternal const &)
	~ACLExternal ()
ACLExternal &	operator= (ACLExternal const &)
virtual ACL *	clone () const
virtual char const *	typeString () const
virtual void	parse ()
	parses node represenation in squid.conf; dies on failures More...
virtual int	match (ACLChecklist *checklist)
	Matches the actual data in checklist against this ACL. More...
virtual bool	requiresAle () const
	whether our (i.e. shallow) match() requires checklist to have a AccessLogEntry More...
virtual bool	requiresRequest () const
	whether our (i.e. shallow) match() requires checklist to have a request More...
virtual bool	isProxyAuth () const
virtual SBufList	dump () const
virtual bool	valid () const
virtual bool	empty () const
void *	operator new (size_t)
void	operator delete (void *)
void	context (const char *name, const char *configuration)
	sets user-specified ACL name and squid.conf context More...
bool	matches (ACLChecklist *checklist) const
virtual const Acl::Options &	options ()
virtual void	parseFlags ()
	configures ACL options, throwing on configuration errors More...
int	cacheMatchAcl (dlink_list *cache, ACLChecklist *)
virtual int	matchForCache (ACLChecklist *checklist)
virtual void	prepareForUse ()
SBufList	dumpOptions ()

Static Public Member Functions
static void	ExternalAclLookup (ACLChecklist *ch, ACLExternal *)
static void	ParseAclLine (ConfigParser &parser, ACL **head)
static void	Initialize ()
static ACL *	FindByName (const char *name)

Public Attributes
char	name [ACL_NAME_SZ]
char *	cfgline
ACL *	next
bool	registered
	added to the global list of ACLs via aclRegister() More...

Protected Attributes
external_acl_data *	data
char const *	class_

Private Member Functions
	MEMPROXY_CLASS (ACLExternal)

Detailed Description

Definition at line 37 of file ExternalACL.h.

Constructor & Destructor Documentation

ACLExternal::ACLExternal

(

char const *

theClass

)

Definition at line 1177 of file external_acl.cc.

Referenced by clone().

ACLExternal::ACLExternal

(

ACLExternal const &

old

)

Definition at line 1180 of file external_acl.cc.

References assert, and data.

ACLExternal::~ACLExternal

(

)

Definition at line 566 of file external_acl.cc.

References class_, data, and xfree.

Member Function Documentation

int ACL::cacheMatchAcl ( dlink_list *  cache, ACLChecklist *  checklist  )

inherited

Definition at line 336 of file Acl.cc.

References acl_proxy_auth_match_cache::acl_data, dlink_node::data, debugs, dlinkAddTail(), dlink_list::head, acl_proxy_auth_match_cache::link, ACL::matchForCache(), acl_proxy_auth_match_cache::matchrv, ACL::name, and dlink_node::next.

Referenced by ACLProxyAuth::matchProxyAuth().

ACL * ACLExternal::clone ( ) const

virtual

Definition at line 1172 of file external_acl.cc.

References ACLExternal().

void ACL::context ( const char *  name, const char *  configuration  )

inherited

Definition at line 157 of file Acl.cc.

References ACL_NAME_SZ, ACL::cfgline, ACL::name, safe_free, xstrdup, and xstrncpy().

Referenced by aclParseAccessLine(), aclParseAclList(), Acl::AllOf::parse(), ACL::ParseAclLine(), and ParseAclWithAction().

SBufList ACLExternal::dump ( ) const

virtual

Implements ACL.

Definition at line 730 of file external_acl.cc.

References arg, external_acl_data::arguments, data, external_acl_data::def, external_acl::name, and SBuf::Printf().

SBufList ACL::dumpOptions ( )

inherited

Returns

approximate options configuration

Definition at line 299 of file Acl.cc.

References SBufStream::buf(), SBuf::isEmpty(), and ACL::options().

Referenced by dump_acl().

bool ACLExternal::empty ( ) const

virtual

Implements ACL.

Definition at line 561 of file external_acl.cc.

void ACLExternal::ExternalAclLookup ( ACLChecklist *  ch, ACLExternal *  me  )

static

Definition at line 1016 of file external_acl.cc.

References data, and ExternalACLLookup::Start().

Referenced by ExternalACLLookup::checkForAsync().

ACL * ACL::FindByName ( const char *  name )

staticinherited

Definition at line 93 of file Acl.cc.

References a, SquidConfig::aclList, Config, debugs, ACL::name, ACL::next, and NULL.

Referenced by aclIsProxyAuth(), ExternalACLLookup::checkForAsync(), Acl::InnerNode::lineParse(), parse_ftp_epsv(), and ACL::ParseAclLine().

void ACL::Initialize ( )

staticinherited

Definition at line 407 of file Acl.cc.

References a, SquidConfig::aclList, Config, debugs, ACL::next, and ACL::prepareForUse().

Referenced by serverConnectionsOpen().

bool ACLExternal::isProxyAuth ( ) const

virtual

Reimplemented from ACL.

Definition at line 1193 of file external_acl.cc.

References data, external_acl_data::def, and external_acl::require_auth.

int ACLExternal::match ( ACLChecklist *  checklist )

virtual

Implements ACL.

Definition at line 706 of file external_acl.cc.

References ACCESS_ALLOWED, ACCESS_AUTH_REQUIRED, ACCESS_DENIED, ACCESS_DUNNO, aclMatchExternal(), data, Filled(), ACLChecklist::keepMatching(), and ACLChecklist::markFinished().

bool ACL::matches ( ACLChecklist *  checklist ) const

inherited

Orchestrates matching checklist against the ACL using match(), after checking preconditions and while providing debugging.

Returns

true if and only if there was a successful match. Updates the checklist state on match, async, and failure.

Definition at line 121 of file Acl.cc.

References AclMatchedName, ACLChecklist::asyncInProgress(), DBG_IMPORTANT, debugs, ACLChecklist::hasAle(), ACLChecklist::hasReply(), ACLChecklist::hasRequest(), ACL::match(), ACL::name, PROF_start, PROF_stop, ACL::requiresAle(), ACL::requiresReply(), ACL::requiresRequest(), and ACLChecklist::verifyAle().

Referenced by ACLChecklist::matchAndFinish(), and ACLChecklist::matchChild().

int ACL::matchForCache ( ACLChecklist *  checklist )

virtualinherited

Reimplemented in ACLProxyAuth.

Definition at line 318 of file Acl.cc.

References fatal().

Referenced by ACL::cacheMatchAcl().

ACLExternal::MEMPROXY_CLASS ( ACLExternal  )

private

void ACL::operator delete ( void *  )

inherited

Definition at line 87 of file Acl.cc.

References fatal().

void * ACL::operator new ( size_t  )

inherited

Definition at line 80 of file Acl.cc.

References fatal().

ACLExternal& ACLExternal::operator=

(

ACLExternal const &

)

virtual const Acl::Options& ACL::options ( )

inlinevirtualinherited

Returns

(linked) Options supported by this ACL

Reimplemented in ACLStrategised< M >, ACLDestinationIP, and ACLMaxUserIP.

Definition at line 63 of file Acl.h.

References Acl::NoOptions().

Referenced by ACL::dumpOptions(), and ACL::parseFlags().

void ACLExternal::parse ( )

virtual

Implements ACL.

Definition at line 509 of file external_acl.cc.

References AclMatchedName, external_acl_data::arguments, data, external_acl_data::def, find_externalAclHelper(), external_acl_data::name, self_destruct(), ConfigParser::strtokFile(), wordlistAdd(), and xstrdup.

void ACL::ParseAclLine ( ConfigParser &  parser, ACL **  head  )

staticinherited

Definition at line 168 of file Acl.cc.

References A, ACL_NAME_SZ, SquidConfig::aclList, AclMatchedName, aclRegister(), assert, ACL::cfgline, Config, config_input_line, ACL::context(), DBG_CRITICAL, DBG_IMPORTANT, DBG_PARSE_NOTE, debugs, ConfigParser::destruct(), ACL::empty(), fatalf(), ACL::FindByName(), head, HttpPortList, LOCAL_ARRAY, Acl::Make(), ACL::name, ACL::next, ConfigParser::NextToken(), NULL, p, ACL::parse(), ACL::parseFlags(), ACL::typeString(), ACL::valid(), and xstrncpy().

Referenced by parse_acl(), and testACLMaxUserIP::testParseLine().

void ACL::parseFlags ( )

virtualinherited

Reimplemented in ACLIdent, ACLProxyAuth, ACLStrategised< M >, and ACLExtUser.

Definition at line 292 of file Acl.cc.

References Acl::NoFlags(), ACL::options(), and Acl::ParseFlags().

Referenced by ACL::ParseAclLine().

virtual void ACL::prepareForUse ( )

inlinevirtualinherited

Reimplemented in ACLStrategised< M >, Acl::InnerNode, and ACLMaxConnection.

Definition at line 79 of file Acl.h.

Referenced by ACL::Initialize().

virtual bool ACLExternal::requiresAle ( ) const

inlinevirtual

Reimplemented from ACL.

Definition at line 54 of file ExternalACL.h.

virtual bool ACLExternal::requiresRequest ( ) const

inlinevirtual

Reimplemented from ACL.

Definition at line 55 of file ExternalACL.h.

char const * ACLExternal::typeString ( ) const

virtual

Implements ACL.

Definition at line 1187 of file external_acl.cc.

References class_.

bool ACLExternal::valid ( ) const

virtual

Reimplemented from ACL.

Definition at line 541 of file external_acl.cc.

References authenticateActiveSchemeCount(), authenticateSchemeCount(), data, DBG_CRITICAL, debugs, external_acl_data::def, and external_acl::require_auth.

Member Data Documentation

char* ACL::cfgline

inherited

Definition at line 84 of file Acl.h.

Referenced by ACL::context(), Acl::AllOf::parse(), ACL::ParseAclLine(), and ACL::~ACL().

char const* ACLExternal::class_

protected

Definition at line 66 of file ExternalACL.h.

Referenced by typeString(), and ~ACLExternal().

external_acl_data* ACLExternal::data

protected

Definition at line 65 of file ExternalACL.h.

Referenced by ACLExternal(), dump(), ExternalAclLookup(), isProxyAuth(), match(), parse(), valid(), and ~ACLExternal().

char ACL::name[ACL_NAME_SZ]

inherited

Definition at line 83 of file Acl.h.

Referenced by ACL::ACL(), ACL::cacheMatchAcl(), ACL::context(), dump_acl(), ACL::FindByName(), ACLRandom::match(), ACLDestinationIP::match(), ACL::matches(), Acl::NotNode::NotNode(), ACL::ParseAclLine(), ACLMaxConnection::prepareForUse(), and ACL::~ACL().

ACL* ACL::next

inherited

Definition at line 85 of file Acl.h.

Referenced by dump_acl(), ACL::FindByName(), ACL::Initialize(), and ACL::ParseAclLine().

bool ACL::registered

inherited

Definition at line 86 of file Acl.h.

Referenced by aclDeregister(), aclDestroyAcls(), and aclRegister().

---

The documentation for this class was generated from the following files:

• src/ExternalACL.h
• src/external_acl.cc