2 * Copyright 2001-2006 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 * SAML1POSTDecoder.cpp
20 * SAML 1.x POST binding/profile message decoder
24 #include "exceptions.h"
25 #include "saml/binding/ReplayCache.h"
26 #include "saml1/binding/SAML1POSTDecoder.h"
27 #include "saml2/metadata/Metadata.h"
28 #include "saml2/metadata/MetadataProvider.h"
29 #include "security/X509TrustEngine.h"
31 #include <log4cpp/Category.hh>
32 #include <xercesc/util/Base64.hpp>
33 #include <xmltooling/util/NDC.h>
35 using namespace opensaml::saml2md;
36 using namespace opensaml::saml1p;
37 using namespace opensaml::saml1;
38 using namespace opensaml;
39 using namespace xmlsignature;
40 using namespace xmltooling;
41 using namespace log4cpp;
46 MessageDecoder* SAML_DLLLOCAL SAML1POSTDecoderFactory(const DOMElement* const & e)
48 return new SAML1POSTDecoder(e);
53 SAML1POSTDecoder::SAML1POSTDecoder(const DOMElement* e) {}
55 SAML1POSTDecoder::~SAML1POSTDecoder() {}
57 Response* SAML1POSTDecoder::decode(
59 const RoleDescriptor*& issuer,
61 const HTTPRequest& httpRequest,
62 const MetadataProvider* metadataProvider,
64 const opensaml::TrustEngine* trustEngine
68 xmltooling::NDC ndc("decode");
70 Category& log = Category::getInstance(SAML_LOGCAT".MessageDecoder.SAML1POST");
72 log.debug("validating input");
73 if (strcmp(httpRequest.getMethod(),"POST"))
75 const char* samlResponse = httpRequest.getParameter("SAMLResponse");
76 const char* TARGET = httpRequest.getParameter("TARGET");
77 if (!samlResponse || !TARGET)
81 // Decode the base64 into SAML.
83 XMLByte* decoded=Base64::decode(reinterpret_cast<const XMLByte*>(samlResponse),&x);
85 throw BindingException("Unable to decode base64 in POST profile response.");
86 log.debug("decoded SAML response:\n%s", decoded);
87 istringstream is(reinterpret_cast<char*>(decoded));
88 XMLString::release(&decoded);
90 // Parse and bind the document into an XMLObject.
91 DOMDocument* doc = (m_validate ? XMLToolingConfig::getConfig().getValidatingParser()
92 : XMLToolingConfig::getConfig().getParser()).parse(is);
93 XercesJanitor<DOMDocument> janitor(doc);
94 auto_ptr<XMLObject> xmlObject(XMLObjectBuilder::buildOneFromElement(doc->getDocumentElement(), true));
97 Response* response = dynamic_cast<Response*>(xmlObject.get());
99 throw BindingException("Decoded message was not a SAML 1.x Response.");
101 const EntityDescriptor* provider=NULL;
104 SchemaValidators.validate(xmlObject.get());
106 // Check recipient URL.
107 auto_ptr_char recipient(response->getRecipient());
108 const char* recipient2 = httpRequest.getRequestURL();
109 if (!recipient.get() || !*(recipient.get())) {
110 log.error("response missing Recipient attribute");
111 throw BindingException("SAML response did not contain Recipient attribute identifying intended destination.");
113 else if (!recipient2 || !*recipient2 || strcmp(recipient.get(),recipient2)) {
114 log.error("POST targeted at (%s), but delivered to (%s)", recipient.get(), recipient2 ? recipient2 : "none");
115 throw BindingException("SAML message delivered with POST to incorrect server URL.");
119 time_t now = time(NULL);
120 if (response->getIssueInstant()->getEpoch() < now-(2*XMLToolingConfig::getConfig().clock_skew_secs))
121 throw BindingException("Detected expired POST profile response.");
124 ReplayCache* replayCache = SAMLConfig::getConfig().getReplayCache();
126 auto_ptr_char id(response->getResponseID());
127 if (!replayCache->check("SAML1POST", id.get(), response->getIssueInstant()->getEpoch() + (2*XMLToolingConfig::getConfig().clock_skew_secs))) {
128 log.error("replay detected of response ID (%s)", id.get());
129 throw BindingException("Rejecting replayed response ID ($1).", params(1,id.get()));
133 log.warn("replay cache was not provided, this is a serious security risk!");
135 /* For SAML 1, the issuer can only be established from any assertions in the message.
136 * Generally, errors aren't delivered like this, so there should be one.
137 * The Issuer attribute is matched against metadata, and then trust checking can be
141 issuerTrusted = false;
142 log.debug("attempting to establish issuer and integrity of message...");
143 const vector<Assertion*>& assertions=const_cast<const Response*>(response)->getAssertions();
144 if (!assertions.empty()) {
145 log.debug("searching metadata for assertion issuer...");
146 provider=metadataProvider ? metadataProvider->getEntityDescriptor(assertions.front()->getIssuer()) : NULL;
148 log.debug("matched assertion issuer against metadata, searching for applicable role...");
149 pair<bool,int> minor = response->getMinorVersion();
150 issuer=provider->getRoleDescriptor(
152 (minor.first && minor.second==0) ? SAMLConstants::SAML10_PROTOCOL_ENUM : SAMLConstants::SAML11_PROTOCOL_ENUM
155 if (trustEngine && response->getSignature()) {
156 issuerTrusted = trustEngine->validate(
157 *(response->getSignature()), *issuer, metadataProvider->getKeyResolver()
159 if (!issuerTrusted) {
160 log.error("unable to verify signature on message with supplied trust engine");
161 throw BindingException("Message signature failed verification.");
165 log.warn("unable to verify integrity of the message, leaving untrusted");
170 "unable to find compatible SAML 1.%d role (%s) in metadata",
171 (minor.first && minor.second==0) ? 0 : 1,
172 role->toString().c_str()
175 if (log.isDebugEnabled()) {
176 auto_ptr_char iname(assertions.front()->getIssuer());
177 log.debug("message from (%s), integrity %sverified", iname.get(), issuerTrusted ? "" : "NOT ");
181 auto_ptr_char temp(assertions.front()->getIssuer());
182 log.warn("no metadata found, can't establish identity of issuer (%s)", temp.get());
186 log.warn("no assertions found, can't establish identity of issuer");
189 catch (XMLToolingException& ex) {
190 // Check for an Issuer.
192 const vector<Assertion*>& assertions=const_cast<const Response*>(response)->getAssertions();
193 if (!assertions.empty() || !metadataProvider ||
194 !(provider=metadataProvider->getEntityDescriptor(assertions.front()->getIssuer(), false))) {
196 auto_ptr_char iname(assertions.front()->getIssuer());
198 ex.addProperty("entityID", iname.get());
203 pair<bool,int> minor = response->getMinorVersion();
204 issuer=provider->getRoleDescriptor(
206 (minor.first && minor.second==0) ? SAMLConstants::SAML10_PROTOCOL_ENUM : SAMLConstants::SAML11_PROTOCOL_ENUM
209 if (issuer) annotateException(&ex,issuer); // throws it
210 annotateException(&ex,provider); // throws it