src/auth/Gadgets.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_AUTH_GADGETS_H
  34 #define SQUID_AUTH_GADGETS_H
  35
  36 #include "hash.h"
  37 #include "MemPool.h"
  38 #include "typedefs.h" /* for authConfig */
  39
  40 class AuthUser;
  41
  42 /**
  43  \ingroup AuthAPI
  44  *
  45  * This is used to link auth_users into the username cache.
  46  * Because some schemes may link in aliases to a user,
  47  * the link is not part of the AuthUser structure itself.
  48  *
  49  \todo Inheritance in a struct? this should be a class.
  50  */
  51 struct AuthUserHashPointer : public hash_link {
  52     /* first two items must be same as hash_link */
  53
  54 public:
  55     static void removeFromCache (void *anAuthUserHashPointer);
  56     MEMPROXY_CLASS(AuthUserHashPointer);
  57
  58     AuthUserHashPointer(AuthUser *);
  59
  60     AuthUser *user() const;
  61
  62 private:
  63     AuthUser *auth_user;
  64 };
  65
  66 MEMPROXY_CLASS_INLINE(AuthUserHashPointer);
  67
  68 class ConnStateData;
  69 class AuthScheme;
  70 class StoreEntry;
  71
  72 /**
  73  \ingroup AuthAPI
  74  \todo this should be a generic cachemgr API type ?
  75  */
  76 typedef void AUTHSSTATS(StoreEntry *);
  77
  78 /**
  79  \ingroup AuthAPI
  80  * subsumed by the C++ interface
  81  \todo does 'subsumed' mean deprecated use a C++ API call?
  82  */
  83 extern void authenticateAuthUserMerge(AuthUser *, AuthUser *);
  84
  85 /// \ingroup AuthAPI
  86 extern void authenticateInit(authConfig *);
  87 /// \ingroup AuthAPI
  88 extern void authenticateShutdown(void);
  89 /// \ingroup AuthAPI
  90 extern int authenticateAuthUserInuse(AuthUser * auth_user);
  91
  92 /// \ingroup AuthAPI
  93 extern void authenticateFreeProxyAuthUserACLResults(void *data);
  94 /// \ingroup AuthAPI
  95 extern int authenticateActiveSchemeCount(void);
  96 /// \ingroup AuthAPI
  97 extern int authenticateSchemeCount(void);
  98
  99 /// \ingroup AuthAPI
 100 extern void authenticateUserCacheRestart(void);
 101 /// \ingroup AuthAPI
 102 extern void authenticateOnCloseConnection(ConnStateData * conn);
 103
 104 #endif /* SQUID_AUTH_GADGETS_H */