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 * SAML1POSTEncoder.cpp
20 * SAML 1.x POST binding/profile message encoder
24 #include "exceptions.h"
25 #include "binding/MessageEncoder.h"
26 #include "saml1/core/Protocols.h"
30 #include <log4cpp/Category.hh>
31 #include <xercesc/util/Base64.hpp>
32 #include <xmltooling/util/NDC.h>
33 #include <xmltooling/util/TemplateEngine.h>
35 using namespace opensaml::saml1p;
36 using namespace opensaml;
37 using namespace xmlsignature;
38 using namespace xmltooling;
39 using namespace log4cpp;
44 class SAML_DLLLOCAL SAML1POSTEncoder : public MessageEncoder
47 SAML1POSTEncoder(const DOMElement* e);
48 virtual ~SAML1POSTEncoder() {}
51 GenericResponse& genericResponse,
52 xmltooling::XMLObject* xmlObject,
53 const char* destination,
54 const char* recipientID=NULL,
55 const char* relayState=NULL,
56 const xmltooling::CredentialResolver* credResolver=NULL,
57 const XMLCh* sigAlgorithm=NULL
61 /** Pathname of HTML template for transmission of message via POST. */
62 std::string m_template;
65 MessageEncoder* SAML_DLLLOCAL SAML1POSTEncoderFactory(const DOMElement* const & e)
67 return new SAML1POSTEncoder(e);
72 static const XMLCh _template[] = UNICODE_LITERAL_8(t,e,m,p,l,a,t,e);
74 SAML1POSTEncoder::SAML1POSTEncoder(const DOMElement* e)
77 auto_ptr_char t(e->getAttributeNS(NULL, _template));
81 if (m_template.empty())
82 throw XMLToolingException("SAML1POSTEncoder requires template XML attribute.");
85 long SAML1POSTEncoder::encode(
86 GenericResponse& genericResponse,
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.SAML1POST");
100 log.debug("validating input");
101 if (xmlObject->getParent())
102 throw BindingException("Cannot encode XML content with parent.");
103 Response* response = dynamic_cast<Response*>(xmlObject);
105 throw BindingException("XML content for SAML 1.x POST Encoder must be a SAML 1.x <Response>.");
107 throw BindingException("SAML 1.x POST Encoder requires relay state (TARGET) value.");
109 DOMElement* rootElement = NULL;
111 // Signature based on native XML signing.
112 if (response->getSignature()) {
113 log.debug("response already signed, skipping signature operation");
116 log.debug("signing and marshalling the response");
118 // Build a Signature.
119 Signature* sig = buildSignature(credResolver, sigAlgorithm);
120 response->setSignature(sig);
122 // Sign response while marshalling.
123 vector<Signature*> sigs(1,sig);
124 rootElement = response->marshall((DOMDocument*)NULL,&sigs);
128 log.debug("marshalling the response");
129 rootElement = response->marshall();
133 XMLHelper::serialize(rootElement, xmlbuf);
135 XMLByte* out=Base64::encode(reinterpret_cast<const XMLByte*>(xmlbuf.data()),xmlbuf.size(),&len);
138 xmlbuf.append(reinterpret_cast<char*>(out),len);
139 XMLString::release(&out);
142 throw BindingException("Base64 encoding of XML failed.");
145 // Push message into template and send result to client.
146 log.debug("message encoded, sending HTML form template to client");
147 TemplateEngine* engine = XMLToolingConfig::getConfig().getTemplateEngine();
149 throw BindingException("Encoding response using POST requires a TemplateEngine instance.");
150 ifstream infile(m_template.c_str());
152 throw BindingException("Failed to open HTML template for POST response ($1).", params(1,m_template.c_str()));
153 TemplateEngine::TemplateParameters params;
154 params.m_map["action"] = destination;
155 params.m_map["SAMLResponse"] = xmlbuf;
156 params.m_map["TARGET"] = relayState;
158 engine->run(infile, s, params);
159 genericResponse.setContentType("text/html");
160 long ret = genericResponse.sendResponse(s);
162 // Cleanup by destroying XML.