2 * Copyright 2001-2010 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 * SAML2ArtifactEncoder.cpp
20 * SAML 2.0 HTTP-Artifact binding message encoder.
24 #include "exceptions.h"
25 #include "binding/ArtifactMap.h"
26 #include "binding/MessageEncoder.h"
27 #include "saml2/binding/SAML2Artifact.h"
28 #include "saml2/core/Protocols.h"
29 #include "saml2/metadata/Metadata.h"
30 #include "signature/ContentReference.h"
34 #include <xmltooling/logging.h>
35 #include <xmltooling/XMLToolingConfig.h>
36 #include <xmltooling/io/HTTPResponse.h>
37 #include <xmltooling/signature/Signature.h>
38 #include <xmltooling/util/NDC.h>
39 #include <xmltooling/util/PathResolver.h>
40 #include <xmltooling/util/TemplateEngine.h>
41 #include <xmltooling/util/URLEncoder.h>
43 using namespace opensaml::saml2p;
44 using namespace opensaml::saml2md;
45 using namespace opensaml;
46 using namespace xmlsignature;
47 using namespace xmltooling::logging;
48 using namespace xmltooling;
53 class SAML_DLLLOCAL SAML2ArtifactEncoder : public MessageEncoder
56 SAML2ArtifactEncoder(const DOMElement* e, const XMLCh* ns);
57 virtual ~SAML2ArtifactEncoder() {}
59 const XMLCh* getProtocolFamily() const {
60 return samlconstants::SAML20P_NS;
64 GenericResponse& genericResponse,
66 const char* destination,
67 const EntityDescriptor* recipient=nullptr,
68 const char* relayState=nullptr,
69 const ArtifactGenerator* artifactGenerator=nullptr,
70 const Credential* credential=nullptr,
71 const XMLCh* signatureAlg=nullptr,
72 const XMLCh* digestAlg=nullptr
79 MessageEncoder* SAML_DLLLOCAL SAML2ArtifactEncoderFactory(const pair<const DOMElement*,const XMLCh*>& p)
81 return new SAML2ArtifactEncoder(p.first, p.second);
85 static const XMLCh _template[] = UNICODE_LITERAL_8(t,e,m,p,l,a,t,e);
86 static const XMLCh postArtifact[] = UNICODE_LITERAL_12(p,o,s,t,A,r,t,i,f,a,c,t);
89 SAML2ArtifactEncoder::SAML2ArtifactEncoder(const DOMElement* e, const XMLCh* ns)
91 if (XMLHelper::getAttrBool(e, false, postArtifact, ns)) {
92 m_template = XMLHelper::getAttrString(e, "bindingTemplate.html", _template, ns);
93 if (!m_template.empty())
94 XMLToolingConfig::getConfig().getPathResolver()->resolve(m_template, PathResolver::XMLTOOLING_CFG_FILE);
98 long SAML2ArtifactEncoder::encode(
99 GenericResponse& genericResponse,
100 XMLObject* xmlObject,
101 const char* destination,
102 const EntityDescriptor* recipient,
103 const char* relayState,
104 const ArtifactGenerator* artifactGenerator,
105 const Credential* credential,
106 const XMLCh* signatureAlg,
107 const XMLCh* digestAlg
111 xmltooling::NDC ndc("encode");
113 Category& log = Category::getInstance(SAML_LOGCAT".MessageEncoder.SAML2Artifact");
114 log.debug("validating input");
116 throw BindingException("Encoding response requires a destination.");
117 HTTPResponse* httpResponse=dynamic_cast<HTTPResponse*>(&genericResponse);
119 throw BindingException("Unable to cast response interface to HTTPResponse type.");
120 if (relayState && strlen(relayState)>80)
121 throw BindingException("RelayState cannot exceed 80 bytes in length.");
122 if (xmlObject->getParent())
123 throw BindingException("Cannot encode XML content with parent.");
125 StatusResponseType* response = nullptr;
126 RequestAbstractType* request = dynamic_cast<RequestAbstractType*>(xmlObject);
128 response = dynamic_cast<StatusResponseType*>(xmlObject);
130 throw BindingException("XML content for SAML 2.0 HTTP-Artifact Encoder must be a SAML 2.0 protocol message.");
133 ArtifactMap* mapper = SAMLConfig::getConfig().getArtifactMap();
135 throw BindingException("SAML 2.0 HTTP-Artifact Encoder requires ArtifactMap be set in configuration.");
137 // Obtain a fresh artifact.
138 if (!artifactGenerator)
139 throw BindingException("SAML 2.0 HTTP-Artifact Encoder requires an ArtifactGenerator instance.");
140 auto_ptr_char recipientID(recipient ? recipient->getEntityID() : nullptr);
141 log.debug("obtaining new artifact for relying party (%s)", recipientID.get() ? recipientID.get() : "unknown");
142 auto_ptr<SAMLArtifact> artifact(artifactGenerator->generateSAML2Artifact(recipient));
145 // Signature based on native XML signing.
146 if (request ? request->getSignature() : response->getSignature()) {
147 log.debug("message already signed, skipping signature operation");
150 log.debug("signing the message");
152 // Build a Signature.
153 Signature* sig = SignatureBuilder::buildSignature();
154 request ? request->setSignature(sig) : response->setSignature(sig);
156 sig->setSignatureAlgorithm(signatureAlg);
158 opensaml::ContentReference* cr = dynamic_cast<opensaml::ContentReference*>(sig->getContentReference());
160 cr->setDigestAlgorithm(digestAlg);
163 // Sign response while marshalling.
164 vector<Signature*> sigs(1,sig);
165 xmlObject->marshall((DOMDocument*)nullptr,&sigs,credential);
169 if (log.isDebugEnabled())
170 log.debugStream() << "marshalled message:" << logging::eol << *xmlObject << logging::eol;
172 // Store the message. Last step in storage will be to delete the XML.
173 log.debug("storing artifact and content in map");
174 mapper->storeContent(xmlObject, artifact.get(), recipientID.get());
176 if (m_template.empty()) {
177 // Generate redirect.
178 string loc = destination;
179 loc += (strchr(destination,'?') ? '&' : '?');
180 const URLEncoder* escaper = XMLToolingConfig::getConfig().getURLEncoder();
181 loc = loc + "SAMLart=" + escaper->encode(artifact->encode().c_str());
182 if (relayState && *relayState)
183 loc = loc + "&RelayState=" + escaper->encode(relayState);
184 log.debug("message encoded, sending redirect to client");
185 return httpResponse->sendRedirect(loc.c_str());
188 // Push message into template and send result to client.
189 log.debug("message encoded, sending HTML form template to client");
190 TemplateEngine* engine = XMLToolingConfig::getConfig().getTemplateEngine();
192 throw BindingException("Encoding artifact using POST requires a TemplateEngine instance.");
193 HTTPResponse::sanitizeURL(destination);
194 ifstream infile(m_template.c_str());
196 throw BindingException("Failed to open HTML template for POST response ($1).", params(1,m_template.c_str()));
197 TemplateEngine::TemplateParameters params;
198 params.m_map["action"] = destination;
199 params.m_map["SAMLart"] = artifact->encode();
200 if (relayState && *relayState)
201 params.m_map["RelayState"] = relayState;
203 engine->run(infile, s, params);
204 httpResponse->setContentType("text/html");
205 httpResponse->setResponseHeader("Expires", "01-Jan-1997 12:00:00 GMT");
206 httpResponse->setResponseHeader("Cache-Control", "no-cache, no-store, must-revalidate, private");
207 httpResponse->setResponseHeader("Pragma", "no-cache");
208 return httpResponse->sendResponse(s);