[thirdparty/squid.git] / src / auth / digest / Scheme.h

/*
 * Copyright (C) 1996-2015 The Squid Software Foundation and contributors
 *
 * Squid software is distributed under GPLv2+ license and includes
 * contributions from numerous individuals and organizations.
 * Please see the COPYING and CONTRIBUTORS files for details.
 */

#ifndef SQUID_AUTH_DIGEST_SCHEME_H
#define SQUID_AUTH_DIGEST_SCHEME_H

#include "auth/Scheme.h"

namespace Auth
{
namespace Digest
{

/// \ingroup AuthSchemeAPI
/// \ingroup AuthAPI
class Scheme : public Auth::Scheme
{

public:
    static Auth::Scheme::Pointer GetInstance();
    Scheme() {};
    virtual ~Scheme() {}

    /* per scheme */
    virtual char const *type () const;
    virtual void shutdownCleanup();
    virtual Auth::Config *createConfig();

    /* Not implemented */
    Scheme(Scheme const &);
    Scheme &operator=(Scheme const &);

private:
    static Auth::Scheme::Pointer _instance;

    /**
     * Remove all cached user credentials from circulation.
     * Intended for use during shutdown procedure.
     * After calling this all newly received credentials must be re-authenticated.
     */
    static void PurgeCredentialsCache(void);
};

} // namespace Digest
} // namespace Auth

#endif /* SQUID_AUTH_DIGEST_SCHEME_H */
Commit	Line	Data
	1	/*
	2	* Copyright (C) 1996-2015 The Squid Software Foundation and contributors
	3	*
	4	* Squid software is distributed under GPLv2+ license and includes
	5	* contributions from numerous individuals and organizations.
	6	* Please see the COPYING and CONTRIBUTORS files for details.
	7	*/
	8
	9	#ifndef SQUID_AUTH_DIGEST_SCHEME_H
	10	#define SQUID_AUTH_DIGEST_SCHEME_H
	11
	12	#include "auth/Scheme.h"
	13
	14	namespace Auth
	15	{
	16	namespace Digest
	17	{
	18
	19	/// \ingroup AuthSchemeAPI
	20	/// \ingroup AuthAPI
	21	class Scheme : public Auth::Scheme
	22	{
	23
	24	public:
	25	static Auth::Scheme::Pointer GetInstance();
	26	Scheme() {};
	27	virtual ~Scheme() {}
	28
	29	/* per scheme */
	30	virtual char const *type () const;
	31	virtual void shutdownCleanup();
	32	virtual Auth::Config *createConfig();
	33
	34	/* Not implemented */
	35	Scheme(Scheme const &);
	36	Scheme &operator=(Scheme const &);
	37
	38	private:
	39	static Auth::Scheme::Pointer _instance;
	40
	41	/**
	42	* Remove all cached user credentials from circulation.
	43	* Intended for use during shutdown procedure.
	44	* After calling this all newly received credentials must be re-authenticated.
	45	*/
	46	static void PurgeCredentialsCache(void);
	47	};
	48
	49	} // namespace Digest
	50	} // namespace Auth
	51
	52	#endif /* SQUID_AUTH_DIGEST_SCHEME_H */
	53