2 * Copyright 2001-2010 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 * SAML2RedirectEncoder.cpp
20 * SAML 2.0 HTTP-POST binding message encoder.
24 #include "exceptions.h"
25 #include "binding/MessageEncoder.h"
26 #include "saml2/binding/SAML2Redirect.h"
27 #include "saml2/core/Protocols.h"
31 #include <xercesc/util/Base64.hpp>
32 #include <xsec/dsig/DSIGConstants.hpp>
33 #include <xmltooling/logging.h>
34 #include <xmltooling/XMLToolingConfig.h>
35 #include <xmltooling/io/HTTPResponse.h>
36 #include <xmltooling/security/Credential.h>
37 #include <xmltooling/signature/Signature.h>
38 #include <xmltooling/util/NDC.h>
39 #include <xmltooling/util/URLEncoder.h>
41 using namespace opensaml::saml2p;
42 using namespace opensaml::saml2md;
43 using namespace opensaml;
44 using namespace xmlsignature;
45 using namespace xmltooling::logging;
46 using namespace xmltooling;
51 class SAML_DLLLOCAL SAML2RedirectEncoder : public MessageEncoder
54 SAML2RedirectEncoder() {}
55 virtual ~SAML2RedirectEncoder() {}
57 bool isCompact() const {
61 const XMLCh* getProtocolFamily() const {
62 return samlconstants::SAML20P_NS;
66 GenericResponse& genericResponse,
68 const char* destination,
69 const EntityDescriptor* recipient=nullptr,
70 const char* relayState=nullptr,
71 const ArtifactGenerator* artifactGenerator=nullptr,
72 const Credential* credential=nullptr,
73 const XMLCh* signatureAlg=nullptr,
74 const XMLCh* digestAlg=nullptr
78 MessageEncoder* SAML_DLLLOCAL SAML2RedirectEncoderFactory(const pair<const DOMElement*,const XMLCh*>& p)
80 return new SAML2RedirectEncoder();
85 long SAML2RedirectEncoder::encode(
86 GenericResponse& genericResponse,
88 const char* destination,
89 const EntityDescriptor* recipient,
90 const char* relayState,
91 const ArtifactGenerator* artifactGenerator,
92 const Credential* credential,
93 const XMLCh* signatureAlg,
94 const XMLCh* digestAlg
98 xmltooling::NDC ndc("encode");
100 Category& log = Category::getInstance(SAML_LOGCAT".MessageEncoder.SAML2Redirect");
102 log.debug("validating input");
103 HTTPResponse* httpResponse=dynamic_cast<HTTPResponse*>(&genericResponse);
105 throw BindingException("Unable to cast response interface to HTTPResponse type.");
106 if (xmlObject->getParent())
107 throw BindingException("Cannot encode XML content with parent.");
109 StatusResponseType* response = nullptr;
110 RequestAbstractType* request = dynamic_cast<RequestAbstractType*>(xmlObject);
112 response = dynamic_cast<StatusResponseType*>(xmlObject);
114 throw BindingException("XML content for SAML 2.0 HTTP-Redirect Encoder must be a SAML 2.0 protocol message.");
117 // Check for XML signature.
118 if (request ? request->getSignature() : response->getSignature()) {
119 log.debug("message already signed, removing native signature due to size considerations");
120 request ? request->setSignature(nullptr) : response->setSignature(nullptr);
123 log.debug("marshalling, deflating, base64-encoding the message");
124 DOMElement* rootElement = xmlObject->marshall();
126 XMLHelper::serialize(rootElement, xmlbuf);
127 log.debug("marshalled message:\n%s", xmlbuf.c_str());
130 char* deflated = deflate(const_cast<char*>(xmlbuf.c_str()), xmlbuf.length(), &len);
132 throw BindingException("Failed to deflate message.");
135 XMLByte* encoded=Base64::encode(reinterpret_cast<XMLByte*>(deflated), len, &xlen);
138 throw BindingException("Base64 encoding of XML failed.");
140 // Create beginnings of redirect query string.
141 const URLEncoder* escaper = XMLToolingConfig::getConfig().getURLEncoder();
143 xmlbuf.append(reinterpret_cast<char*>(encoded), xlen);
144 #ifdef OPENSAML_XERCESC_HAS_XMLBYTE_RELEASE
145 XMLString::release(&encoded);
147 XMLString::release((char**)&encoded);
150 xmlbuf = (request ? "SAMLRequest=" : "SAMLResponse=") + escaper->encode(xmlbuf.c_str());
151 if (relayState && *relayState)
152 xmlbuf = xmlbuf + "&RelayState=" + escaper->encode(relayState);
155 log.debug("signing the message");
157 // Sign the query string after adding the algorithm.
159 signatureAlg = DSIGConstants::s_unicodeStrURIRSA_SHA1;
160 auto_ptr_char alg(signatureAlg);
161 xmlbuf = xmlbuf + "&SigAlg=" + escaper->encode(alg.get());
164 memset(sigbuf,0,sizeof(sigbuf));
165 Signature::createRawSignature(credential->getPrivateKey(), signatureAlg, xmlbuf.c_str(), xmlbuf.length(), sigbuf, sizeof(sigbuf)-1);
166 xmlbuf = xmlbuf + "&Signature=" + escaper->encode(sigbuf);
169 // Generate redirect.
170 log.debug("message encoded, sending redirect to client");
171 xmlbuf.insert((string::size_type)0,(string::size_type)1,(strchr(destination,'?') ? '&' : '?'));
172 xmlbuf.insert(0,destination);
173 long ret = httpResponse->sendRedirect(xmlbuf.c_str());
175 // Cleanup by destroying XML.