ACLSourceIP Class Reference

#include <SourceIp.h>

Inheritance diagram for ACLSourceIP:

Collaboration diagram for ACLSourceIP:

Public Types
typedef Splay< acl_ip_data * >	IPSplay

Public Member Functions
virtual char const *	typeString () const
virtual int	match (ACLChecklist *checklist)
	Matches the actual data in checklist against this ACL. More...
virtual ACL *	clone () const
void *	operator new (size_t)
void	operator delete (void *)
virtual void	parse ()
	parses node representation in squid.conf; dies on failures More...
virtual SBufList	dump () const
virtual bool	empty () const
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...
virtual bool	isProxyAuth () const
virtual bool	valid () const
int	cacheMatchAcl (dlink_list *cache, ACLChecklist *)
virtual int	matchForCache (ACLChecklist *checklist)
virtual void	prepareForUse ()
SBufList	dumpOptions ()

Static Public Member Functions
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 Member Functions
int	match (const Ip::Address &)

Protected Attributes
IPSplay *	data

Private Member Functions
	MEMPROXY_CLASS (ACLSourceIP)
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	requiresReply () const
	whether our (i.e. shallow) match() requires checklist to have a reply More...

Detailed Description

Definition at line 14 of file SourceIp.h.

Member Typedef Documentation

IPSplay

typedef Splay<acl_ip_data *> ACLIP::IPSplay

inherited

Definition at line 53 of file Ip.h.

Member Function Documentation

cacheMatchAcl()

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

inherited

Definition at line 333 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().

clone()

ACL * ACLSourceIP::clone ( ) const

virtual

Definition at line 28 of file SourceIp.cc.

context()

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

inherited

Definition at line 154 of file Acl.cc.

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

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

dump()

SBufList ACLIP::dump ( ) const

virtualinherited

Implements ACL.

Definition at line 510 of file Ip.cc.

References IpAclDumpVisitor::contents, ACLIP::data, and Splay< V >::visit().

dumpOptions()

SBufList ACL::dumpOptions ( )

inherited

Returns

approximate options configuration

Definition at line 296 of file Acl.cc.

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

Referenced by dump_acl().

empty()

bool ACLIP::empty ( ) const

virtualinherited

Implements ACL.

Definition at line 518 of file Ip.cc.

References ACLIP::data, and Splay< V >::empty().

FindByName()

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

staticinherited

Definition at line 92 of file Acl.cc.

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

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

Initialize()

void ACL::Initialize ( )

staticinherited

Definition at line 404 of file Acl.cc.

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

Referenced by serverConnectionsOpen().

isProxyAuth()

bool ACL::isProxyAuth ( ) const

virtualinherited

Reimplemented in ACLIdent, ACLExternal, and ACLProxyAuth.

Definition at line 283 of file Acl.cc.

Referenced by aclIsProxyAuth().

match() [1/2]

int ACLSourceIP::match ( ACLChecklist *  checklist )

virtual

Implements ACLIP.

Definition at line 22 of file SourceIp.cc.

References Filled(), and ACLIP::match().

match() [2/2]

int ACLIP::match ( const Ip::Address &  clientip )

protectedinherited

Definition at line 524 of file Ip.cc.

References aclIpAddrNetworkCompare(), acl_ip_data::addr1, acl_ip_data::addr2, ACLIP::data, debugs, Splay< V >::find(), acl_ip_data::mask, NULL, and Ip::Address::setEmpty().

matches()

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 120 of file Acl.cc.

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

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

matchForCache()

int ACL::matchForCache ( ACLChecklist *  checklist )

virtualinherited

Reimplemented in ACLProxyAuth.

Definition at line 315 of file Acl.cc.

References fatal().

Referenced by ACL::cacheMatchAcl().

MEMPROXY_CLASS()

ACLSourceIP::MEMPROXY_CLASS ( ACLSourceIP  )

private

operator delete()

void ACLIP::operator delete ( void *  )

inherited

Definition at line 29 of file Ip.cc.

References fatal().

operator new()

void * ACLIP::operator new ( size_t  )

inherited

Definition at line 22 of file Ip.cc.

References fatal().

options()

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

inlinevirtualinherited

Returns

(linked) Options supported by this ACL

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

Definition at line 63 of file Acl.h.

References Acl::NoOptions().

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

parse()

void ACLIP::parse ( )

virtualinherited

Implements ACL.

Definition at line 475 of file Ip.cc.

References ACLIP::data, acl_ip_data::FactoryParse(), Splay< V >::find(), Splay< V >::insert(), acl_ip_data::NetworkCompare(), acl_ip_data::next, NULL, and ConfigParser::strtokFile().

ParseAclLine()

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

staticinherited

Definition at line 165 of file Acl.cc.

References A, ACL_NAME_SZ, SquidConfig::aclList, AclMatchedName, aclRegister(), assert, Config, config_input_line, DBG_CRITICAL, DBG_IMPORTANT, DBG_PARSE_NOTE, debugs, ConfigParser::destruct(), fatalf(), ACL::FindByName(), head, HttpPortList, LOCAL_ARRAY, Acl::Make(), ConfigParser::NextToken(), NULL, and xstrncpy().

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

parseFlags()

void ACL::parseFlags ( )

virtualinherited

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

Definition at line 289 of file Acl.cc.

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

prepareForUse()

virtual void ACL::prepareForUse ( )

inlinevirtualinherited

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

Definition at line 79 of file Acl.h.

Referenced by ACL::Initialize().

requiresAle()

bool ACL::requiresAle ( ) const

privatevirtualinherited

Reimplemented in ACLExternal.

Definition at line 375 of file Acl.cc.

Referenced by ACL::matches().

requiresReply()

bool ACL::requiresReply ( ) const

privatevirtualinherited

Reimplemented in ACLStrategised< M >, and ACLHTTPStatus.

Definition at line 381 of file Acl.cc.

Referenced by ACL::matches().

requiresRequest()

bool ACL::requiresRequest ( ) const

privatevirtualinherited

Reimplemented in ACLExternal, ACLProxyAuth, ACLMaxUserIP, Acl::TransactionInitiator, and ACLStrategised< M >.

Definition at line 387 of file Acl.cc.

Referenced by ACL::matches().

typeString()

char const * ACLSourceIP::typeString ( ) const

virtual

Implements ACLIP.

Definition at line 16 of file SourceIp.cc.

valid()

bool ACL::valid ( ) const

virtualinherited

Reimplemented in ACLExternal, ACLProxyAuth, ACLMaxUserIP, ACLStrategised< M >, ACLRandom, and ACLMaxConnection.

Definition at line 114 of file Acl.cc.

Member Data Documentation

cfgline

char* ACL::cfgline

inherited

Definition at line 84 of file Acl.h.

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

data

IPSplay* ACLIP::data

protectedinherited

Definition at line 65 of file Ip.h.

Referenced by ACLIP::~ACLIP(), ACLIP::dump(), ACLIP::empty(), ACLIP::match(), and ACLIP::parse().

name

char ACL::name[ACL_NAME_SZ]

inherited

Definition at line 83 of file Acl.h.

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

next

ACL* ACL::next

inherited

Definition at line 85 of file Acl.h.

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

registered

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/acl/SourceIp.h
• src/acl/SourceIp.cc