blob: ff3c34612b92989ca4f2dd4c0b2a57ed68defe45 [file] [log] [blame]
Willy Tarreau59f98392012-07-06 14:13:49 +02001/*
2 * Connection management functions
3 *
4 * Copyright 2000-2012 Willy Tarreau <w@1wt.eu>
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
10 *
11 */
12
Willy Tarreaue1e4a612012-10-05 00:10:55 +020013#include <errno.h>
14
Willy Tarreau59f98392012-07-06 14:13:49 +020015#include <common/compat.h>
16#include <common/config.h>
Willy Tarreau0108d902018-11-25 19:14:37 +010017#include <common/initcall.h>
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +010018#include <common/namespace.h>
Emmanuel Hocdet4399c752018-02-05 15:26:43 +010019#include <common/hash.h>
20#include <common/net_helper.h>
Willy Tarreau59f98392012-07-06 14:13:49 +020021
Willy Tarreauc5788912012-08-24 18:12:41 +020022#include <proto/connection.h>
Willy Tarreaudd2f85e2012-09-02 22:34:23 +020023#include <proto/fd.h>
Willy Tarreau5f1504f2012-10-04 23:55:57 +020024#include <proto/frontend.h>
Willy Tarreau2da156f2012-07-23 15:07:23 +020025#include <proto/proto_tcp.h>
Willy Tarreau2c6be842012-07-06 17:12:34 +020026#include <proto/stream_interface.h>
Emeric Brun4f603012017-01-05 15:11:44 +010027#include <proto/sample.h>
Emeric Brun46591952012-05-18 15:47:34 +020028#include <proto/ssl_sock.h>
Emeric Brun46591952012-05-18 15:47:34 +020029
Alexander Liu2a54bb72019-05-22 19:44:48 +080030#include <common/debug.h>
31
Willy Tarreau8ceae722018-11-26 11:58:30 +010032DECLARE_POOL(pool_head_connection, "connection", sizeof(struct connection));
33DECLARE_POOL(pool_head_connstream, "conn_stream", sizeof(struct conn_stream));
Willy Tarreauff5d57b2019-07-17 18:37:02 +020034DECLARE_POOL(pool_head_sockaddr, "sockaddr", sizeof(struct sockaddr_storage));
Geoff Simmons7185b782019-08-27 18:31:16 +020035DECLARE_POOL(pool_head_authority, "authority", PP2_AUTHORITY_MAX);
Willy Tarreau8ceae722018-11-26 11:58:30 +010036
Willy Tarreau13e14102016-12-22 20:25:26 +010037struct xprt_ops *registered_xprt[XPRT_ENTRIES] = { NULL, };
Willy Tarreauf2943dc2012-10-26 20:10:28 +020038
Christopher Faulet32f61c02018-04-10 14:33:41 +020039/* List head of all known muxes for PROTO */
40struct mux_proto_list mux_proto_list = {
41 .list = LIST_HEAD_INIT(mux_proto_list.list)
Willy Tarreau2386be62017-09-21 19:40:52 +020042};
43
Olivier Houchard477902b2020-01-22 18:08:48 +010044int conn_create_mux(struct connection *conn)
45{
Olivier Houchard477902b2020-01-22 18:08:48 +010046 if (conn_is_back(conn)) {
47 struct server *srv;
48 struct conn_stream *cs = conn->ctx;
49
50 if (conn->flags & CO_FL_ERROR)
51 goto fail;
Olivier Houcharda8a415d2020-01-23 13:15:14 +010052
Olivier Houchard477902b2020-01-22 18:08:48 +010053 if (conn_install_mux_be(conn, conn->ctx, conn->owner) < 0)
54 goto fail;
55 srv = objt_server(conn->target);
56 if (srv && ((srv->proxy->options & PR_O_REUSE_MASK) != PR_O_REUSE_NEVR) &&
57 conn->mux->avail_streams(conn) > 0)
58 LIST_ADD(&srv->idle_conns[tid], &conn->list);
59 return 0;
60fail:
61 /* let the upper layer know the connection failed */
62 cs->data_cb->wake(cs);
63 return -1;
64 } else
65 return conn_complete_session(conn);
66
67}
68
Willy Tarreau59f98392012-07-06 14:13:49 +020069/* I/O callback for fd-based connections. It calls the read/write handlers
Willy Tarreau7a798e52016-04-14 11:13:20 +020070 * provided by the connection's sock_ops, which must be valid.
Willy Tarreau59f98392012-07-06 14:13:49 +020071 */
Willy Tarreau7a798e52016-04-14 11:13:20 +020072void conn_fd_handler(int fd)
Willy Tarreau59f98392012-07-06 14:13:49 +020073{
Willy Tarreau80184712012-07-06 14:54:49 +020074 struct connection *conn = fdtab[fd].owner;
Willy Tarreau9e272bf2012-10-03 21:04:48 +020075 unsigned int flags;
Olivier Houchardaf4021e2018-08-09 13:06:55 +020076 int io_available = 0;
Willy Tarreau59f98392012-07-06 14:13:49 +020077
Willy Tarreaud80cb4e2018-01-20 19:30:13 +010078 if (unlikely(!conn)) {
79 activity[tid].conn_dead++;
Willy Tarreau7a798e52016-04-14 11:13:20 +020080 return;
Willy Tarreaud80cb4e2018-01-20 19:30:13 +010081 }
Willy Tarreau59f98392012-07-06 14:13:49 +020082
Willy Tarreau916e12d2017-10-25 09:22:43 +020083 conn->flags |= CO_FL_WILL_UPDATE;
84
Willy Tarreau7d281492012-12-16 19:19:13 +010085 flags = conn->flags & ~CO_FL_ERROR; /* ensure to call the wake handler upon error */
Willy Tarreaud29a0662012-12-10 16:33:38 +010086
Willy Tarreaub2a7ab02019-12-27 10:54:22 +010087 if (unlikely(conn->flags & CO_FL_WAIT_L4_CONN) &&
88 ((fd_send_ready(fd) && fd_send_active(fd)) ||
89 (fd_recv_ready(fd) && fd_recv_active(fd)))) {
90 /* Still waiting for a connection to establish and nothing was
91 * attempted yet to probe the connection. this will clear the
92 * CO_FL_WAIT_L4_CONN flag on success.
93 */
94 if (!conn_fd_check(conn))
95 goto leave;
96 }
97
Willy Tarreau8081abe2019-11-28 18:08:49 +010098 if (fd_send_ready(fd) && fd_send_active(fd)) {
Willy Tarreau3c0cc492017-03-19 07:54:28 +010099 /* force reporting of activity by clearing the previous flags :
100 * we'll have at least ERROR or CONNECTED at the end of an I/O,
101 * both of which will be detected below.
Willy Tarreau9e272bf2012-10-03 21:04:48 +0200102 */
Willy Tarreau3c0cc492017-03-19 07:54:28 +0100103 flags = 0;
Willy Tarreau7872d1f2020-01-10 07:06:05 +0100104 if (conn->subs && conn->subs->events & SUB_RETRY_SEND) {
105 tasklet_wakeup(conn->subs->tasklet);
106 conn->subs->events &= ~SUB_RETRY_SEND;
107 if (!conn->subs->events)
108 conn->subs = NULL;
Olivier Houchardfa8aa862018-10-10 18:25:41 +0200109 } else
110 io_available = 1;
Olivier Houchard53216e72018-10-10 15:46:36 +0200111 __conn_xprt_stop_send(conn);
Willy Tarreau9e272bf2012-10-03 21:04:48 +0200112 }
Willy Tarreau59f98392012-07-06 14:13:49 +0200113
Willy Tarreau57ec32f2017-04-11 19:59:33 +0200114 /* The data transfer starts here and stops on error and handshakes. Note
115 * that we must absolutely test conn->xprt at each step in case it suddenly
116 * changes due to a quick unexpected close().
117 */
Willy Tarreau8081abe2019-11-28 18:08:49 +0100118 if (fd_recv_ready(fd) && fd_recv_active(fd)) {
Willy Tarreau3c0cc492017-03-19 07:54:28 +0100119 /* force reporting of activity by clearing the previous flags :
120 * we'll have at least ERROR or CONNECTED at the end of an I/O,
121 * both of which will be detected below.
Willy Tarreau9e272bf2012-10-03 21:04:48 +0200122 */
Willy Tarreau3c0cc492017-03-19 07:54:28 +0100123 flags = 0;
Willy Tarreau7872d1f2020-01-10 07:06:05 +0100124 if (conn->subs && conn->subs->events & SUB_RETRY_RECV) {
125 tasklet_wakeup(conn->subs->tasklet);
126 conn->subs->events &= ~SUB_RETRY_RECV;
127 if (!conn->subs->events)
128 conn->subs = NULL;
Olivier Houchardfa8aa862018-10-10 18:25:41 +0200129 } else
130 io_available = 1;
Olivier Houchard53216e72018-10-10 15:46:36 +0200131 __conn_xprt_stop_recv(conn);
Willy Tarreau9e272bf2012-10-03 21:04:48 +0200132 }
Willy Tarreau2da156f2012-07-23 15:07:23 +0200133
Willy Tarreau2c6be842012-07-06 17:12:34 +0200134 leave:
Olivier Houchard477902b2020-01-22 18:08:48 +0100135 /* If we don't yet have a mux, that means we were waiting for
136 * informations to create one, typically from the ALPN. If we're
137 * done with the handshake, attempt to create one.
Willy Tarreau8e3c6ce2017-08-28 15:46:01 +0200138 */
Willy Tarreau911db9b2020-01-23 16:27:54 +0100139 if (unlikely(!conn->mux) && !(conn->flags & CO_FL_WAIT_XPRT))
Olivier Houchard477902b2020-01-22 18:08:48 +0100140 if (conn_create_mux(conn) < 0)
141 return;
Willy Tarreau8e3c6ce2017-08-28 15:46:01 +0200142
Willy Tarreau3c0cc492017-03-19 07:54:28 +0100143 /* The wake callback is normally used to notify the data layer about
144 * data layer activity (successful send/recv), connection establishment,
145 * shutdown and fatal errors. We need to consider the following
146 * situations to wake up the data layer :
Willy Tarreau0fbc3182019-12-27 14:57:45 +0100147 * - change among the CO_FL_NOTIFY_DONE flags :
148 * SOCK_{RD,WR}_SH, ERROR,
Willy Tarreau3c0cc492017-03-19 07:54:28 +0100149 * - absence of any of {L4,L6}_CONN and CONNECTED, indicating the
150 * end of handshake and transition to CONNECTED
151 * - raise of CONNECTED with HANDSHAKE down
152 * - end of HANDSHAKE with CONNECTED set
153 * - regular data layer activity
154 *
155 * Note that the wake callback is allowed to release the connection and
156 * the fd (and return < 0 in this case).
Willy Tarreau2396c1c2012-10-03 21:12:16 +0200157 */
Willy Tarreau911db9b2020-01-23 16:27:54 +0100158 if ((io_available || ((conn->flags ^ flags) & CO_FL_NOTIFY_DONE) ||
159 ((flags & CO_FL_WAIT_XPRT) && !(conn->flags & CO_FL_WAIT_XPRT))) &&
Olivier Houchardfe50bfb2019-05-27 12:09:19 +0200160 conn->mux && conn->mux->wake && conn->mux->wake(conn) < 0)
Willy Tarreau7a798e52016-04-14 11:13:20 +0200161 return;
Willy Tarreaufd31e532012-07-23 18:24:25 +0200162
Willy Tarreauf9dabec2012-08-17 17:33:53 +0200163 /* commit polling changes */
Willy Tarreau916e12d2017-10-25 09:22:43 +0200164 conn->flags &= ~CO_FL_WILL_UPDATE;
Willy Tarreauf9dabec2012-08-17 17:33:53 +0200165 conn_cond_update_polling(conn);
Willy Tarreau7a798e52016-04-14 11:13:20 +0200166 return;
Willy Tarreau59f98392012-07-06 14:13:49 +0200167}
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200168
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200169/* Update polling on connection <c>'s file descriptor depending on its current
Willy Tarreau3381bf82020-01-17 17:39:35 +0100170 * state as reported in the connection's CO_FL_XPRT_* flags. The connection
171 * flags are updated with the new flags at the end of the operation. Polling
172 * is totally disabled if an error was reported.
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200173 */
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200174void conn_update_xprt_polling(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200175{
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200176 unsigned int f = c->flags;
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200177
Willy Tarreau3c728722014-01-23 13:50:42 +0100178 if (!conn_ctrl_ready(c))
Willy Tarreauf79c8172013-10-21 16:30:56 +0200179 return;
180
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200181 /* update read status if needed */
Willy Tarreau3381bf82020-01-17 17:39:35 +0100182 if (f & CO_FL_XPRT_RD_ENA)
Willy Tarreau585744b2017-08-24 14:31:19 +0200183 fd_want_recv(c->handle.fd);
Willy Tarreau3381bf82020-01-17 17:39:35 +0100184 else
Willy Tarreau585744b2017-08-24 14:31:19 +0200185 fd_stop_recv(c->handle.fd);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200186
187 /* update write status if needed */
Willy Tarreau3381bf82020-01-17 17:39:35 +0100188 if (f & CO_FL_XPRT_WR_ENA)
Willy Tarreau585744b2017-08-24 14:31:19 +0200189 fd_want_send(c->handle.fd);
Willy Tarreau3381bf82020-01-17 17:39:35 +0100190 else
Willy Tarreau585744b2017-08-24 14:31:19 +0200191 fd_stop_send(c->handle.fd);
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200192}
193
Willy Tarreau4970e5a2019-12-27 10:40:21 +0100194/* This is the callback which is set when a connection establishment is pending
195 * and we have nothing to send. It may update the FD polling status to indicate
196 * !READY. It returns 0 if it fails in a fatal way or needs to poll to go
197 * further, otherwise it returns non-zero and removes the CO_FL_WAIT_L4_CONN
198 * flag from the connection's flags. In case of error, it sets CO_FL_ERROR and
199 * leaves the error code in errno.
200 */
201int conn_fd_check(struct connection *conn)
202{
203 struct sockaddr_storage *addr;
204 int fd = conn->handle.fd;
205
206 if (conn->flags & CO_FL_ERROR)
207 return 0;
208
209 if (!conn_ctrl_ready(conn))
210 return 0;
211
212 if (!(conn->flags & CO_FL_WAIT_L4_CONN))
213 return 1; /* strange we were called while ready */
214
215 if (!fd_send_ready(fd))
216 return 0;
217
218 /* Here we have 2 cases :
219 * - modern pollers, able to report ERR/HUP. If these ones return any
220 * of these flags then it's likely a failure, otherwise it possibly
221 * is a success (i.e. there may have been data received just before
222 * the error was reported).
223 * - select, which doesn't report these and with which it's always
224 * necessary either to try connect() again or to check for SO_ERROR.
225 * In order to simplify everything, we double-check using connect() as
226 * soon as we meet either of these delicate situations. Note that
227 * SO_ERROR would clear the error after reporting it!
228 */
229 if (cur_poller.flags & HAP_POLL_F_ERRHUP) {
230 /* modern poller, able to report ERR/HUP */
231 if ((fdtab[fd].ev & (FD_POLL_IN|FD_POLL_ERR|FD_POLL_HUP)) == FD_POLL_IN)
232 goto done;
233 if ((fdtab[fd].ev & (FD_POLL_OUT|FD_POLL_ERR|FD_POLL_HUP)) == FD_POLL_OUT)
234 goto done;
235 if (!(fdtab[fd].ev & (FD_POLL_ERR|FD_POLL_HUP)))
236 goto wait;
237 /* error present, fall through common error check path */
238 }
239
240 /* Use connect() to check the state of the socket. This has the double
241 * advantage of *not* clearing the error (so that health checks can
242 * still use getsockopt(SO_ERROR)) and giving us the following info :
243 * - error
244 * - connecting (EALREADY, EINPROGRESS)
245 * - connected (EISCONN, 0)
246 */
247 addr = conn->dst;
248 if ((conn->flags & CO_FL_SOCKS4) && obj_type(conn->target) == OBJ_TYPE_SERVER)
249 addr = &objt_server(conn->target)->socks4_addr;
250
251 if (connect(fd, (const struct sockaddr *)addr, get_addr_len(addr)) == -1) {
252 if (errno == EALREADY || errno == EINPROGRESS)
253 goto wait;
254
255 if (errno && errno != EISCONN)
256 goto out_error;
257 }
258
259 done:
260 /* The FD is ready now, we'll mark the connection as complete and
261 * forward the event to the transport layer which will notify the
262 * data layer.
263 */
264 conn->flags &= ~CO_FL_WAIT_L4_CONN;
265 fd_may_send(fd);
266 fd_cond_recv(fd);
267 errno = 0; // make health checks happy
268 return 1;
269
270 out_error:
271 /* Write error on the file descriptor. Report it to the connection
272 * and disable polling on this FD.
273 */
274 fdtab[fd].linger_risk = 0;
275 conn->flags |= CO_FL_ERROR | CO_FL_SOCK_RD_SH | CO_FL_SOCK_WR_SH;
276 __conn_xprt_stop_both(conn);
277 return 0;
278
279 wait:
280 __conn_xprt_want_send(conn);
281 fd_cant_send(fd);
282 return 0;
283}
284
Willy Tarreauff3e6482015-03-12 23:56:52 +0100285/* Send a message over an established connection. It makes use of send() and
286 * returns the same return code and errno. If the socket layer is not ready yet
287 * then -1 is returned and ENOTSOCK is set into errno. If the fd is not marked
288 * as ready, or if EAGAIN or ENOTCONN is returned, then we return 0. It returns
289 * EMSGSIZE if called with a zero length message. The purpose is to simplify
290 * some rare attempts to directly write on the socket from above the connection
291 * (typically send_proxy). In case of EAGAIN, the fd is marked as "cant_send".
292 * It automatically retries on EINTR. Other errors cause the connection to be
293 * marked as in error state. It takes similar arguments as send() except the
294 * first one which is the connection instead of the file descriptor. Note,
295 * MSG_DONTWAIT and MSG_NOSIGNAL are forced on the flags.
296 */
297int conn_sock_send(struct connection *conn, const void *buf, int len, int flags)
298{
299 int ret;
300
301 ret = -1;
302 errno = ENOTSOCK;
303
304 if (conn->flags & CO_FL_SOCK_WR_SH)
305 goto fail;
306
307 if (!conn_ctrl_ready(conn))
308 goto fail;
309
310 errno = EMSGSIZE;
311 if (!len)
312 goto fail;
313
Willy Tarreau585744b2017-08-24 14:31:19 +0200314 if (!fd_send_ready(conn->handle.fd))
Willy Tarreauff3e6482015-03-12 23:56:52 +0100315 goto wait;
316
317 do {
Willy Tarreau585744b2017-08-24 14:31:19 +0200318 ret = send(conn->handle.fd, buf, len, flags | MSG_DONTWAIT | MSG_NOSIGNAL);
Willy Tarreauff3e6482015-03-12 23:56:52 +0100319 } while (ret < 0 && errno == EINTR);
320
321
Willy Tarreauccf3f6d2019-09-05 17:05:05 +0200322 if (ret > 0) {
323 if (conn->flags & CO_FL_WAIT_L4_CONN) {
324 conn->flags &= ~CO_FL_WAIT_L4_CONN;
325 fd_may_send(conn->handle.fd);
326 fd_cond_recv(conn->handle.fd);
327 }
Willy Tarreauff3e6482015-03-12 23:56:52 +0100328 return ret;
Willy Tarreauccf3f6d2019-09-05 17:05:05 +0200329 }
Willy Tarreauff3e6482015-03-12 23:56:52 +0100330
331 if (ret == 0 || errno == EAGAIN || errno == ENOTCONN) {
332 wait:
Willy Tarreau585744b2017-08-24 14:31:19 +0200333 fd_cant_send(conn->handle.fd);
Willy Tarreauff3e6482015-03-12 23:56:52 +0100334 return 0;
335 }
336 fail:
337 conn->flags |= CO_FL_SOCK_RD_SH | CO_FL_SOCK_WR_SH | CO_FL_ERROR;
338 return ret;
339}
340
Willy Tarreauee1a6fc2020-01-17 07:52:13 +0100341/* Called from the upper layer, to subscribe <es> to events <event_type>. The
342 * event subscriber <es> is not allowed to change from a previous call as long
343 * as at least one event is still subscribed. The <event_type> must only be a
344 * combination of SUB_RETRY_RECV and SUB_RETRY_SEND. It always returns 0.
345 */
346int conn_unsubscribe(struct connection *conn, void *xprt_ctx, int event_type, struct wait_event *es)
Olivier Houchard83a0cd82018-09-28 17:57:58 +0200347{
Willy Tarreau7872d1f2020-01-10 07:06:05 +0100348 BUG_ON(event_type & ~(SUB_RETRY_SEND|SUB_RETRY_RECV));
Willy Tarreauee1a6fc2020-01-17 07:52:13 +0100349 BUG_ON(conn->subs && conn->subs != es);
Willy Tarreau7872d1f2020-01-10 07:06:05 +0100350
Willy Tarreauee1a6fc2020-01-17 07:52:13 +0100351 es->events &= ~event_type;
352 if (!es->events)
Willy Tarreau7872d1f2020-01-10 07:06:05 +0100353 conn->subs = NULL;
354
355 if (event_type & SUB_RETRY_RECV)
Olivier Houchard53216e72018-10-10 15:46:36 +0200356 __conn_xprt_stop_recv(conn);
Willy Tarreau7872d1f2020-01-10 07:06:05 +0100357
358 if (event_type & SUB_RETRY_SEND)
Olivier Houchard53216e72018-10-10 15:46:36 +0200359 __conn_xprt_stop_send(conn);
Willy Tarreau7872d1f2020-01-10 07:06:05 +0100360
Olivier Houchard53216e72018-10-10 15:46:36 +0200361 conn_update_xprt_polling(conn);
Olivier Houchard83a0cd82018-09-28 17:57:58 +0200362 return 0;
363}
364
Willy Tarreauee1a6fc2020-01-17 07:52:13 +0100365/* Called from the upper layer, to unsubscribe <es> from events <event_type>
366 * (undo fcgi_subscribe). The <es> struct is not allowed to differ from the one
367 * passed to the subscribe() call. It always returns zero.
368 */
369int conn_subscribe(struct connection *conn, void *xprt_ctx, int event_type, struct wait_event *es)
Olivier Houchard6ff20392018-07-17 18:46:31 +0200370{
Willy Tarreau7872d1f2020-01-10 07:06:05 +0100371 BUG_ON(event_type & ~(SUB_RETRY_SEND|SUB_RETRY_RECV));
372 BUG_ON(conn->subs && conn->subs->events & event_type);
Willy Tarreauee1a6fc2020-01-17 07:52:13 +0100373 BUG_ON(conn->subs && conn->subs != es);
Willy Tarreau7872d1f2020-01-10 07:06:05 +0100374
Willy Tarreauee1a6fc2020-01-17 07:52:13 +0100375 conn->subs = es;
376 es->events |= event_type;
Willy Tarreau7872d1f2020-01-10 07:06:05 +0100377
378 if (event_type & SUB_RETRY_RECV)
Olivier Houchard53216e72018-10-10 15:46:36 +0200379 __conn_xprt_want_recv(conn);
Willy Tarreau7872d1f2020-01-10 07:06:05 +0100380
381 if (event_type & SUB_RETRY_SEND)
Olivier Houchard53216e72018-10-10 15:46:36 +0200382 __conn_xprt_want_send(conn);
Willy Tarreau7872d1f2020-01-10 07:06:05 +0100383
Olivier Houchard53216e72018-10-10 15:46:36 +0200384 conn_update_xprt_polling(conn);
Olivier Houchard83a0cd82018-09-28 17:57:58 +0200385 return 0;
Olivier Houchard6ff20392018-07-17 18:46:31 +0200386}
387
Willy Tarreaud85c4852015-03-13 00:40:28 +0100388/* Drains possibly pending incoming data on the file descriptor attached to the
389 * connection and update the connection's flags accordingly. This is used to
390 * know whether we need to disable lingering on close. Returns non-zero if it
391 * is safe to close without disabling lingering, otherwise zero. The SOCK_RD_SH
392 * flag may also be updated if the incoming shutdown was reported by the drain()
393 * function.
394 */
395int conn_sock_drain(struct connection *conn)
396{
Willy Tarreaue215bba2018-08-24 14:31:53 +0200397 int turns = 2;
398 int len;
399
Willy Tarreaud85c4852015-03-13 00:40:28 +0100400 if (!conn_ctrl_ready(conn))
401 return 1;
402
403 if (conn->flags & (CO_FL_ERROR | CO_FL_SOCK_RD_SH))
404 return 1;
405
Willy Tarreaue215bba2018-08-24 14:31:53 +0200406 if (fdtab[conn->handle.fd].ev & (FD_POLL_ERR|FD_POLL_HUP))
407 goto shut;
Willy Tarreaud85c4852015-03-13 00:40:28 +0100408
Willy Tarreaue215bba2018-08-24 14:31:53 +0200409 if (!fd_recv_ready(conn->handle.fd))
410 return 0;
Willy Tarreaud85c4852015-03-13 00:40:28 +0100411
Willy Tarreaue215bba2018-08-24 14:31:53 +0200412 if (conn->ctrl->drain) {
Willy Tarreau585744b2017-08-24 14:31:19 +0200413 if (conn->ctrl->drain(conn->handle.fd) <= 0)
Willy Tarreaud85c4852015-03-13 00:40:28 +0100414 return 0;
Willy Tarreaue215bba2018-08-24 14:31:53 +0200415 goto shut;
416 }
417
418 /* no drain function defined, use the generic one */
419
420 while (turns) {
421#ifdef MSG_TRUNC_CLEARS_INPUT
422 len = recv(conn->handle.fd, NULL, INT_MAX, MSG_DONTWAIT | MSG_NOSIGNAL | MSG_TRUNC);
423 if (len == -1 && errno == EFAULT)
424#endif
425 len = recv(conn->handle.fd, trash.area, trash.size,
426 MSG_DONTWAIT | MSG_NOSIGNAL);
427
428 if (len == 0)
429 goto shut;
430
431 if (len < 0) {
432 if (errno == EAGAIN) {
433 /* connection not closed yet */
434 fd_cant_recv(conn->handle.fd);
435 break;
436 }
437 if (errno == EINTR) /* oops, try again */
438 continue;
439 /* other errors indicate a dead connection, fine. */
440 goto shut;
441 }
442 /* OK we read some data, let's try again once */
443 turns--;
Willy Tarreaud85c4852015-03-13 00:40:28 +0100444 }
445
Willy Tarreaue215bba2018-08-24 14:31:53 +0200446 /* some data are still present, give up */
447 return 0;
448
449 shut:
450 /* we're certain the connection was shut down */
451 fdtab[conn->handle.fd].linger_risk = 0;
Willy Tarreaud85c4852015-03-13 00:40:28 +0100452 conn->flags |= CO_FL_SOCK_RD_SH;
453 return 1;
454}
455
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +0100456/*
457 * Get data length from tlv
458 */
459static int get_tlv_length(const struct tlv *src)
460{
461 return (src->length_hi << 8) | src->length_lo;
462}
463
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200464/* This handshake handler waits a PROXY protocol header at the beginning of the
465 * raw data stream. The header looks like this :
466 *
467 * "PROXY" <SP> PROTO <SP> SRC3 <SP> DST3 <SP> SRC4 <SP> <DST4> "\r\n"
468 *
469 * There must be exactly one space between each field. Fields are :
470 * - PROTO : layer 4 protocol, which must be "TCP4" or "TCP6".
471 * - SRC3 : layer 3 (eg: IP) source address in standard text form
472 * - DST3 : layer 3 (eg: IP) destination address in standard text form
473 * - SRC4 : layer 4 (eg: TCP port) source address in standard text form
474 * - DST4 : layer 4 (eg: TCP port) destination address in standard text form
475 *
476 * This line MUST be at the beginning of the buffer and MUST NOT wrap.
477 *
478 * The header line is small and in all cases smaller than the smallest normal
479 * TCP MSS. So it MUST always be delivered as one segment, which ensures we
480 * can safely use MSG_PEEK and avoid buffering.
481 *
482 * Once the data is fetched, the values are set in the connection's address
483 * fields, and data are removed from the socket's buffer. The function returns
484 * zero if it needs to wait for more data or if it fails, or 1 if it completed
485 * and removed itself.
486 */
487int conn_recv_proxy(struct connection *conn, int flag)
488{
489 char *line, *end;
Willy Tarreau77992672014-06-14 11:06:17 +0200490 struct proxy_hdr_v2 *hdr_v2;
491 const char v2sig[] = PP2_SIGNATURE;
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +0100492 int tlv_length = 0;
KOVACS Krisztian7209c202015-07-03 14:09:10 +0200493 int tlv_offset = 0;
Willy Tarreaub406b872018-08-22 05:20:32 +0200494 int ret;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200495
Willy Tarreau3c728722014-01-23 13:50:42 +0100496 if (!conn_ctrl_ready(conn))
Willy Tarreauf79c8172013-10-21 16:30:56 +0200497 goto fail;
498
Willy Tarreauca79f592019-07-17 19:04:47 +0200499 if (!sockaddr_alloc(&conn->src) || !sockaddr_alloc(&conn->dst))
500 goto fail;
501
Willy Tarreau585744b2017-08-24 14:31:19 +0200502 if (!fd_recv_ready(conn->handle.fd))
Willy Tarreau6499b9d2019-06-03 08:17:30 +0200503 goto not_ready;
Willy Tarreaufd803bb2014-01-20 15:13:07 +0100504
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200505 do {
Willy Tarreaub406b872018-08-22 05:20:32 +0200506 ret = recv(conn->handle.fd, trash.area, trash.size, MSG_PEEK);
507 if (ret < 0) {
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200508 if (errno == EINTR)
509 continue;
510 if (errno == EAGAIN) {
Willy Tarreau585744b2017-08-24 14:31:19 +0200511 fd_cant_recv(conn->handle.fd);
Willy Tarreau6499b9d2019-06-03 08:17:30 +0200512 goto not_ready;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200513 }
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100514 goto recv_abort;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200515 }
Willy Tarreaub406b872018-08-22 05:20:32 +0200516 trash.data = ret;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200517 } while (0);
518
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200519 if (!trash.data) {
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100520 /* client shutdown */
521 conn->err_code = CO_ER_PRX_EMPTY;
522 goto fail;
523 }
524
Willy Tarreauc192b0a2020-01-23 09:11:58 +0100525 conn->flags &= ~CO_FL_WAIT_L4_CONN;
526
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200527 if (trash.data < 6)
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200528 goto missing;
529
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200530 line = trash.area;
531 end = trash.area + trash.data;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200532
533 /* Decode a possible proxy request, fail early if it does not match */
Willy Tarreau77992672014-06-14 11:06:17 +0200534 if (strncmp(line, "PROXY ", 6) != 0)
535 goto not_v1;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200536
537 line += 6;
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200538 if (trash.data < 9) /* shortest possible line */
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200539 goto missing;
540
David CARLIER42ff05e2016-03-24 09:22:36 +0000541 if (memcmp(line, "TCP4 ", 5) == 0) {
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200542 u32 src3, dst3, sport, dport;
543
544 line += 5;
545
546 src3 = inetaddr_host_lim_ret(line, end, &line);
547 if (line == end)
548 goto missing;
549 if (*line++ != ' ')
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100550 goto bad_header;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200551
552 dst3 = inetaddr_host_lim_ret(line, end, &line);
553 if (line == end)
554 goto missing;
555 if (*line++ != ' ')
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100556 goto bad_header;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200557
558 sport = read_uint((const char **)&line, end);
559 if (line == end)
560 goto missing;
561 if (*line++ != ' ')
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100562 goto bad_header;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200563
564 dport = read_uint((const char **)&line, end);
565 if (line > end - 2)
566 goto missing;
567 if (*line++ != '\r')
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100568 goto bad_header;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200569 if (*line++ != '\n')
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100570 goto bad_header;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200571
572 /* update the session's addresses and mark them set */
Willy Tarreau226572f2019-07-17 14:46:00 +0200573 ((struct sockaddr_in *)conn->src)->sin_family = AF_INET;
574 ((struct sockaddr_in *)conn->src)->sin_addr.s_addr = htonl(src3);
575 ((struct sockaddr_in *)conn->src)->sin_port = htons(sport);
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200576
Willy Tarreau226572f2019-07-17 14:46:00 +0200577 ((struct sockaddr_in *)conn->dst)->sin_family = AF_INET;
578 ((struct sockaddr_in *)conn->dst)->sin_addr.s_addr = htonl(dst3);
579 ((struct sockaddr_in *)conn->dst)->sin_port = htons(dport);
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200580 conn->flags |= CO_FL_ADDR_FROM_SET | CO_FL_ADDR_TO_SET;
581 }
David CARLIER42ff05e2016-03-24 09:22:36 +0000582 else if (memcmp(line, "TCP6 ", 5) == 0) {
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200583 u32 sport, dport;
584 char *src_s;
585 char *dst_s, *sport_s, *dport_s;
586 struct in6_addr src3, dst3;
587
588 line += 5;
589
590 src_s = line;
591 dst_s = sport_s = dport_s = NULL;
592 while (1) {
593 if (line > end - 2) {
594 goto missing;
595 }
596 else if (*line == '\r') {
597 *line = 0;
598 line++;
599 if (*line++ != '\n')
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100600 goto bad_header;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200601 break;
602 }
603
604 if (*line == ' ') {
605 *line = 0;
606 if (!dst_s)
607 dst_s = line + 1;
608 else if (!sport_s)
609 sport_s = line + 1;
610 else if (!dport_s)
611 dport_s = line + 1;
612 }
613 line++;
614 }
615
616 if (!dst_s || !sport_s || !dport_s)
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100617 goto bad_header;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200618
619 sport = read_uint((const char **)&sport_s,dport_s - 1);
620 if (*sport_s != 0)
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100621 goto bad_header;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200622
623 dport = read_uint((const char **)&dport_s,line - 2);
624 if (*dport_s != 0)
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100625 goto bad_header;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200626
627 if (inet_pton(AF_INET6, src_s, (void *)&src3) != 1)
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100628 goto bad_header;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200629
630 if (inet_pton(AF_INET6, dst_s, (void *)&dst3) != 1)
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100631 goto bad_header;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200632
633 /* update the session's addresses and mark them set */
Willy Tarreau226572f2019-07-17 14:46:00 +0200634 ((struct sockaddr_in6 *)conn->src)->sin6_family = AF_INET6;
635 memcpy(&((struct sockaddr_in6 *)conn->src)->sin6_addr, &src3, sizeof(struct in6_addr));
636 ((struct sockaddr_in6 *)conn->src)->sin6_port = htons(sport);
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200637
Willy Tarreau226572f2019-07-17 14:46:00 +0200638 ((struct sockaddr_in6 *)conn->dst)->sin6_family = AF_INET6;
639 memcpy(&((struct sockaddr_in6 *)conn->dst)->sin6_addr, &dst3, sizeof(struct in6_addr));
640 ((struct sockaddr_in6 *)conn->dst)->sin6_port = htons(dport);
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200641 conn->flags |= CO_FL_ADDR_FROM_SET | CO_FL_ADDR_TO_SET;
642 }
Willy Tarreau4c20d292014-06-14 11:41:36 +0200643 else if (memcmp(line, "UNKNOWN\r\n", 9) == 0) {
644 /* This can be a UNIX socket forwarded by an haproxy upstream */
645 line += 9;
646 }
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200647 else {
Willy Tarreau4c20d292014-06-14 11:41:36 +0200648 /* The protocol does not match something known (TCP4/TCP6/UNKNOWN) */
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100649 conn->err_code = CO_ER_PRX_BAD_PROTO;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200650 goto fail;
651 }
652
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200653 trash.data = line - trash.area;
Willy Tarreau77992672014-06-14 11:06:17 +0200654 goto eat_header;
655
656 not_v1:
657 /* try PPv2 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200658 if (trash.data < PP2_HEADER_LEN)
Willy Tarreau77992672014-06-14 11:06:17 +0200659 goto missing;
660
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200661 hdr_v2 = (struct proxy_hdr_v2 *) trash.area;
Willy Tarreau77992672014-06-14 11:06:17 +0200662
663 if (memcmp(hdr_v2->sig, v2sig, PP2_SIGNATURE_LEN) != 0 ||
664 (hdr_v2->ver_cmd & PP2_VERSION_MASK) != PP2_VERSION) {
665 conn->err_code = CO_ER_PRX_NOT_HDR;
666 goto fail;
667 }
668
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200669 if (trash.data < PP2_HEADER_LEN + ntohs(hdr_v2->len))
Willy Tarreau77992672014-06-14 11:06:17 +0200670 goto missing;
671
672 switch (hdr_v2->ver_cmd & PP2_CMD_MASK) {
673 case 0x01: /* PROXY command */
674 switch (hdr_v2->fam) {
675 case 0x11: /* TCPv4 */
KOVACS Krisztianefd3aa92014-11-19 10:53:20 +0100676 if (ntohs(hdr_v2->len) < PP2_ADDR_LEN_INET)
677 goto bad_header;
678
Willy Tarreau226572f2019-07-17 14:46:00 +0200679 ((struct sockaddr_in *)conn->src)->sin_family = AF_INET;
680 ((struct sockaddr_in *)conn->src)->sin_addr.s_addr = hdr_v2->addr.ip4.src_addr;
681 ((struct sockaddr_in *)conn->src)->sin_port = hdr_v2->addr.ip4.src_port;
682 ((struct sockaddr_in *)conn->dst)->sin_family = AF_INET;
683 ((struct sockaddr_in *)conn->dst)->sin_addr.s_addr = hdr_v2->addr.ip4.dst_addr;
684 ((struct sockaddr_in *)conn->dst)->sin_port = hdr_v2->addr.ip4.dst_port;
Willy Tarreau77992672014-06-14 11:06:17 +0200685 conn->flags |= CO_FL_ADDR_FROM_SET | CO_FL_ADDR_TO_SET;
KOVACS Krisztian7209c202015-07-03 14:09:10 +0200686 tlv_offset = PP2_HEADER_LEN + PP2_ADDR_LEN_INET;
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +0100687 tlv_length = ntohs(hdr_v2->len) - PP2_ADDR_LEN_INET;
Willy Tarreau77992672014-06-14 11:06:17 +0200688 break;
689 case 0x21: /* TCPv6 */
KOVACS Krisztianefd3aa92014-11-19 10:53:20 +0100690 if (ntohs(hdr_v2->len) < PP2_ADDR_LEN_INET6)
691 goto bad_header;
692
Willy Tarreau226572f2019-07-17 14:46:00 +0200693 ((struct sockaddr_in6 *)conn->src)->sin6_family = AF_INET6;
694 memcpy(&((struct sockaddr_in6 *)conn->src)->sin6_addr, hdr_v2->addr.ip6.src_addr, 16);
695 ((struct sockaddr_in6 *)conn->src)->sin6_port = hdr_v2->addr.ip6.src_port;
696 ((struct sockaddr_in6 *)conn->dst)->sin6_family = AF_INET6;
697 memcpy(&((struct sockaddr_in6 *)conn->dst)->sin6_addr, hdr_v2->addr.ip6.dst_addr, 16);
698 ((struct sockaddr_in6 *)conn->dst)->sin6_port = hdr_v2->addr.ip6.dst_port;
Willy Tarreau77992672014-06-14 11:06:17 +0200699 conn->flags |= CO_FL_ADDR_FROM_SET | CO_FL_ADDR_TO_SET;
KOVACS Krisztian7209c202015-07-03 14:09:10 +0200700 tlv_offset = PP2_HEADER_LEN + PP2_ADDR_LEN_INET6;
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +0100701 tlv_length = ntohs(hdr_v2->len) - PP2_ADDR_LEN_INET6;
Willy Tarreau77992672014-06-14 11:06:17 +0200702 break;
703 }
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +0100704
705 /* TLV parsing */
706 if (tlv_length > 0) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200707 while (tlv_offset + TLV_HEADER_SIZE <= trash.data) {
708 const struct tlv *tlv_packet = (struct tlv *) &trash.area[tlv_offset];
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +0100709 const int tlv_len = get_tlv_length(tlv_packet);
710 tlv_offset += tlv_len + TLV_HEADER_SIZE;
711
712 switch (tlv_packet->type) {
Emmanuel Hocdet115df3e2018-02-05 16:23:23 +0100713 case PP2_TYPE_CRC32C: {
714 void *tlv_crc32c_p = (void *)tlv_packet->value;
715 uint32_t n_crc32c = ntohl(read_u32(tlv_crc32c_p));
716 write_u32(tlv_crc32c_p, 0);
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200717 if (hash_crc32c(trash.area, PP2_HEADER_LEN + ntohs(hdr_v2->len)) != n_crc32c)
Emmanuel Hocdet115df3e2018-02-05 16:23:23 +0100718 goto bad_header;
719 break;
720 }
Willy Tarreaue5733232019-05-22 19:24:06 +0200721#ifdef USE_NS
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +0100722 case PP2_TYPE_NETNS: {
723 const struct netns_entry *ns;
724 ns = netns_store_lookup((char*)tlv_packet->value, tlv_len);
725 if (ns)
726 conn->proxy_netns = ns;
727 break;
728 }
729#endif
Geoff Simmons7185b782019-08-27 18:31:16 +0200730 case PP2_TYPE_AUTHORITY: {
731 if (tlv_len > PP2_AUTHORITY_MAX)
732 goto bad_header;
733 conn->proxy_authority = pool_alloc(pool_head_authority);
734 if (conn->proxy_authority == NULL)
735 goto fail;
736 memcpy(conn->proxy_authority, (const char *)tlv_packet->value, tlv_len);
737 conn->proxy_authority_len = tlv_len;
738 break;
739 }
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +0100740 default:
741 break;
742 }
743 }
744 }
745
Willy Tarreau77992672014-06-14 11:06:17 +0200746 /* unsupported protocol, keep local connection address */
747 break;
748 case 0x00: /* LOCAL command */
749 /* keep local connection address for LOCAL */
750 break;
751 default:
752 goto bad_header; /* not a supported command */
753 }
754
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200755 trash.data = PP2_HEADER_LEN + ntohs(hdr_v2->len);
Willy Tarreau77992672014-06-14 11:06:17 +0200756 goto eat_header;
757
758 eat_header:
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200759 /* remove the PROXY line from the request. For this we re-read the
760 * exact line at once. If we don't get the exact same result, we
761 * fail.
762 */
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200763 do {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200764 int len2 = recv(conn->handle.fd, trash.area, trash.data, 0);
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200765 if (len2 < 0 && errno == EINTR)
766 continue;
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200767 if (len2 != trash.data)
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100768 goto recv_abort;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200769 } while (0);
770
771 conn->flags &= ~flag;
Emeric Brun4f603012017-01-05 15:11:44 +0100772 conn->flags |= CO_FL_RCVD_PROXY;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200773 return 1;
774
Willy Tarreau6499b9d2019-06-03 08:17:30 +0200775 not_ready:
Willy Tarreau6499b9d2019-06-03 08:17:30 +0200776 return 0;
777
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200778 missing:
779 /* Missing data. Since we're using MSG_PEEK, we can only poll again if
780 * we have not read anything. Otherwise we need to fail because we won't
781 * be able to poll anymore.
782 */
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100783 conn->err_code = CO_ER_PRX_TRUNCATED;
784 goto fail;
785
786 bad_header:
787 /* This is not a valid proxy protocol header */
788 conn->err_code = CO_ER_PRX_BAD_HDR;
789 goto fail;
790
791 recv_abort:
792 conn->err_code = CO_ER_PRX_ABORT;
Willy Tarreau26f4a042013-12-04 23:44:10 +0100793 conn->flags |= CO_FL_SOCK_RD_SH | CO_FL_SOCK_WR_SH;
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100794 goto fail;
795
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200796 fail:
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200797 conn->flags |= CO_FL_ERROR;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200798 return 0;
799}
800
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100801/* This handshake handler waits a NetScaler Client IP insertion header
Bertrand Jacquin72fa1ec2017-12-12 01:17:23 +0000802 * at the beginning of the raw data stream. The header format is
803 * described in doc/netscaler-client-ip-insertion-protocol.txt
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100804 *
805 * This line MUST be at the beginning of the buffer and MUST NOT be
806 * fragmented.
807 *
808 * The header line is small and in all cases smaller than the smallest normal
809 * TCP MSS. So it MUST always be delivered as one segment, which ensures we
810 * can safely use MSG_PEEK and avoid buffering.
811 *
812 * Once the data is fetched, the values are set in the connection's address
813 * fields, and data are removed from the socket's buffer. The function returns
814 * zero if it needs to wait for more data or if it fails, or 1 if it completed
815 * and removed itself.
816 */
817int conn_recv_netscaler_cip(struct connection *conn, int flag)
818{
819 char *line;
Bertrand Jacquin7d668f92017-12-13 01:23:39 +0000820 uint32_t hdr_len;
Willy Tarreau0ca24aa2019-03-29 17:35:32 +0100821 uint8_t ip_ver;
Willy Tarreaub406b872018-08-22 05:20:32 +0200822 int ret;
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100823
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100824 if (!conn_ctrl_ready(conn))
825 goto fail;
826
Olivier Houchard1a9dbe52020-01-22 15:31:09 +0100827 if (!sockaddr_alloc(&conn->src) || !sockaddr_alloc(&conn->dst))
828 goto fail;
829
Willy Tarreau585744b2017-08-24 14:31:19 +0200830 if (!fd_recv_ready(conn->handle.fd))
Willy Tarreau6499b9d2019-06-03 08:17:30 +0200831 goto not_ready;
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100832
833 do {
Willy Tarreaub406b872018-08-22 05:20:32 +0200834 ret = recv(conn->handle.fd, trash.area, trash.size, MSG_PEEK);
835 if (ret < 0) {
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100836 if (errno == EINTR)
837 continue;
838 if (errno == EAGAIN) {
Willy Tarreau585744b2017-08-24 14:31:19 +0200839 fd_cant_recv(conn->handle.fd);
Willy Tarreau6499b9d2019-06-03 08:17:30 +0200840 goto not_ready;
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100841 }
842 goto recv_abort;
843 }
Willy Tarreaub406b872018-08-22 05:20:32 +0200844 trash.data = ret;
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100845 } while (0);
846
Willy Tarreauc192b0a2020-01-23 09:11:58 +0100847 conn->flags &= ~CO_FL_WAIT_L4_CONN;
848
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200849 if (!trash.data) {
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100850 /* client shutdown */
851 conn->err_code = CO_ER_CIP_EMPTY;
852 goto fail;
853 }
854
855 /* Fail if buffer length is not large enough to contain
Bertrand Jacquin72fa1ec2017-12-12 01:17:23 +0000856 * CIP magic, header length or
857 * CIP magic, CIP length, CIP type, header length */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200858 if (trash.data < 12)
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100859 goto missing;
860
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200861 line = trash.area;
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100862
863 /* Decode a possible NetScaler Client IP request, fail early if
864 * it does not match */
Willy Tarreau55e0da62018-09-20 11:26:52 +0200865 if (ntohl(*(uint32_t *)line) != __objt_listener(conn->target)->bind_conf->ns_cip_magic)
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100866 goto bad_magic;
867
Bertrand Jacquin72fa1ec2017-12-12 01:17:23 +0000868 /* Legacy CIP protocol */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200869 if ((trash.area[8] & 0xD0) == 0x40) {
Bertrand Jacquin72fa1ec2017-12-12 01:17:23 +0000870 hdr_len = ntohl(*(uint32_t *)(line+4));
871 line += 8;
872 }
873 /* Standard CIP protocol */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200874 else if (trash.area[8] == 0x00) {
Bertrand Jacquin72fa1ec2017-12-12 01:17:23 +0000875 hdr_len = ntohs(*(uint32_t *)(line+10));
876 line += 12;
877 }
878 /* Unknown CIP protocol */
879 else {
880 conn->err_code = CO_ER_CIP_BAD_PROTO;
881 goto fail;
882 }
883
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100884 /* Fail if buffer length is not large enough to contain
Bertrand Jacquin72fa1ec2017-12-12 01:17:23 +0000885 * a minimal IP header */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200886 if (trash.data < 20)
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100887 goto missing;
888
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100889 /* Get IP version from the first four bits */
Willy Tarreau0ca24aa2019-03-29 17:35:32 +0100890 ip_ver = (*line & 0xf0) >> 4;
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100891
Willy Tarreau0ca24aa2019-03-29 17:35:32 +0100892 if (ip_ver == 4) {
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100893 struct ip *hdr_ip4;
David Carlier3015a2e2016-07-04 22:51:33 +0100894 struct my_tcphdr *hdr_tcp;
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100895
896 hdr_ip4 = (struct ip *)line;
897
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200898 if (trash.data < 40 || trash.data < hdr_len) {
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100899 /* Fail if buffer length is not large enough to contain
Bertrand Jacquin67de5a22017-12-13 01:15:05 +0000900 * IPv4 header, TCP header */
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100901 goto missing;
Bertrand Jacquinb3875912017-12-13 00:58:51 +0000902 }
903 else if (hdr_ip4->ip_p != IPPROTO_TCP) {
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100904 /* The protocol does not include a TCP header */
905 conn->err_code = CO_ER_CIP_BAD_PROTO;
906 goto fail;
Bertrand Jacquinb3875912017-12-13 00:58:51 +0000907 }
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100908
David Carlier3015a2e2016-07-04 22:51:33 +0100909 hdr_tcp = (struct my_tcphdr *)(line + (hdr_ip4->ip_hl * 4));
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100910
911 /* update the session's addresses and mark them set */
Willy Tarreau226572f2019-07-17 14:46:00 +0200912 ((struct sockaddr_in *)conn->src)->sin_family = AF_INET;
913 ((struct sockaddr_in *)conn->src)->sin_addr.s_addr = hdr_ip4->ip_src.s_addr;
914 ((struct sockaddr_in *)conn->src)->sin_port = hdr_tcp->source;
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100915
Willy Tarreau226572f2019-07-17 14:46:00 +0200916 ((struct sockaddr_in *)conn->dst)->sin_family = AF_INET;
917 ((struct sockaddr_in *)conn->dst)->sin_addr.s_addr = hdr_ip4->ip_dst.s_addr;
918 ((struct sockaddr_in *)conn->dst)->sin_port = hdr_tcp->dest;
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100919
920 conn->flags |= CO_FL_ADDR_FROM_SET | CO_FL_ADDR_TO_SET;
921 }
Willy Tarreau0ca24aa2019-03-29 17:35:32 +0100922 else if (ip_ver == 6) {
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100923 struct ip6_hdr *hdr_ip6;
David Carlier3015a2e2016-07-04 22:51:33 +0100924 struct my_tcphdr *hdr_tcp;
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100925
926 hdr_ip6 = (struct ip6_hdr *)line;
927
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200928 if (trash.data < 60 || trash.data < hdr_len) {
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100929 /* Fail if buffer length is not large enough to contain
Bertrand Jacquin67de5a22017-12-13 01:15:05 +0000930 * IPv6 header, TCP header */
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100931 goto missing;
Bertrand Jacquinb3875912017-12-13 00:58:51 +0000932 }
933 else if (hdr_ip6->ip6_nxt != IPPROTO_TCP) {
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100934 /* The protocol does not include a TCP header */
935 conn->err_code = CO_ER_CIP_BAD_PROTO;
936 goto fail;
Bertrand Jacquinb3875912017-12-13 00:58:51 +0000937 }
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100938
David Carlier3015a2e2016-07-04 22:51:33 +0100939 hdr_tcp = (struct my_tcphdr *)(line + sizeof(struct ip6_hdr));
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100940
941 /* update the session's addresses and mark them set */
Willy Tarreau226572f2019-07-17 14:46:00 +0200942 ((struct sockaddr_in6 *)conn->src)->sin6_family = AF_INET6;
943 ((struct sockaddr_in6 *)conn->src)->sin6_addr = hdr_ip6->ip6_src;
944 ((struct sockaddr_in6 *)conn->src)->sin6_port = hdr_tcp->source;
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100945
Willy Tarreau226572f2019-07-17 14:46:00 +0200946 ((struct sockaddr_in6 *)conn->dst)->sin6_family = AF_INET6;
947 ((struct sockaddr_in6 *)conn->dst)->sin6_addr = hdr_ip6->ip6_dst;
948 ((struct sockaddr_in6 *)conn->dst)->sin6_port = hdr_tcp->dest;
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100949
950 conn->flags |= CO_FL_ADDR_FROM_SET | CO_FL_ADDR_TO_SET;
951 }
952 else {
953 /* The protocol does not match something known (IPv4/IPv6) */
954 conn->err_code = CO_ER_CIP_BAD_PROTO;
955 goto fail;
956 }
957
Bertrand Jacquin7d668f92017-12-13 01:23:39 +0000958 line += hdr_len;
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200959 trash.data = line - trash.area;
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100960
961 /* remove the NetScaler Client IP header from the request. For this
962 * we re-read the exact line at once. If we don't get the exact same
963 * result, we fail.
964 */
965 do {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200966 int len2 = recv(conn->handle.fd, trash.area, trash.data, 0);
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100967 if (len2 < 0 && errno == EINTR)
968 continue;
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200969 if (len2 != trash.data)
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100970 goto recv_abort;
971 } while (0);
972
973 conn->flags &= ~flag;
974 return 1;
975
Willy Tarreau6499b9d2019-06-03 08:17:30 +0200976 not_ready:
Willy Tarreau6499b9d2019-06-03 08:17:30 +0200977 return 0;
978
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100979 missing:
980 /* Missing data. Since we're using MSG_PEEK, we can only poll again if
981 * we have not read anything. Otherwise we need to fail because we won't
982 * be able to poll anymore.
983 */
984 conn->err_code = CO_ER_CIP_TRUNCATED;
985 goto fail;
986
987 bad_magic:
988 conn->err_code = CO_ER_CIP_BAD_MAGIC;
989 goto fail;
990
991 recv_abort:
992 conn->err_code = CO_ER_CIP_ABORT;
993 conn->flags |= CO_FL_SOCK_RD_SH | CO_FL_SOCK_WR_SH;
994 goto fail;
995
996 fail:
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100997 conn->flags |= CO_FL_ERROR;
998 return 0;
999}
1000
Alexander Liu2a54bb72019-05-22 19:44:48 +08001001
1002int conn_send_socks4_proxy_request(struct connection *conn)
1003{
1004 struct socks4_request req_line;
1005
Alexander Liu2a54bb72019-05-22 19:44:48 +08001006 if (!conn_ctrl_ready(conn))
1007 goto out_error;
1008
Willy Tarreau226572f2019-07-17 14:46:00 +02001009 if (!conn_get_dst(conn))
1010 goto out_error;
1011
Alexander Liu2a54bb72019-05-22 19:44:48 +08001012 req_line.version = 0x04;
1013 req_line.command = 0x01;
Willy Tarreau226572f2019-07-17 14:46:00 +02001014 req_line.port = get_net_port(conn->dst);
1015 req_line.ip = is_inet_addr(conn->dst);
Alexander Liu2a54bb72019-05-22 19:44:48 +08001016 memcpy(req_line.user_id, "HAProxy\0", 8);
1017
1018 if (conn->send_proxy_ofs > 0) {
1019 /*
1020 * This is the first call to send the request
1021 */
1022 conn->send_proxy_ofs = -(int)sizeof(req_line);
1023 }
1024
1025 if (conn->send_proxy_ofs < 0) {
1026 int ret = 0;
1027
1028 /* we are sending the socks4_req_line here. If the data layer
1029 * has a pending write, we'll also set MSG_MORE.
1030 */
1031 ret = conn_sock_send(
1032 conn,
1033 ((char *)(&req_line)) + (sizeof(req_line)+conn->send_proxy_ofs),
1034 -conn->send_proxy_ofs,
1035 (conn->flags & CO_FL_XPRT_WR_ENA) ? MSG_MORE : 0);
1036
1037 DPRINTF(stderr, "SOCKS PROXY HS FD[%04X]: Before send remain is [%d], sent [%d]\n",
1038 conn->handle.fd, -conn->send_proxy_ofs, ret);
1039
1040 if (ret < 0) {
1041 goto out_error;
1042 }
1043
1044 conn->send_proxy_ofs += ret; /* becomes zero once complete */
1045 if (conn->send_proxy_ofs != 0) {
1046 goto out_wait;
1047 }
1048 }
1049
1050 /* OK we've the whole request sent */
1051 conn->flags &= ~CO_FL_SOCKS4_SEND;
Alexander Liu2a54bb72019-05-22 19:44:48 +08001052
1053 /* The connection is ready now, simply return and let the connection
1054 * handler notify upper layers if needed.
1055 */
Willy Tarreauc192b0a2020-01-23 09:11:58 +01001056 conn->flags &= ~CO_FL_WAIT_L4_CONN;
Alexander Liu2a54bb72019-05-22 19:44:48 +08001057
1058 if (conn->flags & CO_FL_SEND_PROXY) {
1059 /*
1060 * Get the send_proxy_ofs ready for the send_proxy due to we are
1061 * reusing the "send_proxy_ofs", and SOCKS4 handshake should be done
1062 * before sending PROXY Protocol.
1063 */
1064 conn->send_proxy_ofs = 1;
1065 }
1066 return 1;
1067
1068 out_error:
1069 /* Write error on the file descriptor */
1070 conn->flags |= CO_FL_ERROR;
1071 if (conn->err_code == CO_ER_NONE) {
1072 conn->err_code = CO_ER_SOCKS4_SEND;
1073 }
1074 return 0;
1075
1076 out_wait:
Alexander Liu2a54bb72019-05-22 19:44:48 +08001077 return 0;
1078}
1079
1080int conn_recv_socks4_proxy_response(struct connection *conn)
1081{
1082 char line[SOCKS4_HS_RSP_LEN];
1083 int ret;
1084
Alexander Liu2a54bb72019-05-22 19:44:48 +08001085 if (!conn_ctrl_ready(conn))
1086 goto fail;
1087
1088 if (!fd_recv_ready(conn->handle.fd))
Willy Tarreau6499b9d2019-06-03 08:17:30 +02001089 goto not_ready;
Alexander Liu2a54bb72019-05-22 19:44:48 +08001090
1091 do {
1092 /* SOCKS4 Proxy will response with 8 bytes, 0x00 | 0x5A | 0x00 0x00 | 0x00 0x00 0x00 0x00
1093 * Try to peek into it, before all 8 bytes ready.
1094 */
1095 ret = recv(conn->handle.fd, line, SOCKS4_HS_RSP_LEN, MSG_PEEK);
1096
1097 if (ret == 0) {
1098 /* the socket has been closed or shutdown for send */
1099 DPRINTF(stderr, "SOCKS PROXY HS FD[%04X]: Received ret[%d], errno[%d], looks like the socket has been closed or shutdown for send\n",
1100 conn->handle.fd, ret, errno);
1101 if (conn->err_code == CO_ER_NONE) {
1102 conn->err_code = CO_ER_SOCKS4_RECV;
1103 }
1104 goto fail;
1105 }
1106
1107 if (ret > 0) {
1108 if (ret == SOCKS4_HS_RSP_LEN) {
1109 DPRINTF(stderr, "SOCKS PROXY HS FD[%04X]: Received 8 bytes, the response is [%02X|%02X|%02X %02X|%02X %02X %02X %02X]\n",
1110 conn->handle.fd, line[0], line[1], line[2], line[3], line[4], line[5], line[6], line[7]);
1111 }else{
1112 DPRINTF(stderr, "SOCKS PROXY HS FD[%04X]: Received ret[%d], first byte is [%02X], last bye is [%02X]\n", conn->handle.fd, ret, line[0], line[ret-1]);
1113 }
1114 } else {
1115 DPRINTF(stderr, "SOCKS PROXY HS FD[%04X]: Received ret[%d], errno[%d]\n", conn->handle.fd, ret, errno);
1116 }
1117
1118 if (ret < 0) {
1119 if (errno == EINTR) {
1120 continue;
1121 }
1122 if (errno == EAGAIN) {
1123 fd_cant_recv(conn->handle.fd);
Willy Tarreau6499b9d2019-06-03 08:17:30 +02001124 goto not_ready;
Alexander Liu2a54bb72019-05-22 19:44:48 +08001125 }
1126 goto recv_abort;
1127 }
1128 } while (0);
1129
Willy Tarreauc192b0a2020-01-23 09:11:58 +01001130 conn->flags &= ~CO_FL_WAIT_L4_CONN;
1131
Alexander Liu2a54bb72019-05-22 19:44:48 +08001132 if (ret < SOCKS4_HS_RSP_LEN) {
1133 /* Missing data. Since we're using MSG_PEEK, we can only poll again if
1134 * we are not able to read enough data.
1135 */
Willy Tarreau6499b9d2019-06-03 08:17:30 +02001136 goto not_ready;
Alexander Liu2a54bb72019-05-22 19:44:48 +08001137 }
1138
1139 /*
1140 * Base on the SOCSK4 protocol:
1141 *
1142 * +----+----+----+----+----+----+----+----+
1143 * | VN | CD | DSTPORT | DSTIP |
1144 * +----+----+----+----+----+----+----+----+
1145 * # of bytes: 1 1 2 4
1146 * VN is the version of the reply code and should be 0. CD is the result
1147 * code with one of the following values:
1148 * 90: request granted
1149 * 91: request rejected or failed
1150 * 92: request rejected becasue SOCKS server cannot connect to identd on the client
1151 * 93: request rejected because the client program and identd report different user-ids
1152 * The remaining fields are ignored.
1153 */
1154 if (line[1] != 90) {
1155 conn->flags &= ~CO_FL_SOCKS4_RECV;
1156
1157 DPRINTF(stderr, "SOCKS PROXY HS FD[%04X]: FAIL, the response is [%02X|%02X|%02X %02X|%02X %02X %02X %02X]\n",
1158 conn->handle.fd, line[0], line[1], line[2], line[3], line[4], line[5], line[6], line[7]);
1159 if (conn->err_code == CO_ER_NONE) {
1160 conn->err_code = CO_ER_SOCKS4_DENY;
1161 }
1162 goto fail;
1163 }
1164
1165 /* remove the 8 bytes response from the stream */
1166 do {
1167 ret = recv(conn->handle.fd, line, SOCKS4_HS_RSP_LEN, 0);
1168 if (ret < 0 && errno == EINTR) {
1169 continue;
1170 }
1171 if (ret != SOCKS4_HS_RSP_LEN) {
1172 if (conn->err_code == CO_ER_NONE) {
1173 conn->err_code = CO_ER_SOCKS4_RECV;
1174 }
1175 goto fail;
1176 }
1177 } while (0);
1178
1179 conn->flags &= ~CO_FL_SOCKS4_RECV;
1180 return 1;
1181
Willy Tarreau6499b9d2019-06-03 08:17:30 +02001182 not_ready:
Willy Tarreau6499b9d2019-06-03 08:17:30 +02001183 return 0;
1184
Alexander Liu2a54bb72019-05-22 19:44:48 +08001185 recv_abort:
1186 if (conn->err_code == CO_ER_NONE) {
1187 conn->err_code = CO_ER_SOCKS4_ABORT;
1188 }
1189 conn->flags |= (CO_FL_SOCK_RD_SH | CO_FL_SOCK_WR_SH);
1190 goto fail;
1191
1192 fail:
Alexander Liu2a54bb72019-05-22 19:44:48 +08001193 conn->flags |= CO_FL_ERROR;
1194 return 0;
1195}
1196
Ilya Shipitsinca56fce2018-09-15 00:50:05 +05001197/* Note: <remote> is explicitly allowed to be NULL */
David Safb76832014-05-08 23:42:08 -04001198int make_proxy_line(char *buf, int buf_len, struct server *srv, struct connection *remote)
1199{
1200 int ret = 0;
1201
1202 if (srv && (srv->pp_opts & SRV_PP_V2)) {
1203 ret = make_proxy_line_v2(buf, buf_len, srv, remote);
1204 }
1205 else {
Willy Tarreau226572f2019-07-17 14:46:00 +02001206 if (remote && conn_get_src(remote) && conn_get_dst(remote))
1207 ret = make_proxy_line_v1(buf, buf_len, remote->src, remote->dst);
David Safb76832014-05-08 23:42:08 -04001208 else
1209 ret = make_proxy_line_v1(buf, buf_len, NULL, NULL);
1210 }
1211
1212 return ret;
1213}
1214
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001215/* Makes a PROXY protocol line from the two addresses. The output is sent to
1216 * buffer <buf> for a maximum size of <buf_len> (including the trailing zero).
1217 * It returns the number of bytes composing this line (including the trailing
1218 * LF), or zero in case of failure (eg: not enough space). It supports TCP4,
Willy Tarreau2e1401a2013-10-01 11:41:55 +02001219 * TCP6 and "UNKNOWN" formats. If any of <src> or <dst> is null, UNKNOWN is
1220 * emitted as well.
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001221 */
David Safb76832014-05-08 23:42:08 -04001222int make_proxy_line_v1(char *buf, int buf_len, struct sockaddr_storage *src, struct sockaddr_storage *dst)
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001223{
1224 int ret = 0;
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001225 char * protocol;
1226 char src_str[MAX(INET_ADDRSTRLEN, INET6_ADDRSTRLEN)];
1227 char dst_str[MAX(INET_ADDRSTRLEN, INET6_ADDRSTRLEN)];
1228 in_port_t src_port;
1229 in_port_t dst_port;
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001230
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001231 if ( !src
1232 || !dst
1233 || (src->ss_family != AF_INET && src->ss_family != AF_INET6)
1234 || (dst->ss_family != AF_INET && dst->ss_family != AF_INET6)) {
1235 /* unknown family combination */
1236 ret = snprintf(buf, buf_len, "PROXY UNKNOWN\r\n");
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001237 if (ret >= buf_len)
1238 return 0;
1239
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001240 return ret;
1241 }
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001242
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001243 /* IPv4 for both src and dst */
1244 if (src->ss_family == AF_INET && dst->ss_family == AF_INET) {
1245 protocol = "TCP4";
1246 if (!inet_ntop(AF_INET, &((struct sockaddr_in *)src)->sin_addr, src_str, sizeof(src_str)))
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001247 return 0;
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001248 src_port = ((struct sockaddr_in *)src)->sin_port;
1249 if (!inet_ntop(AF_INET, &((struct sockaddr_in *)dst)->sin_addr, dst_str, sizeof(dst_str)))
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001250 return 0;
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001251 dst_port = ((struct sockaddr_in *)dst)->sin_port;
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001252 }
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001253 /* IPv6 for at least one of src and dst */
1254 else {
1255 struct in6_addr tmp;
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001256
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001257 protocol = "TCP6";
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001258
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001259 if (src->ss_family == AF_INET) {
1260 /* Convert src to IPv6 */
1261 v4tov6(&tmp, &((struct sockaddr_in *)src)->sin_addr);
1262 src_port = ((struct sockaddr_in *)src)->sin_port;
1263 }
1264 else {
1265 tmp = ((struct sockaddr_in6 *)src)->sin6_addr;
1266 src_port = ((struct sockaddr_in6 *)src)->sin6_port;
1267 }
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001268
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001269 if (!inet_ntop(AF_INET6, &tmp, src_str, sizeof(src_str)))
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001270 return 0;
1271
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001272 if (dst->ss_family == AF_INET) {
1273 /* Convert dst to IPv6 */
1274 v4tov6(&tmp, &((struct sockaddr_in *)dst)->sin_addr);
1275 dst_port = ((struct sockaddr_in *)dst)->sin_port;
1276 }
1277 else {
1278 tmp = ((struct sockaddr_in6 *)dst)->sin6_addr;
1279 dst_port = ((struct sockaddr_in6 *)dst)->sin6_port;
1280 }
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001281
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001282 if (!inet_ntop(AF_INET6, &tmp, dst_str, sizeof(dst_str)))
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001283 return 0;
1284 }
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001285
1286 ret = snprintf(buf, buf_len, "PROXY %s %s %s %u %u\r\n", protocol, src_str, dst_str, ntohs(src_port), ntohs(dst_port));
1287 if (ret >= buf_len)
1288 return 0;
1289
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001290 return ret;
1291}
David Safb76832014-05-08 23:42:08 -04001292
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +01001293static int make_tlv(char *dest, int dest_len, char type, uint16_t length, const char *value)
David Safb76832014-05-08 23:42:08 -04001294{
1295 struct tlv *tlv;
1296
1297 if (!dest || (length + sizeof(*tlv) > dest_len))
1298 return 0;
1299
1300 tlv = (struct tlv *)dest;
1301
1302 tlv->type = type;
1303 tlv->length_hi = length >> 8;
1304 tlv->length_lo = length & 0x00ff;
1305 memcpy(tlv->value, value, length);
1306 return length + sizeof(*tlv);
1307}
David Safb76832014-05-08 23:42:08 -04001308
Ilya Shipitsinca56fce2018-09-15 00:50:05 +05001309/* Note: <remote> is explicitly allowed to be NULL */
David Safb76832014-05-08 23:42:08 -04001310int make_proxy_line_v2(char *buf, int buf_len, struct server *srv, struct connection *remote)
1311{
Willy Tarreau8fccfa22014-06-14 08:28:06 +02001312 const char pp2_signature[] = PP2_SIGNATURE;
Emmanuel Hocdet4399c752018-02-05 15:26:43 +01001313 void *tlv_crc32c_p = NULL;
David Safb76832014-05-08 23:42:08 -04001314 int ret = 0;
Willy Tarreau8fccfa22014-06-14 08:28:06 +02001315 struct proxy_hdr_v2 *hdr = (struct proxy_hdr_v2 *)buf;
Vincent Bernat6e615892016-05-18 16:17:44 +02001316 struct sockaddr_storage null_addr = { .ss_family = 0 };
David Safb76832014-05-08 23:42:08 -04001317 struct sockaddr_storage *src = &null_addr;
1318 struct sockaddr_storage *dst = &null_addr;
Emmanuel Hocdet404d9782017-10-24 10:55:14 +02001319 const char *value;
1320 int value_len;
David Safb76832014-05-08 23:42:08 -04001321
1322 if (buf_len < PP2_HEADER_LEN)
1323 return 0;
Willy Tarreau8fccfa22014-06-14 08:28:06 +02001324 memcpy(hdr->sig, pp2_signature, PP2_SIGNATURE_LEN);
David Safb76832014-05-08 23:42:08 -04001325
Willy Tarreau226572f2019-07-17 14:46:00 +02001326 if (remote && conn_get_src(remote) && conn_get_dst(remote)) {
1327 src = remote->src;
1328 dst = remote->dst;
David Safb76832014-05-08 23:42:08 -04001329 }
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +01001330
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001331 /* At least one of src or dst is not of AF_INET or AF_INET6 */
1332 if ( !src
1333 || !dst
1334 || (src->ss_family != AF_INET && src->ss_family != AF_INET6)
1335 || (dst->ss_family != AF_INET && dst->ss_family != AF_INET6)) {
David Safb76832014-05-08 23:42:08 -04001336 if (buf_len < PP2_HDR_LEN_UNSPEC)
1337 return 0;
Willy Tarreau8fccfa22014-06-14 08:28:06 +02001338 hdr->ver_cmd = PP2_VERSION | PP2_CMD_LOCAL;
1339 hdr->fam = PP2_FAM_UNSPEC | PP2_TRANS_UNSPEC;
David Safb76832014-05-08 23:42:08 -04001340 ret = PP2_HDR_LEN_UNSPEC;
1341 }
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001342 else {
1343 /* IPv4 for both src and dst */
1344 if (src->ss_family == AF_INET && dst->ss_family == AF_INET) {
1345 if (buf_len < PP2_HDR_LEN_INET)
1346 return 0;
1347 hdr->ver_cmd = PP2_VERSION | PP2_CMD_PROXY;
1348 hdr->fam = PP2_FAM_INET | PP2_TRANS_STREAM;
1349 hdr->addr.ip4.src_addr = ((struct sockaddr_in *)src)->sin_addr.s_addr;
1350 hdr->addr.ip4.src_port = ((struct sockaddr_in *)src)->sin_port;
1351 hdr->addr.ip4.dst_addr = ((struct sockaddr_in *)dst)->sin_addr.s_addr;
1352 hdr->addr.ip4.dst_port = ((struct sockaddr_in *)dst)->sin_port;
1353 ret = PP2_HDR_LEN_INET;
1354 }
1355 /* IPv6 for at least one of src and dst */
1356 else {
1357 struct in6_addr tmp;
1358
1359 if (buf_len < PP2_HDR_LEN_INET6)
1360 return 0;
1361 hdr->ver_cmd = PP2_VERSION | PP2_CMD_PROXY;
1362 hdr->fam = PP2_FAM_INET6 | PP2_TRANS_STREAM;
1363 if (src->ss_family == AF_INET) {
1364 v4tov6(&tmp, &((struct sockaddr_in *)src)->sin_addr);
1365 memcpy(hdr->addr.ip6.src_addr, &tmp, 16);
1366 hdr->addr.ip6.src_port = ((struct sockaddr_in *)src)->sin_port;
1367 }
1368 else {
1369 memcpy(hdr->addr.ip6.src_addr, &((struct sockaddr_in6 *)src)->sin6_addr, 16);
1370 hdr->addr.ip6.src_port = ((struct sockaddr_in6 *)src)->sin6_port;
1371 }
1372 if (dst->ss_family == AF_INET) {
1373 v4tov6(&tmp, &((struct sockaddr_in *)dst)->sin_addr);
1374 memcpy(hdr->addr.ip6.dst_addr, &tmp, 16);
William Dauchybd8bf672020-01-26 19:06:39 +01001375 hdr->addr.ip6.dst_port = ((struct sockaddr_in *)dst)->sin_port;
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001376 }
1377 else {
1378 memcpy(hdr->addr.ip6.dst_addr, &((struct sockaddr_in6 *)dst)->sin6_addr, 16);
1379 hdr->addr.ip6.dst_port = ((struct sockaddr_in6 *)dst)->sin6_port;
1380 }
1381
1382 ret = PP2_HDR_LEN_INET6;
1383 }
1384 }
David Safb76832014-05-08 23:42:08 -04001385
Emmanuel Hocdet4399c752018-02-05 15:26:43 +01001386 if (srv->pp_opts & SRV_PP_V2_CRC32C) {
1387 uint32_t zero_crc32c = 0;
1388 if ((buf_len - ret) < sizeof(struct tlv))
1389 return 0;
1390 tlv_crc32c_p = (void *)((struct tlv *)&buf[ret])->value;
1391 ret += make_tlv(&buf[ret], (buf_len - ret), PP2_TYPE_CRC32C, sizeof(zero_crc32c), (const char *)&zero_crc32c);
1392 }
1393
Ilya Shipitsinca56fce2018-09-15 00:50:05 +05001394 if (remote && conn_get_alpn(remote, &value, &value_len)) {
Emmanuel Hocdet404d9782017-10-24 10:55:14 +02001395 if ((buf_len - ret) < sizeof(struct tlv))
1396 return 0;
Emmanuel Hocdet571c7ac2017-10-31 18:24:05 +01001397 ret += make_tlv(&buf[ret], (buf_len - ret), PP2_TYPE_ALPN, value_len, value);
Emmanuel Hocdet404d9782017-10-24 10:55:14 +02001398 }
1399
Emmanuel Hocdet253c3b72018-02-01 18:29:59 +01001400 if (srv->pp_opts & SRV_PP_V2_AUTHORITY) {
Emmanuel Hocdet8a4ffa02019-08-29 11:54:51 +02001401 value = NULL;
1402 if (remote && remote->proxy_authority) {
1403 value = remote->proxy_authority;
1404 value_len = remote->proxy_authority_len;
1405 }
1406#ifdef USE_OPENSSL
1407 else {
Jerome Magnin78891c72019-09-02 09:53:41 +02001408 if ((value = ssl_sock_get_sni(remote)))
Emmanuel Hocdet8a4ffa02019-08-29 11:54:51 +02001409 value_len = strlen(value);
1410 }
1411#endif
Emmanuel Hocdet253c3b72018-02-01 18:29:59 +01001412 if (value) {
1413 if ((buf_len - ret) < sizeof(struct tlv))
1414 return 0;
Emmanuel Hocdet8a4ffa02019-08-29 11:54:51 +02001415 ret += make_tlv(&buf[ret], (buf_len - ret), PP2_TYPE_AUTHORITY, value_len, value);
Emmanuel Hocdet253c3b72018-02-01 18:29:59 +01001416 }
1417 }
1418
Emmanuel Hocdet8a4ffa02019-08-29 11:54:51 +02001419#ifdef USE_OPENSSL
David Safb76832014-05-08 23:42:08 -04001420 if (srv->pp_opts & SRV_PP_V2_SSL) {
Emmanuel Hocdet404d9782017-10-24 10:55:14 +02001421 struct tlv_ssl *tlv;
1422 int ssl_tlv_len = 0;
David Safb76832014-05-08 23:42:08 -04001423 if ((buf_len - ret) < sizeof(struct tlv_ssl))
1424 return 0;
1425 tlv = (struct tlv_ssl *)&buf[ret];
1426 memset(tlv, 0, sizeof(struct tlv_ssl));
1427 ssl_tlv_len += sizeof(struct tlv_ssl);
1428 tlv->tlv.type = PP2_TYPE_SSL;
1429 if (ssl_sock_is_ssl(remote)) {
1430 tlv->client |= PP2_CLIENT_SSL;
Emmanuel Hocdet01da5712017-10-13 16:59:49 +02001431 value = ssl_sock_get_proto_version(remote);
David Safb76832014-05-08 23:42:08 -04001432 if (value) {
Emmanuel Hocdet8c0c34b2018-02-28 12:02:14 +01001433 ssl_tlv_len += make_tlv(&buf[ret+ssl_tlv_len], (buf_len-ret-ssl_tlv_len), PP2_SUBTYPE_SSL_VERSION, strlen(value), value);
David Safb76832014-05-08 23:42:08 -04001434 }
Dave McCowan328fb582014-07-30 10:39:13 -04001435 if (ssl_sock_get_cert_used_sess(remote)) {
1436 tlv->client |= PP2_CLIENT_CERT_SESS;
David Safb76832014-05-08 23:42:08 -04001437 tlv->verify = htonl(ssl_sock_get_verify_result(remote));
Dave McCowan328fb582014-07-30 10:39:13 -04001438 if (ssl_sock_get_cert_used_conn(remote))
1439 tlv->client |= PP2_CLIENT_CERT_CONN;
David Safb76832014-05-08 23:42:08 -04001440 }
1441 if (srv->pp_opts & SRV_PP_V2_SSL_CN) {
Willy Tarreau83061a82018-07-13 11:56:34 +02001442 struct buffer *cn_trash = get_trash_chunk();
Willy Tarreau3b9a0c92014-07-19 06:37:33 +02001443 if (ssl_sock_get_remote_common_name(remote, cn_trash) > 0) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001444 ssl_tlv_len += make_tlv(&buf[ret+ssl_tlv_len], (buf_len - ret - ssl_tlv_len), PP2_SUBTYPE_SSL_CN,
1445 cn_trash->data,
1446 cn_trash->area);
David Safb76832014-05-08 23:42:08 -04001447 }
1448 }
Emmanuel Hocdetfa8d0f12018-02-01 15:53:52 +01001449 if (srv->pp_opts & SRV_PP_V2_SSL_KEY_ALG) {
Willy Tarreau83061a82018-07-13 11:56:34 +02001450 struct buffer *pkey_trash = get_trash_chunk();
Emmanuel Hocdetfa8d0f12018-02-01 15:53:52 +01001451 if (ssl_sock_get_pkey_algo(remote, pkey_trash) > 0) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001452 ssl_tlv_len += make_tlv(&buf[ret+ssl_tlv_len], (buf_len - ret - ssl_tlv_len), PP2_SUBTYPE_SSL_KEY_ALG,
1453 pkey_trash->data,
1454 pkey_trash->area);
Emmanuel Hocdetfa8d0f12018-02-01 15:53:52 +01001455 }
1456 }
1457 if (srv->pp_opts & SRV_PP_V2_SSL_SIG_ALG) {
1458 value = ssl_sock_get_cert_sig(remote);
1459 if (value) {
1460 ssl_tlv_len += make_tlv(&buf[ret+ssl_tlv_len], (buf_len - ret - ssl_tlv_len), PP2_SUBTYPE_SSL_SIG_ALG, strlen(value), value);
1461 }
1462 }
1463 if (srv->pp_opts & SRV_PP_V2_SSL_CIPHER) {
1464 value = ssl_sock_get_cipher_name(remote);
1465 if (value) {
1466 ssl_tlv_len += make_tlv(&buf[ret+ssl_tlv_len], (buf_len - ret - ssl_tlv_len), PP2_SUBTYPE_SSL_CIPHER, strlen(value), value);
1467 }
1468 }
David Safb76832014-05-08 23:42:08 -04001469 }
1470 tlv->tlv.length_hi = (uint16_t)(ssl_tlv_len - sizeof(struct tlv)) >> 8;
1471 tlv->tlv.length_lo = (uint16_t)(ssl_tlv_len - sizeof(struct tlv)) & 0x00ff;
1472 ret += ssl_tlv_len;
1473 }
1474#endif
1475
Willy Tarreaue5733232019-05-22 19:24:06 +02001476#ifdef USE_NS
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +01001477 if (remote && (remote->proxy_netns)) {
1478 if ((buf_len - ret) < sizeof(struct tlv))
1479 return 0;
Emmanuel Hocdet571c7ac2017-10-31 18:24:05 +01001480 ret += make_tlv(&buf[ret], (buf_len - ret), PP2_TYPE_NETNS, remote->proxy_netns->name_len, remote->proxy_netns->node.key);
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +01001481 }
1482#endif
1483
Willy Tarreau8fccfa22014-06-14 08:28:06 +02001484 hdr->len = htons((uint16_t)(ret - PP2_HEADER_LEN));
David Safb76832014-05-08 23:42:08 -04001485
Emmanuel Hocdet4399c752018-02-05 15:26:43 +01001486 if (tlv_crc32c_p) {
1487 write_u32(tlv_crc32c_p, htonl(hash_crc32c(buf, ret)));
1488 }
1489
David Safb76832014-05-08 23:42:08 -04001490 return ret;
1491}
Emeric Brun4f603012017-01-05 15:11:44 +01001492
Willy Tarreau60ca10a2017-08-18 15:26:54 +02001493/* return the major HTTP version as 1 or 2 depending on how the request arrived
1494 * before being processed.
1495 */
1496static int
1497smp_fetch_fc_http_major(const struct arg *args, struct sample *smp, const char *kw, void *private)
1498{
Jérôme Magnin86577422018-12-07 09:03:11 +01001499 struct connection *conn = (kw[0] != 'b') ? objt_conn(smp->sess->origin) :
1500 smp->strm ? cs_conn(objt_cs(smp->strm->si[1].end)) : NULL;
Willy Tarreau60ca10a2017-08-18 15:26:54 +02001501
1502 smp->data.type = SMP_T_SINT;
1503 smp->data.u.sint = (conn && strcmp(conn_get_mux_name(conn), "H2") == 0) ? 2 : 1;
1504 return 1;
1505}
1506
Emeric Brun4f603012017-01-05 15:11:44 +01001507/* fetch if the received connection used a PROXY protocol header */
1508int smp_fetch_fc_rcvd_proxy(const struct arg *args, struct sample *smp, const char *kw, void *private)
1509{
1510 struct connection *conn;
1511
1512 conn = objt_conn(smp->sess->origin);
1513 if (!conn)
1514 return 0;
1515
Willy Tarreau911db9b2020-01-23 16:27:54 +01001516 if (conn->flags & CO_FL_WAIT_XPRT) {
Emeric Brun4f603012017-01-05 15:11:44 +01001517 smp->flags |= SMP_F_MAY_CHANGE;
1518 return 0;
1519 }
1520
1521 smp->flags = 0;
1522 smp->data.type = SMP_T_BOOL;
1523 smp->data.u.sint = (conn->flags & CO_FL_RCVD_PROXY) ? 1 : 0;
1524
1525 return 1;
1526}
1527
Geoff Simmons7185b782019-08-27 18:31:16 +02001528/* fetch the authority TLV from a PROXY protocol header */
1529int smp_fetch_fc_pp_authority(const struct arg *args, struct sample *smp, const char *kw, void *private)
1530{
1531 struct connection *conn;
1532
1533 conn = objt_conn(smp->sess->origin);
1534 if (!conn)
1535 return 0;
1536
Willy Tarreau911db9b2020-01-23 16:27:54 +01001537 if (conn->flags & CO_FL_WAIT_XPRT) {
Geoff Simmons7185b782019-08-27 18:31:16 +02001538 smp->flags |= SMP_F_MAY_CHANGE;
1539 return 0;
1540 }
1541
1542 if (conn->proxy_authority == NULL)
1543 return 0;
1544
1545 smp->flags = 0;
1546 smp->data.type = SMP_T_STR;
1547 smp->data.u.str.area = conn->proxy_authority;
1548 smp->data.u.str.data = conn->proxy_authority_len;
1549
1550 return 1;
1551}
1552
Emeric Brun4f603012017-01-05 15:11:44 +01001553/* Note: must not be declared <const> as its list will be overwritten.
1554 * Note: fetches that may return multiple types must be declared as the lowest
1555 * common denominator, the type that can be casted into all other ones. For
1556 * instance v4/v6 must be declared v4.
1557 */
1558static struct sample_fetch_kw_list sample_fetch_keywords = {ILH, {
Willy Tarreau60ca10a2017-08-18 15:26:54 +02001559 { "fc_http_major", smp_fetch_fc_http_major, 0, NULL, SMP_T_SINT, SMP_USE_L4CLI },
Jérôme Magnin86577422018-12-07 09:03:11 +01001560 { "bc_http_major", smp_fetch_fc_http_major, 0, NULL, SMP_T_SINT, SMP_USE_L4SRV },
Emeric Brun4f603012017-01-05 15:11:44 +01001561 { "fc_rcvd_proxy", smp_fetch_fc_rcvd_proxy, 0, NULL, SMP_T_BOOL, SMP_USE_L4CLI },
Geoff Simmons7185b782019-08-27 18:31:16 +02001562 { "fc_pp_authority", smp_fetch_fc_pp_authority, 0, NULL, SMP_T_STR, SMP_USE_L4CLI },
Emeric Brun4f603012017-01-05 15:11:44 +01001563 { /* END */ },
1564}};
1565
Willy Tarreau0108d902018-11-25 19:14:37 +01001566INITCALL1(STG_REGISTER, sample_register_fetches, &sample_fetch_keywords);