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 SAMLArtifact;\r
  40     class SAML_API TrustEngine;\r
  41 \r
  42     namespace saml2md {\r
  43         class SAML_API MetadataProvider;\r
  44         class SAML_API MetadataFilter;\r
  45     };\r
  46 \r
  47 #if defined (_MSC_VER)\r
  48     #pragma warning( push )\r
  49     #pragma warning( disable : 4250 4251 )\r
  50 #endif\r
  51 \r
  52     /**\r
  53      * Singleton object that manages library startup/shutdown.configuration.\r
  54      */\r
  55     class SAML_API SAMLConfig\r
  56     {\r
  57     MAKE_NONCOPYABLE(SAMLConfig);\r
  58     public:\r
  59         virtual ~SAMLConfig() {}\r
  60 \r
  61         /**\r
  62          * Returns the global configuration object for the library.\r
  63          * \r
  64          * @return reference to the global library configuration object\r
  65          */\r
  66         static SAMLConfig& getConfig();\r
  67         \r
  68         /**\r
  69          * Initializes library\r
  70          * \r
  71          * Each process using the library MUST call this function exactly once\r
  72          * before using any library classes. The flag controls whether this is the\r
  73          * "dominant" library or not and can allow the SAML library to be loaded\r
  74          * as an extension of XMLTooling rather than subsuming it.\r
  75          * \r
  76          * @param initXMLTooling true iff this method should initialize the XMLTooling layer\r
  77          * @return true iff initialization was successful \r
  78          */\r
  79         virtual bool init(bool initXMLTooling=true)=0;\r
  80         \r
  81         /**\r
  82          * Shuts down library\r
  83          * \r
  84          * Each process using the library SHOULD call this function exactly once\r
  85          * before terminating itself. The flag controls whether this is the\r
  86          * "dominant" library or not and can allow the SAML library to be loaded\r
  87          * as an extension of XMLTooling rather than subsuming it.\r
  88          * \r
  89          * @param termXMLTooling true iff this method should shutdown the XMLTooling layer\r
  90          */\r
  91         virtual void term(bool termXMLTooling=true)=0;\r
  92         \r
  93         /**\r
  94          * Generate random information using the underlying security library\r
  95          * \r
  96          * @param buf   buffer for the information\r
  97          * @param len   number of bytes to write into buffer\r
  98          */\r
  99         virtual void generateRandomBytes(void* buf, unsigned int len)=0;\r
 100 \r
 101         /**\r
 102          * Generate random information using the underlying security library\r
 103          * \r
 104          * @param buf   string buffer for the information\r
 105          * @param len   number of bytes to write into buffer\r
 106          */\r
 107         virtual void generateRandomBytes(std::string& buf, unsigned int len)=0;\r
 108 \r
 109         /**\r
 110          * Generate a valid XML identifier of the form _X{32} where X is a\r
 111          * random hex character. The caller is responsible for freeing the result.\r
 112          * \r
 113          * @return a valid null-terminated XML ID\r
 114          */\r
 115         virtual XMLCh* generateIdentifier()=0;\r
 116         \r
 117         /**\r
 118          * Generate the SHA-1 hash of a string\r
 119          * \r
 120          * @param s     NULL-terminated string to hash\r
 121          * @param toHex true iff the result should be encoded in hexadecimal form or left as raw bytes\r
 122          *  \r
 123          * @return  SHA-1 hash of the data\r
 124          */\r
 125         virtual std::string hashSHA1(const char* s, bool toHex=false)=0;\r
 126         \r
 127         /**\r
 128          * Manages factories for MetadataProvider plugins.\r
 129          */\r
 130         xmltooling::PluginManager<saml2md::MetadataProvider,const DOMElement*> MetadataProviderManager;\r
 131         \r
 132         /**\r
 133          * Manages factories for MetadataFilter plugins.\r
 134          */\r
 135         xmltooling::PluginManager<saml2md::MetadataFilter,const DOMElement*> MetadataFilterManager;\r
 136 \r
 137         /**\r
 138          * Manages factories for SAMLArtifact plugins.\r
 139          */\r
 140         xmltooling::PluginManager<SAMLArtifact,const char*> SAMLArtifactManager;\r
 141 \r
 142         /**\r
 143          * Manages factories for TrustEngine plugins.\r
 144          */\r
 145         xmltooling::PluginManager<TrustEngine,const DOMElement*> TrustEngineManager;\r
 146 \r
 147     protected:\r
 148         SAMLConfig() {}\r
 149     };\r
 150 \r
 151 #if defined (_MSC_VER)\r
 152     #pragma warning( pop )\r
 153 #endif\r
 154     \r
 155 };\r
 156 \r
 157 #endif /* __saml_config_h__ */\r