User.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_USER_H
#define SQUID_SRC_AUTH_USER_H
 
#if USE_AUTH
 
#include "auth/CredentialState.h"
#include "auth/forward.h"
#include "auth/Type.h"
#include "base/CbcPointer.h"
#include "base/RefCount.h"
#include "dlink.h"
#include "ip/Address.h"
#include "Notes.h"
#include "sbuf/SBuf.h"
 
class StoreEntry;
 
namespace Auth
{
 
class User : public RefCountable
{
public:
    typedef RefCount<User> Pointer;
 
protected:
    User(Auth::SchemeConfig *, const char *requestRealm);
public:
    ~User() override;
 
    /* extra fields for proxy_auth */
    Auth::Type auth_type;
    Auth::SchemeConfig *config;
    dlink_list proxy_match_cache;
    size_t ipcount;
    long expiretime;
 
    NotePairs notes;
 
public:
    static SBuf BuildUserKey(const char *username, const char *realm);
 
    void absorb(Auth::User::Pointer from);
    char const *username() const { return username_; }
    void username(char const *); 
 
    // NP: key is set at the same time as username_. Until then both are empty/NULL.
    const SBuf userKey() const {return userKey_;}
 
    virtual int32_t ttl() const = 0;
 
    /* Manage list of IPs using this username */
    void clearIp();
    void removeIp(Ip::Address);
    void addIp(Ip::Address);
 
    virtual void addToNameCache() = 0;
    static void CredentialsCacheStats(StoreEntry * output);
 
    // userKey ->Auth::User::Pointer cache
    // must be reimplemented in subclasses
    static CbcPointer<Auth::CredentialsCache> Cache();
 
    CredentialState credentials() const;
    void credentials(CredentialState);
 
private:
    CredentialState credentials_state;
 
private:
    const char *username_;
 
    SBuf requestRealm_;
 
    SBuf userKey_;
 
    dlink_list ip_list;
};
 
} // namespace Auth
 
#endif /* USE_AUTH */
#endif /* SQUID_SRC_AUTH_USER_H */