3 * Copyright 2001-2006 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
25 #include "exceptions.h"
26 #include "SAMLConfig.h"
27 #include "binding/ArtifactMap.h"
28 #include "binding/MessageDecoder.h"
29 #include "binding/MessageEncoder.h"
30 #include "binding/SAMLArtifact.h"
31 #include "binding/SecurityPolicyRule.h"
32 #include "binding/URLEncoder.h"
33 #include "saml1/core/Assertions.h"
34 #include "saml1/core/Protocols.h"
35 #include "saml2/core/Protocols.h"
36 #include "saml2/metadata/Metadata.h"
37 #include "saml2/metadata/MetadataProvider.h"
38 #include "util/SAMLConstants.h"
40 #include <xmltooling/XMLToolingConfig.h>
41 #include <xmltooling/signature/Signature.h>
42 #include <xmltooling/util/NDC.h>
44 #include <log4cpp/Category.hh>
45 #include <xsec/enc/XSECCryptoException.hpp>
46 #include <xsec/enc/XSECCryptoProvider.hpp>
47 #include <xsec/utils/XSECPlatformUtils.hpp>
48 #include <openssl/err.h>
50 using namespace opensaml;
51 using namespace xmlsignature;
52 using namespace xmltooling;
53 using namespace log4cpp;
56 // Expose entry points when used as an extension library
58 extern "C" int SAML_API xmltooling_extension_init(void*)
60 if (SAMLConfig::getConfig().init(false))
65 extern "C" void SAML_API xmltooling_extension_term()
67 SAMLConfig::getConfig().term(false);
70 DECL_XMLTOOLING_EXCEPTION_FACTORY(ArtifactException,opensaml);
71 DECL_XMLTOOLING_EXCEPTION_FACTORY(MetadataFilterException,opensaml::saml2md);
72 DECL_XMLTOOLING_EXCEPTION_FACTORY(BindingException,opensaml);
75 SAMLInternalConfig g_config;
78 SAMLConfig& SAMLConfig::getConfig()
83 SAMLInternalConfig& SAMLInternalConfig::getInternalConfig()
88 void SAMLConfig::setArtifactMap(ArtifactMap* artifactMap)
91 m_artifactMap = artifactMap;
94 void SAMLConfig::setURLEncoder(URLEncoder* urlEncoder)
97 m_urlEncoder = urlEncoder;
100 bool SAMLInternalConfig::init(bool initXMLTooling)
103 xmltooling::NDC ndc("init");
105 Category& log=Category::getInstance(SAML_LOGCAT".SAMLConfig");
106 log.debug("library initialization started");
108 if (initXMLTooling) {
109 XMLToolingConfig::getConfig().init();
110 log.debug("XMLTooling library initialized");
113 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(ArtifactException,opensaml);
114 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(MetadataFilterException,opensaml::saml2md);
115 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(BindingException,opensaml);
117 saml1::registerAssertionClasses();
118 saml1p::registerProtocolClasses();
119 saml2::registerAssertionClasses();
120 saml2p::registerProtocolClasses();
121 saml2md::registerMetadataClasses();
122 saml2md::registerMetadataProviders();
123 saml2md::registerMetadataFilters();
124 registerSAMLArtifacts();
125 registerMessageEncoders();
126 registerMessageDecoders();
127 registerSecurityPolicyRules();
129 m_urlEncoder = new URLEncoder();
131 log.info("library initialization complete");
135 void SAMLInternalConfig::term(bool termXMLTooling)
138 xmltooling::NDC ndc("term");
140 Category& log=Category::getInstance(SAML_LOGCAT".SAMLConfig");
142 MessageDecoderManager.deregisterFactories();
143 MessageEncoderManager.deregisterFactories();
144 SecurityPolicyRuleManager.deregisterFactories();
145 SAMLArtifactManager.deregisterFactories();
146 MetadataFilterManager.deregisterFactories();
147 MetadataProviderManager.deregisterFactories();
149 delete m_artifactMap;
150 m_artifactMap = NULL;
154 if (termXMLTooling) {
155 XMLToolingConfig::getConfig().term();
156 log.debug("XMLTooling library shut down");
158 log.info("library shutdown complete");
161 void SAMLInternalConfig::generateRandomBytes(void* buf, unsigned int len)
164 if (XSECPlatformUtils::g_cryptoProvider->getRandom(reinterpret_cast<unsigned char*>(buf),len)<len)
165 throw XMLSecurityException("Unable to generate random data; was PRNG seeded?");
167 catch (XSECCryptoException& e) {
168 throw XMLSecurityException("Unable to generate random data: $1",params(1,e.getMsg()));
172 void SAMLInternalConfig::generateRandomBytes(std::string& buf, unsigned int len)
175 auto_ptr<unsigned char> hold(new unsigned char[len]);
176 generateRandomBytes(hold.get(),len);
177 for (unsigned int i=0; i<len; i++)
178 buf+=(hold.get())[i];
181 XMLCh* SAMLInternalConfig::generateIdentifier()
183 unsigned char key[17];
184 generateRandomBytes(key,16);
187 sprintf(hexform,"_%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x",
188 key[0],key[1],key[2],key[3],key[4],key[5],key[6],key[7],
189 key[8],key[9],key[10],key[11],key[12],key[13],key[14],key[15]);
191 return XMLString::transcode(hexform);
194 string SAMLInternalConfig::hashSHA1(const char* s, bool toHex)
196 static char DIGITS[] = {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};
198 auto_ptr<XSECCryptoHash> hasher(XSECPlatformUtils::g_cryptoProvider->hashSHA1());
200 unsigned char buf[21];
201 hasher->hash(reinterpret_cast<unsigned char*>(const_cast<char*>(s)),strlen(s));
202 if (hasher->finish(buf,20)==20) {
205 for (unsigned int i=0; i<20; i++) {
206 ret+=(DIGITS[((unsigned char)(0xF0 & buf[i])) >> 4 ]);
207 ret+=(DIGITS[0x0F & buf[i]]);
211 for (unsigned int i=0; i<20; i++) {
218 throw XMLSecurityException("Unable to generate SHA-1 hash.");
221 void opensaml::log_openssl()
227 unsigned long code=ERR_get_error_line_data(&file,&line,&data,&flags);
229 Category& log=Category::getInstance("OpenSSL");
230 log.errorStream() << "error code: " << code << " in " << file << ", line " << line << CategoryStream::ENDLINE;
231 if (data && (flags & ERR_TXT_STRING))
232 log.errorStream() << "error data: " << data << CategoryStream::ENDLINE;
233 code=ERR_get_error_line_data(&file,&line,&data,&flags);
237 using namespace saml2md;
239 void opensaml::annotateException(XMLToolingException* e, const EntityDescriptor* entity, bool rethrow)
242 auto_ptr_char id(entity->getEntityID());
243 e->addProperty("entityID",id.get());
244 const list<XMLObject*>& roles=entity->getOrderedChildren();
245 for (list<XMLObject*>::const_iterator child=roles.begin(); child!=roles.end(); ++child) {
246 const RoleDescriptor* role=dynamic_cast<RoleDescriptor*>(*child);
247 if (role && role->isValid()) {
248 const vector<ContactPerson*>& contacts=role->getContactPersons();
249 for (vector<ContactPerson*>::const_iterator c=contacts.begin(); c!=contacts.end(); ++c) {
250 const XMLCh* ctype=(*c)->getContactType();
251 if (ctype && (XMLString::equals(ctype,ContactPerson::CONTACT_SUPPORT)
252 || XMLString::equals(ctype,ContactPerson::CONTACT_TECHNICAL))) {
253 GivenName* fname=(*c)->getGivenName();
254 SurName* lname=(*c)->getSurName();
255 auto_ptr_char first(fname ? fname->getName() : NULL);
256 auto_ptr_char last(lname ? lname->getName() : NULL);
257 if (first.get() && last.get()) {
258 string contact=string(first.get()) + ' ' + last.get();
259 e->addProperty("contactName",contact.c_str());
261 else if (first.get())
262 e->addProperty("contactName",first.get());
264 e->addProperty("contactName",last.get());
265 const vector<EmailAddress*>& emails=const_cast<const ContactPerson*>(*c)->getEmailAddresss();
266 if (!emails.empty()) {
267 auto_ptr_char email(emails.front()->getAddress());
269 e->addProperty("contactEmail",email.get());
274 if (e->getProperty("contactName") || e->getProperty("contactEmail")) {
275 auto_ptr_char eurl(role->getErrorURL());
277 e->addProperty("errorURL",eurl.get());
289 void opensaml::annotateException(XMLToolingException* e, const RoleDescriptor* role, bool rethrow)
292 auto_ptr_char id(dynamic_cast<EntityDescriptor*>(role->getParent())->getEntityID());
293 e->addProperty("entityID",id.get());
295 const vector<ContactPerson*>& contacts=role->getContactPersons();
296 for (vector<ContactPerson*>::const_iterator c=contacts.begin(); c!=contacts.end(); ++c) {
297 const XMLCh* ctype=(*c)->getContactType();
298 if (ctype && (XMLString::equals(ctype,ContactPerson::CONTACT_SUPPORT)
299 || XMLString::equals(ctype,ContactPerson::CONTACT_TECHNICAL))) {
300 GivenName* fname=(*c)->getGivenName();
301 SurName* lname=(*c)->getSurName();
302 auto_ptr_char first(fname ? fname->getName() : NULL);
303 auto_ptr_char last(lname ? lname->getName() : NULL);
304 if (first.get() && last.get()) {
305 string contact=string(first.get()) + ' ' + last.get();
306 e->addProperty("contactName",contact.c_str());
308 else if (first.get())
309 e->addProperty("contactName",first.get());
311 e->addProperty("contactName",last.get());
312 const vector<EmailAddress*>& emails=const_cast<const ContactPerson*>(*c)->getEmailAddresss();
313 if (!emails.empty()) {
314 auto_ptr_char email(emails.front()->getAddress());
316 e->addProperty("contactEmail",email.get());
322 auto_ptr_char eurl(role->getErrorURL());
324 e->addProperty("errorURL",eurl.get());