shib-target/internal.h

   1 /*
   2  * The Shibboleth License, Version 1.
   3  * Copyright (c) 2002
   4  * University Corporation for Advanced Internet Development, Inc.
   5  * All rights reserved
   6  *
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions are met:
  10  *
  11  * Redistributions of source code must retain the above copyright notice, this
  12  * list of conditions and the following disclaimer.
  13  *
  14  * Redistributions in binary form must reproduce the above copyright notice,
  15  * this list of conditions and the following disclaimer in the documentation
  16  * and/or other materials provided with the distribution, if any, must include
  17  * the following acknowledgment: "This product includes software developed by
  18  * the University Corporation for Advanced Internet Development
  19  * <http://www.ucaid.edu>Internet2 Project. Alternately, this acknowledegement
  20  * may appear in the software itself, if and wherever such third-party
  21  * acknowledgments normally appear.
  22  *
  23  * Neither the name of Shibboleth nor the names of its contributors, nor
  24  * Internet2, nor the University Corporation for Advanced Internet Development,
  25  * Inc., nor UCAID may be used to endorse or promote products derived from this
  26  * software without specific prior written permission. For written permission,
  27  * please contact shibboleth@shibboleth.org
  28  *
  29  * Products derived from this software may not be called Shibboleth, Internet2,
  30  * UCAID, or the University Corporation for Advanced Internet Development, nor
  31  * may Shibboleth appear in their name, without prior written permission of the
  32  * University Corporation for Advanced Internet Development.
  33  *
  34  *
  35  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  36  * AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  37  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
  38  * PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE DISCLAIMED AND THE ENTIRE RISK
  39  * OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH LICENSEE.
  40  * IN NO EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY
  41  * CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC. BE LIABLE FOR ANY DIRECT,
  42  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  43  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  44  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  46  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  47  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  48  */
  49
  50
  51 /* internal.h - internally visible declarations
  52
  53    Scott Cantor
  54    6/29/03
  55
  56    $History:$
  57 */
  58
  59 #ifndef __shibtarget_internal_h__
  60 #define __shibtarget_internal_h__
  61
  62 #ifdef WIN32
  63 # define SHIBTARGET_EXPORTS __declspec(dllexport)
  64 #endif
  65
  66 // eventually we might be able to support autoconf via cygwin...
  67 #if defined (_MSC_VER) || defined(__BORLANDC__)
  68 # include "config_win32.h"
  69 #else
  70 # include "config.h"
  71 #endif
  72
  73 #include "shib-target.h"
  74
  75 #include <log4cpp/Category.hh>
  76 #include <log4cpp/FixedContextCategory.hh>
  77
  78 #define SHIBT_L(s) shibtarget::XML::Literals::s
  79 #define SHIBT_L_QNAME(p,s) shibtarget::XML::Literals::p##_##s
  80 #define SHIBTRAN_LOGCAT "Shibboleth-TRANSACTION"
  81
  82 // Controls default logging level of console tools and other situations
  83 // where full shibboleth.xml-based logging isn't used.
  84 #define SHIB_LOGGING "WARN"
  85
  86 namespace shibtarget {
  87
  88     // Wraps the actual RPC connection
  89     class RPCHandle
  90     {
  91     public:
  92         RPCHandle();
  93         ~RPCHandle();
  94
  95         CLIENT* connect(void);  // connects and returns the CLIENT handle
  96         void disconnect();      // disconnects, should not return disconnected handles to pool!
  97
  98     private:
  99         log4cpp::Category* log;
 100         CLIENT* m_clnt;
 101         IListener::ShibSocket m_sock;
 102     };
 103
 104     // Manages the pool of connections
 105     class RPCHandlePool
 106     {
 107     public:
 108         RPCHandlePool() :  m_lock(shibboleth::Mutex::create()) {}
 109         ~RPCHandlePool();
 110         RPCHandle* get();
 111         void put(RPCHandle*);
 112
 113     private:
 114         std::auto_ptr<shibboleth::Mutex> m_lock;
 115         std::stack<RPCHandle*> m_pool;
 116     };
 117
 118     // Cleans up after use
 119     class RPC
 120     {
 121     public:
 122         RPC();
 123         ~RPC() {delete m_handle;}
 124         RPCHandle* operator->() {return m_handle;}
 125         void pool() {m_pool.put(m_handle); m_handle=NULL;}
 126
 127     private:
 128         RPCHandlePool& m_pool;
 129         RPCHandle* m_handle;
 130     };
 131
 132     // Generic class, which handles the IPropertySet configuration interface.
 133     // Most of the basic configuration details are exposed via this interface.
 134     // This implementation extracts the XML tree structure and caches it in a map
 135     // with the attributes stored in the various possible formats they might be fetched.
 136     // Elements are treated as nested IPropertySets.
 137     // The "trick" to this is to pass in an "exclude list" using a DOMNodeFilter. Nested
 138     // property sets are extracted by running a TreeWalker againt the filter for the
 139     // immediate children. The filter should skip any excluded elements that will be
 140     // processed separately.
 141     class XMLPropertySet : public virtual IPropertySet
 142     {
 143     public:
 144         XMLPropertySet() {}
 145         ~XMLPropertySet();
 146
 147         std::pair<bool,bool> getBool(const char* name, const char* ns=NULL) const;
 148         std::pair<bool,const char*> getString(const char* name, const char* ns=NULL) const;
 149         std::pair<bool,const XMLCh*> getXMLString(const char* name, const char* ns=NULL) const;
 150         std::pair<bool,unsigned int> getUnsignedInt(const char* name, const char* ns=NULL) const;
 151         std::pair<bool,int> getInt(const char* name, const char* ns=NULL) const;
 152         const IPropertySet* getPropertySet(const char* name, const char* ns="urn:mace:shibboleth:target:config:1.0") const;
 153         const DOMElement* getElement() const {return m_root;}
 154
 155     protected:
 156         void load(const DOMElement* e, log4cpp::Category& log, DOMNodeFilter* filter);
 157
 158     private:
 159         const DOMElement* m_root;
 160         std::map<std::string,std::pair<char*,const XMLCh*> > m_map;
 161         std::map<std::string,IPropertySet*> m_nested;
 162     };
 163
 164     class STConfig : public ShibTargetConfig
 165     {
 166     public:
 167         STConfig() : m_tranLog(NULL), m_tranLogLock(NULL) {}
 168         ~STConfig() {}
 169
 170         bool init(const char* schemadir, const char* config);
 171         void shutdown();
 172
 173         RPCHandlePool& getRPCHandlePool() {return m_rpcpool;}
 174         log4cpp::Category& getTransactionLog() { m_tranLogLock->lock(); return *m_tranLog; }
 175         void releaseTransactionLog() { m_tranLogLock->unlock();}
 176     private:
 177         RPCHandlePool m_rpcpool;
 178         log4cpp::FixedContextCategory* m_tranLog;
 179         shibboleth::Mutex* m_tranLogLock;
 180         static IConfig* ShibTargetConfigFactory(const DOMElement* e);
 181     };
 182
 183     class XML
 184     {
 185     public:
 186         static const XMLCh SHIBTARGET_SCHEMA_ID[];
 187
 188         static const char htaccessType[];
 189         static const char MemorySessionCacheType[];
 190         static const char MySQLSessionCacheType[];
 191         static const char RequestMapType[];
 192         static const char TCPListenerType[];
 193         static const char UnixListenerType[];
 194
 195         struct Literals
 196         {
 197             static const XMLCh AAPProvider[];
 198             static const XMLCh AccessControlProvider[];
 199             static const XMLCh AND[];
 200             static const XMLCh applicationId[];
 201             static const XMLCh Application[];
 202             static const XMLCh Applications[];
 203             static const XMLCh CredentialsProvider[];
 204             static const XMLCh CredentialUse[];
 205             static const XMLCh Extensions[];
 206             static const XMLCh fatal[];
 207             static const XMLCh FederationProvider[];
 208             static const XMLCh Host[];
 209             static const XMLCh htaccess[];
 210             static const XMLCh Implementation[];
 211             static const XMLCh Library[];
 212             static const XMLCh Listener[];
 213             static const XMLCh logger[];
 214             static const XMLCh MemorySessionCache[];
 215             static const XMLCh MySQLSessionCache[];
 216             static const XMLCh name[];
 217             static const XMLCh Name[];
 218             static const XMLCh NOT[];
 219             static const XMLCh OR[];
 220             static const XMLCh Path[];
 221             static const XMLCh path[];
 222             static const XMLCh RelyingParty[];
 223             static const XMLCh RequestMap[];
 224             static const XMLCh RequestMapProvider[];
 225             static const XMLCh require[];
 226             static const XMLCh RevocationProvider[];
 227             static const XMLCh Rule[];
 228             static const XMLCh SessionCache[];
 229             static const XMLCh SHAR[];
 230             static const XMLCh ShibbolethTargetConfig[];
 231             static const XMLCh SHIRE[];
 232             static const XMLCh Signing[];
 233             static const XMLCh TCPListener[];
 234             static const XMLCh TLS[];
 235             static const XMLCh TrustProvider[];
 236             static const XMLCh type[];
 237             static const XMLCh UnixListener[];
 238         };
 239     };
 240 }
 241
 242 #endif