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 #ifdef __cplusplus
  76
  77 #include "ccache-utils.h"
  78
  79 #include <log4cpp/Category.hh>
  80
  81 namespace shibtarget {
  82
  83     // Wraps the actual RPC connection
  84     class RPCHandle
  85     {
  86     public:
  87         RPCHandle(const char* shar, u_long program, u_long version);
  88         ~RPCHandle();
  89
  90         CLIENT* connect(void);  // connects and returns the CLIENT handle
  91         void disconnect();      // disconnects, should not return disconnected handles to pool!
  92
  93     private:
  94         log4cpp::Category* log;
  95         const char* m_shar;
  96         u_long m_program;
  97         u_long m_version;
  98         CLIENT*  m_clnt;
  99         ShibSocket m_sock;
 100     };
 101
 102     // Manages the pool of connections
 103     class RPCHandlePool
 104     {
 105     public:
 106         RPCHandlePool() :  m_lock(shibboleth::Mutex::create()) {}
 107         ~RPCHandlePool();
 108         RPCHandle* get();
 109         void put(RPCHandle*);
 110
 111     private:
 112         std::auto_ptr<shibboleth::Mutex> m_lock;
 113         std::stack<RPCHandle*> m_pool;
 114     };
 115
 116     // Cleans up after use
 117     class RPC
 118     {
 119     public:
 120         RPC();
 121         ~RPC() {delete m_handle;}
 122         RPCHandle* operator->() {return m_handle;}
 123         void pool() {m_pool.put(m_handle); m_handle=NULL;}
 124
 125     private:
 126         RPCHandlePool& m_pool;
 127         RPCHandle* m_handle;
 128     };
 129
 130     // An implementation of the URL->application mapping API using an XML file
 131     class XMLApplicationMapper : public IApplicationMapper, public shibboleth::ReloadableXMLFile
 132     {
 133     public:
 134         XMLApplicationMapper(const DOMElement* e) : shibboleth::ReloadableXMLFile(e) {}
 135         ~XMLApplicationMapper() {}
 136
 137         const char* getApplicationFromURL(const char* url) const;
 138         const XMLCh* getXMLChApplicationFromURL(const char* url) const;
 139         const char* getApplicationFromParsedURL(
 140             const char* scheme, const char* hostname, unsigned int port, const char* path=NULL
 141             ) const;
 142         const XMLCh* getXMLChApplicationFromParsedURL(
 143             const char* scheme, const char* hostname, unsigned int port, const char* path=NULL
 144             ) const;
 145
 146     protected:
 147         virtual shibboleth::ReloadableXMLFileImpl* newImplementation(const char* pathname) const;
 148         virtual shibboleth::ReloadableXMLFileImpl* newImplementation(const DOMElement* e) const;
 149     };
 150
 151     class STConfig : public ShibTargetConfig
 152     {
 153     public:
 154         STConfig(const char* app_name, const char* inifile);
 155         ~STConfig();
 156         void ref();
 157         void init();
 158         void shutdown();
 159         ShibINI& getINI() const { return *ini; }
 160         IApplicationMapper* getApplicationMapper() const { return m_applicationMapper; }
 161         saml::Iterator<shibboleth::IMetadata*> getMetadataProviders() const { return metadatas; }
 162         saml::Iterator<shibboleth::IRevocation*> getRevocationProviders() const { return revocations; }
 163         saml::Iterator<shibboleth::ITrust*> getTrustProviders() const { return trusts; }
 164         saml::Iterator<shibboleth::ICredentials*> getCredentialProviders() const { return creds; }
 165         saml::Iterator<shibboleth::IAAP*> getAAPProviders() const { return aaps; }
 166         saml::Iterator<const XMLCh*> getPolicies() const { return saml::Iterator<const XMLCh*>(policies); }
 167         RPCHandlePool& getRPCHandlePool() { return m_rpcpool; }
 168
 169     private:
 170         saml::SAMLConfig& samlConf;
 171         shibboleth::ShibConfig& shibConf;
 172         ShibINI* ini;
 173         std::string m_app_name;
 174         int refcount;
 175         std::vector<const XMLCh*> policies;
 176         std::string m_SocketName;
 177 #ifdef WANT_TCP_SHAR
 178         std::vector<std::string> m_SocketACL;
 179 #endif
 180         IApplicationMapper* m_applicationMapper;
 181         std::vector<shibboleth::IMetadata*> metadatas;
 182         std::vector<shibboleth::IRevocation*> revocations;
 183         std::vector<shibboleth::ITrust*> trusts;
 184         std::vector<shibboleth::ICredentials*> creds;
 185         std::vector<shibboleth::IAAP*> aaps;
 186
 187         RPCHandlePool m_rpcpool;
 188
 189         friend const char* ::shib_target_sockname();
 190         friend const char* ::shib_target_sockacl(unsigned int);
 191     };
 192
 193     class XML
 194     {
 195     public:
 196         // URI constants
 197         static const XMLCh APPMAP_NS[];
 198         static const XMLCh APPMAP_SCHEMA_ID[];
 199
 200         struct Literals
 201         {
 202             static const XMLCh ApplicationID[];
 203             static const XMLCh ApplicationMap[];
 204             static const XMLCh Host[];
 205             static const XMLCh Name[];
 206             static const XMLCh Path[];
 207             static const XMLCh Port[];
 208             static const XMLCh Scheme[];
 209         };
 210     };
 211 }
 212
 213 #endif
 214
 215 #endif