shibsp/attribute/NameIDAttribute.h

   1 /*
   2  *  Copyright 2001-2007 Internet2
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * @file shibsp/attribute/NameIDAttribute.h
  19  *
  20  * An Attribute whose values are relations of a value and a scope.
  21  */
  22
  23 #ifndef __shibsp_nameidattr_h__
  24 #define __shibsp_nameidattr_h__
  25
  26 #include <shibsp/attribute/Attribute.h>
  27 #include <xmltooling/exceptions.h>
  28
  29 namespace shibsp {
  30
  31 #if defined (_MSC_VER)
  32     #pragma warning( push )
  33     #pragma warning( disable : 4251 )
  34 #endif
  35
  36     /** Default serialization format for NameIDs */
  37     #define DEFAULT_NAMEID_FORMATTER    "$Name!!$NameQualifier!!$SPNameQualifier"
  38
  39     /**
  40      * An Attribute whose values are derived from or mappable to a SAML NameID.
  41      */
  42     class SHIBSP_API NameIDAttribute : public Attribute
  43     {
  44     public:
  45         /**
  46          * Constructor.
  47          *
  48          * @param ids       array with primary identifier in first position, followed by any aliases
  49          * @param formatter template for serialization of tuple
  50          */
  51         NameIDAttribute(const std::vector<std::string>& ids, const char* formatter=DEFAULT_NAMEID_FORMATTER)
  52             : Attribute(ids), m_formatter(formatter) {
  53         }
  54
  55         /**
  56          * Constructs based on a remoted NameIDAttribute.
  57          *
  58          * @param in    input object containing marshalled NameIDAttribute
  59          */
  60         NameIDAttribute(DDF& in) : Attribute(in) {
  61             DDF val = in["_formatter"];
  62             if (val.isstring())
  63                 m_formatter = val.string();
  64             else
  65                 m_formatter = DEFAULT_NAMEID_FORMATTER;
  66             const char* pch;
  67             val = in.first().first();
  68             while (val.name()) {
  69                 m_values.push_back(Value());
  70                 Value& v = m_values.back();
  71                 v.m_Name = val.name();
  72                 pch = val["Format"].string();
  73                 if (pch)
  74                     v.m_Format = pch;
  75                 pch = val["NameQualifier"].string();
  76                 if (pch)
  77                     v.m_NameQualifier = pch;
  78                 pch = val["SPNameQualifier"].string();
  79                 if (pch)
  80                     v.m_SPNameQualifier = pch;
  81                 pch = val["SPProvidedID"].string();
  82                 if (pch)
  83                     v.m_SPProvidedID = pch;
  84                 val = in.first().next();
  85             }
  86         }
  87
  88         virtual ~NameIDAttribute() {}
  89
  90         /**
  91          * Holds all the fields associated with a NameID.
  92          */
  93         struct SHIBSP_API Value
  94         {
  95             std::string m_Name;
  96             std::string m_Format;
  97             std::string m_NameQualifier;
  98             std::string m_SPNameQualifier;
  99             std::string m_SPProvidedID;
 100         };
 101
 102         /**
 103          * Returns the set of values encoded as UTF-8 strings.
 104          *
 105          * <p>Each compound value is a pair containing the simple value and the scope.
 106          *
 107          * @return  a mutable vector of the values
 108          */
 109         std::vector<Value>& getValues() {
 110             return m_values;
 111         }
 112
 113         size_t valueCount() const {
 114             return m_values.size();
 115         }
 116
 117         void clearSerializedValues() {
 118             m_serialized.clear();
 119         }
 120
 121         const char* getString(size_t index) const {
 122             return m_values[index].m_Name.c_str();
 123         }
 124
 125         const char* getScope(size_t index) const {
 126             return m_values[index].m_NameQualifier.c_str();
 127         }
 128
 129         void removeValue(size_t index) {
 130             Attribute::removeValue(index);
 131             if (index < m_values.size())
 132                 m_values.erase(m_values.begin() + index);
 133         }
 134
 135         const std::vector<std::string>& getSerializedValues() const {
 136             if (m_serialized.empty()) {
 137                 for (std::vector<Value>::const_iterator i=m_values.begin(); i!=m_values.end(); ++i) {
 138                     // This is kind of a hack, but it's a good way to reuse some code.
 139                     xmltooling::XMLToolingException e(
 140                         m_formatter,
 141                         xmltooling::namedparams(
 142                             5,
 143                             "Name", i->m_Name.c_str(),
 144                             "Format", i->m_Format.c_str(),
 145                             "NameQualifier", i->m_NameQualifier.c_str(),
 146                             "SPNameQualifier", i->m_SPNameQualifier.c_str(),
 147                             "SPProvidedID", i->m_SPProvidedID.c_str()
 148                             )
 149                         );
 150                     m_serialized.push_back(e.what());
 151                 }
 152             }
 153             return Attribute::getSerializedValues();
 154         }
 155
 156         DDF marshall() const {
 157             DDF ddf = Attribute::marshall();
 158             ddf.name("NameID");
 159             ddf.addmember("_formatter").string(m_formatter.c_str());
 160             DDF vlist = ddf.first();
 161             for (std::vector<Value>::const_iterator i=m_values.begin(); i!=m_values.end(); ++i) {
 162                 DDF val = DDF(i->m_Name.c_str()).structure();
 163                 if (!i->m_Format.empty())
 164                     val.addmember("Format").string(i->m_Format.c_str());
 165                 if (!i->m_NameQualifier.empty())
 166                     val.addmember("NameQualifier").string(i->m_NameQualifier.c_str());
 167                 if (!i->m_SPNameQualifier.empty())
 168                     val.addmember("SPNameQualifier").string(i->m_SPNameQualifier.c_str());
 169                 if (!i->m_SPProvidedID.empty())
 170                     val.addmember("SPProvidedID").string(i->m_SPProvidedID.c_str());
 171                 vlist.add(val);
 172             }
 173             return ddf;
 174         }
 175
 176     private:
 177         std::vector<Value> m_values;
 178         std::string m_formatter;
 179     };
 180
 181 #if defined (_MSC_VER)
 182     #pragma warning( pop )
 183 #endif
 184
 185 };
 186
 187 #endif /* __shibsp_nameidattr_h__ */