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 * SAML2ArtifactEncoder.cpp
20 * SAML 2.0 HTTP-Artifact binding message encoder
24 #include "exceptions.h"
25 #include "binding/ArtifactMap.h"
26 #include "binding/HTTPResponse.h"
27 #include "binding/MessageEncoder.h"
28 #include "saml2/binding/SAML2Artifact.h"
29 #include "saml2/core/Protocols.h"
33 #include <log4cpp/Category.hh>
34 #include <xmltooling/util/NDC.h>
35 #include <xmltooling/util/TemplateEngine.h>
36 #include <xmltooling/util/URLEncoder.h>
38 using namespace opensaml::saml2p;
39 using namespace opensaml;
40 using namespace xmlsignature;
41 using namespace xmltooling;
42 using namespace log4cpp;
47 class SAML_DLLLOCAL SAML2ArtifactEncoder : public MessageEncoder
50 SAML2ArtifactEncoder(const DOMElement* e);
51 virtual ~SAML2ArtifactEncoder() {}
54 GenericResponse& genericResponse,
55 xmltooling::XMLObject* xmlObject,
56 const char* destination,
57 const char* recipientID=NULL,
58 const char* relayState=NULL,
59 const xmltooling::CredentialResolver* credResolver=NULL,
60 const XMLCh* sigAlgorithm=NULL
64 std::string m_template;
67 MessageEncoder* SAML_DLLLOCAL SAML2ArtifactEncoderFactory(const DOMElement* const & e)
69 return new SAML2ArtifactEncoder(e);
74 static const XMLCh _template[] = UNICODE_LITERAL_8(t,e,m,p,l,a,t,e);
76 SAML2ArtifactEncoder::SAML2ArtifactEncoder(const DOMElement* e)
79 auto_ptr_char t(e->getAttributeNS(NULL, _template));
85 long SAML2ArtifactEncoder::encode(
86 GenericResponse& genericResponse,
87 xmltooling::XMLObject* xmlObject,
88 const char* destination,
89 const char* recipientID,
90 const char* relayState,
91 const CredentialResolver* credResolver,
92 const XMLCh* sigAlgorithm
96 xmltooling::NDC ndc("encode");
98 Category& log = Category::getInstance(SAML_LOGCAT".MessageEncoder.SAML2Artifact");
100 log.debug("validating input");
101 HTTPResponse* httpResponse=dynamic_cast<HTTPResponse*>(&genericResponse);
103 throw BindingException("Unable to cast response interface to HTTPResponse type.");
104 if (relayState && strlen(relayState)>80)
105 throw BindingException("RelayState cannot exceed 80 bytes in length.");
107 if (xmlObject->getParent())
108 throw BindingException("Cannot encode XML content with parent.");
110 StatusResponseType* response = NULL;
111 RequestAbstractType* request = dynamic_cast<RequestAbstractType*>(xmlObject);
113 response = dynamic_cast<StatusResponseType*>(xmlObject);
115 throw BindingException("XML content for SAML 2.0 HTTP-Artifact Encoder must be a SAML 2.0 protocol message.");
117 ArtifactMap* mapper = SAMLConfig::getConfig().getArtifactMap();
119 throw BindingException("SAML 2.0 HTTP-Artifact Encoder requires ArtifactMap be set in configuration.");
121 // Obtain a fresh artifact.
122 if (!m_artifactGenerator)
123 throw BindingException("SAML 2.0 HTTP-Artifact Encoder requires an ArtifactGenerator instance.");
124 log.debug("obtaining new artifact for relying party (%s)", recipientID ? recipientID : "unknown");
125 auto_ptr<SAMLArtifact> artifact(m_artifactGenerator->generateSAML2Artifact(recipientID));
128 // Signature based on native XML signing.
129 if (request ? request->getSignature() : response->getSignature()) {
130 log.debug("message already signed, skipping signature operation");
133 log.debug("signing the message");
135 // Build a Signature.
136 Signature* sig = buildSignature(credResolver, sigAlgorithm);
139 request ? request->setSignature(sig) : response->setSignature(sig);
141 // Sign response while marshalling.
142 vector<Signature*> sigs(1,sig);
143 xmlObject->marshall((DOMDocument*)NULL,&sigs);
147 // Store the message. Last step in storage will be to delete the XML.
148 log.debug("storing artifact and content in map");
149 mapper->storeContent(xmlObject, artifact.get(), recipientID);
151 if (m_template.empty()) {
152 // Generate redirect.
153 string loc = destination;
154 loc += (strchr(destination,'?') ? '&' : '?');
155 const URLEncoder* escaper = XMLToolingConfig::getConfig().getURLEncoder();
156 loc = loc + "SAMLart=" + escaper->encode(artifact->encode().c_str());
158 loc = loc + "&RelayState=" + escaper->encode(relayState);
159 log.debug("message encoded, sending redirect to client");
160 return httpResponse->sendRedirect(loc.c_str());
163 // Push message into template and send result to client.
164 log.debug("message encoded, sending HTML form template to client");
165 TemplateEngine* engine = XMLToolingConfig::getConfig().getTemplateEngine();
167 throw BindingException("Encoding artifact using POST requires a TemplateEngine instance.");
168 ifstream infile(m_template.c_str());
170 throw BindingException("Failed to open HTML template for POST response ($1).", params(1,m_template.c_str()));
171 TemplateEngine::TemplateParameters params;
172 params.m_map["action"] = destination;
173 params.m_map["SAMLart"] = artifact->encode();
175 params.m_map["RelayState"] = relayState;
177 engine->run(infile, s, params);
178 httpResponse->setContentType("text/html");
179 return httpResponse->sendResponse(s);