2 * Copyright 2001-2010 Internet2
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * @file saml/SAMLConfig.h
20 * Library configuration.
23 #ifndef __saml_config_h__
24 #define __saml_config_h__
26 #include <saml/base.h>
29 #include <xercesc/dom/DOM.hpp>
30 #include <xmltooling/PluginManager.h>
34 * Common classes for OpenSAML library
38 class SAML_API ArtifactMap;
39 class SAML_API MessageEncoder;
40 class SAML_API MessageDecoder;
41 class SAML_API SAMLArtifact;
42 class SAML_API SecurityPolicyRule;
45 class SAML_API MetadataProvider;
46 class SAML_API MetadataFilter;
49 #if defined (_MSC_VER)
50 #pragma warning( push )
51 #pragma warning( disable : 4250 4251 )
55 * Singleton object that manages library startup/shutdown.configuration.
57 class SAML_API SAMLConfig
59 MAKE_NONCOPYABLE(SAMLConfig);
61 virtual ~SAMLConfig();
64 * Returns the global configuration object for the library.
66 * @return reference to the global library configuration object
68 static SAMLConfig& getConfig();
73 * Each process using the library MUST call this function exactly once
74 * before using any library classes. The flag controls whether this is the
75 * "dominant" library or not and can allow the SAML library to be loaded
76 * as an extension of XMLTooling rather than subsuming it.
78 * @param initXMLTooling true iff this method should initialize the XMLTooling layer
79 * @return true iff initialization was successful
81 virtual bool init(bool initXMLTooling=true)=0;
86 * Each process using the library SHOULD call this function exactly once
87 * before terminating itself. The flag controls whether this is the
88 * "dominant" library or not and can allow the SAML library to be loaded
89 * as an extension of XMLTooling rather than subsuming it.
91 * @param termXMLTooling true iff this method should shutdown the XMLTooling layer
93 virtual void term(bool termXMLTooling=true)=0;
96 * Sets the global ArtifactMap instance.
97 * This method must be externally synchronized with any code that uses the object.
98 * Any previously set object is destroyed.
100 * @param artifactMap new ArtifactMap instance to store
102 void setArtifactMap(ArtifactMap* artifactMap);
105 * Returns the global ArtifactMap instance.
107 * @return global ArtifactMap or nullptr
109 ArtifactMap* getArtifactMap() const;
112 * Generate random information using the underlying security library
114 * @param buf buffer for the information
115 * @param len number of bytes to write into buffer
117 virtual void generateRandomBytes(void* buf, unsigned int len)=0;
120 * Generate random information using the underlying security library
122 * @param buf string buffer for the information
123 * @param len number of bytes to write into buffer
125 virtual void generateRandomBytes(std::string& buf, unsigned int len)=0;
128 * Generate a valid XML identifier of the form _X{32} where X is a
129 * random hex character. The caller is responsible for freeing the result.
131 * @return a valid null-terminated XML ID
133 virtual XMLCh* generateIdentifier()=0;
137 * Generate the SHA-1 hash of a string
139 * @param s NULL-terminated string to hash
140 * @param toHex true iff the result should be encoded in hexadecimal form or left as raw bytes
142 * @return SHA-1 hash of the data
144 virtual std::string hashSHA1(const char* s, bool toHex=false)=0;
146 /** Manages factories for MessageDecoder plugins. */
147 xmltooling::PluginManager< MessageDecoder,std::string,std::pair<const xercesc::DOMElement*,const XMLCh*> > MessageDecoderManager;
149 /** Manages factories for MessageEncoder plugins. */
150 xmltooling::PluginManager< MessageEncoder,std::string,std::pair<const xercesc::DOMElement*,const XMLCh*> > MessageEncoderManager;
152 /** Manages factories for SAMLArtifact plugins. */
153 xmltooling::PluginManager<SAMLArtifact,std::string,const char*> SAMLArtifactManager;
155 /** Manages factories for SecurityPolicyRule plugins. */
156 xmltooling::PluginManager<SecurityPolicyRule,std::string,const xercesc::DOMElement*> SecurityPolicyRuleManager;
158 /** Manages factories for MetadataProvider plugins. */
159 xmltooling::PluginManager<saml2md::MetadataProvider,std::string,const xercesc::DOMElement*> MetadataProviderManager;
161 /** Manages factories for MetadataFilter plugins. */
162 xmltooling::PluginManager<saml2md::MetadataFilter,std::string,const xercesc::DOMElement*> MetadataFilterManager;
167 /** Global ArtifactMap instance for use by artifact-related functions. */
168 ArtifactMap* m_artifactMap;
171 #if defined (_MSC_VER)
172 #pragma warning( pop )
177 #endif /* __saml_config_h__ */