/* * Copyright (C) 1996-2018 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_SCHEME_H #define SQUID_AUTH_SCHEME_H #if USE_AUTH #include "base/RefCount.h" #include /** \defgroup AuthSchemeAPI Authentication Scheme API \ingroup AuthAPI */ namespace Auth { class Config; /** * \ingroup AuthAPI * \ingroup AuthSchemeAPI * \par * I represent an authentication scheme. For now my children * store the scheme metadata. * \par * Should we need multiple configs of a single scheme, * a new class should be made, and the config specific calls on Auth::Scheme moved to it. */ class Scheme : public RefCountable { public: typedef RefCount Pointer; typedef std::vector::iterator iterator; typedef std::vector::const_iterator const_iterator; public: Scheme() : initialised (false) {}; virtual ~Scheme() {}; static void AddScheme(Scheme::Pointer); /** * Final termination of all authentication components. * To be used only on shutdown. All global pointers are released. * After this all schemes will appear completely unsupported * until a call to InitAuthModules(). * Release the Auth::TheConfig handles instead to disable authentication * without terminiating all support. */ static void FreeAll(); /** * Locate an authentication scheme component by Name. */ static Scheme::Pointer Find(const char *); /* per scheme methods */ virtual char const *type() const = 0; virtual void shutdownCleanup() = 0; virtual Auth::Config *createConfig() = 0; // Not implemented Scheme(Scheme const &); Scheme &operator=(Scheme const&); static std::vector &GetSchemes(); protected: bool initialised; private: static std::vector *_Schemes; }; } // namespace Auth #endif /* USE_AUTH */ #endif /* SQUID_AUTH_SCHEME_H */