Clean Solaris build.
[shibboleth/cpp-sp.git] / shibsp / handler / impl / SAML2SessionInitiator.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  * SAML2SessionInitiator.cpp
19  * 
20  * SAML 2.0 AuthnRequest support.
21  */
22
23 #include "internal.h"
24 #include "Application.h"
25 #include "exceptions.h"
26 #include "ServiceProvider.h"
27 #include "SPRequest.h"
28 #include "handler/AbstractHandler.h"
29 #include "handler/RemotedHandler.h"
30 #include "handler/SessionInitiator.h"
31 #include "util/SPConstants.h"
32
33 #ifndef SHIBSP_LITE
34 # include <saml/SAMLConfig.h>
35 # include <saml/saml2/core/Protocols.h>
36 # include <saml/saml2/metadata/EndpointManager.h>
37 # include <saml/saml2/metadata/Metadata.h>
38 # include <saml/saml2/metadata/MetadataCredentialCriteria.h>
39 using namespace opensaml::saml2;
40 using namespace opensaml::saml2p;
41 using namespace opensaml::saml2md;
42 #else
43 #include <xercesc/util/XMLUniDefs.hpp>
44 #endif
45
46 using namespace shibsp;
47 using namespace opensaml;
48 using namespace xmltooling;
49 using namespace std;
50
51 namespace shibsp {
52
53 #if defined (_MSC_VER)
54     #pragma warning( push )
55     #pragma warning( disable : 4250 )
56 #endif
57
58     class SHIBSP_DLLLOCAL SAML2SessionInitiator : public SessionInitiator, public AbstractHandler, public RemotedHandler
59     {
60     public:
61         SAML2SessionInitiator(const DOMElement* e, const char* appId);
62         virtual ~SAML2SessionInitiator() {
63 #ifndef SHIBSP_LITE
64             if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
65                 XMLString::release(&m_outgoing);
66                 for_each(m_encoders.begin(), m_encoders.end(), cleanup_pair<const XMLCh*,MessageEncoder>());
67                 delete m_requestTemplate;
68             }
69 #endif
70         }
71         
72         void setParent(const PropertySet* parent);
73         void receive(DDF& in, ostream& out);
74         pair<bool,long> run(SPRequest& request, const char* entityID=NULL, bool isHandler=true) const;
75
76     private:
77         pair<bool,long> doRequest(
78             const Application& application,
79             HTTPResponse& httpResponse,
80             const char* entityID,
81             const XMLCh* acsIndex,
82             const char* acsLocation,
83             const XMLCh* acsBinding,
84             bool isPassive,
85             bool forceAuthn,
86             const char* authnContextClassRef,
87             const char* authnContextComparison,
88             string& relayState
89             ) const;
90
91         string m_appId;
92         auto_ptr_char m_paosNS,m_ecpNS;
93         auto_ptr_XMLCh m_paosBinding;
94 #ifndef SHIBSP_LITE
95         XMLCh* m_outgoing;
96         vector<const XMLCh*> m_bindings;
97         map<const XMLCh*,MessageEncoder*> m_encoders;
98         MessageEncoder* m_ecp;
99         AuthnRequest* m_requestTemplate;
100 #else
101         bool m_ecp;
102 #endif
103     };
104
105 #if defined (_MSC_VER)
106     #pragma warning( pop )
107 #endif
108
109     SessionInitiator* SHIBSP_DLLLOCAL SAML2SessionInitiatorFactory(const pair<const DOMElement*,const char*>& p)
110     {
111         return new SAML2SessionInitiator(p.first, p.second);
112     }
113
114 };
115
116 SAML2SessionInitiator::SAML2SessionInitiator(const DOMElement* e, const char* appId)
117     : AbstractHandler(e, Category::getInstance(SHIBSP_LOGCAT".SessionInitiator.SAML2")), m_appId(appId),
118         m_paosNS(samlconstants::PAOS_NS), m_ecpNS(samlconstants::SAML20ECP_NS), m_paosBinding(samlconstants::SAML20_BINDING_PAOS)
119 {
120     static const XMLCh ECP[] = UNICODE_LITERAL_3(E,C,P);
121     const XMLCh* flag = e ? e->getAttributeNS(NULL,ECP) : NULL;
122 #ifdef SHIBSP_LITE
123     m_ecp = (flag && (*flag == chLatin_t || *flag == chDigit_1));
124 #else
125     m_outgoing=NULL;
126     m_ecp = NULL;
127     m_requestTemplate=NULL;
128
129     if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
130         // Check for a template AuthnRequest to build from.
131         DOMElement* child = XMLHelper::getFirstChildElement(e, samlconstants::SAML20P_NS, AuthnRequest::LOCAL_NAME);
132         if (child)
133             m_requestTemplate = dynamic_cast<AuthnRequest*>(AuthnRequestBuilder::buildOneFromElement(child));
134
135         // If directed, build an ECP encoder.
136         if (flag && (*flag == chLatin_t || *flag == chDigit_1)) {
137             try {
138                 m_ecp = SAMLConfig::getConfig().MessageEncoderManager.newPlugin(
139                     samlconstants::SAML20_BINDING_PAOS, pair<const DOMElement*,const XMLCh*>(e,NULL)
140                     );
141             }
142             catch (exception& ex) {
143                 m_log.error("error building PAOS/ECP MessageEncoder: %s", ex.what());
144             }
145         }
146
147         // Handle outgoing binding setup.
148         pair<bool,const XMLCh*> outgoing = getXMLString("outgoingBindings");
149         if (outgoing.first) {
150             m_outgoing = XMLString::replicate(outgoing.second);
151             XMLString::trim(m_outgoing);
152         }
153         else {
154             // No override, so we'll install a default binding precedence.
155             string prec = string(samlconstants::SAML20_BINDING_HTTP_REDIRECT) + ' ' + samlconstants::SAML20_BINDING_HTTP_POST + ' ' +
156                 samlconstants::SAML20_BINDING_HTTP_POST_SIMPLESIGN + ' ' + samlconstants::SAML20_BINDING_HTTP_ARTIFACT;
157             m_outgoing = XMLString::transcode(prec.c_str());
158         }
159
160         int pos;
161         XMLCh* start = m_outgoing;
162         while (start && *start) {
163             pos = XMLString::indexOf(start,chSpace);
164             if (pos != -1)
165                 *(start + pos)=chNull;
166             m_bindings.push_back(start);
167             try {
168                 auto_ptr_char b(start);
169                 MessageEncoder * encoder = SAMLConfig::getConfig().MessageEncoderManager.newPlugin(
170                     b.get(),pair<const DOMElement*,const XMLCh*>(e,NULL)
171                     );
172                 m_encoders[start] = encoder;
173                 m_log.debug("supporting outgoing binding (%s)", b.get());
174             }
175             catch (exception& ex) {
176                 m_log.error("error building MessageEncoder: %s", ex.what());
177             }
178             if (pos != -1)
179                 start = start + pos + 1;
180             else
181                 break;
182         }
183     }
184 #endif
185
186     // If Location isn't set, defer address registration until the setParent call.
187     pair<bool,const char*> loc = getString("Location");
188     if (loc.first) {
189         string address = m_appId + loc.second + "::run::SAML2SI";
190         setAddress(address.c_str());
191     }
192 }
193
194 void SAML2SessionInitiator::setParent(const PropertySet* parent)
195 {
196     DOMPropertySet::setParent(parent);
197     pair<bool,const char*> loc = getString("Location");
198     if (loc.first) {
199         string address = m_appId + loc.second + "::run::SAML2SI";
200         setAddress(address.c_str());
201     }
202     else {
203         m_log.warn("no Location property in SAML2 SessionInitiator (or parent), can't register as remoted handler");
204     }
205 }
206
207 pair<bool,long> SAML2SessionInitiator::run(SPRequest& request, const char* entityID, bool isHandler) const
208 {
209     // First check for ECP support, since that doesn't require an IdP to be known.
210     bool ECP = false;
211     if (m_ecp && request.getHeader("Accept").find("application/vnd.paos+xml") != string::npos) {
212         string PAOS = request.getHeader("PAOS");
213         if (PAOS.find(m_paosNS.get()) != string::npos && PAOS.find(m_ecpNS.get()) != string::npos)
214             ECP = true;
215     }
216
217     // We have to know the IdP to function unless this is ECP.
218     if (!ECP && (!entityID || !*entityID))
219         return make_pair(false,0L);
220
221     string target;
222     const Handler* ACS=NULL;
223     const char* option;
224     pair<bool,const char*> acClass;
225     pair<bool,const char*> acComp;
226     bool isPassive=false,forceAuthn=false;
227     const Application& app=request.getApplication();
228
229     // ECP means the ACS will be by value no matter what.
230     pair<bool,bool> acsByIndex = ECP ? make_pair(true,false) : getBool("acsByIndex");
231
232     if (isHandler) {
233         option=request.getParameter("acsIndex");
234         if (option) {
235             ACS = app.getAssertionConsumerServiceByIndex(atoi(option));
236             if (!ACS)
237                 request.log(SPRequest::SPWarn, "invalid acsIndex specified in request, using default ACS location");
238             else if (ECP && !XMLString::equals(ACS->getString("Binding").second, samlconstants::SAML20_BINDING_PAOS)) {
239                 request.log(SPRequest::SPWarn, "acsIndex in request referenced a non-PAOS ACS, using default ACS location");
240                 ACS = NULL;
241             }
242         }
243
244         option = request.getParameter("target");
245         if (option)
246             target = option;
247         if (acsByIndex.first && !acsByIndex.second) {
248             // Since we're passing the ACS by value, we need to compute the return URL,
249             // so we'll need the target resource for real.
250             recoverRelayState(request.getApplication(), request, target, false);
251         }
252
253         option = request.getParameter("isPassive");
254         isPassive = (option && (*option=='1' || *option=='t'));
255         if (!isPassive) {
256             option = request.getParameter("forceAuthn");
257             forceAuthn = (option && (*option=='1' || *option=='t'));
258         }
259
260         acClass.second = request.getParameter("authnContextClassRef");
261         acClass.first = (acClass.second!=NULL);
262         acComp.second = request.getParameter("authnContextComparison");
263         acComp.first = (acComp.second!=NULL);
264     }
265     else {
266         // We're running as a "virtual handler" from within the filter.
267         // The target resource is the current one and everything else is defaulted.
268         target=request.getRequestURL();
269         const PropertySet* settings = request.getRequestSettings().first;
270
271         pair<bool,bool> flag = settings->getBool("isPassive");
272         isPassive = flag.first && flag.second;
273         if (!isPassive) {
274             flag = settings->getBool("forceAuthn");
275             forceAuthn = flag.first && flag.second;
276         }
277
278         acClass = settings->getString("authnContextClassRef");
279         acComp = settings->getString("authnContextComparison");
280     }
281
282     if (ECP)
283         m_log.debug("attempting to initiate session using SAML 2.0 Enhanced Client Profile");
284     else
285         m_log.debug("attempting to initiate session using SAML 2.0 with provider (%s)", entityID);
286
287     if (!ACS) {
288         if (ECP) {
289             const vector<const Handler*>& handlers = app.getAssertionConsumerServicesByBinding(m_paosBinding.get());
290             if (handlers.empty())
291                 throw ConfigurationException("Unable to locate PAOS response endpoint.");
292             ACS = handlers.front();
293         }
294         else {
295             pair<bool,unsigned int> index = getUnsignedInt("defaultACSIndex");
296             if (index.first) {
297                 ACS = app.getAssertionConsumerServiceByIndex(index.second);
298                 if (!ACS)
299                     request.log(SPRequest::SPWarn, "invalid defaultACSIndex, using default ACS location");
300             }
301             if (!ACS)
302                 ACS = app.getDefaultAssertionConsumerService();
303         }
304     }
305
306     // To invoke the request builder, the key requirement is to figure out how
307     // to express the ACS, by index or value, and if by value, where.
308
309     SPConfig& conf = SPConfig::getConfig();
310     if (conf.isEnabled(SPConfig::OutOfProcess)) {
311         if (!acsByIndex.first || acsByIndex.second) {
312             // Pass by Index.
313             if (isHandler) {
314                 // We may already have RelayState set if we looped back here,
315                 // but just in case target is a resource, we reset it back.
316                 target.erase();
317                 option = request.getParameter("target");
318                 if (option)
319                     target = option;
320             }
321             return doRequest(
322                 app, request, entityID,
323                 ACS ? ACS->getXMLString("index").second : NULL, NULL, NULL,
324                 isPassive, forceAuthn,
325                 acClass.first ? acClass.second : NULL,
326                 acComp.first ? acComp.second : NULL,
327                 target
328                 );
329         }
330
331         // Since we're not passing by index, we need to fully compute the return URL and binding.
332         // Compute the ACS URL. We add the ACS location to the base handlerURL.
333         string ACSloc=request.getHandlerURL(target.c_str());
334         pair<bool,const char*> loc=ACS ? ACS->getString("Location") : pair<bool,const char*>(false,NULL);
335         if (loc.first) ACSloc+=loc.second;
336
337         if (isHandler) {
338             // We may already have RelayState set if we looped back here,
339             // but just in case target is a resource, we reset it back.
340             target.erase();
341             option = request.getParameter("target");
342             if (option)
343                 target = option;
344         }
345
346         return doRequest(
347             app, request, entityID,
348             NULL, ACSloc.c_str(), ACS ? ACS->getXMLString("Binding").second : NULL,
349             isPassive, forceAuthn,
350             acClass.first ? acClass.second : NULL,
351             acComp.first ? acComp.second : NULL,
352             target
353             );
354     }
355
356     // Remote the call.
357     DDF out,in = DDF(m_address.c_str()).structure();
358     DDFJanitor jin(in), jout(out);
359     in.addmember("application_id").string(app.getId());
360     if (entityID)
361         in.addmember("entity_id").string(entityID);
362     if (isPassive)
363         in.addmember("isPassive").integer(1);
364     else if (forceAuthn)
365         in.addmember("forceAuthn").integer(1);
366     if (acClass.first)
367         in.addmember("authnContextClassRef").string(acClass.second);
368     if (acComp.first)
369         in.addmember("authnContextComparison").string(acComp.second);
370     if (!acsByIndex.first || acsByIndex.second) {
371         if (ACS)
372             in.addmember("acsIndex").string(ACS->getString("index").second);
373     }
374     else {
375         // Since we're not passing by index, we need to fully compute the return URL and binding.
376         // Compute the ACS URL. We add the ACS location to the base handlerURL.
377         string ACSloc=request.getHandlerURL(target.c_str());
378         pair<bool,const char*> loc=ACS ? ACS->getString("Location") : pair<bool,const char*>(false,NULL);
379         if (loc.first) ACSloc+=loc.second;
380         in.addmember("acsLocation").string(ACSloc.c_str());
381         if (ACS)
382             in.addmember("acsBinding").string(ACS->getString("Binding").second);
383     }
384
385     if (isHandler) {
386         // We may already have RelayState set if we looped back here,
387         // but just in case target is a resource, we reset it back.
388         target.erase();
389         option = request.getParameter("target");
390         if (option)
391             target = option;
392     }
393     if (!target.empty())
394         in.addmember("RelayState").string(target.c_str());
395
396     // Remote the processing.
397     out = request.getServiceProvider().getListenerService()->send(in);
398     return unwrap(request, out);
399 }
400
401 void SAML2SessionInitiator::receive(DDF& in, ostream& out)
402 {
403     // Find application.
404     const char* aid=in["application_id"].string();
405     const Application* app=aid ? SPConfig::getConfig().getServiceProvider()->getApplication(aid) : NULL;
406     if (!app) {
407         // Something's horribly wrong.
408         m_log.error("couldn't find application (%s) to generate AuthnRequest", aid ? aid : "(missing)");
409         throw ConfigurationException("Unable to locate application for new session, deleted?");
410     }
411
412     DDF ret(NULL);
413     DDFJanitor jout(ret);
414
415     // Wrap the outgoing object with a Response facade.
416     auto_ptr<HTTPResponse> http(getResponse(ret));
417
418     auto_ptr_XMLCh index(in["acsIndex"].string());
419     auto_ptr_XMLCh bind(in["acsBinding"].string());
420
421     string relayState(in["RelayState"].string() ? in["RelayState"].string() : "");
422
423     // Since we're remoted, the result should either be a throw, which we pass on,
424     // a false/0 return, which we just return as an empty structure, or a response/redirect,
425     // which we capture in the facade and send back.
426     doRequest(
427         *app, *http.get(), in["entity_id"].string(),
428         index.get(), in["acsLocation"].string(), bind.get(),
429         in["isPassive"].integer()==1, in["forceAuthn"].integer()==1,
430         in["authnContextClassRef"].string(), in["authnContextComparison"].string(),
431         relayState
432         );
433     out << ret;
434 }
435
436 #ifndef SHIBSP_LITE
437 namespace {
438     class _sameIdP : public binary_function<const IDPEntry*, const XMLCh*, bool>
439     {
440     public:
441         bool operator()(const IDPEntry* entry, const XMLCh* entityID) const {
442             return entry ? XMLString::equals(entry->getProviderID(), entityID) : false;
443         }
444     };
445 };
446 #endif
447
448 pair<bool,long> SAML2SessionInitiator::doRequest(
449     const Application& app,
450     HTTPResponse& httpResponse,
451     const char* entityID,
452     const XMLCh* acsIndex,
453     const char* acsLocation,
454     const XMLCh* acsBinding,
455     bool isPassive,
456     bool forceAuthn,
457     const char* authnContextClassRef,
458     const char* authnContextComparison,
459     string& relayState
460     ) const
461 {
462 #ifndef SHIBSP_LITE
463     bool ECP = XMLString::equals(acsBinding, m_paosBinding.get());
464
465     pair<const EntityDescriptor*,const RoleDescriptor*> entity = pair<const EntityDescriptor*,const RoleDescriptor*>(NULL,NULL);
466     const IDPSSODescriptor* role = NULL;
467     const EndpointType* ep = NULL;
468     const MessageEncoder* encoder = NULL;
469     
470     if (ECP) {
471         encoder = m_ecp;
472         if (!encoder) {
473             m_log.error("MessageEncoder for PAOS binding not available");
474             return make_pair(false,0L);
475         }
476     }
477     else {
478         // Use metadata to locate the IdP's SSO service.
479         MetadataProvider* m=app.getMetadataProvider();
480         Locker locker(m);
481         MetadataProvider::Criteria mc(entityID, &IDPSSODescriptor::ELEMENT_QNAME, samlconstants::SAML20P_NS);
482         entity=m->getEntityDescriptor(mc);
483         if (!entity.first) {
484             m_log.error("unable to locate metadata for provider (%s)", entityID);
485             throw MetadataException("Unable to locate metadata for identity provider ($entityID)", namedparams(1, "entityID", entityID));
486         }
487         else if (!entity.second) {
488             m_log.error("unable to locate SAML 2.0 identity provider role for provider (%s)", entityID);
489             return make_pair(false,0L);
490         }
491
492         // Loop over the supportable outgoing bindings.
493         role = dynamic_cast<const IDPSSODescriptor*>(entity.second);
494         vector<const XMLCh*>::const_iterator b;
495         for (b = m_bindings.begin(); b!=m_bindings.end(); ++b) {
496             if (ep=EndpointManager<SingleSignOnService>(role->getSingleSignOnServices()).getByBinding(*b)) {
497                 map<const XMLCh*,MessageEncoder*>::const_iterator enc = m_encoders.find(*b);
498                 if (enc!=m_encoders.end())
499                     encoder = enc->second;
500                 break;
501             }
502         }
503         if (!ep || !encoder) {
504             m_log.error("unable to locate compatible SSO service for provider (%s)", entityID);
505             return make_pair(false,0L);
506         }
507     }
508
509     preserveRelayState(app, httpResponse, relayState);
510
511     auto_ptr<AuthnRequest> req(m_requestTemplate ? m_requestTemplate->cloneAuthnRequest() : AuthnRequestBuilder::buildAuthnRequest());
512     if (m_requestTemplate) {
513         // Freshen TS and ID.
514         req->setID(NULL);
515         req->setIssueInstant(time(NULL));
516     }
517
518     if (ep)
519         req->setDestination(ep->getLocation());
520     if (acsIndex && *acsIndex)
521         req->setAssertionConsumerServiceIndex(acsIndex);
522     if (acsLocation) {
523         auto_ptr_XMLCh wideloc(acsLocation);
524         req->setAssertionConsumerServiceURL(wideloc.get());
525     }
526     if (acsBinding && *acsBinding)
527         req->setProtocolBinding(acsBinding);
528     if (isPassive)
529         req->IsPassive(isPassive);
530     else if (forceAuthn)
531         req->ForceAuthn(forceAuthn);
532     if (!req->getIssuer()) {
533         Issuer* issuer = IssuerBuilder::buildIssuer();
534         req->setIssuer(issuer);
535         issuer->setName(app.getXMLString("entityID").second);
536     }
537     if (!req->getNameIDPolicy()) {
538         NameIDPolicy* namepol = NameIDPolicyBuilder::buildNameIDPolicy();
539         req->setNameIDPolicy(namepol);
540         namepol->AllowCreate(true);
541     }
542     if (authnContextClassRef || authnContextComparison) {
543         RequestedAuthnContext* reqContext = req->getRequestedAuthnContext();
544         if (!reqContext) {
545             reqContext = RequestedAuthnContextBuilder::buildRequestedAuthnContext();
546             req->setRequestedAuthnContext(reqContext);
547         }
548         if (authnContextClassRef) {
549             reqContext->getAuthnContextDeclRefs().clear();
550             auto_ptr_XMLCh wideclass(authnContextClassRef);
551             AuthnContextClassRef* cref = AuthnContextClassRefBuilder::buildAuthnContextClassRef();
552             cref->setReference(wideclass.get());
553             reqContext->getAuthnContextClassRefs().push_back(cref);
554         }
555         if (authnContextComparison &&
556                 (!reqContext->getAuthnContextClassRefs().empty() || !reqContext->getAuthnContextDeclRefs().empty())) {
557             auto_ptr_XMLCh widecomp(authnContextComparison);
558             reqContext->setComparison(widecomp.get());
559         }
560     }
561
562     if (ECP && entityID) {
563         auto_ptr_XMLCh wideid(entityID);
564         Scoping* scoping = req->getScoping();
565         if (!scoping) {
566             scoping = ScopingBuilder::buildScoping();
567             req->setScoping(scoping);
568         }
569         IDPList* idplist = scoping->getIDPList();
570         if (!idplist) {
571             idplist = IDPListBuilder::buildIDPList();
572             scoping->setIDPList(idplist);
573         }
574         VectorOf(IDPEntry) entries = idplist->getIDPEntrys();
575         if (find_if(entries, bind2nd(_sameIdP(), wideid.get())) == NULL) {
576             IDPEntry* entry = IDPEntryBuilder::buildIDPEntry();
577             entry->setProviderID(wideid.get());
578             entries.push_back(entry);
579         }
580     }
581
582     auto_ptr_char dest(ep ? ep->getLocation() : NULL);
583
584     long ret = sendMessage(
585         *encoder, req.get(), relayState.c_str(), dest.get(), role, app, httpResponse, role ? role->WantAuthnRequestsSigned() : false
586         );
587     req.release();  // freed by encoder
588     return make_pair(true,ret);
589 #else
590     return make_pair(false,0L);
591 #endif
592 }