Move scoped attribute subclass, add attribute plugin support.
authorcantor <cantor@cb58f699-b61c-0410-a6fe-9272a202ed29>
Sun, 1 May 2005 03:30:09 +0000 (03:30 +0000)
committercantor <cantor@cb58f699-b61c-0410-a6fe-9272a202ed29>
Sun, 1 May 2005 03:30:09 +0000 (03:30 +0000)
git-svn-id: https://svn.middleware.georgetown.edu/cpp-sp/trunk@1573 cb58f699-b61c-0410-a6fe-9272a202ed29

shib/Makefile.am
shib/ScopedAttribute.cpp [new file with mode: 0644]
shib/ShibConfig.cpp
shib/internal.h
shib/shib.dsp
shib/shib.h

index 669eaea..232e918 100644 (file)
@@ -17,7 +17,8 @@ libshib_la_SOURCES = \
                     ShibConfig.cpp \
                     ShibBrowserProfile.cpp \
                     ShibHTTPHook.cpp \
-                    shib-threads.cpp
+                    shib-threads.cpp \
+                    ScopedAttribute.cpp
 
 
 # this is different from the project version
diff --git a/shib/ScopedAttribute.cpp b/shib/ScopedAttribute.cpp
new file mode 100644 (file)
index 0000000..78c5863
--- /dev/null
@@ -0,0 +1,199 @@
+/*
+ * The Shibboleth License, Version 1.
+ * Copyright (c) 2002
+ * University Corporation for Advanced Internet Development, Inc.
+ * All rights reserved
+ *
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution, if any, must include
+ * the following acknowledgment: "This product includes software developed by
+ * the University Corporation for Advanced Internet Development
+ * <http://www.ucaid.edu>Internet2 Project. Alternately, this acknowledegement
+ * may appear in the software itself, if and wherever such third-party
+ * acknowledgments normally appear.
+ *
+ * Neither the name of Shibboleth nor the names of its contributors, nor
+ * Internet2, nor the University Corporation for Advanced Internet Development,
+ * Inc., nor UCAID may be used to endorse or promote products derived from this
+ * software without specific prior written permission. For written permission,
+ * please contact shibboleth@shibboleth.org
+ *
+ * Products derived from this software may not be called Shibboleth, Internet2,
+ * UCAID, or the University Corporation for Advanced Internet Development, nor
+ * may Shibboleth appear in their name, without prior written permission of the
+ * University Corporation for Advanced Internet Development.
+ *
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+ * PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE DISCLAIMED AND THE ENTIRE RISK
+ * OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH LICENSEE.
+ * IN NO EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY
+ * CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC. BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+
+/* ScopedAttribute.cpp - eduPerson scoped attribute base class
+
+   Scott Cantor
+   6/4/02
+
+   $History:$
+*/
+
+#include "internal.h"
+#include <xercesc/util/regx/RegularExpression.hpp>
+#include <log4cpp/Category.hh>
+
+using namespace shibboleth;
+using namespace saml;
+using namespace log4cpp;
+using namespace std;
+
+const XMLCh ScopedAttribute::Scope[] = { chLatin_S, chLatin_c, chLatin_o, chLatin_p, chLatin_e, chNull };
+
+ScopedAttribute::ScopedAttribute(
+    const XMLCh* name,
+    const XMLCh* ns,
+    const saml::QName* type,
+    long lifetime,
+    const saml::Iterator<const XMLCh*>& scopes,
+    const saml::Iterator<const XMLCh*>& values
+    ) : SAMLAttribute(name,ns,type,lifetime,values)
+{
+    RTTI(ScopedAttribute);
+    if (scopes.size()!=values.size())
+        throw MalformedException("ScopedAttribute() requires the number of scopes to equal the number of values");
+
+    while (scopes.hasNext())
+        m_scopes.push_back(saml::XML::assign(scopes.next()));
+}
+
+ScopedAttribute::ScopedAttribute(DOMElement* e) : SAMLAttribute(e,false)
+{
+    RTTI(ScopedAttribute);
+    fromDOM(e);
+}
+
+ScopedAttribute::ScopedAttribute(istream& in) : SAMLAttribute(in,false)
+{
+    RTTI(ScopedAttribute);
+    fromDOM(m_document->getDocumentElement());
+}
+
+ScopedAttribute::~ScopedAttribute()
+{
+    if (m_bOwnStrings) {
+        for (vector<const XMLCh*>::iterator i=m_scopes.begin(); i!=m_scopes.end(); i++) {
+            XMLCh* p = const_cast<XMLCh*>(*i);
+            XMLString::release(&p);
+        }
+    }
+
+    // We always own any scoped values we've built.
+    for (vector<const XMLCh*>::iterator i=m_scopedValues.begin(); i!=m_scopedValues.end(); i++) {
+        XMLCh* p = const_cast<XMLCh*>(*i);
+        XMLString::release(&p);
+    }
+}
+
+void ScopedAttribute::ownStrings()
+{
+    if (!m_bOwnStrings) {
+        for (vector<const XMLCh*>::iterator i=m_scopes.begin(); i!=m_scopes.end(); i++)
+            (*i)=saml::XML::assign(*i);
+        SAMLAttribute::ownStrings();
+    }
+}
+
+Iterator<const XMLCh*> ScopedAttribute::getValues() const
+{
+    static XMLCh at[]={chAt, chNull};
+
+    if (m_scopedValues.empty()) {
+        vector<const XMLCh*>::const_iterator j=m_scopes.begin();
+        for (vector<const XMLCh*>::const_iterator i=m_values.begin(); i!=m_values.end(); i++, j++) {
+            XMLCh* temp=new XMLCh[XMLString::stringLen(*i) + XMLString::stringLen(*j) + 2];
+            temp[0]=chNull;
+            XMLString::catString(temp,*i);
+            XMLString::catString(temp,at);
+            XMLString::catString(temp,*j);
+            m_scopedValues.push_back(temp);
+        }
+    }
+    return m_scopedValues;
+}
+
+Iterator<string> ScopedAttribute::getSingleByteValues() const
+{
+    getValues();
+    if (m_sbValues.empty()) {
+        for (vector<const XMLCh*>::const_iterator i=m_scopedValues.begin(); i!=m_scopedValues.end(); i++) {
+            auto_ptr<char> temp(toUTF8(*i));
+            if (temp.get())
+                m_sbValues.push_back(temp.get());
+        }
+    }
+    return m_sbValues;
+}
+
+void ScopedAttribute::setValues(const Iterator<const XMLCh*>& values)
+{
+    throw SAMLException("unsupported operation");
+}
+
+void ScopedAttribute::addValue(const XMLCh* value)
+{
+    throw SAMLException("unsupported operation");
+}
+
+void ScopedAttribute::removeValue(unsigned int index)
+{
+    if (m_bOwnStrings) {
+        XMLCh* p=const_cast<XMLCh*>(m_scopes[index]);
+        XMLString::release(&p);
+    }
+    m_scopes.erase(m_scopes.begin()+index);
+    
+    if (!m_scopedValues.empty()) {
+        XMLCh* p=const_cast<XMLCh*>(m_scopedValues[index]);
+        XMLString::release(&p);
+        m_scopedValues.erase(m_scopedValues.begin()+index);
+    }
+
+    SAMLAttribute::removeValue(index);
+}
+
+void ScopedAttribute::valueFromDOM(DOMElement* e)
+{
+    SAMLAttribute::valueFromDOM(e);
+    m_scopes.push_back(e->getAttributeNS(NULL,Scope));
+}
+
+void ScopedAttribute::valueToDOM(unsigned int index, DOMElement* e) const
+{
+    SAMLAttribute::valueToDOM(index,e);
+    const XMLCh* scope=m_scopes[index];
+    if (!saml::XML::isEmpty(scope))
+        e->setAttributeNS(NULL,Scope,m_scopes[index]);
+}
+
+SAMLObject* ScopedAttribute::clone() const
+{
+    return new ScopedAttribute(m_name,m_namespace,m_type,m_lifetime,m_scopes,m_values);
+}
index cccb1e4..0db5b55 100644 (file)
@@ -85,6 +85,75 @@ PlugManager::Factory ShibbolethTrustFactory;
 namespace {
     ShibConfig g_config;
     vector<Mutex*> g_openssl_locks;
+#ifdef HAVE_GOOD_STL
+    map<xstring,const IAttributeFactory*> attrMap;
+#else
+    map<XMLCh*,const IAttributeFactory*> attrMap;
+#endif
+}
+
+extern "C" SAMLAttribute* ShibAttributeFactory(DOMElement* e)
+{
+    // First check for an explicit factory.
+#ifdef HAVE_GOOD_STL
+    map<xstring,const IAttributeFactory*>::const_iterator i=attrMap.find(e->getAttributeNS(NULL,L(AttributeName)));
+#else
+    const XMLCh* aname=e->getAttributeNS(NULL,L(AttributeName));
+    map<XMLCh*,const IAttributeFactory*>::const_iterator i;
+    for (i=attrMap.begin(); i!=attrMap.end(); i++)
+        if (!XMLString::compareString(aname,i->first))
+            break;
+#endif
+    if (i!=attrMap.end())
+        return i->second->build(e);
+
+    // Now check for a Scope attribute to ensure proper value handling whenever possible.
+    DOMElement* n=saml::XML::getFirstChildElement(e,saml::XML::SAML_NS,L(AttributeValue));
+    if (n && n->hasAttributeNS(NULL,ScopedAttribute::Scope))
+        return new ScopedAttribute(e);
+        
+    // Just use the default class.
+    return new SAMLAttribute(e);
+}
+
+void ShibConfig::regAttributeMapping(const XMLCh* name, const IAttributeFactory* factory)
+{
+    if (name && factory) {
+#ifdef HAVE_GOOD_STL
+        attrMap[name]=factory;
+#else
+        attrMap.insert(make_pair(XMLString::replicate(name),factory));
+#endif
+    }
+}
+
+void ShibConfig::unregAttributeMapping(const XMLCh* name)
+{
+    if (name) {
+#ifdef HAVE_GOOD_STL
+        attrMap.erase(name);
+#else
+        for (map<XMLCh*,const IAttributeFactory*>::iterator i=attrMap.begin(); i!=attrMap.end(); i++) {
+            if (!XMLString::compareString(name,i->first)) {
+                XMLCh* temp=i->first;
+                XMLString::release(&temp);
+                attrMap.erase(i);
+                break;
+            }
+        }
+#endif
+    }
+}
+
+void ShibConfig::clearAttributeMappings()
+{
+#ifndef HAVE_GOOD_STL
+    for (map<XMLCh*,const IAttributeFactory*>::iterator i=attrMap.begin(); i!=attrMap.end(); i++) {
+        XMLCh* temp=i->first;
+        XMLString::release(&temp);
+    }
+#endif
+    attrMap.clear();
 }
 
 extern "C" void openssl_locking_callback(int mode,int n,const char *file,int line)
@@ -123,14 +192,18 @@ bool ShibConfig::init()
     CRYPTO_set_id_callback(openssl_thread_id);
 #endif
 
+    SAMLAttribute::setFactory(&ShibAttributeFactory);
     return true;
 }
 
 void ShibConfig::term()
 {
+    SAMLAttribute::setFactory(NULL);
+    clearAttributeMappings();
+   
     CRYPTO_set_locking_callback(NULL);
-    for (vector<Mutex*>::iterator i=g_openssl_locks.begin(); i!=g_openssl_locks.end(); i++)
-        delete (*i);
+    for (vector<Mutex*>::iterator j=g_openssl_locks.begin(); j!=g_openssl_locks.end(); j++)
+        delete (*j);
     g_openssl_locks.clear();
 
     // Unregister plugin factories
index 7f49040..0433717 100644 (file)
@@ -89,6 +89,39 @@ namespace shibboleth {
     protected:
         std::vector<saml::KeyInfoResolver*> m_resolvers;
     };
+
+    class ScopedAttribute : public saml::SAMLAttribute
+    {
+    public:
+        ScopedAttribute(
+            const XMLCh* name=NULL,
+            const XMLCh* ns=NULL,
+            const saml::QName* type=NULL,
+            long lifetime=0,
+            const saml::Iterator<const XMLCh*>& scopes=EMPTY(const XMLCh*),
+            const saml::Iterator<const XMLCh*>& values=EMPTY(const XMLCh*)
+            );
+        ScopedAttribute(DOMElement* e);
+        ScopedAttribute(std::istream& in);
+        ~ScopedAttribute();
+    
+        saml::SAMLObject* clone() const;
+        
+        saml::Iterator<const XMLCh*> getValues() const;
+        saml::Iterator<std::string> getSingleByteValues() const;
+        void setValues(const saml::Iterator<const XMLCh*>& values=EMPTY(const XMLCh*));
+        void addValue(const XMLCh* value);
+        void removeValue(unsigned int index);
+        
+        static const XMLCh Scope[];
+    protected:
+        void valueToDOM(unsigned int index, DOMElement* e) const;
+        void valueFromDOM(DOMElement* e);
+        void ownStrings();
+        
+        std::vector<const XMLCh*> m_scopes;
+        mutable std::vector<const XMLCh*> m_scopedValues;
+    };
 }
 
 #endif
index 00a24f8..9030bde 100644 (file)
@@ -121,6 +121,10 @@ SOURCE=.\resource.h
 # End Source File
 # Begin Source File
 
+SOURCE=.\ScopedAttribute.cpp
+# End Source File
+# Begin Source File
+
 SOURCE=".\shib-threads-win32.cpp"
 # End Source File
 # Begin Source File
index a64d689..19560c7 100644 (file)
@@ -362,6 +362,12 @@ namespace shibboleth
         virtual saml::Iterator<const IAttributeRule*> getAttributeRules() const=0;
         virtual ~IAAP() {}
     };
+    
+    struct SHIB_EXPORTS IAttributeFactory : public virtual saml::IPlugIn
+    {
+        virtual saml::SAMLAttribute* build(DOMElement* e) const=0;
+        virtual ~IAttributeFactory() {}
+    };
 
 #ifdef SHIB_INSTANTIATE
     template class SHIB_EXPORTS saml::Iterator<const IContactPerson*>;
@@ -543,6 +549,11 @@ namespace shibboleth
         virtual bool init();
         virtual void term();
 
+        // manages specific attribute name to factory mappings
+        void regAttributeMapping(const XMLCh* name, const IAttributeFactory* factory);
+        void unregAttributeMapping(const XMLCh* name);
+        void clearAttributeMappings();
+
         // enables runtime and clients to access configuration
         static ShibConfig& getConfig();
     };