Factor out XML signing code, add SAML 2 Artifact/POST
[shibboleth/cpp-opensaml.git] / saml / saml2 / binding / impl / SAML2POSTEncoder.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  * SAML2POSTEncoder.cpp
19  * 
20  * SAML 2.0 HTTP-POST binding message encoder
21  */
22
23 #include "internal.h"
24 #include "exceptions.h"
25 #include "saml2/binding/SAML2POSTEncoder.h"
26 #include "saml2/core/Protocols.h"
27
28 #include <log4cpp/Category.hh>
29 #include <xercesc/util/Base64.hpp>
30 #include <xmltooling/util/NDC.h>
31
32 using namespace opensaml::saml2p;
33 using namespace opensaml;
34 using namespace xmlsignature;
35 using namespace xmltooling;
36 using namespace log4cpp;
37 using namespace std;
38
39 namespace opensaml {
40     namespace saml2p {              
41         MessageEncoder* SAML_DLLLOCAL SAML2POSTEncoderFactory(const DOMElement* const & e)
42         {
43             return new SAML2POSTEncoder(e);
44         }
45     };
46 };
47
48 SAML2POSTEncoder::SAML2POSTEncoder(const DOMElement* e) {}
49
50 SAML2POSTEncoder::~SAML2POSTEncoder() {}
51
52 void SAML2POSTEncoder::encode(
53     map<string,string>& outputFields,
54     XMLObject* xmlObject,
55     const char* recipientID,
56     const char* relayState,
57     const CredentialResolver* credResolver,
58     const XMLCh* sigAlgorithm
59     ) const
60 {
61 #ifdef _DEBUG
62     xmltooling::NDC ndc("encode");
63 #endif
64     Category& log = Category::getInstance(SAML_LOGCAT".MessageEncoder.SAML2POST");
65     log.debug("validating input");
66     
67     outputFields.clear();
68     if (xmlObject->getParent())
69         throw BindingException("Cannot encode XML content with parent.");
70     
71     StatusResponseType* response = NULL;
72     RequestAbstractType* request = dynamic_cast<RequestAbstractType*>(xmlObject);
73     if (!request)
74         response = dynamic_cast<StatusResponseType*>(xmlObject);
75     if (!response)
76         throw BindingException("XML content for SAML 2.0 HTTP-POST Encoder must be a SAML 2.0 protocol message.");
77     
78     DOMElement* rootElement = NULL;
79     if (credResolver) {
80         // Signature based on native XML signing.
81         if (request ? request->getSignature() : response->getSignature()) {
82             log.debug("message already signed, skipping signature operation");
83         }
84         else {
85             log.debug("signing and marshalling the message");
86
87             // Build a Signature.
88             Signature* sig = buildSignature(credResolver, sigAlgorithm);
89             
90             // Append Signature.
91             request ? request->setSignature(sig) : response->setSignature(sig);    
92         
93             // Sign response while marshalling.
94             vector<Signature*> sigs(1,sig);
95             rootElement = xmlObject->marshall((DOMDocument*)NULL,&sigs);
96         }
97     }
98     else {
99         log.debug("marshalling the message");
100         rootElement = xmlObject->marshall();
101     }
102     
103     string xmlbuf;
104     XMLHelper::serialize(rootElement, xmlbuf);
105     unsigned int len=0;
106     XMLByte* out=Base64::encode(reinterpret_cast<const XMLByte*>(xmlbuf.data()),xmlbuf.size(),&len);
107     if (out) {
108         xmlbuf.erase();
109         xmlbuf.append(reinterpret_cast<char*>(out),len);
110         XMLString::release(&out);
111     }
112     else {
113         throw BindingException("Base64 encoding of XML failed.");
114     }
115     
116     // Pass back output fields.
117     outputFields[request ? "SAMLRequest" : "SAMLResponse"] = xmlbuf;
118     if (relayState)
119         outputFields["RelayState"] = relayState;
120
121     // Cleanup by destroying XML.
122     delete xmlObject;
123
124     log.debug("message encoded");
125 }