Revamped encoders to produce the actual HTTP responses.
[shibboleth/cpp-opensaml.git] / saml / saml1 / binding / impl / SAML1POSTEncoder.cpp
1 /*
2  *  Copyright 2001-2006 Internet2
3  * 
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
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 /**
18  * SAML1POSTEncoder.cpp
19  * 
20  * SAML 1.x POST binding/profile message encoder
21  */
22
23 #include "internal.h"
24 #include "exceptions.h"
25 #include "saml1/binding/SAML1POSTEncoder.h"
26 #include "saml1/core/Protocols.h"
27
28 #include <fstream>
29 #include <sstream>
30 #include <log4cpp/Category.hh>
31 #include <xercesc/util/Base64.hpp>
32 #include <xmltooling/util/NDC.h>
33 #include <xmltooling/util/TemplateEngine.h>
34
35 using namespace opensaml::saml1p;
36 using namespace opensaml;
37 using namespace xmlsignature;
38 using namespace xmltooling;
39 using namespace log4cpp;
40 using namespace std;
41
42 namespace opensaml {
43     namespace saml1p {              
44         MessageEncoder* SAML_DLLLOCAL SAML1POSTEncoderFactory(const DOMElement* const & e)
45         {
46             return new SAML1POSTEncoder(e);
47         }
48     };
49 };
50
51 static const XMLCh templat[] = UNICODE_LITERAL_8(t,e,m,p,l,a,t,e);
52
53 SAML1POSTEncoder::SAML1POSTEncoder(const DOMElement* e)
54 {
55     if (e) {
56         auto_ptr_char t(e->getAttributeNS(NULL, templat));
57         if (t.get())
58             m_template = t.get();
59     }
60     if (m_template.empty())
61         throw XMLToolingException("SAML1POSTEncoder requires template attribute.");
62 }
63
64 SAML1POSTEncoder::~SAML1POSTEncoder() {}
65
66 long SAML1POSTEncoder::encode(
67     HTTPResponse& httpResponse,
68     XMLObject* xmlObject,
69     const char* destination,
70     const char* recipientID,
71     const char* relayState,
72     const CredentialResolver* credResolver,
73     const XMLCh* sigAlgorithm
74     ) const
75 {
76 #ifdef _DEBUG
77     xmltooling::NDC ndc("encode");
78 #endif
79     Category& log = Category::getInstance(SAML_LOGCAT".MessageEncoder.SAML1POST");
80     log.debug("validating input");
81     
82     if (xmlObject->getParent())
83         throw BindingException("Cannot encode XML content with parent.");
84     Response* response = dynamic_cast<Response*>(xmlObject);
85     if (!response)
86         throw BindingException("XML content for SAML 1.x POST Encoder must be a SAML 1.x <Response>.");
87     if (!relayState)
88         throw BindingException("SAML 1.x POST Encoder requires relay state (TARGET) value.");
89     
90     DOMElement* rootElement = NULL;
91     if (credResolver) {
92         // Signature based on native XML signing.
93         if (response->getSignature()) {
94             log.debug("response already signed, skipping signature operation");
95         }
96         else {
97             log.debug("signing and marshalling the response");
98
99             // Build a Signature.
100             Signature* sig = buildSignature(credResolver, sigAlgorithm);
101             response->setSignature(sig);
102     
103             // Sign response while marshalling.
104             vector<Signature*> sigs(1,sig);
105             rootElement = response->marshall((DOMDocument*)NULL,&sigs);
106         }
107     }
108     else {
109         log.debug("marshalling the response");
110         rootElement = response->marshall();
111     }
112     
113     string xmlbuf;
114     XMLHelper::serialize(rootElement, xmlbuf);
115     unsigned int len=0;
116     XMLByte* out=Base64::encode(reinterpret_cast<const XMLByte*>(xmlbuf.data()),xmlbuf.size(),&len);
117     if (out) {
118         xmlbuf.erase();
119         xmlbuf.append(reinterpret_cast<char*>(out),len);
120         XMLString::release(&out);
121     }
122     else {
123         throw BindingException("Base64 encoding of XML failed.");
124     }
125
126     // Push message into template and send result to client.
127     log.debug("message encoded, sending HTML form template to client");
128     TemplateEngine* engine = XMLToolingConfig::getConfig().getTemplateEngine();
129     if (!engine)
130         throw BindingException("Encoding response using POST requires a TemplateEngine instance.");
131     ifstream infile(m_template.c_str());
132     if (!infile)
133         throw BindingException("Failed to open HTML template for POST response ($1).", params(1,m_template.c_str()));
134     map<string,string> params;
135     params["action"] = destination;
136     params["SAMLResponse"] = xmlbuf;
137     params["TARGET"] = relayState;
138     stringstream s;
139     engine->run(infile, s, params);
140     long ret = httpResponse.sendResponse(s);
141
142     // Cleanup by destroying XML.
143     delete xmlObject;
144     return ret;
145 }