blob: 319f85e5f1f3514f538e630f685b143d28facc11 [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 */
Olivier Houchard477902b2020-01-22 18:08:48 +0100139 if (unlikely(!conn->mux) && !(conn->flags & CO_FL_HANDSHAKE))
140 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 Tarreau0fbc3182019-12-27 14:57:45 +0100158 if ((io_available || (((conn->flags ^ flags) & CO_FL_NOTIFY_DONE) ||
Willy Tarreauc192b0a2020-01-23 09:11:58 +0100159 ((flags & (CO_FL_WAIT_L4L6|CO_FL_HANDSHAKE)) &&
160 (conn->flags & (CO_FL_WAIT_L4L6|CO_FL_HANDSHAKE)) == 0))) &&
Olivier Houchardfe50bfb2019-05-27 12:09:19 +0200161 conn->mux && conn->mux->wake && conn->mux->wake(conn) < 0)
Willy Tarreau7a798e52016-04-14 11:13:20 +0200162 return;
Willy Tarreaufd31e532012-07-23 18:24:25 +0200163
Willy Tarreauf9dabec2012-08-17 17:33:53 +0200164 /* commit polling changes */
Willy Tarreau916e12d2017-10-25 09:22:43 +0200165 conn->flags &= ~CO_FL_WILL_UPDATE;
Willy Tarreauf9dabec2012-08-17 17:33:53 +0200166 conn_cond_update_polling(conn);
Willy Tarreau7a798e52016-04-14 11:13:20 +0200167 return;
Willy Tarreau59f98392012-07-06 14:13:49 +0200168}
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200169
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200170/* Update polling on connection <c>'s file descriptor depending on its current
Willy Tarreau3381bf82020-01-17 17:39:35 +0100171 * state as reported in the connection's CO_FL_XPRT_* flags. The connection
172 * flags are updated with the new flags at the end of the operation. Polling
173 * is totally disabled if an error was reported.
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200174 */
Olivier Houchard1a0545f2017-09-13 18:30:23 +0200175void conn_update_xprt_polling(struct connection *c)
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200176{
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200177 unsigned int f = c->flags;
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200178
Willy Tarreau3c728722014-01-23 13:50:42 +0100179 if (!conn_ctrl_ready(c))
Willy Tarreauf79c8172013-10-21 16:30:56 +0200180 return;
181
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200182 /* update read status if needed */
Willy Tarreau3381bf82020-01-17 17:39:35 +0100183 if (f & CO_FL_XPRT_RD_ENA)
Willy Tarreau585744b2017-08-24 14:31:19 +0200184 fd_want_recv(c->handle.fd);
Willy Tarreau3381bf82020-01-17 17:39:35 +0100185 else
Willy Tarreau585744b2017-08-24 14:31:19 +0200186 fd_stop_recv(c->handle.fd);
Willy Tarreaub5e2cbd2012-08-17 11:55:04 +0200187
188 /* update write status if needed */
Willy Tarreau3381bf82020-01-17 17:39:35 +0100189 if (f & CO_FL_XPRT_WR_ENA)
Willy Tarreau585744b2017-08-24 14:31:19 +0200190 fd_want_send(c->handle.fd);
Willy Tarreau3381bf82020-01-17 17:39:35 +0100191 else
Willy Tarreau585744b2017-08-24 14:31:19 +0200192 fd_stop_send(c->handle.fd);
Willy Tarreaue9dfa792012-09-01 17:26:16 +0200193}
194
Willy Tarreau4970e5a2019-12-27 10:40:21 +0100195/* This is the callback which is set when a connection establishment is pending
196 * and we have nothing to send. It may update the FD polling status to indicate
197 * !READY. It returns 0 if it fails in a fatal way or needs to poll to go
198 * further, otherwise it returns non-zero and removes the CO_FL_WAIT_L4_CONN
199 * flag from the connection's flags. In case of error, it sets CO_FL_ERROR and
200 * leaves the error code in errno.
201 */
202int conn_fd_check(struct connection *conn)
203{
204 struct sockaddr_storage *addr;
205 int fd = conn->handle.fd;
206
207 if (conn->flags & CO_FL_ERROR)
208 return 0;
209
210 if (!conn_ctrl_ready(conn))
211 return 0;
212
213 if (!(conn->flags & CO_FL_WAIT_L4_CONN))
214 return 1; /* strange we were called while ready */
215
216 if (!fd_send_ready(fd))
217 return 0;
218
219 /* Here we have 2 cases :
220 * - modern pollers, able to report ERR/HUP. If these ones return any
221 * of these flags then it's likely a failure, otherwise it possibly
222 * is a success (i.e. there may have been data received just before
223 * the error was reported).
224 * - select, which doesn't report these and with which it's always
225 * necessary either to try connect() again or to check for SO_ERROR.
226 * In order to simplify everything, we double-check using connect() as
227 * soon as we meet either of these delicate situations. Note that
228 * SO_ERROR would clear the error after reporting it!
229 */
230 if (cur_poller.flags & HAP_POLL_F_ERRHUP) {
231 /* modern poller, able to report ERR/HUP */
232 if ((fdtab[fd].ev & (FD_POLL_IN|FD_POLL_ERR|FD_POLL_HUP)) == FD_POLL_IN)
233 goto done;
234 if ((fdtab[fd].ev & (FD_POLL_OUT|FD_POLL_ERR|FD_POLL_HUP)) == FD_POLL_OUT)
235 goto done;
236 if (!(fdtab[fd].ev & (FD_POLL_ERR|FD_POLL_HUP)))
237 goto wait;
238 /* error present, fall through common error check path */
239 }
240
241 /* Use connect() to check the state of the socket. This has the double
242 * advantage of *not* clearing the error (so that health checks can
243 * still use getsockopt(SO_ERROR)) and giving us the following info :
244 * - error
245 * - connecting (EALREADY, EINPROGRESS)
246 * - connected (EISCONN, 0)
247 */
248 addr = conn->dst;
249 if ((conn->flags & CO_FL_SOCKS4) && obj_type(conn->target) == OBJ_TYPE_SERVER)
250 addr = &objt_server(conn->target)->socks4_addr;
251
252 if (connect(fd, (const struct sockaddr *)addr, get_addr_len(addr)) == -1) {
253 if (errno == EALREADY || errno == EINPROGRESS)
254 goto wait;
255
256 if (errno && errno != EISCONN)
257 goto out_error;
258 }
259
260 done:
261 /* The FD is ready now, we'll mark the connection as complete and
262 * forward the event to the transport layer which will notify the
263 * data layer.
264 */
265 conn->flags &= ~CO_FL_WAIT_L4_CONN;
266 fd_may_send(fd);
267 fd_cond_recv(fd);
268 errno = 0; // make health checks happy
269 return 1;
270
271 out_error:
272 /* Write error on the file descriptor. Report it to the connection
273 * and disable polling on this FD.
274 */
275 fdtab[fd].linger_risk = 0;
276 conn->flags |= CO_FL_ERROR | CO_FL_SOCK_RD_SH | CO_FL_SOCK_WR_SH;
277 __conn_xprt_stop_both(conn);
278 return 0;
279
280 wait:
281 __conn_xprt_want_send(conn);
282 fd_cant_send(fd);
283 return 0;
284}
285
Willy Tarreauff3e6482015-03-12 23:56:52 +0100286/* Send a message over an established connection. It makes use of send() and
287 * returns the same return code and errno. If the socket layer is not ready yet
288 * then -1 is returned and ENOTSOCK is set into errno. If the fd is not marked
289 * as ready, or if EAGAIN or ENOTCONN is returned, then we return 0. It returns
290 * EMSGSIZE if called with a zero length message. The purpose is to simplify
291 * some rare attempts to directly write on the socket from above the connection
292 * (typically send_proxy). In case of EAGAIN, the fd is marked as "cant_send".
293 * It automatically retries on EINTR. Other errors cause the connection to be
294 * marked as in error state. It takes similar arguments as send() except the
295 * first one which is the connection instead of the file descriptor. Note,
296 * MSG_DONTWAIT and MSG_NOSIGNAL are forced on the flags.
297 */
298int conn_sock_send(struct connection *conn, const void *buf, int len, int flags)
299{
300 int ret;
301
302 ret = -1;
303 errno = ENOTSOCK;
304
305 if (conn->flags & CO_FL_SOCK_WR_SH)
306 goto fail;
307
308 if (!conn_ctrl_ready(conn))
309 goto fail;
310
311 errno = EMSGSIZE;
312 if (!len)
313 goto fail;
314
Willy Tarreau585744b2017-08-24 14:31:19 +0200315 if (!fd_send_ready(conn->handle.fd))
Willy Tarreauff3e6482015-03-12 23:56:52 +0100316 goto wait;
317
318 do {
Willy Tarreau585744b2017-08-24 14:31:19 +0200319 ret = send(conn->handle.fd, buf, len, flags | MSG_DONTWAIT | MSG_NOSIGNAL);
Willy Tarreauff3e6482015-03-12 23:56:52 +0100320 } while (ret < 0 && errno == EINTR);
321
322
Willy Tarreauccf3f6d2019-09-05 17:05:05 +0200323 if (ret > 0) {
324 if (conn->flags & CO_FL_WAIT_L4_CONN) {
325 conn->flags &= ~CO_FL_WAIT_L4_CONN;
326 fd_may_send(conn->handle.fd);
327 fd_cond_recv(conn->handle.fd);
328 }
Willy Tarreauff3e6482015-03-12 23:56:52 +0100329 return ret;
Willy Tarreauccf3f6d2019-09-05 17:05:05 +0200330 }
Willy Tarreauff3e6482015-03-12 23:56:52 +0100331
332 if (ret == 0 || errno == EAGAIN || errno == ENOTCONN) {
333 wait:
Willy Tarreau585744b2017-08-24 14:31:19 +0200334 fd_cant_send(conn->handle.fd);
Willy Tarreauff3e6482015-03-12 23:56:52 +0100335 return 0;
336 }
337 fail:
338 conn->flags |= CO_FL_SOCK_RD_SH | CO_FL_SOCK_WR_SH | CO_FL_ERROR;
339 return ret;
340}
341
Willy Tarreauee1a6fc2020-01-17 07:52:13 +0100342/* Called from the upper layer, to subscribe <es> to events <event_type>. The
343 * event subscriber <es> is not allowed to change from a previous call as long
344 * as at least one event is still subscribed. The <event_type> must only be a
345 * combination of SUB_RETRY_RECV and SUB_RETRY_SEND. It always returns 0.
346 */
347int conn_unsubscribe(struct connection *conn, void *xprt_ctx, int event_type, struct wait_event *es)
Olivier Houchard83a0cd82018-09-28 17:57:58 +0200348{
Willy Tarreau7872d1f2020-01-10 07:06:05 +0100349 BUG_ON(event_type & ~(SUB_RETRY_SEND|SUB_RETRY_RECV));
Willy Tarreauee1a6fc2020-01-17 07:52:13 +0100350 BUG_ON(conn->subs && conn->subs != es);
Willy Tarreau7872d1f2020-01-10 07:06:05 +0100351
Willy Tarreauee1a6fc2020-01-17 07:52:13 +0100352 es->events &= ~event_type;
353 if (!es->events)
Willy Tarreau7872d1f2020-01-10 07:06:05 +0100354 conn->subs = NULL;
355
356 if (event_type & SUB_RETRY_RECV)
Olivier Houchard53216e72018-10-10 15:46:36 +0200357 __conn_xprt_stop_recv(conn);
Willy Tarreau7872d1f2020-01-10 07:06:05 +0100358
359 if (event_type & SUB_RETRY_SEND)
Olivier Houchard53216e72018-10-10 15:46:36 +0200360 __conn_xprt_stop_send(conn);
Willy Tarreau7872d1f2020-01-10 07:06:05 +0100361
Olivier Houchard53216e72018-10-10 15:46:36 +0200362 conn_update_xprt_polling(conn);
Olivier Houchard83a0cd82018-09-28 17:57:58 +0200363 return 0;
364}
365
Willy Tarreauee1a6fc2020-01-17 07:52:13 +0100366/* Called from the upper layer, to unsubscribe <es> from events <event_type>
367 * (undo fcgi_subscribe). The <es> struct is not allowed to differ from the one
368 * passed to the subscribe() call. It always returns zero.
369 */
370int conn_subscribe(struct connection *conn, void *xprt_ctx, int event_type, struct wait_event *es)
Olivier Houchard6ff20392018-07-17 18:46:31 +0200371{
Willy Tarreau7872d1f2020-01-10 07:06:05 +0100372 BUG_ON(event_type & ~(SUB_RETRY_SEND|SUB_RETRY_RECV));
373 BUG_ON(conn->subs && conn->subs->events & event_type);
Willy Tarreauee1a6fc2020-01-17 07:52:13 +0100374 BUG_ON(conn->subs && conn->subs != es);
Willy Tarreau7872d1f2020-01-10 07:06:05 +0100375
Willy Tarreauee1a6fc2020-01-17 07:52:13 +0100376 conn->subs = es;
377 es->events |= event_type;
Willy Tarreau7872d1f2020-01-10 07:06:05 +0100378
379 if (event_type & SUB_RETRY_RECV)
Olivier Houchard53216e72018-10-10 15:46:36 +0200380 __conn_xprt_want_recv(conn);
Willy Tarreau7872d1f2020-01-10 07:06:05 +0100381
382 if (event_type & SUB_RETRY_SEND)
Olivier Houchard53216e72018-10-10 15:46:36 +0200383 __conn_xprt_want_send(conn);
Willy Tarreau7872d1f2020-01-10 07:06:05 +0100384
Olivier Houchard53216e72018-10-10 15:46:36 +0200385 conn_update_xprt_polling(conn);
Olivier Houchard83a0cd82018-09-28 17:57:58 +0200386 return 0;
Olivier Houchard6ff20392018-07-17 18:46:31 +0200387}
388
Willy Tarreaud85c4852015-03-13 00:40:28 +0100389/* Drains possibly pending incoming data on the file descriptor attached to the
390 * connection and update the connection's flags accordingly. This is used to
391 * know whether we need to disable lingering on close. Returns non-zero if it
392 * is safe to close without disabling lingering, otherwise zero. The SOCK_RD_SH
393 * flag may also be updated if the incoming shutdown was reported by the drain()
394 * function.
395 */
396int conn_sock_drain(struct connection *conn)
397{
Willy Tarreaue215bba2018-08-24 14:31:53 +0200398 int turns = 2;
399 int len;
400
Willy Tarreaud85c4852015-03-13 00:40:28 +0100401 if (!conn_ctrl_ready(conn))
402 return 1;
403
404 if (conn->flags & (CO_FL_ERROR | CO_FL_SOCK_RD_SH))
405 return 1;
406
Willy Tarreaue215bba2018-08-24 14:31:53 +0200407 if (fdtab[conn->handle.fd].ev & (FD_POLL_ERR|FD_POLL_HUP))
408 goto shut;
Willy Tarreaud85c4852015-03-13 00:40:28 +0100409
Willy Tarreaue215bba2018-08-24 14:31:53 +0200410 if (!fd_recv_ready(conn->handle.fd))
411 return 0;
Willy Tarreaud85c4852015-03-13 00:40:28 +0100412
Willy Tarreaue215bba2018-08-24 14:31:53 +0200413 if (conn->ctrl->drain) {
Willy Tarreau585744b2017-08-24 14:31:19 +0200414 if (conn->ctrl->drain(conn->handle.fd) <= 0)
Willy Tarreaud85c4852015-03-13 00:40:28 +0100415 return 0;
Willy Tarreaue215bba2018-08-24 14:31:53 +0200416 goto shut;
417 }
418
419 /* no drain function defined, use the generic one */
420
421 while (turns) {
422#ifdef MSG_TRUNC_CLEARS_INPUT
423 len = recv(conn->handle.fd, NULL, INT_MAX, MSG_DONTWAIT | MSG_NOSIGNAL | MSG_TRUNC);
424 if (len == -1 && errno == EFAULT)
425#endif
426 len = recv(conn->handle.fd, trash.area, trash.size,
427 MSG_DONTWAIT | MSG_NOSIGNAL);
428
429 if (len == 0)
430 goto shut;
431
432 if (len < 0) {
433 if (errno == EAGAIN) {
434 /* connection not closed yet */
435 fd_cant_recv(conn->handle.fd);
436 break;
437 }
438 if (errno == EINTR) /* oops, try again */
439 continue;
440 /* other errors indicate a dead connection, fine. */
441 goto shut;
442 }
443 /* OK we read some data, let's try again once */
444 turns--;
Willy Tarreaud85c4852015-03-13 00:40:28 +0100445 }
446
Willy Tarreaue215bba2018-08-24 14:31:53 +0200447 /* some data are still present, give up */
448 return 0;
449
450 shut:
451 /* we're certain the connection was shut down */
452 fdtab[conn->handle.fd].linger_risk = 0;
Willy Tarreaud85c4852015-03-13 00:40:28 +0100453 conn->flags |= CO_FL_SOCK_RD_SH;
454 return 1;
455}
456
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +0100457/*
458 * Get data length from tlv
459 */
460static int get_tlv_length(const struct tlv *src)
461{
462 return (src->length_hi << 8) | src->length_lo;
463}
464
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200465/* This handshake handler waits a PROXY protocol header at the beginning of the
466 * raw data stream. The header looks like this :
467 *
468 * "PROXY" <SP> PROTO <SP> SRC3 <SP> DST3 <SP> SRC4 <SP> <DST4> "\r\n"
469 *
470 * There must be exactly one space between each field. Fields are :
471 * - PROTO : layer 4 protocol, which must be "TCP4" or "TCP6".
472 * - SRC3 : layer 3 (eg: IP) source address in standard text form
473 * - DST3 : layer 3 (eg: IP) destination address in standard text form
474 * - SRC4 : layer 4 (eg: TCP port) source address in standard text form
475 * - DST4 : layer 4 (eg: TCP port) destination address in standard text form
476 *
477 * This line MUST be at the beginning of the buffer and MUST NOT wrap.
478 *
479 * The header line is small and in all cases smaller than the smallest normal
480 * TCP MSS. So it MUST always be delivered as one segment, which ensures we
481 * can safely use MSG_PEEK and avoid buffering.
482 *
483 * Once the data is fetched, the values are set in the connection's address
484 * fields, and data are removed from the socket's buffer. The function returns
485 * zero if it needs to wait for more data or if it fails, or 1 if it completed
486 * and removed itself.
487 */
488int conn_recv_proxy(struct connection *conn, int flag)
489{
490 char *line, *end;
Willy Tarreau77992672014-06-14 11:06:17 +0200491 struct proxy_hdr_v2 *hdr_v2;
492 const char v2sig[] = PP2_SIGNATURE;
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +0100493 int tlv_length = 0;
KOVACS Krisztian7209c202015-07-03 14:09:10 +0200494 int tlv_offset = 0;
Willy Tarreaub406b872018-08-22 05:20:32 +0200495 int ret;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200496
497 /* we might have been called just after an asynchronous shutr */
498 if (conn->flags & CO_FL_SOCK_RD_SH)
499 goto fail;
500
Willy Tarreau3c728722014-01-23 13:50:42 +0100501 if (!conn_ctrl_ready(conn))
Willy Tarreauf79c8172013-10-21 16:30:56 +0200502 goto fail;
503
Willy Tarreauca79f592019-07-17 19:04:47 +0200504 if (!sockaddr_alloc(&conn->src) || !sockaddr_alloc(&conn->dst))
505 goto fail;
506
Willy Tarreau585744b2017-08-24 14:31:19 +0200507 if (!fd_recv_ready(conn->handle.fd))
Willy Tarreau6499b9d2019-06-03 08:17:30 +0200508 goto not_ready;
Willy Tarreaufd803bb2014-01-20 15:13:07 +0100509
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200510 do {
Willy Tarreaub406b872018-08-22 05:20:32 +0200511 ret = recv(conn->handle.fd, trash.area, trash.size, MSG_PEEK);
512 if (ret < 0) {
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200513 if (errno == EINTR)
514 continue;
515 if (errno == EAGAIN) {
Willy Tarreau585744b2017-08-24 14:31:19 +0200516 fd_cant_recv(conn->handle.fd);
Willy Tarreau6499b9d2019-06-03 08:17:30 +0200517 goto not_ready;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200518 }
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100519 goto recv_abort;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200520 }
Willy Tarreaub406b872018-08-22 05:20:32 +0200521 trash.data = ret;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200522 } while (0);
523
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200524 if (!trash.data) {
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100525 /* client shutdown */
526 conn->err_code = CO_ER_PRX_EMPTY;
527 goto fail;
528 }
529
Willy Tarreauc192b0a2020-01-23 09:11:58 +0100530 conn->flags &= ~CO_FL_WAIT_L4_CONN;
531
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200532 if (trash.data < 6)
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200533 goto missing;
534
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200535 line = trash.area;
536 end = trash.area + trash.data;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200537
538 /* Decode a possible proxy request, fail early if it does not match */
Willy Tarreau77992672014-06-14 11:06:17 +0200539 if (strncmp(line, "PROXY ", 6) != 0)
540 goto not_v1;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200541
542 line += 6;
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200543 if (trash.data < 9) /* shortest possible line */
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200544 goto missing;
545
David CARLIER42ff05e2016-03-24 09:22:36 +0000546 if (memcmp(line, "TCP4 ", 5) == 0) {
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200547 u32 src3, dst3, sport, dport;
548
549 line += 5;
550
551 src3 = inetaddr_host_lim_ret(line, end, &line);
552 if (line == end)
553 goto missing;
554 if (*line++ != ' ')
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100555 goto bad_header;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200556
557 dst3 = inetaddr_host_lim_ret(line, end, &line);
558 if (line == end)
559 goto missing;
560 if (*line++ != ' ')
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100561 goto bad_header;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200562
563 sport = read_uint((const char **)&line, end);
564 if (line == end)
565 goto missing;
566 if (*line++ != ' ')
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100567 goto bad_header;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200568
569 dport = read_uint((const char **)&line, end);
570 if (line > end - 2)
571 goto missing;
572 if (*line++ != '\r')
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100573 goto bad_header;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200574 if (*line++ != '\n')
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100575 goto bad_header;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200576
577 /* update the session's addresses and mark them set */
Willy Tarreau226572f2019-07-17 14:46:00 +0200578 ((struct sockaddr_in *)conn->src)->sin_family = AF_INET;
579 ((struct sockaddr_in *)conn->src)->sin_addr.s_addr = htonl(src3);
580 ((struct sockaddr_in *)conn->src)->sin_port = htons(sport);
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200581
Willy Tarreau226572f2019-07-17 14:46:00 +0200582 ((struct sockaddr_in *)conn->dst)->sin_family = AF_INET;
583 ((struct sockaddr_in *)conn->dst)->sin_addr.s_addr = htonl(dst3);
584 ((struct sockaddr_in *)conn->dst)->sin_port = htons(dport);
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200585 conn->flags |= CO_FL_ADDR_FROM_SET | CO_FL_ADDR_TO_SET;
586 }
David CARLIER42ff05e2016-03-24 09:22:36 +0000587 else if (memcmp(line, "TCP6 ", 5) == 0) {
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200588 u32 sport, dport;
589 char *src_s;
590 char *dst_s, *sport_s, *dport_s;
591 struct in6_addr src3, dst3;
592
593 line += 5;
594
595 src_s = line;
596 dst_s = sport_s = dport_s = NULL;
597 while (1) {
598 if (line > end - 2) {
599 goto missing;
600 }
601 else if (*line == '\r') {
602 *line = 0;
603 line++;
604 if (*line++ != '\n')
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100605 goto bad_header;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200606 break;
607 }
608
609 if (*line == ' ') {
610 *line = 0;
611 if (!dst_s)
612 dst_s = line + 1;
613 else if (!sport_s)
614 sport_s = line + 1;
615 else if (!dport_s)
616 dport_s = line + 1;
617 }
618 line++;
619 }
620
621 if (!dst_s || !sport_s || !dport_s)
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100622 goto bad_header;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200623
624 sport = read_uint((const char **)&sport_s,dport_s - 1);
625 if (*sport_s != 0)
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100626 goto bad_header;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200627
628 dport = read_uint((const char **)&dport_s,line - 2);
629 if (*dport_s != 0)
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100630 goto bad_header;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200631
632 if (inet_pton(AF_INET6, src_s, (void *)&src3) != 1)
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100633 goto bad_header;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200634
635 if (inet_pton(AF_INET6, dst_s, (void *)&dst3) != 1)
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100636 goto bad_header;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200637
638 /* update the session's addresses and mark them set */
Willy Tarreau226572f2019-07-17 14:46:00 +0200639 ((struct sockaddr_in6 *)conn->src)->sin6_family = AF_INET6;
640 memcpy(&((struct sockaddr_in6 *)conn->src)->sin6_addr, &src3, sizeof(struct in6_addr));
641 ((struct sockaddr_in6 *)conn->src)->sin6_port = htons(sport);
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200642
Willy Tarreau226572f2019-07-17 14:46:00 +0200643 ((struct sockaddr_in6 *)conn->dst)->sin6_family = AF_INET6;
644 memcpy(&((struct sockaddr_in6 *)conn->dst)->sin6_addr, &dst3, sizeof(struct in6_addr));
645 ((struct sockaddr_in6 *)conn->dst)->sin6_port = htons(dport);
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200646 conn->flags |= CO_FL_ADDR_FROM_SET | CO_FL_ADDR_TO_SET;
647 }
Willy Tarreau4c20d292014-06-14 11:41:36 +0200648 else if (memcmp(line, "UNKNOWN\r\n", 9) == 0) {
649 /* This can be a UNIX socket forwarded by an haproxy upstream */
650 line += 9;
651 }
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200652 else {
Willy Tarreau4c20d292014-06-14 11:41:36 +0200653 /* The protocol does not match something known (TCP4/TCP6/UNKNOWN) */
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100654 conn->err_code = CO_ER_PRX_BAD_PROTO;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200655 goto fail;
656 }
657
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200658 trash.data = line - trash.area;
Willy Tarreau77992672014-06-14 11:06:17 +0200659 goto eat_header;
660
661 not_v1:
662 /* try PPv2 */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200663 if (trash.data < PP2_HEADER_LEN)
Willy Tarreau77992672014-06-14 11:06:17 +0200664 goto missing;
665
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200666 hdr_v2 = (struct proxy_hdr_v2 *) trash.area;
Willy Tarreau77992672014-06-14 11:06:17 +0200667
668 if (memcmp(hdr_v2->sig, v2sig, PP2_SIGNATURE_LEN) != 0 ||
669 (hdr_v2->ver_cmd & PP2_VERSION_MASK) != PP2_VERSION) {
670 conn->err_code = CO_ER_PRX_NOT_HDR;
671 goto fail;
672 }
673
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200674 if (trash.data < PP2_HEADER_LEN + ntohs(hdr_v2->len))
Willy Tarreau77992672014-06-14 11:06:17 +0200675 goto missing;
676
677 switch (hdr_v2->ver_cmd & PP2_CMD_MASK) {
678 case 0x01: /* PROXY command */
679 switch (hdr_v2->fam) {
680 case 0x11: /* TCPv4 */
KOVACS Krisztianefd3aa92014-11-19 10:53:20 +0100681 if (ntohs(hdr_v2->len) < PP2_ADDR_LEN_INET)
682 goto bad_header;
683
Willy Tarreau226572f2019-07-17 14:46:00 +0200684 ((struct sockaddr_in *)conn->src)->sin_family = AF_INET;
685 ((struct sockaddr_in *)conn->src)->sin_addr.s_addr = hdr_v2->addr.ip4.src_addr;
686 ((struct sockaddr_in *)conn->src)->sin_port = hdr_v2->addr.ip4.src_port;
687 ((struct sockaddr_in *)conn->dst)->sin_family = AF_INET;
688 ((struct sockaddr_in *)conn->dst)->sin_addr.s_addr = hdr_v2->addr.ip4.dst_addr;
689 ((struct sockaddr_in *)conn->dst)->sin_port = hdr_v2->addr.ip4.dst_port;
Willy Tarreau77992672014-06-14 11:06:17 +0200690 conn->flags |= CO_FL_ADDR_FROM_SET | CO_FL_ADDR_TO_SET;
KOVACS Krisztian7209c202015-07-03 14:09:10 +0200691 tlv_offset = PP2_HEADER_LEN + PP2_ADDR_LEN_INET;
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +0100692 tlv_length = ntohs(hdr_v2->len) - PP2_ADDR_LEN_INET;
Willy Tarreau77992672014-06-14 11:06:17 +0200693 break;
694 case 0x21: /* TCPv6 */
KOVACS Krisztianefd3aa92014-11-19 10:53:20 +0100695 if (ntohs(hdr_v2->len) < PP2_ADDR_LEN_INET6)
696 goto bad_header;
697
Willy Tarreau226572f2019-07-17 14:46:00 +0200698 ((struct sockaddr_in6 *)conn->src)->sin6_family = AF_INET6;
699 memcpy(&((struct sockaddr_in6 *)conn->src)->sin6_addr, hdr_v2->addr.ip6.src_addr, 16);
700 ((struct sockaddr_in6 *)conn->src)->sin6_port = hdr_v2->addr.ip6.src_port;
701 ((struct sockaddr_in6 *)conn->dst)->sin6_family = AF_INET6;
702 memcpy(&((struct sockaddr_in6 *)conn->dst)->sin6_addr, hdr_v2->addr.ip6.dst_addr, 16);
703 ((struct sockaddr_in6 *)conn->dst)->sin6_port = hdr_v2->addr.ip6.dst_port;
Willy Tarreau77992672014-06-14 11:06:17 +0200704 conn->flags |= CO_FL_ADDR_FROM_SET | CO_FL_ADDR_TO_SET;
KOVACS Krisztian7209c202015-07-03 14:09:10 +0200705 tlv_offset = PP2_HEADER_LEN + PP2_ADDR_LEN_INET6;
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +0100706 tlv_length = ntohs(hdr_v2->len) - PP2_ADDR_LEN_INET6;
Willy Tarreau77992672014-06-14 11:06:17 +0200707 break;
708 }
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +0100709
710 /* TLV parsing */
711 if (tlv_length > 0) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200712 while (tlv_offset + TLV_HEADER_SIZE <= trash.data) {
713 const struct tlv *tlv_packet = (struct tlv *) &trash.area[tlv_offset];
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +0100714 const int tlv_len = get_tlv_length(tlv_packet);
715 tlv_offset += tlv_len + TLV_HEADER_SIZE;
716
717 switch (tlv_packet->type) {
Emmanuel Hocdet115df3e2018-02-05 16:23:23 +0100718 case PP2_TYPE_CRC32C: {
719 void *tlv_crc32c_p = (void *)tlv_packet->value;
720 uint32_t n_crc32c = ntohl(read_u32(tlv_crc32c_p));
721 write_u32(tlv_crc32c_p, 0);
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200722 if (hash_crc32c(trash.area, PP2_HEADER_LEN + ntohs(hdr_v2->len)) != n_crc32c)
Emmanuel Hocdet115df3e2018-02-05 16:23:23 +0100723 goto bad_header;
724 break;
725 }
Willy Tarreaue5733232019-05-22 19:24:06 +0200726#ifdef USE_NS
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +0100727 case PP2_TYPE_NETNS: {
728 const struct netns_entry *ns;
729 ns = netns_store_lookup((char*)tlv_packet->value, tlv_len);
730 if (ns)
731 conn->proxy_netns = ns;
732 break;
733 }
734#endif
Geoff Simmons7185b782019-08-27 18:31:16 +0200735 case PP2_TYPE_AUTHORITY: {
736 if (tlv_len > PP2_AUTHORITY_MAX)
737 goto bad_header;
738 conn->proxy_authority = pool_alloc(pool_head_authority);
739 if (conn->proxy_authority == NULL)
740 goto fail;
741 memcpy(conn->proxy_authority, (const char *)tlv_packet->value, tlv_len);
742 conn->proxy_authority_len = tlv_len;
743 break;
744 }
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +0100745 default:
746 break;
747 }
748 }
749 }
750
Willy Tarreau77992672014-06-14 11:06:17 +0200751 /* unsupported protocol, keep local connection address */
752 break;
753 case 0x00: /* LOCAL command */
754 /* keep local connection address for LOCAL */
755 break;
756 default:
757 goto bad_header; /* not a supported command */
758 }
759
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200760 trash.data = PP2_HEADER_LEN + ntohs(hdr_v2->len);
Willy Tarreau77992672014-06-14 11:06:17 +0200761 goto eat_header;
762
763 eat_header:
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200764 /* remove the PROXY line from the request. For this we re-read the
765 * exact line at once. If we don't get the exact same result, we
766 * fail.
767 */
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200768 do {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200769 int len2 = recv(conn->handle.fd, trash.area, trash.data, 0);
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200770 if (len2 < 0 && errno == EINTR)
771 continue;
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200772 if (len2 != trash.data)
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100773 goto recv_abort;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200774 } while (0);
775
776 conn->flags &= ~flag;
Emeric Brun4f603012017-01-05 15:11:44 +0100777 conn->flags |= CO_FL_RCVD_PROXY;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200778 return 1;
779
Willy Tarreau6499b9d2019-06-03 08:17:30 +0200780 not_ready:
Willy Tarreau6499b9d2019-06-03 08:17:30 +0200781 return 0;
782
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200783 missing:
784 /* Missing data. Since we're using MSG_PEEK, we can only poll again if
785 * we have not read anything. Otherwise we need to fail because we won't
786 * be able to poll anymore.
787 */
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100788 conn->err_code = CO_ER_PRX_TRUNCATED;
789 goto fail;
790
791 bad_header:
792 /* This is not a valid proxy protocol header */
793 conn->err_code = CO_ER_PRX_BAD_HDR;
794 goto fail;
795
796 recv_abort:
797 conn->err_code = CO_ER_PRX_ABORT;
Willy Tarreau26f4a042013-12-04 23:44:10 +0100798 conn->flags |= CO_FL_SOCK_RD_SH | CO_FL_SOCK_WR_SH;
Willy Tarreau8e3bf692012-12-03 15:41:18 +0100799 goto fail;
800
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200801 fail:
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200802 conn->flags |= CO_FL_ERROR;
Willy Tarreaue1e4a612012-10-05 00:10:55 +0200803 return 0;
804}
805
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100806/* This handshake handler waits a NetScaler Client IP insertion header
Bertrand Jacquin72fa1ec2017-12-12 01:17:23 +0000807 * at the beginning of the raw data stream. The header format is
808 * described in doc/netscaler-client-ip-insertion-protocol.txt
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100809 *
810 * This line MUST be at the beginning of the buffer and MUST NOT be
811 * fragmented.
812 *
813 * The header line is small and in all cases smaller than the smallest normal
814 * TCP MSS. So it MUST always be delivered as one segment, which ensures we
815 * can safely use MSG_PEEK and avoid buffering.
816 *
817 * Once the data is fetched, the values are set in the connection's address
818 * fields, and data are removed from the socket's buffer. The function returns
819 * zero if it needs to wait for more data or if it fails, or 1 if it completed
820 * and removed itself.
821 */
822int conn_recv_netscaler_cip(struct connection *conn, int flag)
823{
824 char *line;
Bertrand Jacquin7d668f92017-12-13 01:23:39 +0000825 uint32_t hdr_len;
Willy Tarreau0ca24aa2019-03-29 17:35:32 +0100826 uint8_t ip_ver;
Willy Tarreaub406b872018-08-22 05:20:32 +0200827 int ret;
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100828
829 /* we might have been called just after an asynchronous shutr */
830 if (conn->flags & CO_FL_SOCK_RD_SH)
831 goto fail;
832
833 if (!conn_ctrl_ready(conn))
834 goto fail;
835
Olivier Houchard1a9dbe52020-01-22 15:31:09 +0100836 if (!sockaddr_alloc(&conn->src) || !sockaddr_alloc(&conn->dst))
837 goto fail;
838
Willy Tarreau585744b2017-08-24 14:31:19 +0200839 if (!fd_recv_ready(conn->handle.fd))
Willy Tarreau6499b9d2019-06-03 08:17:30 +0200840 goto not_ready;
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100841
842 do {
Willy Tarreaub406b872018-08-22 05:20:32 +0200843 ret = recv(conn->handle.fd, trash.area, trash.size, MSG_PEEK);
844 if (ret < 0) {
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100845 if (errno == EINTR)
846 continue;
847 if (errno == EAGAIN) {
Willy Tarreau585744b2017-08-24 14:31:19 +0200848 fd_cant_recv(conn->handle.fd);
Willy Tarreau6499b9d2019-06-03 08:17:30 +0200849 goto not_ready;
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100850 }
851 goto recv_abort;
852 }
Willy Tarreaub406b872018-08-22 05:20:32 +0200853 trash.data = ret;
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100854 } while (0);
855
Willy Tarreauc192b0a2020-01-23 09:11:58 +0100856 conn->flags &= ~CO_FL_WAIT_L4_CONN;
857
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200858 if (!trash.data) {
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100859 /* client shutdown */
860 conn->err_code = CO_ER_CIP_EMPTY;
861 goto fail;
862 }
863
864 /* Fail if buffer length is not large enough to contain
Bertrand Jacquin72fa1ec2017-12-12 01:17:23 +0000865 * CIP magic, header length or
866 * CIP magic, CIP length, CIP type, header length */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200867 if (trash.data < 12)
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100868 goto missing;
869
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200870 line = trash.area;
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100871
872 /* Decode a possible NetScaler Client IP request, fail early if
873 * it does not match */
Willy Tarreau55e0da62018-09-20 11:26:52 +0200874 if (ntohl(*(uint32_t *)line) != __objt_listener(conn->target)->bind_conf->ns_cip_magic)
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100875 goto bad_magic;
876
Bertrand Jacquin72fa1ec2017-12-12 01:17:23 +0000877 /* Legacy CIP protocol */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200878 if ((trash.area[8] & 0xD0) == 0x40) {
Bertrand Jacquin72fa1ec2017-12-12 01:17:23 +0000879 hdr_len = ntohl(*(uint32_t *)(line+4));
880 line += 8;
881 }
882 /* Standard CIP protocol */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200883 else if (trash.area[8] == 0x00) {
Bertrand Jacquin72fa1ec2017-12-12 01:17:23 +0000884 hdr_len = ntohs(*(uint32_t *)(line+10));
885 line += 12;
886 }
887 /* Unknown CIP protocol */
888 else {
889 conn->err_code = CO_ER_CIP_BAD_PROTO;
890 goto fail;
891 }
892
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100893 /* Fail if buffer length is not large enough to contain
Bertrand Jacquin72fa1ec2017-12-12 01:17:23 +0000894 * a minimal IP header */
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200895 if (trash.data < 20)
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100896 goto missing;
897
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100898 /* Get IP version from the first four bits */
Willy Tarreau0ca24aa2019-03-29 17:35:32 +0100899 ip_ver = (*line & 0xf0) >> 4;
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100900
Willy Tarreau0ca24aa2019-03-29 17:35:32 +0100901 if (ip_ver == 4) {
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100902 struct ip *hdr_ip4;
David Carlier3015a2e2016-07-04 22:51:33 +0100903 struct my_tcphdr *hdr_tcp;
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100904
905 hdr_ip4 = (struct ip *)line;
906
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200907 if (trash.data < 40 || trash.data < hdr_len) {
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100908 /* Fail if buffer length is not large enough to contain
Bertrand Jacquin67de5a22017-12-13 01:15:05 +0000909 * IPv4 header, TCP header */
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100910 goto missing;
Bertrand Jacquinb3875912017-12-13 00:58:51 +0000911 }
912 else if (hdr_ip4->ip_p != IPPROTO_TCP) {
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100913 /* The protocol does not include a TCP header */
914 conn->err_code = CO_ER_CIP_BAD_PROTO;
915 goto fail;
Bertrand Jacquinb3875912017-12-13 00:58:51 +0000916 }
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100917
David Carlier3015a2e2016-07-04 22:51:33 +0100918 hdr_tcp = (struct my_tcphdr *)(line + (hdr_ip4->ip_hl * 4));
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100919
920 /* update the session's addresses and mark them set */
Willy Tarreau226572f2019-07-17 14:46:00 +0200921 ((struct sockaddr_in *)conn->src)->sin_family = AF_INET;
922 ((struct sockaddr_in *)conn->src)->sin_addr.s_addr = hdr_ip4->ip_src.s_addr;
923 ((struct sockaddr_in *)conn->src)->sin_port = hdr_tcp->source;
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100924
Willy Tarreau226572f2019-07-17 14:46:00 +0200925 ((struct sockaddr_in *)conn->dst)->sin_family = AF_INET;
926 ((struct sockaddr_in *)conn->dst)->sin_addr.s_addr = hdr_ip4->ip_dst.s_addr;
927 ((struct sockaddr_in *)conn->dst)->sin_port = hdr_tcp->dest;
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100928
929 conn->flags |= CO_FL_ADDR_FROM_SET | CO_FL_ADDR_TO_SET;
930 }
Willy Tarreau0ca24aa2019-03-29 17:35:32 +0100931 else if (ip_ver == 6) {
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100932 struct ip6_hdr *hdr_ip6;
David Carlier3015a2e2016-07-04 22:51:33 +0100933 struct my_tcphdr *hdr_tcp;
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100934
935 hdr_ip6 = (struct ip6_hdr *)line;
936
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200937 if (trash.data < 60 || trash.data < hdr_len) {
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100938 /* Fail if buffer length is not large enough to contain
Bertrand Jacquin67de5a22017-12-13 01:15:05 +0000939 * IPv6 header, TCP header */
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100940 goto missing;
Bertrand Jacquinb3875912017-12-13 00:58:51 +0000941 }
942 else if (hdr_ip6->ip6_nxt != IPPROTO_TCP) {
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100943 /* The protocol does not include a TCP header */
944 conn->err_code = CO_ER_CIP_BAD_PROTO;
945 goto fail;
Bertrand Jacquinb3875912017-12-13 00:58:51 +0000946 }
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100947
David Carlier3015a2e2016-07-04 22:51:33 +0100948 hdr_tcp = (struct my_tcphdr *)(line + sizeof(struct ip6_hdr));
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100949
950 /* update the session's addresses and mark them set */
Willy Tarreau226572f2019-07-17 14:46:00 +0200951 ((struct sockaddr_in6 *)conn->src)->sin6_family = AF_INET6;
952 ((struct sockaddr_in6 *)conn->src)->sin6_addr = hdr_ip6->ip6_src;
953 ((struct sockaddr_in6 *)conn->src)->sin6_port = hdr_tcp->source;
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100954
Willy Tarreau226572f2019-07-17 14:46:00 +0200955 ((struct sockaddr_in6 *)conn->dst)->sin6_family = AF_INET6;
956 ((struct sockaddr_in6 *)conn->dst)->sin6_addr = hdr_ip6->ip6_dst;
957 ((struct sockaddr_in6 *)conn->dst)->sin6_port = hdr_tcp->dest;
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100958
959 conn->flags |= CO_FL_ADDR_FROM_SET | CO_FL_ADDR_TO_SET;
960 }
961 else {
962 /* The protocol does not match something known (IPv4/IPv6) */
963 conn->err_code = CO_ER_CIP_BAD_PROTO;
964 goto fail;
965 }
966
Bertrand Jacquin7d668f92017-12-13 01:23:39 +0000967 line += hdr_len;
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200968 trash.data = line - trash.area;
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100969
970 /* remove the NetScaler Client IP header from the request. For this
971 * we re-read the exact line at once. If we don't get the exact same
972 * result, we fail.
973 */
974 do {
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200975 int len2 = recv(conn->handle.fd, trash.area, trash.data, 0);
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100976 if (len2 < 0 && errno == EINTR)
977 continue;
Willy Tarreau843b7cb2018-07-13 10:54:26 +0200978 if (len2 != trash.data)
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100979 goto recv_abort;
980 } while (0);
981
982 conn->flags &= ~flag;
983 return 1;
984
Willy Tarreau6499b9d2019-06-03 08:17:30 +0200985 not_ready:
Willy Tarreau6499b9d2019-06-03 08:17:30 +0200986 return 0;
987
Bertrand Jacquin93b227d2016-06-04 15:11:10 +0100988 missing:
989 /* Missing data. Since we're using MSG_PEEK, we can only poll again if
990 * we have not read anything. Otherwise we need to fail because we won't
991 * be able to poll anymore.
992 */
993 conn->err_code = CO_ER_CIP_TRUNCATED;
994 goto fail;
995
996 bad_magic:
997 conn->err_code = CO_ER_CIP_BAD_MAGIC;
998 goto fail;
999
1000 recv_abort:
1001 conn->err_code = CO_ER_CIP_ABORT;
1002 conn->flags |= CO_FL_SOCK_RD_SH | CO_FL_SOCK_WR_SH;
1003 goto fail;
1004
1005 fail:
Bertrand Jacquin93b227d2016-06-04 15:11:10 +01001006 conn->flags |= CO_FL_ERROR;
1007 return 0;
1008}
1009
Alexander Liu2a54bb72019-05-22 19:44:48 +08001010
1011int conn_send_socks4_proxy_request(struct connection *conn)
1012{
1013 struct socks4_request req_line;
1014
1015 /* we might have been called just after an asynchronous shutw */
1016 if (conn->flags & CO_FL_SOCK_WR_SH)
1017 goto out_error;
1018
1019 if (!conn_ctrl_ready(conn))
1020 goto out_error;
1021
Willy Tarreau226572f2019-07-17 14:46:00 +02001022 if (!conn_get_dst(conn))
1023 goto out_error;
1024
Alexander Liu2a54bb72019-05-22 19:44:48 +08001025 req_line.version = 0x04;
1026 req_line.command = 0x01;
Willy Tarreau226572f2019-07-17 14:46:00 +02001027 req_line.port = get_net_port(conn->dst);
1028 req_line.ip = is_inet_addr(conn->dst);
Alexander Liu2a54bb72019-05-22 19:44:48 +08001029 memcpy(req_line.user_id, "HAProxy\0", 8);
1030
1031 if (conn->send_proxy_ofs > 0) {
1032 /*
1033 * This is the first call to send the request
1034 */
1035 conn->send_proxy_ofs = -(int)sizeof(req_line);
1036 }
1037
1038 if (conn->send_proxy_ofs < 0) {
1039 int ret = 0;
1040
1041 /* we are sending the socks4_req_line here. If the data layer
1042 * has a pending write, we'll also set MSG_MORE.
1043 */
1044 ret = conn_sock_send(
1045 conn,
1046 ((char *)(&req_line)) + (sizeof(req_line)+conn->send_proxy_ofs),
1047 -conn->send_proxy_ofs,
1048 (conn->flags & CO_FL_XPRT_WR_ENA) ? MSG_MORE : 0);
1049
1050 DPRINTF(stderr, "SOCKS PROXY HS FD[%04X]: Before send remain is [%d], sent [%d]\n",
1051 conn->handle.fd, -conn->send_proxy_ofs, ret);
1052
1053 if (ret < 0) {
1054 goto out_error;
1055 }
1056
1057 conn->send_proxy_ofs += ret; /* becomes zero once complete */
1058 if (conn->send_proxy_ofs != 0) {
1059 goto out_wait;
1060 }
1061 }
1062
1063 /* OK we've the whole request sent */
1064 conn->flags &= ~CO_FL_SOCKS4_SEND;
Alexander Liu2a54bb72019-05-22 19:44:48 +08001065
1066 /* The connection is ready now, simply return and let the connection
1067 * handler notify upper layers if needed.
1068 */
Willy Tarreauc192b0a2020-01-23 09:11:58 +01001069 conn->flags &= ~CO_FL_WAIT_L4_CONN;
Alexander Liu2a54bb72019-05-22 19:44:48 +08001070
1071 if (conn->flags & CO_FL_SEND_PROXY) {
1072 /*
1073 * Get the send_proxy_ofs ready for the send_proxy due to we are
1074 * reusing the "send_proxy_ofs", and SOCKS4 handshake should be done
1075 * before sending PROXY Protocol.
1076 */
1077 conn->send_proxy_ofs = 1;
1078 }
1079 return 1;
1080
1081 out_error:
1082 /* Write error on the file descriptor */
1083 conn->flags |= CO_FL_ERROR;
1084 if (conn->err_code == CO_ER_NONE) {
1085 conn->err_code = CO_ER_SOCKS4_SEND;
1086 }
1087 return 0;
1088
1089 out_wait:
Alexander Liu2a54bb72019-05-22 19:44:48 +08001090 return 0;
1091}
1092
1093int conn_recv_socks4_proxy_response(struct connection *conn)
1094{
1095 char line[SOCKS4_HS_RSP_LEN];
1096 int ret;
1097
1098 /* we might have been called just after an asynchronous shutr */
1099 if (conn->flags & CO_FL_SOCK_RD_SH)
1100 goto fail;
1101
1102 if (!conn_ctrl_ready(conn))
1103 goto fail;
1104
1105 if (!fd_recv_ready(conn->handle.fd))
Willy Tarreau6499b9d2019-06-03 08:17:30 +02001106 goto not_ready;
Alexander Liu2a54bb72019-05-22 19:44:48 +08001107
1108 do {
1109 /* SOCKS4 Proxy will response with 8 bytes, 0x00 | 0x5A | 0x00 0x00 | 0x00 0x00 0x00 0x00
1110 * Try to peek into it, before all 8 bytes ready.
1111 */
1112 ret = recv(conn->handle.fd, line, SOCKS4_HS_RSP_LEN, MSG_PEEK);
1113
1114 if (ret == 0) {
1115 /* the socket has been closed or shutdown for send */
1116 DPRINTF(stderr, "SOCKS PROXY HS FD[%04X]: Received ret[%d], errno[%d], looks like the socket has been closed or shutdown for send\n",
1117 conn->handle.fd, ret, errno);
1118 if (conn->err_code == CO_ER_NONE) {
1119 conn->err_code = CO_ER_SOCKS4_RECV;
1120 }
1121 goto fail;
1122 }
1123
1124 if (ret > 0) {
1125 if (ret == SOCKS4_HS_RSP_LEN) {
1126 DPRINTF(stderr, "SOCKS PROXY HS FD[%04X]: Received 8 bytes, the response is [%02X|%02X|%02X %02X|%02X %02X %02X %02X]\n",
1127 conn->handle.fd, line[0], line[1], line[2], line[3], line[4], line[5], line[6], line[7]);
1128 }else{
1129 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]);
1130 }
1131 } else {
1132 DPRINTF(stderr, "SOCKS PROXY HS FD[%04X]: Received ret[%d], errno[%d]\n", conn->handle.fd, ret, errno);
1133 }
1134
1135 if (ret < 0) {
1136 if (errno == EINTR) {
1137 continue;
1138 }
1139 if (errno == EAGAIN) {
1140 fd_cant_recv(conn->handle.fd);
Willy Tarreau6499b9d2019-06-03 08:17:30 +02001141 goto not_ready;
Alexander Liu2a54bb72019-05-22 19:44:48 +08001142 }
1143 goto recv_abort;
1144 }
1145 } while (0);
1146
Willy Tarreauc192b0a2020-01-23 09:11:58 +01001147 conn->flags &= ~CO_FL_WAIT_L4_CONN;
1148
Alexander Liu2a54bb72019-05-22 19:44:48 +08001149 if (ret < SOCKS4_HS_RSP_LEN) {
1150 /* Missing data. Since we're using MSG_PEEK, we can only poll again if
1151 * we are not able to read enough data.
1152 */
Willy Tarreau6499b9d2019-06-03 08:17:30 +02001153 goto not_ready;
Alexander Liu2a54bb72019-05-22 19:44:48 +08001154 }
1155
1156 /*
1157 * Base on the SOCSK4 protocol:
1158 *
1159 * +----+----+----+----+----+----+----+----+
1160 * | VN | CD | DSTPORT | DSTIP |
1161 * +----+----+----+----+----+----+----+----+
1162 * # of bytes: 1 1 2 4
1163 * VN is the version of the reply code and should be 0. CD is the result
1164 * code with one of the following values:
1165 * 90: request granted
1166 * 91: request rejected or failed
1167 * 92: request rejected becasue SOCKS server cannot connect to identd on the client
1168 * 93: request rejected because the client program and identd report different user-ids
1169 * The remaining fields are ignored.
1170 */
1171 if (line[1] != 90) {
1172 conn->flags &= ~CO_FL_SOCKS4_RECV;
1173
1174 DPRINTF(stderr, "SOCKS PROXY HS FD[%04X]: FAIL, the response is [%02X|%02X|%02X %02X|%02X %02X %02X %02X]\n",
1175 conn->handle.fd, line[0], line[1], line[2], line[3], line[4], line[5], line[6], line[7]);
1176 if (conn->err_code == CO_ER_NONE) {
1177 conn->err_code = CO_ER_SOCKS4_DENY;
1178 }
1179 goto fail;
1180 }
1181
1182 /* remove the 8 bytes response from the stream */
1183 do {
1184 ret = recv(conn->handle.fd, line, SOCKS4_HS_RSP_LEN, 0);
1185 if (ret < 0 && errno == EINTR) {
1186 continue;
1187 }
1188 if (ret != SOCKS4_HS_RSP_LEN) {
1189 if (conn->err_code == CO_ER_NONE) {
1190 conn->err_code = CO_ER_SOCKS4_RECV;
1191 }
1192 goto fail;
1193 }
1194 } while (0);
1195
1196 conn->flags &= ~CO_FL_SOCKS4_RECV;
1197 return 1;
1198
Willy Tarreau6499b9d2019-06-03 08:17:30 +02001199 not_ready:
Willy Tarreau6499b9d2019-06-03 08:17:30 +02001200 return 0;
1201
Alexander Liu2a54bb72019-05-22 19:44:48 +08001202 recv_abort:
1203 if (conn->err_code == CO_ER_NONE) {
1204 conn->err_code = CO_ER_SOCKS4_ABORT;
1205 }
1206 conn->flags |= (CO_FL_SOCK_RD_SH | CO_FL_SOCK_WR_SH);
1207 goto fail;
1208
1209 fail:
Alexander Liu2a54bb72019-05-22 19:44:48 +08001210 conn->flags |= CO_FL_ERROR;
1211 return 0;
1212}
1213
Ilya Shipitsinca56fce2018-09-15 00:50:05 +05001214/* Note: <remote> is explicitly allowed to be NULL */
David Safb76832014-05-08 23:42:08 -04001215int make_proxy_line(char *buf, int buf_len, struct server *srv, struct connection *remote)
1216{
1217 int ret = 0;
1218
1219 if (srv && (srv->pp_opts & SRV_PP_V2)) {
1220 ret = make_proxy_line_v2(buf, buf_len, srv, remote);
1221 }
1222 else {
Willy Tarreau226572f2019-07-17 14:46:00 +02001223 if (remote && conn_get_src(remote) && conn_get_dst(remote))
1224 ret = make_proxy_line_v1(buf, buf_len, remote->src, remote->dst);
David Safb76832014-05-08 23:42:08 -04001225 else
1226 ret = make_proxy_line_v1(buf, buf_len, NULL, NULL);
1227 }
1228
1229 return ret;
1230}
1231
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001232/* Makes a PROXY protocol line from the two addresses. The output is sent to
1233 * buffer <buf> for a maximum size of <buf_len> (including the trailing zero).
1234 * It returns the number of bytes composing this line (including the trailing
1235 * LF), or zero in case of failure (eg: not enough space). It supports TCP4,
Willy Tarreau2e1401a2013-10-01 11:41:55 +02001236 * TCP6 and "UNKNOWN" formats. If any of <src> or <dst> is null, UNKNOWN is
1237 * emitted as well.
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001238 */
David Safb76832014-05-08 23:42:08 -04001239int make_proxy_line_v1(char *buf, int buf_len, struct sockaddr_storage *src, struct sockaddr_storage *dst)
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001240{
1241 int ret = 0;
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001242 char * protocol;
1243 char src_str[MAX(INET_ADDRSTRLEN, INET6_ADDRSTRLEN)];
1244 char dst_str[MAX(INET_ADDRSTRLEN, INET6_ADDRSTRLEN)];
1245 in_port_t src_port;
1246 in_port_t dst_port;
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001247
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001248 if ( !src
1249 || !dst
1250 || (src->ss_family != AF_INET && src->ss_family != AF_INET6)
1251 || (dst->ss_family != AF_INET && dst->ss_family != AF_INET6)) {
1252 /* unknown family combination */
1253 ret = snprintf(buf, buf_len, "PROXY UNKNOWN\r\n");
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001254 if (ret >= buf_len)
1255 return 0;
1256
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001257 return ret;
1258 }
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001259
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001260 /* IPv4 for both src and dst */
1261 if (src->ss_family == AF_INET && dst->ss_family == AF_INET) {
1262 protocol = "TCP4";
1263 if (!inet_ntop(AF_INET, &((struct sockaddr_in *)src)->sin_addr, src_str, sizeof(src_str)))
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001264 return 0;
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001265 src_port = ((struct sockaddr_in *)src)->sin_port;
1266 if (!inet_ntop(AF_INET, &((struct sockaddr_in *)dst)->sin_addr, dst_str, sizeof(dst_str)))
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001267 return 0;
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001268 dst_port = ((struct sockaddr_in *)dst)->sin_port;
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001269 }
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001270 /* IPv6 for at least one of src and dst */
1271 else {
1272 struct in6_addr tmp;
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001273
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001274 protocol = "TCP6";
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001275
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001276 if (src->ss_family == AF_INET) {
1277 /* Convert src to IPv6 */
1278 v4tov6(&tmp, &((struct sockaddr_in *)src)->sin_addr);
1279 src_port = ((struct sockaddr_in *)src)->sin_port;
1280 }
1281 else {
1282 tmp = ((struct sockaddr_in6 *)src)->sin6_addr;
1283 src_port = ((struct sockaddr_in6 *)src)->sin6_port;
1284 }
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001285
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001286 if (!inet_ntop(AF_INET6, &tmp, src_str, sizeof(src_str)))
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001287 return 0;
1288
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001289 if (dst->ss_family == AF_INET) {
1290 /* Convert dst to IPv6 */
1291 v4tov6(&tmp, &((struct sockaddr_in *)dst)->sin_addr);
1292 dst_port = ((struct sockaddr_in *)dst)->sin_port;
1293 }
1294 else {
1295 tmp = ((struct sockaddr_in6 *)dst)->sin6_addr;
1296 dst_port = ((struct sockaddr_in6 *)dst)->sin6_port;
1297 }
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001298
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001299 if (!inet_ntop(AF_INET6, &tmp, dst_str, sizeof(dst_str)))
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001300 return 0;
1301 }
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001302
1303 ret = snprintf(buf, buf_len, "PROXY %s %s %s %u %u\r\n", protocol, src_str, dst_str, ntohs(src_port), ntohs(dst_port));
1304 if (ret >= buf_len)
1305 return 0;
1306
Willy Tarreaue1e4a612012-10-05 00:10:55 +02001307 return ret;
1308}
David Safb76832014-05-08 23:42:08 -04001309
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +01001310static int make_tlv(char *dest, int dest_len, char type, uint16_t length, const char *value)
David Safb76832014-05-08 23:42:08 -04001311{
1312 struct tlv *tlv;
1313
1314 if (!dest || (length + sizeof(*tlv) > dest_len))
1315 return 0;
1316
1317 tlv = (struct tlv *)dest;
1318
1319 tlv->type = type;
1320 tlv->length_hi = length >> 8;
1321 tlv->length_lo = length & 0x00ff;
1322 memcpy(tlv->value, value, length);
1323 return length + sizeof(*tlv);
1324}
David Safb76832014-05-08 23:42:08 -04001325
Ilya Shipitsinca56fce2018-09-15 00:50:05 +05001326/* Note: <remote> is explicitly allowed to be NULL */
David Safb76832014-05-08 23:42:08 -04001327int make_proxy_line_v2(char *buf, int buf_len, struct server *srv, struct connection *remote)
1328{
Willy Tarreau8fccfa22014-06-14 08:28:06 +02001329 const char pp2_signature[] = PP2_SIGNATURE;
Emmanuel Hocdet4399c752018-02-05 15:26:43 +01001330 void *tlv_crc32c_p = NULL;
David Safb76832014-05-08 23:42:08 -04001331 int ret = 0;
Willy Tarreau8fccfa22014-06-14 08:28:06 +02001332 struct proxy_hdr_v2 *hdr = (struct proxy_hdr_v2 *)buf;
Vincent Bernat6e615892016-05-18 16:17:44 +02001333 struct sockaddr_storage null_addr = { .ss_family = 0 };
David Safb76832014-05-08 23:42:08 -04001334 struct sockaddr_storage *src = &null_addr;
1335 struct sockaddr_storage *dst = &null_addr;
Emmanuel Hocdet404d9782017-10-24 10:55:14 +02001336 const char *value;
1337 int value_len;
David Safb76832014-05-08 23:42:08 -04001338
1339 if (buf_len < PP2_HEADER_LEN)
1340 return 0;
Willy Tarreau8fccfa22014-06-14 08:28:06 +02001341 memcpy(hdr->sig, pp2_signature, PP2_SIGNATURE_LEN);
David Safb76832014-05-08 23:42:08 -04001342
Willy Tarreau226572f2019-07-17 14:46:00 +02001343 if (remote && conn_get_src(remote) && conn_get_dst(remote)) {
1344 src = remote->src;
1345 dst = remote->dst;
David Safb76832014-05-08 23:42:08 -04001346 }
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +01001347
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001348 /* At least one of src or dst is not of AF_INET or AF_INET6 */
1349 if ( !src
1350 || !dst
1351 || (src->ss_family != AF_INET && src->ss_family != AF_INET6)
1352 || (dst->ss_family != AF_INET && dst->ss_family != AF_INET6)) {
David Safb76832014-05-08 23:42:08 -04001353 if (buf_len < PP2_HDR_LEN_UNSPEC)
1354 return 0;
Willy Tarreau8fccfa22014-06-14 08:28:06 +02001355 hdr->ver_cmd = PP2_VERSION | PP2_CMD_LOCAL;
1356 hdr->fam = PP2_FAM_UNSPEC | PP2_TRANS_UNSPEC;
David Safb76832014-05-08 23:42:08 -04001357 ret = PP2_HDR_LEN_UNSPEC;
1358 }
Tim Duesterhus7fec0212018-07-27 18:46:13 +02001359 else {
1360 /* IPv4 for both src and dst */
1361 if (src->ss_family == AF_INET && dst->ss_family == AF_INET) {
1362 if (buf_len < PP2_HDR_LEN_INET)
1363 return 0;
1364 hdr->ver_cmd = PP2_VERSION | PP2_CMD_PROXY;
1365 hdr->fam = PP2_FAM_INET | PP2_TRANS_STREAM;
1366 hdr->addr.ip4.src_addr = ((struct sockaddr_in *)src)->sin_addr.s_addr;
1367 hdr->addr.ip4.src_port = ((struct sockaddr_in *)src)->sin_port;
1368 hdr->addr.ip4.dst_addr = ((struct sockaddr_in *)dst)->sin_addr.s_addr;
1369 hdr->addr.ip4.dst_port = ((struct sockaddr_in *)dst)->sin_port;
1370 ret = PP2_HDR_LEN_INET;
1371 }
1372 /* IPv6 for at least one of src and dst */
1373 else {
1374 struct in6_addr tmp;
1375
1376 if (buf_len < PP2_HDR_LEN_INET6)
1377 return 0;
1378 hdr->ver_cmd = PP2_VERSION | PP2_CMD_PROXY;
1379 hdr->fam = PP2_FAM_INET6 | PP2_TRANS_STREAM;
1380 if (src->ss_family == AF_INET) {
1381 v4tov6(&tmp, &((struct sockaddr_in *)src)->sin_addr);
1382 memcpy(hdr->addr.ip6.src_addr, &tmp, 16);
1383 hdr->addr.ip6.src_port = ((struct sockaddr_in *)src)->sin_port;
1384 }
1385 else {
1386 memcpy(hdr->addr.ip6.src_addr, &((struct sockaddr_in6 *)src)->sin6_addr, 16);
1387 hdr->addr.ip6.src_port = ((struct sockaddr_in6 *)src)->sin6_port;
1388 }
1389 if (dst->ss_family == AF_INET) {
1390 v4tov6(&tmp, &((struct sockaddr_in *)dst)->sin_addr);
1391 memcpy(hdr->addr.ip6.dst_addr, &tmp, 16);
1392 hdr->addr.ip6.src_port = ((struct sockaddr_in *)src)->sin_port;
1393 }
1394 else {
1395 memcpy(hdr->addr.ip6.dst_addr, &((struct sockaddr_in6 *)dst)->sin6_addr, 16);
1396 hdr->addr.ip6.dst_port = ((struct sockaddr_in6 *)dst)->sin6_port;
1397 }
1398
1399 ret = PP2_HDR_LEN_INET6;
1400 }
1401 }
David Safb76832014-05-08 23:42:08 -04001402
Emmanuel Hocdet4399c752018-02-05 15:26:43 +01001403 if (srv->pp_opts & SRV_PP_V2_CRC32C) {
1404 uint32_t zero_crc32c = 0;
1405 if ((buf_len - ret) < sizeof(struct tlv))
1406 return 0;
1407 tlv_crc32c_p = (void *)((struct tlv *)&buf[ret])->value;
1408 ret += make_tlv(&buf[ret], (buf_len - ret), PP2_TYPE_CRC32C, sizeof(zero_crc32c), (const char *)&zero_crc32c);
1409 }
1410
Ilya Shipitsinca56fce2018-09-15 00:50:05 +05001411 if (remote && conn_get_alpn(remote, &value, &value_len)) {
Emmanuel Hocdet404d9782017-10-24 10:55:14 +02001412 if ((buf_len - ret) < sizeof(struct tlv))
1413 return 0;
Emmanuel Hocdet571c7ac2017-10-31 18:24:05 +01001414 ret += make_tlv(&buf[ret], (buf_len - ret), PP2_TYPE_ALPN, value_len, value);
Emmanuel Hocdet404d9782017-10-24 10:55:14 +02001415 }
1416
Emmanuel Hocdet253c3b72018-02-01 18:29:59 +01001417 if (srv->pp_opts & SRV_PP_V2_AUTHORITY) {
Emmanuel Hocdet8a4ffa02019-08-29 11:54:51 +02001418 value = NULL;
1419 if (remote && remote->proxy_authority) {
1420 value = remote->proxy_authority;
1421 value_len = remote->proxy_authority_len;
1422 }
1423#ifdef USE_OPENSSL
1424 else {
Jerome Magnin78891c72019-09-02 09:53:41 +02001425 if ((value = ssl_sock_get_sni(remote)))
Emmanuel Hocdet8a4ffa02019-08-29 11:54:51 +02001426 value_len = strlen(value);
1427 }
1428#endif
Emmanuel Hocdet253c3b72018-02-01 18:29:59 +01001429 if (value) {
1430 if ((buf_len - ret) < sizeof(struct tlv))
1431 return 0;
Emmanuel Hocdet8a4ffa02019-08-29 11:54:51 +02001432 ret += make_tlv(&buf[ret], (buf_len - ret), PP2_TYPE_AUTHORITY, value_len, value);
Emmanuel Hocdet253c3b72018-02-01 18:29:59 +01001433 }
1434 }
1435
Emmanuel Hocdet8a4ffa02019-08-29 11:54:51 +02001436#ifdef USE_OPENSSL
David Safb76832014-05-08 23:42:08 -04001437 if (srv->pp_opts & SRV_PP_V2_SSL) {
Emmanuel Hocdet404d9782017-10-24 10:55:14 +02001438 struct tlv_ssl *tlv;
1439 int ssl_tlv_len = 0;
David Safb76832014-05-08 23:42:08 -04001440 if ((buf_len - ret) < sizeof(struct tlv_ssl))
1441 return 0;
1442 tlv = (struct tlv_ssl *)&buf[ret];
1443 memset(tlv, 0, sizeof(struct tlv_ssl));
1444 ssl_tlv_len += sizeof(struct tlv_ssl);
1445 tlv->tlv.type = PP2_TYPE_SSL;
1446 if (ssl_sock_is_ssl(remote)) {
1447 tlv->client |= PP2_CLIENT_SSL;
Emmanuel Hocdet01da5712017-10-13 16:59:49 +02001448 value = ssl_sock_get_proto_version(remote);
David Safb76832014-05-08 23:42:08 -04001449 if (value) {
Emmanuel Hocdet8c0c34b2018-02-28 12:02:14 +01001450 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 -04001451 }
Dave McCowan328fb582014-07-30 10:39:13 -04001452 if (ssl_sock_get_cert_used_sess(remote)) {
1453 tlv->client |= PP2_CLIENT_CERT_SESS;
David Safb76832014-05-08 23:42:08 -04001454 tlv->verify = htonl(ssl_sock_get_verify_result(remote));
Dave McCowan328fb582014-07-30 10:39:13 -04001455 if (ssl_sock_get_cert_used_conn(remote))
1456 tlv->client |= PP2_CLIENT_CERT_CONN;
David Safb76832014-05-08 23:42:08 -04001457 }
1458 if (srv->pp_opts & SRV_PP_V2_SSL_CN) {
Willy Tarreau83061a82018-07-13 11:56:34 +02001459 struct buffer *cn_trash = get_trash_chunk();
Willy Tarreau3b9a0c92014-07-19 06:37:33 +02001460 if (ssl_sock_get_remote_common_name(remote, cn_trash) > 0) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001461 ssl_tlv_len += make_tlv(&buf[ret+ssl_tlv_len], (buf_len - ret - ssl_tlv_len), PP2_SUBTYPE_SSL_CN,
1462 cn_trash->data,
1463 cn_trash->area);
David Safb76832014-05-08 23:42:08 -04001464 }
1465 }
Emmanuel Hocdetfa8d0f12018-02-01 15:53:52 +01001466 if (srv->pp_opts & SRV_PP_V2_SSL_KEY_ALG) {
Willy Tarreau83061a82018-07-13 11:56:34 +02001467 struct buffer *pkey_trash = get_trash_chunk();
Emmanuel Hocdetfa8d0f12018-02-01 15:53:52 +01001468 if (ssl_sock_get_pkey_algo(remote, pkey_trash) > 0) {
Willy Tarreau843b7cb2018-07-13 10:54:26 +02001469 ssl_tlv_len += make_tlv(&buf[ret+ssl_tlv_len], (buf_len - ret - ssl_tlv_len), PP2_SUBTYPE_SSL_KEY_ALG,
1470 pkey_trash->data,
1471 pkey_trash->area);
Emmanuel Hocdetfa8d0f12018-02-01 15:53:52 +01001472 }
1473 }
1474 if (srv->pp_opts & SRV_PP_V2_SSL_SIG_ALG) {
1475 value = ssl_sock_get_cert_sig(remote);
1476 if (value) {
1477 ssl_tlv_len += make_tlv(&buf[ret+ssl_tlv_len], (buf_len - ret - ssl_tlv_len), PP2_SUBTYPE_SSL_SIG_ALG, strlen(value), value);
1478 }
1479 }
1480 if (srv->pp_opts & SRV_PP_V2_SSL_CIPHER) {
1481 value = ssl_sock_get_cipher_name(remote);
1482 if (value) {
1483 ssl_tlv_len += make_tlv(&buf[ret+ssl_tlv_len], (buf_len - ret - ssl_tlv_len), PP2_SUBTYPE_SSL_CIPHER, strlen(value), value);
1484 }
1485 }
David Safb76832014-05-08 23:42:08 -04001486 }
1487 tlv->tlv.length_hi = (uint16_t)(ssl_tlv_len - sizeof(struct tlv)) >> 8;
1488 tlv->tlv.length_lo = (uint16_t)(ssl_tlv_len - sizeof(struct tlv)) & 0x00ff;
1489 ret += ssl_tlv_len;
1490 }
1491#endif
1492
Willy Tarreaue5733232019-05-22 19:24:06 +02001493#ifdef USE_NS
KOVACS Krisztianb3e54fe2014-11-17 15:11:45 +01001494 if (remote && (remote->proxy_netns)) {
1495 if ((buf_len - ret) < sizeof(struct tlv))
1496 return 0;
Emmanuel Hocdet571c7ac2017-10-31 18:24:05 +01001497 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 +01001498 }
1499#endif
1500
Willy Tarreau8fccfa22014-06-14 08:28:06 +02001501 hdr->len = htons((uint16_t)(ret - PP2_HEADER_LEN));
David Safb76832014-05-08 23:42:08 -04001502
Emmanuel Hocdet4399c752018-02-05 15:26:43 +01001503 if (tlv_crc32c_p) {
1504 write_u32(tlv_crc32c_p, htonl(hash_crc32c(buf, ret)));
1505 }
1506
David Safb76832014-05-08 23:42:08 -04001507 return ret;
1508}
Emeric Brun4f603012017-01-05 15:11:44 +01001509
Willy Tarreau60ca10a2017-08-18 15:26:54 +02001510/* return the major HTTP version as 1 or 2 depending on how the request arrived
1511 * before being processed.
1512 */
1513static int
1514smp_fetch_fc_http_major(const struct arg *args, struct sample *smp, const char *kw, void *private)
1515{
Jérôme Magnin86577422018-12-07 09:03:11 +01001516 struct connection *conn = (kw[0] != 'b') ? objt_conn(smp->sess->origin) :
1517 smp->strm ? cs_conn(objt_cs(smp->strm->si[1].end)) : NULL;
Willy Tarreau60ca10a2017-08-18 15:26:54 +02001518
1519 smp->data.type = SMP_T_SINT;
1520 smp->data.u.sint = (conn && strcmp(conn_get_mux_name(conn), "H2") == 0) ? 2 : 1;
1521 return 1;
1522}
1523
Emeric Brun4f603012017-01-05 15:11:44 +01001524/* fetch if the received connection used a PROXY protocol header */
1525int smp_fetch_fc_rcvd_proxy(const struct arg *args, struct sample *smp, const char *kw, void *private)
1526{
1527 struct connection *conn;
1528
1529 conn = objt_conn(smp->sess->origin);
1530 if (!conn)
1531 return 0;
1532
Willy Tarreauc192b0a2020-01-23 09:11:58 +01001533 if (conn->flags & CO_FL_WAIT_L4L6) {
Emeric Brun4f603012017-01-05 15:11:44 +01001534 smp->flags |= SMP_F_MAY_CHANGE;
1535 return 0;
1536 }
1537
1538 smp->flags = 0;
1539 smp->data.type = SMP_T_BOOL;
1540 smp->data.u.sint = (conn->flags & CO_FL_RCVD_PROXY) ? 1 : 0;
1541
1542 return 1;
1543}
1544
Geoff Simmons7185b782019-08-27 18:31:16 +02001545/* fetch the authority TLV from a PROXY protocol header */
1546int smp_fetch_fc_pp_authority(const struct arg *args, struct sample *smp, const char *kw, void *private)
1547{
1548 struct connection *conn;
1549
1550 conn = objt_conn(smp->sess->origin);
1551 if (!conn)
1552 return 0;
1553
Willy Tarreauc192b0a2020-01-23 09:11:58 +01001554 if (conn->flags & CO_FL_WAIT_L4L6) {
Geoff Simmons7185b782019-08-27 18:31:16 +02001555 smp->flags |= SMP_F_MAY_CHANGE;
1556 return 0;
1557 }
1558
1559 if (conn->proxy_authority == NULL)
1560 return 0;
1561
1562 smp->flags = 0;
1563 smp->data.type = SMP_T_STR;
1564 smp->data.u.str.area = conn->proxy_authority;
1565 smp->data.u.str.data = conn->proxy_authority_len;
1566
1567 return 1;
1568}
1569
Emeric Brun4f603012017-01-05 15:11:44 +01001570/* Note: must not be declared <const> as its list will be overwritten.
1571 * Note: fetches that may return multiple types must be declared as the lowest
1572 * common denominator, the type that can be casted into all other ones. For
1573 * instance v4/v6 must be declared v4.
1574 */
1575static struct sample_fetch_kw_list sample_fetch_keywords = {ILH, {
Willy Tarreau60ca10a2017-08-18 15:26:54 +02001576 { "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 +01001577 { "bc_http_major", smp_fetch_fc_http_major, 0, NULL, SMP_T_SINT, SMP_USE_L4SRV },
Emeric Brun4f603012017-01-05 15:11:44 +01001578 { "fc_rcvd_proxy", smp_fetch_fc_rcvd_proxy, 0, NULL, SMP_T_BOOL, SMP_USE_L4CLI },
Geoff Simmons7185b782019-08-27 18:31:16 +02001579 { "fc_pp_authority", smp_fetch_fc_pp_authority, 0, NULL, SMP_T_STR, SMP_USE_L4CLI },
Emeric Brun4f603012017-01-05 15:11:44 +01001580 { /* END */ },
1581}};
1582
Willy Tarreau0108d902018-11-25 19:14:37 +01001583INITCALL1(STG_REGISTER, sample_register_fetches, &sample_fetch_keywords);