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 * SAML2RedirectEncoder.cpp
20 * SAML 2.0 HTTP-POST binding message encoder
24 #include "exceptions.h"
25 #include "binding/HTTPResponse.h"
26 #include "binding/MessageEncoder.h"
27 #include "saml2/binding/SAML2Redirect.h"
28 #include "saml2/core/Protocols.h"
32 #include <log4cpp/Category.hh>
33 #include <xercesc/util/Base64.hpp>
34 #include <xmltooling/util/NDC.h>
35 #include <xmltooling/util/URLEncoder.h>
37 using namespace opensaml::saml2p;
38 using namespace opensaml;
39 using namespace xmlsignature;
40 using namespace xmltooling;
41 using namespace log4cpp;
46 class SAML_DLLLOCAL SAML2RedirectEncoder : public MessageEncoder
49 SAML2RedirectEncoder(const DOMElement* e) {}
50 virtual ~SAML2RedirectEncoder() {}
52 bool isCompact() const {
57 GenericResponse& genericResponse,
59 const char* destination,
60 const char* recipientID=NULL,
61 const char* relayState=NULL,
62 const Credential* credential=NULL,
63 const XMLCh* signatureAlg=NULL,
64 const XMLCh* digestAlg=NULL
68 MessageEncoder* SAML_DLLLOCAL SAML2RedirectEncoderFactory(const DOMElement* const & e)
70 return new SAML2RedirectEncoder(e);
75 long SAML2RedirectEncoder::encode(
76 GenericResponse& genericResponse,
78 const char* destination,
79 const char* recipientID,
80 const char* relayState,
81 const Credential* credential,
82 const XMLCh* signatureAlg,
83 const XMLCh* digestAlg
87 xmltooling::NDC ndc("encode");
89 Category& log = Category::getInstance(SAML_LOGCAT".MessageEncoder.SAML2Redirect");
91 log.debug("validating input");
92 HTTPResponse* httpResponse=dynamic_cast<HTTPResponse*>(&genericResponse);
94 throw BindingException("Unable to cast response interface to HTTPResponse type.");
95 if (xmlObject->getParent())
96 throw BindingException("Cannot encode XML content with parent.");
98 StatusResponseType* response = NULL;
99 RequestAbstractType* request = dynamic_cast<RequestAbstractType*>(xmlObject);
101 response = dynamic_cast<StatusResponseType*>(xmlObject);
103 throw BindingException("XML content for SAML 2.0 HTTP-Redirect Encoder must be a SAML 2.0 protocol message.");
106 // Check for XML signature.
107 if (request ? request->getSignature() : response->getSignature()) {
108 log.debug("message already signed, removing native signature due to size considerations");
109 request ? request->setSignature(NULL) : response->setSignature(NULL);
112 log.debug("marshalling, deflating, base64-encoding the message");
113 DOMElement* rootElement = xmlObject->marshall();
115 XMLHelper::serialize(rootElement, xmlbuf);
118 char* deflated = deflate(const_cast<char*>(xmlbuf.c_str()), xmlbuf.length(), &len);
120 throw BindingException("Failed to deflate message.");
122 XMLByte* encoded=Base64::encode(reinterpret_cast<XMLByte*>(deflated),len,&len);
125 throw BindingException("Base64 encoding of XML failed.");
127 // Create beginnings of redirect query string.
128 const URLEncoder* escaper = XMLToolingConfig::getConfig().getURLEncoder();
130 xmlbuf.append(reinterpret_cast<char*>(encoded),len);
131 xmlbuf = (request ? "SAMLRequest=" : "SAMLResponse=") + escaper->encode(xmlbuf.c_str());
132 if (relayState && *relayState)
133 xmlbuf = xmlbuf + "&RelayState=" + escaper->encode(relayState);
136 log.debug("signing the message");
138 // Sign the query string after adding the algorithm.
140 signatureAlg = DSIGConstants::s_unicodeStrURIRSA_SHA1;
141 auto_ptr_char alg(signatureAlg);
142 xmlbuf = xmlbuf + "&SigAlg=" + escaper->encode(alg.get());
145 memset(sigbuf,0,sizeof(sigbuf));
146 Signature::createRawSignature(credential->getPrivateKey(), signatureAlg, xmlbuf.c_str(), xmlbuf.length(), sigbuf, sizeof(sigbuf)-1);
147 xmlbuf = xmlbuf + "&Signature=" + escaper->encode(sigbuf);
150 // Generate redirect.
151 log.debug("message encoded, sending redirect to client");
152 xmlbuf.insert((string::size_type)0,(string::size_type)1,(strchr(destination,'?') ? '&' : '?'));
153 xmlbuf.insert(0,destination);
154 long ret = httpResponse->sendRedirect(xmlbuf.c_str());
156 // Cleanup by destroying XML.