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 * SAML1SOAPEncoder.cpp
20 * SAML 1.x SOAP binding message encoder
24 #include "exceptions.h"
25 #include "binding/MessageEncoder.h"
26 #include "signature/ContentReference.h"
27 #include "saml1/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::saml1p;
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 SAML1SOAPEncoder : public MessageEncoder
50 virtual ~SAML1SOAPEncoder() {}
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 SAML1SOAPEncoderFactory(const pair<const DOMElement*,const XMLCh*>& p)
71 return new SAML1SOAPEncoder();
76 long SAML1SOAPEncoder::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.SAML1SOAP");
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 Response.
108 Response* response = dynamic_cast<Response*>(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(response);
119 // Now check for a full Envelope (which might have just been created).
120 Envelope* env = dynamic_cast<Envelope*>(xmlObject);
123 response = (env->getBody() && env->getBody()->hasChildren()) ?
124 dynamic_cast<Response*>(env->getBody()->getUnknownXMLObjects().front()) : NULL;
127 // Now check for signing requirements.
128 if (response && credential) {
129 if (response->getSignature()) {
130 log.debug("response already signed, skipping signature operation");
131 rootElement = env->marshall();
134 log.debug("signing the response and marshalling the envelope");
136 // Build a Signature.
137 Signature* sig = SignatureBuilder::buildSignature();
138 response->setSignature(sig);
140 sig->setSignatureAlgorithm(signatureAlg);
142 opensaml::ContentReference* cr = dynamic_cast<opensaml::ContentReference*>(sig->getContentReference());
144 cr->setDigestAlgorithm(digestAlg);
147 // Sign message while marshalling.
148 vector<Signature*> sigs(1,sig);
149 rootElement = env->marshall((DOMDocument*)NULL,&sigs,credential);
153 log.debug("marshalling the envelope");
154 rootElement = env->marshall();
158 XMLHelper::serialize(rootElement, xmlbuf);
159 istringstream s(xmlbuf);
160 log.debug("sending serialized envelope");
161 bool error = (!response && env->getBody() && env->getBody()->hasChildren() &&
162 dynamic_cast<Fault*>(env->getBody()->getUnknownXMLObjects().front()));
163 long ret = error ? genericResponse.sendError(s) : genericResponse.sendResponse(s);
165 // Cleanup by destroying XML.
169 catch (XMLToolingException&) {
170 if (response && detachOnFailure) {
171 // A bit weird...we have to "revert" things so that the response is isolated
172 // so the caller can free it.
173 if (response->getParent()) {
174 response->getParent()->detach();
182 Fault* fault = dynamic_cast<Fault*>(xmlObject);
185 log.debug("building envelope and marshalling fault");
186 Envelope* env = EnvelopeBuilder::buildEnvelope();
187 Body* body = BodyBuilder::buildBody();
189 body->getUnknownXMLObjects().push_back(fault);
190 rootElement = env->marshall();
193 XMLHelper::serialize(rootElement, xmlbuf);
194 istringstream s(xmlbuf);
195 log.debug("sending serialized fault");
196 long ret = genericResponse.sendError(s);
198 // Cleanup by destroying XML.
202 catch (XMLToolingException&) {
203 // A bit weird...we have to "revert" things so that the fault is isolated
204 // so the caller can free it.
205 if (fault->getParent()) {
206 fault->getParent()->detach();
213 throw BindingException("XML content for SAML 1.x SOAP Encoder must be a SAML 1.x <Response> or SOAP Fault/Envelope.");