2 * Copyright 2001-2009 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 * SAML2ArtifactDecoder.cpp
20 * SAML 2.0 Artifact binding message decoder
24 #include "exceptions.h"
25 #include "binding/SecurityPolicy.h"
26 #include "saml2/binding/SAML2Artifact.h"
27 #include "saml2/binding/SAML2MessageDecoder.h"
28 #include "saml2/core/Protocols.h"
29 #include "saml2/metadata/Metadata.h"
30 #include "saml2/metadata/MetadataProvider.h"
32 #include <xmltooling/logging.h>
33 #include <xmltooling/XMLToolingConfig.h>
34 #include <xmltooling/io/HTTPRequest.h>
35 #include <xmltooling/util/NDC.h>
36 #include <xmltooling/util/ReplayCache.h>
38 using namespace opensaml::saml2md;
39 using namespace opensaml::saml2p;
40 using namespace opensaml::saml2;
41 using namespace opensaml;
42 using namespace xmltooling::logging;
43 using namespace xmltooling;
48 class SAML_DLLLOCAL SAML2ArtifactDecoder : public SAML2MessageDecoder
51 SAML2ArtifactDecoder() {}
52 virtual ~SAML2ArtifactDecoder() {}
54 xmltooling::XMLObject* decode(
55 std::string& relayState,
56 const GenericRequest& genericRequest,
57 SecurityPolicy& policy
61 MessageDecoder* SAML_DLLLOCAL SAML2ArtifactDecoderFactory(const pair<const DOMElement*,const XMLCh*>& p)
63 return new SAML2ArtifactDecoder();
68 XMLObject* SAML2ArtifactDecoder::decode(
70 const GenericRequest& genericRequest,
71 SecurityPolicy& policy
75 xmltooling::NDC ndc("decode");
77 Category& log = Category::getInstance(SAML_LOGCAT".MessageDecoder.SAML2Artifact");
79 log.debug("validating input");
80 const HTTPRequest* httpRequest=dynamic_cast<const HTTPRequest*>(&genericRequest);
82 throw BindingException("Unable to cast request object to HTTPRequest type.");
83 const char* SAMLart = httpRequest->getParameter("SAMLart");
85 throw BindingException("Request missing SAMLart query string or form parameter.");
86 const char* state = httpRequest->getParameter("RelayState");
90 if (!m_artifactResolver || !policy.getMetadataProvider() || !policy.getRole())
91 throw BindingException("Artifact binding requires ArtifactResolver and MetadataProvider implementations be supplied.");
93 // Import the artifact.
94 SAMLArtifact* artifact=NULL;
96 log.debug("processing encoded artifact (%s)", SAMLart);
99 ReplayCache* replayCache = XMLToolingConfig::getConfig().getReplayCache();
101 if (!replayCache->check("SAML2Artifact", SAMLart, time(NULL) + (2*XMLToolingConfig::getConfig().clock_skew_secs))) {
102 log.error("replay detected of artifact (%s)", SAMLart);
103 throw BindingException("Rejecting replayed artifact ($1).", params(1,SAMLart));
107 log.warn("replay cache was not provided, this is a serious security risk!");
109 artifact = SAMLArtifact::parse(SAMLart);
111 catch (ArtifactException&) {
112 log.error("error parsing artifact (%s)", SAMLart);
117 auto_ptr<SAML2Artifact> artifact2(dynamic_cast<SAML2Artifact*>(artifact));
118 if (!artifact2.get()) {
119 throw BindingException("Artifact binding requires SAML 2.0 artifact.");
123 log.debug("attempting to determine source of artifact...");
124 MetadataProvider::Criteria& mc = policy.getMetadataProviderCriteria();
125 mc.artifact = artifact;
126 mc.role = policy.getRole();
127 mc.protocol = samlconstants::SAML20P_NS;
128 pair<const EntityDescriptor*,const RoleDescriptor*> provider=policy.getMetadataProvider()->getEntityDescriptor(mc);
129 if (!provider.first) {
131 "metadata lookup failed, unable to determine issuer of artifact (0x%s)",
132 SAMLArtifact::toHex(artifact->getBytes()).c_str()
134 throw BindingException("Metadata lookup failed, unable to determine artifact issuer.");
137 if (log.isDebugEnabled()) {
138 auto_ptr_char issuer(provider.first->getEntityID());
139 log.debug("lookup succeeded, artifact issued by (%s)", issuer.get());
142 if (!provider.second || !dynamic_cast<const SSODescriptorType*>(provider.second)) {
143 log.error("unable to find compatible SAML 2.0 role (%s) in metadata", policy.getRole()->toString().c_str());
144 throw BindingException("Unable to find compatible metadata role for artifact issuer.");
146 // Set issuer into policy.
147 policy.setIssuer(provider.first->getEntityID());
148 policy.setIssuerMetadata(provider.second);
150 log.debug("calling ArtifactResolver...");
151 auto_ptr<ArtifactResponse> response(
152 m_artifactResolver->resolve(*(artifact2.get()), dynamic_cast<const SSODescriptorType&>(*provider.second), policy)
155 // The policy should be enforced against the ArtifactResponse by the resolve step.
156 // Reset only the message state.
159 // Now extract details from the payload and check that message.
160 XMLObject* payload = response->getPayload();
162 throw BindingException("ArtifactResponse message did not contain a protocol message.");
163 extractMessageDetails(*payload, genericRequest, samlconstants::SAML20P_NS, policy);
164 policy.evaluate(*payload, &genericRequest);
166 // Return the payload only.