-/*\r
- * Copyright 2001-2007 Internet2\r
- * \r
- * Licensed under the Apache License, Version 2.0 (the "License");\r
- * you may not use this file except in compliance with the License.\r
- * You may obtain a copy of the License at\r
- *\r
- * http://www.apache.org/licenses/LICENSE-2.0\r
- *\r
- * Unless required by applicable law or agreed to in writing, software\r
- * distributed under the License is distributed on an "AS IS" BASIS,\r
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
- * See the License for the specific language governing permissions and\r
- * limitations under the License.\r
- */\r
-\r
-/**\r
- * NameIDAttributeDecoder.cpp\r
- * \r
- * Decodes SAML into NameIDAttributes\r
- */\r
-\r
-#include "internal.h"\r
-#include "attribute/AttributeDecoder.h"\r
-#include "attribute/NameIDAttribute.h"\r
-\r
-#include <saml/saml1/core/Assertions.h>\r
-#include <saml/saml2/core/Assertions.h>\r
-\r
-using namespace shibsp;\r
-using namespace opensaml::saml1;\r
-using namespace opensaml::saml2;\r
-using namespace xmltooling;\r
-using namespace std;\r
-\r
-namespace shibsp {\r
- static XMLCh formatter[] = UNICODE_LITERAL_9(f,o,r,m,a,t,t,e,r);\r
-\r
- class SHIBSP_DLLLOCAL NameIDAttributeDecoder : virtual public AttributeDecoder\r
- {\r
- public:\r
- NameIDAttributeDecoder(const DOMElement* e) : AttributeDecoder(e), m_formatter(e ? e->getAttributeNS(NULL,formatter) : NULL) {}\r
- ~NameIDAttributeDecoder() {}\r
-\r
- shibsp::Attribute* decode(\r
- const char* id, const XMLObject* xmlObject, const char* assertingParty=NULL, const char* relyingParty=NULL\r
- ) const;\r
-\r
- private:\r
- void extract(\r
- const NameIDType* n, vector<NameIDAttribute::Value>& dest, const char* assertingParty=NULL, const char* relyingParty=NULL\r
- ) const;\r
- void extract(\r
- const NameIdentifier* n, vector<NameIDAttribute::Value>& dest, const char* assertingParty=NULL, const char* relyingParty=NULL\r
- ) const;\r
- auto_ptr_char m_formatter;\r
- };\r
-\r
- AttributeDecoder* SHIBSP_DLLLOCAL NameIDAttributeDecoderFactory(const DOMElement* const & e)\r
- {\r
- return new NameIDAttributeDecoder(e);\r
- }\r
-};\r
-\r
-shibsp::Attribute* NameIDAttributeDecoder::decode(\r
- const char* id, const XMLObject* xmlObject, const char* assertingParty, const char* relyingParty\r
- ) const\r
-{\r
- auto_ptr<NameIDAttribute> nameid(\r
- new NameIDAttribute(id, (m_formatter.get() && *m_formatter.get()) ? m_formatter.get() : DEFAULT_NAMEID_FORMATTER)\r
- );\r
- nameid->setCaseSensitive(m_caseSensitive);\r
- vector<NameIDAttribute::Value>& dest = nameid->getValues();\r
- vector<XMLObject*>::const_iterator v,stop;\r
-\r
- Category& log = Category::getInstance(SHIBSP_LOGCAT".AttributeDecoder");\r
- \r
- if (xmlObject && XMLString::equals(opensaml::saml1::Attribute::LOCAL_NAME,xmlObject->getElementQName().getLocalPart())) {\r
- const opensaml::saml2::Attribute* saml2attr = dynamic_cast<const opensaml::saml2::Attribute*>(xmlObject);\r
- if (saml2attr) {\r
- const vector<XMLObject*>& values = saml2attr->getAttributeValues();\r
- v = values.begin();\r
- stop = values.end();\r
- if (log.isDebugEnabled()) {\r
- auto_ptr_char n(saml2attr->getName());\r
- log.debug("decoding NameIDAttribute (%s) from SAML 2 Attribute (%s) with %lu value(s)", id, n.get() ? n.get() : "unnamed", values.size());\r
- }\r
- }\r
- else {\r
- const opensaml::saml1::Attribute* saml1attr = dynamic_cast<const opensaml::saml1::Attribute*>(xmlObject);\r
- if (saml1attr) {\r
- const vector<XMLObject*>& values = saml1attr->getAttributeValues();\r
- v = values.begin();\r
- stop = values.end();\r
- if (log.isDebugEnabled()) {\r
- auto_ptr_char n(saml1attr->getAttributeName());\r
- log.debug("decoding NameIDAttribute (%s) from SAML 1 Attribute (%s) with %lu value(s)", id, n.get() ? n.get() : "unnamed", values.size());\r
- }\r
- }\r
- else {\r
- log.warn("XMLObject type not recognized by NameIDAttributeDecoder, no values returned");\r
- return NULL;\r
- }\r
- }\r
-\r
- for (; v!=stop; ++v) {\r
- const NameIDType* n2 = dynamic_cast<const NameIDType*>(*v);\r
- if (n2)\r
- extract(n2, dest);\r
- else {\r
- const NameIdentifier* n1=dynamic_cast<const NameIdentifier*>(*v);\r
- if (n1)\r
- extract(n1, dest);\r
- else if ((*v)->hasChildren()) {\r
- const list<XMLObject*>& values = (*v)->getOrderedChildren();\r
- for (list<XMLObject*>::const_iterator vv = values.begin(); vv!=values.end(); ++vv) {\r
- if (n2=dynamic_cast<const NameIDType*>(*vv))\r
- extract(n2, dest);\r
- else if (n1=dynamic_cast<const NameIdentifier*>(*vv))\r
- extract(n1, dest);\r
- else\r
- log.warn("skipping AttributeValue without a recognizable NameID/NameIdentifier");\r
- }\r
- }\r
- }\r
- }\r
-\r
- return dest.empty() ? NULL : nameid.release();\r
- }\r
-\r
- const NameIDType* saml2name = dynamic_cast<const NameIDType*>(xmlObject);\r
- if (saml2name) {\r
- if (log.isDebugEnabled()) {\r
- auto_ptr_char f(saml2name->getFormat());\r
- log.debug("decoding NameIDAttribute (%s) from SAML 2 NameID with Format (%s)", id, f.get() ? f.get() : "unspecified");\r
- }\r
- extract(saml2name, dest);\r
- }\r
- else {\r
- const NameIdentifier* saml1name = dynamic_cast<const NameIdentifier*>(xmlObject);\r
- if (saml1name) {\r
- if (log.isDebugEnabled()) {\r
- auto_ptr_char f(saml1name->getFormat());\r
- log.debug("decoding NameIDAttribute (%s) from SAML 1 NameIdentifier with Format (%s)", id, f.get() ? f.get() : "unspecified");\r
- }\r
- extract(saml1name, dest);\r
- }\r
- else {\r
- log.warn("XMLObject type not recognized by NameIDAttributeDecoder, no values returned");\r
- return NULL;\r
- }\r
- }\r
-\r
- return dest.empty() ? NULL : nameid.release();\r
-}\r
-\r
-void NameIDAttributeDecoder::extract(\r
- const NameIDType* n, vector<NameIDAttribute::Value>& dest, const char* assertingParty, const char* relyingParty\r
- ) const\r
-{\r
- char* name = toUTF8(n->getName());\r
- if (name && *name) {\r
- dest.push_back(NameIDAttribute::Value());\r
- NameIDAttribute::Value& val = dest.back();\r
- val.m_Name = name;\r
- char* str = toUTF8(n->getFormat());\r
- if (str) {\r
- val.m_Format = str;\r
- delete[] str;\r
- }\r
- \r
- str = toUTF8(n->getNameQualifier());\r
- if (str && *str)\r
- val.m_NameQualifier = str;\r
- else if (assertingParty)\r
- val.m_NameQualifier = assertingParty;\r
- delete[] str;\r
- \r
- str = toUTF8(n->getSPNameQualifier());\r
- if (str && *str)\r
- val.m_SPNameQualifier = str;\r
- else if (relyingParty)\r
- val.m_SPNameQualifier = relyingParty;\r
- delete[] str;\r
- \r
- str = toUTF8(n->getSPProvidedID());\r
- if (str) {\r
- val.m_SPProvidedID = str;\r
- delete[] str;\r
- }\r
- }\r
- delete[] name;\r
-}\r
-\r
-void NameIDAttributeDecoder::extract(\r
- const NameIdentifier* n, vector<NameIDAttribute::Value>& dest, const char* assertingParty, const char* relyingParty\r
- ) const\r
-{\r
- char* name = toUTF8(n->getName());\r
- if (name && *name) {\r
- dest.push_back(NameIDAttribute::Value());\r
- NameIDAttribute::Value& val = dest.back();\r
- val.m_Name = name;\r
- char* str = toUTF8(n->getFormat());\r
- if (str) {\r
- val.m_Format = str;\r
- delete[] str;\r
- }\r
-\r
- str = toUTF8(n->getNameQualifier());\r
- if (str && *str)\r
- val.m_NameQualifier = str;\r
- else if (assertingParty)\r
- val.m_NameQualifier = assertingParty;\r
- delete[] str;\r
- \r
- if (relyingParty)\r
- val.m_SPNameQualifier = relyingParty;\r
- }\r
- delete[] name;\r
-}\r
+/**
+ * Licensed to the University Corporation for Advanced Internet
+ * Development, Inc. (UCAID) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
+ *
+ * UCAID licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the
+ * License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
+ */
+
+/**
+ * NameIDAttributeDecoder.cpp
+ *
+ * Decodes SAML into NameIDAttributes.
+ */
+
+#include "internal.h"
+#include "attribute/AttributeDecoder.h"
+#include "attribute/NameIDAttribute.h"
+
+#include <saml/saml1/core/Assertions.h>
+#include <saml/saml2/core/Assertions.h>
+
+using namespace shibsp;
+using namespace opensaml::saml1;
+using namespace opensaml::saml2;
+using namespace xmltooling;
+using namespace std;
+
+namespace shibsp {
+ static const XMLCh formatter[] = UNICODE_LITERAL_9(f,o,r,m,a,t,t,e,r);
+ static const XMLCh defaultQualifiers[] = UNICODE_LITERAL_17(d,e,f,a,u,l,t,Q,u,a,l,i,f,i,e,r,s);
+
+ class SHIBSP_DLLLOCAL NameIDAttributeDecoder : virtual public AttributeDecoder
+ {
+ public:
+ NameIDAttributeDecoder(const DOMElement* e)
+ : AttributeDecoder(e),
+ m_formatter(XMLHelper::getAttrString(e, nullptr, formatter)),
+ m_defaultQualifiers(XMLHelper::getAttrBool(e, false, defaultQualifiers)) {
+ }
+ ~NameIDAttributeDecoder() {}
+
+ // deprecated method
+ shibsp::Attribute* decode(
+ const vector<string>& ids, const XMLObject* xmlObject, const char* assertingParty=nullptr, const char* relyingParty=nullptr
+ ) const {
+ return decode(nullptr, ids, xmlObject, assertingParty, relyingParty);
+ }
+
+ shibsp::Attribute* decode(
+ const GenericRequest*, const vector<string>&, const XMLObject*, const char* assertingParty=nullptr, const char* relyingParty=nullptr
+ ) const;
+
+ private:
+ void extract(
+ const NameIDType* n, vector<NameIDAttribute::Value>& dest, const char* assertingParty, const char* relyingParty
+ ) const;
+ void extract(
+ const NameIdentifier* n, vector<NameIDAttribute::Value>& dest, const char* assertingParty, const char* relyingParty
+ ) const;
+ string m_formatter;
+ bool m_defaultQualifiers;
+ };
+
+ AttributeDecoder* SHIBSP_DLLLOCAL NameIDAttributeDecoderFactory(const DOMElement* const & e)
+ {
+ return new NameIDAttributeDecoder(e);
+ }
+};
+
+shibsp::Attribute* NameIDAttributeDecoder::decode(
+ const GenericRequest*, const vector<string>& ids, const XMLObject* xmlObject, const char* assertingParty, const char* relyingParty
+ ) const
+{
+ auto_ptr<NameIDAttribute> nameid(
+ new NameIDAttribute(ids, (!m_formatter.empty()) ? m_formatter.c_str() : DEFAULT_NAMEID_FORMATTER, m_hashAlg.c_str())
+ );
+ vector<NameIDAttribute::Value>& dest = nameid->getValues();
+ vector<XMLObject*>::const_iterator v,stop;
+
+ Category& log = Category::getInstance(SHIBSP_LOGCAT ".AttributeDecoder.NameID");
+
+ if (xmlObject && XMLString::equals(opensaml::saml1::Attribute::LOCAL_NAME,xmlObject->getElementQName().getLocalPart())) {
+ const opensaml::saml2::Attribute* saml2attr = dynamic_cast<const opensaml::saml2::Attribute*>(xmlObject);
+ if (saml2attr) {
+ const vector<XMLObject*>& values = saml2attr->getAttributeValues();
+ v = values.begin();
+ stop = values.end();
+ if (log.isDebugEnabled()) {
+ auto_ptr_char n(saml2attr->getName());
+ log.debug(
+ "decoding NameIDAttribute (%s) from SAML 2 Attribute (%s) with %lu value(s)",
+ ids.front().c_str(), n.get() ? n.get() : "unnamed", values.size()
+ );
+ }
+ }
+ else {
+ const opensaml::saml1::Attribute* saml1attr = dynamic_cast<const opensaml::saml1::Attribute*>(xmlObject);
+ if (saml1attr) {
+ const vector<XMLObject*>& values = saml1attr->getAttributeValues();
+ v = values.begin();
+ stop = values.end();
+ if (log.isDebugEnabled()) {
+ auto_ptr_char n(saml1attr->getAttributeName());
+ log.debug(
+ "decoding NameIDAttribute (%s) from SAML 1 Attribute (%s) with %lu value(s)",
+ ids.front().c_str(), n.get() ? n.get() : "unnamed", values.size()
+ );
+ }
+ }
+ else {
+ log.warn("XMLObject type not recognized by NameIDAttributeDecoder, no values returned");
+ return nullptr;
+ }
+ }
+
+ for (; v != stop; ++v) {
+ const NameIDType* n2 = dynamic_cast<const NameIDType*>(*v);
+ if (n2) {
+ log.debug("decoding AttributeValue element of saml2:NameIDType type");
+ extract(n2, dest, assertingParty, relyingParty);
+ }
+ else {
+ const NameIdentifier* n1=dynamic_cast<const NameIdentifier*>(*v);
+ if (n1) {
+ log.debug("decoding AttributeValue element of saml1:NameIdentifier type");
+ extract(n1, dest, assertingParty, relyingParty);
+ }
+ else if ((*v)->hasChildren()) {
+ const list<XMLObject*>& values = (*v)->getOrderedChildren();
+ for (list<XMLObject*>::const_iterator vv = values.begin(); vv!=values.end(); ++vv) {
+ if (n2=dynamic_cast<const NameIDType*>(*vv)) {
+ log.debug("decoding saml2:NameID child element of AttributeValue");
+ extract(n2, dest, assertingParty, relyingParty);
+ }
+ else if (n1=dynamic_cast<const NameIdentifier*>(*vv)) {
+ log.debug("decoding saml1:NameIdentifier child element of AttributeValue");
+ extract(n1, dest, assertingParty, relyingParty);
+ }
+ else {
+ log.warn("skipping AttributeValue child element not recognizable as NameID/NameIdentifier");
+ }
+ }
+ }
+ else {
+ log.warn("AttributeValue was not of a supported type and contains no child elements");
+ }
+ }
+ }
+
+ return dest.empty() ? nullptr : nameid.release();
+ }
+
+ const NameIDType* saml2name = dynamic_cast<const NameIDType*>(xmlObject);
+ if (saml2name) {
+ if (log.isDebugEnabled()) {
+ auto_ptr_char f(saml2name->getFormat());
+ log.debug("decoding NameIDAttribute (%s) from SAML 2 NameID with Format (%s)", ids.front().c_str(), f.get() ? f.get() : "unspecified");
+ }
+ extract(saml2name, dest, assertingParty, relyingParty);
+ }
+ else {
+ const NameIdentifier* saml1name = dynamic_cast<const NameIdentifier*>(xmlObject);
+ if (saml1name) {
+ if (log.isDebugEnabled()) {
+ auto_ptr_char f(saml1name->getFormat());
+ log.debug(
+ "decoding NameIDAttribute (%s) from SAML 1 NameIdentifier with Format (%s)",
+ ids.front().c_str(), f.get() ? f.get() : "unspecified"
+ );
+ }
+ extract(saml1name, dest, assertingParty, relyingParty);
+ }
+ else {
+ log.warn("XMLObject type not recognized by NameIDAttributeDecoder, no values returned");
+ return nullptr;
+ }
+ }
+
+ return dest.empty() ? nullptr : nameid.release();
+}
+
+void NameIDAttributeDecoder::extract(
+ const NameIDType* n, vector<NameIDAttribute::Value>& dest, const char* assertingParty, const char* relyingParty
+ ) const
+{
+ auto_arrayptr<char> name(toUTF8(n->getName()));
+ if (name.get() && *name.get()) {
+ dest.push_back(NameIDAttribute::Value());
+ NameIDAttribute::Value& val = dest.back();
+ val.m_Name = name.get();
+
+ auto_arrayptr<char> format(toUTF8(n->getFormat()));
+ if (format.get())
+ val.m_Format = format.get();
+
+ auto_arrayptr<char> nameQualifier(toUTF8(n->getNameQualifier()));
+ if (nameQualifier.get() && *nameQualifier.get())
+ val.m_NameQualifier = nameQualifier.get();
+ else if (m_defaultQualifiers && assertingParty)
+ val.m_NameQualifier = assertingParty;
+
+ auto_arrayptr<char> spNameQualifier(toUTF8(n->getSPNameQualifier()));
+ if (spNameQualifier.get() && *spNameQualifier.get())
+ val.m_SPNameQualifier = spNameQualifier.get();
+ else if (m_defaultQualifiers && relyingParty)
+ val.m_SPNameQualifier = relyingParty;
+
+ auto_arrayptr<char> spProvidedID(toUTF8(n->getSPProvidedID()));
+ if (spProvidedID.get())
+ val.m_SPProvidedID = spProvidedID.get();
+ }
+}
+
+void NameIDAttributeDecoder::extract(
+ const NameIdentifier* n, vector<NameIDAttribute::Value>& dest, const char* assertingParty, const char* relyingParty
+ ) const
+{
+ auto_arrayptr<char> name(toUTF8(n->getName()));
+ if (name.get() && *name.get()) {
+ dest.push_back(NameIDAttribute::Value());
+ NameIDAttribute::Value& val = dest.back();
+ val.m_Name = name.get();
+
+ auto_arrayptr<char> format(toUTF8(n->getFormat()));
+ if (format.get())
+ val.m_Format = format.get();
+
+ auto_arrayptr<char> nameQualifier(toUTF8(n->getNameQualifier()));
+ if (nameQualifier.get() && *nameQualifier.get())
+ val.m_NameQualifier = nameQualifier.get();
+ else if (m_defaultQualifiers && assertingParty)
+ val.m_NameQualifier = assertingParty;
+
+ if (m_defaultQualifiers && relyingParty)
+ val.m_SPNameQualifier = relyingParty;
+ }
+}