SchemeConfig.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_SCHEMECONFIG_H
#define SQUID_SRC_AUTH_SCHEMECONFIG_H
 
#if USE_AUTH
 
#include "AccessLogEntry.h"
#include "auth/forward.h"
#include "auth/UserRequest.h"
#include "helper/ChildConfig.h"
 
class StoreEntry;
class HttpReply;
class HttpRequest;
class wordlist;
 
/* for Http::HdrType parameters-by-value */
#include "HttpHeader.h"
 
namespace Format
{
class Format;
}
 
namespace Auth
{
 
class SchemeConfig
{
 
public:
    static UserRequest::Pointer CreateAuthUser(const char *proxy_auth, AccessLogEntry::Pointer &al);
 
    static SchemeConfig *Find(const char *proxy_auth);
    static SchemeConfig *GetParsed(const char *proxy_auth);
    SchemeConfig() : authenticateChildren(20) {}
 
    virtual ~SchemeConfig() {}
 
    virtual bool active() const = 0;
 
    virtual UserRequest::Pointer decode(char const *proxy_auth, const HttpRequest *request, const char *requestRealm) = 0;
 
    virtual void done();
 
    virtual bool configured() const;
 
    virtual void rotateHelpers(void) = 0;
 
    virtual bool dump(StoreEntry *, const char *, SchemeConfig *) const;
 
    virtual void fixHeader(UserRequest::Pointer, HttpReply *, Http::HdrType, HttpRequest *) = 0;
 
    virtual void init(SchemeConfig *) = 0;
 
    virtual void registerWithCacheManager(void);
 
    virtual void parse(SchemeConfig *, size_t, char *);
 
    virtual const char * type() const = 0;
 
public:
    Helper::ChildConfig authenticateChildren;
    wordlist *authenticateProgram = nullptr; 
    String keyExtrasLine;  
    Format::Format *keyExtras = nullptr; 
    int keep_alive = 1; 
    int utf8 = 0; 
 
protected:
    bool isCP1251EncodingAllowed(const HttpRequest *request);
 
    SBuf realm;
};
 
} // namespace Auth
 
#endif /* USE_AUTH */
#endif /* SQUID_SRC_AUTH_SCHEMECONFIG_H */