2 * Copyright 2001-2007 Internet2
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * QueryAttributeResolver.cpp
20 * AttributeResolver based on SAML queries.
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"
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>
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;
63 class SHIBSP_DLLLOCAL QueryContext : public ResolutionContext
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());
74 const Application& application,
75 const EntityDescriptor* issuer,
76 const XMLCh* protocol,
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) {
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()) {
92 const saml1::Assertion* token1 = dynamic_cast<const saml1::Assertion*>(*t);
93 if (token1 && !token1->getAttributeStatements().empty()) {
103 XMLString::release((XMLCh**)&m_protocol);
104 XMLString::release((XMLCh**)&m_class);
105 XMLString::release((XMLCh**)&m_decl);
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>());
113 bool doQuery() const {
117 const Application& getApplication() const {
120 const EntityDescriptor* getEntityDescriptor() const {
123 if (m_session && m_session->getEntityID()) {
124 m_metadata = m_app.getMetadataProvider();
127 return m_entity = m_metadata->getEntityDescriptor(m_session->getEntityID());
132 const XMLCh* getProtocol() const {
135 const NameID* getNameID() const {
136 return m_session ? m_session->getNameID() : m_nameid;
138 const XMLCh* getClassRef() const {
141 const XMLCh* getDeclRef() const {
144 const Session* getSession() const {
147 vector<shibsp::Attribute*>& getResolvedAttributes() {
150 vector<opensaml::Assertion*>& getResolvedAssertions() {
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;
164 vector<shibsp::Attribute*> m_attributes;
165 vector<opensaml::Assertion*> m_assertions;
168 class SHIBSP_DLLLOCAL QueryResolver : public AttributeResolver
171 QueryResolver(const DOMElement* e);
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>());
177 Lockable* lock() {return this;}
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
190 return new QueryContext(application,issuer,protocol,nameid,authncontext_class,authncontext_decl,tokens,attributes);
193 ResolutionContext* createResolutionContext(const Application& application, const Session& session) const {
194 return new QueryContext(application,session);
197 void resolveAttributes(ResolutionContext& ctx) const;
199 void getAttributeIds(vector<string>& attributes) const {
200 // Nothing to do, only the extractor would actually generate them.
204 bool SAML1Query(QueryContext& ctx) const;
205 bool SAML2Query(QueryContext& ctx) const;
208 vector<AttributeDesignator*> m_SAML1Designators;
209 vector<saml2::Attribute*> m_SAML2Designators;
212 AttributeResolver* SHIBSP_DLLLOCAL QueryResolverFactory(const DOMElement* const & e)
214 return new QueryResolver(e);
219 void SHIBSP_API shibsp::registerAttributeResolvers()
221 SPConfig::getConfig().AttributeResolverManager.registerFactory(QUERY_ATTRIBUTE_RESOLVER, QueryResolverFactory);
224 QueryResolver::QueryResolver(const DOMElement* e) : m_log(Category::getInstance(SHIBSP_LOGCAT".AttributeResolver"))
227 xmltooling::NDC ndc("QueryResolver");
230 DOMElement* child = XMLHelper::getFirstChildElement(e);
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());
237 m_SAML2Designators.push_back(down);
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());
245 m_SAML1Designators.push_back(down);
250 catch (exception& ex) {
251 m_log.error("exception loading attribute designator: %s", ex.what());
253 child = XMLHelper::getNextSiblingElement(child);
257 bool QueryResolver::SAML1Query(QueryContext& ctx) const
260 xmltooling::NDC ndc("query");
263 int version = XMLString::equals(ctx.getProtocol(), samlconstants::SAML11_PROTOCOL_ENUM) ? 1 : 0;
264 const AttributeAuthorityDescriptor* AA =
265 find_if(ctx.getEntityDescriptor()->getAttributeAuthorityDescriptors(), isValidForProtocol(ctx.getProtocol()));
267 m_log.warn("no SAML 1.%d AttributeAuthority role found in metadata", version);
271 const Application& application = ctx.getApplication();
272 shibsp::SecurityPolicy policy(application);
273 MetadataCredentialCriteria mcc(*AA);
274 shibsp::SOAPClient soaper(policy);
275 const PropertySet* policySettings =
276 application.getServiceProvider().getPolicySettings(application.getString("policyId").second);
277 pair<bool,bool> signedAssertions = policySettings->getBool("signedAssertions");
279 auto_ptr_XMLCh binding(samlconstants::SAML1_BINDING_SOAP);
280 saml1p::Response* response=NULL;
281 const vector<AttributeService*>& endpoints=AA->getAttributeServices();
282 for (vector<AttributeService*>::const_iterator ep=endpoints.begin(); !response && ep!=endpoints.end(); ++ep) {
284 if (!XMLString::equals((*ep)->getBinding(),binding.get()))
286 auto_ptr_char loc((*ep)->getLocation());
287 auto_ptr_XMLCh issuer(application.getString("entityID").second);
288 NameIdentifier* nameid = NameIdentifierBuilder::buildNameIdentifier();
289 nameid->setName(ctx.getNameID()->getName());
290 nameid->setFormat(ctx.getNameID()->getFormat());
291 nameid->setNameQualifier(ctx.getNameID()->getNameQualifier());
292 saml1::Subject* subject = saml1::SubjectBuilder::buildSubject();
293 subject->setNameIdentifier(nameid);
294 saml1p::AttributeQuery* query = saml1p::AttributeQueryBuilder::buildAttributeQuery();
295 query->setSubject(subject);
296 query->setResource(issuer.get());
297 for (vector<AttributeDesignator*>::const_iterator ad = m_SAML1Designators.begin(); ad!=m_SAML1Designators.end(); ++ad)
298 query->getAttributeDesignators().push_back((*ad)->cloneAttributeDesignator());
299 Request* request = RequestBuilder::buildRequest();
300 request->setAttributeQuery(query);
301 request->setMinorVersion(version);
303 SAML1SOAPClient client(soaper, false);
304 client.sendSAML(request, application.getId(), mcc, loc.get());
305 response = client.receiveSAML();
307 catch (exception& ex) {
308 m_log.error("exception making SAML query: %s", ex.what());
314 m_log.error("unable to obtain a SAML response from attribute authority");
317 else if (!response->getStatus() || !response->getStatus()->getStatusCode() || response->getStatus()->getStatusCode()->getValue()==NULL ||
318 *(response->getStatus()->getStatusCode()->getValue()) != saml1p::StatusCode::SUCCESS) {
320 m_log.error("attribute authority returned a SAML error");
324 const vector<saml1::Assertion*>& assertions = const_cast<const saml1p::Response*>(response)->getAssertions();
325 if (assertions.empty()) {
327 m_log.warn("response from attribute authority was empty");
330 else if (assertions.size()>1)
331 m_log.warn("simple resolver only supports one assertion in the query response");
333 auto_ptr<saml1p::Response> wrapper(response);
334 saml1::Assertion* newtoken = assertions.front();
336 if (!newtoken->getSignature() && signedAssertions.first && signedAssertions.second) {
337 m_log.error("assertion unsigned, rejecting it based on signedAssertions policy");
342 // We're going to insist that the assertion issuer is the same as the peer.
343 // Reset the policy's message bits and extract them from the assertion.
345 policy.setMessageID(newtoken->getAssertionID());
346 policy.setIssueInstant(newtoken->getIssueInstantEpoch());
347 policy.setIssuer(newtoken->getIssuer());
348 policy.evaluate(*newtoken);
350 // Now we can check the security status of the policy.
351 if (!policy.isAuthenticated())
352 throw SecurityPolicyException("Security of SAML 1.x query result not established.");
354 // Lastly, check it over.
355 saml1::AssertionValidator tokval(application.getAudiences(), time(NULL));
356 tokval.validateAssertion(*newtoken);
358 catch (exception& ex) {
359 m_log.error("assertion failed policy/validation: %s", ex.what());
365 ctx.getResolvedAssertions().push_back(newtoken);
367 // Finally, extract and filter the result.
369 AttributeExtractor* extractor = application.getAttributeExtractor();
371 Locker extlocker(extractor);
372 extractor->extractAttributes(application, AA, *newtoken, ctx.getResolvedAttributes());
375 AttributeFilter* filter = application.getAttributeFilter();
377 BasicFilteringContext fc(application, ctx.getResolvedAttributes(), AA, ctx.getClassRef(), ctx.getDeclRef());
378 Locker filtlocker(filter);
379 filter->filterAttributes(fc, ctx.getResolvedAttributes());
382 catch (exception& ex) {
383 m_log.error("caught exception extracting/filtering attributes from query result: %s", ex.what());
384 for_each(ctx.getResolvedAttributes().begin(), ctx.getResolvedAttributes().end(), xmltooling::cleanup<shibsp::Attribute>());
385 ctx.getResolvedAttributes().clear();
391 bool QueryResolver::SAML2Query(QueryContext& ctx) const
394 xmltooling::NDC ndc("query");
397 const AttributeAuthorityDescriptor* AA =
398 find_if(ctx.getEntityDescriptor()->getAttributeAuthorityDescriptors(), isValidForProtocol(samlconstants::SAML20P_NS));
400 m_log.warn("no SAML 2 AttributeAuthority role found in metadata");
404 const Application& application = ctx.getApplication();
405 shibsp::SecurityPolicy policy(application);
406 MetadataCredentialCriteria mcc(*AA);
407 shibsp::SOAPClient soaper(policy);
408 const PropertySet* policySettings = application.getServiceProvider().getPolicySettings(application.getString("policyId").second);
409 pair<bool,bool> signedAssertions = policySettings->getBool("signedAssertions");
411 const PropertySet* relyingParty = application.getRelyingParty(ctx.getEntityDescriptor());
412 pair<bool,const char*> encryption = relyingParty->getString("encryption");
414 auto_ptr_XMLCh binding(samlconstants::SAML20_BINDING_SOAP);
415 saml2p::StatusResponseType* srt=NULL;
416 const vector<AttributeService*>& endpoints=AA->getAttributeServices();
417 for (vector<AttributeService*>::const_iterator ep=endpoints.begin(); !srt && ep!=endpoints.end(); ++ep) {
419 if (!XMLString::equals((*ep)->getBinding(),binding.get()))
421 auto_ptr_char loc((*ep)->getLocation());
422 auto_ptr_XMLCh issuer(application.getString("entityID").second);
424 auto_ptr<saml2::Subject> subject(saml2::SubjectBuilder::buildSubject());
426 // Encrypt the NameID?
427 if (encryption.first && (!strcmp(encryption.second, "true") || !strcmp(encryption.second, "back"))) {
428 auto_ptr<EncryptedID> encrypted(EncryptedIDBuilder::buildEncryptedID());
429 MetadataCredentialCriteria mcc(*AA);
432 *(application.getMetadataProvider()),
435 relyingParty->getXMLString("encryptionAlg").second
437 subject->setEncryptedID(encrypted.release());
440 subject->setNameID(ctx.getNameID()->cloneNameID());
443 saml2p::AttributeQuery* query = saml2p::AttributeQueryBuilder::buildAttributeQuery();
444 query->setSubject(subject.release());
445 Issuer* iss = IssuerBuilder::buildIssuer();
446 iss->setName(issuer.get());
447 query->setIssuer(iss);
448 for (vector<saml2::Attribute*>::const_iterator ad = m_SAML2Designators.begin(); ad!=m_SAML2Designators.end(); ++ad)
449 query->getAttributes().push_back((*ad)->cloneAttribute());
451 SAML2SOAPClient client(soaper, false);
452 client.sendSAML(query, application.getId(), mcc, loc.get());
453 srt = client.receiveSAML();
455 catch (exception& ex) {
456 m_log.error("exception making SAML query: %s", ex.what());
462 m_log.error("unable to obtain a SAML response from attribute authority");
465 saml2p::Response* response = dynamic_cast<saml2p::Response*>(srt);
468 m_log.error("message was not a samlp:Response");
471 else if (!response->getStatus() || !response->getStatus()->getStatusCode() ||
472 !XMLString::equals(response->getStatus()->getStatusCode()->getValue(), saml2p::StatusCode::SUCCESS)) {
474 m_log.error("attribute authority returned a SAML error");
478 const vector<saml2::Assertion*>& assertions = const_cast<const saml2p::Response*>(response)->getAssertions();
479 if (assertions.empty()) {
481 m_log.warn("response from attribute authority was empty");
484 else if (assertions.size()>1)
485 m_log.warn("simple resolver only supports one assertion in the query response");
487 auto_ptr<saml2p::StatusResponseType> wrapper(srt);
488 saml2::Assertion* newtoken = assertions.front();
490 if (!newtoken->getSignature() && signedAssertions.first && signedAssertions.second) {
491 m_log.error("assertion unsigned, rejecting it based on signedAssertions policy");
496 // We're going to insist that the assertion issuer is the same as the peer.
497 // Reset the policy's message bits and extract them from the assertion.
499 policy.setMessageID(newtoken->getID());
500 policy.setIssueInstant(newtoken->getIssueInstantEpoch());
501 policy.setIssuer(newtoken->getIssuer());
502 policy.evaluate(*newtoken);
504 // Now we can check the security status of the policy.
505 if (!policy.isAuthenticated())
506 throw SecurityPolicyException("Security of SAML 2.0 query result not established.");
508 // Lastly, check it over.
509 saml2::AssertionValidator tokval(application.getAudiences(), time(NULL));
510 tokval.validateAssertion(*newtoken);
512 catch (exception& ex) {
513 m_log.error("assertion failed policy/validation: %s", ex.what());
519 ctx.getResolvedAssertions().push_back(newtoken);
521 // Finally, extract and filter the result.
523 AttributeExtractor* extractor = application.getAttributeExtractor();
525 Locker extlocker(extractor);
526 extractor->extractAttributes(application, AA, *newtoken, ctx.getResolvedAttributes());
529 AttributeFilter* filter = application.getAttributeFilter();
531 BasicFilteringContext fc(application, ctx.getResolvedAttributes(), AA, ctx.getClassRef(), ctx.getDeclRef());
532 Locker filtlocker(filter);
533 filter->filterAttributes(fc, ctx.getResolvedAttributes());
536 catch (exception& ex) {
537 m_log.error("caught exception extracting/filtering attributes from query result: %s", ex.what());
538 for_each(ctx.getResolvedAttributes().begin(), ctx.getResolvedAttributes().end(), xmltooling::cleanup<shibsp::Attribute>());
539 ctx.getResolvedAttributes().clear();
545 void QueryResolver::resolveAttributes(ResolutionContext& ctx) const
548 xmltooling::NDC ndc("resolveAttributes");
551 QueryContext& qctx = dynamic_cast<QueryContext&>(ctx);
552 if (!qctx.doQuery()) {
553 m_log.debug("found AttributeStatement in input to new session, skipping query");
557 if (qctx.getNameID() && qctx.getEntityDescriptor()) {
558 if (XMLString::equals(qctx.getProtocol(), samlconstants::SAML20P_NS)) {
559 m_log.debug("attempting SAML 2.0 attribute query");
562 else if (XMLString::equals(qctx.getProtocol(), samlconstants::SAML11_PROTOCOL_ENUM) ||
563 XMLString::equals(qctx.getProtocol(), samlconstants::SAML10_PROTOCOL_ENUM)) {
564 m_log.debug("attempting SAML 1.x attribute query");
568 m_log.warn("SSO protocol does not allow for attribute query");
571 m_log.warn("can't attempt attribute query, either no NameID or no metadata to use");