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 namespace shibtarget {
  80
  81     // An implementation of the URL->application mapping API using an XML file
  82     class XMLApplicationMapper : public IApplicationMapper, public shibboleth::ReloadableXMLFile
  83     {
  84     public:
  85         XMLApplicationMapper(const char* pathname) : shibboleth::ReloadableXMLFile(pathname) {}
  86         ~XMLApplicationMapper() {}
  87
  88         const char* getApplicationFromURL(const char* url) const;
  89         const XMLCh* getXMLChApplicationFromURL(const char* url) const;
  90         const char* getApplicationFromParsedURL(
  91             const char* scheme, const char* hostname, unsigned int port, const char* path=NULL
  92             ) const;
  93         const XMLCh* getXMLChApplicationFromParsedURL(
  94             const char* scheme, const char* hostname, unsigned int port, const char* path=NULL
  95             ) const;
  96
  97     protected:
  98         virtual shibboleth::ReloadableXMLFileImpl* newImplementation(const char* pathname) const;
  99     };
 100
 101     class STConfig : public ShibTargetConfig
 102     {
 103     public:
 104         STConfig(const char* app_name, const char* inifile);
 105         ~STConfig();
 106         void ref();
 107         void init();
 108         void shutdown();
 109         ShibINI& getINI() const { return *ini; }
 110         IApplicationMapper* getApplicationMapper() const { return m_applicationMapper; }
 111         saml::Iterator<shibboleth::IMetadata*> getMetadataProviders() const { return metadatas; }
 112         saml::Iterator<shibboleth::ITrust*> getTrustProviders() const { return trusts; }
 113         saml::Iterator<shibboleth::ICredentials*> getCredentialProviders() const { return creds; }
 114         saml::Iterator<shibboleth::IAAP*> getAAPProviders() const { return aaps; }
 115         saml::Iterator<const XMLCh*> getPolicies() const { return saml::Iterator<const XMLCh*>(policies); }
 116
 117     private:
 118         saml::SAMLConfig& samlConf;
 119         shibboleth::ShibConfig& shibConf;
 120         ShibINI* ini;
 121         std::string m_app_name;
 122         int refcount;
 123         std::vector<const XMLCh*> policies;
 124         std::string m_SocketName;
 125 #ifdef WANT_TCP_SHAR
 126         std::vector<std::string> m_SocketACL;
 127 #endif
 128         IApplicationMapper* m_applicationMapper;
 129         std::vector<shibboleth::IMetadata*> metadatas;
 130         std::vector<shibboleth::ITrust*> trusts;
 131         std::vector<shibboleth::ICredentials*> creds;
 132         std::vector<shibboleth::IAAP*> aaps;
 133
 134         friend const char* ::shib_target_sockname();
 135         friend const char* ::shib_target_sockacl(unsigned int);
 136     };
 137
 138     class XML
 139     {
 140     public:
 141         // URI constants
 142         static const XMLCh APPMAP_NS[];
 143         static const XMLCh APPMAP_SCHEMA_ID[];
 144
 145         struct Literals
 146         {
 147             static const XMLCh ApplicationID[];
 148             static const XMLCh ApplicationMap[];
 149             static const XMLCh Host[];
 150             static const XMLCh Path[];
 151             static const XMLCh Port[];
 152             static const XMLCh Scheme[];
 153         };
 154     };
 155 }
 156
 157 #endif
 158
 159 #endif