blob: c826546d67e63b9dd5fdb6bb8eae2f6e688ba4de [file] [log] [blame]
Willy Tarreau92fb9832007-10-16 17:34:28 +02001/*
2 * UNIX SOCK_STREAM protocol layer (uxst)
3 *
Willy Tarreaueb472682010-05-28 18:46:57 +02004 * Copyright 2000-2010 Willy Tarreau <w@1wt.eu>
Willy Tarreau92fb9832007-10-16 17:34:28 +02005 *
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
13#include <ctype.h>
14#include <errno.h>
15#include <fcntl.h>
Willy Tarreaud0a895d2012-09-18 17:40:35 +020016#include <pwd.h>
17#include <grp.h>
Willy Tarreau92fb9832007-10-16 17:34:28 +020018#include <stdio.h>
19#include <stdlib.h>
20#include <string.h>
21#include <syslog.h>
22#include <time.h>
23
Willy Tarreau92fb9832007-10-16 17:34:28 +020024#include <sys/socket.h>
25#include <sys/stat.h>
26#include <sys/types.h>
27#include <sys/un.h>
28
Willy Tarreau4c7e4b72020-05-27 12:58:42 +020029#include <haproxy/api.h>
Willy Tarreau8d366972020-05-27 16:10:29 +020030#include <haproxy/errors.h>
Willy Tarreauf268ee82020-06-04 17:05:57 +020031#include <haproxy/global.h>
Willy Tarreau853b2972020-05-27 18:01:47 +020032#include <haproxy/list.h>
Willy Tarreau213e9902020-06-04 14:58:24 +020033#include <haproxy/listener.h>
Willy Tarreau48fbcae2020-06-03 18:09:46 +020034#include <haproxy/tools.h>
Willy Tarreau92b4f132020-06-01 11:05:15 +020035#include <haproxy/time.h>
Willy Tarreaud6788052020-05-27 15:59:00 +020036#include <haproxy/version.h>
Willy Tarreau92fb9832007-10-16 17:34:28 +020037
Willy Tarreau47f48c42014-05-09 22:57:47 +020038#include <proto/connection.h>
Willy Tarreau0f6ffd62020-06-03 19:33:00 +020039#include <haproxy/fd.h>
Willy Tarreau92fb9832007-10-16 17:34:28 +020040#include <proto/log.h>
Willy Tarreau2dd7c352020-06-03 15:26:55 +020041#include <haproxy/protocol.h>
Willy Tarreau92fb9832007-10-16 17:34:28 +020042
Emeric Bruncf20bf12010-10-22 16:06:11 +020043static int uxst_bind_listener(struct listener *listener, char *errmsg, int errlen);
44static int uxst_bind_listeners(struct protocol *proto, char *errmsg, int errlen);
Willy Tarreaudabf2e22007-10-28 21:59:24 +010045static int uxst_unbind_listeners(struct protocol *proto);
Olivier Houchardfdcb0072019-05-06 18:32:29 +020046static int uxst_connect_server(struct connection *conn, int flags);
Willy Tarreau9d5be5c2017-09-15 07:55:51 +020047static void uxst_add_listener(struct listener *listener, int port);
Willy Tarreau31794892017-09-15 07:59:31 +020048static int uxst_pause_listener(struct listener *l);
49static int uxst_get_src(int fd, struct sockaddr *sa, socklen_t salen, int dir);
50static int uxst_get_dst(int fd, struct sockaddr *sa, socklen_t salen, int dir);
Willy Tarreaudabf2e22007-10-28 21:59:24 +010051
52/* Note: must not be declared <const> as its list will be overwritten */
53static struct protocol proto_unix = {
54 .name = "unix_stream",
55 .sock_domain = PF_UNIX,
56 .sock_type = SOCK_STREAM,
57 .sock_prot = 0,
58 .sock_family = AF_UNIX,
59 .sock_addrlen = sizeof(struct sockaddr_un),
60 .l3_addrlen = sizeof(((struct sockaddr_un*)0)->sun_path),/* path len */
Willy Tarreaubbebbbf2012-05-07 21:22:09 +020061 .accept = &listener_accept,
Willy Tarreau47f48c42014-05-09 22:57:47 +020062 .connect = &uxst_connect_server,
Emeric Bruncf20bf12010-10-22 16:06:11 +020063 .bind = uxst_bind_listener,
Willy Tarreaudabf2e22007-10-28 21:59:24 +010064 .bind_all = uxst_bind_listeners,
65 .unbind_all = uxst_unbind_listeners,
66 .enable_all = enable_all_listeners,
67 .disable_all = disable_all_listeners,
Willy Tarreau59b94792012-05-11 16:16:40 +020068 .get_src = uxst_get_src,
69 .get_dst = uxst_get_dst,
Willy Tarreaufd0e0082014-07-07 21:07:51 +020070 .pause = uxst_pause_listener,
Willy Tarreau9d5be5c2017-09-15 07:55:51 +020071 .add = uxst_add_listener,
Willy Tarreaudabf2e22007-10-28 21:59:24 +010072 .listeners = LIST_HEAD_INIT(proto_unix.listeners),
73 .nb_listeners = 0,
74};
75
Willy Tarreau0108d902018-11-25 19:14:37 +010076INITCALL1(STG_REGISTER, protocol_register, &proto_unix);
77
Willy Tarreaudabf2e22007-10-28 21:59:24 +010078/********************************
79 * 1) low-level socket functions
80 ********************************/
81
Willy Tarreau59b94792012-05-11 16:16:40 +020082/*
83 * Retrieves the source address for the socket <fd>, with <dir> indicating
84 * if we're a listener (=0) or an initiator (!=0). It returns 0 in case of
85 * success, -1 in case of error. The socket's source address is stored in
86 * <sa> for <salen> bytes.
87 */
Willy Tarreau31794892017-09-15 07:59:31 +020088static int uxst_get_src(int fd, struct sockaddr *sa, socklen_t salen, int dir)
Willy Tarreau59b94792012-05-11 16:16:40 +020089{
90 if (dir)
91 return getsockname(fd, sa, &salen);
92 else
93 return getpeername(fd, sa, &salen);
94}
95
96
97/*
98 * Retrieves the original destination address for the socket <fd>, with <dir>
99 * indicating if we're a listener (=0) or an initiator (!=0). It returns 0 in
100 * case of success, -1 in case of error. The socket's source address is stored
101 * in <sa> for <salen> bytes.
102 */
Willy Tarreau31794892017-09-15 07:59:31 +0200103static int uxst_get_dst(int fd, struct sockaddr *sa, socklen_t salen, int dir)
Willy Tarreau59b94792012-05-11 16:16:40 +0200104{
105 if (dir)
106 return getpeername(fd, sa, &salen);
107 else
108 return getsockname(fd, sa, &salen);
109}
110
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100111
Cyril Bonté1f5848a2010-11-14 17:03:19 +0100112/********************************
113 * 2) listener-oriented functions
114 ********************************/
115
116
Olivier Houchardf886e342017-04-05 22:24:59 +0200117static int uxst_find_compatible_fd(struct listener *l)
118{
119 struct xfer_sock_list *xfer_sock = xfer_sock_list;
120 int ret = -1;
121
122 while (xfer_sock) {
123 struct sockaddr_un *un1 = (void *)&l->addr;
124 struct sockaddr_un *un2 = (void *)&xfer_sock->addr;
125
126 /*
127 * The bound socket's path as returned by getsockaddr
128 * will be the temporary name <sockname>.XXXXX.tmp,
129 * so we can't just compare the two names
130 */
131 if (xfer_sock->addr.ss_family == AF_UNIX &&
132 strncmp(un1->sun_path, un2->sun_path,
133 strlen(un1->sun_path)) == 0) {
134 char *after_sockname = un2->sun_path +
135 strlen(un1->sun_path);
136 /* Make a reasonnable effort to check that
137 * it is indeed a haproxy-generated temporary
138 * name, it's not perfect, but probably good enough.
139 */
140 if (after_sockname[0] == '.') {
141 after_sockname++;
142 while (after_sockname[0] >= '0' &&
143 after_sockname[0] <= '9')
144 after_sockname++;
145 if (!strcmp(after_sockname, ".tmp"))
146 break;
Olivier Houchardb4dd15b2018-06-06 18:34:34 +0200147 /* abns sockets sun_path starts with a \0 */
148 } else if (un1->sun_path[0] == 0
149 && un2->sun_path[0] == 0
150 && !memcmp(&un1->sun_path[1], &un2->sun_path[1],
151 sizeof(un1->sun_path) - 1))
152 break;
Olivier Houchardf886e342017-04-05 22:24:59 +0200153 }
154 xfer_sock = xfer_sock->next;
155 }
156 if (xfer_sock != NULL) {
157 ret = xfer_sock->fd;
158 if (xfer_sock == xfer_sock_list)
159 xfer_sock_list = xfer_sock->next;
160 if (xfer_sock->prev)
161 xfer_sock->prev->next = xfer_sock->next;
162 if (xfer_sock->next)
Olivier Houchardec9516a2018-03-08 18:25:49 +0100163 xfer_sock->next->prev = xfer_sock->prev;
Olivier Houchardf886e342017-04-05 22:24:59 +0200164 free(xfer_sock);
165 }
166 return ret;
167
168}
169
Cyril Bonté1f5848a2010-11-14 17:03:19 +0100170/* This function creates a UNIX socket associated to the listener. It changes
171 * the state from ASSIGNED to LISTEN. The socket is NOT enabled for polling.
Willy Tarreau8ab505b2013-01-24 01:41:38 +0100172 * The return value is composed from ERR_NONE, ERR_RETRYABLE and ERR_FATAL. It
173 * may return a warning or an error message in <errmsg> if the message is at
174 * most <errlen> bytes long (including '\0'). Note that <errmsg> may be NULL if
175 * <errlen> is also zero.
Willy Tarreau92fb9832007-10-16 17:34:28 +0200176 */
Cyril Bonté1f5848a2010-11-14 17:03:19 +0100177static int uxst_bind_listener(struct listener *listener, char *errmsg, int errlen)
Willy Tarreau92fb9832007-10-16 17:34:28 +0200178{
Cyril Bonté1f5848a2010-11-14 17:03:19 +0100179 int fd;
Willy Tarreau92fb9832007-10-16 17:34:28 +0200180 char tempname[MAXPATHLEN];
181 char backname[MAXPATHLEN];
182 struct sockaddr_un addr;
Willy Tarreaub40dc942010-11-07 12:10:51 +0100183 const char *msg = NULL;
Cyril Bonté1f5848a2010-11-14 17:03:19 +0100184 const char *path;
Willy Tarreau327ea5a2020-02-11 06:43:37 +0100185 int maxpathlen;
Willy Tarreau40aa0702013-03-10 23:51:38 +0100186 int ext, ready;
187 socklen_t ready_len;
Willy Tarreau3c5efa22014-07-07 18:36:45 +0200188 int err;
Cyril Bonté1f5848a2010-11-14 17:03:19 +0100189 int ret;
Willy Tarreau92fb9832007-10-16 17:34:28 +0200190
Willy Tarreau3c5efa22014-07-07 18:36:45 +0200191 err = ERR_NONE;
192
Cyril Bonté1f5848a2010-11-14 17:03:19 +0100193 /* ensure we never return garbage */
Willy Tarreau8ab505b2013-01-24 01:41:38 +0100194 if (errlen)
Cyril Bonté1f5848a2010-11-14 17:03:19 +0100195 *errmsg = 0;
196
197 if (listener->state != LI_ASSIGNED)
198 return ERR_NONE; /* already bound */
199
Olivier Houchardf886e342017-04-05 22:24:59 +0200200 if (listener->fd == -1)
201 listener->fd = uxst_find_compatible_fd(listener);
Cyril Bonté1f5848a2010-11-14 17:03:19 +0100202 path = ((struct sockaddr_un *)&listener->addr)->sun_path;
Willy Tarreau92fb9832007-10-16 17:34:28 +0200203
Willy Tarreau327ea5a2020-02-11 06:43:37 +0100204 maxpathlen = MIN(MAXPATHLEN, sizeof(addr.sun_path));
205
Willy Tarreau40aa0702013-03-10 23:51:38 +0100206 /* if the listener already has an fd assigned, then we were offered the
207 * fd by an external process (most likely the parent), and we don't want
208 * to create a new socket. However we still want to set a few flags on
209 * the socket.
210 */
211 fd = listener->fd;
212 ext = (fd >= 0);
213 if (ext)
214 goto fd_ready;
215
Willy Tarreauccfccef2014-05-10 01:49:15 +0200216 if (path[0]) {
Willy Tarreau327ea5a2020-02-11 06:43:37 +0100217 ret = snprintf(tempname, maxpathlen, "%s.%d.tmp", path, pid);
218 if (ret < 0 || ret >= maxpathlen) {
Willy Tarreau3c5efa22014-07-07 18:36:45 +0200219 err |= ERR_FATAL | ERR_ALERT;
Willy Tarreau327ea5a2020-02-11 06:43:37 +0100220 msg = "name too long for UNIX socket (limit usually 97)";
Willy Tarreauccfccef2014-05-10 01:49:15 +0200221 goto err_return;
222 }
Willy Tarreau92fb9832007-10-16 17:34:28 +0200223
Willy Tarreau327ea5a2020-02-11 06:43:37 +0100224 ret = snprintf(backname, maxpathlen, "%s.%d.bak", path, pid);
225 if (ret < 0 || ret >= maxpathlen) {
Willy Tarreau3c5efa22014-07-07 18:36:45 +0200226 err |= ERR_FATAL | ERR_ALERT;
Willy Tarreau327ea5a2020-02-11 06:43:37 +0100227 msg = "name too long for UNIX socket (limit usually 97)";
Willy Tarreauccfccef2014-05-10 01:49:15 +0200228 goto err_return;
229 }
Willy Tarreau92fb9832007-10-16 17:34:28 +0200230
Willy Tarreauccfccef2014-05-10 01:49:15 +0200231 /* 2. clean existing orphaned entries */
232 if (unlink(tempname) < 0 && errno != ENOENT) {
Willy Tarreau3c5efa22014-07-07 18:36:45 +0200233 err |= ERR_FATAL | ERR_ALERT;
Willy Tarreauccfccef2014-05-10 01:49:15 +0200234 msg = "error when trying to unlink previous UNIX socket";
235 goto err_return;
236 }
Willy Tarreau92fb9832007-10-16 17:34:28 +0200237
Willy Tarreauccfccef2014-05-10 01:49:15 +0200238 if (unlink(backname) < 0 && errno != ENOENT) {
Willy Tarreau3c5efa22014-07-07 18:36:45 +0200239 err |= ERR_FATAL | ERR_ALERT;
Willy Tarreauccfccef2014-05-10 01:49:15 +0200240 msg = "error when trying to unlink previous UNIX socket";
241 goto err_return;
242 }
Willy Tarreau92fb9832007-10-16 17:34:28 +0200243
Willy Tarreauccfccef2014-05-10 01:49:15 +0200244 /* 3. backup existing socket */
245 if (link(path, backname) < 0 && errno != ENOENT) {
Willy Tarreau3c5efa22014-07-07 18:36:45 +0200246 err |= ERR_FATAL | ERR_ALERT;
Willy Tarreauccfccef2014-05-10 01:49:15 +0200247 msg = "error when trying to preserve previous UNIX socket";
248 goto err_return;
249 }
Willy Tarreau92fb9832007-10-16 17:34:28 +0200250
Willy Tarreau719e07c2019-12-11 16:29:10 +0100251 strncpy(addr.sun_path, tempname, sizeof(addr.sun_path) - 1);
Willy Tarreauccfccef2014-05-10 01:49:15 +0200252 addr.sun_path[sizeof(addr.sun_path) - 1] = 0;
Willy Tarreau92fb9832007-10-16 17:34:28 +0200253 }
Willy Tarreauccfccef2014-05-10 01:49:15 +0200254 else {
255 /* first char is zero, it's an abstract socket whose address
256 * is defined by all the bytes past this zero.
257 */
258 memcpy(addr.sun_path, path, sizeof(addr.sun_path));
259 }
Willy Tarreau92fb9832007-10-16 17:34:28 +0200260 addr.sun_family = AF_UNIX;
Willy Tarreau92fb9832007-10-16 17:34:28 +0200261
Cyril Bonté1f5848a2010-11-14 17:03:19 +0100262 fd = socket(PF_UNIX, SOCK_STREAM, 0);
263 if (fd < 0) {
Willy Tarreau3c5efa22014-07-07 18:36:45 +0200264 err |= ERR_FATAL | ERR_ALERT;
Willy Tarreaub40dc942010-11-07 12:10:51 +0100265 msg = "cannot create UNIX socket";
Willy Tarreau92fb9832007-10-16 17:34:28 +0200266 goto err_unlink_back;
267 }
268
Willy Tarreau40aa0702013-03-10 23:51:38 +0100269 fd_ready:
Cyril Bonté1f5848a2010-11-14 17:03:19 +0100270 if (fd >= global.maxsock) {
Willy Tarreau3c5efa22014-07-07 18:36:45 +0200271 err |= ERR_FATAL | ERR_ALERT;
Willy Tarreaub40dc942010-11-07 12:10:51 +0100272 msg = "socket(): not enough free sockets, raise -n argument";
Willy Tarreau92fb9832007-10-16 17:34:28 +0200273 goto err_unlink_temp;
274 }
Cyril Bonté1f5848a2010-11-14 17:03:19 +0100275
276 if (fcntl(fd, F_SETFL, O_NONBLOCK) == -1) {
Willy Tarreau3c5efa22014-07-07 18:36:45 +0200277 err |= ERR_FATAL | ERR_ALERT;
Willy Tarreaub40dc942010-11-07 12:10:51 +0100278 msg = "cannot make UNIX socket non-blocking";
Willy Tarreau92fb9832007-10-16 17:34:28 +0200279 goto err_unlink_temp;
280 }
Cyril Bonté1f5848a2010-11-14 17:03:19 +0100281
Willy Tarreau40aa0702013-03-10 23:51:38 +0100282 if (!ext && bind(fd, (struct sockaddr *)&addr, sizeof(addr)) < 0) {
Willy Tarreau92fb9832007-10-16 17:34:28 +0200283 /* note that bind() creates the socket <tempname> on the file system */
Willy Tarreau3c5efa22014-07-07 18:36:45 +0200284 if (errno == EADDRINUSE) {
285 /* the old process might still own it, let's retry */
286 err |= ERR_RETRYABLE | ERR_ALERT;
287 msg = "cannot listen to socket";
288 }
289 else {
290 err |= ERR_FATAL | ERR_ALERT;
291 msg = "cannot bind UNIX socket";
292 }
Willy Tarreau92fb9832007-10-16 17:34:28 +0200293 goto err_unlink_temp;
294 }
295
Cyril Bonté1f5848a2010-11-14 17:03:19 +0100296 /* <uid> and <gid> different of -1 will be used to change the socket owner.
297 * If <mode> is not 0, it will be used to restrict access to the socket.
298 * While it is known not to be portable on every OS, it's still useful
Willy Tarreauccfccef2014-05-10 01:49:15 +0200299 * where it works. We also don't change permissions on abstract sockets.
Cyril Bonté1f5848a2010-11-14 17:03:19 +0100300 */
Willy Tarreauccfccef2014-05-10 01:49:15 +0200301 if (!ext && path[0] &&
Willy Tarreau40aa0702013-03-10 23:51:38 +0100302 (((listener->bind_conf->ux.uid != -1 || listener->bind_conf->ux.gid != -1) &&
303 (chown(tempname, listener->bind_conf->ux.uid, listener->bind_conf->ux.gid) == -1)) ||
304 (listener->bind_conf->ux.mode != 0 && chmod(tempname, listener->bind_conf->ux.mode) == -1))) {
Willy Tarreau3c5efa22014-07-07 18:36:45 +0200305 err |= ERR_FATAL | ERR_ALERT;
Willy Tarreaub40dc942010-11-07 12:10:51 +0100306 msg = "cannot change UNIX socket ownership";
Willy Tarreaue6ad2b12007-10-18 12:45:54 +0200307 goto err_unlink_temp;
308 }
309
Willy Tarreau40aa0702013-03-10 23:51:38 +0100310 ready = 0;
311 ready_len = sizeof(ready);
312 if (getsockopt(fd, SOL_SOCKET, SO_ACCEPTCONN, &ready, &ready_len) == -1)
313 ready = 0;
314
315 if (!(ext && ready) && /* only listen if not already done by external process */
Willy Tarreaue2711c72019-02-27 15:39:41 +0100316 listen(fd, listener_backlog(listener)) < 0) {
Willy Tarreau3c5efa22014-07-07 18:36:45 +0200317 err |= ERR_FATAL | ERR_ALERT;
Willy Tarreaub40dc942010-11-07 12:10:51 +0100318 msg = "cannot listen to UNIX socket";
Willy Tarreau92fb9832007-10-16 17:34:28 +0200319 goto err_unlink_temp;
320 }
321
Willy Tarreauccfccef2014-05-10 01:49:15 +0200322 /* Point of no return: we are ready, we'll switch the sockets. We don't
Willy Tarreau92fb9832007-10-16 17:34:28 +0200323 * fear loosing the socket <path> because we have a copy of it in
Willy Tarreauccfccef2014-05-10 01:49:15 +0200324 * backname. Abstract sockets are not renamed.
Willy Tarreau92fb9832007-10-16 17:34:28 +0200325 */
Willy Tarreauccfccef2014-05-10 01:49:15 +0200326 if (!ext && path[0] && rename(tempname, path) < 0) {
Willy Tarreau3c5efa22014-07-07 18:36:45 +0200327 err |= ERR_FATAL | ERR_ALERT;
Willy Tarreaub40dc942010-11-07 12:10:51 +0100328 msg = "cannot switch final and temporary UNIX sockets";
Willy Tarreau92fb9832007-10-16 17:34:28 +0200329 goto err_rename;
330 }
331
Willy Tarreau68986ab2017-06-16 10:34:20 +0200332 /* Cleanup: only unlink if we didn't inherit the fd from the parent */
Willy Tarreauccfccef2014-05-10 01:49:15 +0200333 if (!ext && path[0])
Willy Tarreau40aa0702013-03-10 23:51:38 +0100334 unlink(backname);
Willy Tarreau92fb9832007-10-16 17:34:28 +0200335
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100336 /* the socket is now listening */
337 listener->fd = fd;
338 listener->state = LI_LISTEN;
339
Willy Tarreaua9786b62018-01-25 07:22:13 +0100340 fd_insert(fd, listener, listener->proto->accept,
Willy Tarreau0948a782020-02-12 10:15:34 +0100341 thread_mask(listener->bind_conf->bind_thread) & all_threads_mask);
Willy Tarreaua9786b62018-01-25 07:22:13 +0100342
Willy Tarreau3c5efa22014-07-07 18:36:45 +0200343 return err;
344
Cyril Bonté1f5848a2010-11-14 17:03:19 +0100345 err_rename:
346 ret = rename(backname, path);
347 if (ret < 0 && errno == ENOENT)
348 unlink(path);
349 err_unlink_temp:
Jan Seda7319b642014-06-26 20:44:05 +0200350 if (!ext && path[0])
Willy Tarreau40aa0702013-03-10 23:51:38 +0100351 unlink(tempname);
Cyril Bonté1f5848a2010-11-14 17:03:19 +0100352 close(fd);
353 err_unlink_back:
Jan Seda7319b642014-06-26 20:44:05 +0200354 if (!ext && path[0])
Willy Tarreau40aa0702013-03-10 23:51:38 +0100355 unlink(backname);
Cyril Bonté1f5848a2010-11-14 17:03:19 +0100356 err_return:
Willy Tarreau40aa0702013-03-10 23:51:38 +0100357 if (msg && errlen) {
358 if (!ext)
359 snprintf(errmsg, errlen, "%s [%s]", msg, path);
360 else
361 snprintf(errmsg, errlen, "%s [fd %d]", msg, fd);
362 }
Willy Tarreau3c5efa22014-07-07 18:36:45 +0200363 return err;
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100364}
365
366/* This function closes the UNIX sockets for the specified listener.
367 * The listener enters the LI_ASSIGNED state. It always returns ERR_NONE.
368 */
369static int uxst_unbind_listener(struct listener *listener)
370{
Willy Tarreaube58c382011-07-24 18:28:10 +0200371 if (listener->state > LI_ASSIGNED) {
372 unbind_listener(listener);
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100373 }
374 return ERR_NONE;
375}
376
Willy Tarreau32282382017-09-15 07:44:44 +0200377/* Add <listener> to the list of unix stream listeners (port is ignored). The
378 * listener's state is automatically updated from LI_INIT to LI_ASSIGNED.
379 * The number of listeners for the protocol is updated.
Willy Tarreaudaacf362019-07-24 16:45:02 +0200380 *
381 * Must be called with proto_lock held.
382 *
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100383 */
Willy Tarreau9d5be5c2017-09-15 07:55:51 +0200384static void uxst_add_listener(struct listener *listener, int port)
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100385{
386 if (listener->state != LI_INIT)
387 return;
388 listener->state = LI_ASSIGNED;
389 listener->proto = &proto_unix;
390 LIST_ADDQ(&proto_unix.listeners, &listener->proto_list);
391 proto_unix.nb_listeners++;
392}
393
Willy Tarreaufd0e0082014-07-07 21:07:51 +0200394/* Pause a listener. Returns < 0 in case of failure, 0 if the listener
395 * was totally stopped, or > 0 if correctly paused. Nothing is done for
396 * plain unix sockets since currently it's the new process which handles
397 * the renaming. Abstract sockets are completely unbound.
398 */
Willy Tarreau31794892017-09-15 07:59:31 +0200399static int uxst_pause_listener(struct listener *l)
Willy Tarreaufd0e0082014-07-07 21:07:51 +0200400{
401 if (((struct sockaddr_un *)&l->addr)->sun_path[0])
402 return 1;
403
Christopher Faulet510c0d62018-03-16 10:04:47 +0100404 /* Listener's lock already held. Call lockless version of
405 * unbind_listener. */
406 do_unbind_listener(l, 1);
Willy Tarreaufd0e0082014-07-07 21:07:51 +0200407 return 0;
408}
409
Willy Tarreau47f48c42014-05-09 22:57:47 +0200410
411/*
412 * This function initiates a UNIX connection establishment to the target assigned
Willy Tarreauca9f5a92019-07-17 16:40:37 +0200413 * to connection <conn> using (si->{target,dst}). The source address is ignored
Willy Tarreau47f48c42014-05-09 22:57:47 +0200414 * and will be selected by the system. conn->target may point either to a valid
415 * server or to a backend, depending on conn->target. Only OBJ_TYPE_PROXY and
416 * OBJ_TYPE_SERVER are supported. The <data> parameter is a boolean indicating
417 * whether there are data waiting for being sent or not, in order to adjust data
418 * write polling and on some platforms. The <delack> argument is ignored.
419 *
420 * Note that a pending send_proxy message accounts for data.
421 *
422 * It can return one of :
Willy Tarreaue7dff022015-04-03 01:14:29 +0200423 * - SF_ERR_NONE if everything's OK
424 * - SF_ERR_SRVTO if there are no more servers
425 * - SF_ERR_SRVCL if the connection was refused by the server
426 * - SF_ERR_PRXCOND if the connection has been limited by the proxy (maxconn)
427 * - SF_ERR_RESOURCE if a system resource is lacking (eg: fd limits, ports, ...)
428 * - SF_ERR_INTERNAL for any other purely internal errors
Tim Düsterhus4896c442016-11-29 02:15:19 +0100429 * Additionally, in the case of SF_ERR_RESOURCE, an emergency log will be emitted.
Willy Tarreau47f48c42014-05-09 22:57:47 +0200430 *
Willy Tarreaue7dff022015-04-03 01:14:29 +0200431 * The connection's fd is inserted only when SF_ERR_NONE is returned, otherwise
Willy Tarreau47f48c42014-05-09 22:57:47 +0200432 * it's invalid and the caller has nothing to do.
433 */
Olivier Houchardfdcb0072019-05-06 18:32:29 +0200434static int uxst_connect_server(struct connection *conn, int flags)
Willy Tarreau47f48c42014-05-09 22:57:47 +0200435{
436 int fd;
437 struct server *srv;
438 struct proxy *be;
439
Willy Tarreau47f48c42014-05-09 22:57:47 +0200440 switch (obj_type(conn->target)) {
441 case OBJ_TYPE_PROXY:
442 be = objt_proxy(conn->target);
443 srv = NULL;
444 break;
445 case OBJ_TYPE_SERVER:
446 srv = objt_server(conn->target);
447 be = srv->proxy;
448 break;
449 default:
450 conn->flags |= CO_FL_ERROR;
Willy Tarreaue7dff022015-04-03 01:14:29 +0200451 return SF_ERR_INTERNAL;
Willy Tarreau47f48c42014-05-09 22:57:47 +0200452 }
453
Willy Tarreau585744b2017-08-24 14:31:19 +0200454 if ((fd = conn->handle.fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1) {
Willy Tarreau47f48c42014-05-09 22:57:47 +0200455 qfprintf(stderr, "Cannot get a server socket.\n");
456
457 if (errno == ENFILE) {
458 conn->err_code = CO_ER_SYS_FDLIM;
459 send_log(be, LOG_EMERG,
Willy Tarreauc5532ac2018-01-29 15:06:04 +0100460 "Proxy %s reached system FD limit (maxsock=%d). Please check system tunables.\n",
461 be->id, global.maxsock);
Willy Tarreau47f48c42014-05-09 22:57:47 +0200462 }
463 else if (errno == EMFILE) {
464 conn->err_code = CO_ER_PROC_FDLIM;
465 send_log(be, LOG_EMERG,
Willy Tarreauc5532ac2018-01-29 15:06:04 +0100466 "Proxy %s reached process FD limit (maxsock=%d). Please check 'ulimit-n' and restart.\n",
467 be->id, global.maxsock);
Willy Tarreau47f48c42014-05-09 22:57:47 +0200468 }
469 else if (errno == ENOBUFS || errno == ENOMEM) {
470 conn->err_code = CO_ER_SYS_MEMLIM;
471 send_log(be, LOG_EMERG,
Willy Tarreauc5532ac2018-01-29 15:06:04 +0100472 "Proxy %s reached system memory limit (maxsock=%d). Please check system tunables.\n",
473 be->id, global.maxsock);
Willy Tarreau47f48c42014-05-09 22:57:47 +0200474 }
475 else if (errno == EAFNOSUPPORT || errno == EPROTONOSUPPORT) {
476 conn->err_code = CO_ER_NOPROTO;
477 }
478 else
479 conn->err_code = CO_ER_SOCK_ERR;
480
481 /* this is a resource error */
482 conn->flags |= CO_FL_ERROR;
Willy Tarreaue7dff022015-04-03 01:14:29 +0200483 return SF_ERR_RESOURCE;
Willy Tarreau47f48c42014-05-09 22:57:47 +0200484 }
485
486 if (fd >= global.maxsock) {
487 /* do not log anything there, it's a normal condition when this option
488 * is used to serialize connections to a server !
489 */
Christopher Faulet767a84b2017-11-24 16:50:31 +0100490 ha_alert("socket(): not enough free sockets. Raise -n argument. Giving up.\n");
Willy Tarreau47f48c42014-05-09 22:57:47 +0200491 close(fd);
492 conn->err_code = CO_ER_CONF_FDLIM;
493 conn->flags |= CO_FL_ERROR;
Willy Tarreaue7dff022015-04-03 01:14:29 +0200494 return SF_ERR_PRXCOND; /* it is a configuration limit */
Willy Tarreau47f48c42014-05-09 22:57:47 +0200495 }
496
497 if (fcntl(fd, F_SETFL, O_NONBLOCK) == -1) {
498 qfprintf(stderr,"Cannot set client socket to non blocking mode.\n");
499 close(fd);
500 conn->err_code = CO_ER_SOCK_ERR;
501 conn->flags |= CO_FL_ERROR;
Willy Tarreaue7dff022015-04-03 01:14:29 +0200502 return SF_ERR_INTERNAL;
Willy Tarreau47f48c42014-05-09 22:57:47 +0200503 }
504
William Lallemandc03eb012018-11-27 12:02:37 +0100505 if (master == 1 && (fcntl(fd, F_SETFD, FD_CLOEXEC) == -1)) {
506 ha_alert("Cannot set CLOEXEC on client socket.\n");
507 close(fd);
508 conn->err_code = CO_ER_SOCK_ERR;
509 conn->flags |= CO_FL_ERROR;
510 return SF_ERR_INTERNAL;
511 }
512
Willy Tarreau47f48c42014-05-09 22:57:47 +0200513 /* if a send_proxy is there, there are data */
Olivier Houchardfdcb0072019-05-06 18:32:29 +0200514 if (conn->send_proxy_ofs)
515 flags |= CONNECT_HAS_DATA;
Willy Tarreau47f48c42014-05-09 22:57:47 +0200516
517 if (global.tune.server_sndbuf)
518 setsockopt(fd, SOL_SOCKET, SO_SNDBUF, &global.tune.server_sndbuf, sizeof(global.tune.server_sndbuf));
519
520 if (global.tune.server_rcvbuf)
521 setsockopt(fd, SOL_SOCKET, SO_RCVBUF, &global.tune.server_rcvbuf, sizeof(global.tune.server_rcvbuf));
522
Willy Tarreauca9f5a92019-07-17 16:40:37 +0200523 if (connect(fd, (struct sockaddr *)conn->dst, get_addr_len(conn->dst)) == -1) {
Willy Tarreau94841792017-01-25 14:27:38 +0100524 if (errno == EINPROGRESS || errno == EALREADY) {
Willy Tarreau7bb21532014-05-10 09:48:28 +0200525 conn->flags |= CO_FL_WAIT_L4_CONN;
526 }
Willy Tarreau94841792017-01-25 14:27:38 +0100527 else if (errno == EISCONN) {
528 conn->flags &= ~CO_FL_WAIT_L4_CONN;
529 }
Willy Tarreau7bb21532014-05-10 09:48:28 +0200530 else if (errno == EAGAIN || errno == EADDRINUSE || errno == EADDRNOTAVAIL) {
Willy Tarreau47f48c42014-05-09 22:57:47 +0200531 char *msg;
532 if (errno == EAGAIN || errno == EADDRNOTAVAIL) {
Lukas Tribus9f256d42016-01-26 20:33:14 +0100533 msg = "can't connect to destination unix socket, check backlog size on the server";
Willy Tarreau47f48c42014-05-09 22:57:47 +0200534 conn->err_code = CO_ER_FREE_PORTS;
535 }
536 else {
537 msg = "local address already in use";
538 conn->err_code = CO_ER_ADDR_INUSE;
539 }
540
541 qfprintf(stderr,"Connect() failed for backend %s: %s.\n", be->id, msg);
542 close(fd);
543 send_log(be, LOG_ERR, "Connect() failed for backend %s: %s.\n", be->id, msg);
544 conn->flags |= CO_FL_ERROR;
Willy Tarreaue7dff022015-04-03 01:14:29 +0200545 return SF_ERR_RESOURCE;
Willy Tarreau47f48c42014-05-09 22:57:47 +0200546 }
547 else if (errno == ETIMEDOUT) {
548 close(fd);
549 conn->err_code = CO_ER_SOCK_ERR;
550 conn->flags |= CO_FL_ERROR;
Willy Tarreaue7dff022015-04-03 01:14:29 +0200551 return SF_ERR_SRVTO;
Willy Tarreau47f48c42014-05-09 22:57:47 +0200552 }
553 else { // (errno == ECONNREFUSED || errno == ENETUNREACH || errno == EACCES || errno == EPERM)
554 close(fd);
555 conn->err_code = CO_ER_SOCK_ERR;
556 conn->flags |= CO_FL_ERROR;
Willy Tarreaue7dff022015-04-03 01:14:29 +0200557 return SF_ERR_SRVCL;
Willy Tarreau47f48c42014-05-09 22:57:47 +0200558 }
559 }
Willy Tarreau7bb21532014-05-10 09:48:28 +0200560 else {
561 /* connect() already succeeded, which is quite usual for unix
Willy Tarreau94841792017-01-25 14:27:38 +0100562 * sockets. Let's avoid a second connect() probe to complete it.
Willy Tarreau7bb21532014-05-10 09:48:28 +0200563 */
564 conn->flags &= ~CO_FL_WAIT_L4_CONN;
Willy Tarreau7bb21532014-05-10 09:48:28 +0200565 }
Willy Tarreau47f48c42014-05-09 22:57:47 +0200566
567 conn->flags |= CO_FL_ADDR_TO_SET;
568
569 /* Prepare to send a few handshakes related to the on-wire protocol. */
570 if (conn->send_proxy_ofs)
571 conn->flags |= CO_FL_SEND_PROXY;
572
573 conn_ctrl_init(conn); /* registers the FD */
Willy Tarreau7bb21532014-05-10 09:48:28 +0200574 fdtab[fd].linger_risk = 0; /* no need to disable lingering */
Willy Tarreau47f48c42014-05-09 22:57:47 +0200575
Willy Tarreau4c69cff2020-03-04 16:38:00 +0100576 if (conn->flags & CO_FL_WAIT_L4_CONN) {
577 fd_want_send(fd);
578 fd_cant_send(fd);
579 }
Willy Tarreauccf3f6d2019-09-05 17:05:05 +0200580
Willy Tarreau47f48c42014-05-09 22:57:47 +0200581 if (conn_xprt_init(conn) < 0) {
Willy Tarreau8c829012017-10-05 18:02:11 +0200582 conn_full_close(conn);
Willy Tarreau47f48c42014-05-09 22:57:47 +0200583 conn->flags |= CO_FL_ERROR;
Willy Tarreaue7dff022015-04-03 01:14:29 +0200584 return SF_ERR_RESOURCE;
Willy Tarreau47f48c42014-05-09 22:57:47 +0200585 }
586
Willy Tarreaue7dff022015-04-03 01:14:29 +0200587 return SF_ERR_NONE; /* connection is OK */
Willy Tarreau47f48c42014-05-09 22:57:47 +0200588}
589
590
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100591/********************************
592 * 3) protocol-oriented functions
593 ********************************/
594
595
Willy Tarreau92fb9832007-10-16 17:34:28 +0200596/* This function creates all UNIX sockets bound to the protocol entry <proto>.
597 * It is intended to be used as the protocol's bind_all() function.
598 * The sockets will be registered but not added to any fd_set, in order not to
599 * loose them across the fork(). A call to uxst_enable_listeners() is needed
600 * to complete initialization.
601 *
Willy Tarreaudaacf362019-07-24 16:45:02 +0200602 * Must be called with proto_lock held.
603 *
Willy Tarreau92fb9832007-10-16 17:34:28 +0200604 * The return value is composed from ERR_NONE, ERR_RETRYABLE and ERR_FATAL.
605 */
Emeric Bruncf20bf12010-10-22 16:06:11 +0200606static int uxst_bind_listeners(struct protocol *proto, char *errmsg, int errlen)
Willy Tarreau92fb9832007-10-16 17:34:28 +0200607{
608 struct listener *listener;
609 int err = ERR_NONE;
Willy Tarreau92fb9832007-10-16 17:34:28 +0200610
611 list_for_each_entry(listener, &proto->listeners, proto_list) {
Emeric Bruncf20bf12010-10-22 16:06:11 +0200612 err |= uxst_bind_listener(listener, errmsg, errlen);
613 if (err & ERR_ABORT)
614 break;
Willy Tarreau92fb9832007-10-16 17:34:28 +0200615 }
Willy Tarreau92fb9832007-10-16 17:34:28 +0200616 return err;
617}
618
Willy Tarreau92fb9832007-10-16 17:34:28 +0200619
620/* This function stops all listening UNIX sockets bound to the protocol
621 * <proto>. It does not detaches them from the protocol.
622 * It always returns ERR_NONE.
Willy Tarreaudaacf362019-07-24 16:45:02 +0200623 *
624 * Must be called with proto_lock held.
625 *
Willy Tarreau92fb9832007-10-16 17:34:28 +0200626 */
627static int uxst_unbind_listeners(struct protocol *proto)
628{
629 struct listener *listener;
630
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100631 list_for_each_entry(listener, &proto->listeners, proto_list)
632 uxst_unbind_listener(listener);
Willy Tarreau92fb9832007-10-16 17:34:28 +0200633 return ERR_NONE;
634}
635
Willy Tarreaud0a895d2012-09-18 17:40:35 +0200636/* parse the "mode" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +0200637static int bind_parse_mode(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
Willy Tarreaud0a895d2012-09-18 17:40:35 +0200638{
Willy Tarreaua1a247b2017-10-04 14:43:44 +0200639 char *endptr;
640
641 conf->ux.mode = strtol(args[cur_arg + 1], &endptr, 8);
642
643 if (!*args[cur_arg + 1] || *endptr) {
644 memprintf(err, "'%s' : missing or invalid mode '%s' (octal integer expected)", args[cur_arg], args[cur_arg + 1]);
Willy Tarreaud0a895d2012-09-18 17:40:35 +0200645 return ERR_ALERT | ERR_FATAL;
646 }
647
Willy Tarreaud0a895d2012-09-18 17:40:35 +0200648 return 0;
649}
650
651/* parse the "gid" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +0200652static int bind_parse_gid(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
Willy Tarreaud0a895d2012-09-18 17:40:35 +0200653{
Willy Tarreaud0a895d2012-09-18 17:40:35 +0200654 if (!*args[cur_arg + 1]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200655 memprintf(err, "'%s' : missing value", args[cur_arg]);
Willy Tarreaud0a895d2012-09-18 17:40:35 +0200656 return ERR_ALERT | ERR_FATAL;
657 }
658
Willy Tarreau290e63a2012-09-20 18:07:14 +0200659 conf->ux.gid = atol(args[cur_arg + 1]);
Willy Tarreaud0a895d2012-09-18 17:40:35 +0200660 return 0;
661}
662
663/* parse the "group" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +0200664static int bind_parse_group(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
Willy Tarreaud0a895d2012-09-18 17:40:35 +0200665{
Willy Tarreaud0a895d2012-09-18 17:40:35 +0200666 struct group *group;
667
Willy Tarreaud0a895d2012-09-18 17:40:35 +0200668 if (!*args[cur_arg + 1]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200669 memprintf(err, "'%s' : missing group name", args[cur_arg]);
Willy Tarreaud0a895d2012-09-18 17:40:35 +0200670 return ERR_ALERT | ERR_FATAL;
671 }
672
673 group = getgrnam(args[cur_arg + 1]);
674 if (!group) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200675 memprintf(err, "'%s' : unknown group name '%s'", args[cur_arg], args[cur_arg + 1]);
Willy Tarreaud0a895d2012-09-18 17:40:35 +0200676 return ERR_ALERT | ERR_FATAL;
677 }
678
Willy Tarreau290e63a2012-09-20 18:07:14 +0200679 conf->ux.gid = group->gr_gid;
Willy Tarreaud0a895d2012-09-18 17:40:35 +0200680 return 0;
681}
682
683/* parse the "uid" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +0200684static int bind_parse_uid(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
Willy Tarreaud0a895d2012-09-18 17:40:35 +0200685{
Willy Tarreaud0a895d2012-09-18 17:40:35 +0200686 if (!*args[cur_arg + 1]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200687 memprintf(err, "'%s' : missing value", args[cur_arg]);
Willy Tarreaud0a895d2012-09-18 17:40:35 +0200688 return ERR_ALERT | ERR_FATAL;
689 }
690
Willy Tarreau290e63a2012-09-20 18:07:14 +0200691 conf->ux.uid = atol(args[cur_arg + 1]);
Willy Tarreaud0a895d2012-09-18 17:40:35 +0200692 return 0;
693}
694
695/* parse the "user" bind keyword */
Willy Tarreau4348fad2012-09-20 16:48:07 +0200696static int bind_parse_user(char **args, int cur_arg, struct proxy *px, struct bind_conf *conf, char **err)
Willy Tarreaud0a895d2012-09-18 17:40:35 +0200697{
Willy Tarreaud0a895d2012-09-18 17:40:35 +0200698 struct passwd *user;
699
Willy Tarreaud0a895d2012-09-18 17:40:35 +0200700 if (!*args[cur_arg + 1]) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200701 memprintf(err, "'%s' : missing user name", args[cur_arg]);
Willy Tarreaud0a895d2012-09-18 17:40:35 +0200702 return ERR_ALERT | ERR_FATAL;
703 }
704
705 user = getpwnam(args[cur_arg + 1]);
706 if (!user) {
Willy Tarreaueb6cead2012-09-20 19:43:14 +0200707 memprintf(err, "'%s' : unknown user name '%s'", args[cur_arg], args[cur_arg + 1]);
Willy Tarreaud0a895d2012-09-18 17:40:35 +0200708 return ERR_ALERT | ERR_FATAL;
709 }
710
Willy Tarreau290e63a2012-09-20 18:07:14 +0200711 conf->ux.uid = user->pw_uid;
Willy Tarreaud0a895d2012-09-18 17:40:35 +0200712 return 0;
713}
714
715/* Note: must not be declared <const> as its list will be overwritten.
716 * Please take care of keeping this list alphabetically sorted, doing so helps
717 * all code contributors.
718 * Optional keywords are also declared with a NULL ->parse() function so that
719 * the config parser can report an appropriate error when a known keyword was
720 * not enabled.
721 */
Willy Tarreau51fb7652012-09-18 18:24:39 +0200722static struct bind_kw_list bind_kws = { "UNIX", { }, {
Willy Tarreaud0a895d2012-09-18 17:40:35 +0200723 { "gid", bind_parse_gid, 1 }, /* set the socket's gid */
724 { "group", bind_parse_group, 1 }, /* set the socket's gid from the group name */
725 { "mode", bind_parse_mode, 1 }, /* set the socket's mode (eg: 0644)*/
726 { "uid", bind_parse_uid, 1 }, /* set the socket's uid */
727 { "user", bind_parse_user, 1 }, /* set the socket's uid from the user name */
728 { NULL, NULL, 0 },
729}};
Willy Tarreaudabf2e22007-10-28 21:59:24 +0100730
Willy Tarreau0108d902018-11-25 19:14:37 +0100731INITCALL1(STG_REGISTER, bind_register_keywords, &bind_kws);
Willy Tarreau92fb9832007-10-16 17:34:28 +0200732
733/*
734 * Local variables:
735 * c-indent-level: 8
736 * c-basic-offset: 8
737 * End:
738 */