Change API to permit session initiators to modify the entityID mid-chain.
[shibboleth/sp.git] / shibsp / handler / impl / ChainingSessionInitiator.cpp
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  * ChainingSessionInitiator.cpp
19  * 
20  * Chains together multiple SessionInitiator handlers in sequence.
21  */
22
23 #include "internal.h"
24 #include "exceptions.h"
25 #include "handler/AbstractHandler.h"
26 #include "handler/SessionInitiator.h"
27 #include "util/SPConstants.h"
28
29 #include <xercesc/util/XMLUniDefs.hpp>
30 #include <xmltooling/util/XMLHelper.h>
31
32 using namespace shibsp;
33 using namespace xmltooling;
34 using namespace std;
35
36 namespace shibsp {
37
38 #if defined (_MSC_VER)
39     #pragma warning( push )
40     #pragma warning( disable : 4250 )
41 #endif
42
43     class SHIBSP_DLLLOCAL ChainingSessionInitiator : public SessionInitiator, public AbstractHandler
44     {
45     public:
46         ChainingSessionInitiator(const DOMElement* e, const char* appId);
47         virtual ~ChainingSessionInitiator() {
48             for_each(m_handlers.begin(), m_handlers.end(), xmltooling::cleanup<SessionInitiator>());
49         }
50         
51         pair<bool,long> run(SPRequest& request, string& entityID, bool isHandler=true) const;
52
53 #ifndef SHIBSP_LITE
54         void generateMetadata(opensaml::saml2md::SPSSODescriptor& role, const char* handlerURL) const {
55             for (vector<SessionInitiator*>::const_iterator i = m_handlers.begin(); i!=m_handlers.end(); ++i)
56                 (*i)->generateMetadata(role, handlerURL);
57         }
58 #endif
59
60     private:
61         vector<SessionInitiator*> m_handlers;
62     };
63
64 #if defined (_MSC_VER)
65     #pragma warning( pop )
66 #endif
67
68     static const XMLCh _SessionInitiator[] =    UNICODE_LITERAL_16(S,e,s,s,i,o,n,I,n,i,t,i,a,t,o,r);
69     static const XMLCh _type[] =                UNICODE_LITERAL_4(t,y,p,e);
70
71     class SHIBSP_DLLLOCAL SessionInitiatorNodeFilter : public DOMNodeFilter
72     {
73     public:
74         short acceptNode(const DOMNode* node) const {
75             if (XMLHelper::isNodeNamed(node,shibspconstants::SHIB2SPCONFIG_NS,_SessionInitiator))
76                 return FILTER_REJECT;
77             return FILTER_ACCEPT;
78         }
79     };
80
81     static SHIBSP_DLLLOCAL SessionInitiatorNodeFilter g_SINFilter;
82
83     SessionInitiator* SHIBSP_DLLLOCAL ChainingSessionInitiatorFactory(const pair<const DOMElement*,const char*>& p)
84     {
85         return new ChainingSessionInitiator(p.first, p.second);
86     }
87 };
88
89 ChainingSessionInitiator::ChainingSessionInitiator(const DOMElement* e, const char* appId)
90     : AbstractHandler(e, Category::getInstance(SHIBSP_LOGCAT".SessionInitiator.Chaining"), &g_SINFilter)
91 {
92     SPConfig& conf = SPConfig::getConfig();
93
94     // Load up the chain of handlers.
95     e = e ? XMLHelper::getFirstChildElement(e, _SessionInitiator) : NULL;
96     while (e) {
97         auto_ptr_char type(e->getAttributeNS(NULL,_type));
98         if (type.get() && *(type.get())) {
99             try {
100                 m_handlers.push_back(conf.SessionInitiatorManager.newPlugin(type.get(),make_pair(e, appId)));
101                 m_handlers.back()->setParent(this);
102             }
103             catch (exception& ex) {
104                 m_log.error("caught exception processing embedded SessionInitiator element: %s", ex.what());
105             }
106         }
107         e = XMLHelper::getNextSiblingElement(e, _SessionInitiator);
108     }
109 }
110
111 pair<bool,long> ChainingSessionInitiator::run(SPRequest& request, string& entityID, bool isHandler) const
112 {
113     pair<bool,long> ret;
114     for (vector<SessionInitiator*>::const_iterator i = m_handlers.begin(); i!=m_handlers.end(); ++i) {
115         ret = (*i)->run(request, entityID, isHandler);
116         if (ret.first)
117             return ret;
118     }
119     throw ConfigurationException("None of the configured SessionInitiators handled the request.");
120 }