#include <DestinationIp.h>

Inheritance diagram for ACLDestinationIP:

Collaboration diagram for ACLDestinationIP:

Public Types
typedef Splay< acl_ip_data * >	IPSplay

using	Pointer = RefCount< Node >

Public Member Functions
char const *	typeString () const override

const Acl::Options &	options () override

int	match (ACLChecklist *checklist) override
	Matches the actual data in checklist against this Acl::Node.

void *	operator new (size_t)

void	operator delete (void *)

void	parse () override
	parses node representation in squid.conf; dies on failures

SBufList	dump () const override

bool	empty () const override

void	context (const SBuf &aName, const char *configuration)
	sets user-specified ACL name and squid.conf context

bool	matches (ACLChecklist *checklist) const

void	parseFlags ()
	configures Acl::Node options, throwing on configuration errors

virtual bool	isProxyAuth () const

virtual bool	valid () const

int	cacheMatchAcl (dlink_list cache, ACLChecklist )

virtual int	matchForCache (ACLChecklist *checklist)

virtual void	prepareForUse ()

void	dumpWhole (const char *directiveName, std::ostream &)

Static Public Member Functions
static void	StartLookup (ACLFilledChecklist &, const Acl::Node &)

static void	ParseNamedAcl (ConfigParser &, NamedAcls *&)
	parses acl directive parts that follow directive name (i.e. "acl")

static void	Initialize ()

static Acl::Node *	FindByName (const SBuf &)
	A configured ACL with a given name or nil.

Public Attributes
SBuf	name

char *	cfgline = nullptr

Protected Member Functions
int	match (const Ip::Address &)

Protected Attributes
IPSplay *	data

Private Member Functions
	MEMPROXY_CLASS (ACLDestinationIP)

bool	parseGlobal (const char *)

virtual bool	requiresAle () const
	whether our (i.e. shallow) match() requires checklist to have a AccessLogEntry

virtual bool	requiresRequest () const
	whether our (i.e. shallow) match() requires checklist to have a request

virtual bool	requiresReply () const
	whether our (i.e. shallow) match() requires checklist to have a reply

virtual const Acl::Options &	lineOptions ()

Static Private Member Functions
static void	LookupDone (const ipcache_addrs , const Dns::LookupDetails &, void data)

static void	ParseNamed (ConfigParser &, NamedAcls &, const SBuf &name)
	parses acl directive parts that follow aclname

Private Attributes
Acl::BooleanOptionValue	lookupBanned
	are DNS lookups allowed?

bool	matchAnyIpv4 = false
	whether match() should return 1 for any IPv4 parameter

bool	matchAnyIpv6 = false
	whether match() should return 1 for any IPv6 parameter

Detailed Description

Definition at line 16 of file DestinationIp.h.

Member Typedef Documentation

◆ IPSplay

typedef Splay<acl_ip_data *> ACLIP::IPSplay

inherited

Definition at line 60 of file Ip.h.

◆ Pointer

using Acl::Node::Pointer = RefCount<Node>

inherited

Definition at line 29 of file Node.h.

Member Function Documentation

◆ cacheMatchAcl()

int Acl::Node::cacheMatchAcl	(	dlink_list *	cache,
		ACLChecklist *	checklist
	)

inherited

Definition at line 401 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_proxy_auth_match_cache::matchrv, and dlink_node::next.

Referenced by ACLProxyAuth::matchProxyAuth().

◆ context()

void Acl::Node::context	(	const SBuf &	aName,
		const char *	configuration
	)

inherited

Definition at line 220 of file Acl.cc.

References safe_free, and xstrdup.

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

◆ dump()

SBufList ACLIP::dump ( ) const

overridevirtualinherited

Implements Acl::Node.

Definition at line 509 of file Ip.cc.

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

◆ dumpWhole()

void Acl::Node::dumpWhole	(	const char *	directiveName,
		std::ostream &	os
	)

inherited

Prints aggregated "acl" (or similar) directive configuration, including the given directive name, ACL name, ACL type, and ACL parameters. The printed parameters are collected from all same-name "acl" directives.

Definition at line 371 of file Acl.cc.

References asList().

◆ empty()

bool ACLIP::empty ( ) const

overridevirtualinherited

Implements Acl::Node.

Definition at line 525 of file Ip.cc.

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

◆ FindByName()

Acl::Node * Acl::Node::FindByName ( const SBuf & name )

staticinherited

Definition at line 159 of file Acl.cc.

References assert, Config, debugs, and SquidConfig::namedAcls.

Referenced by aclIsProxyAuth(), Acl::InnerNode::lineParse(), parse_ftp_epsv(), and TestACLMaxUserIP::testParseLine().

◆ Initialize()

void Acl::Node::Initialize ( )

staticinherited

Definition at line 471 of file Acl.cc.

References Config, debugs, and SquidConfig::namedAcls.

Referenced by serverConnectionsOpen().

◆ isProxyAuth()

bool Acl::Node::isProxyAuth ( ) const

virtualinherited

Reimplemented in ACLProxyAuth, and ACLExternal.

Definition at line 354 of file Acl.cc.

◆ lineOptions()

virtual const Acl::Options & Acl::Node::lineOptions ( )

inlineprivatevirtualinherited

Returns: (linked) "line" Options supported by this Acl::Node

See also: Acl::Node::options()

Definition at line 102 of file Node.h.

References Acl::NoOptions().

◆ LookupDone()

void ACLDestinationIP::LookupDone	(	const ipcache_addrs *	,
		const Dns::LookupDetails &	details,
		void *	data
	)

staticprivate

Definition at line 94 of file DestinationIp.cc.

References ACLIP::data, RequestFlags::destinationIpLookedUp, Filled(), HttpRequest::flags, HttpRequest::recordLookup(), ACLFilledChecklist::request, and ACLChecklist::resumeNonBlockingCheck().

Referenced by StartLookup().

◆ match() [1/2]

int ACLDestinationIP::match ( ACLChecklist * checklist )

overridevirtual

◆ match() [2/2]

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

protectedinherited

Definition at line 531 of file Ip.cc.

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

◆ matches()

bool Acl::Node::matches ( ACLChecklist * checklist ) const

inherited

Orchestrates matching checklist against the Acl::Node 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 189 of file Acl.cc.

References ACLChecklist::asyncInProgress(), DBG_IMPORTANT, debugs, ACLChecklist::hasAle(), ACLChecklist::hasReply(), ACLChecklist::hasRequest(), ACLChecklist::setLastCheckedName(), and ACLChecklist::verifyAle().

Referenced by ACLChecklist::matchAndFinish().

◆ matchForCache()

int Acl::Node::matchForCache ( ACLChecklist * checklist )

virtualinherited

Reimplemented in ACLProxyAuth.

Definition at line 383 of file Acl.cc.

References fatal().

◆ MEMPROXY_CLASS()

ACLDestinationIP::MEMPROXY_CLASS ( ACLDestinationIP )

private

◆ operator delete()

void ACLIP::operator delete ( void * )

inherited

Definition at line 32 of file Ip.cc.

References fatal().

◆ operator new()

void * ACLIP::operator new ( size_t )

inherited

Definition at line 25 of file Ip.cc.

References fatal().

◆ options()

const Acl::Options & ACLDestinationIP::options ( )

overridevirtual

Returns: (linked) 'global' Options supported by this Acl::Node

Reimplemented from Acl::Node.

Definition at line 27 of file DestinationIp.cc.

References Acl::TypedOption< Recipient >::linkWith(), and lookupBanned.

◆ parse()

void ACLIP::parse ( )

overridevirtualinherited

Implements Acl::Node.

Definition at line 472 of file Ip.cc.

References ACLIP::data, acl_ip_data::FactoryParse(), Acl::SplayInserter< DataValue >::Merge(), acl_ip_data::next, ACLIP::parseGlobal(), and ConfigParser::strtokFile().

◆ parseFlags()

void Acl::Node::parseFlags ( )

inherited

Definition at line 360 of file Acl.cc.

References Acl::ParseFlags().

◆ parseGlobal()

bool ACLIP::parseGlobal ( const char * token )

privateinherited

handles special ACL data parameters that apply to the whole ACLIP object

Returns: true if input token is such a special parameter

Definition at line 426 of file Ip.cc.

References DBG_CRITICAL, debugs, ACLIP::matchAnyIpv4, and ACLIP::matchAnyIpv6.

Referenced by ACLIP::parse().

◆ ParseNamed()

void Acl::Node::ParseNamed	(	ConfigParser &	parser,
		NamedAcls &	namedAcls,
		const SBuf &	name
	)

staticprivateinherited

Definition at line 253 of file Acl.cc.

References Assure, SBuf::cmp(), config_input_line, DBG_CRITICAL, DBG_IMPORTANT, DBG_PARSE_NOTE, debugs, ConfigParser::destruct(), fatalf(), HttpPortList, Acl::Make(), and ConfigParser::NextToken().

◆ ParseNamedAcl()

void Acl::Node::ParseNamedAcl	(	ConfigParser &	parser,
		NamedAcls *&	namedAcls
	)

staticinherited

Definition at line 229 of file Acl.cc.

References CallParser(), DBG_CRITICAL, debugs, ConfigParser::destruct(), RefCount< C >::Make(), and ConfigParser::NextToken().

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

◆ prepareForUse()

virtual void Acl::Node::prepareForUse ( )

inlinevirtualinherited

Definition at line 69 of file Node.h.

◆ requiresAle()

bool Acl::Node::requiresAle ( ) const

privatevirtualinherited

Reimplemented in ACLExternal.

Definition at line 443 of file Acl.cc.

◆ requiresReply()

bool Acl::Node::requiresReply ( ) const

privatevirtualinherited

Reimplemented in Acl::HttpRepHeaderCheck, ACLHTTPStatus, and Acl::ReplyHeaderCheck< header >.

Definition at line 449 of file Acl.cc.

◆ requiresRequest()

bool Acl::Node::requiresRequest ( ) const

privatevirtualinherited

Reimplemented in Acl::DestinationDomainCheck, ACLExtUser, Acl::HierCodeCheck, Acl::HttpReqHeaderCheck, Acl::MethodCheck, Acl::NoteCheck, Acl::ProtocolCheck, Acl::RequestHeaderCheck< header >, Acl::ServerNameCheck, Acl::TransactionInitiator, Acl::UrlCheck, Acl::UrlLoginCheck, Acl::UrlPathCheck, Acl::UrlPortCheck, ACLMaxUserIP, ACLProxyAuth, and ACLExternal.

Definition at line 455 of file Acl.cc.

◆ StartLookup()

void ACLDestinationIP::StartLookup	(	ACLFilledChecklist &	cl,
		const Acl::Node &
	)

static

Definition at line 88 of file DestinationIp.cc.

References AnyP::Uri::host(), ipcache_nbgethostbyname(), LookupDone(), ACLFilledChecklist::request, and HttpRequest::url.

Referenced by match().

◆ typeString()

char const * ACLDestinationIP::typeString ( ) const

overridevirtual

Implements ACLIP.

Definition at line 21 of file DestinationIp.cc.

◆ valid()

bool Acl::Node::valid ( ) const

virtualinherited

Reimplemented in ACLMaxConnection, ACLRandom, Acl::ServerNameCheck, ACLMaxUserIP, ACLProxyAuth, and ACLExternal.

Definition at line 183 of file Acl.cc.

Member Data Documentation

◆ cfgline

char* Acl::Node::cfgline = nullptr

inherited

Definition at line 83 of file Node.h.

◆ data

IPSplay* ACLIP::data

protectedinherited

Definition at line 72 of file Ip.h.

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

◆ lookupBanned

Acl::BooleanOptionValue ACLDestinationIP::lookupBanned

private

Definition at line 30 of file DestinationIp.h.

Referenced by match(), and options().

◆ matchAnyIpv4

bool ACLIP::matchAnyIpv4 = false

privateinherited

Definition at line 78 of file Ip.h.

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

◆ matchAnyIpv6

bool ACLIP::matchAnyIpv6 = false

privateinherited

Definition at line 81 of file Ip.h.

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

◆ name

SBuf Acl::Node::name

inherited

Either aclname parameter from the explicitly configured acl directive or a label generated for an internal ACL tree node. All Node objects corresponding to one Squid configuration have unique names. See also: context() and FindByName().

Definition at line 81 of file Node.h.

Referenced by Acl::NotNode::NotNode(), aclDestroyAccessList(), Acl::AnnotateClientCheck::match(), Acl::AnnotateTransactionCheck::match(), Acl::SourceDomainCheck::match(), match(), ACLRandom::match(), ACLExternal::parse(), and ACLMaxConnection::prepareForUse().

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

squid/src/acl/DestinationIp.h
squid/src/acl/DestinationIp.cc

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ IPSplay

◆ Pointer

Member Function Documentation

◆ cacheMatchAcl()

◆ context()

◆ dump()

◆ dumpWhole()

◆ empty()

◆ FindByName()

◆ Initialize()

◆ isProxyAuth()

◆ lineOptions()

◆ LookupDone()

◆ match() [1/2]

◆ match() [2/2]

◆ matches()

◆ matchForCache()

◆ MEMPROXY_CLASS()

◆ operator delete()

◆ operator new()

◆ options()

◆ parse()

◆ parseFlags()

◆ parseGlobal()

◆ ParseNamed()

◆ ParseNamedAcl()

◆ prepareForUse()

◆ requiresAle()

◆ requiresReply()

◆ requiresRequest()

◆ StartLookup()

◆ typeString()

◆ valid()

Member Data Documentation

◆ cfgline

◆ data

◆ lookupBanned

◆ matchAnyIpv4

◆ matchAnyIpv6

◆ name