src/auth/Scheme.h

   1 /*
   2  *
   3  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   4  * ----------------------------------------------------------
   5  *
   6  *  Squid is the result of efforts by numerous individuals from
   7  *  the Internet community; see the CONTRIBUTORS file for full
   8  *  details.   Many organizations have provided support for Squid's
   9  *  development; see the SPONSORS file for full details.  Squid is
  10  *  Copyrighted (C) 2001 by the Regents of the University of
  11  *  California; see the COPYRIGHT file for full details.  Squid
  12  *  incorporates software developed and/or copyrighted by other
  13  *  sources; see the CREDITS file for full details.
  14  *
  15  *  This program is free software; you can redistribute it and/or modify
  16  *  it under the terms of the GNU General Public License as published by
  17  *  the Free Software Foundation; either version 2 of the License, or
  18  *  (at your option) any later version.
  19  *
  20  *  This program is distributed in the hope that it will be useful,
  21  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  22  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23  *  GNU General Public License for more details.
  24  *
  25  *  You should have received a copy of the GNU General Public License
  26  *  along with this program; if not, write to the Free Software
  27  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  28  *
  29  */
  30
  31 #ifndef SQUID_AUTH_SCHEME_H
  32 #define SQUID_AUTH_SCHEME_H
  33
  34 #if USE_AUTH
  35
  36 #include "base/RefCount.h"
  37 #include "base/Vector.h"
  38
  39 /**
  40  \defgroup AuthSchemeAPI        Authentication Scheme API
  41  \ingroup AuthAPI
  42  */
  43
  44 namespace Auth
  45 {
  46
  47 class Config;
  48
  49 /**
  50  * \ingroup AuthAPI
  51  * \ingroup AuthSchemeAPI
  52  * \par
  53  * I represent an authentication scheme. For now my children
  54  * store the scheme metadata.
  55  * \par
  56  * Should we need multiple configs of a single scheme,
  57  * a new class should be made, and the config specific calls on Auth::Scheme moved to it.
  58  */
  59 class Scheme : public RefCountable
  60 {
  61 public:
  62     typedef RefCount<Scheme> Pointer;
  63     typedef Vector<Scheme::Pointer>::iterator iterator;
  64     typedef Vector<Scheme::Pointer>::const_iterator const_iterator;
  65
  66 public:
  67     Scheme() : initialised (false) {};
  68     virtual ~Scheme() {};
  69
  70     static void AddScheme(Scheme::Pointer);
  71
  72     /**
  73      * Final termination of all authentication components.
  74      * To be used only on shutdown. All global pointers are released.
  75      * After this all schemes will appear completely unsupported
  76      * until a call to InitAuthModules().
  77      * Release the Auth::TheConfig handles instead to disable authentication
  78      * without terminiating all support.
  79      */
  80     static void FreeAll();
  81
  82     /**
  83      * Locate an authentication scheme component by Name.
  84      */
  85     static Scheme::Pointer Find(const char *);
  86
  87     /* per scheme methods */
  88     virtual char const *type() const = 0;
  89     virtual void shutdownCleanup() = 0;
  90     virtual Auth::Config *createConfig() = 0;
  91
  92     // Not implemented
  93     Scheme(Scheme const &);
  94     Scheme &operator=(Scheme const&);
  95
  96     static Vector<Scheme::Pointer> &GetSchemes();
  97
  98 protected:
  99     bool initialised;
 100
 101 private:
 102     static Vector<Scheme::Pointer> *_Schemes;
 103 };
 104
 105 } // namespace Auth
 106
 107 #endif /* USE_AUTH */
 108 #endif /* SQUID_AUTH_SCHEME_H */