saml/saml2/binding/impl/SAML2ArtifactEncoder.cpp

   1 /*
   2  *  Copyright 2001-2007 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  * SAML2ArtifactEncoder.cpp
  19  *
  20  * SAML 2.0 HTTP-Artifact binding message encoder
  21  */
  22
  23 #include "internal.h"
  24 #include "exceptions.h"
  25 #include "binding/ArtifactMap.h"
  26 #include "binding/MessageEncoder.h"
  27 #include "saml2/binding/SAML2Artifact.h"
  28 #include "saml2/core/Protocols.h"
  29 #include "saml2/metadata/Metadata.h"
  30
  31 #include <fstream>
  32 #include <sstream>
  33 #include <log4cpp/Category.hh>
  34 #include <xmltooling/io/HTTPResponse.h>
  35 #include <xmltooling/util/NDC.h>
  36 #include <xmltooling/util/TemplateEngine.h>
  37 #include <xmltooling/util/URLEncoder.h>
  38
  39 using namespace opensaml::saml2p;
  40 using namespace opensaml::saml2md;
  41 using namespace opensaml;
  42 using namespace xmlsignature;
  43 using namespace xmltooling;
  44 using namespace log4cpp;
  45 using namespace std;
  46
  47 namespace opensaml {
  48     namespace saml2p {
  49         class SAML_DLLLOCAL SAML2ArtifactEncoder : public MessageEncoder
  50         {
  51         public:
  52             SAML2ArtifactEncoder(const DOMElement* e);
  53             virtual ~SAML2ArtifactEncoder() {}
  54
  55             long encode(
  56                 GenericResponse& genericResponse,
  57                 XMLObject* xmlObject,
  58                 const char* destination,
  59                 const EntityDescriptor* recipient=NULL,
  60                 const char* relayState=NULL,
  61                 const ArtifactGenerator* artifactGenerator=NULL,
  62                 const Credential* credential=NULL,
  63                 const XMLCh* signatureAlg=NULL,
  64                 const XMLCh* digestAlg=NULL
  65                 ) const;
  66
  67         private:
  68             bool m_post;
  69             string m_template;
  70         };
  71
  72         MessageEncoder* SAML_DLLLOCAL SAML2ArtifactEncoderFactory(const DOMElement* const & e)
  73         {
  74             return new SAML2ArtifactEncoder(e);
  75         }
  76     };
  77
  78     static const XMLCh _template[] =    UNICODE_LITERAL_8(t,e,m,p,l,a,t,e);
  79     static const XMLCh postArtifact[] = UNICODE_LITERAL_12(p,o,s,t,A,r,t,i,f,a,c,t);
  80 };
  81
  82 SAML2ArtifactEncoder::SAML2ArtifactEncoder(const DOMElement* e) : m_post(false)
  83 {
  84     if (e) {
  85         const XMLCh* flag = e->getAttributeNS(NULL, postArtifact);
  86         m_post = (flag && (*flag==chLatin_t || *flag==chDigit_1));
  87         if (m_post) {
  88             auto_ptr_char t(e->getAttributeNS(NULL, _template));
  89             if (t.get())
  90                 m_template = t.get();
  91         }
  92     }
  93 }
  94
  95 long SAML2ArtifactEncoder::encode(
  96     GenericResponse& genericResponse,
  97     XMLObject* xmlObject,
  98     const char* destination,
  99     const EntityDescriptor* recipient,
 100     const char* relayState,
 101     const ArtifactGenerator* artifactGenerator,
 102     const Credential* credential,
 103     const XMLCh* signatureAlg,
 104     const XMLCh* digestAlg
 105     ) const
 106 {
 107 #ifdef _DEBUG
 108     xmltooling::NDC ndc("encode");
 109 #endif
 110     Category& log = Category::getInstance(SAML_LOGCAT".MessageEncoder.SAML2Artifact");
 111
 112     log.debug("validating input");
 113     HTTPResponse* httpResponse=dynamic_cast<HTTPResponse*>(&genericResponse);
 114     if (!httpResponse)
 115         throw BindingException("Unable to cast response interface to HTTPResponse type.");
 116     if (relayState && strlen(relayState)>80)
 117         throw BindingException("RelayState cannot exceed 80 bytes in length.");
 118
 119     if (xmlObject->getParent())
 120         throw BindingException("Cannot encode XML content with parent.");
 121
 122     StatusResponseType* response = NULL;
 123     RequestAbstractType* request = dynamic_cast<RequestAbstractType*>(xmlObject);
 124     if (!request)
 125         response = dynamic_cast<StatusResponseType*>(xmlObject);
 126     if (!response)
 127         throw BindingException("XML content for SAML 2.0 HTTP-Artifact Encoder must be a SAML 2.0 protocol message.");
 128
 129     ArtifactMap* mapper = SAMLConfig::getConfig().getArtifactMap();
 130     if (!mapper)
 131         throw BindingException("SAML 2.0 HTTP-Artifact Encoder requires ArtifactMap be set in configuration.");
 132
 133     // Obtain a fresh artifact.
 134     if (!artifactGenerator)
 135         throw BindingException("SAML 2.0 HTTP-Artifact Encoder requires an ArtifactGenerator instance.");
 136     auto_ptr_char recipientID(recipient ? recipient->getEntityID() : NULL);
 137     log.debug("obtaining new artifact for relying party (%s)", recipientID.get() ? recipientID.get() : "unknown");
 138     auto_ptr<SAMLArtifact> artifact(artifactGenerator->generateSAML2Artifact(recipient));
 139
 140     if (credential) {
 141         // Signature based on native XML signing.
 142         if (request ? request->getSignature() : response->getSignature()) {
 143             log.debug("message already signed, skipping signature operation");
 144         }
 145         else {
 146             log.debug("signing the message");
 147
 148             // Build a Signature.
 149             Signature* sig = SignatureBuilder::buildSignature();
 150             request ? request->setSignature(sig) : response->setSignature(sig);
 151             if (signatureAlg)
 152                 sig->setSignatureAlgorithm(signatureAlg);
 153             if (digestAlg) {
 154                 opensaml::ContentReference* cr = dynamic_cast<opensaml::ContentReference*>(sig->getContentReference());
 155                 if (cr)
 156                     cr->setDigestAlgorithm(digestAlg);
 157             }
 158
 159             // Sign response while marshalling.
 160             vector<Signature*> sigs(1,sig);
 161             xmlObject->marshall((DOMDocument*)NULL,&sigs,credential);
 162         }
 163     }
 164
 165     // Store the message. Last step in storage will be to delete the XML.
 166     log.debug("storing artifact and content in map");
 167     mapper->storeContent(xmlObject, artifact.get(), recipientID.get());
 168
 169     if (m_template.empty()) {
 170         // Generate redirect.
 171         string loc = destination;
 172         loc += (strchr(destination,'?') ? '&' : '?');
 173         const URLEncoder* escaper = XMLToolingConfig::getConfig().getURLEncoder();
 174         loc = loc + "SAMLart=" + escaper->encode(artifact->encode().c_str());
 175         if (relayState && *relayState)
 176             loc = loc + "&RelayState=" + escaper->encode(relayState);
 177         log.debug("message encoded, sending redirect to client");
 178         return httpResponse->sendRedirect(loc.c_str());
 179     }
 180     else {
 181         // Push message into template and send result to client.
 182         log.debug("message encoded, sending HTML form template to client");
 183         TemplateEngine* engine = XMLToolingConfig::getConfig().getTemplateEngine();
 184         if (!engine)
 185             throw BindingException("Encoding artifact using POST requires a TemplateEngine instance.");
 186         ifstream infile(m_template.c_str());
 187         if (!infile)
 188             throw BindingException("Failed to open HTML template for POST response ($1).", params(1,m_template.c_str()));
 189         TemplateEngine::TemplateParameters params;
 190         params.m_map["action"] = destination;
 191         params.m_map["SAMLart"] = artifact->encode();
 192         if (relayState && *relayState)
 193             params.m_map["RelayState"] = relayState;
 194         stringstream s;
 195         engine->run(infile, s, params);
 196         httpResponse->setContentType("text/html");
 197         return httpResponse->sendResponse(s);
 198     }
 199 }