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 * SAML1ArtifactDecoder.cpp
20 * SAML 1.x Artifact binding/profile message decoder
24 #include "exceptions.h"
25 #include "binding/MessageDecoder.h"
26 #include "binding/SAMLArtifact.h"
27 #include "saml1/core/Protocols.h"
28 #include "saml2/metadata/Metadata.h"
29 #include "saml2/metadata/MetadataProvider.h"
31 #include <log4cpp/Category.hh>
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::saml1p;
38 using namespace opensaml;
39 using namespace xmltooling;
40 using namespace log4cpp;
45 class SAML_DLLLOCAL SAML1ArtifactDecoder : public MessageDecoder
48 SAML1ArtifactDecoder(const DOMElement* e) {}
49 virtual ~SAML1ArtifactDecoder() {}
51 xmltooling::XMLObject* decode(
52 std::string& relayState,
53 const GenericRequest& genericRequest,
54 SecurityPolicy& policy
58 MessageDecoder* SAML_DLLLOCAL SAML1ArtifactDecoderFactory(const DOMElement* const & e)
60 return new SAML1ArtifactDecoder(e);
65 XMLObject* SAML1ArtifactDecoder::decode(
67 const GenericRequest& genericRequest,
68 SecurityPolicy& policy
72 xmltooling::NDC ndc("decode");
74 Category& log = Category::getInstance(SAML_LOGCAT".MessageDecoder.SAML1Artifact");
76 log.debug("validating input");
77 const HTTPRequest* httpRequest=dynamic_cast<const HTTPRequest*>(&genericRequest);
79 log.error("unable to cast request to HTTPRequest type");
82 if (strcmp(httpRequest->getMethod(),"GET"))
84 vector<const char*> SAMLart;
85 const char* TARGET = httpRequest->getParameter("TARGET");
86 if (httpRequest->getParameters("SAMLart", SAMLart)==0 || !TARGET)
90 if (!m_artifactResolver || !policy.getMetadataProvider() || !policy.getRole())
91 throw BindingException("Artifact profile requires ArtifactResolver and MetadataProvider implementations be supplied.");
93 // Import the artifacts.
94 vector<SAMLArtifact*> artifacts;
95 for (vector<const char*>::const_iterator raw=SAMLart.begin(); raw!=SAMLart.end(); ++raw) {
97 log.debug("processing encoded artifact (%s)", *raw);
100 ReplayCache* replayCache = XMLToolingConfig::getConfig().getReplayCache();
102 if (!replayCache->check("SAML1Artifact", *raw, time(NULL) + (2*XMLToolingConfig::getConfig().clock_skew_secs))) {
103 log.error("replay detected of artifact (%s)", *raw);
104 throw BindingException("Rejecting replayed artifact ($1).", params(1,*raw));
108 log.warn("replay cache was not provided, this is a serious security risk!");
110 artifacts.push_back(SAMLArtifact::parse(*raw));
112 catch (ArtifactException&) {
113 log.error("error parsing artifact (%s)", *raw);
114 for_each(artifacts.begin(), artifacts.end(), xmltooling::cleanup<SAMLArtifact>());
117 catch (XMLToolingException&) {
118 for_each(artifacts.begin(), artifacts.end(), xmltooling::cleanup<SAMLArtifact>());
123 log.debug("attempting to determine source of artifact(s)...");
124 const EntityDescriptor* provider=policy.getMetadataProvider()->getEntityDescriptor(artifacts.front());
127 "metadata lookup failed, unable to determine issuer of artifact (0x%s)",
128 SAMLArtifact::toHex(artifacts.front()->getBytes()).c_str()
130 for_each(artifacts.begin(), artifacts.end(), xmltooling::cleanup<SAMLArtifact>());
131 throw BindingException("Metadata lookup failed, unable to determine artifact issuer");
134 if (log.isDebugEnabled()) {
135 auto_ptr_char issuer(provider->getEntityID());
136 log.debug("lookup succeeded, artifact issued by (%s)", issuer.get());
139 // Mock up an Issuer object for the policy.
140 auto_ptr<saml2::Issuer> issuer(saml2::IssuerBuilder::buildIssuer());
141 issuer->setName(provider->getEntityID());
142 policy.setIssuer(issuer.get());
143 issuer.release(); // owned by policy now
145 log.debug("attempting to find artifact issuing role...");
146 const RoleDescriptor* roledesc=provider->getRoleDescriptor(*(policy.getRole()), samlconstants::SAML11_PROTOCOL_ENUM);
148 roledesc=provider->getRoleDescriptor(*(policy.getRole()), samlconstants::SAML10_PROTOCOL_ENUM);
149 if (!roledesc || !dynamic_cast<const IDPSSODescriptor*>(roledesc)) {
150 log.error("unable to find compatible SAML role (%s) in metadata", policy.getRole()->toString().c_str());
151 for_each(artifacts.begin(), artifacts.end(), xmltooling::cleanup<SAMLArtifact>());
152 throw BindingException("Unable to find compatible metadata role for artifact issuer.");
154 policy.setIssuerMetadata(roledesc);
157 log.debug("calling ArtifactResolver...");
158 auto_ptr<Response> response(
159 m_artifactResolver->resolve(artifacts, dynamic_cast<const IDPSSODescriptor&>(*roledesc), policy)
162 // The policy should be enforced against the Response by the resolve step.
164 for_each(artifacts.begin(), artifacts.end(), xmltooling::cleanup<SAMLArtifact>());
165 return response.release();
167 catch (XMLToolingException&) {
168 for_each(artifacts.begin(), artifacts.end(), xmltooling::cleanup<SAMLArtifact>());