shibsp/handler/impl/SAML1Consumer.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  * SAML1Consumer.cpp
  19  *
  20  * SAML 1.x assertion consumer service
  21  */
  22
  23 #include "internal.h"
  24 #include "Application.h"
  25 #include "exceptions.h"
  26 #include "ServiceProvider.h"
  27 #include "SessionCache.h"
  28 #include "attribute/resolver/ResolutionContext.h"
  29 #include "handler/AssertionConsumerService.h"
  30
  31 #include <saml/saml1/core/Assertions.h>
  32 #include <saml/saml1/core/Protocols.h>
  33 #include <saml/saml1/profile/BrowserSSOProfileValidator.h>
  34 #include <saml/saml2/metadata/Metadata.h>
  35
  36 using namespace shibsp;
  37 using namespace opensaml::saml1;
  38 using namespace opensaml::saml1p;
  39 using namespace opensaml;
  40 using namespace xmltooling;
  41 using namespace log4cpp;
  42 using namespace std;
  43 using saml2::NameID;
  44 using saml2::NameIDBuilder;
  45 using saml2md::EntityDescriptor;
  46
  47 namespace shibsp {
  48
  49 #if defined (_MSC_VER)
  50     #pragma warning( push )
  51     #pragma warning( disable : 4250 )
  52 #endif
  53
  54     class SHIBSP_DLLLOCAL SAML1Consumer : public AssertionConsumerService
  55     {
  56     public:
  57         SAML1Consumer(const DOMElement* e) : AssertionConsumerService(e, Category::getInstance(SHIBSP_LOGCAT".SAML1")) {}
  58         virtual ~SAML1Consumer() {}
  59
  60     private:
  61         string implementProtocol(
  62             const Application& application,
  63             const HTTPRequest& httpRequest,
  64             SecurityPolicy& policy,
  65             const PropertySet* settings,
  66             const XMLObject& xmlObject
  67             ) const;
  68     };
  69
  70 #if defined (_MSC_VER)
  71     #pragma warning( pop )
  72 #endif
  73
  74     Handler* SHIBSP_DLLLOCAL SAML1ConsumerFactory(const DOMElement* const & e)
  75     {
  76         return new SAML1Consumer(e);
  77     }
  78
  79 };
  80
  81 string SAML1Consumer::implementProtocol(
  82     const Application& application,
  83     const HTTPRequest& httpRequest,
  84     SecurityPolicy& policy,
  85     const PropertySet* settings,
  86     const XMLObject& xmlObject
  87     ) const
  88 {
  89     // Implementation of SAML 1.x SSO profile(s).
  90     m_log.debug("processing message against SAML 1.x SSO profile");
  91
  92     // With the binding aspects now moved out to the MessageDecoder,
  93     // the focus here is on the assertion content. For SAML 1.x,
  94     // all the security comes from the protocol layer, and signing
  95     // the assertion isn't sufficient. So we can check the policy
  96     // object now and bail if it's not a secure message.
  97     if (!policy.isSecure())
  98         throw SecurityPolicyException("Security of SAML 1.x SSO response not established.");
  99
 100     // Check for errors...this will throw if it's not a successful message.
 101     checkError(&xmlObject);
 102
 103     const Response* response = dynamic_cast<const Response*>(&xmlObject);
 104     if (!response)
 105         throw FatalProfileException("Incoming message was not a samlp:Response.");
 106
 107     const vector<saml1::Assertion*>& assertions = response->getAssertions();
 108     if (assertions.empty())
 109         throw FatalProfileException("Incoming message contained no SAML assertions.");
 110
 111     // Maintain list of "legit" tokens to feed to SP subsystems.
 112     const AuthenticationStatement* ssoStatement=NULL;
 113     vector<const opensaml::Assertion*> tokens;
 114
 115     // Profile validator.
 116     time_t now = time(NULL);
 117     BrowserSSOProfileValidator ssoValidator(application.getAudiences(), now);
 118
 119     // With this flag on, we ignore any unsigned assertions.
 120     pair<bool,bool> flag = settings->getBool("signedAssertions");
 121
 122     for (vector<saml1::Assertion*>::const_iterator a = assertions.begin(); a!=assertions.end(); ++a) {
 123         // Skip unsigned assertion?
 124         if (!(*a)->getSignature() && flag.first && flag.second) {
 125             m_log.warn("found unsigned assertion in SAML response, ignoring it per signedAssertions policy");
 126             continue;
 127         }
 128
 129         try {
 130             // Run the policy over the assertion. Handles issuer consistency, replay, freshness,
 131             // and signature verification, assuming the relevant rules are configured.
 132             policy.evaluate(*(*a));
 133
 134             // Now do profile and core semantic validation to ensure we can use it for SSO.
 135             ssoValidator.validateAssertion(*(*a));
 136
 137             // Track it as a valid token.
 138             tokens.push_back(*a);
 139
 140             // Save off the first valid SSO statement.
 141             if (!ssoStatement && !(*a)->getAuthenticationStatements().empty())
 142                 ssoStatement = (*a)->getAuthenticationStatements().front();
 143         }
 144         catch (exception& ex) {
 145             m_log.warn("profile validation error in assertion: %s", ex.what());
 146         }
 147     }
 148
 149     if (!ssoStatement)
 150         throw FatalProfileException("A valid authentication statement was not found in the incoming message.");
 151
 152     // Address checking.
 153     SubjectLocality* locality = ssoStatement->getSubjectLocality();
 154     if (locality && locality->getIPAddress()) {
 155         auto_ptr_char ip(locality->getIPAddress());
 156         checkAddress(application, httpRequest, ip.get());
 157     }
 158
 159     m_log.debug("SSO profile processing completed successfully");
 160
 161     // We've successfully "accepted" at least one SSO token, along with any additional valid tokens.
 162     // To complete processing, we need to resolve attributes and then create the session.
 163
 164     // First, normalize the SAML 1.x NameIdentifier...
 165     auto_ptr<NameID> nameid(NameIDBuilder::buildNameID());
 166     NameIdentifier* n = ssoStatement->getSubject()->getNameIdentifier();
 167     if (n) {
 168         nameid->setName(n->getName());
 169         nameid->setFormat(n->getFormat());
 170         nameid->setNameQualifier(n->getNameQualifier());
 171     }
 172
 173     const EntityDescriptor* issuerMetadata = dynamic_cast<const EntityDescriptor*>(policy.getIssuerMetadata()->getParent());
 174     auto_ptr<ResolutionContext> ctx(
 175         resolveAttributes(application, httpRequest, issuerMetadata, *nameid.get(), &tokens)
 176         );
 177
 178     // Copy over any new tokens, but leave them in the context for cleanup.
 179     tokens.insert(tokens.end(), ctx->getResolvedAssertions().begin(), ctx->getResolvedAssertions().end());
 180
 181     // Now we have to extract the authentication details for session setup.
 182
 183     // Session expiration for SAML 1.x is purely SP-driven, and the method is mapped to a ctx class.
 184     const PropertySet* sessionProps = application.getPropertySet("Sessions");
 185     pair<bool,unsigned int> lifetime = sessionProps ? sessionProps->getUnsignedInt("lifetime") : make_pair(true,28800);
 186     if (!lifetime.first)
 187         lifetime.second = 28800;
 188     auto_ptr_char authnInstant(
 189         ssoStatement->getAuthenticationInstant() ? ssoStatement->getAuthenticationInstant()->getRawData() : NULL
 190         );
 191     auto_ptr_char authnMethod(ssoStatement->getAuthenticationMethod());
 192
 193     vector<shibsp::Attribute*>& attrs = ctx->getResolvedAttributes();
 194     string key = application.getServiceProvider().getSessionCache()->insert(
 195         lifetime.second ? now + lifetime.second : 0,
 196         application,
 197         httpRequest.getRemoteAddr().c_str(),
 198         issuerMetadata,
 199         *nameid.get(),
 200         authnInstant.get(),
 201         NULL,
 202         authnMethod.get(),
 203         NULL,
 204         &tokens,
 205         &attrs
 206         );
 207     attrs.clear();  // Attributes are owned by cache now.
 208     return key;
 209 }