MessageEncoder, ArtifactMap, and SAML 1.x encoder classes.
[shibboleth/cpp-opensaml.git] / saml / saml1 / binding / impl / SAML1ArtifactEncoder.cpp
1 /*
2  *  Copyright 2001-2006 Internet2
3  * 
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
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 /**
18  * SAML1ArtifactEncoder.cpp
19  * 
20  * SAML 1.x Artifact binding/profile message encoder
21  */
22
23 #include "internal.h"
24 #include "exceptions.h"
25 #include "saml/binding/SAMLArtifact.h"
26 #include "saml1/binding/SAML1ArtifactEncoder.h"
27 #include "saml1/core/Assertions.h"
28
29 #include <log4cpp/Category.hh>
30 #include <xmltooling/util/NDC.h>
31
32 using namespace opensaml::saml1;
33 using namespace opensaml::saml1p;
34 using namespace opensaml;
35 using namespace xmlsignature;
36 using namespace xmltooling;
37 using namespace log4cpp;
38 using namespace std;
39
40 namespace opensaml {
41     namespace saml1p {              
42         MessageEncoder* SAML_DLLLOCAL SAML1ArtifactEncoderFactory(const DOMElement* const & e)
43         {
44             return new SAML1ArtifactEncoder(e);
45         }
46     };
47 };
48
49 SAML1ArtifactEncoder::SAML1ArtifactEncoder(const DOMElement* e) {}
50
51 SAML1ArtifactEncoder::~SAML1ArtifactEncoder() {}
52
53 void SAML1ArtifactEncoder::encode(
54     map<string,string>& outputFields,
55     XMLObject* xmlObject,
56     const char* recipientID,
57     const char* relayState,
58     const CredentialResolver* credResolver,
59     const XMLCh* sigAlgorithm
60     ) const
61 {
62 #ifdef _DEBUG
63     xmltooling::NDC ndc("encode");
64 #endif
65     Category& log = Category::getInstance(SAML_LOGCAT".MessageEncoder.SAML1Artifact");
66     log.debug("validating input");
67     
68     outputFields.clear();
69     if (xmlObject->getParent())
70         throw BindingException("Cannot encode XML content with parent.");
71     Assertion* assertion = dynamic_cast<Assertion*>(xmlObject);
72     if (!assertion)
73         throw BindingException("XML content for SAML 1.x Artifact Encoder must be a SAML 1.x <Assertion>.");
74     if (!relayState)
75         throw BindingException("SAML 1.x Artifact Encoder requires relay state (TARGET) value.");
76     
77     // Signing is a protocol level issue, so no signing here...
78     
79     ArtifactMap* mapper = SAMLConfig::getConfig().getArtifactMap();
80     if (!mapper)
81         throw BindingException("SAML 1.x Artifact Encoder requires ArtifactMap be set in configuration.");
82
83     // Obtain a fresh artifact.
84     if (!m_artifactGenerator)
85         throw BindingException("SAML 1.x Artifact Encoder requires an ArtifactGenerator instance.");
86     log.debug("obtaining new artifact for relying party (%s)", recipientID ? recipientID : "unknown");
87     auto_ptr<SAMLArtifact> artifact(m_artifactGenerator->generateSAML1Artifact(recipientID));
88     
89     // Pass back output fields.
90     outputFields["SAMLart"] = artifact->encode();
91     outputFields["TARGET"] = relayState;
92
93     // Store the assertion. Last step in storage will be to delete the XML.
94     log.debug("storing artifact and content in map");
95     mapper->storeContent(xmlObject, artifact.get(), recipientID);
96
97     log.debug("message encoded");
98 }