/usr/include/shibsp/ServiceProvider.h is in libshibsp-dev 2.6.1+dfsg1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 | /**
* Licensed to the University Corporation for Advanced Internet
* Development, Inc. (UCAID) under one or more contributor license
* agreements. See the NOTICE file distributed with this work for
* additional information regarding copyright ownership.
*
* UCAID licenses this file to you under the Apache License,
* Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the
* License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific
* language governing permissions and limitations under the License.
*/
/**
* @file shibsp/ServiceProvider.h
*
* Interface to a Shibboleth ServiceProvider instance.
*/
#ifndef __shibsp_sp_h__
#define __shibsp_sp_h__
#include <shibsp/util/PropertySet.h>
#include <set>
#include <vector>
#include <xmltooling/Lockable.h>
namespace xmltooling {
class XMLTOOL_API SOAPTransport;
class XMLTOOL_API StorageService;
};
#ifndef SHIBSP_LITE
namespace opensaml {
class SAML_API SecurityPolicyRule;
};
#endif
namespace shibsp {
class SHIBSP_API Application;
class SHIBSP_API Handler;
class SHIBSP_API ListenerService;
class SHIBSP_API Remoted;
class SHIBSP_API RequestMapper;
class SHIBSP_API SessionCache;
class SHIBSP_API SPRequest;
class SHIBSP_API TemplateParameters;
#ifndef SHIBSP_LITE
class SHIBSP_API SecurityPolicyProvider;
class SHIBSP_API TransactionLog;
#endif
#if defined (_MSC_VER)
#pragma warning( push )
#pragma warning( disable : 4251 )
#endif
/**
* Interface to a Shibboleth ServiceProvider instance.
*
* <p>A ServiceProvider exposes configuration and infrastructure services required
* by the SP implementation, allowing a flexible configuration format.
*/
class SHIBSP_API ServiceProvider : public virtual xmltooling::Lockable, public virtual PropertySet
{
MAKE_NONCOPYABLE(ServiceProvider);
protected:
ServiceProvider();
public:
virtual ~ServiceProvider();
/**
* Loads a configuration and prepares the instance for use.
*
* <p>Implemented as a separate method so that services can rely on
* other services while they initialize by accessing the ServiceProvider
* from the SPConfig singleton.
*/
virtual void init()=0;
#ifndef SHIBSP_LITE
/**
* Returns a TransactionLog instance.
*
* @return a TransactionLog instance
*/
virtual TransactionLog* getTransactionLog() const=0;
/**
* Returns a StorageService instance based on an ID.
*
* @param id a nullptr-terminated key identifying the StorageService to the configuration
* @return a StorageService if available, or nullptr
*/
virtual xmltooling::StorageService* getStorageService(const char* id) const=0;
#endif
/**
* Returns a SessionCache instance.
*
* @param required true iff an exception should be thrown if no SessionCache is available
* @return a SessionCache
*/
virtual SessionCache* getSessionCache(bool required=true) const=0;
/**
* Returns a ListenerService instance.
*
* @param required true iff an exception should be thrown if no ListenerService is available
* @return a ListenerService
*/
virtual ListenerService* getListenerService(bool required=true) const=0;
#ifndef SHIBSP_LITE
/**
* Returns a SecurityPolicyProvider instance.
*
* @param required true iff an exception should be thrown if no SecurityPolicyProvider is available
* @return a SecurityPolicyProvider
*/
virtual SecurityPolicyProvider* getSecurityPolicyProvider(bool required=true) const;
/**
* @deprecated
* Returns the security policy settings for an identified policy.
*
* @param id identifies the policy to return, or nullptr for default
* @return a PropertySet
*/
virtual const PropertySet* getPolicySettings(const char* id) const=0;
/**
* @deprecated
* Returns the security policy rules for an identified policy.
*
* @param id identifies the policy to return, or nullptr for default
* @return an array of policy rules
*/
virtual const std::vector<const opensaml::SecurityPolicyRule*>& getPolicyRules(const char* id) const=0;
/**
* Sets implementation-specific transport options.
*
* @param transport a SOAPTransport object
* @return true iff all options were successfully set
*/
virtual bool setTransportOptions(xmltooling::SOAPTransport& transport) const=0;
#endif
/**
* Returns a RequestMapper instance.
*
* @param required true iff an exception should be thrown if no RequestMapper is available
* @return a RequestMapper
*/
virtual RequestMapper* getRequestMapper(bool required=true) const=0;
/**
* Returns an Application instance matching the specified ID.
*
* @param applicationId the ID of the application, or nullptr for the default
* @return pointer to the application, or nullptr
*/
virtual const Application* getApplication(const char* applicationId) const=0;
/**
* Enforces requirements for an authenticated session.
*
* <p>If the return value's first member is true, then request processing should terminate
* with the second member as a status value. If false, processing can continue.
*
* @param request SP request interface
* @param handler true iff a request to a registered Handler location can be directly executed
* @return a pair containing a "request completed" indicator and a server-specific response code
*/
virtual std::pair<bool,long> doAuthentication(SPRequest& request, bool handler=false) const;
/**
* Enforces authorization requirements based on the authenticated session.
*
* <p>If the return value's first member is true, then request processing should terminate
* with the second member as a status value. If false, processing can continue.
*
* @param request SP request interface
* @return a pair containing a "request completed" indicator and a server-specific response code
*/
virtual std::pair<bool,long> doAuthorization(SPRequest& request) const;
/**
* Publishes session contents to the request in the form of headers or environment variables.
*
* <p>If the return value's first member is true, then request processing should terminate
* with the second member as a status value. If false, processing can continue.
*
* @param request SP request interface
* @param requireSession set to true iff an error should result if no session exists
* @return a pair containing a "request completed" indicator and a server-specific response code
*/
virtual std::pair<bool,long> doExport(SPRequest& request, bool requireSession=true) const;
/**
* Services requests for registered Handler locations.
*
* <p>If the return value's first member is true, then request processing should terminate
* with the second member as a status value. If false, processing can continue.
*
* @param request SP request interface
* @return a pair containing a "request completed" indicator and a server-specific response code
*/
virtual std::pair<bool,long> doHandler(SPRequest& request) const;
/**
* Register for a message. Returns existing remote service, allowing message hooking.
*
* @param address message address to register
* @param svc pointer to remote service
* @return previous service registered for message, if any
*/
virtual Remoted* regListener(const char* address, Remoted* svc);
/**
* Unregisters service from an address, possibly restoring an original.
*
* @param address message address to modify
* @param current pointer to unregistering service
* @param restore service to "restore" registration for
* @return true iff the current service was still registered
*/
virtual bool unregListener(const char* address, Remoted* current, Remoted* restore=nullptr);
/**
* Returns current service registered at an address, if any.
*
* @param address message address to access
* @return registered service, or nullptr
*/
virtual Remoted* lookupListener(const char* address) const;
protected:
/** The AuthTypes to "recognize" (defaults to "shibboleth"). */
std::set<std::string> m_authTypes;
private:
std::map<std::string,Remoted*> m_listenerMap;
};
#if defined (_MSC_VER)
#pragma warning( pop )
#endif
/**
* Registers ServiceProvider classes into the runtime.
*/
void SHIBSP_API registerServiceProviders();
/** SP based on integrated XML and native server configuration. */
#define XML_SERVICE_PROVIDER "XML"
};
#endif /* __shibsp_sp_h__ */
|