saml/saml2/binding/impl/SAML2ArtifactDecoder.cpp

   1 /*
   2  *  Copyright 2001-2006 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  * SAML2ArtifactDecoder.cpp
  19  *
  20  * SAML 2.0 Artifact binding message decoder
  21  */
  22
  23 #include "internal.h"
  24 #include "exceptions.h"
  25 #include "binding/HTTPRequest.h"
  26 #include "saml/binding/SAMLArtifact.h"
  27 #include "saml2/binding/SAML2Artifact.h"
  28 #include "saml2/binding/SAML2ArtifactDecoder.h"
  29 #include "saml2/core/Protocols.h"
  30 #include "saml2/metadata/Metadata.h"
  31 #include "saml2/metadata/MetadataProvider.h"
  32
  33 #include <log4cpp/Category.hh>
  34 #include <xmltooling/util/NDC.h>
  35 #include <xmltooling/util/ReplayCache.h>
  36
  37 using namespace opensaml::saml2md;
  38 using namespace opensaml::saml2p;
  39 using namespace opensaml::saml2;
  40 using namespace opensaml;
  41 using namespace xmltooling;
  42 using namespace log4cpp;
  43 using namespace std;
  44
  45 namespace opensaml {
  46     namespace saml2p {
  47         MessageDecoder* SAML_DLLLOCAL SAML2ArtifactDecoderFactory(const DOMElement* const & e)
  48         {
  49             return new SAML2ArtifactDecoder(e);
  50         }
  51     };
  52 };
  53
  54 SAML2ArtifactDecoder::SAML2ArtifactDecoder(const DOMElement* e) {}
  55
  56 XMLObject* SAML2ArtifactDecoder::decode(
  57     string& relayState,
  58     const GenericRequest& genericRequest,
  59     SecurityPolicy& policy
  60     ) const
  61 {
  62 #ifdef _DEBUG
  63     xmltooling::NDC ndc("decode");
  64 #endif
  65     Category& log = Category::getInstance(SAML_LOGCAT".MessageDecoder.SAML2Artifact");
  66
  67     log.debug("validating input");
  68     const HTTPRequest* httpRequest=dynamic_cast<const HTTPRequest*>(&genericRequest);
  69     if (!httpRequest) {
  70         log.error("unable to cast request to HTTPRequest type");
  71         return NULL;
  72     }
  73     const char* SAMLart = httpRequest->getParameter("SAMLart");
  74     if (!SAMLart)
  75         return NULL;
  76     const char* state = httpRequest->getParameter("RelayState");
  77     if (state)
  78         relayState = state;
  79
  80     if (!m_artifactResolver || !policy.getMetadataProvider() || !policy.getRole())
  81         throw BindingException("Artifact binding requires ArtifactResolver and MetadataProvider implementations be supplied.");
  82
  83     // Import the artifact.
  84     SAMLArtifact* artifact=NULL;
  85     try {
  86         log.debug("processing encoded artifact (%s)", SAMLart);
  87
  88         // Check replay.
  89         ReplayCache* replayCache = XMLToolingConfig::getConfig().getReplayCache();
  90         if (replayCache) {
  91             if (!replayCache->check("SAML2Artifact", SAMLart, time(NULL) + (2*XMLToolingConfig::getConfig().clock_skew_secs))) {
  92                 log.error("replay detected of artifact (%s)", SAMLart);
  93                 throw BindingException("Rejecting replayed artifact ($1).", params(1,SAMLart));
  94             }
  95         }
  96         else
  97             log.warn("replay cache was not provided, this is a serious security risk!");
  98
  99         artifact = SAMLArtifact::parse(SAMLart);
 100     }
 101     catch (ArtifactException&) {
 102         log.error("error parsing artifact (%s)", SAMLart);
 103         throw;
 104     }
 105
 106     // Check the type.
 107     auto_ptr<SAML2Artifact> artifact2(dynamic_cast<SAML2Artifact*>(artifact));
 108     if (!artifact2.get()) {
 109         throw BindingException("Artifact binding requires SAML 2.0 artifact.");
 110         delete artifact;
 111     }
 112
 113     log.debug("attempting to determine source of artifact...");
 114     const EntityDescriptor* provider=policy.getMetadataProvider()->getEntityDescriptor(artifact);
 115     if (!provider) {
 116         log.error(
 117             "metadata lookup failed, unable to determine issuer of artifact (0x%s)",
 118             SAMLArtifact::toHex(artifact->getBytes()).c_str()
 119             );
 120         throw BindingException("Metadata lookup failed, unable to determine artifact issuer.");
 121     }
 122
 123     if (log.isDebugEnabled()) {
 124         auto_ptr_char issuer(provider->getEntityID());
 125         log.debug("lookup succeeded, artifact issued by (%s)", issuer.get());
 126     }
 127
 128     log.debug("attempting to find artifact issuing role...");
 129     const RoleDescriptor* roledesc=provider->getRoleDescriptor(*(policy.getRole()), samlconstants::SAML20P_NS);
 130     if (!roledesc || !dynamic_cast<const SSODescriptorType*>(roledesc)) {
 131         log.error("unable to find compatible SAML role (%s) in metadata", policy.getRole()->toString().c_str());
 132         BindingException ex("Unable to find compatible metadata role for artifact issuer.");
 133         annotateException(&ex,provider); // throws it
 134     }
 135
 136     try {
 137         auto_ptr<ArtifactResponse> response(
 138             m_artifactResolver->resolve(*(artifact2.get()), dynamic_cast<const SSODescriptorType&>(*roledesc), policy)
 139             );
 140
 141         policy.evaluate(genericRequest, *(response.get()));
 142
 143         // Extract payload and check that message.
 144         XMLObject* payload = response->getPayload();
 145         policy.evaluate(genericRequest, *payload);
 146
 147         // Return the payload only.
 148         response.release();
 149         payload->detach();
 150         return payload;
 151     }
 152     catch (XMLToolingException& ex) {
 153         annotateException(&ex,roledesc,false);
 154         throw;
 155     }
 156 }