2 * Licensed to the University Corporation for Advanced Internet
3 * Development, Inc. (UCAID) under one or more contributor license
4 * agreements. See the NOTICE file distributed with this work for
5 * additional information regarding copyright ownership.
7 * UCAID licenses this file to you under the Apache License,
8 * Version 2.0 (the "License"); you may not use this file except
9 * in compliance with the License. You may obtain a copy of the
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
17 * either express or implied. See the License for the specific
18 * language governing permissions and limitations under the License.
22 * SAML1ArtifactEncoder.cpp
24 * SAML 1.x Artifact binding/profile message encoder
28 #include "exceptions.h"
29 #include "binding/ArtifactMap.h"
30 #include "binding/MessageEncoder.h"
31 #include "binding/SAMLArtifact.h"
32 #include "saml1/core/Assertions.h"
33 #include "saml1/core/Protocols.h"
34 #include "saml2/metadata/Metadata.h"
36 #include <xmltooling/logging.h>
37 #include <xmltooling/XMLToolingConfig.h>
38 #include <xmltooling/io/HTTPResponse.h>
39 #include <xmltooling/util/NDC.h>
40 #include <xmltooling/util/URLEncoder.h>
42 using namespace opensaml::saml1;
43 using namespace opensaml::saml1p;
44 using namespace opensaml::saml2md;
45 using namespace opensaml;
46 using namespace xmlsignature;
47 using namespace xmltooling::logging;
48 using namespace xmltooling;
53 class SAML_DLLLOCAL SAML1ArtifactEncoder : public MessageEncoder
56 SAML1ArtifactEncoder() {}
57 virtual ~SAML1ArtifactEncoder() {}
59 const XMLCh* getProtocolFamily() const {
60 return samlconstants::SAML11_PROTOCOL_ENUM;
64 GenericResponse& genericResponse,
66 const char* destination,
67 const EntityDescriptor* recipient=nullptr,
68 const char* relayState=nullptr,
69 const ArtifactGenerator* artifactGenerator=nullptr,
70 const Credential* credential=nullptr,
71 const XMLCh* signatureAlg=nullptr,
72 const XMLCh* digestAlg=nullptr
76 MessageEncoder* SAML_DLLLOCAL SAML1ArtifactEncoderFactory(const pair<const DOMElement*,const XMLCh*>& p)
78 return new SAML1ArtifactEncoder();
83 long SAML1ArtifactEncoder::encode(
84 GenericResponse& genericResponse,
86 const char* destination,
87 const EntityDescriptor* recipient,
88 const char* relayState,
89 const ArtifactGenerator* artifactGenerator,
90 const Credential* credential,
91 const XMLCh* signatureAlg,
92 const XMLCh* digestAlg
96 xmltooling::NDC ndc("encode");
98 Category& log = Category::getInstance(SAML_LOGCAT".MessageEncoder.SAML1Artifact");
100 log.debug("validating input");
101 HTTPResponse* httpResponse=dynamic_cast<HTTPResponse*>(&genericResponse);
103 throw BindingException("Unable to cast response interface to HTTPResponse type.");
104 if (xmlObject->getParent())
105 throw BindingException("Cannot encode XML content with parent.");
106 Assertion* assertion = dynamic_cast<Assertion*>(xmlObject);
108 throw BindingException("XML content for SAML 1.x Artifact Encoder must be a SAML 1.x <Assertion>.");
110 throw BindingException("SAML 1.x Artifact Encoder requires relay state (TARGET) value.");
112 // Signing is a protocol level issue, so no signing here...
114 ArtifactMap* mapper = SAMLConfig::getConfig().getArtifactMap();
116 throw BindingException("SAML 1.x Artifact Encoder requires ArtifactMap be set in configuration.");
118 // Obtain a fresh artifact.
119 if (!artifactGenerator)
120 throw BindingException("SAML 1.x Artifact Encoder requires an ArtifactGenerator instance.");
122 if (log.isDebugEnabled())
123 log.debugStream() << "marshalled assertion:" << logging::eol << *xmlObject << logging::eol;
125 auto_ptr_char recipientID(recipient ? recipient->getEntityID() : nullptr);
126 log.debug("obtaining new artifact for relying party (%s)", recipientID.get() ? recipientID.get() : "unknown");
127 auto_ptr<SAMLArtifact> artifact(artifactGenerator->generateSAML1Artifact(recipient));
129 // Store the assertion. Last step in storage will be to delete the XML.
130 log.debug("storing artifact and content in map");
131 mapper->storeContent(xmlObject, artifact.get(), recipientID.get());
133 // Generate redirect.
134 string loc = destination;
135 loc += (strchr(destination,'?') ? '&' : '?');
136 const URLEncoder* escaper = XMLToolingConfig::getConfig().getURLEncoder();
137 loc = loc + "SAMLart=" + escaper->encode(artifact->encode().c_str()) + "&TARGET=" + escaper->encode(relayState);
138 log.debug("message encoded, sending redirect to client");
139 return httpResponse->sendRedirect(loc.c_str());