SSPCPP-616 - clean up concatenated string literals
[shibboleth/cpp-opensaml.git] / saml / saml1 / binding / impl / SAML1POSTEncoder.cpp
index f62bd62..5086cea 100644 (file)
-/*
- *  Copyright 2001-2006 Internet2
- * 
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+/**
+ * Licensed to the University Corporation for Advanced Internet
+ * Development, Inc. (UCAID) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
+ *
+ * UCAID licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the
+ * License at
  *
- *     http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
  *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
  */
 
 /**
  * SAML1POSTEncoder.cpp
  * 
- * SAML 1.x Artifact binding/profile message encoder
+ * SAML 1.x POST binding/profile message encoder.
  */
 
 #include "internal.h"
 #include "exceptions.h"
-#include "saml1/binding/SAML1POSTEncoder.h"
+#include "binding/MessageEncoder.h"
+#include "signature/ContentReference.h"
 #include "saml1/core/Protocols.h"
 
-#include <log4cpp/Category.hh>
+#include <fstream>
+#include <sstream>
 #include <xercesc/util/Base64.hpp>
+#include <xsec/framework/XSECDefs.hpp>
+#include <xmltooling/io/HTTPResponse.h>
+#include <xmltooling/logging.h>
+#include <xmltooling/XMLToolingConfig.h>
+#include <xmltooling/signature/Signature.h>
 #include <xmltooling/util/NDC.h>
+#include <xmltooling/util/PathResolver.h>
+#include <xmltooling/util/TemplateEngine.h>
 
 using namespace opensaml::saml1p;
+using namespace opensaml::saml2md;
 using namespace opensaml;
 using namespace xmlsignature;
+using namespace xmltooling::logging;
 using namespace xmltooling;
-using namespace log4cpp;
 using namespace std;
 
 namespace opensaml {
     namespace saml1p {              
-        MessageEncoder* SAML_DLLLOCAL SAML1POSTEncoderFactory(const DOMElement* const & e)
+        class SAML_DLLLOCAL SAML1POSTEncoder : public MessageEncoder
         {
-            return new SAML1POSTEncoder(e);
-        }
-
-        class SAML_DLLLOCAL _addcert : public binary_function<X509Data*,XSECCryptoX509*,void> {
         public:
-            void operator()(X509Data* bag, XSECCryptoX509* cert) const {
-                safeBuffer& buf=cert->getDEREncodingSB();
-                X509Certificate* x=X509CertificateBuilder::buildX509Certificate();
-                x->setValue(buf.sbStrToXMLCh());
-                bag->getX509Certificates().push_back(x);
+            SAML1POSTEncoder(const DOMElement* e, const XMLCh* ns);
+            virtual ~SAML1POSTEncoder() {}
+
+            const XMLCh* getProtocolFamily() const {
+                return samlconstants::SAML11_PROTOCOL_ENUM;
             }
+
+            long encode(
+                GenericResponse& genericResponse,
+                XMLObject* xmlObject,
+                const char* destination,
+                const EntityDescriptor* recipient=nullptr,
+                const char* relayState=nullptr,
+                const ArtifactGenerator* artifactGenerator=nullptr,
+                const Credential* credential=nullptr,
+                const XMLCh* signatureAlg=nullptr,
+                const XMLCh* digestAlg=nullptr
+                ) const;
+
+        protected:
+            /** Pathname of HTML template for transmission of message via POST. */
+            string m_template;
         };
+
+        MessageEncoder* SAML_DLLLOCAL SAML1POSTEncoderFactory(const pair<const DOMElement*,const XMLCh*>& p)
+        {
+            return new SAML1POSTEncoder(p.first, p.second);
+        }
     };
 };
 
-SAML1POSTEncoder::SAML1POSTEncoder(const DOMElement* e) {}
+static const XMLCh _template[] = UNICODE_LITERAL_8(t,e,m,p,l,a,t,e);
 
-SAML1POSTEncoder::~SAML1POSTEncoder() {}
+SAML1POSTEncoder::SAML1POSTEncoder(const DOMElement* e, const XMLCh* ns)
+    : m_template(XMLHelper::getAttrString(e, "bindingTemplate.html", _template, ns))
+{
+    if (m_template.empty())
+        throw XMLToolingException("SAML1POSTEncoder requires template XML attribute.");
+    XMLToolingConfig::getConfig().getPathResolver()->resolve(m_template, PathResolver::XMLTOOLING_CFG_FILE);
+}
 
-void SAML1POSTEncoder::encode(
-    map<string,string>& outputFields,
+long SAML1POSTEncoder::encode(
+    GenericResponse& genericResponse,
     XMLObject* xmlObject,
-    const char* recipientID,
+    const char* destination,
+    const EntityDescriptor* recipient,
     const char* relayState,
-    const CredentialResolver* credResolver,
-    const XMLCh* sigAlgorithm
+    const ArtifactGenerator* artifactGenerator,
+    const Credential* credential,
+    const XMLCh* signatureAlg,
+    const XMLCh* digestAlg
     ) const
 {
 #ifdef _DEBUG
     xmltooling::NDC ndc("encode");
 #endif
-    Category& log = Category::getInstance(SAML_LOGCAT".MessageEncoder.SAML1POST");
+    Category& log = Category::getInstance(SAML_LOGCAT ".MessageEncoder.SAML1POST");
     log.debug("validating input");
-    
-    outputFields.clear();
+
+    TemplateEngine* engine = XMLToolingConfig::getConfig().getTemplateEngine();
+    if (!engine || !destination)
+        throw BindingException("Encoding response using POST requires a TemplateEngine instance and a destination.");
+    HTTPResponse::sanitizeURL(destination);
     if (xmlObject->getParent())
         throw BindingException("Cannot encode XML content with parent.");
     Response* response = dynamic_cast<Response*>(xmlObject);
@@ -83,8 +126,8 @@ void SAML1POSTEncoder::encode(
     if (!relayState)
         throw BindingException("SAML 1.x POST Encoder requires relay state (TARGET) value.");
     
-    DOMElement* rootElement = NULL;
-    if (credResolver) {
+    DOMElement* rootElement = nullptr;
+    if (credential) {
         // Signature based on native XML signing.
         if (response->getSignature()) {
             log.debug("response already signed, skipping signature operation");
@@ -92,49 +135,68 @@ void SAML1POSTEncoder::encode(
         else {
             log.debug("signing and marshalling the response");
 
-            // Append a Signature.
-            response->setSignature(SignatureBuilder::buildSignature());
-            response->getSignature()->setSigningKey(credResolver->getKey());
-    
-            // Build KeyInfo.
-            const vector<XSECCryptoX509*>& certs = credResolver->getCertificates();
-            if (!certs.empty()) {
-                KeyInfo* keyInfo=KeyInfoBuilder::buildKeyInfo();
-                X509Data* x509Data=X509DataBuilder::buildX509Data();
-                keyInfo->getX509Datas().push_back(x509Data);
-                for_each(certs.begin(),certs.end(),bind1st(_addcert(),x509Data));
-                response->getSignature()->setKeyInfo(keyInfo);
+            // Build a Signature.
+            Signature* sig = SignatureBuilder::buildSignature();
+            response->setSignature(sig);
+            if (signatureAlg)
+                sig->setSignatureAlgorithm(signatureAlg);
+            if (digestAlg) {
+                opensaml::ContentReference* cr = dynamic_cast<opensaml::ContentReference*>(sig->getContentReference());
+                if (cr)
+                    cr->setDigestAlgorithm(digestAlg);
             }
     
             // Sign response while marshalling.
-            vector<Signature*> sigs(1,response->getSignature());
-            rootElement = response->marshall((DOMDocument*)NULL,&sigs);
+            vector<Signature*> sigs(1,sig);
+            rootElement = response->marshall((DOMDocument*)nullptr,&sigs,credential);
         }
     }
     else {
         log.debug("marshalling the response");
         rootElement = response->marshall();
     }
-    
-    string xmlbuf;
+
+    // Push message into template.
+    TemplateEngine::TemplateParameters pmap;
+    string& xmlbuf = pmap.m_map["SAMLResponse"];
     XMLHelper::serialize(rootElement, xmlbuf);
-    unsigned int len=0;
+    log.debug("marshalled response:\n%s", xmlbuf.c_str());
+    
+    // Replace with base-64 encoded version.
+    xsecsize_t len=0;
     XMLByte* out=Base64::encode(reinterpret_cast<const XMLByte*>(xmlbuf.data()),xmlbuf.size(),&len);
     if (out) {
         xmlbuf.erase();
         xmlbuf.append(reinterpret_cast<char*>(out),len);
+#ifdef OPENSAML_XERCESC_HAS_XMLBYTE_RELEASE
         XMLString::release(&out);
+#else
+        XMLString::release((char**)&out);
+#endif
     }
     else {
         throw BindingException("Base64 encoding of XML failed.");
     }
-    
-    // Pass back output fields.
-    outputFields["SAMLResponse"] = xmlbuf;
-    outputFields["TARGET"] = relayState;
+
+    // Fill in the rest of the data and send to the client.
+    log.debug("message encoded, sending HTML form template to client");
+    ifstream infile(m_template.c_str());
+    if (!infile)
+        throw BindingException("Failed to open HTML template for POST response ($1).", params(1,m_template.c_str()));
+    pmap.m_map["action"] = destination;
+    pmap.m_map["TARGET"] = relayState;
+    stringstream s;
+    engine->run(infile, s, pmap);
+    genericResponse.setContentType("text/html");
+    HTTPResponse* httpResponse = dynamic_cast<HTTPResponse*>(&genericResponse);
+    if (httpResponse) {
+        httpResponse->setResponseHeader("Expires", "01-Jan-1997 12:00:00 GMT");
+        httpResponse->setResponseHeader("Cache-Control", "no-cache, no-store, must-revalidate, private");
+        httpResponse->setResponseHeader("Pragma", "no-cache");
+    }
+    long ret = genericResponse.sendResponse(s);
 
     // Cleanup by destroying XML.
     delete xmlObject;
-
-    log.debug("message encoded");
+    return ret;
 }