3 * Copyright 2001-2007 Internet2
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
21 * Library configuration
26 #if defined(XMLTOOLING_LOG4SHIB)
27 # ifndef OPENSAML_LOG4SHIB
28 # error "Logging library mismatch (XMLTooling is using log4shib)."
30 #elif defined(XMLTOOLING_LOG4CPP)
31 # ifndef OPENSAML_LOG4CPP
32 # error "Logging library mismatch (XMLTooling is using log4cpp)."
35 # error "No supported logging library."
38 #include "exceptions.h"
39 #include "SAMLConfig.h"
40 #include "binding/ArtifactMap.h"
41 #include "binding/MessageDecoder.h"
42 #include "binding/MessageEncoder.h"
43 #include "binding/SAMLArtifact.h"
44 #include "binding/SecurityPolicyRule.h"
45 #include "saml1/core/Assertions.h"
46 #include "saml1/core/Protocols.h"
47 #include "saml2/core/Protocols.h"
48 #include "saml2/metadata/Metadata.h"
49 #include "saml2/metadata/MetadataFilter.h"
50 #include "saml2/metadata/MetadataProvider.h"
51 #include "util/SAMLConstants.h"
53 #include <xmltooling/logging.h>
54 #include <xmltooling/XMLToolingConfig.h>
55 #include <xmltooling/signature/Signature.h>
56 #include <xmltooling/util/NDC.h>
58 #include <xsec/enc/XSECCryptoException.hpp>
59 #include <xsec/enc/XSECCryptoProvider.hpp>
60 #include <xsec/utils/XSECPlatformUtils.hpp>
62 using namespace opensaml;
63 using namespace xmlsignature;
64 using namespace xmltooling::logging;
65 using namespace xmltooling;
68 // Expose entry points when used as an extension library
70 extern "C" int SAML_API xmltooling_extension_init(void*)
72 if (SAMLConfig::getConfig().init(false))
77 extern "C" void SAML_API xmltooling_extension_term()
79 SAMLConfig::getConfig().term(false);
82 DECL_XMLTOOLING_EXCEPTION_FACTORY(ArtifactException,opensaml);
83 DECL_XMLTOOLING_EXCEPTION_FACTORY(SecurityPolicyException,opensaml);
84 DECL_XMLTOOLING_EXCEPTION_FACTORY(MetadataException,opensaml::saml2md);
85 DECL_XMLTOOLING_EXCEPTION_FACTORY(MetadataFilterException,opensaml::saml2md);
86 DECL_XMLTOOLING_EXCEPTION_FACTORY(BindingException,opensaml);
87 DECL_XMLTOOLING_EXCEPTION_FACTORY(ProfileException,opensaml);
88 DECL_XMLTOOLING_EXCEPTION_FACTORY(FatalProfileException,opensaml);
89 DECL_XMLTOOLING_EXCEPTION_FACTORY(RetryableProfileException,opensaml);
92 SAMLInternalConfig g_config;
95 SAMLConfig& SAMLConfig::getConfig()
100 SAMLInternalConfig& SAMLInternalConfig::getInternalConfig()
105 void SAMLConfig::setArtifactMap(ArtifactMap* artifactMap)
107 delete m_artifactMap;
108 m_artifactMap = artifactMap;
111 bool SAMLInternalConfig::init(bool initXMLTooling)
114 xmltooling::NDC ndc("init");
116 Category& log=Category::getInstance(SAML_LOGCAT".SAMLConfig");
117 log.debug("library initialization started");
119 if (initXMLTooling) {
120 XMLToolingConfig::getConfig().init();
121 log.debug("XMLTooling library initialized");
124 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(ArtifactException,opensaml);
125 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(SecurityPolicyException,opensaml);
126 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(MetadataException,opensaml::saml2md);
127 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(MetadataFilterException,opensaml::saml2md);
128 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(BindingException,opensaml);
129 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(ProfileException,opensaml);
130 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(FatalProfileException,opensaml);
131 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(RetryableProfileException,opensaml);
133 saml1::registerAssertionClasses();
134 saml1p::registerProtocolClasses();
135 saml2::registerAssertionClasses();
136 saml2p::registerProtocolClasses();
137 saml2md::registerMetadataClasses();
138 saml2md::registerMetadataProviders();
139 saml2md::registerMetadataFilters();
140 registerSAMLArtifacts();
141 registerMessageEncoders();
142 registerMessageDecoders();
143 registerSecurityPolicyRules();
145 log.info("library initialization complete");
149 void SAMLInternalConfig::term(bool termXMLTooling)
152 xmltooling::NDC ndc("term");
154 Category& log=Category::getInstance(SAML_LOGCAT".SAMLConfig");
156 MessageDecoderManager.deregisterFactories();
157 MessageEncoderManager.deregisterFactories();
158 SecurityPolicyRuleManager.deregisterFactories();
159 SAMLArtifactManager.deregisterFactories();
160 MetadataFilterManager.deregisterFactories();
161 MetadataProviderManager.deregisterFactories();
163 delete m_artifactMap;
164 m_artifactMap = NULL;
166 if (termXMLTooling) {
167 XMLToolingConfig::getConfig().term();
168 log.debug("XMLTooling library shut down");
170 log.info("library shutdown complete");
173 void SAMLInternalConfig::generateRandomBytes(void* buf, unsigned int len)
176 if (XSECPlatformUtils::g_cryptoProvider->getRandom(reinterpret_cast<unsigned char*>(buf),len)<len)
177 throw XMLSecurityException("Unable to generate random data; was PRNG seeded?");
179 catch (XSECCryptoException& e) {
180 throw XMLSecurityException("Unable to generate random data: $1",params(1,e.getMsg()));
184 void SAMLInternalConfig::generateRandomBytes(std::string& buf, unsigned int len)
187 auto_ptr<unsigned char> hold(new unsigned char[len]);
188 generateRandomBytes(hold.get(),len);
189 for (unsigned int i=0; i<len; i++)
190 buf+=(hold.get())[i];
193 XMLCh* SAMLInternalConfig::generateIdentifier()
195 unsigned char key[17];
196 generateRandomBytes(key,16);
199 sprintf(hexform,"_%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x",
200 key[0],key[1],key[2],key[3],key[4],key[5],key[6],key[7],
201 key[8],key[9],key[10],key[11],key[12],key[13],key[14],key[15]);
203 return XMLString::transcode(hexform);
206 string SAMLInternalConfig::hashSHA1(const char* s, bool toHex)
208 static char DIGITS[] = {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};
210 auto_ptr<XSECCryptoHash> hasher(XSECPlatformUtils::g_cryptoProvider->hashSHA1());
212 unsigned char buf[21];
213 hasher->hash(reinterpret_cast<unsigned char*>(const_cast<char*>(s)),strlen(s));
214 if (hasher->finish(buf,20)==20) {
217 for (unsigned int i=0; i<20; i++) {
218 ret+=(DIGITS[((unsigned char)(0xF0 & buf[i])) >> 4 ]);
219 ret+=(DIGITS[0x0F & buf[i]]);
223 for (unsigned int i=0; i<20; i++) {
230 throw XMLSecurityException("Unable to generate SHA-1 hash.");
233 using namespace saml2p;
234 using namespace saml2md;
236 void opensaml::annotateException(XMLToolingException* e, const EntityDescriptor* entity, const Status* status, bool rethrow)
238 const RoleDescriptor* role = NULL;
240 const list<XMLObject*>& roles=entity->getOrderedChildren();
241 for (list<XMLObject*>::const_iterator child=roles.begin(); !role && child!=roles.end(); ++child) {
242 role=dynamic_cast<RoleDescriptor*>(*child);
243 if (role && !role->isValid())
247 annotateException(e, role, status, rethrow);
250 void opensaml::annotateException(XMLToolingException* e, const RoleDescriptor* role, const Status* status, bool rethrow)
253 auto_ptr_char id(dynamic_cast<EntityDescriptor*>(role->getParent())->getEntityID());
254 e->addProperty("entityID",id.get());
256 const vector<ContactPerson*>& contacts=role->getContactPersons();
257 for (vector<ContactPerson*>::const_iterator c=contacts.begin(); c!=contacts.end(); ++c) {
258 const XMLCh* ctype=(*c)->getContactType();
259 if (ctype && (XMLString::equals(ctype,ContactPerson::CONTACT_SUPPORT)
260 || XMLString::equals(ctype,ContactPerson::CONTACT_TECHNICAL))) {
261 GivenName* fname=(*c)->getGivenName();
262 SurName* lname=(*c)->getSurName();
263 auto_ptr_char first(fname ? fname->getName() : NULL);
264 auto_ptr_char last(lname ? lname->getName() : NULL);
265 if (first.get() && last.get()) {
266 string contact=string(first.get()) + ' ' + last.get();
267 e->addProperty("contactName",contact.c_str());
269 else if (first.get())
270 e->addProperty("contactName",first.get());
272 e->addProperty("contactName",last.get());
273 const vector<EmailAddress*>& emails=const_cast<const ContactPerson*>(*c)->getEmailAddresss();
274 if (!emails.empty()) {
275 auto_ptr_char email(emails.front()->getAddress());
277 e->addProperty("contactEmail",email.get());
283 auto_ptr_char eurl(role->getErrorURL());
285 e->addProperty("errorURL",eurl.get());
290 auto_ptr_char sc(status->getStatusCode() ? status->getStatusCode()->getValue() : NULL);
291 if (sc.get() && *sc.get())
292 e->addProperty("statusCode", sc.get());
293 if (status->getStatusCode()->getStatusCode()) {
294 auto_ptr_char sc2(status->getStatusCode()->getStatusCode()->getValue());
295 if (sc2.get() && *sc.get())
296 e->addProperty("statusCode2", sc2.get());
298 if (status->getStatusMessage()) {
299 auto_ptr_char msg(status->getStatusMessage()->getMessage());
300 if (msg.get() && *msg.get())
301 e->addProperty("statusMessage", msg.get());