shibsp/Application.h

   1 /*
   2  *  Copyright 2001-2007 Internet2
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * @file shibsp/Application.h
  19  *
  20  * Interface to a Shibboleth Application instance.
  21  */
  22
  23 #ifndef __shibsp_app_h__
  24 #define __shibsp_app_h__
  25
  26 #include <shibsp/util/PropertySet.h>
  27
  28 #include <set>
  29 #ifndef SHIBSP_LITE
  30 # include <saml/saml2/metadata/MetadataProvider.h>
  31 # include <xmltooling/security/CredentialResolver.h>
  32 # include <xmltooling/security/TrustEngine.h>
  33 #endif
  34
  35 namespace shibsp {
  36
  37 #ifndef SHIBSP_LITE
  38     class SHIBSP_API AttributeExtractor;
  39     class SHIBSP_API AttributeFilter;
  40     class SHIBSP_API AttributeResolver;
  41 #endif
  42     class SHIBSP_API Handler;
  43     class SHIBSP_API ServiceProvider;
  44     class SHIBSP_API SessionInitiator;
  45     class SHIBSP_API SPRequest;
  46
  47     /**
  48      * Interface to a Shibboleth Application instance.
  49      *
  50      * <p>An Application is a logical set of resources that act as a unit
  51      * of session management and policy.
  52      */
  53     class SHIBSP_API Application : public virtual PropertySet
  54     {
  55         MAKE_NONCOPYABLE(Application);
  56     protected:
  57         Application() {}
  58     public:
  59         virtual ~Application() {}
  60
  61         /**
  62          * Returns the owning ServiceProvider instance.
  63          *
  64          * @return a locked ServiceProvider
  65          */
  66         virtual const ServiceProvider& getServiceProvider() const=0;
  67
  68         /**
  69          * Returns the Application's ID.
  70          *
  71          * @return  the ID
  72          */
  73         virtual const char* getId() const=0;
  74
  75         /**
  76          * Returns a unique hash for the Application.
  77          *
  78          * @return a value resulting from a computation over the Application's configuration
  79          */
  80         virtual const char* getHash() const=0;
  81
  82         /**
  83          * Returns the name and cookie properties to use for this Application.
  84          *
  85          * @param prefix    a value to prepend to the base cookie name
  86          * @return  a pair containing the cookie name and the string to append to the cookie value
  87          */
  88         virtual std::pair<std::string,const char*> getCookieNameProps(const char* prefix) const;
  89
  90 #ifndef SHIBSP_LITE
  91         /**
  92          * Returns a MetadataProvider for use with this Application.
  93          *
  94          * @param required  true iff an exception should be thrown if no MetadataProvider is available
  95          * @return  a MetadataProvider instance, or NULL
  96          */
  97         virtual opensaml::saml2md::MetadataProvider* getMetadataProvider(bool required=true) const=0;
  98
  99         /**
 100          * Returns a TrustEngine for use with this Application.
 101          *
 102          * @param required  true iff an exception should be thrown if no TrustEngine is available
 103          * @return  a TrustEngine instance, or NULL
 104          */
 105         virtual xmltooling::TrustEngine* getTrustEngine(bool required=true) const=0;
 106
 107         /**
 108          * Returns an AttributeExtractor for use with this Application.
 109          *
 110          * @return  an AttributeExtractor, or NULL
 111          */
 112         virtual AttributeExtractor* getAttributeExtractor() const=0;
 113
 114         /**
 115          * Returns an AttributeFilter for use with this Application.
 116          *
 117          * @return  an AttributeFilter, or NULL
 118          */
 119         virtual AttributeFilter* getAttributeFilter() const=0;
 120
 121         /**
 122          * Returns an AttributeResolver for use with this Application.
 123          *
 124          * @return  an AttributeResolver, or NULL
 125          */
 126         virtual AttributeResolver* getAttributeResolver() const=0;
 127
 128         /**
 129          * Returns the CredentialResolver instance associated with this Application.
 130          *
 131          * @return  a CredentialResolver, or NULL
 132          */
 133         virtual xmltooling::CredentialResolver* getCredentialResolver() const=0;
 134
 135         /**
 136          * Returns configuration properties governing security interactions with a peer.
 137          *
 138          * @param provider  a peer entity's metadata
 139          * @return  the applicable PropertySet
 140          */
 141         virtual const PropertySet* getRelyingParty(const opensaml::saml2md::EntityDescriptor* provider) const=0;
 142
 143         /**
 144          * Returns the set of audience values associated with this Application.
 145          *
 146          * @return set of audience values associated with the Application
 147          */
 148         virtual const std::vector<const XMLCh*>& getAudiences() const=0;
 149 #endif
 150
 151         /**
 152          * Returns a set of attribute IDs to use as a REMOTE_USER value.
 153          * <p>The first attribute with a value (and only a single value) will be used.
 154          *
 155          * @return  a set of attribute IDs, or an empty set
 156          */
 157         virtual const std::set<std::string>& getRemoteUserAttributeIds() const=0;
 158
 159         /**
 160          * Clears any headers that may be used to hold attributes after export.
 161          *
 162          * @param request   SP request to clear
 163          */
 164         virtual void clearAttributeHeaders(SPRequest& request) const=0;
 165
 166         /**
 167          * Returns the default SessionInitiator when automatically requesting a session.
 168          *
 169          * @return the default SessionInitiator, or NULL
 170          */
 171         virtual const SessionInitiator* getDefaultSessionInitiator() const=0;
 172
 173         /**
 174          * Returns a SessionInitiator with a particular ID when automatically requesting a session.
 175          *
 176          * @param id    an identifier unique to the Application
 177          * @return the designated SessionInitiator, or NULL
 178          */
 179         virtual const SessionInitiator* getSessionInitiatorById(const char* id) const=0;
 180
 181         /**
 182          * Returns the default AssertionConsumerService Handler
 183          * for use in AuthnRequest messages.
 184          *
 185          * @return the default AssertionConsumerService, or NULL
 186          */
 187         virtual const Handler* getDefaultAssertionConsumerService() const=0;
 188
 189         /**
 190          * Returns an AssertionConsumerService Handler with a particular index
 191          * for use in AuthnRequest messages.
 192          *
 193          * @param index an index unique to an application
 194          * @return the designated AssertionConsumerService, or NULL
 195          */
 196         virtual const Handler* getAssertionConsumerServiceByIndex(unsigned short index) const=0;
 197
 198         /**
 199          * Returns one or more AssertionConsumerService Handlers that support
 200          * a particular protocol binding.
 201          *
 202          * @param binding   a protocol binding identifier
 203          * @return a set of qualifying AssertionConsumerServices
 204          */
 205         virtual const std::vector<const Handler*>& getAssertionConsumerServicesByBinding(const XMLCh* binding) const=0;
 206
 207         /**
 208          * Returns the Handler associated with a particular path/location.
 209          *
 210          * @param path  the PATH_INFO appended to the end of a base Handler location
 211          *              that invokes the Handler
 212          * @return the mapped Handler, or NULL
 213          */
 214         virtual const Handler* getHandler(const char* path) const=0;
 215     };
 216 };
 217
 218 #endif /* __shibsp_app_h__ */