Transport.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_TOOLS_SQUIDCLIENT_TRANSPORT_H
#define SQUID_TOOLS_SQUIDCLIENT_TRANSPORT_H
 
#include "tools/squidclient/Parameters.h"
 
#if HAVE_GNUTLS_GNUTLS_H
#include <gnutls/gnutls.h>
#endif
#include <list>
#include <string>
 
namespace Transport
{
 
class TheConfig
{
public:
    TheConfig() :
        ioTimeout(120),
        localHost(nullptr),
        port(CACHE_HTTP_PORT),
        tlsEnabled(false),
        tlsAnonymous(false) {
        params = "NORMAL";
        hostname = "localhost";
    }
 
// TODO: implicit transport options depending on the protocol-specific options
//     ie --https enables TLS connection settings
 
    void usage();
 
    bool parseCommandOpts(int argc, char *argv[], int c, int &optIndex);
 
    int ioTimeout;
 
    const char *localHost;
 
    const char *hostname;
 
    uint16_t port;
 
    bool tlsEnabled;
 
    bool tlsAnonymous;
 
    const char *params;
 
    // client certificate PEM file(s)
    std::list<std::string> certFiles;
 
    // client trusted x509 certificate authorities file
    std::list<std::string> caFiles;
 
#if USE_GNUTLS
    gnutls_anon_client_credentials_t anonCredentials;
 
    // client x509 certificate credentials
    gnutls_certificate_credentials_t certCredentials;
 
    gnutls_session_t session;
#endif
};
 
extern TheConfig Config;
 
bool Connect();
 
void CloseConnection();
 
void InitTls();
 
bool MaybeStartTls(const char *hostname);
 
void ShutdownTls();
 
ssize_t Write(const void *buf, size_t len);
 
ssize_t Read(void *buf, size_t len);
 
} // namespace Transport
 
#endif /* SQUID_TOOLS_SQUIDCLIENT_TRANSPORT_H */