shib-target/shib-target.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  * shib-target.h -- top-level header file for the SHIB Common Target Library
  52  *
  53  * Created by:  Derek Atkins <derek@ihtfp.com>
  54  *
  55  * $Id$
  56  */
  57
  58 #ifndef SHIB_TARGET_H
  59 #define SHIB_TARGET_H
  60
  61 #include <saml/saml.h>
  62 #include <shib/shib.h>
  63 #include <shib/shib-threads.h>
  64
  65 #ifdef WIN32
  66 # ifndef SHIBTARGET_EXPORTS
  67 #  define SHIBTARGET_EXPORTS __declspec(dllimport)
  68 # endif
  69 # define SHIB_SCHEMAS "/opt/shibboleth/share/xml/shibboleth"
  70 # define SHIB_CONFIG "/opt/shibboleth/etc/shibboleth/shibboleth.xml"
  71 #else
  72 # include <shib-target/shib-paths.h>
  73 # define SHIBTARGET_EXPORTS
  74 #endif
  75
  76 #include <shib-target/shibrpc.h>
  77
  78 namespace shibtarget {
  79
  80   //******************************************************************************
  81   // You probably don't care about much below this line
  82   // unless you are using the lower-layer APIs provided by
  83   // the shib target library.  Go to the end of the file to
  84   // find the ShibTarget class -- you probably wnat to use that.
  85   //
  86
  87   class SHIBTARGET_EXPORTS ShibTargetException : public std::exception
  88   {
  89   public:
  90     explicit ShibTargetException() : m_code(SHIBRPC_OK) {}
  91     explicit ShibTargetException(ShibRpcStatus code, const char* msg, const shibboleth::IEntityDescriptor* provider);
  92     explicit ShibTargetException(ShibRpcStatus code, const char* msg, const shibboleth::IRoleDescriptor* role=NULL);
  93
  94     virtual ~ShibTargetException() throw () {}
  95     virtual ShibRpcStatus which() const throw () { return m_code; }
  96     virtual const char* what() const throw () { return m_msg.c_str(); }
  97     virtual const char* syswho() const throw() { return m_providerId.c_str(); }
  98     virtual const char* where() const throw () { return m_errorURL.c_str(); }
  99     virtual const char* who() const throw () { return m_contact.c_str(); }
 100     virtual const char* how() const throw () { return m_email.c_str(); }
 101
 102   private:
 103     ShibRpcStatus m_code;
 104     std::string m_msg;
 105     std::string m_providerId;
 106     std::string m_errorURL;
 107     std::string m_contact;
 108     std::string m_email;
 109   };
 110
 111   class RPCErrorPriv;
 112   class SHIBTARGET_EXPORTS RPCError
 113   {
 114   public:
 115     RPCError();
 116     RPCError(ShibRpcError* e);
 117     RPCError(int s, const char* st);
 118     RPCError(ShibTargetException &exp);
 119     ~RPCError();
 120
 121     bool isError();
 122     bool isRetryable();
 123
 124     // Return a set of strings that correspond to the error properties
 125     const char* getType();
 126     const char* getText();
 127     const char* getDesc();
 128     const char* getProviderId();
 129     const char* getErrorURL();
 130     const char* getContactName();
 131     const char* getContactEmail();
 132     int getCode();
 133
 134   private:
 135     RPCErrorPriv* m_priv;
 136   };
 137
 138     // Abstract APIs for access to configuration information
 139
 140     struct SHIBTARGET_EXPORTS IPropertySet
 141     {
 142         virtual std::pair<bool,bool> getBool(const char* name, const char* ns=NULL) const=0;
 143         virtual std::pair<bool,const char*> getString(const char* name, const char* ns=NULL) const=0;
 144         virtual std::pair<bool,const XMLCh*> getXMLString(const char* name, const char* ns=NULL) const=0;
 145         virtual std::pair<bool,unsigned int> getUnsignedInt(const char* name, const char* ns=NULL) const=0;
 146         virtual std::pair<bool,int> getInt(const char* name, const char* ns=NULL) const=0;
 147         virtual const IPropertySet* getPropertySet(const char* name, const char* ns="urn:mace:shibboleth:target:config:1.0") const=0;
 148         virtual const DOMElement* getElement() const=0;
 149         virtual ~IPropertySet() {}
 150     };
 151
 152     struct SHIBTARGET_EXPORTS IListener : public virtual saml::IPlugIn
 153     {
 154 #ifdef WIN32
 155         typedef SOCKET ShibSocket;
 156 #else
 157         typedef int ShibSocket;
 158 #endif
 159         virtual bool create(ShibSocket& s) const=0;
 160         virtual bool bind(ShibSocket& s, bool force=false) const=0;
 161         virtual bool connect(ShibSocket& s) const=0;
 162         virtual bool close(ShibSocket& s) const=0;
 163         virtual bool accept(ShibSocket& listener, ShibSocket& s) const=0;
 164         virtual CLIENT* getClientHandle(ShibSocket& s, u_long program, u_long version) const=0;
 165         virtual ~IListener() {}
 166     };
 167
 168     struct SHIBTARGET_EXPORTS IAccessControl : public virtual saml::ILockable, public virtual saml::IPlugIn
 169     {
 170         virtual bool authorized(
 171             const saml::SAMLAuthenticationStatement& authn, const saml::Iterator<saml::SAMLAssertion*>& attrs
 172             ) const=0;
 173         virtual ~IAccessControl() {}
 174     };
 175
 176     struct SHIBTARGET_EXPORTS IRequestMapper : public virtual saml::ILockable, public virtual saml::IPlugIn
 177     {
 178         typedef std::pair<const IPropertySet*,IAccessControl*> Settings;
 179         virtual Settings getSettingsFromURL(const char* url) const=0;
 180         virtual Settings getSettingsFromParsedURL(
 181             const char* scheme, const char* hostname, unsigned int port, const char* path=NULL
 182             ) const=0;
 183         virtual ~IRequestMapper() {}
 184     };
 185
 186     struct SHIBTARGET_EXPORTS IApplication : public virtual IPropertySet
 187     {
 188         virtual const char* getId() const=0;
 189         virtual saml::Iterator<saml::SAMLAttributeDesignator*> getAttributeDesignators() const=0;
 190         virtual saml::Iterator<shibboleth::IAAP*> getAAPProviders() const=0;
 191         virtual saml::Iterator<shibboleth::IMetadata*> getMetadataProviders() const=0;
 192         virtual saml::Iterator<shibboleth::ITrust*> getTrustProviders() const=0;
 193         virtual saml::Iterator<shibboleth::IRevocation*> getRevocationProviders() const=0;
 194         virtual saml::Iterator<const XMLCh*> getAudiences() const=0;
 195         virtual const IPropertySet* getCredentialUse(const shibboleth::IEntityDescriptor* provider) const=0;
 196
 197         // caller is borrowing object, must use within scope of config lock
 198         virtual const saml::SAMLBrowserProfile* getBrowserProfile() const=0;
 199         virtual const saml::SAMLBinding* getBinding(const XMLCh* binding) const=0;
 200
 201         // caller is given ownership of object, must use and delete within scope of config lock
 202         virtual saml::SAMLBrowserProfile::ArtifactMapper* getArtifactMapper() const=0;
 203
 204         virtual ~IApplication() {}
 205     };
 206
 207     struct SHIBTARGET_EXPORTS ISessionCacheEntry : public virtual saml::ILockable
 208     {
 209         virtual bool isValid(time_t lifetime, time_t timeout) const=0;
 210         virtual const char* getClientAddress() const=0;
 211         virtual const saml::SAMLAuthenticationStatement* getAuthnStatement() const=0;
 212         virtual saml::Iterator<saml::SAMLAssertion*> getAssertions()=0;
 213         virtual ~ISessionCacheEntry() {}
 214     };
 215
 216     struct SHIBTARGET_EXPORTS ISessionCache : public virtual saml::IPlugIn
 217     {
 218         virtual void thread_init()=0;
 219         virtual void thread_end()=0;
 220         virtual std::string generateKey() const=0;
 221         virtual void insert(
 222             const char* key,
 223             const IApplication* application,
 224             saml::SAMLAuthenticationStatement *s,
 225             const char* client_addr,
 226             saml::SAMLResponse* r=NULL,
 227             const shibboleth::IRoleDescriptor* source=NULL
 228             )=0;
 229         virtual ISessionCacheEntry* find(const char* key, const IApplication* application)=0;
 230         virtual void remove(const char* key)=0;
 231         virtual ~ISessionCache() {}
 232     };
 233
 234     struct SHIBTARGET_EXPORTS IConfig : public virtual saml::ILockable, public virtual IPropertySet, public virtual saml::IPlugIn
 235     {
 236         virtual const IListener* getListener() const=0;
 237         virtual ISessionCache* getSessionCache() const=0;
 238         virtual saml::IReplayCache* getReplayCache() const=0;
 239         virtual IRequestMapper* getRequestMapper() const=0;
 240         virtual const IApplication* getApplication(const char* applicationId) const=0;
 241         virtual saml::Iterator<shibboleth::ICredentials*> getCredentialsProviders() const=0;
 242         virtual ~IConfig() {}
 243     };
 244
 245     class SHIBTARGET_EXPORTS ShibTargetConfig
 246     {
 247     public:
 248         ShibTargetConfig() : m_ini(NULL), m_features(0) {}
 249         virtual ~ShibTargetConfig() {}
 250
 251         virtual bool init(const char* schemadir, const char* config) = 0;
 252         virtual void shutdown() = 0;
 253
 254         enum components_t {
 255             Listener = 1,
 256             SessionCache = 2,
 257             Metadata = 4,
 258             Trust = 8,
 259             Credentials = 16,
 260             AAP = 32,
 261             RequestMapper = 64,
 262             GlobalExtensions = 128,
 263             LocalExtensions = 256,
 264             Logging = 512
 265         };
 266         void setFeatures(long enabled) {m_features = enabled;}
 267         bool isEnabled(components_t feature) {return (m_features & feature)>0;}
 268         virtual IConfig* getINI() const {return m_ini;}
 269
 270         static const XMLCh SHIBTARGET_NS[];
 271         static ShibTargetConfig& getConfig();
 272
 273     protected:
 274         IConfig* m_ini;
 275
 276     private:
 277         unsigned long m_features;
 278     };
 279
 280     class ShibMLPPriv;
 281     class SHIBTARGET_EXPORTS ShibMLP {
 282     public:
 283         ShibMLP();
 284         ~ShibMLP();
 285
 286         void insert (const std::string& key, const std::string& value);
 287         void insert (const std::string& key, const char* value) {
 288           std::string v = value;
 289           insert (key, v);
 290         }
 291         void insert (const char* key, const std::string& value) {
 292           std::string k = key;
 293           insert (k, value);
 294         }
 295         void insert (const char* key, const char* value) {
 296           std::string k = key, v = value;
 297           insert(k,v);
 298         }
 299         void insert (RPCError& e);
 300
 301         void clear () { m_map.clear(); }
 302
 303         const char* run (std::istream& s, const IPropertySet* props=NULL, std::string* output=NULL);
 304         const char* run (const std::string& input, const IPropertySet* props=NULL, std::string* output=NULL);
 305         const char* run (const char* input, const IPropertySet* props=NULL, std::string* output=NULL) {
 306             std::string i = input;
 307             return run(i,props,output);
 308         }
 309
 310     private:
 311         ShibMLPPriv *m_priv;
 312         std::map<std::string,std::string> m_map;
 313         std::string m_generated;
 314     };
 315
 316   //******************************************************************************
 317   //
 318   // This is the interface you're looking for.
 319   //
 320
 321   class HTAccessInfo {
 322   public:
 323     class RequireLine {
 324     public:
 325       bool use_line;
 326       std::vector<std::string> tokens;
 327     };
 328
 329     HTAccessInfo() {}
 330     ~HTAccessInfo() {
 331       for (int k = 0; k < elements.size(); k++)
 332         delete elements[k];
 333       elements.resize(0);
 334     }
 335
 336     std::vector<RequireLine*> elements;
 337     bool requireAll;
 338   };
 339
 340   class HTGroupTable {
 341   public:
 342     virtual ~HTGroupTable() {}
 343     virtual bool lookup(const char *entry) = 0;
 344   protected:
 345     HTGroupTable() {}
 346   };
 347
 348   // This usurps the existing SHIRE and RM apis into a single class.
 349   class ShibTargetPriv;
 350   class SHIBTARGET_EXPORTS ShibTarget {
 351   public:
 352     ShibTarget(const IApplication *app);
 353     virtual ~ShibTarget(void);
 354
 355     // These are defined here so the subclass does not need to specifically
 356     // depend on log4cpp.  We could use log4cpp::Priority::PriorityLevel
 357     // but this is just as easy, IMHO.  It's just a case statement in the
 358     // implementation to handle the event level.
 359     enum ShibLogLevel {
 360       LogLevelDebug,
 361       LogLevelInfo,
 362       LogLevelWarn,
 363       LogLevelError
 364     };
 365
 366     //
 367     // Note: subclasses MUST implement ALL of these virtual methods
 368     //
 369
 370     // Send a message to the Webserver log
 371     virtual void log(ShibLogLevel level, const std::string &msg)=0;
 372
 373     void log(ShibLogLevel level, const char *msg) {
 374       std::string s = msg;
 375       log(level, s);
 376     }
 377
 378     // Get/Set a cookie for this connection
 379     virtual std::string getCookies(void)=0;
 380     virtual void setCookie(const std::string &name, const std::string &value)=0;
 381
 382     void setCookie(const char *name, const char *value) {
 383       std::string ns = name;
 384       std::string vs = value;
 385       setCookie(ns, vs);
 386     }
 387     void setCookie(const char *name, const std::string &value) {
 388       std::string ns = name;
 389       setCookie(ns, value);
 390     }
 391
 392
 393     // Get the request's GET arguments or POST data from the server
 394     virtual std::string getArgs(void)=0;
 395     virtual std::string getPostData(void)=0;
 396
 397     // Clear a header, set a header
 398     // These APIs are used for exporting the Assertions into the
 399     // Headers.  It will clear some well-known headers first to make
 400     // sure none remain.  Then it will process the set of assertions
 401     // and export them via setHeader().
 402     virtual void clearHeader(const std::string &name)=0;
 403     virtual void setHeader(const std::string &name, const std::string &value)=0;
 404     virtual std::string getHeader(const std::string &name)=0;
 405     virtual void setRemoteUser(const std::string &user)=0;
 406     virtual std::string getRemoteUser(void)=0;
 407
 408     void clearHeader(const char *n) {
 409       std::string s = n;
 410       clearHeader(s);
 411     }
 412     void setHeader(const char *n, const char *v) {
 413       std::string ns = n;
 414       std::string vs = v;
 415       setHeader(ns, vs);
 416     }
 417     void setHeader(const std::string &n, const char *v) {
 418       std::string vs = v;
 419       setHeader(n, vs);
 420     }
 421     void setHeader(const char *n, const std::string &v) {
 422       std::string ns = n;
 423       setHeader(ns, v);
 424     }
 425     std::string getHeader(const char *n) {
 426       std::string s = n;
 427       return getHeader(s);
 428     }
 429     void setRemoteUser(const char *n) {
 430       std::string s = n;
 431       setRemoteUser(s);
 432     }
 433
 434     // returns the "auth type"..  if this string is not "shibboleth" then
 435     // the request will be denied.  Any kind of "override" should be handled
 436     // by the subclass before returning this value.  Note that the default
 437     // implementation always returns "shibboleth".
 438     virtual std::string getAuthType(void);
 439
 440     // Note: we still need to define exactly what kind of data in contained
 441     // in the HTAccessInfo -- perhaps we can stub it out so non-htaccess
 442     // systems have something they can plug in?
 443     virtual HTAccessInfo* getAccessInfo(void);
 444     virtual HTGroupTable* getGroupTable(std::string &user);
 445
 446     // We're done.  Finish up.  Send either a result (error?) page or a redirect.
 447     // If there are no headers supplied assume the content-type == text/html
 448     typedef std::pair<std::string, std::string> header_t;
 449     virtual void* sendPage(
 450                            const std::string &msg,
 451                            const std::string content_type = "text/html",
 452                            const saml::Iterator<header_t>& headers = EMPTY(header_t),
 453                            int code = 200
 454                            )=0;
 455     void* sendPage(const char *msg) {
 456       std::string m = msg;
 457       return sendPage(m);
 458     }
 459
 460     virtual void* sendRedirect(const std::string url)=0;
 461
 462     // These next two APIs are used to obtain the module-specific "OK"
 463     // and "Decline" results.  OK means "we believe that this request
 464     // should be accepted".  Declined means "we believe that this is
 465     // not a shibbolized request so we have no comment".
 466
 467     virtual void* returnDecline(void);
 468     virtual void* returnOK(void);
 469
 470     //
 471     // Note:  Subclasses need not implement anything below this line
 472     //
 473
 474     // These functions implement the server-agnostic shibboleth engine
 475     // The web server modules implement a subclass and then call into
 476     // these methods once they instantiate their request object.
 477     //
 478     // Return value:
 479     //   these APIs will always return the result of sendPage(), sendRedirect(),
 480     //   returnDecline(), or returnOK() in the void* portion of the return code.
 481     //   Exactly what those values are is module- (subclass-) implementation
 482     //   specific.  The 'bool' part of the return value declares whether the
 483     //   void* is valid or not.  If the bool is true then the void* is valid.
 484     //   If the bool is false then the API did not call any callback, the void*
 485     //   is not valid, and the caller should continue processing (the API Call
 486     //   finished successfully).
 487     //
 488     //   The arguments are all overrides..  The requireSession and
 489     //   exportAssertion values passed in here are only used if the
 490     //   settings resource is negative.
 491     //
 492     //   The handleProfile argument declares whether doCheckAuthN() should
 493     //   automatically call doHandlePOST() when it encounters a request for
 494     //   the ShireURL;  if false it will call returnOK() instead.
 495     //
 496     std::pair<bool,void*> doCheckAuthN(bool requireSession = false, bool handleProfile = false);
 497     std::pair<bool,void*> doHandleProfile();
 498     std::pair<bool,void*> doCheckAuthZ();
 499     std::pair<bool,void*> doExportAssertions(bool exportAssertion = false);
 500
 501     //**************************************************************************
 502     // These APIs are for backwards-compatibility.  Hopefully they can
 503     // eventually go away.
 504
 505     // SHIRE APIs
 506
 507     // Get the session cookie name and properties for the application
 508     std::pair<const char*,const char*> getCookieNameProps() const;
 509
 510     // Find the default assertion consumer service for the resource
 511     const char* getShireURL(const char* resource) const;
 512
 513     // Generate a Shib 1.x AuthnRequest redirect URL for the resource
 514     const char* getAuthnRequest(const char* resource) const;
 515
 516     // Process a lazy session setup request and turn it into an AuthnRequest
 517     const char* getLazyAuthnRequest(const char* query_string) const;
 518
 519   protected:
 520     ShibTarget();
 521
 522     // Currently wraps remoted interface.
 523     // TODO: Move this functionality behind ISessionCache
 524     RPCError* sessionNew(
 525                const char* packet,
 526                const char* ip,
 527                std::string& cookie,
 528                 std::string& target
 529              ) const;
 530
 531     RPCError* sessionGet(
 532              const char* cookie,
 533                const char* ip,
 534                std::vector<saml::SAMLAssertion*>& assertions,
 535                 saml::SAMLAuthenticationStatement **statement = NULL
 536               ) const;
 537
 538     // Initialize the request from the parsed URL
 539     // protocol == http, https, etc
 540     // hostname == server name
 541     // port == server port
 542     // uri == resource path
 543     // method == GET, POST, etc.
 544     void init(ShibTargetConfig *config,
 545               std::string protocol, std::string hostname, int port,
 546               std::string uri, std::string content_type, std::string remote_host,
 547               std::string method);
 548
 549   private:
 550     mutable ShibTargetPriv *m_priv;
 551   };
 552 }
 553
 554 #endif /* SHIB_TARGET_H */