Public Member Functions | Static Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
ACLProxyAuth Class Reference

#include <AclProxyAuth.h>

Inheritance diagram for ACLProxyAuth:
Inheritance graph
[legend]
Collaboration diagram for ACLProxyAuth:
Collaboration graph
[legend]

Public Member Functions

 ~ACLProxyAuth () override
 
 ACLProxyAuth (ACLData< char const * > *, char const *)
 
char const * typeString () const override
 
void parse () override
 parses node representation in squid.conf; dies on failures More...
 
bool isProxyAuth () const override
 
int match (ACLChecklist *checklist) override
 Matches the actual data in checklist against this ACL. More...
 
SBufList dump () const override
 
bool valid () const override
 
bool empty () const override
 
bool requiresRequest () const override
 whether our (i.e. shallow) match() requires checklist to have a request More...
 
int matchForCache (ACLChecklist *checklist) override
 
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...
 
int cacheMatchAcl (dlink_list *cache, ACLChecklist *)
 
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...
 

Private Member Functions

 MEMPROXY_CLASS (ACLProxyAuth)
 
const Acl::Options & lineOptions () override
 
int matchProxyAuth (ACLChecklist *)
 
virtual bool requiresAle () const
 whether our (i.e. shallow) match() requires checklist to have a AccessLogEntry More...
 
virtual bool requiresReply () const
 whether our (i.e. shallow) match() requires checklist to have a reply More...
 
virtual const Acl::Options & options ()
 

Private Attributes

ACLData< char const * > * data
 
char const * type_
 

Detailed Description

Definition at line 30 of file AclProxyAuth.h.

Constructor & Destructor Documentation

◆ ~ACLProxyAuth()

ACLProxyAuth::~ACLProxyAuth ( )
override

Definition at line 24 of file AclProxyAuth.cc.

References data.

◆ ACLProxyAuth()

ACLProxyAuth::ACLProxyAuth ( ACLData< char const * > *  newData,
char const *  theType 
)

Definition at line 29 of file AclProxyAuth.cc.

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 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()

SBufList ACLProxyAuth::dump ( ) const
overridevirtual

Implements ACL.

Definition at line 78 of file AclProxyAuth.cc.

References data, and ACLData< M >::dump().

◆ 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()

bool ACLProxyAuth::empty ( ) const
overridevirtual

Implements ACL.

Definition at line 84 of file AclProxyAuth.cc.

References data, and ACLData< M >::empty().

◆ 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 ACLProxyAuth::isProxyAuth ( ) const
inlineoverridevirtual

Reimplemented from ACL.

Definition at line 41 of file AclProxyAuth.h.

◆ lineOptions()

const Acl::Options & ACLProxyAuth::lineOptions ( )
overrideprivatevirtual
Returns
(linked) "line" Options supported by this ACL
See also
ACL::options()

Reimplemented from ACL.

Definition at line 41 of file AclProxyAuth.cc.

References data, and ACLData< M >::lineOptions().

◆ match()

int ACLProxyAuth::match ( ACLChecklist *  checklist)
overridevirtual

Implements ACL.

Definition at line 53 of file AclProxyAuth.cc.

References ACCESS_ALLOWED, ACCESS_AUTH_REQUIRED, ACCESS_DENIED, ACCESS_DUNNO, AuthenticateAcl(), ACLChecklist::keepMatching(), ACLChecklist::markFinished(), and matchProxyAuth().

◆ 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 ACLProxyAuth::matchForCache ( ACLChecklist *  checklist)
overridevirtual

Reimplemented from ACL.

Definition at line 146 of file AclProxyAuth.cc.

References assert, ACLFilledChecklist::auth_user_request, data, Filled(), ACLData< M >::match(), and Auth::UserRequest::username().

◆ matchProxyAuth()

int ACLProxyAuth::matchProxyAuth ( ACLChecklist *  cl)
private

Definition at line 158 of file AclProxyAuth.cc.

References ACLFilledChecklist::auth_user_request, authenticateUserAuthenticated(), ACL::cacheMatchAcl(), Filled(), HttpRequest::flags, ACLFilledChecklist::request, RequestFlags::sslBumped, and Auth::UserRequest::user().

Referenced by match().

◆ MEMPROXY_CLASS()

ACLProxyAuth::MEMPROXY_CLASS ( ACLProxyAuth  )
private

◆ 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()

void ACLProxyAuth::parse ( )
overridevirtual

Implements ACL.

Definition at line 47 of file AclProxyAuth.cc.

References data, and ACLData< M >::parse().

◆ 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()

virtual void ACL::prepareForUse ( )
inlinevirtualinherited

Reimplemented in Acl::InnerNode, ACLMaxConnection, Acl::ParameterizedNode< P >, Acl::ParameterizedNode< ACLData< const char * > >, Acl::ParameterizedNode< ACLData< NotePairs::Entry * > >, Acl::ParameterizedNode< ACLData< XactionStep > >, Acl::ParameterizedNode< ACLData< const Security::CertErrors * > >, Acl::ParameterizedNode< ACLData< X509 * > >, Acl::ParameterizedNode< ACLTimeData >, Acl::ParameterizedNode< ACLData< Ip::Address > >, Acl::ParameterizedNode< ACLData< ACLChecklist * > >, Acl::ParameterizedNode< ACLData< hier_code > >, Acl::ParameterizedNode< ACLData< HttpHeader * > >, Acl::ParameterizedNode< ACLData< int > >, Acl::ParameterizedNode< ACLData< HttpRequestMethod > >, Acl::ParameterizedNode< ACLData< AnyP::ProtocolType > >, and Acl::ParameterizedNode< ACLData< err_type > >.

Definition at line 83 of file Acl.h.

Referenced by ACL::Initialize().

◆ 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 ACLProxyAuth::requiresRequest ( ) const
inlineoverridevirtual

Reimplemented from ACL.

Definition at line 46 of file AclProxyAuth.h.

◆ typeString()

char const * ACLProxyAuth::typeString ( ) const
overridevirtual

Implements ACL.

Definition at line 35 of file AclProxyAuth.cc.

References type_.

◆ valid()

bool ACLProxyAuth::valid ( ) const
overridevirtual

Reimplemented from ACL.

Definition at line 90 of file AclProxyAuth.cc.

References authenticateActiveSchemeCount(), authenticateSchemeCount(), DBG_CRITICAL, and debugs.

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

ACLData<char const *>* ACLProxyAuth::data
private

Definition at line 54 of file AclProxyAuth.h.

Referenced by ~ACLProxyAuth(), dump(), empty(), lineOptions(), matchForCache(), and parse().

◆ 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().

◆ type_

char const* ACLProxyAuth::type_
private

Definition at line 55 of file AclProxyAuth.h.

Referenced by typeString().

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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors