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 * SAML2ArtifactDecoder.cpp
20 * SAML 2.0 Artifact binding message decoder
24 #include "exceptions.h"
25 #include "saml2/binding/SAML2Artifact.h"
26 #include "saml2/binding/SAML2MessageDecoder.h"
27 #include "saml2/core/Protocols.h"
28 #include "saml2/metadata/Metadata.h"
29 #include "saml2/metadata/MetadataProvider.h"
31 #include <xmltooling/logging.h>
32 #include <xmltooling/io/HTTPRequest.h>
33 #include <xmltooling/util/NDC.h>
34 #include <xmltooling/util/ReplayCache.h>
36 using namespace opensaml::saml2md;
37 using namespace opensaml::saml2p;
38 using namespace opensaml::saml2;
39 using namespace opensaml;
40 using namespace xmltooling::logging;
41 using namespace xmltooling;
46 class SAML_DLLLOCAL SAML2ArtifactDecoder : public SAML2MessageDecoder
49 SAML2ArtifactDecoder() {}
50 virtual ~SAML2ArtifactDecoder() {}
52 xmltooling::XMLObject* decode(
53 std::string& relayState,
54 const GenericRequest& genericRequest,
55 SecurityPolicy& policy
59 MessageDecoder* SAML_DLLLOCAL SAML2ArtifactDecoderFactory(const pair<const DOMElement*,const XMLCh*>& p)
61 return new SAML2ArtifactDecoder();
66 XMLObject* SAML2ArtifactDecoder::decode(
68 const GenericRequest& genericRequest,
69 SecurityPolicy& policy
73 xmltooling::NDC ndc("decode");
75 Category& log = Category::getInstance(SAML_LOGCAT".MessageDecoder.SAML2Artifact");
77 log.debug("validating input");
78 const HTTPRequest* httpRequest=dynamic_cast<const HTTPRequest*>(&genericRequest);
80 throw BindingException("Unable to cast request object to HTTPRequest type.");
81 const char* SAMLart = httpRequest->getParameter("SAMLart");
83 throw BindingException("Request missing SAMLart query string or form parameter.");
84 const char* state = httpRequest->getParameter("RelayState");
88 if (!m_artifactResolver || !policy.getMetadataProvider() || !policy.getRole())
89 throw BindingException("Artifact binding requires ArtifactResolver and MetadataProvider implementations be supplied.");
91 // Import the artifact.
92 SAMLArtifact* artifact=NULL;
94 log.debug("processing encoded artifact (%s)", SAMLart);
97 ReplayCache* replayCache = XMLToolingConfig::getConfig().getReplayCache();
99 if (!replayCache->check("SAML2Artifact", SAMLart, time(NULL) + (2*XMLToolingConfig::getConfig().clock_skew_secs))) {
100 log.error("replay detected of artifact (%s)", SAMLart);
101 throw BindingException("Rejecting replayed artifact ($1).", params(1,SAMLart));
105 log.warn("replay cache was not provided, this is a serious security risk!");
107 artifact = SAMLArtifact::parse(SAMLart);
109 catch (ArtifactException&) {
110 log.error("error parsing artifact (%s)", SAMLart);
115 auto_ptr<SAML2Artifact> artifact2(dynamic_cast<SAML2Artifact*>(artifact));
116 if (!artifact2.get()) {
117 throw BindingException("Artifact binding requires SAML 2.0 artifact.");
121 log.debug("attempting to determine source of artifact...");
122 MetadataProvider::Criteria& mc = policy.getMetadataProviderCriteria();
123 mc.artifact = artifact;
124 mc.role = policy.getRole();
125 mc.protocol = samlconstants::SAML20P_NS;
126 pair<const EntityDescriptor*,const RoleDescriptor*> provider=policy.getMetadataProvider()->getEntityDescriptor(mc);
127 if (!provider.first) {
129 "metadata lookup failed, unable to determine issuer of artifact (0x%s)",
130 SAMLArtifact::toHex(artifact->getBytes()).c_str()
132 throw BindingException("Metadata lookup failed, unable to determine artifact issuer.");
135 if (log.isDebugEnabled()) {
136 auto_ptr_char issuer(provider.first->getEntityID());
137 log.debug("lookup succeeded, artifact issued by (%s)", issuer.get());
140 if (!provider.second || !dynamic_cast<const SSODescriptorType*>(provider.second)) {
141 log.error("unable to find compatible SAML 2.0 role (%s) in metadata", policy.getRole()->toString().c_str());
142 throw BindingException("Unable to find compatible metadata role for artifact issuer.");
144 // Set issuer into policy.
145 policy.setIssuer(provider.first->getEntityID());
146 policy.setIssuerMetadata(provider.second);
148 log.debug("calling ArtifactResolver...");
149 auto_ptr<ArtifactResponse> response(
150 m_artifactResolver->resolve(*(artifact2.get()), dynamic_cast<const SSODescriptorType&>(*provider.second), policy)
153 // The policy should be enforced against the ArtifactResponse by the resolve step.
154 // Reset only the message state.
157 // Now extract details from the payload and check that message.
158 XMLObject* payload = response->getPayload();
160 throw BindingException("ArtifactResponse message did not contain a protocol message.");
161 extractMessageDetails(*payload, genericRequest, samlconstants::SAML20P_NS, policy);
162 policy.evaluate(*payload, &genericRequest);
164 // Return the payload only.