2 * Licensed to the University Corporation for Advanced Internet
3 * Development, Inc. (UCAID) under one or more contributor license
4 * agreements. See the NOTICE file distributed with this work for
5 * additional information regarding copyright ownership.
7 * UCAID licenses this file to you under the Apache License,
8 * Version 2.0 (the "License"); you may not use this file except
9 * in compliance with the License. You may obtain a copy of the
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
17 * either express or implied. See the License for the specific
18 * language governing permissions and limitations under the License.
22 * @file saml/SAMLConfig.h
24 * Library configuration.
27 #ifndef __saml_config_h__
28 #define __saml_config_h__
30 #include <saml/base.h>
33 #include <xercesc/dom/DOM.hpp>
34 #include <xmltooling/PluginManager.h>
38 * Common classes for OpenSAML library
42 class SAML_API ArtifactMap;
43 class SAML_API MessageEncoder;
44 class SAML_API MessageDecoder;
45 class SAML_API SAMLArtifact;
46 class SAML_API SecurityPolicyRule;
49 class SAML_API ContactPerson;
50 class SAML_API EntityDescriptor;
51 class SAML_API MetadataProvider;
52 class SAML_API MetadataFilter;
53 class SAML_API RoleDescriptor;
56 #if defined (_MSC_VER)
57 #pragma warning( push )
58 #pragma warning( disable : 4250 4251 )
62 * Singleton object that manages library startup/shutdown.configuration.
64 class SAML_API SAMLConfig
66 MAKE_NONCOPYABLE(SAMLConfig);
68 virtual ~SAMLConfig();
71 * Returns the global configuration object for the library.
73 * @return reference to the global library configuration object
75 static SAMLConfig& getConfig();
80 * Each process using the library MUST call this function exactly once
81 * before using any library classes. The flag controls whether this is the
82 * "dominant" library or not and can allow the SAML library to be loaded
83 * as an extension of XMLTooling rather than subsuming it.
85 * @param initXMLTooling true iff this method should initialize the XMLTooling layer
86 * @return true iff initialization was successful
88 virtual bool init(bool initXMLTooling=true)=0;
93 * Each process using the library SHOULD call this function exactly once
94 * before terminating itself. The flag controls whether this is the
95 * "dominant" library or not and can allow the SAML library to be loaded
96 * as an extension of XMLTooling rather than subsuming it.
98 * @param termXMLTooling true iff this method should shutdown the XMLTooling layer
100 virtual void term(bool termXMLTooling=true)=0;
103 * Sets the global ArtifactMap instance.
104 * This method must be externally synchronized with any code that uses the object.
105 * Any previously set object is destroyed.
107 * @param artifactMap new ArtifactMap instance to store
109 void setArtifactMap(ArtifactMap* artifactMap);
112 * Returns the global ArtifactMap instance.
114 * @return global ArtifactMap or nullptr
116 ArtifactMap* getArtifactMap() const;
119 * Generate random information using the underlying security library
121 * @param buf buffer for the information
122 * @param len number of bytes to write into buffer
124 virtual void generateRandomBytes(void* buf, unsigned int len)=0;
127 * Generate random information using the underlying security library
129 * @param buf string buffer for the information
130 * @param len number of bytes to write into buffer
132 virtual void generateRandomBytes(std::string& buf, unsigned int len)=0;
135 * Generate a valid XML identifier of the form _X{32} where X is a
136 * random hex character. The caller is responsible for freeing the result.
138 * @return a valid null-terminated XML ID
140 virtual XMLCh* generateIdentifier()=0;
144 * Generate the SHA-1 hash of a string
146 * @param s NULL-terminated string to hash
147 * @param toHex true iff the result should be encoded in hexadecimal form or left as raw bytes
149 * @return SHA-1 hash of the data
151 virtual std::string hashSHA1(const char* s, bool toHex=false)=0;
154 * Sets the order of contact types to use in annotating exceptions with contact information.
156 * @param contactTypes whitespace-delimited list of contact types
158 virtual void setContactPriority(const XMLCh* contactTypes)=0;
161 * Returns the appropriate contact to use for the entity.
163 * @param entity the entity to search
164 * @return a contact to use, or nullptr
166 virtual const saml2md::ContactPerson* getContactPerson(const saml2md::EntityDescriptor& entity) const=0;
169 * Returns the appropriate contact to use for the role.
171 * @param entity the role to search
172 * @return a contact to use, or nullptr
174 virtual const saml2md::ContactPerson* getContactPerson(const saml2md::RoleDescriptor& role) const=0;
176 /** Manages factories for MessageDecoder plugins. */
177 xmltooling::PluginManager< MessageDecoder,std::string,std::pair<const xercesc::DOMElement*,const XMLCh*> > MessageDecoderManager;
179 /** Manages factories for MessageEncoder plugins. */
180 xmltooling::PluginManager< MessageEncoder,std::string,std::pair<const xercesc::DOMElement*,const XMLCh*> > MessageEncoderManager;
182 /** Manages factories for SAMLArtifact plugins. */
183 xmltooling::PluginManager<SAMLArtifact,std::string,const char*> SAMLArtifactManager;
185 /** Manages factories for SecurityPolicyRule plugins. */
186 xmltooling::PluginManager<SecurityPolicyRule,std::string,const xercesc::DOMElement*> SecurityPolicyRuleManager;
188 /** Manages factories for MetadataProvider plugins. */
189 xmltooling::PluginManager<saml2md::MetadataProvider,std::string,const xercesc::DOMElement*> MetadataProviderManager;
191 /** Manages factories for MetadataFilter plugins. */
192 xmltooling::PluginManager<saml2md::MetadataFilter,std::string,const xercesc::DOMElement*> MetadataFilterManager;
197 /** Global ArtifactMap instance for use by artifact-related functions. */
198 ArtifactMap* m_artifactMap;
201 #if defined (_MSC_VER)
202 #pragma warning( pop )
207 #endif /* __saml_config_h__ */