src/acl/DomainData.cc

   1 /*
   2  * DEBUG: section 28    Access Control
   3  * AUTHOR: Duane Wessels
   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 #include "squid.h"
  36 #include "acl/DomainData.h"
  37 #include "acl/Checklist.h"
  38 #include "cache_cf.h"
  39 #include "Debug.h"
  40 #include "wordlist.h"
  41 #include "src/URL.h"
  42
  43 template<class T>
  44 inline void
  45 xRefFree(T &thing)
  46 {
  47     xfree (thing);
  48 }
  49
  50 ACLDomainData::~ACLDomainData()
  51 {
  52     if (domains)
  53         domains->destroy(xRefFree);
  54 }
  55
  56 template<class T>
  57 inline int
  58 splaystrcasecmp (T&l, T&r)
  59 {
  60     return strcasecmp ((char *)l,(char *)r);
  61 }
  62
  63 template<class T>
  64 inline int
  65 splaystrcmp (T&l, T&r)
  66 {
  67     return strcmp ((char *)l,(char *)r);
  68 }
  69
  70 /* general compare functions, these are used for tree search algorithms
  71  * so they return <0, 0 or >0 */
  72
  73 /* compare a host and a domain */
  74
  75 static int
  76 aclHostDomainCompare( char *const &a, char * const &b)
  77 {
  78     const char *h = static_cast<const char *>(a);
  79     const char *d = static_cast<const char *>(b);
  80     return matchDomainName(h, d);
  81 }
  82
  83 /* compare two domains */
  84
  85 template<class T>
  86 int
  87 aclDomainCompare(T const &a, T const &b)
  88 {
  89     char * const d1 = static_cast<char *>(b);
  90     char * const d2 = static_cast<char *>(a);
  91     int ret;
  92     ret = aclHostDomainCompare(d1, d2);
  93
  94     if (ret != 0) {
  95         char *const d3 = d2;
  96         char *const d4 = d1;
  97         ret = aclHostDomainCompare(d3, d4);
  98         if (ret == 0) {
  99             // When a.example.com comes after .example.com in an ACL
 100             // sub-domain is ignored. That is okay. Just important
 101             bool d3big = (strlen(d3) > strlen(d4)); // Always suggest removing the longer one.
 102             debugs(28, DBG_IMPORTANT, "WARNING: '" << (d3big?d3:d4) << "' is a subdomain of '" << (d3big?d4:d3) << "'");
 103             debugs(28, DBG_IMPORTANT, "WARNING: You should remove '" << (d3big?d3:d4) << "' from the ACL named '" << AclMatchedName << "'");
 104             debugs(28, 2, HERE << "Ignore '" << d3 << "' to keep splay tree searching predictable");
 105         }
 106     } else if (ret == 0) {
 107         // It may be an exact duplicate. No problem. Just drop.
 108         if (strcmp(d1,d2)==0) {
 109             debugs(28, 2, "WARNING: '" << d2 << "' is duplicated in the list.");
 110             debugs(28, 2, "WARNING: You should remove one '" << d2 << "' from the ACL named '" << AclMatchedName << "'");
 111             return ret;
 112         }
 113         // When a.example.com comes before .example.com in an ACL
 114         // discarding the wildcard is critically bad.
 115         // or Maybe even both are wildcards. Things are very weird in those cases.
 116         bool d1big = (strlen(d1) > strlen(d2)); // Always suggest removing the longer one.
 117         debugs(28, DBG_CRITICAL, "ERROR: '" << (d1big?d1:d2) << "' is a subdomain of '" << (d1big?d2:d1) << "'");
 118         debugs(28, DBG_CRITICAL, "ERROR: You need to remove '" << (d1big?d1:d2) << "' from the ACL named '" << AclMatchedName << "'");
 119         self_destruct();
 120     }
 121
 122     return ret;
 123 }
 124
 125 bool
 126 ACLDomainData::match(char const *host)
 127 {
 128     if (host == NULL)
 129         return 0;
 130
 131     debugs(28, 3, "aclMatchDomainList: checking '" << host << "'");
 132
 133     domains = domains->splay((char *)host, aclHostDomainCompare);
 134
 135     debugs(28, 3, "aclMatchDomainList: '" << host << "' " << (splayLastResult ? "NOT found" : "found"));
 136
 137     return !splayLastResult;
 138 }
 139
 140 static void
 141 aclDumpDomainListWalkee(char * const & node_data, void *outlist)
 142 {
 143     /* outlist is really a wordlist ** */
 144     wordlistAdd((wordlist **)outlist, (char const *)node_data);
 145 }
 146
 147 wordlist *
 148 ACLDomainData::dump()
 149 {
 150     wordlist *wl = NULL;
 151     /* damn this is VERY inefficient for long ACL lists... filling
 152      * a wordlist this way costs Sum(1,N) iterations. For instance
 153      * a 1000-elements list will be filled in 499500 iterations.
 154      */
 155     domains->walk(aclDumpDomainListWalkee, &wl);
 156     return wl;
 157 }
 158
 159 void
 160 ACLDomainData::parse()
 161 {
 162     char *t = NULL;
 163
 164     while ((t = strtokFile())) {
 165         Tolower(t);
 166         domains = domains->insert(xstrdup(t), aclDomainCompare);
 167     }
 168 }
 169
 170 bool
 171 ACLDomainData::empty() const
 172 {
 173     return domains->empty();
 174 }
 175
 176 ACLData<char const *> *
 177 ACLDomainData::clone() const
 178 {
 179     /* Splay trees don't clone yet. */
 180     assert (!domains);
 181     return new ACLDomainData;
 182 }