Change license header.
[shibboleth/sp.git] / shibsp / attribute / filtering / impl / AttributeValueStringFunctor.cpp
1 /**
2  * Licensed to the University Corporation for Advanced Internet
3  * Development, Inc. (UCAID) under one or more contributor license
4  * agreements. See the NOTICE file distributed with this work for
5  * additional information regarding copyright ownership.
6  *
7  * UCAID licenses this file to you under the Apache License,
8  * Version 2.0 (the "License"); you may not use this file except
9  * in compliance with the License. You may obtain a copy of the
10  * License at
11  *
12  * http://www.apache.org/licenses/LICENSE-2.0
13  *
14  * Unless required by applicable law or agreed to in writing,
15  * software distributed under the License is distributed on an
16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
17  * either express or implied. See the License for the specific
18  * language governing permissions and limitations under the License.
19  */
20
21 /**
22  * AttributeValueStringFunctor.cpp
23  * 
24  * A match function that matches the value of an attribute against the
25  * specified value.
26  */
27
28 #include "internal.h"
29 #include "exceptions.h"
30 #include "attribute/Attribute.h"
31 #include "attribute/filtering/FilteringContext.h"
32 #include "attribute/filtering/FilterPolicyContext.h"
33 #include "attribute/filtering/MatchFunctor.h"
34
35 #include <xmltooling/util/XMLHelper.h>
36
37 using namespace shibsp;
38 using namespace std;
39 using xmltooling::XMLHelper;
40
41 namespace shibsp {
42
43     static const XMLCh attributeID[] =  UNICODE_LITERAL_11(a,t,t,r,i,b,u,t,e,I,D);
44     static const XMLCh value[] =        UNICODE_LITERAL_5(v,a,l,u,e);
45     static const XMLCh ignoreCase[] =   UNICODE_LITERAL_10(i,g,n,o,r,e,C,a,s,e);
46
47     /**
48      * A match function that matches the value of an attribute against the specified value.
49      */
50     class SHIBSP_DLLLOCAL AttributeValueStringFunctor : public MatchFunctor
51     {
52         string m_attributeID;
53         char* m_value;
54
55         bool hasValue(const FilteringContext& filterContext) const;
56         bool matches(const Attribute& attribute, size_t index) const;
57
58     public:
59         AttributeValueStringFunctor(const DOMElement* e)
60                 : m_attributeID(XMLHelper::getAttrString(e, nullptr, attributeID)),
61                   m_value(e ? xmltooling::toUTF8(e->getAttributeNS(nullptr,value)) : nullptr) {
62             if (!m_value || !*m_value) {
63                 delete[] m_value;
64                 throw ConfigurationException("AttributeValueString MatchFunctor requires non-empty value attribute.");
65             }
66             if (e && e->hasAttributeNS(nullptr,ignoreCase)) {
67                 xmltooling::logging::Category::getInstance(SHIBSP_LOGCAT".AttributeFilter").warn(
68                     "ignoreCase property ignored by AttributeValueString MatchFunctor in favor of attribute's caseSensitive property"
69                     );
70             }
71         }
72
73         virtual ~AttributeValueStringFunctor() {
74             delete[] m_value;
75         }
76
77         bool evaluatePolicyRequirement(const FilteringContext& filterContext) const {
78             if (m_attributeID.empty())
79                 throw AttributeFilteringException("No attributeID specified.");
80             return hasValue(filterContext);
81         }
82
83         bool evaluatePermitValue(const FilteringContext& filterContext, const Attribute& attribute, size_t index) const {
84             if (m_attributeID.empty() || m_attributeID == attribute.getId())
85                 return matches(attribute, index);
86             return hasValue(filterContext);
87         }
88     };
89
90     MatchFunctor* SHIBSP_DLLLOCAL AttributeValueStringFactory(const std::pair<const FilterPolicyContext*,const DOMElement*>& p)
91     {
92         return new AttributeValueStringFunctor(p.second);
93     }
94
95 };
96
97 bool AttributeValueStringFunctor::hasValue(const FilteringContext& filterContext) const
98 {
99     size_t count;
100     pair<multimap<string,Attribute*>::const_iterator,multimap<string,Attribute*>::const_iterator> attrs =
101         filterContext.getAttributes().equal_range(m_attributeID);
102     for (; attrs.first != attrs.second; ++attrs.first) {
103         count = attrs.first->second->valueCount();
104         for (size_t index = 0; index < count; ++index) {
105             if (matches(*(attrs.first->second), index))
106                 return true;
107         }
108     }
109     return false;
110 }
111
112 bool AttributeValueStringFunctor::matches(const Attribute& attribute, size_t index) const
113 {
114     const char* val = attribute.getString(index);
115     if (!val)
116         return false;
117     if (attribute.isCaseSensitive())
118         return !strcmp(m_value, val);
119
120 #ifdef HAVE_STRCASECMP
121     return !strcasecmp(m_value, val);
122 #else
123     return !stricmp(m_value, val);
124 #endif
125 }