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(MetadataException,opensaml::saml2md);
72 DECL_XMLTOOLING_EXCEPTION_FACTORY(MetadataFilterException,opensaml::saml2md);
73 DECL_XMLTOOLING_EXCEPTION_FACTORY(BindingException,opensaml);
74 DECL_XMLTOOLING_EXCEPTION_FACTORY(ProfileException,opensaml);
75 DECL_XMLTOOLING_EXCEPTION_FACTORY(FatalProfileException,opensaml);
76 DECL_XMLTOOLING_EXCEPTION_FACTORY(RetryableProfileException,opensaml);
79 SAMLInternalConfig g_config;
82 SAMLConfig& SAMLConfig::getConfig()
87 SAMLInternalConfig& SAMLInternalConfig::getInternalConfig()
92 void SAMLConfig::setArtifactMap(ArtifactMap* artifactMap)
95 m_artifactMap = artifactMap;
98 void SAMLConfig::setURLEncoder(URLEncoder* urlEncoder)
101 m_urlEncoder = urlEncoder;
104 bool SAMLInternalConfig::init(bool initXMLTooling)
107 xmltooling::NDC ndc("init");
109 Category& log=Category::getInstance(SAML_LOGCAT".SAMLConfig");
110 log.debug("library initialization started");
112 if (initXMLTooling) {
113 XMLToolingConfig::getConfig().init();
114 log.debug("XMLTooling library initialized");
117 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(ArtifactException,opensaml);
118 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(MetadataException,opensaml::saml2md);
119 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(MetadataFilterException,opensaml::saml2md);
120 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(BindingException,opensaml);
121 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(ProfileException,opensaml);
122 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(FatalProfileException,opensaml);
123 REGISTER_XMLTOOLING_EXCEPTION_FACTORY(RetryableProfileException,opensaml);
125 saml1::registerAssertionClasses();
126 saml1p::registerProtocolClasses();
127 saml2::registerAssertionClasses();
128 saml2p::registerProtocolClasses();
129 saml2md::registerMetadataClasses();
130 saml2md::registerMetadataProviders();
131 saml2md::registerMetadataFilters();
132 registerSAMLArtifacts();
133 registerMessageEncoders();
134 registerMessageDecoders();
135 registerSecurityPolicyRules();
137 m_urlEncoder = new URLEncoder();
139 log.info("library initialization complete");
143 void SAMLInternalConfig::term(bool termXMLTooling)
146 xmltooling::NDC ndc("term");
148 Category& log=Category::getInstance(SAML_LOGCAT".SAMLConfig");
150 MessageDecoderManager.deregisterFactories();
151 MessageEncoderManager.deregisterFactories();
152 SecurityPolicyRuleManager.deregisterFactories();
153 SAMLArtifactManager.deregisterFactories();
154 MetadataFilterManager.deregisterFactories();
155 MetadataProviderManager.deregisterFactories();
157 delete m_artifactMap;
158 m_artifactMap = NULL;
162 if (termXMLTooling) {
163 XMLToolingConfig::getConfig().term();
164 log.debug("XMLTooling library shut down");
166 log.info("library shutdown complete");
169 void SAMLInternalConfig::generateRandomBytes(void* buf, unsigned int len)
172 if (XSECPlatformUtils::g_cryptoProvider->getRandom(reinterpret_cast<unsigned char*>(buf),len)<len)
173 throw XMLSecurityException("Unable to generate random data; was PRNG seeded?");
175 catch (XSECCryptoException& e) {
176 throw XMLSecurityException("Unable to generate random data: $1",params(1,e.getMsg()));
180 void SAMLInternalConfig::generateRandomBytes(std::string& buf, unsigned int len)
183 auto_ptr<unsigned char> hold(new unsigned char[len]);
184 generateRandomBytes(hold.get(),len);
185 for (unsigned int i=0; i<len; i++)
186 buf+=(hold.get())[i];
189 XMLCh* SAMLInternalConfig::generateIdentifier()
191 unsigned char key[17];
192 generateRandomBytes(key,16);
195 sprintf(hexform,"_%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x",
196 key[0],key[1],key[2],key[3],key[4],key[5],key[6],key[7],
197 key[8],key[9],key[10],key[11],key[12],key[13],key[14],key[15]);
199 return XMLString::transcode(hexform);
202 string SAMLInternalConfig::hashSHA1(const char* s, bool toHex)
204 static char DIGITS[] = {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};
206 auto_ptr<XSECCryptoHash> hasher(XSECPlatformUtils::g_cryptoProvider->hashSHA1());
208 unsigned char buf[21];
209 hasher->hash(reinterpret_cast<unsigned char*>(const_cast<char*>(s)),strlen(s));
210 if (hasher->finish(buf,20)==20) {
213 for (unsigned int i=0; i<20; i++) {
214 ret+=(DIGITS[((unsigned char)(0xF0 & buf[i])) >> 4 ]);
215 ret+=(DIGITS[0x0F & buf[i]]);
219 for (unsigned int i=0; i<20; i++) {
226 throw XMLSecurityException("Unable to generate SHA-1 hash.");
229 void opensaml::log_openssl()
235 unsigned long code=ERR_get_error_line_data(&file,&line,&data,&flags);
237 Category& log=Category::getInstance("OpenSSL");
238 log.errorStream() << "error code: " << code << " in " << file << ", line " << line << CategoryStream::ENDLINE;
239 if (data && (flags & ERR_TXT_STRING))
240 log.errorStream() << "error data: " << data << CategoryStream::ENDLINE;
241 code=ERR_get_error_line_data(&file,&line,&data,&flags);
245 using namespace saml2md;
247 void opensaml::annotateException(XMLToolingException* e, const EntityDescriptor* entity, bool rethrow)
250 auto_ptr_char id(entity->getEntityID());
251 e->addProperty("entityID",id.get());
252 const list<XMLObject*>& roles=entity->getOrderedChildren();
253 for (list<XMLObject*>::const_iterator child=roles.begin(); child!=roles.end(); ++child) {
254 const RoleDescriptor* role=dynamic_cast<RoleDescriptor*>(*child);
255 if (role && role->isValid()) {
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());
282 if (e->getProperty("contactName") || e->getProperty("contactEmail")) {
283 auto_ptr_char eurl(role->getErrorURL());
285 e->addProperty("errorURL",eurl.get());
297 void opensaml::annotateException(XMLToolingException* e, const RoleDescriptor* role, bool rethrow)
300 auto_ptr_char id(dynamic_cast<EntityDescriptor*>(role->getParent())->getEntityID());
301 e->addProperty("entityID",id.get());
303 const vector<ContactPerson*>& contacts=role->getContactPersons();
304 for (vector<ContactPerson*>::const_iterator c=contacts.begin(); c!=contacts.end(); ++c) {
305 const XMLCh* ctype=(*c)->getContactType();
306 if (ctype && (XMLString::equals(ctype,ContactPerson::CONTACT_SUPPORT)
307 || XMLString::equals(ctype,ContactPerson::CONTACT_TECHNICAL))) {
308 GivenName* fname=(*c)->getGivenName();
309 SurName* lname=(*c)->getSurName();
310 auto_ptr_char first(fname ? fname->getName() : NULL);
311 auto_ptr_char last(lname ? lname->getName() : NULL);
312 if (first.get() && last.get()) {
313 string contact=string(first.get()) + ' ' + last.get();
314 e->addProperty("contactName",contact.c_str());
316 else if (first.get())
317 e->addProperty("contactName",first.get());
319 e->addProperty("contactName",last.get());
320 const vector<EmailAddress*>& emails=const_cast<const ContactPerson*>(*c)->getEmailAddresss();
321 if (!emails.empty()) {
322 auto_ptr_char email(emails.front()->getAddress());
324 e->addProperty("contactEmail",email.get());
330 auto_ptr_char eurl(role->getErrorURL());
332 e->addProperty("errorURL",eurl.get());