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     shibsp::SecurityPolicy policy(ctx.getApplication());
 271     MetadataCredentialCriteria mcc(*AA);
 272     shibsp::SOAPClient soaper(policy);
 273     const PropertySet* policySettings =
 274         ctx.getApplication().getServiceProvider().getPolicySettings(ctx.getApplication().getString("policyId").second);
 275     pair<bool,bool> signedAssertions = policySettings->getBool("signedAssertions");
 276
 277     auto_ptr_XMLCh binding(samlconstants::SAML1_BINDING_SOAP);
 278     saml1p::Response* response=NULL;
 279     const vector<AttributeService*>& endpoints=AA->getAttributeServices();
 280     for (vector<AttributeService*>::const_iterator ep=endpoints.begin(); !response && ep!=endpoints.end(); ++ep) {
 281         try {
 282             if (!XMLString::equals((*ep)->getBinding(),binding.get()))
 283                 continue;
 284             auto_ptr_char loc((*ep)->getLocation());
 285             auto_ptr_XMLCh issuer(ctx.getApplication().getString("entityID").second);
 286             NameIdentifier* nameid = NameIdentifierBuilder::buildNameIdentifier();
 287             nameid->setName(ctx.getNameID()->getName());
 288             nameid->setFormat(ctx.getNameID()->getFormat());
 289             nameid->setNameQualifier(ctx.getNameID()->getNameQualifier());
 290             saml1::Subject* subject = saml1::SubjectBuilder::buildSubject();
 291             subject->setNameIdentifier(nameid);
 292             saml1p::AttributeQuery* query = saml1p::AttributeQueryBuilder::buildAttributeQuery();
 293             query->setSubject(subject);
 294             query->setResource(issuer.get());
 295             for (vector<AttributeDesignator*>::const_iterator ad = m_SAML1Designators.begin(); ad!=m_SAML1Designators.end(); ++ad)
 296                 query->getAttributeDesignators().push_back((*ad)->cloneAttributeDesignator());
 297             Request* request = RequestBuilder::buildRequest();
 298             request->setAttributeQuery(query);
 299             request->setMinorVersion(version);
 300
 301             SAML1SOAPClient client(soaper, false);
 302             client.sendSAML(request, mcc, loc.get());
 303             response = client.receiveSAML();
 304         }
 305         catch (exception& ex) {
 306             m_log.error("exception making SAML query: %s", ex.what());
 307             soaper.reset();
 308         }
 309     }
 310
 311     if (!response) {
 312         m_log.error("unable to obtain a SAML response from attribute authority");
 313         return false;
 314     }
 315     else if (!response->getStatus() || !response->getStatus()->getStatusCode() || response->getStatus()->getStatusCode()->getValue()==NULL ||
 316             *(response->getStatus()->getStatusCode()->getValue()) != saml1p::StatusCode::SUCCESS) {
 317         delete response;
 318         m_log.error("attribute authority returned a SAML error");
 319         return true;
 320     }
 321
 322     const vector<saml1::Assertion*>& assertions = const_cast<const saml1p::Response*>(response)->getAssertions();
 323     if (assertions.size()>1)
 324         m_log.warn("simple resolver only supports one assertion in the query response");
 325
 326     auto_ptr<saml1p::Response> wrapper(response);
 327     saml1::Assertion* newtoken = assertions.front();
 328
 329     if (!newtoken->getSignature() && signedAssertions.first && signedAssertions.second) {
 330         m_log.error("assertion unsigned, rejecting it based on signedAssertions policy");
 331         return true;
 332     }
 333
 334     try {
 335         policy.evaluate(*newtoken);
 336         if (!policy.isSecure())
 337             throw SecurityPolicyException("Security of SAML 1.x query result not established.");
 338         saml1::AssertionValidator tokval(ctx.getApplication().getAudiences(), time(NULL));
 339         tokval.validateAssertion(*newtoken);
 340     }
 341     catch (exception& ex) {
 342         m_log.error("assertion failed policy/validation: %s", ex.what());
 343         return true;
 344     }
 345
 346     newtoken->detach();
 347     wrapper.release();
 348     ctx.getResolvedAssertions().push_back(newtoken);
 349
 350     // Finally, extract and filter the result.
 351     try {
 352         AttributeExtractor* extractor = ctx.getApplication().getAttributeExtractor();
 353         if (extractor) {
 354             Locker extlocker(extractor);
 355             extractor->extractAttributes(ctx.getApplication(), AA, *newtoken, ctx.getResolvedAttributes());
 356         }
 357
 358         AttributeFilter* filter = ctx.getApplication().getAttributeFilter();
 359         if (filter) {
 360             BasicFilteringContext fc(ctx.getApplication(), ctx.getResolvedAttributes(), AA, ctx.getClassRef(), ctx.getDeclRef());
 361             Locker filtlocker(filter);
 362             filter->filterAttributes(fc, ctx.getResolvedAttributes());
 363         }
 364     }
 365     catch (exception& ex) {
 366         m_log.error("caught exception extracting/filtering attributes from query result: %s", ex.what());
 367         for_each(ctx.getResolvedAttributes().begin(), ctx.getResolvedAttributes().end(), xmltooling::cleanup<shibsp::Attribute>());
 368         ctx.getResolvedAttributes().clear();
 369     }
 370
 371     return true;
 372 }
 373
 374 bool QueryResolver::SAML2Query(QueryContext& ctx) const
 375 {
 376 #ifdef _DEBUG
 377     xmltooling::NDC ndc("query");
 378 #endif
 379
 380     const AttributeAuthorityDescriptor* AA = ctx.getEntityDescriptor()->getAttributeAuthorityDescriptor(samlconstants::SAML20P_NS);
 381     if (!AA) {
 382         m_log.warn("no SAML 2 AttributeAuthority role found in metadata");
 383         return false;
 384     }
 385
 386     shibsp::SecurityPolicy policy(ctx.getApplication());
 387     MetadataCredentialCriteria mcc(*AA);
 388     shibsp::SOAPClient soaper(policy);
 389     const PropertySet* policySettings =
 390         ctx.getApplication().getServiceProvider().getPolicySettings(ctx.getApplication().getString("policyId").second);
 391     pair<bool,bool> signedAssertions = policySettings->getBool("signedAssertions");
 392
 393     auto_ptr_XMLCh binding(samlconstants::SAML20_BINDING_SOAP);
 394     saml2p::StatusResponseType* srt=NULL;
 395     const vector<AttributeService*>& endpoints=AA->getAttributeServices();
 396     for (vector<AttributeService*>::const_iterator ep=endpoints.begin(); !srt && ep!=endpoints.end(); ++ep) {
 397         try {
 398             if (!XMLString::equals((*ep)->getBinding(),binding.get()))
 399                 continue;
 400             auto_ptr_char loc((*ep)->getLocation());
 401             auto_ptr_XMLCh issuer(ctx.getApplication().getString("entityID").second);
 402             saml2::Subject* subject = saml2::SubjectBuilder::buildSubject();
 403             subject->setNameID(ctx.getNameID()->cloneNameID());
 404             saml2p::AttributeQuery* query = saml2p::AttributeQueryBuilder::buildAttributeQuery();
 405             query->setSubject(subject);
 406             Issuer* iss = IssuerBuilder::buildIssuer();
 407             iss->setName(issuer.get());
 408             query->setIssuer(iss);
 409             for (vector<saml2::Attribute*>::const_iterator ad = m_SAML2Designators.begin(); ad!=m_SAML2Designators.end(); ++ad)
 410                 query->getAttributes().push_back((*ad)->cloneAttribute());
 411
 412             SAML2SOAPClient client(soaper, false);
 413             client.sendSAML(query, mcc, loc.get());
 414             srt = client.receiveSAML();
 415         }
 416         catch (exception& ex) {
 417             m_log.error("exception making SAML query: %s", ex.what());
 418             soaper.reset();
 419         }
 420     }
 421
 422     if (!srt) {
 423         m_log.error("unable to obtain a SAML response from attribute authority");
 424         return false;
 425     }
 426     saml2p::Response* response = dynamic_cast<saml2p::Response*>(srt);
 427     if (!response) {
 428         delete srt;
 429         m_log.error("message was not a samlp:Response");
 430         return true;
 431     }
 432     else if (!response->getStatus() || !response->getStatus()->getStatusCode() ||
 433             !XMLString::equals(response->getStatus()->getStatusCode()->getValue(), saml2p::StatusCode::SUCCESS)) {
 434         delete srt;
 435         m_log.error("attribute authority returned a SAML error");
 436         return true;
 437     }
 438
 439     const vector<saml2::Assertion*>& assertions = const_cast<const saml2p::Response*>(response)->getAssertions();
 440     if (assertions.size()>1)
 441         m_log.warn("simple resolver only supports one assertion in the query response");
 442
 443     auto_ptr<saml2p::Response> wrapper(response);
 444     saml2::Assertion* newtoken = assertions.front();
 445
 446     if (!newtoken->getSignature() && signedAssertions.first && signedAssertions.second) {
 447         m_log.error("assertion unsigned, rejecting it based on signedAssertions policy");
 448         return true;
 449     }
 450
 451     try {
 452         policy.evaluate(*newtoken);
 453         if (!policy.isSecure())
 454             throw SecurityPolicyException("Security of SAML 2.0 query result not established.");
 455         saml2::AssertionValidator tokval(ctx.getApplication().getAudiences(), time(NULL));
 456         tokval.validateAssertion(*newtoken);
 457     }
 458     catch (exception& ex) {
 459         m_log.error("assertion failed policy/validation: %s", ex.what());
 460         return true;
 461     }
 462
 463     newtoken->detach();
 464     wrapper.release();
 465     ctx.getResolvedAssertions().push_back(newtoken);
 466
 467     // Finally, extract and filter the result.
 468     try {
 469         AttributeExtractor* extractor = ctx.getApplication().getAttributeExtractor();
 470         if (extractor) {
 471             Locker extlocker(extractor);
 472             extractor->extractAttributes(ctx.getApplication(), AA, *newtoken, ctx.getResolvedAttributes());
 473         }
 474
 475         AttributeFilter* filter = ctx.getApplication().getAttributeFilter();
 476         if (filter) {
 477             BasicFilteringContext fc(ctx.getApplication(), ctx.getResolvedAttributes(), AA, ctx.getClassRef(), ctx.getDeclRef());
 478             Locker filtlocker(filter);
 479             filter->filterAttributes(fc, ctx.getResolvedAttributes());
 480         }
 481     }
 482     catch (exception& ex) {
 483         m_log.error("caught exception extracting/filtering attributes from query result: %s", ex.what());
 484         for_each(ctx.getResolvedAttributes().begin(), ctx.getResolvedAttributes().end(), xmltooling::cleanup<shibsp::Attribute>());
 485         ctx.getResolvedAttributes().clear();
 486     }
 487
 488     return true;
 489 }
 490
 491 void QueryResolver::resolveAttributes(ResolutionContext& ctx) const
 492 {
 493 #ifdef _DEBUG
 494     xmltooling::NDC ndc("resolveAttributes");
 495 #endif
 496
 497     QueryContext& qctx = dynamic_cast<QueryContext&>(ctx);
 498     if (!qctx.doQuery()) {
 499         m_log.debug("found AttributeStatement in input to new session, skipping query");
 500         return;
 501     }
 502
 503     if (qctx.getNameID() && qctx.getEntityDescriptor()) {
 504         if (XMLString::equals(qctx.getProtocol(), samlconstants::SAML20P_NS)) {
 505             m_log.debug("attempting SAML 2.0 attribute query");
 506             SAML2Query(qctx);
 507         }
 508         else if (XMLString::equals(qctx.getProtocol(), samlconstants::SAML11_PROTOCOL_ENUM) ||
 509                 XMLString::equals(qctx.getProtocol(), samlconstants::SAML10_PROTOCOL_ENUM)) {
 510             m_log.debug("attempting SAML 1.x attribute query");
 511             SAML1Query(qctx);
 512         }
 513         else
 514             m_log.warn("SSO protocol does not allow for attribute query");
 515     }
 516     else
 517         m_log.warn("can't attempt attribute query, either no NameID or no metadata to use");
 518 }