]> git.ipfire.org Git - thirdparty/squid.git/blame - src/auth/digest/Scheme.h
Cleanup: global/static function or methods should start from capital letter
[thirdparty/squid.git] / src / auth / digest / Scheme.h
CommitLineData
f5691f9c 1/*
262a0e14 2 * $Id$
f5691f9c 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.
26ac0430 21 *
f5691f9c 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.
26ac0430 26 *
f5691f9c 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_DIGESTSCHEME_H
34#define SQUID_DIGESTSCHEME_H
35
2d2b0bb7 36#include "auth/Scheme.h"
5817ee13 37#include "auth/digest/auth_digest.h"
f5691f9c 38
63be0a78 39/// \ingroup AuthSchemeAPI
40/// \ingroup AuthAPI
f5691f9c 41class digestScheme : public AuthScheme
42{
43
44public:
5817ee13
AJ
45 static AuthScheme::Pointer GetInstance();
46 digestScheme() {};
26ac0430 47 virtual ~digestScheme() {}
f5691f9c 48
49 /* per scheme */
50 virtual char const *type () const;
51 virtual void done();
52 virtual AuthConfig *createConfig();
5817ee13 53
f5691f9c 54 /* Not implemented */
55 digestScheme (digestScheme const &);
56 digestScheme &operator=(digestScheme const &);
57
58private:
5817ee13 59 static AuthScheme::Pointer _instance;
56a49fda
AJ
60
61 /**
62 * Remove all cached user credentials from circulation.
63 * Intended for use during shutdown procedure.
64 * After calling this all newly received credentials must be re-authenticated.
65 */
66 static void PurgeCredentialsCache(void);
f5691f9c 67};
68
69#endif /* SQUID_DIGESTSCHEME_H */