ExternalACL.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2023 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_EXTERNALACL_H
#define SQUID_EXTERNALACL_H
 
#include "acl/Checklist.h"
#include "base/RefCount.h"
 
class external_acl;
class external_acl_data;
class StoreEntry;
 
class ExternalACLLookup : public ACLChecklist::AsyncState
{
 
public:
    static ExternalACLLookup *Instance();
    void checkForAsync(ACLChecklist *)const override;
 
    // If possible, starts an asynchronous lookup of an external ACL.
    // Otherwise, asserts (or bails if background refresh is requested).
    static void Start(ACLChecklist *checklist, external_acl_data *acl, bool bg);
 
private:
    static ExternalACLLookup instance_;
    static void LookupDone(void *data, const ExternalACLEntryPointer &result);
};
 
#include "acl/Acl.h"
 
class ACLExternal : public ACL
{
    MEMPROXY_CLASS(ACLExternal);
 
public:
    static void ExternalAclLookup(ACLChecklist * ch, ACLExternal *);
 
    ACLExternal(char const *);
    ~ACLExternal() override;
 
    char const *typeString() const override;
    void parse() override;
    int match(ACLChecklist *checklist) override;
    /* This really should be dynamic based on the external class defn */
    bool requiresAle() const override {return true;}
    bool requiresRequest() const override {return true;}
 
    /* when requiresRequest is made dynamic, review this too */
    //    virtual bool requiresReply() const {return true;}
    bool isProxyAuth() const override;
    SBufList dump() const override;
    bool valid () const override;
    bool empty () const override;
 
protected:
    external_acl_data *data;
    char const *class_;
};
 
void parse_externalAclHelper(external_acl **);
void dump_externalAclHelper(StoreEntry * sentry, const char *name, const external_acl *);
void free_externalAclHelper(external_acl **);
typedef void EAH(void *data, const ExternalACLEntryPointer &result);
void externalAclLookup(ACLChecklist * ch, void *acl_data, EAH * handler, void *data);
void externalAclInit(void);
void externalAclShutdown(void);
 
#endif /* SQUID_EXTERNALACL_H */