2 * Copyright 2001-2007 Internet2
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * SAML2SOAPEncoder.cpp
20 * SAML 2.0 SOAP binding message encoder
24 #include "exceptions.h"
25 #include "binding/MessageEncoder.h"
26 #include "signature/ContentReference.h"
27 #include "saml2/core/Protocols.h"
30 #include <xmltooling/logging.h>
31 #include <xmltooling/io/HTTPResponse.h>
32 #include <xmltooling/util/NDC.h>
33 #include <xmltooling/soap/SOAP.h>
35 using namespace opensaml::saml2p;
36 using namespace opensaml::saml2md;
37 using namespace opensaml;
38 using namespace xmlsignature;
39 using namespace soap11;
40 using namespace xmltooling::logging;
41 using namespace xmltooling;
46 class SAML_DLLLOCAL SAML2SOAPEncoder : public MessageEncoder
50 virtual ~SAML2SOAPEncoder() {}
52 bool isUserAgentPresent() const {
57 GenericResponse& genericResponse,
59 const char* destination,
60 const EntityDescriptor* recipient=NULL,
61 const char* relayState=NULL,
62 const ArtifactGenerator* artifactGenerator=NULL,
63 const Credential* credential=NULL,
64 const XMLCh* signatureAlg=NULL,
65 const XMLCh* digestAlg=NULL
69 MessageEncoder* SAML_DLLLOCAL SAML2SOAPEncoderFactory(const pair<const DOMElement*,const XMLCh*>& p)
71 return new SAML2SOAPEncoder();
76 long SAML2SOAPEncoder::encode(
77 GenericResponse& genericResponse,
79 const char* destination,
80 const EntityDescriptor* recipient,
81 const char* relayState,
82 const ArtifactGenerator* artifactGenerator,
83 const Credential* credential,
84 const XMLCh* signatureAlg,
85 const XMLCh* digestAlg
89 xmltooling::NDC ndc("encode");
91 Category& log = Category::getInstance(SAML_LOGCAT".MessageEncoder.SAML2SOAP");
93 log.debug("validating input");
94 if (xmlObject->getParent())
95 throw BindingException("Cannot encode XML content with parent.");
97 genericResponse.setContentType("text/xml");
98 HTTPResponse* httpResponse = dynamic_cast<HTTPResponse*>(&genericResponse);
100 httpResponse->setResponseHeader("Cache-Control", "no-cache, no-store, must-revalidate, private");
101 httpResponse->setResponseHeader("Pragma", "no-cache");
104 bool detachOnFailure = false;
105 DOMElement* rootElement = NULL;
107 // Check for a naked message.
108 SignableObject* msg = dynamic_cast<SignableObject*>(xmlObject);
110 // Wrap it in a SOAP envelope and point xmlObject at that.
111 detachOnFailure = true;
112 Envelope* env = EnvelopeBuilder::buildEnvelope();
113 Body* body = BodyBuilder::buildBody();
115 body->getUnknownXMLObjects().push_back(msg);
119 Envelope* env = dynamic_cast<Envelope*>(xmlObject);
122 msg = (env->getBody() && env->getBody()->hasChildren()) ?
123 dynamic_cast<SignableObject*>(env->getBody()->getUnknownXMLObjects().front()) : NULL;
126 if (msg && credential) {
127 if (msg->getSignature()) {
128 log.debug("message already signed, skipping signature operation");
129 rootElement = env->marshall();
132 log.debug("signing the message and marshalling the envelope");
134 // Build a Signature.
135 Signature* sig = SignatureBuilder::buildSignature();
136 msg->setSignature(sig);
138 sig->setSignatureAlgorithm(signatureAlg);
140 opensaml::ContentReference* cr = dynamic_cast<opensaml::ContentReference*>(sig->getContentReference());
142 cr->setDigestAlgorithm(digestAlg);
145 // Sign message while marshalling.
146 vector<Signature*> sigs(1,sig);
147 rootElement = env->marshall((DOMDocument*)NULL,&sigs,credential);
151 log.debug("marshalling the envelope");
152 rootElement = env->marshall();
158 if (log.isDebugEnabled())
159 log.debug("marshalled envelope: %s", s.str().c_str());
161 log.debug("sending serialized envelope");
162 bool error = (!msg && env->getBody() && env->getBody()->hasChildren() &&
163 dynamic_cast<Fault*>(env->getBody()->getUnknownXMLObjects().front()));
164 long ret = error ? genericResponse.sendError(s) : genericResponse.sendResponse(s);
166 // Cleanup by destroying XML.
170 catch (XMLToolingException&) {
171 if (msg && detachOnFailure) {
172 // A bit weird...we have to "revert" things so that the message is isolated
173 // so the caller can free it.
174 if (msg->getParent()) {
175 msg->getParent()->detach();
183 Fault* fault = dynamic_cast<Fault*>(xmlObject);
186 log.debug("building envelope and marshalling fault");
187 Envelope* env = EnvelopeBuilder::buildEnvelope();
188 Body* body = BodyBuilder::buildBody();
190 body->getUnknownXMLObjects().push_back(fault);
191 rootElement = env->marshall();
196 if (log.isDebugEnabled())
197 log.debug("marshalled envelope: %s", s.str().c_str());
199 log.debug("sending serialized envelope");
200 long ret = genericResponse.sendError(s);
202 // Cleanup by destroying XML.
206 catch (XMLToolingException&) {
207 // A bit weird...we have to "revert" things so that the fault is isolated
208 // so the caller can free it.
209 if (fault->getParent()) {
210 fault->getParent()->detach();
217 throw BindingException("XML content for SAML 2.0 SOAP Encoder must be a SAML 2.0 message or SOAP Fault/Envelope.");