FilledChecklist.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_ACL_FILLEDCHECKLIST_H
#define SQUID_SRC_ACL_FILLEDCHECKLIST_H
 
#include "AccessLogEntry.h"
#include "acl/Acl.h"
#include "acl/Checklist.h"
#include "acl/forward.h"
#include "base/CbcPointer.h"
#include "error/forward.h"
#include "HttpReply.h"
#include "HttpRequest.h"
#include "ip/Address.h"
#if USE_AUTH
#include "auth/UserRequest.h"
#endif
#include "security/CertError.h"
 
class CachePeer;
class ConnStateData;
 
class ACLFilledChecklist: public ACLChecklist
{
    CBDATA_CLASS_WITH_MAKE(ACLFilledChecklist);
 
public:
    using MakingPointer = std::unique_ptr<ACLFilledChecklist>;
 
    ACLFilledChecklist();
    ACLFilledChecklist(const acl_access *, HttpRequest *);
    ~ACLFilledChecklist() override;
 
    static MakingPointer Make(const acl_access *a, HttpRequest *r) { return MakingPointer(new ACLFilledChecklist(a, r)); }
 
    static void NonBlockingCheck(MakingPointer &&p, ACLCB *cb, void *data) { p->nonBlockingCheck(cb, data); (void)p.release(); }
 
    void setRequest(HttpRequest *);
 
    void updateAle(const AccessLogEntry::Pointer &);
 
public:
    ConnStateData * conn() const;
 
    int fd() const;
 
    void setConn(ConnStateData *);
    void fd(int aDescriptor);
 
    const HttpReply &reply() const { return *reply_; }
 
    void updateReply(const HttpReply::Pointer &);
 
    bool destinationDomainChecked() const;
    void markDestinationDomainChecked();
    bool sourceDomainChecked() const;
    void markSourceDomainChecked();
 
    // ACLChecklist API
    bool hasRequest() const override { return request != nullptr; }
    bool hasReply() const override { return reply_ != nullptr; }
    bool hasAle() const override { return al != nullptr; }
    void syncAle(HttpRequest *adaptedRequest, const char *logUri) const override;
    void verifyAle() const override;
 
public:
    Ip::Address src_addr;
    Ip::Address dst_addr;
    Ip::Address my_addr;
    SBuf dst_peer_name;
    char *dst_rdns = nullptr;
 
    HttpRequest::Pointer request;
 
#if USE_AUTH
    Auth::UserRequest::Pointer auth_user_request;
#endif
#if SQUID_SNMP
    char *snmp_community = nullptr;
#endif
 
    // TODO: RefCount errors; do not ignore them because their "owner" is gone!
    CbcPointer<Security::CertErrors> sslErrors;
 
    Security::CertPointer serverCert;
 
    AccessLogEntry::Pointer al; 
 
    ExternalACLEntryPointer extacl_entry;
 
    err_type requestErrorType = ERR_MAX;
 
private:
    ConnStateData *conn_ = nullptr; 
    int fd_ = -1; 
    HttpReply::Pointer reply_; 
 
    bool destinationDomainChecked_ = false;
    bool sourceDomainChecked_ = false;
    ACLFilledChecklist(const ACLFilledChecklist &);
    ACLFilledChecklist &operator=(const ACLFilledChecklist &);
};
 
inline
ACLFilledChecklist *Filled(ACLChecklist *checklist)
{
    // this should always be safe because ACLChecklist is an abstract class
    // and ACLFilledChecklist is its only [concrete] child
    return dynamic_cast<ACLFilledChecklist*>(checklist);
}
 
#endif /* SQUID_SRC_ACL_FILLEDCHECKLIST_H */