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/HTTPResponse.h"
26 #include "binding/MessageEncoder.h"
27 #include "saml1/core/Protocols.h"
30 #include <log4cpp/Category.hh>
31 #include <xmltooling/util/NDC.h>
32 #include <xmltooling/soap/SOAP.h>
34 using namespace opensaml::saml1p;
35 using namespace opensaml;
36 using namespace xmlsignature;
37 using namespace soap11;
38 using namespace xmltooling;
39 using namespace log4cpp;
44 class SAML_DLLLOCAL SAML1SOAPEncoder : public MessageEncoder
47 SAML1SOAPEncoder(const DOMElement* e) {}
48 virtual ~SAML1SOAPEncoder() {}
51 GenericResponse& genericResponse,
52 xmltooling::XMLObject* xmlObject,
53 const char* destination,
54 const char* recipientID=NULL,
55 const char* relayState=NULL,
56 const xmltooling::CredentialResolver* credResolver=NULL,
57 const XMLCh* sigAlgorithm=NULL
61 MessageEncoder* SAML_DLLLOCAL SAML1SOAPEncoderFactory(const DOMElement* const & e)
63 return new SAML1SOAPEncoder(e);
68 long SAML1SOAPEncoder::encode(
69 GenericResponse& genericResponse,
71 const char* destination,
72 const char* recipientID,
73 const char* relayState,
74 const CredentialResolver* credResolver,
75 const XMLCh* sigAlgorithm
79 xmltooling::NDC ndc("encode");
81 Category& log = Category::getInstance(SAML_LOGCAT".MessageEncoder.SAML1SOAP");
83 log.debug("validating input");
84 if (xmlObject->getParent())
85 throw BindingException("Cannot encode XML content with parent.");
87 genericResponse.setContentType("text/xml");
88 HTTPResponse* httpResponse = dynamic_cast<HTTPResponse*>(&genericResponse);
90 httpResponse->setResponseHeader("Cache-Control", "no-cache, no-store, must-revalidate, private");
91 httpResponse->setResponseHeader("Pragma", "no-cache");
94 DOMElement* rootElement = NULL;
95 Response* response = dynamic_cast<Response*>(xmlObject);
98 Envelope* env = EnvelopeBuilder::buildEnvelope();
99 Body* body = BodyBuilder::buildBody();
101 body->getUnknownXMLObjects().push_back(response);
103 if (response->getSignature()) {
104 log.debug("response already signed, skipping signature operation");
105 rootElement = env->marshall();
108 log.debug("signing and marshalling the response");
110 // Build a Signature.
111 Signature* sig = buildSignature(credResolver, sigAlgorithm);
112 response->setSignature(sig);
114 // Sign response while marshalling.
115 vector<Signature*> sigs(1,sig);
116 rootElement = env->marshall((DOMDocument*)NULL,&sigs);
120 log.debug("marshalling the response");
121 rootElement = env->marshall();
126 log.debug("sending serialized response");
127 long ret = genericResponse.sendResponse(s);
129 // Cleanup by destroying XML.
133 catch (XMLToolingException&) {
134 // A bit weird...we have to "revert" things so that the response is isolated
135 // so the caller can free it.
136 if (response->getParent()) {
137 response->getParent()->detach();
144 Fault* fault = dynamic_cast<Fault*>(xmlObject);
147 log.debug("building Envelope and marshalling Fault");
148 Envelope* env = EnvelopeBuilder::buildEnvelope();
149 Body* body = BodyBuilder::buildBody();
151 body->getUnknownXMLObjects().push_back(fault);
152 rootElement = env->marshall();
155 XMLHelper::serialize(rootElement, xmlbuf);
156 istringstream s(xmlbuf);
157 log.debug("sending serialized fault");
158 long ret = genericResponse.sendError(s);
160 // Cleanup by destroying XML.
164 catch (XMLToolingException&) {
165 // A bit weird...we have to "revert" things so that the fault is isolated
166 // so the caller can free it.
167 if (fault->getParent()) {
168 fault->getParent()->detach();
175 Envelope* env = dynamic_cast<Envelope*>(xmlObject);
177 log.debug("marshalling envelope");
178 rootElement = env->marshall();
182 env->getBody()->hasChildren() &&
183 dynamic_cast<Fault*>(env->getBody()->getUnknownXMLObjects().front()));
186 XMLHelper::serialize(rootElement, xmlbuf);
187 istringstream s(xmlbuf);
188 log.debug("sending serialized envelope");
189 long ret = error ? genericResponse.sendError(s) : genericResponse.sendResponse(s);
191 // Cleanup by destroying XML.
196 throw BindingException("XML content for SAML 1.x SOAP Encoder must be a SAML 1.x <Response> or SOAP Fault/Envelope.");