src/auth/Scheme.h

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