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 #include <saml/saml2/metadata/MetadataProvider.h>
  28 #include <xmltooling/security/TrustEngine.h>
  29
  30 namespace shibsp {
  31
  32     class SHIBSP_API Handler;
  33     class SHIBSP_API ServiceProvider;
  34
  35     /**
  36      * Interface to a Shibboleth Application instance.
  37      *
  38      * <p>An Application is a logical set of resources that act as a unit
  39      * of session management and policy.
  40      */
  41     class SHIBSP_API Application : public virtual PropertySet
  42     {
  43         MAKE_NONCOPYABLE(Application);
  44     protected:
  45         Application() {}
  46     public:
  47         virtual ~Application() {}
  48
  49         /**
  50          * Returns the owning ServiceProvider instance.
  51          *
  52          * @return a locked ServiceProvider
  53          */
  54         virtual const ServiceProvider& getServiceProvider() const=0;
  55
  56         /**
  57          * Returns the Application's ID.
  58          *
  59          * @return  the ID
  60          */
  61         virtual const char* getId() const=0;
  62
  63         /**
  64          * Returns a unique hash for the Application.
  65          *
  66          * @return a value resulting from a hash of the Application's ID
  67          */
  68         virtual const char* getHash() const=0;
  69
  70         /**
  71          * Returns the name and cookie properties to use for this Application.
  72          *
  73          * @param prefix    a value to prepend to the base cookie name
  74          * @return  a pair containing the cookie name and the string to append to the cookie value
  75          */
  76         virtual std::pair<std::string,const char*> getCookieNameProps(const char* prefix) const;
  77
  78         /**
  79          * Returns a MetadataProvider for use with this Application.
  80          *
  81          * @return  a MetadataProvider instance, or NULL
  82          */
  83         virtual opensaml::saml2md::MetadataProvider* getMetadataProvider() const=0;
  84
  85         /**
  86          * Returns a TrustEngine for use with this Application.
  87          *
  88          * @return  a TrustEngine instance, or NULL
  89          */
  90         virtual xmltooling::TrustEngine* getTrustEngine() const=0;
  91
  92         /**
  93          * Returns configuration properties governing security interactions with a peer entity.
  94          *
  95          * @param provider  a peer entity's metadata
  96          * @return  the applicable PropertySet
  97          */
  98         virtual const PropertySet* getCredentialUse(const opensaml::saml2md::EntityDescriptor* provider) const=0;
  99
 100         /**
 101          * Returns the default SessionInitiator Handler when automatically
 102          * requesting a session.
 103          *
 104          * @return the default SessionInitiator, or NULL
 105          */
 106         virtual const Handler* getDefaultSessionInitiator() const=0;
 107
 108         /**
 109          * Returns a SessionInitiator Handler with a particular ID when automatically
 110          * requesting a session.
 111          *
 112          * @param id    an identifier unique to the Application
 113          * @return the designated SessionInitiator, or NULL
 114          */
 115         virtual const Handler* getSessionInitiatorById(const char* id) const=0;
 116
 117         /**
 118          * Returns the default AssertionConsumerService Handler
 119          * for use in AuthnRequest messages.
 120          *
 121          * @return the default AssertionConsumerService, or NULL
 122          */
 123         virtual const Handler* getDefaultAssertionConsumerService() const=0;
 124
 125         /**
 126          * Returns an AssertionConsumerService Handler with a particular index
 127          * for use in AuthnRequest messages.
 128          *
 129          * @param index an index unique to an application
 130          * @return the designated AssertionConsumerService, or NULL
 131          */
 132         virtual const Handler* getAssertionConsumerServiceByIndex(unsigned short index) const=0;
 133
 134         /**
 135          * Returns one or more AssertionConsumerService Handlers that support
 136          * a particular protocol binding.
 137          *
 138          * @param binding   a protocol binding identifier
 139          * @return a set of qualifying AssertionConsumerServices
 140          */
 141         virtual const std::vector<const Handler*>& getAssertionConsumerServicesByBinding(const XMLCh* binding) const=0;
 142
 143         /**
 144          * Returns the Handler associated with a particular path/location.
 145          *
 146          * @param path  the PATH_INFO appended to the end of a base Handler location
 147          *              that invokes the Handler
 148          * @return the mapped Handler, or NULL
 149          */
 150         virtual const Handler* getHandler(const char* path) const=0;
 151
 152         /**
 153          * Returns the set of audience values associated with this Application.
 154          *
 155          * @return set of audience values associated with the Application
 156          */
 157         virtual const std::vector<const XMLCh*>& getAudiences() const=0;
 158     };
 159 };
 160
 161 #endif /* __shibsp_app_h__ */