src/acl/Acl.h

   1 /*
   2  * $Id$
   3  *
   4  *
   5  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   6  * ----------------------------------------------------------
   7  *
   8  *  Squid is the result of efforts by numerous individuals from
   9  *  the Internet community; see the CONTRIBUTORS file for full
  10  *  details.   Many organizations have provided support for Squid's
  11  *  development; see the SPONSORS file for full details.  Squid is
  12  *  Copyrighted (C) 2001 by the Regents of the University of
  13  *  California; see the COPYRIGHT file for full details.  Squid
  14  *  incorporates software developed and/or copyrighted by other
  15  *  sources; see the CREDITS file for full details.
  16  *
  17  *  This program is free software; you can redistribute it and/or modify
  18  *  it under the terms of the GNU General Public License as published by
  19  *  the Free Software Foundation; either version 2 of the License, or
  20  *  (at your option) any later version.
  21  *
  22  *  This program is distributed in the hope that it will be useful,
  23  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  *  GNU General Public License for more details.
  26  *
  27  *  You should have received a copy of the GNU General Public License
  28  *  along with this program; if not, write to the Free Software
  29  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  30  *
  31  *
  32  * Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
  33  */
  34
  35 #ifndef SQUID_ACL_H
  36 #define SQUID_ACL_H
  37
  38 #include "Array.h"
  39 #include "cbdata.h"
  40 #include "dlink.h"
  41
  42 class ConfigParser;
  43 class ACLChecklist;
  44
  45 /// \ingroup ACLAPI
  46 class ACL
  47 {
  48
  49 public:
  50     void *operator new(size_t);
  51     void operator delete(void *);
  52
  53     static ACL *Factory (char const *);
  54     static void ParseAclLine(ConfigParser &parser, ACL ** head);
  55     static void Initialize();
  56     static ACL* FindByName(const char *name);
  57
  58     ACL();
  59     virtual ~ACL();
  60     virtual ACL *clone()const = 0;
  61     virtual void parse() = 0;
  62     virtual char const *typeString() const = 0;
  63     virtual bool isProxyAuth() const;
  64     virtual bool requiresRequest() const;
  65     virtual bool requiresReply() const;
  66     virtual int match(ACLChecklist * checklist) = 0;
  67     virtual wordlist *dump() const = 0;
  68     virtual bool empty () const = 0;
  69     virtual bool valid () const;
  70     int checklistMatches(ACLChecklist *);
  71
  72     int cacheMatchAcl(dlink_list * cache, ACLChecklist *);
  73     virtual int matchForCache(ACLChecklist *checklist);
  74
  75     virtual void prepareForUse() {}
  76
  77     char name[ACL_NAME_SZ];
  78     char *cfgline;
  79     ACL *next;
  80
  81 public:
  82
  83     class Prototype
  84     {
  85
  86     public:
  87         Prototype ();
  88         Prototype (ACL const *, char const *);
  89         ~Prototype();
  90         static bool Registered(char const *);
  91         static ACL *Factory (char const *);
  92
  93     private:
  94         ACL const*prototype;
  95         char const *typeString;
  96
  97     private:
  98         static Vector<Prototype const *> * Registry;
  99         static void *Initialized;
 100         typedef Vector<Prototype const*>::iterator iterator;
 101         typedef Vector<Prototype const*>::const_iterator const_iterator;
 102         void registerMe();
 103     };
 104 };
 105
 106 /// \ingroup ACLAPI
 107 typedef enum {
 108     ACCESS_DENIED,
 109     ACCESS_ALLOWED,
 110     ACCESS_DUNNO,
 111     ACCESS_REQ_PROXY_AUTH
 112 } allow_t;
 113
 114 /// \ingroup ACLAPI
 115 class acl_access
 116 {
 117
 118 public:
 119     void *operator new(size_t);
 120     void operator delete(void *);
 121     allow_t allow;
 122     ACLList *aclList;
 123     char *cfgline;
 124     acl_access *next;
 125
 126 private:
 127     CBDATA_CLASS(acl_access);
 128 };
 129
 130 /// \ingroup ACLAPI
 131 class ACLList
 132 {
 133
 134 public:
 135     MEMPROXY_CLASS(ACLList);
 136
 137     ACLList();
 138     void negated(bool isNegated);
 139     bool matches (ACLChecklist *)const;
 140     int op;
 141     ACL *_acl;
 142     ACLList *next;
 143 };
 144
 145 MEMPROXY_CLASS_INLINE(ACLList);
 146
 147 /// \ingroup ACLAPI
 148 class acl_proxy_auth_match_cache
 149 {
 150
 151 public:
 152     MEMPROXY_CLASS(acl_proxy_auth_match_cache);
 153     dlink_node link;
 154     int matchrv;
 155     void *acl_data;
 156 };
 157
 158 MEMPROXY_CLASS_INLINE(acl_proxy_auth_match_cache);
 159
 160
 161 /// \ingroup ACLAPI
 162 extern const char *AclMatchedName;      /* NULL */
 163
 164 #endif /* SQUID_ACL_H */