saml/saml2/binding/impl/SAML2ArtifactEncoder.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  * SAML2ArtifactEncoder.cpp
  19  *
  20  * SAML 2.0 HTTP-Artifact binding message encoder
  21  */
  22
  23 #include "internal.h"
  24 #include "exceptions.h"
  25 #include "saml2/binding/SAML2Artifact.h"
  26 #include "saml2/binding/SAML2ArtifactEncoder.h"
  27 #include "saml2/core/Protocols.h"
  28
  29 #include <log4cpp/Category.hh>
  30 #include <xmltooling/util/NDC.h>
  31
  32 using namespace opensaml::saml2p;
  33 using namespace opensaml;
  34 using namespace xmlsignature;
  35 using namespace xmltooling;
  36 using namespace log4cpp;
  37 using namespace std;
  38
  39 namespace opensaml {
  40     namespace saml2p {
  41         MessageEncoder* SAML_DLLLOCAL SAML2ArtifactEncoderFactory(const DOMElement* const & e)
  42         {
  43             return new SAML2ArtifactEncoder(e);
  44         }
  45     };
  46 };
  47
  48 SAML2ArtifactEncoder::SAML2ArtifactEncoder(const DOMElement* e) {}
  49
  50 SAML2ArtifactEncoder::~SAML2ArtifactEncoder() {}
  51
  52 void SAML2ArtifactEncoder::encode(
  53     map<string,string>& outputFields,
  54     XMLObject* xmlObject,
  55     const char* recipientID,
  56     const char* relayState,
  57     const CredentialResolver* credResolver,
  58     const XMLCh* sigAlgorithm
  59     ) const
  60 {
  61 #ifdef _DEBUG
  62     xmltooling::NDC ndc("encode");
  63 #endif
  64     Category& log = Category::getInstance(SAML_LOGCAT".MessageEncoder.SAML2Artifact");
  65     log.debug("validating input");
  66
  67     outputFields.clear();
  68     if (xmlObject->getParent())
  69         throw BindingException("Cannot encode XML content with parent.");
  70
  71     StatusResponseType* response = NULL;
  72     RequestAbstractType* request = dynamic_cast<RequestAbstractType*>(xmlObject);
  73     if (!request)
  74         response = dynamic_cast<StatusResponseType*>(xmlObject);
  75     if (!response)
  76         throw BindingException("XML content for SAML 2.0 HTTP-Artifact Encoder must be a SAML 2.0 protocol message.");
  77
  78     ArtifactMap* mapper = SAMLConfig::getConfig().getArtifactMap();
  79     if (!mapper)
  80         throw BindingException("SAML 2.0 HTTP-Artifact Encoder requires ArtifactMap be set in configuration.");
  81
  82     // Obtain a fresh artifact.
  83     if (!m_artifactGenerator)
  84         throw BindingException("SAML 2.0 HTTP-Artifact Encoder requires an ArtifactGenerator instance.");
  85     log.debug("obtaining new artifact for relying party (%s)", recipientID ? recipientID : "unknown");
  86     auto_ptr<SAMLArtifact> artifact(m_artifactGenerator->generateSAML2Artifact(recipientID));
  87
  88     if (credResolver) {
  89         // Signature based on native XML signing.
  90         if (request ? request->getSignature() : response->getSignature()) {
  91             log.debug("message already signed, skipping signature operation");
  92         }
  93         else {
  94             log.debug("signing the message");
  95
  96             // Build a Signature.
  97             Signature* sig = buildSignature(credResolver, sigAlgorithm);
  98
  99             // Append Signature.
 100             request ? request->setSignature(sig) : response->setSignature(sig);
 101
 102             // Sign response while marshalling.
 103             vector<Signature*> sigs(1,sig);
 104             xmlObject->marshall((DOMDocument*)NULL,&sigs);
 105         }
 106     }
 107
 108     // Pass back output fields.
 109     outputFields["SAMLart"] = artifact->encode();
 110     if (relayState)
 111         outputFields["RelayState"] = relayState;
 112
 113     // Store the message. Last step in storage will be to delete the XML.
 114     log.debug("storing artifact and content in map");
 115     mapper->storeContent(xmlObject, artifact.get(), recipientID);
 116
 117     log.debug("message encoded");
 118 }