src/acl/DomainData.cc

   1 /*
   2  * $Id$
   3  *
   4  * DEBUG: section 28    Access Control
   5  * AUTHOR: Duane Wessels
   6  *
   7  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   8  * ----------------------------------------------------------
   9  *
  10  *  Squid is the result of efforts by numerous individuals from
  11  *  the Internet community; see the CONTRIBUTORS file for full
  12  *  details.   Many organizations have provided support for Squid's
  13  *  development; see the SPONSORS file for full details.  Squid is
  14  *  Copyrighted (C) 2001 by the Regents of the University of
  15  *  California; see the COPYRIGHT file for full details.  Squid
  16  *  incorporates software developed and/or copyrighted by other
  17  *  sources; see the CREDITS file for full details.
  18  *
  19  *  This program is free software; you can redistribute it and/or modify
  20  *  it under the terms of the GNU General Public License as published by
  21  *  the Free Software Foundation; either version 2 of the License, or
  22  *  (at your option) any later version.
  23  *
  24  *  This program is distributed in the hope that it will be useful,
  25  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  26  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  27  *  GNU General Public License for more details.
  28  *
  29  *  You should have received a copy of the GNU General Public License
  30  *  along with this program; if not, write to the Free Software
  31  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  32  *
  33  *
  34  * Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
  35  */
  36
  37 #include "squid-old.h"
  38 #include "acl/DomainData.h"
  39 #include "acl/Checklist.h"
  40 #include "wordlist.h"
  41
  42 template<class T>
  43 inline void
  44 xRefFree(T &thing)
  45 {
  46     xfree (thing);
  47 }
  48
  49 ACLDomainData::~ACLDomainData()
  50 {
  51     if (domains)
  52         domains->destroy(xRefFree);
  53 }
  54
  55 template<class T>
  56 inline int
  57 splaystrcasecmp (T&l, T&r)
  58 {
  59     return strcasecmp ((char *)l,(char *)r);
  60 }
  61
  62 template<class T>
  63 inline int
  64 splaystrcmp (T&l, T&r)
  65 {
  66     return strcmp ((char *)l,(char *)r);
  67 }
  68
  69 /* general compare functions, these are used for tree search algorithms
  70  * so they return <0, 0 or >0 */
  71
  72 /* compare a host and a domain */
  73
  74 static int
  75 aclHostDomainCompare( char *const &a, char * const &b)
  76 {
  77     const char *h = static_cast<const char *>(a);
  78     const char *d = static_cast<const char *>(b);
  79     return matchDomainName(h, d);
  80 }
  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             debugs(28, DBG_IMPORTANT, "WARNING: '" << d3 << "' is a subdomain of '" << d4 << "'");
 102             debugs(28, DBG_IMPORTANT, "WARNING: because of this '" << d3 << "' is ignored to keep splay tree searching predictable");
 103             debugs(28, DBG_IMPORTANT, "WARNING: You should remove '" << (*d3=='.'?d4:d3) << "' from the ACL named '" << AclMatchedName << "'");
 104         }
 105     } else if (ret == 0) {
 106         // When a.example.com comes before .example.com in an ACL
 107         // discarding the wildcard is critically bad.
 108         debugs(28, DBG_CRITICAL, "ERROR: '" << d1 << "' is a subdomain of '" << d2 << "'");
 109         debugs(28, DBG_CRITICAL, "ERROR: because of this '" << d2 << "' is ignored to keep splay tree searching predictable");
 110         debugs(28, DBG_CRITICAL, "ERROR: You should remove '" << (*d1=='.'?d2:d1) << "' from the ACL named '" << AclMatchedName << "'");
 111         self_destruct();
 112     }
 113
 114     return ret;
 115 }
 116
 117 bool
 118 ACLDomainData::match(char const *host)
 119 {
 120     if (host == NULL)
 121         return 0;
 122
 123     debugs(28, 3, "aclMatchDomainList: checking '" << host << "'");
 124
 125     domains = domains->splay((char *)host, aclHostDomainCompare);
 126
 127     debugs(28, 3, "aclMatchDomainList: '" << host << "' " << (splayLastResult ? "NOT found" : "found"));
 128
 129     return !splayLastResult;
 130 }
 131
 132 static void
 133 aclDumpDomainListWalkee(char * const & node_data, void *outlist)
 134 {
 135     /* outlist is really a wordlist ** */
 136     wordlistAdd((wordlist **)outlist, (char const *)node_data);
 137 }
 138
 139 wordlist *
 140 ACLDomainData::dump()
 141 {
 142     wordlist *wl = NULL;
 143     /* damn this is VERY inefficient for long ACL lists... filling
 144      * a wordlist this way costs Sum(1,N) iterations. For instance
 145      * a 1000-elements list will be filled in 499500 iterations.
 146      */
 147     domains->walk(aclDumpDomainListWalkee, &wl);
 148     return wl;
 149 }
 150
 151 void
 152 ACLDomainData::parse()
 153 {
 154     char *t = NULL;
 155
 156     while ((t = strtokFile())) {
 157         Tolower(t);
 158         domains = domains->insert(xstrdup(t), aclDomainCompare);
 159     }
 160 }
 161
 162 bool
 163 ACLDomainData::empty() const
 164 {
 165     return domains->empty();
 166 }
 167
 168
 169 ACLData<char const *> *
 170 ACLDomainData::clone() const
 171 {
 172     /* Splay trees don't clone yet. */
 173     assert (!domains);
 174     return new ACLDomainData;
 175 }