https://issues.shibboleth.net/jira/browse/SSPCPP-187
[shibboleth/cpp-opensaml.git] / saml / saml2 / binding / impl / SAML2SOAPEncoder.cpp
index 43ec706..a4aa894 100644 (file)
 
 #include "internal.h"
 #include "exceptions.h"
-#include "binding/HTTPResponse.h"
 #include "binding/MessageEncoder.h"
+#include "signature/ContentReference.h"
 #include "saml2/core/Protocols.h"
 
 #include <sstream>
-#include <log4cpp/Category.hh>
+#include <xmltooling/logging.h>
+#include <xmltooling/io/HTTPResponse.h>
 #include <xmltooling/util/NDC.h>
 #include <xmltooling/soap/SOAP.h>
 
 using namespace opensaml::saml2p;
+using namespace opensaml::saml2md;
 using namespace opensaml;
 using namespace xmlsignature;
 using namespace soap11;
+using namespace xmltooling::logging;
 using namespace xmltooling;
-using namespace log4cpp;
 using namespace std;
 
 namespace opensaml {
@@ -44,37 +46,43 @@ namespace opensaml {
         class SAML_DLLLOCAL SAML2SOAPEncoder : public MessageEncoder
         {
         public:
-            SAML2SOAPEncoder(const DOMElement* e);
+            SAML2SOAPEncoder() {}
             virtual ~SAML2SOAPEncoder() {}
-            
+
+            bool isUserAgentPresent() const {
+                return false;
+            }
+
             long encode(
                 GenericResponse& genericResponse,
                 XMLObject* xmlObject,
                 const char* destination,
-                const char* recipientID=NULL,
+                const EntityDescriptor* recipient=NULL,
                 const char* relayState=NULL,
+                const ArtifactGenerator* artifactGenerator=NULL,
                 const Credential* credential=NULL,
-                const XMLCh* sigAlgorithm=NULL
+                const XMLCh* signatureAlg=NULL,
+                const XMLCh* digestAlg=NULL
                 ) const;
         };
 
-        MessageEncoder* SAML_DLLLOCAL SAML2SOAPEncoderFactory(const DOMElement* const & e)
+        MessageEncoder* SAML_DLLLOCAL SAML2SOAPEncoderFactory(const pair<const DOMElement*,const XMLCh*>& p)
         {
-            return new SAML2SOAPEncoder(e);
+            return new SAML2SOAPEncoder();
         }
     };
 };
 
-SAML2SOAPEncoder::SAML2SOAPEncoder(const DOMElement* e) {}
-
 long SAML2SOAPEncoder::encode(
     GenericResponse& genericResponse,
     XMLObject* xmlObject,
     const char* destination,
-    const char* recipientID,
+    const EntityDescriptor* recipient,
     const char* relayState,
+    const ArtifactGenerator* artifactGenerator,
     const Credential* credential,
-    const XMLCh* sigAlgorithm
+    const XMLCh* signatureAlg,
+    const XMLCh* digestAlg
     ) const
 {
 #ifdef _DEBUG
@@ -89,57 +97,85 @@ long SAML2SOAPEncoder::encode(
     genericResponse.setContentType("text/xml");
     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");
     }
 
+    bool detachOnFailure = false;
     DOMElement* rootElement = NULL;
-    StatusResponseType* response = dynamic_cast<StatusResponseType*>(xmlObject);
-    if (response) {
+
+    // Check for a naked message.
+    SignableObject* msg = dynamic_cast<SignableObject*>(xmlObject);
+    if (msg) {
+        // Wrap it in a SOAP envelope and point xmlObject at that.
+        detachOnFailure = true;
+        Envelope* env = EnvelopeBuilder::buildEnvelope();
+        Body* body = BodyBuilder::buildBody();
+        env->setBody(body);
+        body->getUnknownXMLObjects().push_back(msg);
+        xmlObject = env;
+    }
+
+    Envelope* env = dynamic_cast<Envelope*>(xmlObject);
+    if (env) {
+        if (!msg) {
+            msg = (env->getBody() && env->getBody()->hasChildren()) ?
+                dynamic_cast<SignableObject*>(env->getBody()->getUnknownXMLObjects().front()) : NULL;
+        }
         try {
-            Envelope* env = EnvelopeBuilder::buildEnvelope();
-            Body* body = BodyBuilder::buildBody();
-            env->setBody(body);
-            body->getUnknownXMLObjects().push_back(response);
-            if (credential) {
-                if (response->getSignature()) {
-                    log.debug("response already signed, skipping signature operation");
+            if (msg && credential) {
+                if (msg->getSignature()) {
+                    log.debug("message already signed, skipping signature operation");
                     rootElement = env->marshall();
                 }
                 else {
-                    log.debug("signing and marshalling the response");
+                    log.debug("signing the message and marshalling the envelope");
         
                     // Build a Signature.
                     Signature* sig = SignatureBuilder::buildSignature();
-                    response->setSignature(sig);    
-                    if (sigAlgorithm)
-                        sig->setSignatureAlgorithm(sigAlgorithm);
+                    msg->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.
+                    // Sign message while marshalling.
                     vector<Signature*> sigs(1,sig);
                     rootElement = env->marshall((DOMDocument*)NULL,&sigs,credential);
                 }
             }
             else {
-                log.debug("marshalling the response");
+                log.debug("marshalling the envelope");
                 rootElement = env->marshall();
             }
-            
+
             stringstream s;
             s << *rootElement;
-            log.debug("sending serialized response");
-            long ret = genericResponse.sendResponse(s);
+            
+            if (log.isDebugEnabled())
+                log.debug("marshalled envelope:\n%s", s.str().c_str());
+
+            log.debug("sending serialized envelope");
+            bool error = (!msg && env->getBody() && env->getBody()->hasChildren() &&
+                dynamic_cast<Fault*>(env->getBody()->getUnknownXMLObjects().front()));
+            long ret = error ? genericResponse.sendError(s) : genericResponse.sendResponse(s);
         
             // Cleanup by destroying XML.
             delete env;
             return ret;
         }
         catch (XMLToolingException&) {
-            // A bit weird...we have to "revert" things so that the response is isolated
-            // so the caller can free it.
-            if (response->getParent()) {
-                response->getParent()->detach();
-                response->detach();
+            if (msg && detachOnFailure) {
+                // A bit weird...we have to "revert" things so that the message is isolated
+                // so the caller can free it.
+                if (msg->getParent()) {
+                    msg->getParent()->detach();
+                    msg->detach();
+                }
             }
             throw;
         }
@@ -148,17 +184,20 @@ long SAML2SOAPEncoder::encode(
     Fault* fault = dynamic_cast<Fault*>(xmlObject);
     if (fault) {
         try {
-            log.debug("building Envelope and marshalling Fault");
+            log.debug("building envelope and marshalling fault");
             Envelope* env = EnvelopeBuilder::buildEnvelope();
             Body* body = BodyBuilder::buildBody();
             env->setBody(body);
             body->getUnknownXMLObjects().push_back(fault);
             rootElement = env->marshall();
     
-            string xmlbuf;
-            XMLHelper::serialize(rootElement, xmlbuf);
-            istringstream s(xmlbuf);
-            log.debug("sending serialized fault");
+            stringstream s;
+            s << *rootElement;
+            
+            if (log.isDebugEnabled())
+                log.debug("marshalled envelope:\n%s", s.str().c_str());
+
+            log.debug("sending serialized envelope");
             long ret = genericResponse.sendError(s);
         
             // Cleanup by destroying XML.
@@ -176,26 +215,5 @@ long SAML2SOAPEncoder::encode(
         }
     }
 
-    Envelope* env = dynamic_cast<Envelope*>(xmlObject);
-    if (env) {
-        log.debug("marshalling envelope");
-        rootElement = env->marshall();
-
-        bool error =
-            (env->getBody() &&
-                env->getBody()->hasChildren() &&
-                    dynamic_cast<Fault*>(env->getBody()->getUnknownXMLObjects().front()));
-
-        string xmlbuf;
-        XMLHelper::serialize(rootElement, xmlbuf);
-        istringstream s(xmlbuf);
-        log.debug("sending serialized envelope");
-        long ret = error ? genericResponse.sendError(s) : genericResponse.sendResponse(s);
-    
-        // Cleanup by destroying XML.
-        delete env;
-        return ret;
-    }
-
-    throw BindingException("XML content for SAML 2.0 SOAP Encoder must be a SAML 2.0 response or SOAP Fault/Envelope.");
+    throw BindingException("XML content for SAML 2.0 SOAP Encoder must be a SAML 2.0 message or SOAP Fault/Envelope.");
 }