From b6f1ae3a55008c540f1370a799798e617cfd25fc Mon Sep 17 00:00:00 2001
From: Amos Jeffries <squid3@treenet.co.nz>
Date: Sat, 6 Jun 2009 11:57:14 +1200
Subject: [PATCH] Author: Henrik Nordstrom <henrik@henriknordstrom.net> Adds
 "tag" type acl matching tags set by external acl helpers.

Currently using a list of strings (not even splay) as the number of
members is generally expected to be very small.

Should be complemented by a regex based acl.
---
 doc/release-notes/release-3.1.sgml |  4 +-
 src/AclRegs.cc                     |  4 ++
 src/acl/Makefile.am                |  2 +
 src/acl/Tag.cc                     | 57 +++++++++++++++++++++++++
 src/acl/Tag.h                      | 68 ++++++++++++++++++++++++++++++
 src/cf.data.pre                    |  3 ++
 6 files changed, 137 insertions(+), 1 deletion(-)
 create mode 100644 src/acl/Tag.cc
 create mode 100644 src/acl/Tag.h

diff --git a/doc/release-notes/release-3.1.sgml b/doc/release-notes/release-3.1.sgml
index 6e9d5e7e2a..4b36b19abb 100644
--- a/doc/release-notes/release-3.1.sgml
+++ b/doc/release-notes/release-3.1.sgml
@@ -785,9 +785,10 @@ NOCOMMENT_START
 <sect1>Changes to existing tags<label id="modifiedtags">
 <p>
 <descrip>
-	<tag>acl dst ipv6</tag>
+	<tag>acl</tag>
 	<p>New preset content <em>ipv6</em> available as a preset type in the src and dst ACL matching all of the public IPv6 network space.
 	<p>New acl type myportname, matching the name of the http_port or https_port where the request was accepted.
+	<p>New acl type tag, matching the tag= returned from the external_acl_type helper.
 	<p>New acl type peername, matching against a named cache_peer entry where the request will be attempted first.
 	   NP: peername currently is limited to only match the first peer possible.
         <verb>
@@ -795,6 +796,7 @@ NOCOMMENT_START
 	acl aclname src ipv6			# request from IPv6 address
         acl aclname myportname 3128 ...         # http(s)_port name
 	acl aclname peername myPeer ...		# cache_peer ... name=myPeer
+	acl aclname tag value ...		# tag= option from external ACL
 	</verb>
 
 	<tag>auth_param ntlm, basic, digest</tag>
diff --git a/src/AclRegs.cc b/src/AclRegs.cc
index 5c833b230c..f4d735bdbe 100644
--- a/src/AclRegs.cc
+++ b/src/AclRegs.cc
@@ -56,6 +56,7 @@
 #include "acl/Strategised.h"
 #include "acl/Strategy.h"
 #include "acl/StringData.h"
+#include "acl/Tag.h"
 #include "acl/TimeData.h"
 #include "acl/Time.h"
 #include "acl/Url.h"
@@ -149,3 +150,6 @@ ACLProxyAuth ACLProxyAuth::RegexRegistryEntry_(new ACLRegexData, "proxy_auth_reg
 
 ACL::Prototype ACLMaxUserIP::RegistryProtoype(&ACLMaxUserIP::RegistryEntry_, "max_user_ip");
 ACLMaxUserIP ACLMaxUserIP::RegistryEntry_("max_user_ip");
+
+ACL::Prototype ACLTag::RegistryProtoype(&ACLTag::RegistryEntry_, "tag");
+ACLStrategised<const char *> ACLTag::RegistryEntry_(new ACLStringData, ACLTagStrategy::Instance(), "tag");
diff --git a/src/acl/Makefile.am b/src/acl/Makefile.am
index 41cbceedcc..728563d0ea 100644
--- a/src/acl/Makefile.am
+++ b/src/acl/Makefile.am
@@ -88,6 +88,8 @@ libacls_la_SOURCES = \
 	SourceDomain.h \
 	SourceIp.cc \
 	SourceIp.h \
+	Tag.cc \
+	Tag.h \
 	Url.cc \
 	Url.h \
 	UrlPath.cc \
diff --git a/src/acl/Tag.cc b/src/acl/Tag.cc
new file mode 100644
index 0000000000..bc81eb70a4
--- /dev/null
+++ b/src/acl/Tag.cc
@@ -0,0 +1,57 @@
+
+/*
+ * $Id: ACLTag.cc,v 1.2 2008/02/11 22:44:50 rousskov Exp $
+ *
+ *
+ * SQUID Web Proxy Cache          http://www.squid-cache.org/
+ * ----------------------------------------------------------
+ *
+ *  Squid is the result of efforts by numerous individuals from
+ *  the Internet community; see the CONTRIBUTORS file for full
+ *  details.   Many organizations have provided support for Squid's
+ *  development; see the SPONSORS file for full details.  Squid is
+ *  Copyrighted (C) 2001 by the Regents of the University of
+ *  California; see the COPYRIGHT file for full details.  Squid
+ *  incorporates software developed and/or copyrighted by other
+ *  sources; see the CREDITS file for full details.
+ *
+ *  This program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; either version 2 of the License, or
+ *  (at your option) any later version.
+ *  
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *  
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
+ *
+ *
+ * Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
+ * Copyright (c) 2009, Henrik Nordstrom <henrik@henriknordstrom.net>
+ */
+
+#include "squid.h"
+#include "acl/Tag.h"
+#include "acl/StringData.h"
+#include "acl/Checklist.h"
+#include "HttpRequest.h"
+
+int
+ACLTagStrategy::match (ACLData<MatchType> * &data, ACLFilledChecklist *checklist)
+{
+    if (checklist->conn() != NULL)
+	return data->match (checklist->request->tag.termedBuf());
+    return 0;
+}
+
+ACLTagStrategy *
+ACLTagStrategy::Instance()
+{
+    return &Instance_;
+}
+
+ACLTagStrategy ACLTagStrategy::Instance_;
diff --git a/src/acl/Tag.h b/src/acl/Tag.h
new file mode 100644
index 0000000000..5ff986a4fc
--- /dev/null
+++ b/src/acl/Tag.h
@@ -0,0 +1,68 @@
+/*
+ * $Id$
+ *
+ *
+ * SQUID Web Proxy Cache          http://www.squid-cache.org/
+ * ----------------------------------------------------------
+ *
+ *  Squid is the result of efforts by numerous individuals from
+ *  the Internet community; see the CONTRIBUTORS file for full
+ *  details.   Many organizations have provided support for Squid's
+ *  development; see the SPONSORS file for full details.  Squid is
+ *  Copyrighted (C) 2001 by the Regents of the University of
+ *  California; see the COPYRIGHT file for full details.  Squid
+ *  incorporates software developed and/or copyrighted by other
+ *  sources; see the CREDITS file for full details.
+ *
+ *  This program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; either version 2 of the License, or
+ *  (at your option) any later version.
+ *  
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *  
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
+ *
+ *
+ * Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
+ * Copyright (c) 2009, Henrik Nordstrom <henrik@henriknordstrom.net>
+ */
+
+#ifndef SQUID_ACLTAG_H
+#define SQUID_ACLTAG_H
+
+#include "acl/Strategy.h"
+#include "acl/Strategised.h"
+
+class ACLTagStrategy : public ACLStrategy<const char *>
+{
+
+public:
+    virtual int match (ACLData<MatchType> * &, ACLFilledChecklist *);
+    static ACLTagStrategy *Instance();
+    /* Not implemented to prevent copies of the instance. */
+    /* Not private to prevent brain dead g+++ warnings about
+     * private constructors with no friends */
+    ACLTagStrategy(ACLTagStrategy const &);
+
+private:
+    static ACLTagStrategy Instance_;
+    ACLTagStrategy(){}
+
+    ACLTagStrategy&operator=(ACLTagStrategy const &);
+};
+
+class ACLTag
+{
+
+private:
+    static ACL::Prototype RegistryProtoype;
+    static ACLStrategised<const char *> RegistryEntry_;
+};
+
+#endif /* SQUID_ACLMYPORTNAME_H */
diff --git a/src/cf.data.pre b/src/cf.data.pre
index 167636e35b..6fdf925b07 100644
--- a/src/cf.data.pre
+++ b/src/cf.data.pre
@@ -652,6 +652,9 @@ DOC_START
 	acl aclname ext_user_regex [-i] pattern ...
 	  # string match on username returned by external acl helper
 	  # use REQUIRED to accept any non-null user name.
+	  #
+	acl aclname tag tagvalue ...
+	  # string match on tag returned by external acl helper
 
 Examples:
 acl macaddress arp 09:00:2b:23:45:67
-- 
2.47.3