Willy Tarreau | 56e9c5e | 2012-07-06 09:47:57 +0200 | [diff] [blame] | 1 | /* |
| 2 | * include/types/connection.h |
| 3 | * This file describes the connection struct and associated constants. |
| 4 | * |
Willy Tarreau | baf5b9b | 2014-01-23 15:26:18 +0100 | [diff] [blame] | 5 | * Copyright (C) 2000-2014 Willy Tarreau - w@1wt.eu |
Willy Tarreau | 56e9c5e | 2012-07-06 09:47:57 +0200 | [diff] [blame] | 6 | * |
| 7 | * This library is free software; you can redistribute it and/or |
| 8 | * modify it under the terms of the GNU Lesser General Public |
| 9 | * License as published by the Free Software Foundation, version 2.1 |
| 10 | * exclusively. |
| 11 | * |
| 12 | * This library is distributed in the hope that it will be useful, |
| 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 15 | * Lesser General Public License for more details. |
| 16 | * |
| 17 | * You should have received a copy of the GNU Lesser General Public |
| 18 | * License along with this library; if not, write to the Free Software |
| 19 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
| 20 | */ |
| 21 | |
| 22 | #ifndef _TYPES_CONNECTION_H |
| 23 | #define _TYPES_CONNECTION_H |
| 24 | |
| 25 | #include <stdlib.h> |
| 26 | #include <sys/socket.h> |
| 27 | |
| 28 | #include <common/config.h> |
| 29 | |
Willy Tarreau | d1d5454 | 2012-09-12 22:58:11 +0200 | [diff] [blame] | 30 | #include <types/listener.h> |
Willy Tarreau | 3fdb366 | 2012-11-12 00:42:33 +0100 | [diff] [blame] | 31 | #include <types/obj_type.h> |
Willy Tarreau | ef9a360 | 2012-12-08 22:29:20 +0100 | [diff] [blame] | 32 | #include <types/port_range.h> |
Willy Tarreau | d1d5454 | 2012-09-12 22:58:11 +0200 | [diff] [blame] | 33 | #include <types/protocol.h> |
| 34 | |
Willy Tarreau | d2629f2 | 2016-08-10 18:57:38 +0200 | [diff] [blame] | 35 | #include <netinet/in_systm.h> |
Bertrand Jacquin | 93b227d | 2016-06-04 15:11:10 +0100 | [diff] [blame] | 36 | #include <netinet/ip.h> |
| 37 | #include <netinet/ip6.h> |
Bertrand Jacquin | 93b227d | 2016-06-04 15:11:10 +0100 | [diff] [blame] | 38 | |
Willy Tarreau | 56e9c5e | 2012-07-06 09:47:57 +0200 | [diff] [blame] | 39 | /* referenced below */ |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 40 | struct connection; |
| 41 | struct buffer; |
Willy Tarreau | d84dab7 | 2016-12-22 21:13:18 +0100 | [diff] [blame] | 42 | struct server; |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 43 | struct pipe; |
Willy Tarreau | 56e9c5e | 2012-07-06 09:47:57 +0200 | [diff] [blame] | 44 | |
Willy Tarreau | 585744b | 2017-08-24 14:31:19 +0200 | [diff] [blame] | 45 | |
| 46 | /* A connection handle is how we differenciate two connections on the lower |
| 47 | * layers. It usually is a file descriptor but can be a connection id. |
| 48 | */ |
| 49 | union conn_handle { |
| 50 | int fd; /* file descriptor, for regular sockets */ |
| 51 | }; |
| 52 | |
| 53 | |
Willy Tarreau | baf5b9b | 2014-01-23 15:26:18 +0100 | [diff] [blame] | 54 | /* For each direction, we have a CO_FL_{SOCK,DATA}_<DIR>_ENA flag, which |
| 55 | * indicates if read or write is desired in that direction for the respective |
| 56 | * layers. The current status corresponding to the current layer being used is |
| 57 | * remembered in the CO_FL_CURR_<DIR>_ENA flag. The need to poll (ie receipt of |
| 58 | * EAGAIN) is remembered at the file descriptor level so that even when the |
| 59 | * activity is stopped and restarted, we still remember whether it was needed |
| 60 | * to poll before attempting the I/O. |
Willy Tarreau | e9dfa79 | 2012-09-01 17:26:16 +0200 | [diff] [blame] | 61 | * |
Willy Tarreau | baf5b9b | 2014-01-23 15:26:18 +0100 | [diff] [blame] | 62 | * The CO_FL_CURR_<DIR>_ENA flag is set from the FD status in |
| 63 | * conn_refresh_polling_flags(). The FD state is updated according to these |
| 64 | * flags in conn_cond_update_polling(). |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 65 | */ |
| 66 | |
Willy Tarreau | 900bc93 | 2012-07-06 09:52:14 +0200 | [diff] [blame] | 67 | /* flags for use in connection->flags */ |
| 68 | enum { |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 69 | CO_FL_NONE = 0x00000000, /* Just for initialization purposes */ |
Willy Tarreau | c76ae33 | 2012-07-12 15:32:13 +0200 | [diff] [blame] | 70 | |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 71 | /* Do not change these values without updating conn_*_poll_changes() ! */ |
Willy Tarreau | c8dd77f | 2012-11-05 17:52:26 +0100 | [diff] [blame] | 72 | CO_FL_SOCK_RD_ENA = 0x00000001, /* receiving handshakes is allowed */ |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 73 | CO_FL_XPRT_RD_ENA = 0x00000002, /* receiving data is allowed */ |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 74 | CO_FL_CURR_RD_ENA = 0x00000004, /* receiving is currently allowed */ |
Willy Tarreau | 310987a | 2014-01-22 19:46:33 +0100 | [diff] [blame] | 75 | /* unused : 0x00000008 */ |
Willy Tarreau | c8dd77f | 2012-11-05 17:52:26 +0100 | [diff] [blame] | 76 | |
| 77 | CO_FL_SOCK_WR_ENA = 0x00000010, /* sending handshakes is desired */ |
Olivier Houchard | 1a0545f | 2017-09-13 18:30:23 +0200 | [diff] [blame] | 78 | CO_FL_XPRT_WR_ENA = 0x00000020, /* sending data is desired */ |
Willy Tarreau | c8dd77f | 2012-11-05 17:52:26 +0100 | [diff] [blame] | 79 | CO_FL_CURR_WR_ENA = 0x00000040, /* sending is currently desired */ |
Willy Tarreau | 310987a | 2014-01-22 19:46:33 +0100 | [diff] [blame] | 80 | /* unused : 0x00000080 */ |
Willy Tarreau | c76ae33 | 2012-07-12 15:32:13 +0200 | [diff] [blame] | 81 | |
Willy Tarreau | f79c817 | 2013-10-21 16:30:56 +0200 | [diff] [blame] | 82 | /* These flags indicate whether the Control and Transport layers are initialized */ |
| 83 | CO_FL_CTRL_READY = 0x00000100, /* FD was registered, fd_delete() needed */ |
| 84 | CO_FL_XPRT_READY = 0x00000200, /* xprt_init() done, xprt_close() needed */ |
| 85 | |
Willy Tarreau | 916e12d | 2017-10-25 09:22:43 +0200 | [diff] [blame] | 86 | CO_FL_WILL_UPDATE = 0x00000400, /* the conn handler will take care of updating the polling */ |
Willy Tarreau | 2686dca | 2017-04-26 16:25:12 +0200 | [diff] [blame] | 87 | |
| 88 | /* This flag is used by data layers to indicate they had to stop |
| 89 | * receiving data because a buffer was full. The connection handler |
| 90 | * clears it before first calling the I/O and data callbacks. |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 91 | */ |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 92 | CO_FL_WAIT_ROOM = 0x00000800, /* data sink is full */ |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 93 | |
Willy Tarreau | 986a9d2 | 2012-08-30 21:11:38 +0200 | [diff] [blame] | 94 | /* These flags are used to report whether the from/to addresses are set or not */ |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 95 | CO_FL_ADDR_FROM_SET = 0x00001000, /* addr.from is set */ |
| 96 | CO_FL_ADDR_TO_SET = 0x00002000, /* addr.to is set */ |
| 97 | |
Willy Tarreau | 8e3c6ce | 2017-08-28 15:46:01 +0200 | [diff] [blame] | 98 | /* unused : 0x00004000 */ |
Willy Tarreau | de40d79 | 2017-03-18 17:40:22 +0100 | [diff] [blame] | 99 | /* unused : 0x00008000 */ |
Willy Tarreau | bbae3f0 | 2017-08-30 09:59:52 +0200 | [diff] [blame] | 100 | /* unused : 0x00010000 */ |
| 101 | /* unused : 0x00020000 */ |
Willy Tarreau | 2ba4465 | 2012-08-20 17:30:32 +0200 | [diff] [blame] | 102 | |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 103 | /* flags used to remember what shutdown have been performed/reported */ |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 104 | CO_FL_SOCK_RD_SH = 0x00040000, /* SOCK layer was notified about shutr/read0 */ |
| 105 | CO_FL_SOCK_WR_SH = 0x00080000, /* SOCK layer asked for shutw */ |
| 106 | |
Willy Tarreau | 3c0cc49 | 2017-03-19 07:54:28 +0100 | [diff] [blame] | 107 | /* flags used to report connection errors or other closing conditions */ |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 108 | CO_FL_ERROR = 0x00100000, /* a fatal error was reported */ |
Willy Tarreau | 8e3c6ce | 2017-08-28 15:46:01 +0200 | [diff] [blame] | 109 | CO_FL_NOTIFY_DONE = 0x001C0000, /* any xprt shut/error flags above needs to be reported */ |
Willy Tarreau | 82967bf | 2017-09-20 17:46:46 +0200 | [diff] [blame] | 110 | CO_FL_NOTIFY_DATA = 0x001C0000, /* any shut/error flags above needs to be reported */ |
Willy Tarreau | 3c0cc49 | 2017-03-19 07:54:28 +0100 | [diff] [blame] | 111 | |
| 112 | /* flags used to report connection status updates */ |
| 113 | CO_FL_CONNECTED = 0x00200000, /* L4+L6 now ready ; extra handshakes may or may not exist */ |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 114 | CO_FL_WAIT_L4_CONN = 0x00400000, /* waiting for L4 to be connected */ |
| 115 | CO_FL_WAIT_L6_CONN = 0x00800000, /* waiting for L6 to be connected (eg: SSL) */ |
Willy Tarreau | e9dfa79 | 2012-09-01 17:26:16 +0200 | [diff] [blame] | 116 | |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 117 | /*** All the flags below are used for connection handshakes. Any new |
| 118 | * handshake should be added after this point, and CO_FL_HANDSHAKE |
| 119 | * should be updated. |
Willy Tarreau | e9dfa79 | 2012-09-01 17:26:16 +0200 | [diff] [blame] | 120 | */ |
Willy Tarreau | 57cd3e4 | 2013-10-24 22:01:26 +0200 | [diff] [blame] | 121 | CO_FL_SEND_PROXY = 0x01000000, /* send a valid PROXY protocol header */ |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 122 | CO_FL_SSL_WAIT_HS = 0x02000000, /* wait for an SSL handshake to complete */ |
Willy Tarreau | 5f1504f | 2012-10-04 23:55:57 +0200 | [diff] [blame] | 123 | CO_FL_ACCEPT_PROXY = 0x04000000, /* receive a valid PROXY protocol header */ |
Bertrand Jacquin | 93b227d | 2016-06-04 15:11:10 +0100 | [diff] [blame] | 124 | CO_FL_ACCEPT_CIP = 0x08000000, /* receive a valid NetScaler Client IP header */ |
Willy Tarreau | e9dfa79 | 2012-09-01 17:26:16 +0200 | [diff] [blame] | 125 | |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 126 | /* below we have all handshake flags grouped into one */ |
Bertrand Jacquin | 93b227d | 2016-06-04 15:11:10 +0100 | [diff] [blame] | 127 | CO_FL_HANDSHAKE = CO_FL_SEND_PROXY | CO_FL_SSL_WAIT_HS | CO_FL_ACCEPT_PROXY | CO_FL_ACCEPT_CIP, |
Willy Tarreau | b5e2cbd | 2012-08-17 11:55:04 +0200 | [diff] [blame] | 128 | |
Willy Tarreau | f3a6d7e | 2012-10-03 20:00:18 +0200 | [diff] [blame] | 129 | /* when any of these flags is set, polling is defined by socket-layer |
| 130 | * operations, as opposed to data-layer. Transport is explicitly not |
| 131 | * mentionned here to avoid any confusion, since it can be the same |
| 132 | * as DATA or SOCK on some implementations. |
| 133 | */ |
| 134 | CO_FL_POLL_SOCK = CO_FL_HANDSHAKE | CO_FL_WAIT_L4_CONN | CO_FL_WAIT_L6_CONN, |
Willy Tarreau | 1e95491 | 2012-10-12 17:50:05 +0200 | [diff] [blame] | 135 | |
Willy Tarreau | 387ebf8 | 2015-08-04 19:24:13 +0200 | [diff] [blame] | 136 | /* This connection may not be shared between clients */ |
| 137 | CO_FL_PRIVATE = 0x10000000, |
| 138 | |
Emeric Brun | 4f60301 | 2017-01-05 15:11:44 +0100 | [diff] [blame] | 139 | /* This flag is used to know that a PROXY protocol header was sent by the client */ |
| 140 | CO_FL_RCVD_PROXY = 0x20000000, |
| 141 | |
| 142 | /* unused : 0x40000000 */ |
Willy Tarreau | f79c817 | 2013-10-21 16:30:56 +0200 | [diff] [blame] | 143 | |
Willy Tarreau | 1e95491 | 2012-10-12 17:50:05 +0200 | [diff] [blame] | 144 | /* This last flag indicates that the transport layer is used (for instance |
| 145 | * by logs) and must not be cleared yet. The last call to conn_xprt_close() |
| 146 | * must be done after clearing this flag. |
| 147 | */ |
| 148 | CO_FL_XPRT_TRACKED = 0x80000000, |
Willy Tarreau | 900bc93 | 2012-07-06 09:52:14 +0200 | [diff] [blame] | 149 | }; |
| 150 | |
Willy Tarreau | 14cba4b | 2012-11-30 17:33:05 +0100 | [diff] [blame] | 151 | |
| 152 | /* possible connection error codes */ |
| 153 | enum { |
| 154 | CO_ER_NONE, /* no error */ |
Willy Tarreau | 45b34e8 | 2014-01-24 16:06:50 +0100 | [diff] [blame] | 155 | |
| 156 | CO_ER_CONF_FDLIM, /* reached process' configured FD limitation */ |
| 157 | CO_ER_PROC_FDLIM, /* reached process' FD limitation */ |
| 158 | CO_ER_SYS_FDLIM, /* reached system's FD limitation */ |
| 159 | CO_ER_SYS_MEMLIM, /* reached system buffers limitation */ |
| 160 | CO_ER_NOPROTO, /* protocol not supported */ |
| 161 | CO_ER_SOCK_ERR, /* other socket error */ |
| 162 | |
| 163 | CO_ER_PORT_RANGE, /* source port range exhausted */ |
| 164 | CO_ER_CANT_BIND, /* can't bind to source address */ |
| 165 | CO_ER_FREE_PORTS, /* no more free ports on the system */ |
| 166 | CO_ER_ADDR_INUSE, /* local address already in use */ |
| 167 | |
Willy Tarreau | 8e3bf69 | 2012-12-03 15:41:18 +0100 | [diff] [blame] | 168 | CO_ER_PRX_EMPTY, /* nothing received in PROXY protocol header */ |
| 169 | CO_ER_PRX_ABORT, /* client abort during PROXY protocol header */ |
Willy Tarreau | 0af2912 | 2012-12-03 15:35:00 +0100 | [diff] [blame] | 170 | CO_ER_PRX_TIMEOUT, /* timeout while waiting for a PROXY header */ |
Willy Tarreau | 8e3bf69 | 2012-12-03 15:41:18 +0100 | [diff] [blame] | 171 | CO_ER_PRX_TRUNCATED, /* truncated PROXY protocol header */ |
| 172 | CO_ER_PRX_NOT_HDR, /* not a PROXY protocol header */ |
| 173 | CO_ER_PRX_BAD_HDR, /* bad PROXY protocol header */ |
| 174 | CO_ER_PRX_BAD_PROTO, /* unsupported protocol in PROXY header */ |
| 175 | |
Bertrand Jacquin | 93b227d | 2016-06-04 15:11:10 +0100 | [diff] [blame] | 176 | CO_ER_CIP_EMPTY, /* nothing received in NetScaler Client IP header */ |
| 177 | CO_ER_CIP_ABORT, /* client abort during NetScaler Client IP header */ |
| 178 | CO_ER_CIP_TIMEOUT, /* timeout while waiting for a NetScaler Client IP header */ |
| 179 | CO_ER_CIP_TRUNCATED, /* truncated NetScaler Client IP header */ |
| 180 | CO_ER_CIP_BAD_MAGIC, /* bad magic number in NetScaler Client IP header */ |
| 181 | CO_ER_CIP_BAD_PROTO, /* unsupported protocol in NetScaler Client IP header */ |
| 182 | |
Willy Tarreau | 20879a0 | 2012-12-03 16:32:10 +0100 | [diff] [blame] | 183 | CO_ER_SSL_EMPTY, /* client closed during SSL handshake */ |
| 184 | CO_ER_SSL_ABORT, /* client abort during SSL handshake */ |
Willy Tarreau | 0af2912 | 2012-12-03 15:35:00 +0100 | [diff] [blame] | 185 | CO_ER_SSL_TIMEOUT, /* timeout during SSL handshake */ |
Willy Tarreau | 20879a0 | 2012-12-03 16:32:10 +0100 | [diff] [blame] | 186 | CO_ER_SSL_TOO_MANY, /* too many SSL connections */ |
| 187 | CO_ER_SSL_NO_MEM, /* no more memory to allocate an SSL connection */ |
| 188 | CO_ER_SSL_RENEG, /* forbidden client renegociation */ |
| 189 | CO_ER_SSL_CA_FAIL, /* client cert verification failed in the CA chain */ |
| 190 | CO_ER_SSL_CRT_FAIL, /* client cert verification failed on the certificate */ |
Willy Tarreau | 71d058c | 2017-07-26 20:09:56 +0200 | [diff] [blame] | 191 | CO_ER_SSL_MISMATCH, /* Server presented an SSL certificate different from the configured one */ |
| 192 | CO_ER_SSL_MISMATCH_SNI, /* Server presented an SSL certificate different from the expected one */ |
Willy Tarreau | 20879a0 | 2012-12-03 16:32:10 +0100 | [diff] [blame] | 193 | CO_ER_SSL_HANDSHAKE, /* SSL error during handshake */ |
Willy Tarreau | b396637 | 2014-04-25 18:54:29 +0200 | [diff] [blame] | 194 | CO_ER_SSL_HANDSHAKE_HB, /* SSL error during handshake with heartbeat present */ |
Willy Tarreau | f51c698 | 2014-04-25 20:02:39 +0200 | [diff] [blame] | 195 | CO_ER_SSL_KILLED_HB, /* Stopped a TLSv1 heartbeat attack (CVE-2014-0160) */ |
| 196 | CO_ER_SSL_NO_TARGET, /* unknown target (not client nor server) */ |
Willy Tarreau | 14cba4b | 2012-11-30 17:33:05 +0100 | [diff] [blame] | 197 | }; |
| 198 | |
Willy Tarreau | ef9a360 | 2012-12-08 22:29:20 +0100 | [diff] [blame] | 199 | /* source address settings for outgoing connections */ |
| 200 | enum { |
| 201 | /* Tproxy exclusive values from 0 to 7 */ |
| 202 | CO_SRC_TPROXY_ADDR = 0x0001, /* bind to this non-local address when connecting */ |
| 203 | CO_SRC_TPROXY_CIP = 0x0002, /* bind to the client's IP address when connecting */ |
| 204 | CO_SRC_TPROXY_CLI = 0x0003, /* bind to the client's IP+port when connecting */ |
| 205 | CO_SRC_TPROXY_DYN = 0x0004, /* bind to a dynamically computed non-local address */ |
| 206 | CO_SRC_TPROXY_MASK = 0x0007, /* bind to a non-local address when connecting */ |
| 207 | |
| 208 | CO_SRC_BIND = 0x0008, /* bind to a specific source address when connecting */ |
| 209 | }; |
| 210 | |
Willy Tarreau | 1049b1f | 2014-02-02 01:51:17 +0100 | [diff] [blame] | 211 | /* flags that can be passed to xprt->snd_buf() */ |
| 212 | enum { |
| 213 | CO_SFL_MSG_MORE = 0x0001, /* More data to come afterwards */ |
Willy Tarreau | 7bed945 | 2014-02-02 02:00:24 +0100 | [diff] [blame] | 214 | CO_SFL_STREAMER = 0x0002, /* Producer is continuously streaming data */ |
Willy Tarreau | 1049b1f | 2014-02-02 01:51:17 +0100 | [diff] [blame] | 215 | }; |
Willy Tarreau | ef9a360 | 2012-12-08 22:29:20 +0100 | [diff] [blame] | 216 | |
Willy Tarreau | 13e1410 | 2016-12-22 20:25:26 +0100 | [diff] [blame] | 217 | /* known transport layers (for ease of lookup) */ |
| 218 | enum { |
| 219 | XPRT_RAW = 0, |
| 220 | XPRT_SSL = 1, |
| 221 | XPRT_ENTRIES /* must be last one */ |
| 222 | }; |
| 223 | |
Willy Tarreau | f7bc57c | 2012-10-03 00:19:48 +0200 | [diff] [blame] | 224 | /* xprt_ops describes transport-layer operations for a connection. They |
| 225 | * generally run over a socket-based control layer, but not always. Some |
| 226 | * of them are used for data transfer with the upper layer (rcv_*, snd_*) |
| 227 | * and the other ones are used to setup and release the transport layer. |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 228 | */ |
Willy Tarreau | f7bc57c | 2012-10-03 00:19:48 +0200 | [diff] [blame] | 229 | struct xprt_ops { |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 230 | int (*rcv_buf)(struct connection *conn, struct buffer *buf, int count); /* recv callback */ |
| 231 | int (*snd_buf)(struct connection *conn, struct buffer *buf, int flags); /* send callback */ |
| 232 | int (*rcv_pipe)(struct connection *conn, struct pipe *pipe, unsigned int count); /* recv-to-pipe callback */ |
| 233 | int (*snd_pipe)(struct connection *conn, struct pipe *pipe); /* send-to-pipe callback */ |
| 234 | void (*shutr)(struct connection *, int); /* shutr function */ |
| 235 | void (*shutw)(struct connection *, int); /* shutw function */ |
Willy Tarreau | f7bc57c | 2012-10-03 00:19:48 +0200 | [diff] [blame] | 236 | void (*close)(struct connection *); /* close the transport layer */ |
| 237 | int (*init)(struct connection *conn); /* initialize the transport layer */ |
Willy Tarreau | 5aacf78 | 2016-12-22 17:19:24 +0100 | [diff] [blame] | 238 | int (*prepare_bind_conf)(struct bind_conf *conf); /* prepare a whole bind_conf */ |
Willy Tarreau | fa983d3 | 2016-12-22 17:30:20 +0100 | [diff] [blame] | 239 | void (*destroy_bind_conf)(struct bind_conf *conf); /* destroy a whole bind_conf */ |
Willy Tarreau | d84dab7 | 2016-12-22 21:13:18 +0100 | [diff] [blame] | 240 | int (*prepare_srv)(struct server *srv); /* prepare a server context */ |
| 241 | void (*destroy_srv)(struct server *srv); /* destroy a server context */ |
Willy Tarreau | a9c1741 | 2016-12-04 18:42:09 +0100 | [diff] [blame] | 242 | int (*get_alpn)(const struct connection *conn, const char **str, int *len); /* get application layer name */ |
Willy Tarreau | 8e0bb0a | 2016-11-24 16:58:12 +0100 | [diff] [blame] | 243 | char name[8]; /* transport layer name, zero-terminated */ |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 244 | }; |
| 245 | |
Willy Tarreau | 74beec3 | 2012-10-03 00:41:04 +0200 | [diff] [blame] | 246 | /* data_cb describes the data layer's recv and send callbacks which are called |
Willy Tarreau | f7bc57c | 2012-10-03 00:19:48 +0200 | [diff] [blame] | 247 | * when I/O activity was detected after the transport layer is ready. These |
| 248 | * callbacks are supposed to make use of the xprt_ops above to exchange data |
Willy Tarreau | 4aa3683 | 2012-10-02 20:07:22 +0200 | [diff] [blame] | 249 | * from/to buffers and pipes. The <wake> callback is used to report activity |
| 250 | * at the transport layer, which can be a connection opening/close, or any |
Willy Tarreau | 8e3c6ce | 2017-08-28 15:46:01 +0200 | [diff] [blame] | 251 | * data movement. It may abort a connection by returning < 0. |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 252 | */ |
Willy Tarreau | 74beec3 | 2012-10-03 00:41:04 +0200 | [diff] [blame] | 253 | struct data_cb { |
| 254 | void (*recv)(struct connection *conn); /* data-layer recv callback */ |
| 255 | void (*send)(struct connection *conn); /* data-layer send callback */ |
Willy Tarreau | 2396c1c | 2012-10-03 21:12:16 +0200 | [diff] [blame] | 256 | int (*wake)(struct connection *conn); /* data-layer callback to report activity */ |
Willy Tarreau | 8e0bb0a | 2016-11-24 16:58:12 +0100 | [diff] [blame] | 257 | char name[8]; /* data layer name, zero-terminated */ |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 258 | }; |
| 259 | |
David Carlier | 3015a2e | 2016-07-04 22:51:33 +0100 | [diff] [blame] | 260 | struct my_tcphdr { |
David Carlier | 327298c | 2016-11-20 10:42:38 +0000 | [diff] [blame] | 261 | uint16_t source; |
| 262 | uint16_t dest; |
David Carlier | 3015a2e | 2016-07-04 22:51:33 +0100 | [diff] [blame] | 263 | }; |
| 264 | |
Willy Tarreau | ef9a360 | 2012-12-08 22:29:20 +0100 | [diff] [blame] | 265 | /* a connection source profile defines all the parameters needed to properly |
| 266 | * bind an outgoing connection for a server or proxy. |
| 267 | */ |
| 268 | |
| 269 | struct conn_src { |
| 270 | unsigned int opts; /* CO_SRC_* */ |
| 271 | int iface_len; /* bind interface name length */ |
| 272 | char *iface_name; /* bind interface name or NULL */ |
| 273 | struct port_range *sport_range; /* optional per-server TCP source ports */ |
| 274 | struct sockaddr_storage source_addr; /* the address to which we want to bind for connect() */ |
Willy Tarreau | 29fbe51 | 2015-08-20 19:35:14 +0200 | [diff] [blame] | 275 | #if defined(CONFIG_HAP_TRANSPARENT) |
Willy Tarreau | ef9a360 | 2012-12-08 22:29:20 +0100 | [diff] [blame] | 276 | struct sockaddr_storage tproxy_addr; /* non-local address we want to bind to for connect() */ |
| 277 | char *bind_hdr_name; /* bind to this header name if defined */ |
| 278 | int bind_hdr_len; /* length of the name of the header above */ |
| 279 | int bind_hdr_occ; /* occurrence number of header above: >0 = from first, <0 = from end, 0=disabled */ |
| 280 | #endif |
| 281 | }; |
| 282 | |
Willy Tarreau | 56e9c5e | 2012-07-06 09:47:57 +0200 | [diff] [blame] | 283 | /* This structure describes a connection with its methods and data. |
| 284 | * A connection may be performed to proxy or server via a local or remote |
| 285 | * socket, and can also be made to an internal applet. It can support |
Willy Tarreau | 51c2184 | 2013-09-29 09:06:42 +0200 | [diff] [blame] | 286 | * several transport schemes (raw, ssl, ...). It can support several |
Willy Tarreau | 56e9c5e | 2012-07-06 09:47:57 +0200 | [diff] [blame] | 287 | * connection control schemes, generally a protocol for socket-oriented |
Willy Tarreau | 8e3c6ce | 2017-08-28 15:46:01 +0200 | [diff] [blame] | 288 | * connections, but other methods for applets. The xprt_done_cb() callback |
| 289 | * is called once the transport layer initialization is done (success or |
| 290 | * failure). It may return < 0 to report an error and require an abort of the |
| 291 | * connection being instanciated. It must be removed once done. |
Willy Tarreau | 56e9c5e | 2012-07-06 09:47:57 +0200 | [diff] [blame] | 292 | */ |
| 293 | struct connection { |
Willy Tarreau | 51c2184 | 2013-09-29 09:06:42 +0200 | [diff] [blame] | 294 | enum obj_type obj_type; /* differentiates connection from applet context */ |
Willy Tarreau | ad5281c | 2013-12-06 21:09:57 +0100 | [diff] [blame] | 295 | unsigned char err_code; /* CO_ER_* */ |
| 296 | signed short send_proxy_ofs; /* <0 = offset to (re)send from the end, >0 = send all */ |
Willy Tarreau | b8020ce | 2013-10-24 21:10:08 +0200 | [diff] [blame] | 297 | unsigned int flags; /* CO_FL_* */ |
Willy Tarreau | c578891 | 2012-08-24 18:12:41 +0200 | [diff] [blame] | 298 | const struct protocol *ctrl; /* operations at the socket layer */ |
Willy Tarreau | 378e041 | 2012-10-13 14:33:58 +0200 | [diff] [blame] | 299 | const struct xprt_ops *xprt; /* operations at the transport layer */ |
Willy Tarreau | f79c817 | 2013-10-21 16:30:56 +0200 | [diff] [blame] | 300 | const struct data_cb *data; /* data layer callbacks. Must be set before xprt->init() */ |
Willy Tarreau | 378e041 | 2012-10-13 14:33:58 +0200 | [diff] [blame] | 301 | void *xprt_ctx; /* general purpose pointer, initialized to NULL */ |
Willy Tarreau | 0b74eae | 2017-08-28 19:02:51 +0200 | [diff] [blame] | 302 | void *owner; /* pointer to upper layer's entity (eg: session, stream interface) */ |
Willy Tarreau | b8020ce | 2013-10-24 21:10:08 +0200 | [diff] [blame] | 303 | int xprt_st; /* transport layer state, initialized to zero */ |
Willy Tarreau | 585744b | 2017-08-24 14:31:19 +0200 | [diff] [blame] | 304 | union conn_handle handle; /* connection handle at the socket layer */ |
Willy Tarreau | 3fdb366 | 2012-11-12 00:42:33 +0100 | [diff] [blame] | 305 | enum obj_type *target; /* the target to connect to (server, proxy, applet, ...) */ |
Willy Tarreau | d75d40e | 2015-08-04 17:25:58 +0200 | [diff] [blame] | 306 | struct list list; /* attach point to various connection lists (idle, ...) */ |
Willy Tarreau | 8e3c6ce | 2017-08-28 15:46:01 +0200 | [diff] [blame] | 307 | int (*xprt_done_cb)(struct connection *conn); /* callback to notify of end of handshake */ |
KOVACS Krisztian | b3e54fe | 2014-11-17 15:11:45 +0100 | [diff] [blame] | 308 | const struct netns_entry *proxy_netns; |
Willy Tarreau | 986a9d2 | 2012-08-30 21:11:38 +0200 | [diff] [blame] | 309 | struct { |
| 310 | struct sockaddr_storage from; /* client address, or address to spoof when connecting to the server */ |
Willy Tarreau | cd37995 | 2012-09-27 22:14:33 +0200 | [diff] [blame] | 311 | struct sockaddr_storage to; /* address reached by the client, or address to connect to */ |
Willy Tarreau | 986a9d2 | 2012-08-30 21:11:38 +0200 | [diff] [blame] | 312 | } addr; /* addresses of the remote side, client for producer and server for consumer */ |
Willy Tarreau | 56e9c5e | 2012-07-06 09:47:57 +0200 | [diff] [blame] | 313 | }; |
| 314 | |
David S | afb7683 | 2014-05-08 23:42:08 -0400 | [diff] [blame] | 315 | /* proxy protocol v2 definitions */ |
Willy Tarreau | 8fccfa2 | 2014-06-14 08:28:06 +0200 | [diff] [blame] | 316 | #define PP2_SIGNATURE "\x0D\x0A\x0D\x0A\x00\x0D\x0A\x51\x55\x49\x54\x0A" |
| 317 | #define PP2_SIGNATURE_LEN 12 |
| 318 | #define PP2_HEADER_LEN 16 |
David S | afb7683 | 2014-05-08 23:42:08 -0400 | [diff] [blame] | 319 | |
Willy Tarreau | 8fccfa2 | 2014-06-14 08:28:06 +0200 | [diff] [blame] | 320 | /* ver_cmd byte */ |
| 321 | #define PP2_CMD_LOCAL 0x00 |
| 322 | #define PP2_CMD_PROXY 0x01 |
| 323 | #define PP2_CMD_MASK 0x0F |
David S | afb7683 | 2014-05-08 23:42:08 -0400 | [diff] [blame] | 324 | |
Willy Tarreau | 8fccfa2 | 2014-06-14 08:28:06 +0200 | [diff] [blame] | 325 | #define PP2_VERSION 0x20 |
| 326 | #define PP2_VERSION_MASK 0xF0 |
| 327 | |
| 328 | /* fam byte */ |
| 329 | #define PP2_TRANS_UNSPEC 0x00 |
| 330 | #define PP2_TRANS_STREAM 0x01 |
| 331 | #define PP2_TRANS_DGRAM 0x02 |
| 332 | #define PP2_TRANS_MASK 0x0F |
| 333 | |
| 334 | #define PP2_FAM_UNSPEC 0x00 |
| 335 | #define PP2_FAM_INET 0x10 |
| 336 | #define PP2_FAM_INET6 0x20 |
| 337 | #define PP2_FAM_UNIX 0x30 |
| 338 | #define PP2_FAM_MASK 0xF0 |
| 339 | |
| 340 | #define PP2_ADDR_LEN_UNSPEC (0) |
| 341 | #define PP2_ADDR_LEN_INET (4 + 4 + 2 + 2) |
| 342 | #define PP2_ADDR_LEN_INET6 (16 + 16 + 2 + 2) |
| 343 | #define PP2_ADDR_LEN_UNIX (108 + 108) |
| 344 | |
| 345 | #define PP2_HDR_LEN_UNSPEC (PP2_HEADER_LEN + PP2_ADDR_LEN_UNSPEC) |
| 346 | #define PP2_HDR_LEN_INET (PP2_HEADER_LEN + PP2_ADDR_LEN_INET) |
| 347 | #define PP2_HDR_LEN_INET6 (PP2_HEADER_LEN + PP2_ADDR_LEN_INET6) |
| 348 | #define PP2_HDR_LEN_UNIX (PP2_HEADER_LEN + PP2_ADDR_LEN_UNIX) |
David S | afb7683 | 2014-05-08 23:42:08 -0400 | [diff] [blame] | 349 | |
| 350 | struct proxy_hdr_v2 { |
| 351 | uint8_t sig[12]; /* hex 0D 0A 0D 0A 00 0D 0A 51 55 49 54 0A */ |
Willy Tarreau | 8fccfa2 | 2014-06-14 08:28:06 +0200 | [diff] [blame] | 352 | uint8_t ver_cmd; /* protocol version and command */ |
David S | afb7683 | 2014-05-08 23:42:08 -0400 | [diff] [blame] | 353 | uint8_t fam; /* protocol family and transport */ |
| 354 | uint16_t len; /* number of following bytes part of the header */ |
Willy Tarreau | 8fccfa2 | 2014-06-14 08:28:06 +0200 | [diff] [blame] | 355 | union { |
| 356 | struct { /* for TCP/UDP over IPv4, len = 12 */ |
| 357 | uint32_t src_addr; |
| 358 | uint32_t dst_addr; |
| 359 | uint16_t src_port; |
| 360 | uint16_t dst_port; |
| 361 | } ip4; |
| 362 | struct { /* for TCP/UDP over IPv6, len = 36 */ |
| 363 | uint8_t src_addr[16]; |
| 364 | uint8_t dst_addr[16]; |
| 365 | uint16_t src_port; |
| 366 | uint16_t dst_port; |
| 367 | } ip6; |
| 368 | struct { /* for AF_UNIX sockets, len = 216 */ |
| 369 | uint8_t src_addr[108]; |
| 370 | uint8_t dst_addr[108]; |
| 371 | } unx; |
| 372 | } addr; |
David S | afb7683 | 2014-05-08 23:42:08 -0400 | [diff] [blame] | 373 | }; |
| 374 | |
| 375 | #define PP2_TYPE_SSL 0x20 |
| 376 | #define PP2_TYPE_SSL_VERSION 0x21 |
| 377 | #define PP2_TYPE_SSL_CN 0x22 |
KOVACS Krisztian | b3e54fe | 2014-11-17 15:11:45 +0100 | [diff] [blame] | 378 | #define PP2_TYPE_NETNS 0x30 |
David S | afb7683 | 2014-05-08 23:42:08 -0400 | [diff] [blame] | 379 | |
KOVACS Krisztian | b3e54fe | 2014-11-17 15:11:45 +0100 | [diff] [blame] | 380 | #define TLV_HEADER_SIZE 3 |
David S | afb7683 | 2014-05-08 23:42:08 -0400 | [diff] [blame] | 381 | struct tlv { |
| 382 | uint8_t type; |
| 383 | uint8_t length_hi; |
| 384 | uint8_t length_lo; |
| 385 | uint8_t value[0]; |
| 386 | }__attribute__((packed)); |
| 387 | |
| 388 | struct tlv_ssl { |
| 389 | struct tlv tlv; |
| 390 | uint8_t client; |
| 391 | uint32_t verify; |
| 392 | uint8_t sub_tlv[0]; |
| 393 | }__attribute__((packed)); |
| 394 | |
Dave McCowan | 328fb58 | 2014-07-30 10:39:13 -0400 | [diff] [blame] | 395 | #define PP2_CLIENT_SSL 0x01 |
| 396 | #define PP2_CLIENT_CERT_CONN 0x02 |
| 397 | #define PP2_CLIENT_CERT_SESS 0x04 |
David S | afb7683 | 2014-05-08 23:42:08 -0400 | [diff] [blame] | 398 | |
Olivier Houchard | f886e34 | 2017-04-05 22:24:59 +0200 | [diff] [blame] | 399 | |
| 400 | /* |
| 401 | * Linux seems to be able to send 253 fds per sendmsg(), not sure |
| 402 | * about the other OSes. |
| 403 | */ |
| 404 | /* Max number of file descriptors we send in one sendmsg() */ |
| 405 | #define MAX_SEND_FD 253 |
| 406 | |
Willy Tarreau | 56e9c5e | 2012-07-06 09:47:57 +0200 | [diff] [blame] | 407 | #endif /* _TYPES_CONNECTION_H */ |
| 408 | |
| 409 | /* |
| 410 | * Local variables: |
| 411 | * c-indent-level: 8 |
| 412 | * c-basic-offset: 8 |
| 413 | * End: |
| 414 | */ |