CredentialsCache.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2025 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_SRC_AUTH_CREDENTIALSCACHE_H
#define SQUID_SRC_AUTH_CREDENTIALSCACHE_H
 
#include "auth/User.h"
#include "cbdata.h"
#include "sbuf/Algorithms.h"
 
#include <unordered_map>
 
namespace Auth {
 
class CredentialsCache
{
    CBDATA_CLASS(CredentialsCache);
 
public:
    explicit CredentialsCache(const char *name, const char * const eventName);
 
    ~CredentialsCache() = default;
    CredentialsCache(const CredentialsCache&) = delete;
    CredentialsCache& operator=(const CredentialsCache&) = delete;
 
    Auth::User::Pointer lookup(const SBuf &userKey) const;
 
    void insert(const SBuf &userKey, const Auth::User::Pointer &anAuth_user);
 
    void reset() { store_.clear(); }
 
    size_t size() const { return store_.size(); }
 
    static void Cleanup(void *);
 
    void cleanup();
 
    void doConfigChangeCleanup();
 
    std::vector<Auth::User::Pointer> sortedUsersList() const;
 
private:
    void scheduleCleanup();
 
    bool gcScheduled_;
 
    typedef std::unordered_map<SBuf, Auth::User::Pointer> StoreType;
    StoreType store_;
 
    // c-string raw pointer used as event name
    const char * const cacheCleanupEventName;
};
 
} /* namespace Auth */
 
#endif /* SQUID_SRC_AUTH_CREDENTIALSCACHE_H */