src/comm/Connection.h

   1 /*
   2  * Copyright (C) 1996-2022 The Squid Software Foundation and contributors
   3  *
   4  * Squid software is distributed under GPLv2+ license and includes
   5  * contributions from numerous individuals and organizations.
   6  * Please see the COPYING and CONTRIBUTORS files for details.
   7  */
   8
   9 /* DEBUG: section 05    Socket Functions */
  10
  11 #ifndef _SQUIDCONNECTIONDETAIL_H_
  12 #define _SQUIDCONNECTIONDETAIL_H_
  13
  14 #include "base/CodeContext.h"
  15 #include "base/InstanceId.h"
  16 #include "comm/forward.h"
  17 #include "defines.h"
  18 #if USE_SQUID_EUI
  19 #include "eui/Eui48.h"
  20 #include "eui/Eui64.h"
  21 #endif
  22 #include "hier_code.h"
  23 #include "ip/Address.h"
  24 #include "ip/forward.h"
  25 #include "mem/forward.h"
  26 #include "time/gadgets.h"
  27
  28 #include <iosfwd>
  29 #include <ostream>
  30
  31 class CachePeer;
  32
  33 namespace Security
  34 {
  35 class NegotiationHistory;
  36 };
  37
  38 namespace Comm
  39 {
  40
  41 /* TODO: make these a struct of boolean flags members in the connection instead of a bitmap.
  42  * we can't do that until all non-comm code uses Commm::Connection objects to create FD
  43  * currently there is code still using comm_open() and comm_openex() synchronously!!
  44  */
  45 #define COMM_UNSET              0x00
  46 #define COMM_NONBLOCKING        0x01  // default flag.
  47 #define COMM_NOCLOEXEC          0x02
  48 #define COMM_REUSEADDR          0x04  // shared FD may be both accept()ing and read()ing
  49 #define COMM_DOBIND             0x08  // requires a bind()
  50 #define COMM_TRANSPARENT        0x10  // arrived via TPROXY
  51 #define COMM_INTERCEPTION       0x20  // arrived via NAT
  52 #define COMM_REUSEPORT          0x40 //< needs SO_REUSEPORT
  53 /// not registered with Comm and not owned by any connection-closing code
  54 #define COMM_ORPHANED           0x40
  55
  56 /**
  57  * Store data about the physical and logical attributes of a connection.
  58  *
  59  * Some link state can be inferred from the data, however this is not an
  60  * object for state data. But a semantic equivalent for FD with easily
  61  * accessible cached properties not requiring repeated complex lookups.
  62  *
  63  * Connection properties may be changed until the connection is opened.
  64  * Properties should be considered read-only outside of the Comm layer
  65  * code once the connection is open.
  66  *
  67  * These objects should not be passed around directly,
  68  * but a Comm::ConnectionPointer should be passed instead.
  69  */
  70 class Connection: public CodeContext
  71 {
  72     MEMPROXY_CLASS(Comm::Connection);
  73
  74 public:
  75     Connection();
  76
  77     /** Clear the connection properties and close any open socket. */
  78     virtual ~Connection();
  79
  80     /// To prevent accidental copying of Connection objects that we started to
  81     /// open or that are open, use cloneProfile() instead.
  82     Connection(const Connection &&) = delete;
  83
  84     /// Create a new closed Connection with the same configuration as this one.
  85     ConnectionPointer cloneProfile() const;
  86
  87     /// close the still-open connection when its last reference is gone
  88     void enterOrphanage() { flags |= COMM_ORPHANED; }
  89     /// resume relying on owner(s) to initiate an explicit connection closure
  90     void leaveOrphanage() { flags &= ~COMM_ORPHANED; }
  91
  92     /** Close any open socket. */
  93     void close();
  94
  95     /** Synchronize with Comm: Somebody closed our connection. */
  96     void noteClosure();
  97
  98     /** determine whether this object describes an active connection or not. */
  99     bool isOpen() const { return (fd >= 0); }
 100
 101     /** Alter the stored IP address pair.
 102      * WARNING: Does not ensure matching IPv4/IPv6 are supplied.
 103      */
 104     void setAddrs(const Ip::Address &aLocal, const Ip::Address &aRemote) {local = aLocal; remote = aRemote;}
 105
 106     /** retrieve the CachePeer pointer for use.
 107      * The caller is responsible for all CBDATA operations regarding the
 108      * used of the pointer returned.
 109      */
 110     CachePeer * getPeer() const;
 111
 112     /** alter the stored CachePeer pointer.
 113      * Perform appropriate CBDATA operations for locking the CachePeer pointer
 114      */
 115     void setPeer(CachePeer * p);
 116
 117     /** The time the connection started */
 118     time_t startTime() const {return startTime_;}
 119
 120     /** The connection lifetime */
 121     time_t lifeTime() const {return squid_curtime - startTime_;}
 122
 123     /** The time left for this connection*/
 124     time_t timeLeft(const time_t idleTimeout) const;
 125
 126     /// Connection establishment timeout for callers that have already decided
 127     /// to connect(2), either for the first time or after checking
 128     /// EnoughTimeToReForward() during any re-forwarding attempts.
 129     /// \returns the time left for this connection to become connected
 130     /// \param fwdStart The start time of the peer selection/connection process.
 131     time_t connectTimeout(const time_t fwdStart) const;
 132
 133     void noteStart() {startTime_ = squid_curtime;}
 134
 135     Security::NegotiationHistory *tlsNegotiations();
 136     const Security::NegotiationHistory *hasTlsNegotiations() const {return tlsHistory;}
 137
 138     /* CodeContext API */
 139     virtual ScopedId codeContextGist() const override;
 140     virtual std::ostream &detailCodeContext(std::ostream &os) const override;
 141
 142 public:
 143     /** Address/Port for the Squid end of a TCP link. */
 144     Ip::Address local;
 145
 146     /** Address for the Remote end of a TCP link. */
 147     Ip::Address remote;
 148
 149     /** Hierarchy code for this connection link */
 150     hier_code peerType;
 151
 152     /** Socket used by this connection. Negative if not open. */
 153     int fd;
 154
 155     /** Quality of Service TOS values currently sent on this connection */
 156     tos_t tos;
 157
 158     /** Netfilter MARK values currently sent on this connection
 159      * In case of FTP, the MARK will be sent on data connections as well.
 160      */
 161     nfmark_t nfmark;
 162
 163     /** Netfilter CONNMARK value previously retrieved from this connection
 164      * In case of FTP, the CONNMARK will NOT be applied to data connections, for one main reason:
 165      * the CONNMARK could be set by a third party like iptables and overwriting it in squid may
 166      * cause side effects and break CONNMARK-based policy. In other words, data connection is
 167      * related to control connection, but it's not the same.
 168      */
 169     nfmark_t nfConnmark = 0;
 170
 171     /** COMM flags set on this connection */
 172     int flags;
 173
 174     char rfc931[USER_IDENT_SZ];
 175
 176 #if USE_SQUID_EUI
 177     Eui::Eui48 remoteEui48;
 178     Eui::Eui64 remoteEui64;
 179 #endif
 180
 181     InstanceId<Connection, uint64_t> id;
 182
 183 private:
 184     /** cache_peer data object (if any) */
 185     CachePeer *peer_;
 186
 187     /** The time the connection object was created */
 188     time_t startTime_;
 189
 190     /** TLS connection details*/
 191     Security::NegotiationHistory *tlsHistory;
 192 };
 193
 194 }; // namespace Comm
 195
 196 std::ostream &operator << (std::ostream &os, const Comm::Connection &conn);
 197
 198 inline std::ostream &
 199 operator << (std::ostream &os, const Comm::ConnectionPointer &conn)
 200 {
 201     if (conn != nullptr)
 202         os << *conn;
 203     return os;
 204 }
 205
 206 #endif
 207