saml/SAMLConfig.h

   1 /*\r
   2  *  Copyright 2001-2006 Internet2\r
   3  * \r
   4  * Licensed under the Apache License, Version 2.0 (the "License");\r
   5  * you may not use this file except in compliance with the License.\r
   6  * You may obtain a copy of the License at\r
   7  *\r
   8  *     http://www.apache.org/licenses/LICENSE-2.0\r
   9  *\r
  10  * Unless required by applicable law or agreed to in writing, software\r
  11  * distributed under the License is distributed on an "AS IS" BASIS,\r
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  13  * See the License for the specific language governing permissions and\r
  14  * limitations under the License.\r
  15  */\r
  16 \r
  17 /**\r
  18  * @file saml/SAMLConfig.h\r
  19  * \r
  20  * Library configuration \r
  21  */\r
  22 \r
  23 #ifndef __saml_config_h__\r
  24 #define __saml_config_h__\r
  25 \r
  26 #include <saml/base.h>\r
  27 \r
  28 #include <xmltooling/PluginManager.h>\r
  29 #include <xmltooling/XMLToolingConfig.h>\r
  30 \r
  31 #include <string>\r
  32 \r
  33 /**\r
  34  * @namespace opensaml\r
  35  * Common classes for OpenSAML library\r
  36  */\r
  37 namespace opensaml {\r
  38 \r
  39     class SAML_API ArtifactMap;\r
  40     class SAML_API MessageEncoder;\r
  41     class SAML_API MessageDecoder;\r
  42     class SAML_API SAMLArtifact;\r
  43     class SAML_API TrustEngine;\r
  44     class SAML_API URLEncoder;\r
  45 \r
  46     namespace saml2md {\r
  47         class SAML_API MetadataProvider;\r
  48         class SAML_API MetadataFilter;\r
  49     };\r
  50 \r
  51 #if defined (_MSC_VER)\r
  52     #pragma warning( push )\r
  53     #pragma warning( disable : 4250 4251 )\r
  54 #endif\r
  55 \r
  56     /**\r
  57      * Singleton object that manages library startup/shutdown.configuration.\r
  58      */\r
  59     class SAML_API SAMLConfig\r
  60     {\r
  61     MAKE_NONCOPYABLE(SAMLConfig);\r
  62     public:\r
  63         virtual ~SAMLConfig() {}\r
  64 \r
  65         /**\r
  66          * Returns the global configuration object for the library.\r
  67          * \r
  68          * @return reference to the global library configuration object\r
  69          */\r
  70         static SAMLConfig& getConfig();\r
  71         \r
  72         /**\r
  73          * Initializes library\r
  74          * \r
  75          * Each process using the library MUST call this function exactly once\r
  76          * before using any library classes. The flag controls whether this is the\r
  77          * "dominant" library or not and can allow the SAML library to be loaded\r
  78          * as an extension of XMLTooling rather than subsuming it.\r
  79          * \r
  80          * @param initXMLTooling true iff this method should initialize the XMLTooling layer\r
  81          * @return true iff initialization was successful \r
  82          */\r
  83         virtual bool init(bool initXMLTooling=true)=0;\r
  84         \r
  85         /**\r
  86          * Shuts down library\r
  87          * \r
  88          * Each process using the library SHOULD call this function exactly once\r
  89          * before terminating itself. The flag controls whether this is the\r
  90          * "dominant" library or not and can allow the SAML library to be loaded\r
  91          * as an extension of XMLTooling rather than subsuming it.\r
  92          * \r
  93          * @param termXMLTooling true iff this method should shutdown the XMLTooling layer\r
  94          */\r
  95         virtual void term(bool termXMLTooling=true)=0;\r
  96         \r
  97         /**\r
  98          * Sets the global ArtifactMap instance.\r
  99          * This method must be externally synchronized with any code that uses the object.\r
 100          * Any previously set object is destroyed.\r
 101          * \r
 102          * @param artifactMap   new ArtifactMap instance to store\r
 103          */\r
 104         void setArtifactMap(ArtifactMap* artifactMap);\r
 105         \r
 106         /**\r
 107          * Returns the global ArtifactMap instance.\r
 108          * \r
 109          * @return  global ArtifactMap or NULL\r
 110          */\r
 111         ArtifactMap* getArtifactMap() const {\r
 112             return m_artifactMap;\r
 113         }\r
 114 \r
 115         /**\r
 116          * Sets the global URLEncoder instance.\r
 117          * This method must be externally synchronized with any code that uses the object.\r
 118          * Any previously set object is destroyed.\r
 119          * \r
 120          * @param urlEncoder   new URLEncoder instance to store\r
 121          */\r
 122         void setURLEncoder(URLEncoder* urlEncoder);\r
 123         \r
 124         /**\r
 125          * Returns the global URLEncoder instance.\r
 126          * \r
 127          * @return  global URLEncoder or NULL\r
 128          */\r
 129         URLEncoder* getURLEncoder() const {\r
 130             return m_urlEncoder;\r
 131         }\r
 132         \r
 133         /**\r
 134          * Generate random information using the underlying security library\r
 135          * \r
 136          * @param buf   buffer for the information\r
 137          * @param len   number of bytes to write into buffer\r
 138          */\r
 139         virtual void generateRandomBytes(void* buf, unsigned int len)=0;\r
 140 \r
 141         /**\r
 142          * Generate random information using the underlying security library\r
 143          * \r
 144          * @param buf   string buffer for the information\r
 145          * @param len   number of bytes to write into buffer\r
 146          */\r
 147         virtual void generateRandomBytes(std::string& buf, unsigned int len)=0;\r
 148 \r
 149         /**\r
 150          * Generate a valid XML identifier of the form _X{32} where X is a\r
 151          * random hex character. The caller is responsible for freeing the result.\r
 152          * \r
 153          * @return a valid null-terminated XML ID\r
 154          */\r
 155         virtual XMLCh* generateIdentifier()=0;\r
 156         \r
 157         /**\r
 158          * Generate the SHA-1 hash of a string\r
 159          * \r
 160          * @param s     NULL-terminated string to hash\r
 161          * @param toHex true iff the result should be encoded in hexadecimal form or left as raw bytes\r
 162          *  \r
 163          * @return  SHA-1 hash of the data\r
 164          */\r
 165         virtual std::string hashSHA1(const char* s, bool toHex=false)=0;\r
 166 \r
 167         /**\r
 168          * Manages factories for MessageDecoder plugins.\r
 169          */\r
 170         xmltooling::PluginManager<MessageDecoder,const DOMElement*> MessageDecoderManager;\r
 171 \r
 172         /**\r
 173          * Manages factories for MessageEncoder plugins.\r
 174          */\r
 175         xmltooling::PluginManager<MessageEncoder,const DOMElement*> MessageEncoderManager;        \r
 176 \r
 177         /**\r
 178          * Manages factories for SAMLArtifact plugins.\r
 179          */\r
 180         xmltooling::PluginManager<SAMLArtifact,const char*> SAMLArtifactManager;\r
 181 \r
 182         /**\r
 183          * Manages factories for TrustEngine plugins.\r
 184          */\r
 185         xmltooling::PluginManager<TrustEngine,const DOMElement*> TrustEngineManager;\r
 186 \r
 187         /**\r
 188          * Manages factories for MetadataProvider plugins.\r
 189          */\r
 190         xmltooling::PluginManager<saml2md::MetadataProvider,const DOMElement*> MetadataProviderManager;\r
 191         \r
 192         /**\r
 193          * Manages factories for MetadataFilter plugins.\r
 194          */\r
 195         xmltooling::PluginManager<saml2md::MetadataFilter,const DOMElement*> MetadataFilterManager;\r
 196 \r
 197     protected:\r
 198         SAMLConfig() : m_artifactMap(NULL), m_urlEncoder(NULL) {}\r
 199         \r
 200         /** Global ArtifactMap instance for use by artifact-related functions. */\r
 201         ArtifactMap* m_artifactMap;\r
 202 \r
 203         /** Global URLEncoder instance for use by URL-related functions. */\r
 204         URLEncoder* m_urlEncoder;\r
 205     };\r
 206 \r
 207 #if defined (_MSC_VER)\r
 208     #pragma warning( pop )\r
 209 #endif\r
 210     \r
 211 };\r
 212 \r
 213 #endif /* __saml_config_h__ */\r