Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
Acl::ParameterizedNode< P > Class Template Referenceabstract

#include <ParameterizedNode.h>

Inheritance diagram for Acl::ParameterizedNode< P >:
Inheritance graph
[legend]
Collaboration diagram for Acl::ParameterizedNode< P >:
Collaboration graph
[legend]

Public Types

using Parameters = P
 

Public Member Functions

 ParameterizedNode ()=default
 
 ~ParameterizedNode () override=default
 
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
 
void parseFlags ()
 configures ACL options, throwing on configuration errors More...
 
virtual char const * typeString () const =0
 
virtual bool isProxyAuth () const
 
virtual bool valid () const
 
int cacheMatchAcl (dlink_list *cache, ACLChecklist *)
 
virtual int matchForCache (ACLChecklist *checklist)
 
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

void parse () override
 parses node representation in squid.conf; dies on failures More...
 
void prepareForUse () override
 
SBufList dump () const override
 
bool empty () const override
 
const Acl::Options & lineOptions () override
 

Protected Attributes

std::unique_ptr< Parameters > data
 

Private Member Functions

virtual int match (ACLChecklist *checklist)=0
 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 requiresReply () const
 whether our (i.e. shallow) match() requires checklist to have a reply More...
 
virtual const Acl::Options & options ()
 

Detailed Description

template<class P>
class Acl::ParameterizedNode< P >

An ACL that manages squid.conf-configured ACL parameters using a given class P. That P class must support the ACLData<> or equivalent API.

Definition at line 23 of file ParameterizedNode.h.

Member Typedef Documentation

◆ Parameters

template<class P >
using Acl::ParameterizedNode< P >::Parameters = P

Definition at line 26 of file ParameterizedNode.h.

Constructor & Destructor Documentation

◆ ParameterizedNode()

template<class P >
Acl::ParameterizedNode< P >::ParameterizedNode ( )
default

◆ ~ParameterizedNode()

template<class P >
Acl::ParameterizedNode< P >::~ParameterizedNode ( )
overridedefault

Member Function Documentation

◆ cacheMatchAcl()

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

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

◆ context()

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

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

template<class P >
SBufList Acl::ParameterizedNode< P >::dump ( ) const
inlineoverrideprotectedvirtual

Implements ACL.

Definition at line 37 of file ParameterizedNode.h.

References Acl::ParameterizedNode< P >::data.

◆ dumpOptions()

SBufList ACL::dumpOptions ( )
inherited
Returns
approximate options configuration

Definition at line 326 of file Acl.cc.

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

Referenced by dump_acl().

◆ empty()

template<class P >
bool Acl::ParameterizedNode< P >::empty ( ) const
inlineoverrideprotectedvirtual

Implements ACL.

Definition at line 38 of file ParameterizedNode.h.

References Acl::ParameterizedNode< P >::data.

◆ FindByName()

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

Definition at line 118 of file Acl.cc.

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

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

◆ Initialize()

void ACL::Initialize ( )
staticinherited

Definition at line 438 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 ACLProxyAuth, ACLExternal, and ACLIdent.

Definition at line 309 of file Acl.cc.

Referenced by aclIsProxyAuth().

◆ lineOptions()

template<class P >
const Acl::Options & Acl::ParameterizedNode< P >::lineOptions ( )
inlineoverrideprotectedvirtual
Returns
(linked) "line" Options supported by this ACL
See also
ACL::options()

Reimplemented from ACL.

Definition at line 39 of file ParameterizedNode.h.

References Acl::ParameterizedNode< P >::data.

◆ match()

virtual int ACL::match ( ACLChecklist *  checklist)
privatepure virtualinherited

Implemented in Acl::AdaptationServiceCheck, Acl::AnnotateClientCheck, Acl::AnnotateTransactionCheck, Acl::AtStepCheck, Acl::ClientCertificateCheck, Acl::DestinationAsnCheck, Acl::DestinationDomainCheck, Acl::HasComponentCheck, Acl::HierCodeCheck, Acl::HttpRepHeaderCheck, Acl::HttpReqHeaderCheck, Acl::LocalPortCheck, Acl::MethodCheck, Acl::MyPortNameCheck, Acl::NoteCheck, Acl::PeerNameCheck, Acl::ProtocolCheck, Acl::ReplyHeaderCheck< header >, Acl::RequestHeaderCheck< header >, Acl::ServerCertificateCheck, Acl::ServerNameCheck, Acl::SourceAsnCheck, Acl::SourceDomainCheck, Acl::SquidErrorCheck, Acl::CertificateErrorCheck, Acl::TagCheck, Acl::CurrentTimeCheck, Acl::UrlCheck, Acl::UrlLoginCheck, Acl::UrlPathCheck, Acl::UrlPortCheck, Acl::SnmpCommunityCheck, ACLARP, Acl::ConnectionsEncrypted, Acl::ConnMark, ACLDestinationIP, ACLEui64, ACLExtUser, ACLHTTPStatus, Acl::InnerNode, ACLLocalIP, ACLMaxConnection, ACLRandom, ACLSourceIP, Acl::TransactionInitiator, ACLProxyAuth, ACLExternal, ACLIdent, ACLIP, ACLMaxUserIP, Acl::ReplyHeaderCheck< header >, and Acl::RequestHeaderCheck< header >.

Referenced by ACL::matches().

◆ 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 146 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 349 of file Acl.cc.

References fatal().

Referenced by ACL::cacheMatchAcl().

◆ operator delete()

void ACL::operator delete ( void *  )
inherited

Definition at line 112 of file Acl.cc.

References fatal().

◆ operator new()

void * ACL::operator new ( size_t  )
inherited

Definition at line 105 of file Acl.cc.

References fatal().

◆ options()

virtual const Acl::Options & ACL::options ( )
inlineprivatevirtualinherited
Returns
(linked) 'global' Options supported by this ACL

Reimplemented in Acl::DestinationDomainCheck, ACLDestinationIP, Acl::AnnotationCheck, Acl::ServerNameCheck, and ACLMaxUserIP.

Definition at line 105 of file Acl.h.

References Acl::NoOptions().

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

◆ parse()

template<class P >
void Acl::ParameterizedNode< P >::parse ( )
inlineoverrideprotectedvirtual

Implements ACL.

Definition at line 35 of file ParameterizedNode.h.

References Assure, and Acl::ParameterizedNode< P >::data.

◆ ParseAclLine()

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

Definition at line 191 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(), and xstrncpy().

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

◆ parseFlags()

void ACL::parseFlags ( )
inherited

Definition at line 315 of file Acl.cc.

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

◆ prepareForUse()

template<class P >
void Acl::ParameterizedNode< P >::prepareForUse ( )
inlineoverrideprotectedvirtual

Reimplemented from ACL.

Definition at line 36 of file ParameterizedNode.h.

References Acl::ParameterizedNode< P >::data.

◆ requiresAle()

bool ACL::requiresAle ( ) const
privatevirtualinherited

Reimplemented in ACLExternal.

Definition at line 409 of file Acl.cc.

Referenced by ACL::matches().

◆ requiresReply()

bool ACL::requiresReply ( ) const
privatevirtualinherited

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

Definition at line 415 of file Acl.cc.

Referenced by ACL::matches().

◆ requiresRequest()

bool ACL::requiresRequest ( ) const
privatevirtualinherited

Reimplemented in Acl::AnnotateClientCheck, Acl::AnnotateTransactionCheck, Acl::DestinationAsnCheck, Acl::DestinationDomainCheck, 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 421 of file Acl.cc.

Referenced by ACL::matches().

◆ typeString()

virtual char const * ACL::typeString ( ) const
pure virtualinherited

Implemented in Acl::AllOf, Acl::AnyOf, ACLARP, Acl::NotNode, Acl::AndNode, Acl::OrNode, Acl::ConnectionsEncrypted, Acl::ConnMark, ACLDestinationIP, ACLEui64, ACLExtUser, ACLHTTPStatus, ACLLocalIP, ACLMaxConnection, ACLRandom, ACLSourceIP, Acl::TransactionInitiator, ACLMaxUserIP, ACLProxyAuth, ACLExternal, ACLIdent, and ACLIP.

Referenced by dump_acl().

◆ valid()

bool ACL::valid ( ) const
virtualinherited

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

Definition at line 140 of file Acl.cc.

Member Data Documentation

◆ cfgline

char* ACL::cfgline
inherited

Definition at line 88 of file Acl.h.

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

◆ data

template<class P >
std::unique_ptr<Parameters> Acl::ParameterizedNode< P >::data
protected

Points to items this ACL is configured to match. A derived class ensures that this pointer is never nil after the ACL object construction ends.

Definition at line 43 of file ParameterizedNode.h.

Referenced by Acl::ParameterizedNode< P >::dump(), Acl::ParameterizedNode< P >::empty(), Acl::ParameterizedNode< P >::lineOptions(), Acl::ParameterizedNode< P >::parse(), and Acl::ParameterizedNode< P >::prepareForUse().

◆ name

char ACL::name[ACL_NAME_SZ]
inherited

Definition at line 87 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 89 of file Acl.h.

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

◆ registered

bool ACL::registered
inherited

Definition at line 90 of file Acl.h.

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

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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors