blob: 9a1ba9667ec2610fd15afa2b912fabe78239d2a5 [file] [log] [blame]
Willy Tarreau56e9c5e2012-07-06 09:47:57 +02001/*
2 * include/types/connection.h
3 * This file describes the connection struct and associated constants.
4 *
Willy Tarreaubaf5b9b2014-01-23 15:26:18 +01005 * Copyright (C) 2000-2014 Willy Tarreau - w@1wt.eu
Willy Tarreau56e9c5e2012-07-06 09:47:57 +02006 *
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>
Willy Tarreau2386be62017-09-21 19:40:52 +020029#include <common/ist.h>
Willy Tarreau56e9c5e2012-07-06 09:47:57 +020030
Willy Tarreaud1d54542012-09-12 22:58:11 +020031#include <types/listener.h>
Willy Tarreau3fdb3662012-11-12 00:42:33 +010032#include <types/obj_type.h>
Willy Tarreauef9a3602012-12-08 22:29:20 +010033#include <types/port_range.h>
Willy Tarreaud1d54542012-09-12 22:58:11 +020034#include <types/protocol.h>
35
Willy Tarreaud2629f22016-08-10 18:57:38 +020036#include <netinet/in_systm.h>
Bertrand Jacquin93b227d2016-06-04 15:11:10 +010037#include <netinet/ip.h>
38#include <netinet/ip6.h>
Bertrand Jacquin93b227d2016-06-04 15:11:10 +010039
Willy Tarreau56e9c5e2012-07-06 09:47:57 +020040/* referenced below */
Willy Tarreauc5788912012-08-24 18:12:41 +020041struct connection;
Olivier Houcharde2b40b92017-09-13 18:30:23 +020042struct conn_stream;
Willy Tarreauc5788912012-08-24 18:12:41 +020043struct buffer;
Willy Tarreaud84dab72016-12-22 21:13:18 +010044struct server;
Willy Tarreauc5788912012-08-24 18:12:41 +020045struct pipe;
Willy Tarreau56e9c5e2012-07-06 09:47:57 +020046
Olivier Houcharde1c6dbc2018-08-01 17:06:43 +020047enum sub_event_type {
48 SUB_CAN_SEND = 0x00000001, /* Schedule the tasklet when we can send more */
49 SUB_CAN_RECV = 0x00000002, /* Schedule the tasklet when we can recv more */
50};
51
Olivier Houchard6ff20392018-07-17 18:46:31 +020052struct wait_list {
53 struct tasklet *task;
54 struct list list;
Olivier Houcharde1c6dbc2018-08-01 17:06:43 +020055 int wait_reason;
Olivier Houchard6ff20392018-07-17 18:46:31 +020056};
Willy Tarreau585744b2017-08-24 14:31:19 +020057
58/* A connection handle is how we differenciate two connections on the lower
59 * layers. It usually is a file descriptor but can be a connection id.
60 */
61union conn_handle {
62 int fd; /* file descriptor, for regular sockets */
63};
64
Olivier Houcharde2b40b92017-09-13 18:30:23 +020065/* conn_stream flags */
66enum {
67 CS_FL_NONE = 0x00000000, /* Just for initialization purposes */
68 CS_FL_DATA_RD_ENA = 0x00000001, /* receiving data is allowed */
69 CS_FL_DATA_WR_ENA = 0x00000002, /* sending data is desired */
70
Willy Tarreau79dadb52017-10-05 15:06:07 +020071 CS_FL_SHRD = 0x00000010, /* read shut, draining extra data */
72 CS_FL_SHRR = 0x00000020, /* read shut, resetting extra data */
73 CS_FL_SHR = CS_FL_SHRD | CS_FL_SHRR, /* read shut status */
74
75 CS_FL_SHWN = 0x00000040, /* write shut, verbose mode */
76 CS_FL_SHWS = 0x00000080, /* write shut, silent mode */
77 CS_FL_SHW = CS_FL_SHWN | CS_FL_SHWS, /* write shut status */
78
79
Olivier Houcharde2b40b92017-09-13 18:30:23 +020080 CS_FL_ERROR = 0x00000100, /* a fatal error was reported */
Willy Tarreau3c8294b2017-12-10 21:13:25 +010081 CS_FL_RCV_MORE = 0x00000200, /* more bytes to receive but not enough room */
Willy Tarreaua3f7efe2018-03-02 12:25:45 +010082 CS_FL_EOS = 0x00001000, /* End of stream delivered to data layer */
83 CS_FL_REOS = 0x00002000, /* End of stream received (buffer not empty) */
Olivier Houchard6fa63d92017-11-27 18:41:32 +010084 CS_FL_WAIT_FOR_HS = 0x00010000, /* This stream is waiting for handhskae */
Olivier Houcharde2b40b92017-09-13 18:30:23 +020085};
Willy Tarreau585744b2017-08-24 14:31:19 +020086
Willy Tarreau79dadb52017-10-05 15:06:07 +020087/* cs_shutr() modes */
88enum cs_shr_mode {
89 CS_SHR_DRAIN = 0, /* read shutdown, drain any extra stuff */
90 CS_SHR_RESET = 1, /* read shutdown, reset any extra stuff */
91};
92
93/* cs_shutw() modes */
94enum cs_shw_mode {
95 CS_SHW_NORMAL = 0, /* regular write shutdown */
96 CS_SHW_SILENT = 1, /* imminent close, don't notify peer */
97};
98
Willy Tarreaubaf5b9b2014-01-23 15:26:18 +010099/* For each direction, we have a CO_FL_{SOCK,DATA}_<DIR>_ENA flag, which
100 * indicates if read or write is desired in that direction for the respective
101 * layers. The current status corresponding to the current layer being used is
102 * remembered in the CO_FL_CURR_<DIR>_ENA flag. The need to poll (ie receipt of
103 * EAGAIN) is remembered at the file descriptor level so that even when the
104 * activity is stopped and restarted, we still remember whether it was needed
105 * to poll before attempting the I/O.
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200106 *
Willy Tarreaubaf5b9b2014-01-23 15:26:18 +0100107 * The CO_FL_CURR_<DIR>_ENA flag is set from the FD status in
108 * conn_refresh_polling_flags(). The FD state is updated according to these
109 * flags in conn_cond_update_polling().
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200110 */
111
Willy Tarreau900bc932012-07-06 09:52:14 +0200112/* flags for use in connection->flags */
113enum {
Willy Tarreauf3a6d7e2012-10-03 20:00:18 +0200114 CO_FL_NONE = 0x00000000, /* Just for initialization purposes */
Willy Tarreauc76ae332012-07-12 15:32:13 +0200115
Willy Tarreauf3a6d7e2012-10-03 20:00:18 +0200116 /* Do not change these values without updating conn_*_poll_changes() ! */
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100117 CO_FL_SOCK_RD_ENA = 0x00000001, /* receiving handshakes is allowed */
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200118 CO_FL_XPRT_RD_ENA = 0x00000002, /* receiving data is allowed */
Willy Tarreauf3a6d7e2012-10-03 20:00:18 +0200119 CO_FL_CURR_RD_ENA = 0x00000004, /* receiving is currently allowed */
Willy Tarreau310987a2014-01-22 19:46:33 +0100120 /* unused : 0x00000008 */
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100121
122 CO_FL_SOCK_WR_ENA = 0x00000010, /* sending handshakes is desired */
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200123 CO_FL_XPRT_WR_ENA = 0x00000020, /* sending data is desired */
Willy Tarreauc8dd77f2012-11-05 17:52:26 +0100124 CO_FL_CURR_WR_ENA = 0x00000040, /* sending is currently desired */
Willy Tarreau310987a2014-01-22 19:46:33 +0100125 /* unused : 0x00000080 */
Willy Tarreauc76ae332012-07-12 15:32:13 +0200126
Willy Tarreauf79c8172013-10-21 16:30:56 +0200127 /* These flags indicate whether the Control and Transport layers are initialized */
128 CO_FL_CTRL_READY = 0x00000100, /* FD was registered, fd_delete() needed */
129 CO_FL_XPRT_READY = 0x00000200, /* xprt_init() done, xprt_close() needed */
130
Willy Tarreau916e12d2017-10-25 09:22:43 +0200131 CO_FL_WILL_UPDATE = 0x00000400, /* the conn handler will take care of updating the polling */
Willy Tarreau2686dca2017-04-26 16:25:12 +0200132
133 /* This flag is used by data layers to indicate they had to stop
134 * receiving data because a buffer was full. The connection handler
135 * clears it before first calling the I/O and data callbacks.
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200136 */
Willy Tarreauf3a6d7e2012-10-03 20:00:18 +0200137 CO_FL_WAIT_ROOM = 0x00000800, /* data sink is full */
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200138
Willy Tarreau986a9d22012-08-30 21:11:38 +0200139 /* These flags are used to report whether the from/to addresses are set or not */
Willy Tarreauf3a6d7e2012-10-03 20:00:18 +0200140 CO_FL_ADDR_FROM_SET = 0x00001000, /* addr.from is set */
141 CO_FL_ADDR_TO_SET = 0x00002000, /* addr.to is set */
142
Olivier Houchardc2aae742017-09-22 18:26:28 +0200143 CO_FL_EARLY_SSL_HS = 0x00004000, /* We have early data pending, don't start SSL handshake yet */
144 CO_FL_EARLY_DATA = 0x00008000, /* At least some of the data are early data */
Willy Tarreaubbae3f02017-08-30 09:59:52 +0200145 /* unused : 0x00010000 */
146 /* unused : 0x00020000 */
Willy Tarreau2ba44652012-08-20 17:30:32 +0200147
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200148 /* flags used to remember what shutdown have been performed/reported */
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200149 CO_FL_SOCK_RD_SH = 0x00040000, /* SOCK layer was notified about shutr/read0 */
150 CO_FL_SOCK_WR_SH = 0x00080000, /* SOCK layer asked for shutw */
151
Willy Tarreau3c0cc492017-03-19 07:54:28 +0100152 /* flags used to report connection errors or other closing conditions */
Willy Tarreauf3a6d7e2012-10-03 20:00:18 +0200153 CO_FL_ERROR = 0x00100000, /* a fatal error was reported */
Willy Tarreau8e3c6ce2017-08-28 15:46:01 +0200154 CO_FL_NOTIFY_DONE = 0x001C0000, /* any xprt shut/error flags above needs to be reported */
Willy Tarreau82967bf2017-09-20 17:46:46 +0200155 CO_FL_NOTIFY_DATA = 0x001C0000, /* any shut/error flags above needs to be reported */
Willy Tarreau3c0cc492017-03-19 07:54:28 +0100156
157 /* flags used to report connection status updates */
158 CO_FL_CONNECTED = 0x00200000, /* L4+L6 now ready ; extra handshakes may or may not exist */
Willy Tarreauf3a6d7e2012-10-03 20:00:18 +0200159 CO_FL_WAIT_L4_CONN = 0x00400000, /* waiting for L4 to be connected */
160 CO_FL_WAIT_L6_CONN = 0x00800000, /* waiting for L6 to be connected (eg: SSL) */
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200161
Willy Tarreauf3a6d7e2012-10-03 20:00:18 +0200162 /*** All the flags below are used for connection handshakes. Any new
163 * handshake should be added after this point, and CO_FL_HANDSHAKE
164 * should be updated.
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200165 */
Willy Tarreau57cd3e42013-10-24 22:01:26 +0200166 CO_FL_SEND_PROXY = 0x01000000, /* send a valid PROXY protocol header */
Willy Tarreauf3a6d7e2012-10-03 20:00:18 +0200167 CO_FL_SSL_WAIT_HS = 0x02000000, /* wait for an SSL handshake to complete */
Willy Tarreau5f1504f2012-10-04 23:55:57 +0200168 CO_FL_ACCEPT_PROXY = 0x04000000, /* receive a valid PROXY protocol header */
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100169 CO_FL_ACCEPT_CIP = 0x08000000, /* receive a valid NetScaler Client IP header */
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200170
Willy Tarreauf3a6d7e2012-10-03 20:00:18 +0200171 /* below we have all handshake flags grouped into one */
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100172 CO_FL_HANDSHAKE = CO_FL_SEND_PROXY | CO_FL_SSL_WAIT_HS | CO_FL_ACCEPT_PROXY | CO_FL_ACCEPT_CIP,
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200173
Willy Tarreauf3a6d7e2012-10-03 20:00:18 +0200174 /* when any of these flags is set, polling is defined by socket-layer
175 * operations, as opposed to data-layer. Transport is explicitly not
176 * mentionned here to avoid any confusion, since it can be the same
177 * as DATA or SOCK on some implementations.
178 */
179 CO_FL_POLL_SOCK = CO_FL_HANDSHAKE | CO_FL_WAIT_L4_CONN | CO_FL_WAIT_L6_CONN,
Willy Tarreau1e954912012-10-12 17:50:05 +0200180
Willy Tarreau387ebf82015-08-04 19:24:13 +0200181 /* This connection may not be shared between clients */
182 CO_FL_PRIVATE = 0x10000000,
183
Emeric Brun4f603012017-01-05 15:11:44 +0100184 /* This flag is used to know that a PROXY protocol header was sent by the client */
185 CO_FL_RCVD_PROXY = 0x20000000,
186
187 /* unused : 0x40000000 */
Willy Tarreauf79c8172013-10-21 16:30:56 +0200188
Willy Tarreau1e954912012-10-12 17:50:05 +0200189 /* This last flag indicates that the transport layer is used (for instance
190 * by logs) and must not be cleared yet. The last call to conn_xprt_close()
191 * must be done after clearing this flag.
192 */
193 CO_FL_XPRT_TRACKED = 0x80000000,
Willy Tarreau900bc932012-07-06 09:52:14 +0200194};
195
Willy Tarreau14cba4b2012-11-30 17:33:05 +0100196
197/* possible connection error codes */
198enum {
199 CO_ER_NONE, /* no error */
Willy Tarreau45b34e82014-01-24 16:06:50 +0100200
201 CO_ER_CONF_FDLIM, /* reached process' configured FD limitation */
202 CO_ER_PROC_FDLIM, /* reached process' FD limitation */
203 CO_ER_SYS_FDLIM, /* reached system's FD limitation */
204 CO_ER_SYS_MEMLIM, /* reached system buffers limitation */
205 CO_ER_NOPROTO, /* protocol not supported */
206 CO_ER_SOCK_ERR, /* other socket error */
207
208 CO_ER_PORT_RANGE, /* source port range exhausted */
209 CO_ER_CANT_BIND, /* can't bind to source address */
210 CO_ER_FREE_PORTS, /* no more free ports on the system */
211 CO_ER_ADDR_INUSE, /* local address already in use */
212
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100213 CO_ER_PRX_EMPTY, /* nothing received in PROXY protocol header */
214 CO_ER_PRX_ABORT, /* client abort during PROXY protocol header */
Willy Tarreau0af29122012-12-03 15:35:00 +0100215 CO_ER_PRX_TIMEOUT, /* timeout while waiting for a PROXY header */
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100216 CO_ER_PRX_TRUNCATED, /* truncated PROXY protocol header */
217 CO_ER_PRX_NOT_HDR, /* not a PROXY protocol header */
218 CO_ER_PRX_BAD_HDR, /* bad PROXY protocol header */
219 CO_ER_PRX_BAD_PROTO, /* unsupported protocol in PROXY header */
220
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100221 CO_ER_CIP_EMPTY, /* nothing received in NetScaler Client IP header */
222 CO_ER_CIP_ABORT, /* client abort during NetScaler Client IP header */
223 CO_ER_CIP_TIMEOUT, /* timeout while waiting for a NetScaler Client IP header */
224 CO_ER_CIP_TRUNCATED, /* truncated NetScaler Client IP header */
225 CO_ER_CIP_BAD_MAGIC, /* bad magic number in NetScaler Client IP header */
226 CO_ER_CIP_BAD_PROTO, /* unsupported protocol in NetScaler Client IP header */
227
Willy Tarreau20879a02012-12-03 16:32:10 +0100228 CO_ER_SSL_EMPTY, /* client closed during SSL handshake */
229 CO_ER_SSL_ABORT, /* client abort during SSL handshake */
Willy Tarreau0af29122012-12-03 15:35:00 +0100230 CO_ER_SSL_TIMEOUT, /* timeout during SSL handshake */
Willy Tarreau20879a02012-12-03 16:32:10 +0100231 CO_ER_SSL_TOO_MANY, /* too many SSL connections */
232 CO_ER_SSL_NO_MEM, /* no more memory to allocate an SSL connection */
233 CO_ER_SSL_RENEG, /* forbidden client renegociation */
234 CO_ER_SSL_CA_FAIL, /* client cert verification failed in the CA chain */
235 CO_ER_SSL_CRT_FAIL, /* client cert verification failed on the certificate */
Willy Tarreau71d058c2017-07-26 20:09:56 +0200236 CO_ER_SSL_MISMATCH, /* Server presented an SSL certificate different from the configured one */
237 CO_ER_SSL_MISMATCH_SNI, /* Server presented an SSL certificate different from the expected one */
Willy Tarreau20879a02012-12-03 16:32:10 +0100238 CO_ER_SSL_HANDSHAKE, /* SSL error during handshake */
Willy Tarreaub3966372014-04-25 18:54:29 +0200239 CO_ER_SSL_HANDSHAKE_HB, /* SSL error during handshake with heartbeat present */
Willy Tarreauf51c6982014-04-25 20:02:39 +0200240 CO_ER_SSL_KILLED_HB, /* Stopped a TLSv1 heartbeat attack (CVE-2014-0160) */
241 CO_ER_SSL_NO_TARGET, /* unknown target (not client nor server) */
Olivier Houchard522eea72017-11-03 16:27:47 +0100242 CO_ER_SSL_EARLY_FAILED, /* Server refused early data */
Willy Tarreau14cba4b2012-11-30 17:33:05 +0100243};
244
Willy Tarreauef9a3602012-12-08 22:29:20 +0100245/* source address settings for outgoing connections */
246enum {
247 /* Tproxy exclusive values from 0 to 7 */
248 CO_SRC_TPROXY_ADDR = 0x0001, /* bind to this non-local address when connecting */
249 CO_SRC_TPROXY_CIP = 0x0002, /* bind to the client's IP address when connecting */
250 CO_SRC_TPROXY_CLI = 0x0003, /* bind to the client's IP+port when connecting */
251 CO_SRC_TPROXY_DYN = 0x0004, /* bind to a dynamically computed non-local address */
252 CO_SRC_TPROXY_MASK = 0x0007, /* bind to a non-local address when connecting */
253
254 CO_SRC_BIND = 0x0008, /* bind to a specific source address when connecting */
255};
256
Willy Tarreau337ea572018-06-19 06:23:38 +0200257/* flags that can be passed to xprt->rcv_buf() and mux->rcv_buf() */
258enum {
259 CO_RFL_BUF_WET = 0x0001, /* Buffer still has some output data present */
260};
261
262/* flags that can be passed to xprt->snd_buf() and mux->snd_buf() */
Willy Tarreau1049b1f2014-02-02 01:51:17 +0100263enum {
264 CO_SFL_MSG_MORE = 0x0001, /* More data to come afterwards */
Willy Tarreau7bed9452014-02-02 02:00:24 +0100265 CO_SFL_STREAMER = 0x0002, /* Producer is continuously streaming data */
Willy Tarreau1049b1f2014-02-02 01:51:17 +0100266};
Willy Tarreauef9a3602012-12-08 22:29:20 +0100267
Willy Tarreau13e14102016-12-22 20:25:26 +0100268/* known transport layers (for ease of lookup) */
269enum {
270 XPRT_RAW = 0,
271 XPRT_SSL = 1,
272 XPRT_ENTRIES /* must be last one */
273};
274
Willy Tarreau28f1cb92017-12-20 16:14:44 +0100275/* MUX-specific flags */
276enum {
277 MX_FL_NONE = 0x00000000,
278 MX_FL_CLEAN_ABRT = 0x00000001, /* abort is clearly reported as an error */
279};
280
Willy Tarreauf7bc57c2012-10-03 00:19:48 +0200281/* xprt_ops describes transport-layer operations for a connection. They
282 * generally run over a socket-based control layer, but not always. Some
283 * of them are used for data transfer with the upper layer (rcv_*, snd_*)
284 * and the other ones are used to setup and release the transport layer.
Willy Tarreauc5788912012-08-24 18:12:41 +0200285 */
Willy Tarreauf7bc57c2012-10-03 00:19:48 +0200286struct xprt_ops {
Willy Tarreau7f3225f2018-06-19 06:15:17 +0200287 size_t (*rcv_buf)(struct connection *conn, struct buffer *buf, size_t count, int flags); /* recv callback */
Willy Tarreau787db9a2018-06-14 18:31:46 +0200288 size_t (*snd_buf)(struct connection *conn, const struct buffer *buf, size_t count, int flags); /* send callback */
Willy Tarreauc5788912012-08-24 18:12:41 +0200289 int (*rcv_pipe)(struct connection *conn, struct pipe *pipe, unsigned int count); /* recv-to-pipe callback */
290 int (*snd_pipe)(struct connection *conn, struct pipe *pipe); /* send-to-pipe callback */
291 void (*shutr)(struct connection *, int); /* shutr function */
292 void (*shutw)(struct connection *, int); /* shutw function */
Willy Tarreauf7bc57c2012-10-03 00:19:48 +0200293 void (*close)(struct connection *); /* close the transport layer */
294 int (*init)(struct connection *conn); /* initialize the transport layer */
Willy Tarreau5aacf782016-12-22 17:19:24 +0100295 int (*prepare_bind_conf)(struct bind_conf *conf); /* prepare a whole bind_conf */
Willy Tarreaufa983d32016-12-22 17:30:20 +0100296 void (*destroy_bind_conf)(struct bind_conf *conf); /* destroy a whole bind_conf */
Willy Tarreaud84dab72016-12-22 21:13:18 +0100297 int (*prepare_srv)(struct server *srv); /* prepare a server context */
298 void (*destroy_srv)(struct server *srv); /* destroy a server context */
Willy Tarreaua9c17412016-12-04 18:42:09 +0100299 int (*get_alpn)(const struct connection *conn, const char **str, int *len); /* get application layer name */
Willy Tarreau8e0bb0a2016-11-24 16:58:12 +0100300 char name[8]; /* transport layer name, zero-terminated */
Olivier Houchard6ff20392018-07-17 18:46:31 +0200301 int (*subscribe)(struct connection *conn, int event_type, void *param); /* Subscribe to events, such as "being able to send" */
Willy Tarreauc5788912012-08-24 18:12:41 +0200302};
303
Willy Tarreau53a47662017-08-28 10:53:00 +0200304/* mux_ops describes the mux operations, which are to be performed at the
305 * connection level after data are exchanged with the transport layer in order
306 * to propagate them to streams. The <init> function will automatically be
307 * called once the mux is instanciated by the connection's owner at the end
308 * of a transport handshake, when it is about to transfer data and the data
309 * layer is not ready yet.
310 */
311struct mux_ops {
312 int (*init)(struct connection *conn); /* early initialization */
313 void (*recv)(struct connection *conn); /* mux-layer recv callback */
Willy Tarreau53a47662017-08-28 10:53:00 +0200314 int (*wake)(struct connection *conn); /* mux-layer callback to report activity, mandatory */
Olivier Houchard8e614722017-09-13 18:30:23 +0200315 void (*update_poll)(struct conn_stream *cs); /* commit cs flags to mux/conn */
Willy Tarreau7f3225f2018-06-19 06:15:17 +0200316 size_t (*rcv_buf)(struct conn_stream *cs, struct buffer *buf, size_t count, int flags); /* Called from the upper layer to get data */
Christopher Fauletd44a9b32018-07-27 11:59:41 +0200317 size_t (*snd_buf)(struct conn_stream *cs, struct buffer *buf, size_t count, int flags); /* Called from the upper layer to send data */
Olivier Houchard8e614722017-09-13 18:30:23 +0200318 int (*rcv_pipe)(struct conn_stream *cs, struct pipe *pipe, unsigned int count); /* recv-to-pipe callback */
319 int (*snd_pipe)(struct conn_stream *cs, struct pipe *pipe); /* send-to-pipe callback */
Willy Tarreauecdb3fe2017-10-05 15:25:48 +0200320 void (*shutr)(struct conn_stream *cs, enum cs_shr_mode); /* shutr function */
321 void (*shutw)(struct conn_stream *cs, enum cs_shw_mode); /* shutw function */
Olivier Houchard8e614722017-09-13 18:30:23 +0200322
Olivier Houchard8e614722017-09-13 18:30:23 +0200323 struct conn_stream *(*attach)(struct connection *); /* Create and attach a conn_stream to an outgoing connection */
324 void (*detach)(struct conn_stream *); /* Detach a conn_stream from an outgoing connection, when the request is done */
Willy Tarreau83061a82018-07-13 11:56:34 +0200325 void (*show_fd)(struct buffer *, struct connection *); /* append some data about connection into chunk for "show fd" */
Olivier Houchard6ff20392018-07-17 18:46:31 +0200326 int (*subscribe)(struct conn_stream *cs, int event_type, void *param); /* Subscribe to events, such as "being able to send" */
Willy Tarreau28f1cb92017-12-20 16:14:44 +0100327 unsigned int flags; /* some flags characterizing the mux's capabilities (MX_FL_*) */
Willy Tarreau53a47662017-08-28 10:53:00 +0200328 char name[8]; /* mux layer name, zero-terminated */
329};
330
Willy Tarreau74beec32012-10-03 00:41:04 +0200331/* data_cb describes the data layer's recv and send callbacks which are called
Willy Tarreauf7bc57c2012-10-03 00:19:48 +0200332 * when I/O activity was detected after the transport layer is ready. These
333 * callbacks are supposed to make use of the xprt_ops above to exchange data
Willy Tarreau4aa36832012-10-02 20:07:22 +0200334 * from/to buffers and pipes. The <wake> callback is used to report activity
335 * at the transport layer, which can be a connection opening/close, or any
Willy Tarreau8e3c6ce2017-08-28 15:46:01 +0200336 * data movement. It may abort a connection by returning < 0.
Willy Tarreauc5788912012-08-24 18:12:41 +0200337 */
Willy Tarreau74beec32012-10-03 00:41:04 +0200338struct data_cb {
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200339 void (*recv)(struct conn_stream *cs); /* data-layer recv callback */
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200340 int (*wake)(struct conn_stream *cs); /* data-layer callback to report activity */
Olivier Houchard6ff20392018-07-17 18:46:31 +0200341 int (*subscribe)(struct conn_stream *cs, int event_type, void *param); /* Subscribe to events, such as "being able to send" */
Willy Tarreau8e0bb0a2016-11-24 16:58:12 +0100342 char name[8]; /* data layer name, zero-terminated */
Willy Tarreauc5788912012-08-24 18:12:41 +0200343};
344
David Carlier3015a2e2016-07-04 22:51:33 +0100345struct my_tcphdr {
David Carlier327298c2016-11-20 10:42:38 +0000346 uint16_t source;
347 uint16_t dest;
David Carlier3015a2e2016-07-04 22:51:33 +0100348};
349
Willy Tarreauef9a3602012-12-08 22:29:20 +0100350/* a connection source profile defines all the parameters needed to properly
351 * bind an outgoing connection for a server or proxy.
352 */
353
354struct conn_src {
355 unsigned int opts; /* CO_SRC_* */
356 int iface_len; /* bind interface name length */
357 char *iface_name; /* bind interface name or NULL */
358 struct port_range *sport_range; /* optional per-server TCP source ports */
359 struct sockaddr_storage source_addr; /* the address to which we want to bind for connect() */
Willy Tarreau29fbe512015-08-20 19:35:14 +0200360#if defined(CONFIG_HAP_TRANSPARENT)
Willy Tarreauef9a3602012-12-08 22:29:20 +0100361 struct sockaddr_storage tproxy_addr; /* non-local address we want to bind to for connect() */
362 char *bind_hdr_name; /* bind to this header name if defined */
363 int bind_hdr_len; /* length of the name of the header above */
364 int bind_hdr_occ; /* occurrence number of header above: >0 = from first, <0 = from end, 0=disabled */
365#endif
366};
367
Olivier Houcharde2b40b92017-09-13 18:30:23 +0200368/*
369 * This structure describes the elements of a connection relevant to a stream
370 */
371struct conn_stream {
372 enum obj_type obj_type; /* differentiates connection from applet context */
Willy Tarreau5e1cc5e2018-03-02 10:43:58 +0100373 /* 3 bytes hole here */
Olivier Houchard6ff20392018-07-17 18:46:31 +0200374 unsigned int flags; /* CS_FL_* */
Olivier Houcharde2b40b92017-09-13 18:30:23 +0200375 struct connection *conn; /* xprt-level connection */
Olivier Houchard910b2bc2018-07-17 18:49:38 +0200376 struct wait_list wait_list; /* We're in a wait list for send */
Olivier Houchard6ff20392018-07-17 18:46:31 +0200377 struct list send_wait_list; /* list of tasks to wake when we're ready to send */
Olivier Houcharde2b40b92017-09-13 18:30:23 +0200378 void *data; /* pointer to upper layer's entity (eg: stream interface) */
379 const struct data_cb *data_cb; /* data layer callbacks. Must be set before xprt->init() */
380 void *ctx; /* mux-specific context */
381};
382
Willy Tarreau56e9c5e2012-07-06 09:47:57 +0200383/* This structure describes a connection with its methods and data.
384 * A connection may be performed to proxy or server via a local or remote
385 * socket, and can also be made to an internal applet. It can support
Willy Tarreau51c21842013-09-29 09:06:42 +0200386 * several transport schemes (raw, ssl, ...). It can support several
Willy Tarreau56e9c5e2012-07-06 09:47:57 +0200387 * connection control schemes, generally a protocol for socket-oriented
Willy Tarreau8e3c6ce2017-08-28 15:46:01 +0200388 * connections, but other methods for applets. The xprt_done_cb() callback
389 * is called once the transport layer initialization is done (success or
390 * failure). It may return < 0 to report an error and require an abort of the
391 * connection being instanciated. It must be removed once done.
Willy Tarreau56e9c5e2012-07-06 09:47:57 +0200392 */
393struct connection {
Olivier Houchard6ff20392018-07-17 18:46:31 +0200394 /* first cache line */
Willy Tarreau51c21842013-09-29 09:06:42 +0200395 enum obj_type obj_type; /* differentiates connection from applet context */
Willy Tarreauad5281c2013-12-06 21:09:57 +0100396 unsigned char err_code; /* CO_ER_* */
397 signed short send_proxy_ofs; /* <0 = offset to (re)send from the end, >0 = send all */
Willy Tarreaub8020ce2013-10-24 21:10:08 +0200398 unsigned int flags; /* CO_FL_* */
Willy Tarreauc5788912012-08-24 18:12:41 +0200399 const struct protocol *ctrl; /* operations at the socket layer */
Willy Tarreau378e0412012-10-13 14:33:58 +0200400 const struct xprt_ops *xprt; /* operations at the transport layer */
Willy Tarreau53a47662017-08-28 10:53:00 +0200401 const struct mux_ops *mux; /* mux layer opreations. Must be set before xprt->init() */
Willy Tarreau378e0412012-10-13 14:33:58 +0200402 void *xprt_ctx; /* general purpose pointer, initialized to NULL */
Willy Tarreau53a47662017-08-28 10:53:00 +0200403 void *mux_ctx; /* mux-specific context, initialized to NULL */
Olivier Houchard9aaf7782017-09-13 18:30:23 +0200404 void *owner; /* pointer to the owner session for incoming connections, or NULL */
Olivier Houchard6ff20392018-07-17 18:46:31 +0200405 enum obj_type *target; /* the target to connect to (server, proxy, applet, ...) */
406
407 /* second cache line */
408 struct list send_wait_list; /* list of tasks to wake when we're ready to send */
409 struct list list; /* attach point to various connection lists (idle, ...) */
Willy Tarreaub8020ce2013-10-24 21:10:08 +0200410 int xprt_st; /* transport layer state, initialized to zero */
Willy Tarreau53a47662017-08-28 10:53:00 +0200411 int tmp_early_data; /* 1st byte of early data, if any */
Olivier Houchard90084a12017-11-23 18:21:29 +0100412 int sent_early_data; /* Amount of early data we sent so far */
Willy Tarreau585744b2017-08-24 14:31:19 +0200413 union conn_handle handle; /* connection handle at the socket layer */
Olivier Houchard6ff20392018-07-17 18:46:31 +0200414 const struct netns_entry *proxy_netns;
Willy Tarreau8e3c6ce2017-08-28 15:46:01 +0200415 int (*xprt_done_cb)(struct connection *conn); /* callback to notify of end of handshake */
Olivier Houchard6ff20392018-07-17 18:46:31 +0200416
417 /* third cache line and beyond */
Willy Tarreau436d3332017-10-08 11:16:46 +0200418 void (*destroy_cb)(struct connection *conn); /* callback to notify of imminent death of the connection */
Willy Tarreau986a9d22012-08-30 21:11:38 +0200419 struct {
420 struct sockaddr_storage from; /* client address, or address to spoof when connecting to the server */
Willy Tarreaucd379952012-09-27 22:14:33 +0200421 struct sockaddr_storage to; /* address reached by the client, or address to connect to */
Willy Tarreau986a9d22012-08-30 21:11:38 +0200422 } addr; /* addresses of the remote side, client for producer and server for consumer */
Willy Tarreau56e9c5e2012-07-06 09:47:57 +0200423};
424
Christopher Faulet32f61c02018-04-10 14:33:41 +0200425/* PROTO token registration */
426enum proto_proxy_mode {
427 PROTO_MODE_NONE = 0,
428 PROTO_MODE_TCP = 1 << 0, // must not be changed!
429 PROTO_MODE_HTTP = 1 << 1, // must not be changed!
430 PROTO_MODE_ANY = PROTO_MODE_TCP | PROTO_MODE_HTTP,
Willy Tarreau2386be62017-09-21 19:40:52 +0200431};
432
Christopher Faulet32f61c02018-04-10 14:33:41 +0200433enum proto_proxy_side {
434 PROTO_SIDE_NONE = 0,
435 PROTO_SIDE_FE = 1, // same as PR_CAP_FE
436 PROTO_SIDE_BE = 2, // same as PR_CAP_BE
437 PROTO_SIDE_BOTH = PROTO_SIDE_FE | PROTO_SIDE_BE,
Christopher Faulet2d5292a2018-03-06 14:43:47 +0100438};
439
Christopher Faulet32f61c02018-04-10 14:33:41 +0200440struct mux_proto_list {
Willy Tarreau2386be62017-09-21 19:40:52 +0200441 const struct ist token; /* token name and length. Empty is catch-all */
Christopher Faulet32f61c02018-04-10 14:33:41 +0200442 enum proto_proxy_mode mode;
443 enum proto_proxy_side side;
Willy Tarreau2386be62017-09-21 19:40:52 +0200444 const struct mux_ops *mux;
445 struct list list;
446};
447
David Safb76832014-05-08 23:42:08 -0400448/* proxy protocol v2 definitions */
Willy Tarreau8fccfa22014-06-14 08:28:06 +0200449#define PP2_SIGNATURE "\x0D\x0A\x0D\x0A\x00\x0D\x0A\x51\x55\x49\x54\x0A"
450#define PP2_SIGNATURE_LEN 12
451#define PP2_HEADER_LEN 16
David Safb76832014-05-08 23:42:08 -0400452
Willy Tarreau8fccfa22014-06-14 08:28:06 +0200453/* ver_cmd byte */
454#define PP2_CMD_LOCAL 0x00
455#define PP2_CMD_PROXY 0x01
456#define PP2_CMD_MASK 0x0F
David Safb76832014-05-08 23:42:08 -0400457
Willy Tarreau8fccfa22014-06-14 08:28:06 +0200458#define PP2_VERSION 0x20
459#define PP2_VERSION_MASK 0xF0
460
461/* fam byte */
462#define PP2_TRANS_UNSPEC 0x00
463#define PP2_TRANS_STREAM 0x01
464#define PP2_TRANS_DGRAM 0x02
465#define PP2_TRANS_MASK 0x0F
466
467#define PP2_FAM_UNSPEC 0x00
468#define PP2_FAM_INET 0x10
469#define PP2_FAM_INET6 0x20
470#define PP2_FAM_UNIX 0x30
471#define PP2_FAM_MASK 0xF0
472
473#define PP2_ADDR_LEN_UNSPEC (0)
474#define PP2_ADDR_LEN_INET (4 + 4 + 2 + 2)
475#define PP2_ADDR_LEN_INET6 (16 + 16 + 2 + 2)
476#define PP2_ADDR_LEN_UNIX (108 + 108)
477
478#define PP2_HDR_LEN_UNSPEC (PP2_HEADER_LEN + PP2_ADDR_LEN_UNSPEC)
479#define PP2_HDR_LEN_INET (PP2_HEADER_LEN + PP2_ADDR_LEN_INET)
480#define PP2_HDR_LEN_INET6 (PP2_HEADER_LEN + PP2_ADDR_LEN_INET6)
481#define PP2_HDR_LEN_UNIX (PP2_HEADER_LEN + PP2_ADDR_LEN_UNIX)
David Safb76832014-05-08 23:42:08 -0400482
483struct proxy_hdr_v2 {
484 uint8_t sig[12]; /* hex 0D 0A 0D 0A 00 0D 0A 51 55 49 54 0A */
Willy Tarreau8fccfa22014-06-14 08:28:06 +0200485 uint8_t ver_cmd; /* protocol version and command */
David Safb76832014-05-08 23:42:08 -0400486 uint8_t fam; /* protocol family and transport */
487 uint16_t len; /* number of following bytes part of the header */
Willy Tarreau8fccfa22014-06-14 08:28:06 +0200488 union {
489 struct { /* for TCP/UDP over IPv4, len = 12 */
490 uint32_t src_addr;
491 uint32_t dst_addr;
492 uint16_t src_port;
493 uint16_t dst_port;
494 } ip4;
495 struct { /* for TCP/UDP over IPv6, len = 36 */
496 uint8_t src_addr[16];
497 uint8_t dst_addr[16];
498 uint16_t src_port;
499 uint16_t dst_port;
500 } ip6;
501 struct { /* for AF_UNIX sockets, len = 216 */
502 uint8_t src_addr[108];
503 uint8_t dst_addr[108];
504 } unx;
505 } addr;
David Safb76832014-05-08 23:42:08 -0400506};
507
Emmanuel Hocdet58118b42017-10-13 12:15:28 +0200508#define PP2_TYPE_ALPN 0x01
509#define PP2_TYPE_AUTHORITY 0x02
510#define PP2_TYPE_CRC32C 0x03
511#define PP2_TYPE_NOOP 0x04
512#define PP2_TYPE_SSL 0x20
513#define PP2_SUBTYPE_SSL_VERSION 0x21
514#define PP2_SUBTYPE_SSL_CN 0x22
515#define PP2_SUBTYPE_SSL_CIPHER 0x23
516#define PP2_SUBTYPE_SSL_SIG_ALG 0x24
517#define PP2_SUBTYPE_SSL_KEY_ALG 0x25
518#define PP2_TYPE_NETNS 0x30
David Safb76832014-05-08 23:42:08 -0400519
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +0100520#define TLV_HEADER_SIZE 3
David Safb76832014-05-08 23:42:08 -0400521struct tlv {
522 uint8_t type;
523 uint8_t length_hi;
524 uint8_t length_lo;
525 uint8_t value[0];
526}__attribute__((packed));
527
528struct tlv_ssl {
529 struct tlv tlv;
530 uint8_t client;
531 uint32_t verify;
532 uint8_t sub_tlv[0];
533}__attribute__((packed));
534
Dave McCowan328fb582014-07-30 10:39:13 -0400535#define PP2_CLIENT_SSL 0x01
536#define PP2_CLIENT_CERT_CONN 0x02
537#define PP2_CLIENT_CERT_SESS 0x04
David Safb76832014-05-08 23:42:08 -0400538
Olivier Houchardf886e342017-04-05 22:24:59 +0200539
540/*
541 * Linux seems to be able to send 253 fds per sendmsg(), not sure
542 * about the other OSes.
543 */
544/* Max number of file descriptors we send in one sendmsg() */
545#define MAX_SEND_FD 253
546
Willy Tarreau56e9c5e2012-07-06 09:47:57 +0200547#endif /* _TYPES_CONNECTION_H */
548
549/*
550 * Local variables:
551 * c-indent-level: 8
552 * c-basic-offset: 8
553 * End:
554 */