Refactor assertion extraction into handlers.
[shibboleth/cpp-sp.git] / shibsp / attribute / resolver / impl / QueryAttributeResolver.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  * QueryAttributeResolver.cpp
19  * 
20  * AttributeResolver based on SAML queries.
21  */
22
23 #include "internal.h"
24 #include "Application.h"
25 #include "ServiceProvider.h"
26 #include "SessionCache.h"
27 #include "attribute/Attribute.h"
28 #include "attribute/filtering/AttributeFilter.h"
29 #include "attribute/filtering/BasicFilteringContext.h"
30 #include "attribute/resolver/AttributeExtractor.h"
31 #include "attribute/resolver/AttributeResolver.h"
32 #include "attribute/resolver/ResolutionContext.h"
33 #include "binding/SOAPClient.h"
34 #include "util/SPConstants.h"
35
36 #include <saml/exceptions.h>
37 #include <saml/binding/SecurityPolicy.h>
38 #include <saml/saml1/binding/SAML1SOAPClient.h>
39 #include <saml/saml1/core/Assertions.h>
40 #include <saml/saml1/core/Protocols.h>
41 #include <saml/saml1/profile/AssertionValidator.h>
42 #include <saml/saml2/binding/SAML2SOAPClient.h>
43 #include <saml/saml2/core/Protocols.h>
44 #include <saml/saml2/metadata/Metadata.h>
45 #include <saml/saml2/metadata/MetadataProvider.h>
46 #include <saml/saml2/profile/AssertionValidator.h>
47 #include <xmltooling/util/NDC.h>
48 #include <xmltooling/util/XMLHelper.h>
49 #include <xercesc/util/XMLUniDefs.hpp>
50
51 using namespace shibsp;
52 using namespace opensaml::saml1;
53 using namespace opensaml::saml1p;
54 using namespace opensaml::saml2;
55 using namespace opensaml::saml2p;
56 using namespace opensaml::saml2md;
57 using namespace opensaml;
58 using namespace xmltooling;
59 using namespace std;
60
61 namespace shibsp {
62
63     class SHIBSP_DLLLOCAL QueryContext : public ResolutionContext
64     {
65     public:
66         QueryContext(const Application& application, const Session& session)
67                 : m_query(true), m_app(application), m_session(&session), m_metadata(NULL), m_entity(NULL), m_nameid(NULL) {
68             m_protocol = XMLString::transcode(session.getProtocol());
69             m_class = XMLString::transcode(session.getAuthnContextClassRef());
70             m_decl = XMLString::transcode(session.getAuthnContextDeclRef());
71         }
72         
73         QueryContext(
74             const Application& application,
75             const EntityDescriptor* issuer,
76             const XMLCh* protocol,
77             const NameID* nameid,
78             const XMLCh* authncontext_class=NULL,
79             const XMLCh* authncontext_decl=NULL,
80             const vector<const opensaml::Assertion*>* tokens=NULL,
81             const vector<Attribute*>* attributes=NULL
82             ) : m_query(true), m_app(application), m_session(NULL), m_metadata(NULL), m_entity(issuer),
83                 m_protocol(protocol), m_nameid(nameid), m_class(authncontext_class), m_decl(authncontext_decl) {
84
85             if (tokens) {
86                 for (vector<const opensaml::Assertion*>::const_iterator t = tokens->begin(); t!=tokens->end(); ++t) {
87                     const saml2::Assertion* token2 = dynamic_cast<const saml2::Assertion*>(*t);
88                     if (token2 && !token2->getAttributeStatements().empty()) {
89                         m_query = false;
90                     }
91                     else {
92                         const saml1::Assertion* token1 = dynamic_cast<const saml1::Assertion*>(*t);
93                         if (token1 && !token1->getAttributeStatements().empty()) {
94                             m_query = false;
95                         }
96                     }
97                 }
98             }
99         }
100         
101         ~QueryContext() {
102             if (m_session) {
103                 XMLString::release((XMLCh**)&m_protocol);
104                 XMLString::release((XMLCh**)&m_class);
105                 XMLString::release((XMLCh**)&m_decl);
106             }
107             if (m_metadata)
108                 m_metadata->unlock();
109             for_each(m_attributes.begin(), m_attributes.end(), xmltooling::cleanup<shibsp::Attribute>());
110             for_each(m_assertions.begin(), m_assertions.end(), xmltooling::cleanup<opensaml::Assertion>());
111         }
112     
113         bool doQuery() const {
114             return m_query;
115         }
116
117         const Application& getApplication() const {
118             return m_app;
119         }
120         const EntityDescriptor* getEntityDescriptor() const {
121             if (m_entity)
122                 return m_entity;
123             if (m_session && m_session->getEntityID()) {
124                 m_metadata = m_app.getMetadataProvider();
125                 if (m_metadata) {
126                     m_metadata->lock();
127                     return m_entity = m_metadata->getEntityDescriptor(m_session->getEntityID());
128                 }
129             }
130             return NULL;
131         }
132         const XMLCh* getProtocol() const {
133             return m_protocol;
134         }
135         const NameID* getNameID() const {
136             return m_session ? m_session->getNameID() : m_nameid;
137         }
138         const XMLCh* getClassRef() const {
139             return m_class;
140         }
141         const XMLCh* getDeclRef() const {
142             return m_decl;
143         }
144         const Session* getSession() const {
145             return m_session;
146         }
147         vector<shibsp::Attribute*>& getResolvedAttributes() {
148             return m_attributes;
149         }
150         vector<opensaml::Assertion*>& getResolvedAssertions() {
151             return m_assertions;
152         }
153
154     private:
155         bool m_query;
156         const Application& m_app;
157         const Session* m_session;
158         mutable MetadataProvider* m_metadata;
159         mutable const EntityDescriptor* m_entity;
160         const XMLCh* m_protocol;
161         const NameID* m_nameid;
162         const XMLCh* m_class;
163         const XMLCh* m_decl;
164         vector<shibsp::Attribute*> m_attributes;
165         vector<opensaml::Assertion*> m_assertions;
166     };
167     
168     class SHIBSP_DLLLOCAL QueryResolver : public AttributeResolver
169     {
170     public:
171         QueryResolver(const DOMElement* e);
172         ~QueryResolver() {
173             for_each(m_SAML1Designators.begin(), m_SAML1Designators.end(), xmltooling::cleanup<AttributeDesignator>());
174             for_each(m_SAML2Designators.begin(), m_SAML2Designators.end(), xmltooling::cleanup<saml2::Attribute>());
175         }
176
177         Lockable* lock() {return this;}
178         void unlock() {}
179         
180         ResolutionContext* createResolutionContext(
181             const Application& application,
182             const EntityDescriptor* issuer,
183             const XMLCh* protocol,
184             const NameID* nameid,
185             const XMLCh* authncontext_class=NULL,
186             const XMLCh* authncontext_decl=NULL,
187             const vector<const opensaml::Assertion*>* tokens=NULL,
188             const vector<shibsp::Attribute*>* attributes=NULL
189             ) const {
190             return new QueryContext(application,issuer,protocol,nameid,authncontext_class,authncontext_decl,tokens,attributes);
191         }
192
193         ResolutionContext* createResolutionContext(const Application& application, const Session& session) const {
194             return new QueryContext(application,session);
195         }
196
197         void resolveAttributes(ResolutionContext& ctx) const;
198
199         void getAttributeIds(vector<string>& attributes) const {
200             // Nothing to do, only the extractor would actually generate them.
201         }
202
203     private:
204         bool SAML1Query(QueryContext& ctx) const;
205         bool SAML2Query(QueryContext& ctx) const;
206
207         Category& m_log;
208         vector<AttributeDesignator*> m_SAML1Designators;
209         vector<saml2::Attribute*> m_SAML2Designators;
210     };
211
212     AttributeResolver* SHIBSP_DLLLOCAL QueryResolverFactory(const DOMElement* const & e)
213     {
214         return new QueryResolver(e);
215     }
216     
217 };
218
219 void SHIBSP_API shibsp::registerAttributeResolvers()
220 {
221     SPConfig::getConfig().AttributeResolverManager.registerFactory(QUERY_ATTRIBUTE_RESOLVER, QueryResolverFactory);
222 }
223
224 QueryResolver::QueryResolver(const DOMElement* e) : m_log(Category::getInstance(SHIBSP_LOGCAT".AttributeResolver"))
225 {
226 #ifdef _DEBUG
227     xmltooling::NDC ndc("QueryResolver");
228 #endif
229     
230     DOMElement* child = XMLHelper::getFirstChildElement(e);
231     while (child) {
232         try {
233             if (XMLHelper::isNodeNamed(e, samlconstants::SAML20_NS, saml2::Attribute::LOCAL_NAME)) {
234                 auto_ptr<XMLObject> obj(saml2::AttributeBuilder::buildOneFromElement(child));
235                 saml2::Attribute* down = dynamic_cast<saml2::Attribute*>(obj.get());
236                 if (down) {
237                     m_SAML2Designators.push_back(down);
238                     obj.release();
239                 }
240             }
241             else if (XMLHelper::isNodeNamed(e, samlconstants::SAML1P_NS, AttributeDesignator::LOCAL_NAME)) {
242                 auto_ptr<XMLObject> obj(AttributeDesignatorBuilder::buildOneFromElement(child));
243                 AttributeDesignator* down = dynamic_cast<AttributeDesignator*>(obj.get());
244                 if (down) {
245                     m_SAML1Designators.push_back(down);
246                     obj.release();
247                 }
248             }
249         }
250         catch (exception& ex) {
251             m_log.error("exception loading attribute designator: %s", ex.what());
252         }
253         child = XMLHelper::getNextSiblingElement(child);
254     }
255 }
256
257 bool QueryResolver::SAML1Query(QueryContext& ctx) const
258 {
259 #ifdef _DEBUG
260     xmltooling::NDC ndc("query");
261 #endif
262
263     int version = XMLString::equals(ctx.getProtocol(), samlconstants::SAML11_PROTOCOL_ENUM) ? 1 : 0;
264     const AttributeAuthorityDescriptor* AA = ctx.getEntityDescriptor()->getAttributeAuthorityDescriptor(ctx.getProtocol());
265     if (!AA) {
266         m_log.warn("no SAML 1.%d AttributeAuthority role found in metadata", version);
267         return false;
268     }
269
270     const Application& application = ctx.getApplication();
271     shibsp::SecurityPolicy policy(application);
272     MetadataCredentialCriteria mcc(*AA);
273     shibsp::SOAPClient soaper(policy);
274     const PropertySet* policySettings =
275         application.getServiceProvider().getPolicySettings(application.getString("policyId").second);
276     pair<bool,bool> signedAssertions = policySettings->getBool("signedAssertions");
277
278     auto_ptr_XMLCh binding(samlconstants::SAML1_BINDING_SOAP);
279     saml1p::Response* response=NULL;
280     const vector<AttributeService*>& endpoints=AA->getAttributeServices();
281     for (vector<AttributeService*>::const_iterator ep=endpoints.begin(); !response && ep!=endpoints.end(); ++ep) {
282         try {
283             if (!XMLString::equals((*ep)->getBinding(),binding.get()))
284                 continue;
285             auto_ptr_char loc((*ep)->getLocation());
286             auto_ptr_XMLCh issuer(application.getString("entityID").second);
287             NameIdentifier* nameid = NameIdentifierBuilder::buildNameIdentifier();
288             nameid->setName(ctx.getNameID()->getName());
289             nameid->setFormat(ctx.getNameID()->getFormat());
290             nameid->setNameQualifier(ctx.getNameID()->getNameQualifier());
291             saml1::Subject* subject = saml1::SubjectBuilder::buildSubject();
292             subject->setNameIdentifier(nameid);
293             saml1p::AttributeQuery* query = saml1p::AttributeQueryBuilder::buildAttributeQuery();
294             query->setSubject(subject);
295             query->setResource(issuer.get());
296             for (vector<AttributeDesignator*>::const_iterator ad = m_SAML1Designators.begin(); ad!=m_SAML1Designators.end(); ++ad)
297                 query->getAttributeDesignators().push_back((*ad)->cloneAttributeDesignator());
298             Request* request = RequestBuilder::buildRequest();
299             request->setAttributeQuery(query);
300             request->setMinorVersion(version);
301
302             SAML1SOAPClient client(soaper, false);
303             client.sendSAML(request, application.getId(), mcc, loc.get());
304             response = client.receiveSAML();
305         }
306         catch (exception& ex) {
307             m_log.error("exception making SAML query: %s", ex.what());
308             soaper.reset();
309         }
310     }
311
312     if (!response) {
313         m_log.error("unable to obtain a SAML response from attribute authority");
314         return false;
315     }
316     else if (!response->getStatus() || !response->getStatus()->getStatusCode() || response->getStatus()->getStatusCode()->getValue()==NULL ||
317             *(response->getStatus()->getStatusCode()->getValue()) != saml1p::StatusCode::SUCCESS) {
318         delete response;
319         m_log.error("attribute authority returned a SAML error");
320         return true;
321     }
322
323     const vector<saml1::Assertion*>& assertions = const_cast<const saml1p::Response*>(response)->getAssertions();
324     if (assertions.empty()) {
325         delete response;
326         m_log.warn("response from attribute authority was empty");
327         return true;
328     }
329     else if (assertions.size()>1)
330         m_log.warn("simple resolver only supports one assertion in the query response");
331
332     auto_ptr<saml1p::Response> wrapper(response);
333     saml1::Assertion* newtoken = assertions.front();
334
335     if (!newtoken->getSignature() && signedAssertions.first && signedAssertions.second) {
336         m_log.error("assertion unsigned, rejecting it based on signedAssertions policy");
337         return true;
338     }
339
340     try {
341         // We're going to insist that the assertion issuer is the same as the peer.
342         // Reset the policy's message bits and extract them from the assertion.
343         policy.reset(true);
344         policy.setMessageID(newtoken->getAssertionID());
345         policy.setIssueInstant(newtoken->getIssueInstantEpoch());
346         policy.setIssuer(newtoken->getIssuer());
347         policy.evaluate(*newtoken);
348
349         // Now we can check the security status of the policy.
350         if (!policy.isAuthenticated())
351             throw SecurityPolicyException("Security of SAML 1.x query result not established.");
352
353         // Lastly, check it over.
354         saml1::AssertionValidator tokval(application.getAudiences(), time(NULL));
355         tokval.validateAssertion(*newtoken);
356     }
357     catch (exception& ex) {
358         m_log.error("assertion failed policy/validation: %s", ex.what());
359         return true;
360     }
361
362     newtoken->detach();
363     wrapper.release();
364     ctx.getResolvedAssertions().push_back(newtoken);
365
366     // Finally, extract and filter the result.
367     try {
368         AttributeExtractor* extractor = application.getAttributeExtractor();
369         if (extractor) {
370             Locker extlocker(extractor);
371             extractor->extractAttributes(application, AA, *newtoken, ctx.getResolvedAttributes());
372         }
373
374         AttributeFilter* filter = application.getAttributeFilter();
375         if (filter) {
376             BasicFilteringContext fc(application, ctx.getResolvedAttributes(), AA, ctx.getClassRef(), ctx.getDeclRef());
377             Locker filtlocker(filter);
378             filter->filterAttributes(fc, ctx.getResolvedAttributes());
379         }
380     }
381     catch (exception& ex) {
382         m_log.error("caught exception extracting/filtering attributes from query result: %s", ex.what());
383         for_each(ctx.getResolvedAttributes().begin(), ctx.getResolvedAttributes().end(), xmltooling::cleanup<shibsp::Attribute>());
384         ctx.getResolvedAttributes().clear();
385     }
386
387     return true;
388 }
389
390 bool QueryResolver::SAML2Query(QueryContext& ctx) const
391 {
392 #ifdef _DEBUG
393     xmltooling::NDC ndc("query");
394 #endif
395
396     const AttributeAuthorityDescriptor* AA = ctx.getEntityDescriptor()->getAttributeAuthorityDescriptor(samlconstants::SAML20P_NS);
397     if (!AA) {
398         m_log.warn("no SAML 2 AttributeAuthority role found in metadata");
399         return false;
400     }
401
402     const Application& application = ctx.getApplication();
403     shibsp::SecurityPolicy policy(application);
404     MetadataCredentialCriteria mcc(*AA);
405     shibsp::SOAPClient soaper(policy);
406     const PropertySet* policySettings = application.getServiceProvider().getPolicySettings(application.getString("policyId").second);
407     pair<bool,bool> signedAssertions = policySettings->getBool("signedAssertions");
408
409     const PropertySet* relyingParty = application.getRelyingParty(ctx.getEntityDescriptor());
410     pair<bool,const char*> encryption = relyingParty->getString("encryption");
411
412     auto_ptr_XMLCh binding(samlconstants::SAML20_BINDING_SOAP);
413     saml2p::StatusResponseType* srt=NULL;
414     const vector<AttributeService*>& endpoints=AA->getAttributeServices();
415     for (vector<AttributeService*>::const_iterator ep=endpoints.begin(); !srt && ep!=endpoints.end(); ++ep) {
416         try {
417             if (!XMLString::equals((*ep)->getBinding(),binding.get()))
418                 continue;
419             auto_ptr_char loc((*ep)->getLocation());
420             auto_ptr_XMLCh issuer(application.getString("entityID").second);
421
422             auto_ptr<saml2::Subject> subject(saml2::SubjectBuilder::buildSubject());
423
424             // Encrypt the NameID?
425             if (encryption.first && (!strcmp(encryption.second, "true") || !strcmp(encryption.second, "back"))) {
426                 auto_ptr<EncryptedID> encrypted(EncryptedIDBuilder::buildEncryptedID());
427                 MetadataCredentialCriteria mcc(*AA);
428                 encrypted->encrypt(
429                     *ctx.getNameID(),
430                     *(application.getMetadataProvider()),
431                     mcc,
432                     false,
433                     relyingParty->getXMLString("encryptionAlg").second
434                     );
435                 subject->setEncryptedID(encrypted.release());
436             }
437             else {
438                 subject->setNameID(ctx.getNameID()->cloneNameID());
439             }
440
441             saml2p::AttributeQuery* query = saml2p::AttributeQueryBuilder::buildAttributeQuery();
442             query->setSubject(subject.release());
443             Issuer* iss = IssuerBuilder::buildIssuer();
444             iss->setName(issuer.get());
445             query->setIssuer(iss);
446             for (vector<saml2::Attribute*>::const_iterator ad = m_SAML2Designators.begin(); ad!=m_SAML2Designators.end(); ++ad)
447                 query->getAttributes().push_back((*ad)->cloneAttribute());
448
449             SAML2SOAPClient client(soaper, false);
450             client.sendSAML(query, application.getId(), mcc, loc.get());
451             srt = client.receiveSAML();
452         }
453         catch (exception& ex) {
454             m_log.error("exception making SAML query: %s", ex.what());
455             soaper.reset();
456         }
457     }
458
459     if (!srt) {
460         m_log.error("unable to obtain a SAML response from attribute authority");
461         return false;
462     }
463     saml2p::Response* response = dynamic_cast<saml2p::Response*>(srt);
464     if (!response) {
465         delete srt;
466         m_log.error("message was not a samlp:Response");
467         return true;
468     }
469     else if (!response->getStatus() || !response->getStatus()->getStatusCode() ||
470             !XMLString::equals(response->getStatus()->getStatusCode()->getValue(), saml2p::StatusCode::SUCCESS)) {
471         delete srt;
472         m_log.error("attribute authority returned a SAML error");
473         return true;
474     }
475
476     const vector<saml2::Assertion*>& assertions = const_cast<const saml2p::Response*>(response)->getAssertions();
477     if (assertions.empty()) {
478         delete srt;
479         m_log.warn("response from attribute authority was empty");
480         return true;
481     }
482     else if (assertions.size()>1)
483         m_log.warn("simple resolver only supports one assertion in the query response");
484
485     auto_ptr<saml2p::StatusResponseType> wrapper(srt);
486     saml2::Assertion* newtoken = assertions.front();
487
488     if (!newtoken->getSignature() && signedAssertions.first && signedAssertions.second) {
489         m_log.error("assertion unsigned, rejecting it based on signedAssertions policy");
490         return true;
491     }
492
493     try {
494         // We're going to insist that the assertion issuer is the same as the peer.
495         // Reset the policy's message bits and extract them from the assertion.
496         policy.reset(true);
497         policy.setMessageID(newtoken->getID());
498         policy.setIssueInstant(newtoken->getIssueInstantEpoch());
499         policy.setIssuer(newtoken->getIssuer());
500         policy.evaluate(*newtoken);
501
502         // Now we can check the security status of the policy.
503         if (!policy.isAuthenticated())
504             throw SecurityPolicyException("Security of SAML 2.0 query result not established.");
505
506         // Lastly, check it over.
507         saml2::AssertionValidator tokval(application.getAudiences(), time(NULL));
508         tokval.validateAssertion(*newtoken);
509     }
510     catch (exception& ex) {
511         m_log.error("assertion failed policy/validation: %s", ex.what());
512         return true;
513     }
514
515     newtoken->detach();
516     wrapper.release();
517     ctx.getResolvedAssertions().push_back(newtoken);
518
519     // Finally, extract and filter the result.
520     try {
521         AttributeExtractor* extractor = application.getAttributeExtractor();
522         if (extractor) {
523             Locker extlocker(extractor);
524             extractor->extractAttributes(application, AA, *newtoken, ctx.getResolvedAttributes());
525         }
526
527         AttributeFilter* filter = application.getAttributeFilter();
528         if (filter) {
529             BasicFilteringContext fc(application, ctx.getResolvedAttributes(), AA, ctx.getClassRef(), ctx.getDeclRef());
530             Locker filtlocker(filter);
531             filter->filterAttributes(fc, ctx.getResolvedAttributes());
532         }
533     }
534     catch (exception& ex) {
535         m_log.error("caught exception extracting/filtering attributes from query result: %s", ex.what());
536         for_each(ctx.getResolvedAttributes().begin(), ctx.getResolvedAttributes().end(), xmltooling::cleanup<shibsp::Attribute>());
537         ctx.getResolvedAttributes().clear();
538     }
539
540     return true;
541 }
542
543 void QueryResolver::resolveAttributes(ResolutionContext& ctx) const
544 {
545 #ifdef _DEBUG
546     xmltooling::NDC ndc("resolveAttributes");
547 #endif
548
549     QueryContext& qctx = dynamic_cast<QueryContext&>(ctx);
550     if (!qctx.doQuery()) {
551         m_log.debug("found AttributeStatement in input to new session, skipping query");
552         return;
553     }
554
555     if (qctx.getNameID() && qctx.getEntityDescriptor()) {
556         if (XMLString::equals(qctx.getProtocol(), samlconstants::SAML20P_NS)) {
557             m_log.debug("attempting SAML 2.0 attribute query");
558             SAML2Query(qctx);
559         }
560         else if (XMLString::equals(qctx.getProtocol(), samlconstants::SAML11_PROTOCOL_ENUM) ||
561                 XMLString::equals(qctx.getProtocol(), samlconstants::SAML10_PROTOCOL_ENUM)) {
562             m_log.debug("attempting SAML 1.x attribute query");
563             SAML1Query(qctx);
564         }
565         else
566             m_log.warn("SSO protocol does not allow for attribute query");
567     }
568     else
569         m_log.warn("can't attempt attribute query, either no NameID or no metadata to use");
570 }