/*
- * Copyright 2001-2005 Internet2
+ * Copyright 2001-2007 Internet2
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#ifndef SHIB_TARGET_H
#define SHIB_TARGET_H
+// New headers
+#include <shibsp/Application.h>
+#include <shibsp/Handler.h>
+#include <shibsp/RequestMapper.h>
+#include <shibsp/ServiceProvider.h>
+#include <shibsp/SessionCache.h>
+#include <shibsp/remoting/ListenerService.h>
+
+// Old headers
#include <saml/saml.h>
#include <shib/shib.h>
-#include <shib/shib-threads.h>
#ifdef WIN32
# ifndef SHIBTARGET_EXPORTS
# define SHIBTARGET_EXPORTS
#endif
-#include <shib-target/ddf.h>
-
namespace shibtarget {
- DECLARE_SAML_EXCEPTION(SHIBTARGET_EXPORTS,ListenerException,SAMLException);
- DECLARE_SAML_EXCEPTION(SHIBTARGET_EXPORTS,ConfigurationException,SAMLException);
-
// Abstract APIs for access to configuration information
/**
- * Interface to a generic set of typed properties or a DOM container of additional
- * data.
- */
- struct SHIBTARGET_EXPORTS IPropertySet
- {
- virtual std::pair<bool,bool> getBool(const char* name, const char* ns=NULL) const=0;
- virtual std::pair<bool,const char*> getString(const char* name, const char* ns=NULL) const=0;
- virtual std::pair<bool,const XMLCh*> getXMLString(const char* name, const char* ns=NULL) const=0;
- virtual std::pair<bool,unsigned int> getUnsignedInt(const char* name, const char* ns=NULL) const=0;
- virtual std::pair<bool,int> getInt(const char* name, const char* ns=NULL) const=0;
- virtual const IPropertySet* getPropertySet(const char* name, const char* ns="urn:mace:shibboleth:target:config:1.0") const=0;
- virtual const DOMElement* getElement() const=0;
- virtual ~IPropertySet() {}
- };
-
- // Forward declaration
- class SHIBTARGET_EXPORTS ShibTarget;
-
- /**
- * Interface to a protocol handler
- *
- * Protocol handlers perform system functions such as processing SAML protocol
- * messages to create and logout sessions or creating protocol requests.
- */
- struct SHIBTARGET_EXPORTS IHandler : public virtual saml::IPlugIn
- {
- IHandler() : m_props(NULL) {}
- virtual ~IHandler() {}
- virtual const IPropertySet* getProperties() const { return m_props; }
- virtual void setProperties(const IPropertySet* properties) { m_props=properties; }
- virtual std::pair<bool,void*> run(ShibTarget* st, bool isHandler=true) const=0;
- private:
- const IPropertySet* m_props;
- };
-
- /**
* Interface to Shibboleth Applications, which exposes most of the functionality
* required to process web requests or security protocol messages for resources
* associated with them.
* Application. Implementations should always expose an application named "default"
* as a last resort.
*/
- struct SHIBTARGET_EXPORTS IApplication : public virtual IPropertySet,
+ struct SHIBTARGET_EXPORTS IApplication : public virtual shibsp::Application,
public virtual shibboleth::ShibBrowserProfile::ITokenValidator
{
- virtual const char* getId() const=0;
- virtual const char* getHash() const=0;
-
- virtual saml::Iterator<saml::SAMLAttributeDesignator*> getAttributeDesignators() const=0;
- virtual saml::Iterator<shibboleth::IAAP*> getAAPProviders() const=0;
- virtual saml::Iterator<shibboleth::IMetadata*> getMetadataProviders() const=0;
- virtual saml::Iterator<shibboleth::ITrust*> getTrustProviders() const=0;
- virtual saml::Iterator<const XMLCh*> getAudiences() const=0;
- virtual const IPropertySet* getCredentialUse(const shibboleth::IEntityDescriptor* provider) const=0;
-
// caller is borrowing object, must use within scope of config lock
virtual const saml::SAMLBrowserProfile* getBrowserProfile() const=0;
virtual const saml::SAMLBinding* getBinding(const XMLCh* binding) const=0;
virtual void validateToken(
saml::SAMLAssertion* token,
time_t t=0,
- const shibboleth::IRoleDescriptor* role=NULL,
- const saml::Iterator<shibboleth::ITrust*>& trusts=EMPTY(shibboleth::ITrust*)
+ const opensaml::saml2md::RoleDescriptor* role=NULL,
+ const xmltooling::TrustEngine* trust=NULL
) const=0;
- // Used to locate a default or designated session initiator for automatic sessions
- virtual const IHandler* getDefaultSessionInitiator() const=0;
- virtual const IHandler* getSessionInitiatorById(const char* id) const=0;
-
- // Used by session initiators to get endpoint to forward to IdP/WAYF
- virtual const IHandler* getDefaultAssertionConsumerService() const=0;
- virtual const IHandler* getAssertionConsumerServiceByIndex(unsigned short index) const=0;
- virtual saml::Iterator<const IHandler*> getAssertionConsumerServicesByBinding(const XMLCh* binding) const=0;
-
- // Used by dispatcher to locate the handler for a request
- virtual const IHandler* getHandler(const char* path) const=0;
-
virtual ~IApplication() {}
};
class ShibHTTPHook : virtual public saml::SAMLSOAPHTTPBinding::HTTPHook
{
public:
- ShibHTTPHook(const saml::Iterator<shibboleth::ITrust*>& trusts, const saml::Iterator<shibboleth::ICredentials*>& creds)
- : m_trusts(trusts), m_creds(creds) {}
+ ShibHTTPHook(const xmltooling::TrustEngine* trust) : m_trust(trust) {}
virtual ~ShibHTTPHook() {}
// Only hook we need here is for outgoing connection to server.
// Client declares a context object and pass as callCtx to send() method.
class ShibHTTPHookCallContext {
public:
- ShibHTTPHookCallContext(const IPropertySet* credUse, const shibboleth::IRoleDescriptor* role)
+ ShibHTTPHookCallContext(const shibsp::PropertySet* credUse, const opensaml::saml2md::RoleDescriptor* role)
: m_credUse(credUse), m_role(role), m_hook(NULL), m_authenticated(false) {}
const ShibHTTPHook* getHook() {return m_hook;}
- const IPropertySet* getCredentialUse() {return m_credUse;}
- const shibboleth::IRoleDescriptor* getRoleDescriptor() {return m_role;}
+ const shibsp::PropertySet* getCredentialUse() {return m_credUse;}
+ const opensaml::saml2md::RoleDescriptor* getRoleDescriptor() {return m_role;}
bool isAuthenticated() const {return m_authenticated;}
void setAuthenticated() {m_authenticated=true;}
private:
- const IPropertySet* m_credUse;
- const shibboleth::IRoleDescriptor* m_role;
+ const shibsp::PropertySet* m_credUse;
+ const opensaml::saml2md::RoleDescriptor* m_role;
ShibHTTPHook* m_hook;
bool m_authenticated;
friend class ShibHTTPHook;
};
- const saml::Iterator<shibboleth::ITrust*>& getTrustProviders() const {return m_trusts;}
- const saml::Iterator<shibboleth::ICredentials*>& getCredentialProviders() const {return m_creds;}
+ const xmltooling::TrustEngine* getTrustEngine() const {return m_trust;}
private:
- saml::Iterator<shibboleth::ITrust*> m_trusts;
- saml::Iterator<shibboleth::ICredentials*> m_creds;
+ const xmltooling::TrustEngine* m_trust;
};
/**
* remote and/or optimize calls by implementing custom versions of the
* ISessionCacheEntry interface as required.
*/
- struct SHIBTARGET_EXPORTS ISessionCache : public virtual saml::IPlugIn
+ struct SHIBTARGET_EXPORTS ISessionCache : virtual public shibsp::SessionCache
{
virtual std::string insert(
const IApplication* application,
- const shibboleth::IEntityDescriptor* source,
+ const opensaml::saml2md::RoleDescriptor* source,
const char* client_addr,
const saml::SAMLSubject* subject,
const char* authnContext,
virtual ~ISessionCache() {}
};
- /**
- * Interface to a remoted service
- *
- * Plugins that support remoted messages delivered by the IListener runtime
- * support this interface and register themselves with the runtime to receive
- * particular messages.
- */
- struct SHIBTARGET_EXPORTS IRemoted : public virtual saml::IPlugIn
- {
- virtual DDF receive(const DDF& in)=0;
- virtual ~IRemoted() {}
- };
-
- /**
- * Interface to the remoting engine
- *
- * A listener supports the remoting of DDF objects, which are dynamic data trees
- * that interface implementations can use to remote themselves by calling an
- * out-of-process peer implementation with arbitrary data to carry out tasks
- * on the implementation's behalf that require isolation from the dynamic process
- * fluctuations that web servers are prone to. The ability to pass arbitrary data
- * trees across the boundary allows arbitrary separation of duty between the
- * in-process and out-of-process "halves". The implementation is responsible
- * for marshalling and transmitting messages, as well as managing connections
- * and communication errors.
- */
- class SHIBTARGET_EXPORTS IListener : public virtual IRemoted
- {
- public:
- virtual DDF send(const DDF& in)=0;
- virtual DDF receive(const DDF& in);
- virtual ~IListener() {}
-
- // Remoted classes register and unregister for messages using these methods.
- // Registration returns any existing listeners, allowing message hooking.
- virtual IRemoted* regListener(const char* address, IRemoted* listener);
- virtual bool unregListener(const char* address, IRemoted* current, IRemoted* restore=NULL);
- virtual IRemoted* lookup(const char* address) const;
-
- // OutOfProcess servers can implement server-side transport handling by
- // calling the run method and supplying a flag to monitor for shutdown.
- virtual bool run(bool* shutdown)=0;
+ #define MEMORY_SESSIONCACHE "edu.internet2.middleware.shibboleth.sp.provider.MemorySessionCacheProvider"
+ #define MYSQL_SESSIONCACHE "edu.internet2.middleware.shibboleth.sp.provider.MySQLSessionCacheProvider"
+ #define ODBC_SESSIONCACHE "edu.internet2.middleware.shibboleth.sp.provider.ODBCSessionCacheProvider"
- private:
- std::map<std::string,IRemoted*> m_listenerMap;
- };
+ #define MYSQL_REPLAYCACHE "edu.internet2.middleware.shibboleth.sp.provider.MySQLReplayCacheProvider"
+ #define ODBC_REPLAYCACHE "edu.internet2.middleware.shibboleth.sp.provider.ODBCReplayCacheProvider"
- /**
- * Interface to an access control plugin
- *
- * Access control plugins return authorization decisions based on the intersection
- * of the resource request and the active session. They can be implemented through
- * cross-platform or platform-specific mechanisms.
- */
- struct SHIBTARGET_EXPORTS IAccessControl : public virtual saml::ILockable, public virtual saml::IPlugIn
- {
- virtual bool authorized(ShibTarget* st, ISessionCacheEntry* entry) const=0;
- virtual ~IAccessControl() {}
- };
-
- /**
- * Interface to a request mapping plugin
- *
- * Request mapping plugins return configuration settings that apply to resource requests.
- * They can be implemented through cross-platform or platform-specific mechanisms.
- */
- struct SHIBTARGET_EXPORTS IRequestMapper : public virtual saml::ILockable, public virtual saml::IPlugIn
- {
- typedef std::pair<const IPropertySet*,IAccessControl*> Settings;
- virtual Settings getSettings(ShibTarget* st) const=0;
- virtual ~IRequestMapper() {}
- };
-
- struct SHIBTARGET_EXPORTS IConfig : public virtual saml::ILockable, public virtual IPropertySet, public virtual saml::IPlugIn
- {
- // loads initial configuration
- virtual void init()=0;
-
- virtual IListener* getListener() const=0;
- virtual ISessionCache* getSessionCache() const=0;
- virtual saml::IReplayCache* getReplayCache() const=0;
- virtual IRequestMapper* getRequestMapper() const=0;
- virtual const IApplication* getApplication(const char* applicationId) const=0;
- virtual saml::Iterator<shibboleth::ICredentials*> getCredentialsProviders() const=0;
- virtual ~IConfig() {}
- };
class SHIBTARGET_EXPORTS ShibTargetConfig
{
public:
- ShibTargetConfig() : m_ini(NULL), m_features(0) {}
+ ShibTargetConfig() {}
virtual ~ShibTargetConfig() {}
virtual bool init(const char* schemadir) = 0;
virtual bool load(const char* config) = 0;
virtual void shutdown() = 0;
- enum components_t {
- Listener = 1,
- Caching = 2,
- Metadata = 4,
- Trust = 8,
- Credentials = 16,
- AAP = 32,
- RequestMapper = 64,
- OutOfProcess = 128,
- InProcess = 256,
- Logging = 512
- };
- void setFeatures(long enabled) {m_features = enabled;}
- bool isEnabled(components_t feature) {return (m_features & feature)>0;}
- virtual IConfig* getINI() const {return m_ini;}
-
static ShibTargetConfig& getConfig();
-
- protected:
- IConfig* m_ini;
-
- private:
- unsigned long m_features;
- };
-
- // Helper class for SAML 2.0 Common Domain Cookie operations
- class CommonDomainCookie
- {
- public:
- CommonDomainCookie(const char* cookie);
- ~CommonDomainCookie() {}
- saml::Iterator<std::string> get() {return m_list;}
- const char* set(const char* providerId);
- static const char CDCName[];
- private:
- std::string m_encoded;
- std::vector<std::string> m_list;
};
-
- class ShibTargetPriv;
- class SHIBTARGET_EXPORTS ShibTarget {
- public:
- ShibTarget(const IApplication* app);
- virtual ~ShibTarget(void);
-
- // These are defined here so the subclass does not need to specifically
- // depend on log4cpp. We could use log4cpp::Priority::PriorityLevel
- // but this is just as easy, IMHO. It's just a case statement in the
- // implementation to handle the event level.
- enum ShibLogLevel {
- LogLevelDebug,
- LogLevelInfo,
- LogLevelWarn,
- LogLevelError
- };
-
- //
- // Note: subclasses MUST implement ALL of these virtual methods
- //
-
- // Send a message to the Webserver log
- virtual void log(ShibLogLevel level, const std::string &msg)=0;
-
- void log(ShibLogLevel level, const char* msg) {
- std::string s = msg;
- log(level, s);
- }
-
- // Get/Set a cookie for this request
- virtual std::string getCookies() const=0;
- virtual void setCookie(const std::string& name, const std::string& value)=0;
- virtual const char* getCookie(const std::string& name) const;
- void setCookie(const char* name, const char* value) {
- std::string ns = name;
- std::string vs = value;
- setCookie(ns, vs);
- }
- void setCookie(const char* name, const std::string& value) {
- std::string ns = name;
- setCookie(ns, value);
- }
-
- // Get any URL-encoded arguments or the raw POST body from the server
- virtual const char* getQueryString() const=0;
- virtual const char* getRequestBody() const=0;
- virtual const char* getRequestParameter(const char* param, size_t index=0) const;
-
- // Clear a header, set a header
- // These APIs are used for exporting the Assertions into the
- // Headers. It will clear some well-known headers first to make
- // sure none remain. Then it will process the set of assertions
- // and export them via setHeader().
- virtual void clearHeader(const std::string& name)=0;
- virtual void setHeader(const std::string& name, const std::string& value)=0;
- virtual std::string getHeader(const std::string& name)=0;
- virtual void setRemoteUser(const std::string& user)=0;
- virtual std::string getRemoteUser()=0;
-
- void clearHeader(const char* n) {
- std::string s = n;
- clearHeader(s);
- }
- void setHeader(const char* n, const char* v) {
- std::string ns = n;
- std::string vs = v;
- setHeader(ns, vs);
- }
- void setHeader(const std::string& n, const char* v) {
- std::string vs = v;
- setHeader(n, vs);
- }
- void setHeader(const char* n, const std::string& v) {
- std::string ns = n;
- setHeader(ns, v);
- }
- std::string getHeader(const char* n) {
- std::string s = n;
- return getHeader(s);
- }
- void setRemoteUser(const char* n) {
- std::string s = n;
- setRemoteUser(s);
- }
-
- // We're done. Finish up. Send specific result content or a redirect.
- // If there are no headers supplied assume the content-type is text/html
- typedef std::pair<std::string, std::string> header_t;
- virtual void* sendPage(
- const std::string& msg,
- int code = 200,
- const std::string& content_type = "text/html",
- const saml::Iterator<header_t>& headers = EMPTY(header_t)
- )=0;
- void* sendPage(const char* msg) {
- std::string m = msg;
- return sendPage(m);
- }
- virtual void* sendRedirect(const std::string& url)=0;
-
- // These next two APIs are used to obtain the module-specific "OK"
- // and "Decline" results. OK means "we believe that this request
- // should be accepted". Declined means "we believe that this is
- // not a shibbolized request so we have no comment".
-
- virtual void* returnDecline();
- virtual void* returnOK();
-
- //
- // Note: Subclasses need not implement anything below this line
- //
-
- // These functions implement the server-agnostic shibboleth engine
- // The web server modules implement a subclass and then call into
- // these methods once they instantiate their request object.
- //
- // Return value:
- // these APIs will always return the result of sendPage(), sendRedirect(),
- // returnDecline(), or returnOK() in the void* portion of the return code.
- // Exactly what those values are is module- (subclass-) implementation
- // specific. The 'bool' part of the return value declares whether the
- // void* is valid or not. If the bool is true then the void* is valid.
- // If the bool is false then the API did not call any callback, the void*
- // is not valid, and the caller should continue processing (the API Call
- // finished successfully).
- //
- // The handleProfile argument declares whether doCheckAuthN() should
- // automatically call doHandlePOST() when it encounters a request for
- // the ShireURL; if false it will call returnOK() instead.
- //
- std::pair<bool,void*> doCheckAuthN(bool handler = false);
- std::pair<bool,void*> doHandler();
- std::pair<bool,void*> doCheckAuthZ();
- std::pair<bool,void*> doExportAssertions(bool requireSession = true);
-
- // Basic request access in case any plugins need the info
- virtual const IConfig* getConfig() const;
- virtual const IApplication* getApplication() const;
- const char* getRequestMethod() const {return m_method.c_str();}
- const char* getProtocol() const {return m_protocol.c_str();}
- const char* getHostname() const {return m_hostname.c_str();}
- int getPort() const {return m_port;}
- const char* getRequestURI() const {return m_uri.c_str();}
- const char* getContentType() const {return m_content_type.c_str();}
- const char* getRemoteAddr() const {return m_remote_addr.c_str();}
- const char* getRequestURL() const {return m_url.c_str();}
-
- // Advanced methods useful to profile handlers implemented outside core
-
- // Get per-application session and state cookie name and properties
- virtual std::pair<std::string,const char*> getCookieNameProps(const char* prefix) const;
-
- // Determine the effective handler URL based on the resource URL
- virtual std::string getHandlerURL(const char* resource) const;
-
- static void url_decode(char* s);
- static std::string url_encode(const char* s);
-
- protected:
- ShibTarget();
-
- // Internal APIs
-
- // Initialize the request from the parsed URL
- // protocol == http, https, etc
- // hostname == server name
- // port == server port
- // uri == resource path
- // method == GET, POST, etc.
- void init(
- const char* protocol,
- const char* hostname,
- int port,
- const char* uri,
- const char* content_type,
- const char* remote_addr,
- const char* method
- );
-
- std::string m_url, m_method, m_protocol, m_hostname, m_uri, m_content_type, m_remote_addr;
- int m_port;
-
- private:
- mutable ShibTargetPriv* m_priv;
- friend class ShibTargetPriv;
- };
-
- struct SHIBTARGET_EXPORTS XML
- {
- static const XMLCh SHIBTARGET_NS[];
- static const XMLCh SHIBTARGET_SCHEMA_ID[];
- static const XMLCh SAML2ASSERT_NS[];
- static const XMLCh SAML2ASSERT_SCHEMA_ID[];
- static const XMLCh SAML2META_NS[];
- static const XMLCh SAML2META_SCHEMA_ID[];
- static const XMLCh XMLENC_NS[];
- static const XMLCh XMLENC_SCHEMA_ID[];
-
- // Session cache implementations
- static const char MemorySessionCacheType[];
- static const char MySQLSessionCacheType[];
- static const char ODBCSessionCacheType[];
-
- // Replay cache implementations
- static const char MySQLReplayCacheType[];
- static const char ODBCReplayCacheType[];
-
- // Request mapping/settings implementations
- static const char XMLRequestMapType[]; // portable XML-based map
- static const char NativeRequestMapType[]; // Native web server command override of XML-based map
- static const char LegacyRequestMapType[]; // older designation of XML map, hijacked by web server
-
- // Access control implementations
- static const char htAccessControlType[]; // Apache-specific .htaccess authz module
- static const char XMLAccessControlType[]; // Proprietary but portable XML authz syntax
-
- // Listener implementations
- static const char TCPListenerType[]; // ONC RPC via TCP socket
- static const char UnixListenerType[]; // ONC RPC via domain socker
- static const char MemoryListenerType[]; // "faked" in-process marshalling
-
- struct SHIBTARGET_EXPORTS Literals
- {
- static const XMLCh AAPProvider[];
- static const XMLCh AccessControl[];
- static const XMLCh AccessControlProvider[];
- static const XMLCh acl[];
- static const XMLCh AND[];
- static const XMLCh applicationId[];
- static const XMLCh Application[];
- static const XMLCh Applications[];
- static const XMLCh AssertionConsumerService[];
- static const XMLCh AttributeFactory[];
- static const XMLCh config[];
- static const XMLCh CredentialsProvider[];
- static const XMLCh CredentialUse[];
- static const XMLCh DiagnosticService[];
- static const XMLCh echo[];
- static const XMLCh Extensions[];
- static const XMLCh fatal[];
- static const XMLCh FederationProvider[];
- static const XMLCh Global[];
- static const XMLCh Host[];
- static const XMLCh htaccess[];
- static const XMLCh Implementation[];
- static const XMLCh index[];
- static const XMLCh InProcess[];
- static const XMLCh isDefault[];
- static const XMLCh Library[];
- static const XMLCh Listener[];
- static const XMLCh Local[];
- static const XMLCh log[];
- static const XMLCh logger[];
- static const XMLCh MemorySessionCache[];
- static const XMLCh MetadataProvider[];
- static const XMLCh MySQLReplayCache[];
- static const XMLCh MySQLSessionCache[];
- static const XMLCh name[];
- static const XMLCh Name[];
- static const XMLCh NOT[];
- static const XMLCh ODBCReplayCache[];
- static const XMLCh ODBCSessionCache[];
- static const XMLCh OR[];
- static const XMLCh OutOfProcess[];
- static const XMLCh Path[];
- static const XMLCh path[];
- static const XMLCh RelyingParty[];
- static const XMLCh ReplayCache[];
- static const XMLCh RequestMap[];
- static const XMLCh RequestMapProvider[];
- static const XMLCh require[];
- static const XMLCh Rule[];
- static const XMLCh SessionCache[];
- static const XMLCh SessionInitiator[];
- static const XMLCh SHAR[];
- static const XMLCh ShibbolethTargetConfig[];
- static const XMLCh SHIRE[];
- static const XMLCh Signing[];
- static const XMLCh SingleLogoutService[];
- static const XMLCh SPConfig[];
- static const XMLCh TCPListener[];
- static const XMLCh TLS[];
- static const XMLCh TrustProvider[];
- static const XMLCh type[];
- static const XMLCh UnixListener[];
- };
- };
-
-
- // Template cleanup functors for use with for_each algorithm
- template<class T> struct cleanup
- {
- void operator()(T* ptr) {delete ptr;}
- void operator()(const T* ptr) {delete const_cast<T*>(ptr);}
- };
-
- template<class A,class B> struct cleanup_pair
- {
- void operator()(std::pair<A,B*> p) {delete p.second;}
- };
}
#endif /* SHIB_TARGET_H */
projects / shibboleth / cpp-sp.git / blobdiff