]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/core/socket.c
3d04fdf7775e98d9c7b0bf43fa7d2408f217fa4f
[thirdparty/systemd.git] / src / core / socket.c
1 /* SPDX-License-Identifier: LGPL-2.1+ */
2
3 #include <arpa/inet.h>
4 #include <errno.h>
5 #include <fcntl.h>
6 #include <mqueue.h>
7 #include <netinet/tcp.h>
8 #include <signal.h>
9 #include <sys/epoll.h>
10 #include <sys/stat.h>
11 #include <unistd.h>
12 #include <linux/sctp.h>
13
14 #include "alloc-util.h"
15 #include "bpf-firewall.h"
16 #include "bus-error.h"
17 #include "bus-util.h"
18 #include "copy.h"
19 #include "dbus-socket.h"
20 #include "dbus-unit.h"
21 #include "def.h"
22 #include "exit-status.h"
23 #include "fd-util.h"
24 #include "format-util.h"
25 #include "fs-util.h"
26 #include "in-addr-util.h"
27 #include "io-util.h"
28 #include "ip-protocol-list.h"
29 #include "label.h"
30 #include "log.h"
31 #include "missing.h"
32 #include "mkdir.h"
33 #include "parse-util.h"
34 #include "path-util.h"
35 #include "process-util.h"
36 #include "selinux-util.h"
37 #include "serialize.h"
38 #include "signal-util.h"
39 #include "smack-util.h"
40 #include "socket.h"
41 #include "special.h"
42 #include "string-table.h"
43 #include "string-util.h"
44 #include "strv.h"
45 #include "unit-name.h"
46 #include "unit.h"
47 #include "user-util.h"
48
49 struct SocketPeer {
50 unsigned n_ref;
51
52 Socket *socket;
53 union sockaddr_union peer;
54 socklen_t peer_salen;
55 };
56
57 static const UnitActiveState state_translation_table[_SOCKET_STATE_MAX] = {
58 [SOCKET_DEAD] = UNIT_INACTIVE,
59 [SOCKET_START_PRE] = UNIT_ACTIVATING,
60 [SOCKET_START_CHOWN] = UNIT_ACTIVATING,
61 [SOCKET_START_POST] = UNIT_ACTIVATING,
62 [SOCKET_LISTENING] = UNIT_ACTIVE,
63 [SOCKET_RUNNING] = UNIT_ACTIVE,
64 [SOCKET_STOP_PRE] = UNIT_DEACTIVATING,
65 [SOCKET_STOP_PRE_SIGTERM] = UNIT_DEACTIVATING,
66 [SOCKET_STOP_PRE_SIGKILL] = UNIT_DEACTIVATING,
67 [SOCKET_STOP_POST] = UNIT_DEACTIVATING,
68 [SOCKET_FINAL_SIGTERM] = UNIT_DEACTIVATING,
69 [SOCKET_FINAL_SIGKILL] = UNIT_DEACTIVATING,
70 [SOCKET_FAILED] = UNIT_FAILED,
71 [SOCKET_CLEANING] = UNIT_MAINTENANCE,
72 };
73
74 static int socket_dispatch_io(sd_event_source *source, int fd, uint32_t revents, void *userdata);
75 static int socket_dispatch_timer(sd_event_source *source, usec_t usec, void *userdata);
76
77 static void socket_init(Unit *u) {
78 Socket *s = SOCKET(u);
79
80 assert(u);
81 assert(u->load_state == UNIT_STUB);
82
83 s->backlog = SOMAXCONN;
84 s->timeout_usec = u->manager->default_timeout_start_usec;
85 s->directory_mode = 0755;
86 s->socket_mode = 0666;
87
88 s->max_connections = 64;
89
90 s->priority = -1;
91 s->ip_tos = -1;
92 s->ip_ttl = -1;
93 s->mark = -1;
94
95 s->exec_context.std_output = u->manager->default_std_output;
96 s->exec_context.std_error = u->manager->default_std_error;
97
98 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
99
100 s->trigger_limit.interval = USEC_INFINITY;
101 s->trigger_limit.burst = (unsigned) -1;
102 }
103
104 static void socket_unwatch_control_pid(Socket *s) {
105 assert(s);
106
107 if (s->control_pid <= 0)
108 return;
109
110 unit_unwatch_pid(UNIT(s), s->control_pid);
111 s->control_pid = 0;
112 }
113
114 static void socket_cleanup_fd_list(SocketPort *p) {
115 assert(p);
116
117 close_many(p->auxiliary_fds, p->n_auxiliary_fds);
118 p->auxiliary_fds = mfree(p->auxiliary_fds);
119 p->n_auxiliary_fds = 0;
120 }
121
122 void socket_free_ports(Socket *s) {
123 SocketPort *p;
124
125 assert(s);
126
127 while ((p = s->ports)) {
128 LIST_REMOVE(port, s->ports, p);
129
130 sd_event_source_unref(p->event_source);
131
132 socket_cleanup_fd_list(p);
133 safe_close(p->fd);
134 free(p->path);
135 free(p);
136 }
137 }
138
139 static void socket_done(Unit *u) {
140 Socket *s = SOCKET(u);
141 SocketPeer *p;
142
143 assert(s);
144
145 socket_free_ports(s);
146
147 while ((p = set_steal_first(s->peers_by_address)))
148 p->socket = NULL;
149
150 s->peers_by_address = set_free(s->peers_by_address);
151
152 s->exec_runtime = exec_runtime_unref(s->exec_runtime, false);
153 exec_command_free_array(s->exec_command, _SOCKET_EXEC_COMMAND_MAX);
154 s->control_command = NULL;
155
156 dynamic_creds_unref(&s->dynamic_creds);
157
158 socket_unwatch_control_pid(s);
159
160 unit_ref_unset(&s->service);
161
162 s->tcp_congestion = mfree(s->tcp_congestion);
163 s->bind_to_device = mfree(s->bind_to_device);
164
165 s->smack = mfree(s->smack);
166 s->smack_ip_in = mfree(s->smack_ip_in);
167 s->smack_ip_out = mfree(s->smack_ip_out);
168
169 strv_free(s->symlinks);
170
171 s->user = mfree(s->user);
172 s->group = mfree(s->group);
173
174 s->fdname = mfree(s->fdname);
175
176 s->timer_event_source = sd_event_source_unref(s->timer_event_source);
177 }
178
179 static int socket_arm_timer(Socket *s, usec_t usec) {
180 int r;
181
182 assert(s);
183
184 if (s->timer_event_source) {
185 r = sd_event_source_set_time(s->timer_event_source, usec);
186 if (r < 0)
187 return r;
188
189 return sd_event_source_set_enabled(s->timer_event_source, SD_EVENT_ONESHOT);
190 }
191
192 if (usec == USEC_INFINITY)
193 return 0;
194
195 r = sd_event_add_time(
196 UNIT(s)->manager->event,
197 &s->timer_event_source,
198 CLOCK_MONOTONIC,
199 usec, 0,
200 socket_dispatch_timer, s);
201 if (r < 0)
202 return r;
203
204 (void) sd_event_source_set_description(s->timer_event_source, "socket-timer");
205
206 return 0;
207 }
208
209 int socket_instantiate_service(Socket *s) {
210 _cleanup_free_ char *prefix = NULL, *name = NULL;
211 int r;
212 Unit *u;
213
214 assert(s);
215
216 /* This fills in s->service if it isn't filled in yet. For
217 * Accept=yes sockets we create the next connection service
218 * here. For Accept=no this is mostly a NOP since the service
219 * is figured out at load time anyway. */
220
221 if (UNIT_DEREF(s->service))
222 return 0;
223
224 if (!s->accept)
225 return 0;
226
227 r = unit_name_to_prefix(UNIT(s)->id, &prefix);
228 if (r < 0)
229 return r;
230
231 if (asprintf(&name, "%s@%u.service", prefix, s->n_accepted) < 0)
232 return -ENOMEM;
233
234 r = manager_load_unit(UNIT(s)->manager, name, NULL, NULL, &u);
235 if (r < 0)
236 return r;
237
238 unit_ref_set(&s->service, UNIT(s), u);
239
240 return unit_add_two_dependencies(UNIT(s), UNIT_BEFORE, UNIT_TRIGGERS, u, false, UNIT_DEPENDENCY_IMPLICIT);
241 }
242
243 static bool have_non_accept_socket(Socket *s) {
244 SocketPort *p;
245
246 assert(s);
247
248 if (!s->accept)
249 return true;
250
251 LIST_FOREACH(port, p, s->ports) {
252
253 if (p->type != SOCKET_SOCKET)
254 return true;
255
256 if (!socket_address_can_accept(&p->address))
257 return true;
258 }
259
260 return false;
261 }
262
263 static int socket_add_mount_dependencies(Socket *s) {
264 SocketPort *p;
265 int r;
266
267 assert(s);
268
269 LIST_FOREACH(port, p, s->ports) {
270 const char *path = NULL;
271
272 if (p->type == SOCKET_SOCKET)
273 path = socket_address_get_path(&p->address);
274 else if (IN_SET(p->type, SOCKET_FIFO, SOCKET_SPECIAL, SOCKET_USB_FUNCTION))
275 path = p->path;
276
277 if (!path)
278 continue;
279
280 r = unit_require_mounts_for(UNIT(s), path, UNIT_DEPENDENCY_FILE);
281 if (r < 0)
282 return r;
283 }
284
285 return 0;
286 }
287
288 static int socket_add_device_dependencies(Socket *s) {
289 char *t;
290
291 assert(s);
292
293 if (!s->bind_to_device || streq(s->bind_to_device, "lo"))
294 return 0;
295
296 t = strjoina("/sys/subsystem/net/devices/", s->bind_to_device);
297 return unit_add_node_dependency(UNIT(s), t, false, UNIT_BINDS_TO, UNIT_DEPENDENCY_FILE);
298 }
299
300 static int socket_add_default_dependencies(Socket *s) {
301 int r;
302 assert(s);
303
304 if (!UNIT(s)->default_dependencies)
305 return 0;
306
307 r = unit_add_dependency_by_name(UNIT(s), UNIT_BEFORE, SPECIAL_SOCKETS_TARGET, true, UNIT_DEPENDENCY_DEFAULT);
308 if (r < 0)
309 return r;
310
311 if (MANAGER_IS_SYSTEM(UNIT(s)->manager)) {
312 r = unit_add_two_dependencies_by_name(UNIT(s), UNIT_AFTER, UNIT_REQUIRES, SPECIAL_SYSINIT_TARGET, true, UNIT_DEPENDENCY_DEFAULT);
313 if (r < 0)
314 return r;
315 }
316
317 return unit_add_two_dependencies_by_name(UNIT(s), UNIT_BEFORE, UNIT_CONFLICTS, SPECIAL_SHUTDOWN_TARGET, true, UNIT_DEPENDENCY_DEFAULT);
318 }
319
320 _pure_ static bool socket_has_exec(Socket *s) {
321 unsigned i;
322 assert(s);
323
324 for (i = 0; i < _SOCKET_EXEC_COMMAND_MAX; i++)
325 if (s->exec_command[i])
326 return true;
327
328 return false;
329 }
330
331 static int socket_add_extras(Socket *s) {
332 Unit *u = UNIT(s);
333 int r;
334
335 assert(s);
336
337 /* Pick defaults for the trigger limit, if nothing was explicitly configured. We pick a relatively high limit
338 * in Accept=yes mode, and a lower limit for Accept=no. Reason: in Accept=yes mode we are invoking accept()
339 * ourselves before the trigger limit can hit, thus incoming connections are taken off the socket queue quickly
340 * and reliably. This is different for Accept=no, where the spawned service has to take the incoming traffic
341 * off the queues, which it might not necessarily do. Moreover, while Accept=no services are supposed to
342 * process whatever is queued in one go, and thus should normally never have to be started frequently. This is
343 * different for Accept=yes where each connection is processed by a new service instance, and thus frequent
344 * service starts are typical. */
345
346 if (s->trigger_limit.interval == USEC_INFINITY)
347 s->trigger_limit.interval = 2 * USEC_PER_SEC;
348
349 if (s->trigger_limit.burst == (unsigned) -1) {
350 if (s->accept)
351 s->trigger_limit.burst = 200;
352 else
353 s->trigger_limit.burst = 20;
354 }
355
356 if (have_non_accept_socket(s)) {
357
358 if (!UNIT_DEREF(s->service)) {
359 Unit *x;
360
361 r = unit_load_related_unit(u, ".service", &x);
362 if (r < 0)
363 return r;
364
365 unit_ref_set(&s->service, u, x);
366 }
367
368 r = unit_add_two_dependencies(u, UNIT_BEFORE, UNIT_TRIGGERS, UNIT_DEREF(s->service), true, UNIT_DEPENDENCY_IMPLICIT);
369 if (r < 0)
370 return r;
371 }
372
373 r = socket_add_mount_dependencies(s);
374 if (r < 0)
375 return r;
376
377 r = socket_add_device_dependencies(s);
378 if (r < 0)
379 return r;
380
381 r = unit_patch_contexts(u);
382 if (r < 0)
383 return r;
384
385 if (socket_has_exec(s)) {
386 r = unit_add_exec_dependencies(u, &s->exec_context);
387 if (r < 0)
388 return r;
389 }
390
391 r = unit_set_default_slice(u);
392 if (r < 0)
393 return r;
394
395 r = socket_add_default_dependencies(s);
396 if (r < 0)
397 return r;
398
399 return 0;
400 }
401
402 static const char *socket_find_symlink_target(Socket *s) {
403 const char *found = NULL;
404 SocketPort *p;
405
406 LIST_FOREACH(port, p, s->ports) {
407 const char *f = NULL;
408
409 switch (p->type) {
410
411 case SOCKET_FIFO:
412 f = p->path;
413 break;
414
415 case SOCKET_SOCKET:
416 f = socket_address_get_path(&p->address);
417 break;
418
419 default:
420 break;
421 }
422
423 if (f) {
424 if (found)
425 return NULL;
426
427 found = f;
428 }
429 }
430
431 return found;
432 }
433
434 static int socket_verify(Socket *s) {
435 assert(s);
436
437 if (UNIT(s)->load_state != UNIT_LOADED)
438 return 0;
439
440 if (!s->ports) {
441 log_unit_error(UNIT(s), "Unit has no Listen setting (ListenStream=, ListenDatagram=, ListenFIFO=, ...). Refusing.");
442 return -ENOEXEC;
443 }
444
445 if (s->accept && have_non_accept_socket(s)) {
446 log_unit_error(UNIT(s), "Unit configured for accepting sockets, but sockets are non-accepting. Refusing.");
447 return -ENOEXEC;
448 }
449
450 if (s->accept && s->max_connections <= 0) {
451 log_unit_error(UNIT(s), "MaxConnection= setting too small. Refusing.");
452 return -ENOEXEC;
453 }
454
455 if (s->accept && UNIT_DEREF(s->service)) {
456 log_unit_error(UNIT(s), "Explicit service configuration for accepting socket units not supported. Refusing.");
457 return -ENOEXEC;
458 }
459
460 if (s->exec_context.pam_name && s->kill_context.kill_mode != KILL_CONTROL_GROUP) {
461 log_unit_error(UNIT(s), "Unit has PAM enabled. Kill mode must be set to 'control-group'. Refusing.");
462 return -ENOEXEC;
463 }
464
465 if (!strv_isempty(s->symlinks) && !socket_find_symlink_target(s)) {
466 log_unit_error(UNIT(s), "Unit has symlinks set but none or more than one node in the file system. Refusing.");
467 return -ENOEXEC;
468 }
469
470 return 0;
471 }
472
473 static void peer_address_hash_func(const SocketPeer *s, struct siphash *state) {
474 assert(s);
475
476 if (s->peer.sa.sa_family == AF_INET)
477 siphash24_compress(&s->peer.in.sin_addr, sizeof(s->peer.in.sin_addr), state);
478 else if (s->peer.sa.sa_family == AF_INET6)
479 siphash24_compress(&s->peer.in6.sin6_addr, sizeof(s->peer.in6.sin6_addr), state);
480 else if (s->peer.sa.sa_family == AF_VSOCK)
481 siphash24_compress(&s->peer.vm.svm_cid, sizeof(s->peer.vm.svm_cid), state);
482 else
483 assert_not_reached("Unknown address family.");
484 }
485
486 static int peer_address_compare_func(const SocketPeer *x, const SocketPeer *y) {
487 int r;
488
489 r = CMP(x->peer.sa.sa_family, y->peer.sa.sa_family);
490 if (r != 0)
491 return r;
492
493 switch(x->peer.sa.sa_family) {
494 case AF_INET:
495 return memcmp(&x->peer.in.sin_addr, &y->peer.in.sin_addr, sizeof(x->peer.in.sin_addr));
496 case AF_INET6:
497 return memcmp(&x->peer.in6.sin6_addr, &y->peer.in6.sin6_addr, sizeof(x->peer.in6.sin6_addr));
498 case AF_VSOCK:
499 return CMP(x->peer.vm.svm_cid, y->peer.vm.svm_cid);
500 }
501 assert_not_reached("Black sheep in the family!");
502 }
503
504 DEFINE_PRIVATE_HASH_OPS(peer_address_hash_ops, SocketPeer, peer_address_hash_func, peer_address_compare_func);
505
506 static int socket_load(Unit *u) {
507 Socket *s = SOCKET(u);
508 int r;
509
510 assert(u);
511 assert(u->load_state == UNIT_STUB);
512
513 r = set_ensure_allocated(&s->peers_by_address, &peer_address_hash_ops);
514 if (r < 0)
515 return r;
516
517 r = unit_load_fragment_and_dropin(u, true);
518 if (r < 0)
519 return r;
520
521 if (u->load_state == UNIT_LOADED) {
522 /* This is a new unit? Then let's add in some extras */
523 r = socket_add_extras(s);
524 if (r < 0)
525 return r;
526 }
527
528 return socket_verify(s);
529 }
530
531 static SocketPeer *socket_peer_new(void) {
532 SocketPeer *p;
533
534 p = new0(SocketPeer, 1);
535 if (!p)
536 return NULL;
537
538 p->n_ref = 1;
539
540 return p;
541 }
542
543 static SocketPeer *socket_peer_free(SocketPeer *p) {
544 assert(p);
545
546 if (p->socket)
547 set_remove(p->socket->peers_by_address, p);
548
549 return mfree(p);
550 }
551
552 DEFINE_TRIVIAL_REF_UNREF_FUNC(SocketPeer, socket_peer, socket_peer_free);
553
554 int socket_acquire_peer(Socket *s, int fd, SocketPeer **p) {
555 _cleanup_(socket_peer_unrefp) SocketPeer *remote = NULL;
556 SocketPeer sa = {}, *i;
557 socklen_t salen = sizeof(sa.peer);
558 int r;
559
560 assert(fd >= 0);
561 assert(s);
562
563 r = getpeername(fd, &sa.peer.sa, &salen);
564 if (r < 0)
565 return log_unit_error_errno(UNIT(s), errno, "getpeername failed: %m");
566
567 if (!IN_SET(sa.peer.sa.sa_family, AF_INET, AF_INET6, AF_VSOCK)) {
568 *p = NULL;
569 return 0;
570 }
571
572 i = set_get(s->peers_by_address, &sa);
573 if (i) {
574 *p = socket_peer_ref(i);
575 return 1;
576 }
577
578 remote = socket_peer_new();
579 if (!remote)
580 return log_oom();
581
582 remote->peer = sa.peer;
583 remote->peer_salen = salen;
584
585 r = set_put(s->peers_by_address, remote);
586 if (r < 0)
587 return r;
588
589 remote->socket = s;
590
591 *p = TAKE_PTR(remote);
592
593 return 1;
594 }
595
596 _const_ static const char* listen_lookup(int family, int type) {
597
598 if (family == AF_NETLINK)
599 return "ListenNetlink";
600
601 if (type == SOCK_STREAM)
602 return "ListenStream";
603 else if (type == SOCK_DGRAM)
604 return "ListenDatagram";
605 else if (type == SOCK_SEQPACKET)
606 return "ListenSequentialPacket";
607
608 assert_not_reached("Unknown socket type");
609 return NULL;
610 }
611
612 static void socket_dump(Unit *u, FILE *f, const char *prefix) {
613 char time_string[FORMAT_TIMESPAN_MAX];
614 SocketExecCommand c;
615 Socket *s = SOCKET(u);
616 SocketPort *p;
617 const char *prefix2, *str;
618
619 assert(s);
620 assert(f);
621
622 prefix = strempty(prefix);
623 prefix2 = strjoina(prefix, "\t");
624
625 fprintf(f,
626 "%sSocket State: %s\n"
627 "%sResult: %s\n"
628 "%sClean Result: %s\n"
629 "%sBindIPv6Only: %s\n"
630 "%sBacklog: %u\n"
631 "%sSocketMode: %04o\n"
632 "%sDirectoryMode: %04o\n"
633 "%sKeepAlive: %s\n"
634 "%sNoDelay: %s\n"
635 "%sFreeBind: %s\n"
636 "%sTransparent: %s\n"
637 "%sBroadcast: %s\n"
638 "%sPassCredentials: %s\n"
639 "%sPassSecurity: %s\n"
640 "%sTCPCongestion: %s\n"
641 "%sRemoveOnStop: %s\n"
642 "%sWritable: %s\n"
643 "%sFileDescriptorName: %s\n"
644 "%sSELinuxContextFromNet: %s\n",
645 prefix, socket_state_to_string(s->state),
646 prefix, socket_result_to_string(s->result),
647 prefix, socket_result_to_string(s->clean_result),
648 prefix, socket_address_bind_ipv6_only_to_string(s->bind_ipv6_only),
649 prefix, s->backlog,
650 prefix, s->socket_mode,
651 prefix, s->directory_mode,
652 prefix, yes_no(s->keep_alive),
653 prefix, yes_no(s->no_delay),
654 prefix, yes_no(s->free_bind),
655 prefix, yes_no(s->transparent),
656 prefix, yes_no(s->broadcast),
657 prefix, yes_no(s->pass_cred),
658 prefix, yes_no(s->pass_sec),
659 prefix, strna(s->tcp_congestion),
660 prefix, yes_no(s->remove_on_stop),
661 prefix, yes_no(s->writable),
662 prefix, socket_fdname(s),
663 prefix, yes_no(s->selinux_context_from_net));
664
665 if (s->control_pid > 0)
666 fprintf(f,
667 "%sControl PID: "PID_FMT"\n",
668 prefix, s->control_pid);
669
670 if (s->bind_to_device)
671 fprintf(f,
672 "%sBindToDevice: %s\n",
673 prefix, s->bind_to_device);
674
675 if (s->accept)
676 fprintf(f,
677 "%sAccepted: %u\n"
678 "%sNConnections: %u\n"
679 "%sMaxConnections: %u\n"
680 "%sMaxConnectionsPerSource: %u\n",
681 prefix, s->n_accepted,
682 prefix, s->n_connections,
683 prefix, s->max_connections,
684 prefix, s->max_connections_per_source);
685
686 if (s->priority >= 0)
687 fprintf(f,
688 "%sPriority: %i\n",
689 prefix, s->priority);
690
691 if (s->receive_buffer > 0)
692 fprintf(f,
693 "%sReceiveBuffer: %zu\n",
694 prefix, s->receive_buffer);
695
696 if (s->send_buffer > 0)
697 fprintf(f,
698 "%sSendBuffer: %zu\n",
699 prefix, s->send_buffer);
700
701 if (s->ip_tos >= 0)
702 fprintf(f,
703 "%sIPTOS: %i\n",
704 prefix, s->ip_tos);
705
706 if (s->ip_ttl >= 0)
707 fprintf(f,
708 "%sIPTTL: %i\n",
709 prefix, s->ip_ttl);
710
711 if (s->pipe_size > 0)
712 fprintf(f,
713 "%sPipeSize: %zu\n",
714 prefix, s->pipe_size);
715
716 if (s->mark >= 0)
717 fprintf(f,
718 "%sMark: %i\n",
719 prefix, s->mark);
720
721 if (s->mq_maxmsg > 0)
722 fprintf(f,
723 "%sMessageQueueMaxMessages: %li\n",
724 prefix, s->mq_maxmsg);
725
726 if (s->mq_msgsize > 0)
727 fprintf(f,
728 "%sMessageQueueMessageSize: %li\n",
729 prefix, s->mq_msgsize);
730
731 if (s->reuse_port)
732 fprintf(f,
733 "%sReusePort: %s\n",
734 prefix, yes_no(s->reuse_port));
735
736 if (s->smack)
737 fprintf(f,
738 "%sSmackLabel: %s\n",
739 prefix, s->smack);
740
741 if (s->smack_ip_in)
742 fprintf(f,
743 "%sSmackLabelIPIn: %s\n",
744 prefix, s->smack_ip_in);
745
746 if (s->smack_ip_out)
747 fprintf(f,
748 "%sSmackLabelIPOut: %s\n",
749 prefix, s->smack_ip_out);
750
751 if (!isempty(s->user) || !isempty(s->group))
752 fprintf(f,
753 "%sSocketUser: %s\n"
754 "%sSocketGroup: %s\n",
755 prefix, strna(s->user),
756 prefix, strna(s->group));
757
758 if (s->keep_alive_time > 0)
759 fprintf(f,
760 "%sKeepAliveTimeSec: %s\n",
761 prefix, format_timespan(time_string, FORMAT_TIMESPAN_MAX, s->keep_alive_time, USEC_PER_SEC));
762
763 if (s->keep_alive_interval > 0)
764 fprintf(f,
765 "%sKeepAliveIntervalSec: %s\n",
766 prefix, format_timespan(time_string, FORMAT_TIMESPAN_MAX, s->keep_alive_interval, USEC_PER_SEC));
767
768 if (s->keep_alive_cnt > 0)
769 fprintf(f,
770 "%sKeepAliveProbes: %u\n",
771 prefix, s->keep_alive_cnt);
772
773 if (s->defer_accept > 0)
774 fprintf(f,
775 "%sDeferAcceptSec: %s\n",
776 prefix, format_timespan(time_string, FORMAT_TIMESPAN_MAX, s->defer_accept, USEC_PER_SEC));
777
778 LIST_FOREACH(port, p, s->ports) {
779
780 switch (p->type) {
781 case SOCKET_SOCKET: {
782 _cleanup_free_ char *k = NULL;
783 const char *t;
784 int r;
785
786 r = socket_address_print(&p->address, &k);
787 if (r < 0)
788 t = strerror_safe(r);
789 else
790 t = k;
791
792 fprintf(f, "%s%s: %s\n", prefix, listen_lookup(socket_address_family(&p->address), p->address.type), t);
793 break;
794 }
795 case SOCKET_SPECIAL:
796 fprintf(f, "%sListenSpecial: %s\n", prefix, p->path);
797 break;
798 case SOCKET_USB_FUNCTION:
799 fprintf(f, "%sListenUSBFunction: %s\n", prefix, p->path);
800 break;
801 case SOCKET_MQUEUE:
802 fprintf(f, "%sListenMessageQueue: %s\n", prefix, p->path);
803 break;
804 default:
805 fprintf(f, "%sListenFIFO: %s\n", prefix, p->path);
806 }
807 }
808
809 fprintf(f,
810 "%sTriggerLimitIntervalSec: %s\n"
811 "%sTriggerLimitBurst: %u\n",
812 prefix, format_timespan(time_string, FORMAT_TIMESPAN_MAX, s->trigger_limit.interval, USEC_PER_SEC),
813 prefix, s->trigger_limit.burst);
814
815 str = ip_protocol_to_name(s->socket_protocol);
816 if (str)
817 fprintf(f, "%sSocketProtocol: %s\n", prefix, str);
818
819 if (!strv_isempty(s->symlinks)) {
820 char **q;
821
822 fprintf(f, "%sSymlinks:", prefix);
823 STRV_FOREACH(q, s->symlinks)
824 fprintf(f, " %s", *q);
825
826 fprintf(f, "\n");
827 }
828
829 fprintf(f,
830 "%sTimeoutSec: %s\n",
831 prefix, format_timespan(time_string, FORMAT_TIMESPAN_MAX, s->timeout_usec, USEC_PER_SEC));
832
833 exec_context_dump(&s->exec_context, f, prefix);
834 kill_context_dump(&s->kill_context, f, prefix);
835
836 for (c = 0; c < _SOCKET_EXEC_COMMAND_MAX; c++) {
837 if (!s->exec_command[c])
838 continue;
839
840 fprintf(f, "%s-> %s:\n",
841 prefix, socket_exec_command_to_string(c));
842
843 exec_command_dump_list(s->exec_command[c], f, prefix2);
844 }
845
846 cgroup_context_dump(UNIT(s), f, prefix);
847 }
848
849 static int instance_from_socket(int fd, unsigned nr, char **instance) {
850 socklen_t l;
851 char *r;
852 union sockaddr_union local, remote;
853
854 assert(fd >= 0);
855 assert(instance);
856
857 l = sizeof(local);
858 if (getsockname(fd, &local.sa, &l) < 0)
859 return -errno;
860
861 l = sizeof(remote);
862 if (getpeername(fd, &remote.sa, &l) < 0)
863 return -errno;
864
865 switch (local.sa.sa_family) {
866
867 case AF_INET: {
868 uint32_t
869 a = be32toh(local.in.sin_addr.s_addr),
870 b = be32toh(remote.in.sin_addr.s_addr);
871
872 if (asprintf(&r,
873 "%u-%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
874 nr,
875 a >> 24, (a >> 16) & 0xFF, (a >> 8) & 0xFF, a & 0xFF,
876 be16toh(local.in.sin_port),
877 b >> 24, (b >> 16) & 0xFF, (b >> 8) & 0xFF, b & 0xFF,
878 be16toh(remote.in.sin_port)) < 0)
879 return -ENOMEM;
880
881 break;
882 }
883
884 case AF_INET6: {
885 static const unsigned char ipv4_prefix[] = {
886 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xFF, 0xFF
887 };
888
889 if (memcmp(&local.in6.sin6_addr, ipv4_prefix, sizeof(ipv4_prefix)) == 0 &&
890 memcmp(&remote.in6.sin6_addr, ipv4_prefix, sizeof(ipv4_prefix)) == 0) {
891 const uint8_t
892 *a = local.in6.sin6_addr.s6_addr+12,
893 *b = remote.in6.sin6_addr.s6_addr+12;
894
895 if (asprintf(&r,
896 "%u-%u.%u.%u.%u:%u-%u.%u.%u.%u:%u",
897 nr,
898 a[0], a[1], a[2], a[3],
899 be16toh(local.in6.sin6_port),
900 b[0], b[1], b[2], b[3],
901 be16toh(remote.in6.sin6_port)) < 0)
902 return -ENOMEM;
903 } else {
904 char a[INET6_ADDRSTRLEN], b[INET6_ADDRSTRLEN];
905
906 if (asprintf(&r,
907 "%u-%s:%u-%s:%u",
908 nr,
909 inet_ntop(AF_INET6, &local.in6.sin6_addr, a, sizeof(a)),
910 be16toh(local.in6.sin6_port),
911 inet_ntop(AF_INET6, &remote.in6.sin6_addr, b, sizeof(b)),
912 be16toh(remote.in6.sin6_port)) < 0)
913 return -ENOMEM;
914 }
915
916 break;
917 }
918
919 case AF_UNIX: {
920 struct ucred ucred;
921 int k;
922
923 k = getpeercred(fd, &ucred);
924 if (k >= 0) {
925 if (asprintf(&r,
926 "%u-"PID_FMT"-"UID_FMT,
927 nr, ucred.pid, ucred.uid) < 0)
928 return -ENOMEM;
929 } else if (k == -ENODATA) {
930 /* This handles the case where somebody is
931 * connecting from another pid/uid namespace
932 * (e.g. from outside of our container). */
933 if (asprintf(&r,
934 "%u-unknown",
935 nr) < 0)
936 return -ENOMEM;
937 } else
938 return k;
939
940 break;
941 }
942
943 case AF_VSOCK:
944 if (asprintf(&r,
945 "%u-%u:%u-%u:%u",
946 nr,
947 local.vm.svm_cid, local.vm.svm_port,
948 remote.vm.svm_cid, remote.vm.svm_port) < 0)
949 return -ENOMEM;
950
951 break;
952
953 default:
954 assert_not_reached("Unhandled socket type.");
955 }
956
957 *instance = r;
958 return 0;
959 }
960
961 static void socket_close_fds(Socket *s) {
962 SocketPort *p;
963 char **i;
964
965 assert(s);
966
967 LIST_FOREACH(port, p, s->ports) {
968 bool was_open;
969
970 was_open = p->fd >= 0;
971
972 p->event_source = sd_event_source_unref(p->event_source);
973 p->fd = safe_close(p->fd);
974 socket_cleanup_fd_list(p);
975
976 /* One little note: we should normally not delete any sockets in the file system here! After all some
977 * other process we spawned might still have a reference of this fd and wants to continue to use
978 * it. Therefore we normally delete sockets in the file system before we create a new one, not after we
979 * stopped using one! That all said, if the user explicitly requested this, we'll delete them here
980 * anyway, but only then. */
981
982 if (!was_open || !s->remove_on_stop)
983 continue;
984
985 switch (p->type) {
986
987 case SOCKET_FIFO:
988 (void) unlink(p->path);
989 break;
990
991 case SOCKET_MQUEUE:
992 (void) mq_unlink(p->path);
993 break;
994
995 case SOCKET_SOCKET:
996 (void) socket_address_unlink(&p->address);
997 break;
998
999 default:
1000 break;
1001 }
1002 }
1003
1004 if (s->remove_on_stop)
1005 STRV_FOREACH(i, s->symlinks)
1006 (void) unlink(*i);
1007 }
1008
1009 static void socket_apply_socket_options(Socket *s, int fd) {
1010 int r;
1011
1012 assert(s);
1013 assert(fd >= 0);
1014
1015 if (s->keep_alive) {
1016 r = setsockopt_int(fd, SOL_SOCKET, SO_KEEPALIVE, true);
1017 if (r < 0)
1018 log_unit_warning_errno(UNIT(s), r, "SO_KEEPALIVE failed: %m");
1019 }
1020
1021 if (s->keep_alive_time > 0) {
1022 r = setsockopt_int(fd, SOL_TCP, TCP_KEEPIDLE, s->keep_alive_time / USEC_PER_SEC);
1023 if (r < 0)
1024 log_unit_warning_errno(UNIT(s), r, "TCP_KEEPIDLE failed: %m");
1025 }
1026
1027 if (s->keep_alive_interval > 0) {
1028 r = setsockopt_int(fd, SOL_TCP, TCP_KEEPINTVL, s->keep_alive_interval / USEC_PER_SEC);
1029 if (r < 0)
1030 log_unit_warning_errno(UNIT(s), r, "TCP_KEEPINTVL failed: %m");
1031 }
1032
1033 if (s->keep_alive_cnt > 0) {
1034 r = setsockopt_int(fd, SOL_TCP, TCP_KEEPCNT, s->keep_alive_cnt);
1035 if (r < 0)
1036 log_unit_warning_errno(UNIT(s), r, "TCP_KEEPCNT failed: %m");
1037 }
1038
1039 if (s->defer_accept > 0) {
1040 r = setsockopt_int(fd, SOL_TCP, TCP_DEFER_ACCEPT, s->defer_accept / USEC_PER_SEC);
1041 if (r < 0)
1042 log_unit_warning_errno(UNIT(s), r, "TCP_DEFER_ACCEPT failed: %m");
1043 }
1044
1045 if (s->no_delay) {
1046 if (s->socket_protocol == IPPROTO_SCTP) {
1047 r = setsockopt_int(fd, SOL_SCTP, SCTP_NODELAY, true);
1048 if (r < 0)
1049 log_unit_warning_errno(UNIT(s), r, "SCTP_NODELAY failed: %m");
1050 } else {
1051 r = setsockopt_int(fd, SOL_TCP, TCP_NODELAY, true);
1052 if (r < 0)
1053 log_unit_warning_errno(UNIT(s), r, "TCP_NODELAY failed: %m");
1054 }
1055 }
1056
1057 if (s->broadcast) {
1058 r = setsockopt_int(fd, SOL_SOCKET, SO_BROADCAST, true);
1059 if (r < 0)
1060 log_unit_warning_errno(UNIT(s), r, "SO_BROADCAST failed: %m");
1061 }
1062
1063 if (s->pass_cred) {
1064 r = setsockopt_int(fd, SOL_SOCKET, SO_PASSCRED, true);
1065 if (r < 0)
1066 log_unit_warning_errno(UNIT(s), r, "SO_PASSCRED failed: %m");
1067 }
1068
1069 if (s->pass_sec) {
1070 r = setsockopt_int(fd, SOL_SOCKET, SO_PASSSEC, true);
1071 if (r < 0)
1072 log_unit_warning_errno(UNIT(s), r, "SO_PASSSEC failed: %m");
1073 }
1074
1075 if (s->priority >= 0) {
1076 r = setsockopt_int(fd, SOL_SOCKET, SO_PRIORITY, s->priority);
1077 if (r < 0)
1078 log_unit_warning_errno(UNIT(s), r, "SO_PRIORITY failed: %m");
1079 }
1080
1081 if (s->receive_buffer > 0) {
1082 /* We first try with SO_RCVBUFFORCE, in case we have the perms for that */
1083 if (setsockopt_int(fd, SOL_SOCKET, SO_RCVBUFFORCE, s->receive_buffer) < 0) {
1084 r = setsockopt_int(fd, SOL_SOCKET, SO_RCVBUF, s->receive_buffer);
1085 if (r < 0)
1086 log_unit_warning_errno(UNIT(s), r, "SO_RCVBUF failed: %m");
1087 }
1088 }
1089
1090 if (s->send_buffer > 0) {
1091 if (setsockopt_int(fd, SOL_SOCKET, SO_SNDBUFFORCE, s->send_buffer) < 0) {
1092 r = setsockopt_int(fd, SOL_SOCKET, SO_SNDBUF, s->send_buffer);
1093 if (r < 0)
1094 log_unit_warning_errno(UNIT(s), r, "SO_SNDBUF failed: %m");
1095 }
1096 }
1097
1098 if (s->mark >= 0) {
1099 r = setsockopt_int(fd, SOL_SOCKET, SO_MARK, s->mark);
1100 if (r < 0)
1101 log_unit_warning_errno(UNIT(s), r, "SO_MARK failed: %m");
1102 }
1103
1104 if (s->ip_tos >= 0) {
1105 r = setsockopt_int(fd, IPPROTO_IP, IP_TOS, s->ip_tos);
1106 if (r < 0)
1107 log_unit_warning_errno(UNIT(s), r, "IP_TOS failed: %m");
1108 }
1109
1110 if (s->ip_ttl >= 0) {
1111 int x;
1112
1113 r = setsockopt_int(fd, IPPROTO_IP, IP_TTL, s->ip_ttl);
1114
1115 if (socket_ipv6_is_supported())
1116 x = setsockopt_int(fd, IPPROTO_IPV6, IPV6_UNICAST_HOPS, s->ip_ttl);
1117 else
1118 x = -EAFNOSUPPORT;
1119
1120 if (r < 0 && x < 0)
1121 log_unit_warning_errno(UNIT(s), r, "IP_TTL/IPV6_UNICAST_HOPS failed: %m");
1122 }
1123
1124 if (s->tcp_congestion)
1125 if (setsockopt(fd, SOL_TCP, TCP_CONGESTION, s->tcp_congestion, strlen(s->tcp_congestion)+1) < 0)
1126 log_unit_warning_errno(UNIT(s), errno, "TCP_CONGESTION failed: %m");
1127
1128 if (s->smack_ip_in) {
1129 r = mac_smack_apply_fd(fd, SMACK_ATTR_IPIN, s->smack_ip_in);
1130 if (r < 0)
1131 log_unit_error_errno(UNIT(s), r, "mac_smack_apply_ip_in_fd: %m");
1132 }
1133
1134 if (s->smack_ip_out) {
1135 r = mac_smack_apply_fd(fd, SMACK_ATTR_IPOUT, s->smack_ip_out);
1136 if (r < 0)
1137 log_unit_error_errno(UNIT(s), r, "mac_smack_apply_ip_out_fd: %m");
1138 }
1139 }
1140
1141 static void socket_apply_fifo_options(Socket *s, int fd) {
1142 int r;
1143
1144 assert(s);
1145 assert(fd >= 0);
1146
1147 if (s->pipe_size > 0)
1148 if (fcntl(fd, F_SETPIPE_SZ, s->pipe_size) < 0)
1149 log_unit_warning_errno(UNIT(s), errno, "Setting pipe size failed, ignoring: %m");
1150
1151 if (s->smack) {
1152 r = mac_smack_apply_fd(fd, SMACK_ATTR_ACCESS, s->smack);
1153 if (r < 0)
1154 log_unit_error_errno(UNIT(s), r, "SMACK relabelling failed, ignoring: %m");
1155 }
1156 }
1157
1158 static int fifo_address_create(
1159 const char *path,
1160 mode_t directory_mode,
1161 mode_t socket_mode) {
1162
1163 _cleanup_close_ int fd = -1;
1164 mode_t old_mask;
1165 struct stat st;
1166 int r;
1167
1168 assert(path);
1169
1170 (void) mkdir_parents_label(path, directory_mode);
1171
1172 r = mac_selinux_create_file_prepare(path, S_IFIFO);
1173 if (r < 0)
1174 return r;
1175
1176 /* Enforce the right access mode for the fifo */
1177 old_mask = umask(~socket_mode);
1178
1179 /* Include the original umask in our mask */
1180 (void) umask(~socket_mode | old_mask);
1181
1182 r = mkfifo(path, socket_mode);
1183 (void) umask(old_mask);
1184
1185 if (r < 0 && errno != EEXIST) {
1186 r = -errno;
1187 goto fail;
1188 }
1189
1190 fd = open(path, O_RDWR | O_CLOEXEC | O_NOCTTY | O_NONBLOCK | O_NOFOLLOW);
1191 if (fd < 0) {
1192 r = -errno;
1193 goto fail;
1194 }
1195
1196 mac_selinux_create_file_clear();
1197
1198 if (fstat(fd, &st) < 0) {
1199 r = -errno;
1200 goto fail;
1201 }
1202
1203 if (!S_ISFIFO(st.st_mode) ||
1204 (st.st_mode & 0777) != (socket_mode & ~old_mask) ||
1205 st.st_uid != getuid() ||
1206 st.st_gid != getgid()) {
1207 r = -EEXIST;
1208 goto fail;
1209 }
1210
1211 return TAKE_FD(fd);
1212
1213 fail:
1214 mac_selinux_create_file_clear();
1215 return r;
1216 }
1217
1218 static int special_address_create(const char *path, bool writable) {
1219 _cleanup_close_ int fd = -1;
1220 struct stat st;
1221
1222 assert(path);
1223
1224 fd = open(path, (writable ? O_RDWR : O_RDONLY)|O_CLOEXEC|O_NOCTTY|O_NONBLOCK|O_NOFOLLOW);
1225 if (fd < 0)
1226 return -errno;
1227
1228 if (fstat(fd, &st) < 0)
1229 return -errno;
1230
1231 /* Check whether this is a /proc, /sys or /dev file or char device */
1232 if (!S_ISREG(st.st_mode) && !S_ISCHR(st.st_mode))
1233 return -EEXIST;
1234
1235 return TAKE_FD(fd);
1236 }
1237
1238 static int usbffs_address_create(const char *path) {
1239 _cleanup_close_ int fd = -1;
1240 struct stat st;
1241
1242 assert(path);
1243
1244 fd = open(path, O_RDWR|O_CLOEXEC|O_NOCTTY|O_NONBLOCK|O_NOFOLLOW);
1245 if (fd < 0)
1246 return -errno;
1247
1248 if (fstat(fd, &st) < 0)
1249 return -errno;
1250
1251 /* Check whether this is a regular file (ffs endpoint) */
1252 if (!S_ISREG(st.st_mode))
1253 return -EEXIST;
1254
1255 return TAKE_FD(fd);
1256 }
1257
1258 static int mq_address_create(
1259 const char *path,
1260 mode_t mq_mode,
1261 long maxmsg,
1262 long msgsize) {
1263
1264 _cleanup_close_ int fd = -1;
1265 struct stat st;
1266 mode_t old_mask;
1267 struct mq_attr _attr, *attr = NULL;
1268
1269 assert(path);
1270
1271 if (maxmsg > 0 && msgsize > 0) {
1272 _attr = (struct mq_attr) {
1273 .mq_flags = O_NONBLOCK,
1274 .mq_maxmsg = maxmsg,
1275 .mq_msgsize = msgsize,
1276 };
1277 attr = &_attr;
1278 }
1279
1280 /* Enforce the right access mode for the mq */
1281 old_mask = umask(~mq_mode);
1282
1283 /* Include the original umask in our mask */
1284 (void) umask(~mq_mode | old_mask);
1285 fd = mq_open(path, O_RDONLY|O_CLOEXEC|O_NONBLOCK|O_CREAT, mq_mode, attr);
1286 (void) umask(old_mask);
1287
1288 if (fd < 0)
1289 return -errno;
1290
1291 if (fstat(fd, &st) < 0)
1292 return -errno;
1293
1294 if ((st.st_mode & 0777) != (mq_mode & ~old_mask) ||
1295 st.st_uid != getuid() ||
1296 st.st_gid != getgid())
1297 return -EEXIST;
1298
1299 return TAKE_FD(fd);
1300 }
1301
1302 static int socket_symlink(Socket *s) {
1303 const char *p;
1304 char **i;
1305 int r;
1306
1307 assert(s);
1308
1309 p = socket_find_symlink_target(s);
1310 if (!p)
1311 return 0;
1312
1313 STRV_FOREACH(i, s->symlinks) {
1314 (void) mkdir_parents_label(*i, s->directory_mode);
1315
1316 r = symlink_idempotent(p, *i, false);
1317
1318 if (r == -EEXIST && s->remove_on_stop) {
1319 /* If there's already something where we want to create the symlink, and the destructive
1320 * RemoveOnStop= mode is set, then we might as well try to remove what already exists and try
1321 * again. */
1322
1323 if (unlink(*i) >= 0)
1324 r = symlink_idempotent(p, *i, false);
1325 }
1326
1327 if (r < 0)
1328 log_unit_warning_errno(UNIT(s), r, "Failed to create symlink %s → %s, ignoring: %m", p, *i);
1329 }
1330
1331 return 0;
1332 }
1333
1334 static int usbffs_write_descs(int fd, Service *s) {
1335 int r;
1336
1337 if (!s->usb_function_descriptors || !s->usb_function_strings)
1338 return -EINVAL;
1339
1340 r = copy_file_fd(s->usb_function_descriptors, fd, 0);
1341 if (r < 0)
1342 return r;
1343
1344 return copy_file_fd(s->usb_function_strings, fd, 0);
1345 }
1346
1347 static int usbffs_select_ep(const struct dirent *d) {
1348 return d->d_name[0] != '.' && !streq(d->d_name, "ep0");
1349 }
1350
1351 static int usbffs_dispatch_eps(SocketPort *p) {
1352 _cleanup_free_ struct dirent **ent = NULL;
1353 size_t n, k, i;
1354 int r;
1355
1356 r = scandir(p->path, &ent, usbffs_select_ep, alphasort);
1357 if (r < 0)
1358 return -errno;
1359
1360 n = (size_t) r;
1361 p->auxiliary_fds = new(int, n);
1362 if (!p->auxiliary_fds) {
1363 r = -ENOMEM;
1364 goto clear;
1365 }
1366
1367 p->n_auxiliary_fds = n;
1368
1369 k = 0;
1370 for (i = 0; i < n; ++i) {
1371 _cleanup_free_ char *ep = NULL;
1372
1373 ep = path_make_absolute(ent[i]->d_name, p->path);
1374 if (!ep) {
1375 r = -ENOMEM;
1376 goto fail;
1377 }
1378
1379 path_simplify(ep, false);
1380
1381 r = usbffs_address_create(ep);
1382 if (r < 0)
1383 goto fail;
1384
1385 p->auxiliary_fds[k++] = r;
1386 }
1387
1388 r = 0;
1389 goto clear;
1390
1391 fail:
1392 close_many(p->auxiliary_fds, k);
1393 p->auxiliary_fds = mfree(p->auxiliary_fds);
1394 p->n_auxiliary_fds = 0;
1395
1396 clear:
1397 for (i = 0; i < n; ++i)
1398 free(ent[i]);
1399
1400 return r;
1401 }
1402
1403 static int socket_determine_selinux_label(Socket *s, char **ret) {
1404 Service *service;
1405 ExecCommand *c;
1406 _cleanup_free_ char *path = NULL;
1407 int r;
1408
1409 assert(s);
1410 assert(ret);
1411
1412 if (s->selinux_context_from_net) {
1413 /* If this is requested, get label from the network label */
1414
1415 r = mac_selinux_get_our_label(ret);
1416 if (r == -EOPNOTSUPP)
1417 goto no_label;
1418
1419 } else {
1420 /* Otherwise, get it from the executable we are about to start */
1421 r = socket_instantiate_service(s);
1422 if (r < 0)
1423 return r;
1424
1425 if (!UNIT_ISSET(s->service))
1426 goto no_label;
1427
1428 service = SERVICE(UNIT_DEREF(s->service));
1429 c = service->exec_command[SERVICE_EXEC_START];
1430 if (!c)
1431 goto no_label;
1432
1433 r = chase_symlinks(c->path, service->exec_context.root_directory, CHASE_PREFIX_ROOT, &path);
1434 if (r < 0)
1435 goto no_label;
1436
1437 r = mac_selinux_get_create_label_from_exe(path, ret);
1438 if (IN_SET(r, -EPERM, -EOPNOTSUPP))
1439 goto no_label;
1440 }
1441
1442 return r;
1443
1444 no_label:
1445 *ret = NULL;
1446 return 0;
1447 }
1448
1449 static int socket_address_listen_do(
1450 Socket *s,
1451 const SocketAddress *address,
1452 const char *label) {
1453
1454 assert(s);
1455 assert(address);
1456
1457 return socket_address_listen(
1458 address,
1459 SOCK_CLOEXEC|SOCK_NONBLOCK,
1460 s->backlog,
1461 s->bind_ipv6_only,
1462 s->bind_to_device,
1463 s->reuse_port,
1464 s->free_bind,
1465 s->transparent,
1466 s->directory_mode,
1467 s->socket_mode,
1468 label);
1469 }
1470
1471 #define log_address_error_errno(u, address, error, fmt) \
1472 ({ \
1473 _cleanup_free_ char *_t = NULL; \
1474 \
1475 (void) socket_address_print(address, &_t); \
1476 log_unit_error_errno(u, error, fmt, strna(_t)); \
1477 })
1478
1479 static int fork_needed(const SocketAddress *address, const ExecContext *context) {
1480 int r;
1481
1482 assert(address);
1483 assert(context);
1484
1485 /* Check if we need to do the cgroup or netns stuff. If not we can do things much simpler. */
1486
1487 if (IN_SET(address->sockaddr.sa.sa_family, AF_INET, AF_INET6)) {
1488 r = bpf_firewall_supported();
1489 if (r < 0)
1490 return r;
1491 if (r != BPF_FIREWALL_UNSUPPORTED) /* If BPF firewalling isn't supported anyway — there's no point in this forking complexity */
1492 return true;
1493 }
1494
1495 return context->private_network || context->network_namespace_path;
1496 }
1497
1498 static int socket_address_listen_in_cgroup(
1499 Socket *s,
1500 const SocketAddress *address,
1501 const char *label) {
1502
1503 _cleanup_close_pair_ int pair[2] = { -1, -1 };
1504 int fd, r;
1505 pid_t pid;
1506
1507 assert(s);
1508 assert(address);
1509
1510 /* This is a wrapper around socket_address_listen(), that forks off a helper process inside the
1511 * socket's cgroup and network namespace in which the socket is actually created. This way we ensure
1512 * the socket is actually properly attached to the unit's cgroup for the purpose of BPF filtering and
1513 * such. */
1514
1515 r = fork_needed(address, &s->exec_context);
1516 if (r < 0)
1517 return r;
1518 if (r == 0) {
1519 /* Shortcut things... */
1520 fd = socket_address_listen_do(s, address, label);
1521 if (fd < 0)
1522 return log_address_error_errno(UNIT(s), address, fd, "Failed to create listening socket (%s): %m");
1523
1524 return fd;
1525 }
1526
1527 r = unit_setup_exec_runtime(UNIT(s));
1528 if (r < 0)
1529 return log_unit_error_errno(UNIT(s), r, "Failed acquire runtime: %m");
1530
1531 if (s->exec_context.network_namespace_path &&
1532 s->exec_runtime &&
1533 s->exec_runtime->netns_storage_socket[0] >= 0) {
1534 r = open_netns_path(s->exec_runtime->netns_storage_socket, s->exec_context.network_namespace_path);
1535 if (r < 0)
1536 return log_unit_error_errno(UNIT(s), r, "Failed to open network namespace path %s: %m", s->exec_context.network_namespace_path);
1537 }
1538
1539 if (socketpair(AF_UNIX, SOCK_SEQPACKET|SOCK_CLOEXEC, 0, pair) < 0)
1540 return log_unit_error_errno(UNIT(s), errno, "Failed to create communication channel: %m");
1541
1542 r = unit_fork_helper_process(UNIT(s), "(sd-listen)", &pid);
1543 if (r < 0)
1544 return log_unit_error_errno(UNIT(s), r, "Failed to fork off listener stub process: %m");
1545 if (r == 0) {
1546 /* Child */
1547
1548 pair[0] = safe_close(pair[0]);
1549
1550 if ((s->exec_context.private_network || s->exec_context.network_namespace_path) &&
1551 s->exec_runtime &&
1552 s->exec_runtime->netns_storage_socket[0] >= 0) {
1553
1554 if (ns_type_supported(NAMESPACE_NET)) {
1555 r = setup_netns(s->exec_runtime->netns_storage_socket);
1556 if (r < 0) {
1557 log_unit_error_errno(UNIT(s), r, "Failed to join network namespace: %m");
1558 _exit(EXIT_NETWORK);
1559 }
1560 } else if (s->exec_context.network_namespace_path) {
1561 log_unit_error(UNIT(s), "Network namespace path configured but network namespaces not supported.");
1562 _exit(EXIT_NETWORK);
1563 } else
1564 log_unit_warning(UNIT(s), "PrivateNetwork=yes is configured, but the kernel does not support network namespaces, ignoring.");
1565 }
1566
1567 fd = socket_address_listen_do(s, address, label);
1568 if (fd < 0) {
1569 log_address_error_errno(UNIT(s), address, fd, "Failed to create listening socket (%s): %m");
1570 _exit(EXIT_FAILURE);
1571 }
1572
1573 r = send_one_fd(pair[1], fd, 0);
1574 if (r < 0) {
1575 log_address_error_errno(UNIT(s), address, r, "Failed to send listening socket (%s) to parent: %m");
1576 _exit(EXIT_FAILURE);
1577 }
1578
1579 _exit(EXIT_SUCCESS);
1580 }
1581
1582 pair[1] = safe_close(pair[1]);
1583 fd = receive_one_fd(pair[0], 0);
1584
1585 /* We synchronously wait for the helper, as it shouldn't be slow */
1586 r = wait_for_terminate_and_check("(sd-listen)", pid, WAIT_LOG_ABNORMAL);
1587 if (r < 0) {
1588 safe_close(fd);
1589 return r;
1590 }
1591
1592 if (fd < 0)
1593 return log_address_error_errno(UNIT(s), address, fd, "Failed to receive listening socket (%s): %m");
1594
1595 return fd;
1596 }
1597
1598 DEFINE_TRIVIAL_CLEANUP_FUNC(Socket *, socket_close_fds);
1599
1600 static int socket_open_fds(Socket *_s) {
1601 _cleanup_(socket_close_fdsp) Socket *s = _s;
1602 _cleanup_(mac_selinux_freep) char *label = NULL;
1603 bool know_label = false;
1604 SocketPort *p;
1605 int r;
1606
1607 assert(s);
1608
1609 LIST_FOREACH(port, p, s->ports) {
1610
1611 if (p->fd >= 0)
1612 continue;
1613
1614 switch (p->type) {
1615
1616 case SOCKET_SOCKET:
1617
1618 if (!know_label) {
1619 /* Figure out label, if we don't it know yet. We do it once, for the first socket where
1620 * we need this and remember it for the rest. */
1621
1622 r = socket_determine_selinux_label(s, &label);
1623 if (r < 0)
1624 return log_unit_error_errno(UNIT(s), r, "Failed to determine SELinux label: %m");
1625
1626 know_label = true;
1627 }
1628
1629 /* Apply the socket protocol */
1630 switch (p->address.type) {
1631
1632 case SOCK_STREAM:
1633 case SOCK_SEQPACKET:
1634 if (s->socket_protocol == IPPROTO_SCTP)
1635 p->address.protocol = s->socket_protocol;
1636 break;
1637
1638 case SOCK_DGRAM:
1639 if (s->socket_protocol == IPPROTO_UDPLITE)
1640 p->address.protocol = s->socket_protocol;
1641 break;
1642 }
1643
1644 p->fd = socket_address_listen_in_cgroup(s, &p->address, label);
1645 if (p->fd < 0)
1646 return p->fd;
1647
1648 socket_apply_socket_options(s, p->fd);
1649 socket_symlink(s);
1650 break;
1651
1652 case SOCKET_SPECIAL:
1653
1654 p->fd = special_address_create(p->path, s->writable);
1655 if (p->fd < 0)
1656 return log_unit_error_errno(UNIT(s), p->fd, "Failed to open special file %s: %m", p->path);
1657 break;
1658
1659 case SOCKET_FIFO:
1660
1661 p->fd = fifo_address_create(
1662 p->path,
1663 s->directory_mode,
1664 s->socket_mode);
1665 if (p->fd < 0)
1666 return log_unit_error_errno(UNIT(s), p->fd, "Failed to open FIFO %s: %m", p->path);
1667
1668 socket_apply_fifo_options(s, p->fd);
1669 socket_symlink(s);
1670 break;
1671
1672 case SOCKET_MQUEUE:
1673
1674 p->fd = mq_address_create(
1675 p->path,
1676 s->socket_mode,
1677 s->mq_maxmsg,
1678 s->mq_msgsize);
1679 if (p->fd < 0)
1680 return log_unit_error_errno(UNIT(s), p->fd, "Failed to open message queue %s: %m", p->path);
1681 break;
1682
1683 case SOCKET_USB_FUNCTION: {
1684 _cleanup_free_ char *ep = NULL;
1685
1686 ep = path_make_absolute("ep0", p->path);
1687
1688 p->fd = usbffs_address_create(ep);
1689 if (p->fd < 0)
1690 return p->fd;
1691
1692 r = usbffs_write_descs(p->fd, SERVICE(UNIT_DEREF(s->service)));
1693 if (r < 0)
1694 return r;
1695
1696 r = usbffs_dispatch_eps(p);
1697 if (r < 0)
1698 return r;
1699
1700 break;
1701 }
1702 default:
1703 assert_not_reached("Unknown port type");
1704 }
1705 }
1706
1707 s = NULL;
1708 return 0;
1709 }
1710
1711 static void socket_unwatch_fds(Socket *s) {
1712 SocketPort *p;
1713 int r;
1714
1715 assert(s);
1716
1717 LIST_FOREACH(port, p, s->ports) {
1718 if (p->fd < 0)
1719 continue;
1720
1721 if (!p->event_source)
1722 continue;
1723
1724 r = sd_event_source_set_enabled(p->event_source, SD_EVENT_OFF);
1725 if (r < 0)
1726 log_unit_debug_errno(UNIT(s), r, "Failed to disable event source: %m");
1727 }
1728 }
1729
1730 static int socket_watch_fds(Socket *s) {
1731 SocketPort *p;
1732 int r;
1733
1734 assert(s);
1735
1736 LIST_FOREACH(port, p, s->ports) {
1737 if (p->fd < 0)
1738 continue;
1739
1740 if (p->event_source) {
1741 r = sd_event_source_set_enabled(p->event_source, SD_EVENT_ON);
1742 if (r < 0)
1743 goto fail;
1744 } else {
1745 r = sd_event_add_io(UNIT(s)->manager->event, &p->event_source, p->fd, EPOLLIN, socket_dispatch_io, p);
1746 if (r < 0)
1747 goto fail;
1748
1749 (void) sd_event_source_set_description(p->event_source, "socket-port-io");
1750 }
1751 }
1752
1753 return 0;
1754
1755 fail:
1756 log_unit_warning_errno(UNIT(s), r, "Failed to watch listening fds: %m");
1757 socket_unwatch_fds(s);
1758 return r;
1759 }
1760
1761 enum {
1762 SOCKET_OPEN_NONE,
1763 SOCKET_OPEN_SOME,
1764 SOCKET_OPEN_ALL,
1765 };
1766
1767 static int socket_check_open(Socket *s) {
1768 bool have_open = false, have_closed = false;
1769 SocketPort *p;
1770
1771 assert(s);
1772
1773 LIST_FOREACH(port, p, s->ports) {
1774 if (p->fd < 0)
1775 have_closed = true;
1776 else
1777 have_open = true;
1778
1779 if (have_open && have_closed)
1780 return SOCKET_OPEN_SOME;
1781 }
1782
1783 if (have_open)
1784 return SOCKET_OPEN_ALL;
1785
1786 return SOCKET_OPEN_NONE;
1787 }
1788
1789 static void socket_set_state(Socket *s, SocketState state) {
1790 SocketState old_state;
1791 assert(s);
1792
1793 if (s->state != state)
1794 bus_unit_send_pending_change_signal(UNIT(s), false);
1795
1796 old_state = s->state;
1797 s->state = state;
1798
1799 if (!IN_SET(state,
1800 SOCKET_START_PRE,
1801 SOCKET_START_CHOWN,
1802 SOCKET_START_POST,
1803 SOCKET_STOP_PRE,
1804 SOCKET_STOP_PRE_SIGTERM,
1805 SOCKET_STOP_PRE_SIGKILL,
1806 SOCKET_STOP_POST,
1807 SOCKET_FINAL_SIGTERM,
1808 SOCKET_FINAL_SIGKILL,
1809 SOCKET_CLEANING)) {
1810
1811 s->timer_event_source = sd_event_source_unref(s->timer_event_source);
1812 socket_unwatch_control_pid(s);
1813 s->control_command = NULL;
1814 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
1815 }
1816
1817 if (state != SOCKET_LISTENING)
1818 socket_unwatch_fds(s);
1819
1820 if (!IN_SET(state,
1821 SOCKET_START_CHOWN,
1822 SOCKET_START_POST,
1823 SOCKET_LISTENING,
1824 SOCKET_RUNNING,
1825 SOCKET_STOP_PRE,
1826 SOCKET_STOP_PRE_SIGTERM,
1827 SOCKET_STOP_PRE_SIGKILL,
1828 SOCKET_CLEANING))
1829 socket_close_fds(s);
1830
1831 if (state != old_state)
1832 log_unit_debug(UNIT(s), "Changed %s -> %s", socket_state_to_string(old_state), socket_state_to_string(state));
1833
1834 unit_notify(UNIT(s), state_translation_table[old_state], state_translation_table[state], 0);
1835 }
1836
1837 static int socket_coldplug(Unit *u) {
1838 Socket *s = SOCKET(u);
1839 int r;
1840
1841 assert(s);
1842 assert(s->state == SOCKET_DEAD);
1843
1844 if (s->deserialized_state == s->state)
1845 return 0;
1846
1847 if (s->control_pid > 0 &&
1848 pid_is_unwaited(s->control_pid) &&
1849 IN_SET(s->deserialized_state,
1850 SOCKET_START_PRE,
1851 SOCKET_START_CHOWN,
1852 SOCKET_START_POST,
1853 SOCKET_STOP_PRE,
1854 SOCKET_STOP_PRE_SIGTERM,
1855 SOCKET_STOP_PRE_SIGKILL,
1856 SOCKET_STOP_POST,
1857 SOCKET_FINAL_SIGTERM,
1858 SOCKET_FINAL_SIGKILL,
1859 SOCKET_CLEANING)) {
1860
1861 r = unit_watch_pid(UNIT(s), s->control_pid, false);
1862 if (r < 0)
1863 return r;
1864
1865 r = socket_arm_timer(s, usec_add(u->state_change_timestamp.monotonic, s->timeout_usec));
1866 if (r < 0)
1867 return r;
1868 }
1869
1870 if (IN_SET(s->deserialized_state,
1871 SOCKET_START_CHOWN,
1872 SOCKET_START_POST,
1873 SOCKET_LISTENING,
1874 SOCKET_RUNNING)) {
1875
1876 /* Originally, we used to simply reopen all sockets here that we didn't have file descriptors
1877 * for. However, this is problematic, as we won't traverse through the SOCKET_START_CHOWN state for
1878 * them, and thus the UID/GID wouldn't be right. Hence, instead simply check if we have all fds open,
1879 * and if there's a mismatch, warn loudly. */
1880
1881 r = socket_check_open(s);
1882 if (r == SOCKET_OPEN_NONE)
1883 log_unit_warning(UNIT(s),
1884 "Socket unit configuration has changed while unit has been running, "
1885 "no open socket file descriptor left. "
1886 "The socket unit is not functional until restarted.");
1887 else if (r == SOCKET_OPEN_SOME)
1888 log_unit_warning(UNIT(s),
1889 "Socket unit configuration has changed while unit has been running, "
1890 "and some socket file descriptors have not been opened yet. "
1891 "The socket unit is not fully functional until restarted.");
1892 }
1893
1894 if (s->deserialized_state == SOCKET_LISTENING) {
1895 r = socket_watch_fds(s);
1896 if (r < 0)
1897 return r;
1898 }
1899
1900 if (!IN_SET(s->deserialized_state, SOCKET_DEAD, SOCKET_FAILED, SOCKET_CLEANING)) {
1901 (void) unit_setup_dynamic_creds(u);
1902 (void) unit_setup_exec_runtime(u);
1903 }
1904
1905 socket_set_state(s, s->deserialized_state);
1906 return 0;
1907 }
1908
1909 static int socket_spawn(Socket *s, ExecCommand *c, pid_t *_pid) {
1910
1911 _cleanup_(exec_params_clear) ExecParameters exec_params = {
1912 .flags = EXEC_APPLY_SANDBOXING|EXEC_APPLY_CHROOT|EXEC_APPLY_TTY_STDIN,
1913 .stdin_fd = -1,
1914 .stdout_fd = -1,
1915 .stderr_fd = -1,
1916 .exec_fd = -1,
1917 };
1918 pid_t pid;
1919 int r;
1920
1921 assert(s);
1922 assert(c);
1923 assert(_pid);
1924
1925 r = unit_prepare_exec(UNIT(s));
1926 if (r < 0)
1927 return r;
1928
1929 r = socket_arm_timer(s, usec_add(now(CLOCK_MONOTONIC), s->timeout_usec));
1930 if (r < 0)
1931 return r;
1932
1933 r = unit_set_exec_params(UNIT(s), &exec_params);
1934 if (r < 0)
1935 return r;
1936
1937 r = exec_spawn(UNIT(s),
1938 c,
1939 &s->exec_context,
1940 &exec_params,
1941 s->exec_runtime,
1942 &s->dynamic_creds,
1943 &pid);
1944 if (r < 0)
1945 return r;
1946
1947 r = unit_watch_pid(UNIT(s), pid, true);
1948 if (r < 0)
1949 return r;
1950
1951 *_pid = pid;
1952
1953 return 0;
1954 }
1955
1956 static int socket_chown(Socket *s, pid_t *_pid) {
1957 pid_t pid;
1958 int r;
1959
1960 r = socket_arm_timer(s, usec_add(now(CLOCK_MONOTONIC), s->timeout_usec));
1961 if (r < 0)
1962 goto fail;
1963
1964 /* We have to resolve the user names out-of-process, hence
1965 * let's fork here. It's messy, but well, what can we do? */
1966
1967 r = unit_fork_helper_process(UNIT(s), "(sd-chown)", &pid);
1968 if (r < 0)
1969 return r;
1970 if (r == 0) {
1971 uid_t uid = UID_INVALID;
1972 gid_t gid = GID_INVALID;
1973 SocketPort *p;
1974
1975 /* Child */
1976
1977 if (!isempty(s->user)) {
1978 const char *user = s->user;
1979
1980 r = get_user_creds(&user, &uid, &gid, NULL, NULL, 0);
1981 if (r < 0) {
1982 log_unit_error_errno(UNIT(s), r, "Failed to resolve user %s: %m", user);
1983 _exit(EXIT_USER);
1984 }
1985 }
1986
1987 if (!isempty(s->group)) {
1988 const char *group = s->group;
1989
1990 r = get_group_creds(&group, &gid, 0);
1991 if (r < 0) {
1992 log_unit_error_errno(UNIT(s), r, "Failed to resolve group %s: %m", group);
1993 _exit(EXIT_GROUP);
1994 }
1995 }
1996
1997 LIST_FOREACH(port, p, s->ports) {
1998 const char *path = NULL;
1999
2000 if (p->type == SOCKET_SOCKET)
2001 path = socket_address_get_path(&p->address);
2002 else if (p->type == SOCKET_FIFO)
2003 path = p->path;
2004
2005 if (!path)
2006 continue;
2007
2008 if (chown(path, uid, gid) < 0) {
2009 log_unit_error_errno(UNIT(s), errno, "Failed to chown(): %m");
2010 _exit(EXIT_CHOWN);
2011 }
2012 }
2013
2014 _exit(EXIT_SUCCESS);
2015 }
2016
2017 r = unit_watch_pid(UNIT(s), pid, true);
2018 if (r < 0)
2019 goto fail;
2020
2021 *_pid = pid;
2022 return 0;
2023
2024 fail:
2025 s->timer_event_source = sd_event_source_unref(s->timer_event_source);
2026 return r;
2027 }
2028
2029 static void socket_enter_dead(Socket *s, SocketResult f) {
2030 assert(s);
2031
2032 if (s->result == SOCKET_SUCCESS)
2033 s->result = f;
2034
2035 if (s->result == SOCKET_SUCCESS)
2036 unit_log_success(UNIT(s));
2037 else
2038 unit_log_failure(UNIT(s), socket_result_to_string(s->result));
2039
2040 socket_set_state(s, s->result != SOCKET_SUCCESS ? SOCKET_FAILED : SOCKET_DEAD);
2041
2042 s->exec_runtime = exec_runtime_unref(s->exec_runtime, true);
2043
2044 unit_destroy_runtime_directory(UNIT(s), &s->exec_context);
2045
2046 unit_unref_uid_gid(UNIT(s), true);
2047
2048 dynamic_creds_destroy(&s->dynamic_creds);
2049 }
2050
2051 static void socket_enter_signal(Socket *s, SocketState state, SocketResult f);
2052
2053 static void socket_enter_stop_post(Socket *s, SocketResult f) {
2054 int r;
2055 assert(s);
2056
2057 if (s->result == SOCKET_SUCCESS)
2058 s->result = f;
2059
2060 socket_unwatch_control_pid(s);
2061 s->control_command_id = SOCKET_EXEC_STOP_POST;
2062 s->control_command = s->exec_command[SOCKET_EXEC_STOP_POST];
2063
2064 if (s->control_command) {
2065 r = socket_spawn(s, s->control_command, &s->control_pid);
2066 if (r < 0)
2067 goto fail;
2068
2069 socket_set_state(s, SOCKET_STOP_POST);
2070 } else
2071 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, SOCKET_SUCCESS);
2072
2073 return;
2074
2075 fail:
2076 log_unit_warning_errno(UNIT(s), r, "Failed to run 'stop-post' task: %m");
2077 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, SOCKET_FAILURE_RESOURCES);
2078 }
2079
2080 static int state_to_kill_operation(Socket *s, SocketState state) {
2081 if (state == SOCKET_STOP_PRE_SIGTERM && unit_has_job_type(UNIT(s), JOB_RESTART))
2082 return KILL_RESTART;
2083
2084 if (state == SOCKET_FINAL_SIGTERM)
2085 return KILL_TERMINATE;
2086
2087 return KILL_KILL;
2088 }
2089
2090 static void socket_enter_signal(Socket *s, SocketState state, SocketResult f) {
2091 int r;
2092
2093 assert(s);
2094
2095 if (s->result == SOCKET_SUCCESS)
2096 s->result = f;
2097
2098 r = unit_kill_context(
2099 UNIT(s),
2100 &s->kill_context,
2101 state_to_kill_operation(s, state),
2102 -1,
2103 s->control_pid,
2104 false);
2105 if (r < 0)
2106 goto fail;
2107
2108 if (r > 0) {
2109 r = socket_arm_timer(s, usec_add(now(CLOCK_MONOTONIC), s->timeout_usec));
2110 if (r < 0)
2111 goto fail;
2112
2113 socket_set_state(s, state);
2114 } else if (state == SOCKET_STOP_PRE_SIGTERM)
2115 socket_enter_signal(s, SOCKET_STOP_PRE_SIGKILL, SOCKET_SUCCESS);
2116 else if (state == SOCKET_STOP_PRE_SIGKILL)
2117 socket_enter_stop_post(s, SOCKET_SUCCESS);
2118 else if (state == SOCKET_FINAL_SIGTERM)
2119 socket_enter_signal(s, SOCKET_FINAL_SIGKILL, SOCKET_SUCCESS);
2120 else
2121 socket_enter_dead(s, SOCKET_SUCCESS);
2122
2123 return;
2124
2125 fail:
2126 log_unit_warning_errno(UNIT(s), r, "Failed to kill processes: %m");
2127
2128 if (IN_SET(state, SOCKET_STOP_PRE_SIGTERM, SOCKET_STOP_PRE_SIGKILL))
2129 socket_enter_stop_post(s, SOCKET_FAILURE_RESOURCES);
2130 else
2131 socket_enter_dead(s, SOCKET_FAILURE_RESOURCES);
2132 }
2133
2134 static void socket_enter_stop_pre(Socket *s, SocketResult f) {
2135 int r;
2136 assert(s);
2137
2138 if (s->result == SOCKET_SUCCESS)
2139 s->result = f;
2140
2141 socket_unwatch_control_pid(s);
2142 s->control_command_id = SOCKET_EXEC_STOP_PRE;
2143 s->control_command = s->exec_command[SOCKET_EXEC_STOP_PRE];
2144
2145 if (s->control_command) {
2146 r = socket_spawn(s, s->control_command, &s->control_pid);
2147 if (r < 0)
2148 goto fail;
2149
2150 socket_set_state(s, SOCKET_STOP_PRE);
2151 } else
2152 socket_enter_stop_post(s, SOCKET_SUCCESS);
2153
2154 return;
2155
2156 fail:
2157 log_unit_warning_errno(UNIT(s), r, "Failed to run 'stop-pre' task: %m");
2158 socket_enter_stop_post(s, SOCKET_FAILURE_RESOURCES);
2159 }
2160
2161 static void socket_enter_listening(Socket *s) {
2162 int r;
2163 assert(s);
2164
2165 r = socket_watch_fds(s);
2166 if (r < 0) {
2167 log_unit_warning_errno(UNIT(s), r, "Failed to watch sockets: %m");
2168 goto fail;
2169 }
2170
2171 socket_set_state(s, SOCKET_LISTENING);
2172 return;
2173
2174 fail:
2175 socket_enter_stop_pre(s, SOCKET_FAILURE_RESOURCES);
2176 }
2177
2178 static void socket_enter_start_post(Socket *s) {
2179 int r;
2180 assert(s);
2181
2182 socket_unwatch_control_pid(s);
2183 s->control_command_id = SOCKET_EXEC_START_POST;
2184 s->control_command = s->exec_command[SOCKET_EXEC_START_POST];
2185
2186 if (s->control_command) {
2187 r = socket_spawn(s, s->control_command, &s->control_pid);
2188 if (r < 0) {
2189 log_unit_warning_errno(UNIT(s), r, "Failed to run 'start-post' task: %m");
2190 goto fail;
2191 }
2192
2193 socket_set_state(s, SOCKET_START_POST);
2194 } else
2195 socket_enter_listening(s);
2196
2197 return;
2198
2199 fail:
2200 socket_enter_stop_pre(s, SOCKET_FAILURE_RESOURCES);
2201 }
2202
2203 static void socket_enter_start_chown(Socket *s) {
2204 int r;
2205
2206 assert(s);
2207
2208 r = socket_open_fds(s);
2209 if (r < 0) {
2210 log_unit_warning_errno(UNIT(s), r, "Failed to listen on sockets: %m");
2211 goto fail;
2212 }
2213
2214 if (!isempty(s->user) || !isempty(s->group)) {
2215
2216 socket_unwatch_control_pid(s);
2217 s->control_command_id = SOCKET_EXEC_START_CHOWN;
2218 s->control_command = NULL;
2219
2220 r = socket_chown(s, &s->control_pid);
2221 if (r < 0) {
2222 log_unit_warning_errno(UNIT(s), r, "Failed to fork 'start-chown' task: %m");
2223 goto fail;
2224 }
2225
2226 socket_set_state(s, SOCKET_START_CHOWN);
2227 } else
2228 socket_enter_start_post(s);
2229
2230 return;
2231
2232 fail:
2233 socket_enter_stop_pre(s, SOCKET_FAILURE_RESOURCES);
2234 }
2235
2236 static void socket_enter_start_pre(Socket *s) {
2237 int r;
2238 assert(s);
2239
2240 socket_unwatch_control_pid(s);
2241
2242 unit_warn_leftover_processes(UNIT(s));
2243
2244 s->control_command_id = SOCKET_EXEC_START_PRE;
2245 s->control_command = s->exec_command[SOCKET_EXEC_START_PRE];
2246
2247 if (s->control_command) {
2248 r = socket_spawn(s, s->control_command, &s->control_pid);
2249 if (r < 0) {
2250 log_unit_warning_errno(UNIT(s), r, "Failed to run 'start-pre' task: %m");
2251 goto fail;
2252 }
2253
2254 socket_set_state(s, SOCKET_START_PRE);
2255 } else
2256 socket_enter_start_chown(s);
2257
2258 return;
2259
2260 fail:
2261 socket_enter_dead(s, SOCKET_FAILURE_RESOURCES);
2262 }
2263
2264 static void flush_ports(Socket *s) {
2265 SocketPort *p;
2266
2267 /* Flush all incoming traffic, regardless if actual bytes or new connections, so that this socket isn't busy
2268 * anymore */
2269
2270 LIST_FOREACH(port, p, s->ports) {
2271 if (p->fd < 0)
2272 continue;
2273
2274 (void) flush_accept(p->fd);
2275 (void) flush_fd(p->fd);
2276 }
2277 }
2278
2279 static void socket_enter_running(Socket *s, int cfd) {
2280 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
2281 int r;
2282
2283 /* Note that this call takes possession of the connection fd passed. It either has to assign it somewhere or
2284 * close it. */
2285
2286 assert(s);
2287
2288 /* We don't take connections anymore if we are supposed to shut down anyway */
2289 if (unit_stop_pending(UNIT(s))) {
2290
2291 log_unit_debug(UNIT(s), "Suppressing connection request since unit stop is scheduled.");
2292
2293 if (cfd >= 0)
2294 goto refuse;
2295 else
2296 flush_ports(s);
2297
2298 return;
2299 }
2300
2301 if (!ratelimit_below(&s->trigger_limit)) {
2302 log_unit_warning(UNIT(s), "Trigger limit hit, refusing further activation.");
2303 socket_enter_stop_pre(s, SOCKET_FAILURE_TRIGGER_LIMIT_HIT);
2304 goto refuse;
2305 }
2306
2307 if (cfd < 0) {
2308 bool pending = false;
2309 Unit *other;
2310 Iterator i;
2311 void *v;
2312
2313 /* If there's already a start pending don't bother to
2314 * do anything */
2315 HASHMAP_FOREACH_KEY(v, other, UNIT(s)->dependencies[UNIT_TRIGGERS], i)
2316 if (unit_active_or_pending(other)) {
2317 pending = true;
2318 break;
2319 }
2320
2321 if (!pending) {
2322 if (!UNIT_ISSET(s->service)) {
2323 log_unit_error(UNIT(s), "Service to activate vanished, refusing activation.");
2324 r = -ENOENT;
2325 goto fail;
2326 }
2327
2328 r = manager_add_job(UNIT(s)->manager, JOB_START, UNIT_DEREF(s->service), JOB_REPLACE, NULL, &error, NULL);
2329 if (r < 0)
2330 goto fail;
2331 }
2332
2333 socket_set_state(s, SOCKET_RUNNING);
2334 } else {
2335 _cleanup_free_ char *prefix = NULL, *instance = NULL, *name = NULL;
2336 _cleanup_(socket_peer_unrefp) SocketPeer *p = NULL;
2337 Service *service;
2338
2339 if (s->n_connections >= s->max_connections) {
2340 log_unit_warning(UNIT(s), "Too many incoming connections (%u), dropping connection.",
2341 s->n_connections);
2342 goto refuse;
2343 }
2344
2345 if (s->max_connections_per_source > 0) {
2346 r = socket_acquire_peer(s, cfd, &p);
2347 if (r < 0) {
2348 goto refuse;
2349 } else if (r > 0 && p->n_ref > s->max_connections_per_source) {
2350 _cleanup_free_ char *t = NULL;
2351
2352 (void) sockaddr_pretty(&p->peer.sa, p->peer_salen, true, false, &t);
2353
2354 log_unit_warning(UNIT(s),
2355 "Too many incoming connections (%u) from source %s, dropping connection.",
2356 p->n_ref, strnull(t));
2357 goto refuse;
2358 }
2359 }
2360
2361 r = socket_instantiate_service(s);
2362 if (r < 0)
2363 goto fail;
2364
2365 r = instance_from_socket(cfd, s->n_accepted, &instance);
2366 if (r < 0) {
2367 if (r != -ENOTCONN)
2368 goto fail;
2369
2370 /* ENOTCONN is legitimate if TCP RST was received.
2371 * This connection is over, but the socket unit lives on. */
2372 log_unit_debug(UNIT(s), "Got ENOTCONN on incoming socket, assuming aborted connection attempt, ignoring.");
2373 goto refuse;
2374 }
2375
2376 r = unit_name_to_prefix(UNIT(s)->id, &prefix);
2377 if (r < 0)
2378 goto fail;
2379
2380 r = unit_name_build(prefix, instance, ".service", &name);
2381 if (r < 0)
2382 goto fail;
2383
2384 r = unit_add_name(UNIT_DEREF(s->service), name);
2385 if (r < 0)
2386 goto fail;
2387
2388 service = SERVICE(UNIT_DEREF(s->service));
2389 unit_ref_unset(&s->service);
2390
2391 s->n_accepted++;
2392 unit_choose_id(UNIT(service), name);
2393
2394 r = service_set_socket_fd(service, cfd, s, s->selinux_context_from_net);
2395 if (r < 0)
2396 goto fail;
2397
2398 cfd = -1; /* We passed ownership of the fd to the service now. Forget it here. */
2399 s->n_connections++;
2400
2401 service->peer = TAKE_PTR(p); /* Pass ownership of the peer reference */
2402
2403 r = manager_add_job(UNIT(s)->manager, JOB_START, UNIT(service), JOB_REPLACE, NULL, &error, NULL);
2404 if (r < 0) {
2405 /* We failed to activate the new service, but it still exists. Let's make sure the service
2406 * closes and forgets the connection fd again, immediately. */
2407 service_close_socket_fd(service);
2408 goto fail;
2409 }
2410
2411 /* Notify clients about changed counters */
2412 unit_add_to_dbus_queue(UNIT(s));
2413 }
2414
2415 return;
2416
2417 refuse:
2418 s->n_refused++;
2419 safe_close(cfd);
2420 return;
2421
2422 fail:
2423 log_unit_warning(UNIT(s), "Failed to queue service startup job (Maybe the service file is missing or not a %s unit?): %s",
2424 cfd >= 0 ? "template" : "non-template",
2425 bus_error_message(&error, r));
2426
2427 socket_enter_stop_pre(s, SOCKET_FAILURE_RESOURCES);
2428 safe_close(cfd);
2429 }
2430
2431 static void socket_run_next(Socket *s) {
2432 int r;
2433
2434 assert(s);
2435 assert(s->control_command);
2436 assert(s->control_command->command_next);
2437
2438 socket_unwatch_control_pid(s);
2439
2440 s->control_command = s->control_command->command_next;
2441
2442 r = socket_spawn(s, s->control_command, &s->control_pid);
2443 if (r < 0)
2444 goto fail;
2445
2446 return;
2447
2448 fail:
2449 log_unit_warning_errno(UNIT(s), r, "Failed to run next task: %m");
2450
2451 if (s->state == SOCKET_START_POST)
2452 socket_enter_stop_pre(s, SOCKET_FAILURE_RESOURCES);
2453 else if (s->state == SOCKET_STOP_POST)
2454 socket_enter_dead(s, SOCKET_FAILURE_RESOURCES);
2455 else
2456 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, SOCKET_FAILURE_RESOURCES);
2457 }
2458
2459 static int socket_start(Unit *u) {
2460 Socket *s = SOCKET(u);
2461 int r;
2462
2463 assert(s);
2464
2465 /* We cannot fulfill this request right now, try again later
2466 * please! */
2467 if (IN_SET(s->state,
2468 SOCKET_STOP_PRE,
2469 SOCKET_STOP_PRE_SIGKILL,
2470 SOCKET_STOP_PRE_SIGTERM,
2471 SOCKET_STOP_POST,
2472 SOCKET_FINAL_SIGTERM,
2473 SOCKET_FINAL_SIGKILL,
2474 SOCKET_CLEANING))
2475 return -EAGAIN;
2476
2477 /* Already on it! */
2478 if (IN_SET(s->state,
2479 SOCKET_START_PRE,
2480 SOCKET_START_CHOWN,
2481 SOCKET_START_POST))
2482 return 0;
2483
2484 /* Cannot run this without the service being around */
2485 if (UNIT_ISSET(s->service)) {
2486 Service *service;
2487
2488 service = SERVICE(UNIT_DEREF(s->service));
2489
2490 if (UNIT(service)->load_state != UNIT_LOADED) {
2491 log_unit_error(u, "Socket service %s not loaded, refusing.", UNIT(service)->id);
2492 return -ENOENT;
2493 }
2494
2495 /* If the service is already active we cannot start the
2496 * socket */
2497 if (!IN_SET(service->state, SERVICE_DEAD, SERVICE_FAILED, SERVICE_AUTO_RESTART)) {
2498 log_unit_error(u, "Socket service %s already active, refusing.", UNIT(service)->id);
2499 return -EBUSY;
2500 }
2501 }
2502
2503 assert(IN_SET(s->state, SOCKET_DEAD, SOCKET_FAILED));
2504
2505 r = unit_test_start_limit(u);
2506 if (r < 0) {
2507 socket_enter_dead(s, SOCKET_FAILURE_START_LIMIT_HIT);
2508 return r;
2509 }
2510
2511 r = unit_acquire_invocation_id(u);
2512 if (r < 0)
2513 return r;
2514
2515 s->result = SOCKET_SUCCESS;
2516 exec_command_reset_status_list_array(s->exec_command, _SOCKET_EXEC_COMMAND_MAX);
2517
2518 u->reset_accounting = true;
2519
2520 socket_enter_start_pre(s);
2521 return 1;
2522 }
2523
2524 static int socket_stop(Unit *u) {
2525 Socket *s = SOCKET(u);
2526
2527 assert(s);
2528
2529 /* Already on it */
2530 if (IN_SET(s->state,
2531 SOCKET_STOP_PRE,
2532 SOCKET_STOP_PRE_SIGTERM,
2533 SOCKET_STOP_PRE_SIGKILL,
2534 SOCKET_STOP_POST,
2535 SOCKET_FINAL_SIGTERM,
2536 SOCKET_FINAL_SIGKILL))
2537 return 0;
2538
2539 /* If there's already something running we go directly into
2540 * kill mode. */
2541 if (IN_SET(s->state,
2542 SOCKET_START_PRE,
2543 SOCKET_START_CHOWN,
2544 SOCKET_START_POST)) {
2545 socket_enter_signal(s, SOCKET_STOP_PRE_SIGTERM, SOCKET_SUCCESS);
2546 return -EAGAIN;
2547 }
2548
2549 /* If we are currently cleaning, then abort it, brutally. */
2550 if (s->state == SOCKET_CLEANING) {
2551 socket_enter_signal(s, SOCKET_FINAL_SIGKILL, SOCKET_SUCCESS);
2552 return 0;
2553 }
2554
2555 assert(IN_SET(s->state, SOCKET_LISTENING, SOCKET_RUNNING));
2556
2557 socket_enter_stop_pre(s, SOCKET_SUCCESS);
2558 return 1;
2559 }
2560
2561 static int socket_serialize(Unit *u, FILE *f, FDSet *fds) {
2562 Socket *s = SOCKET(u);
2563 SocketPort *p;
2564 int r;
2565
2566 assert(u);
2567 assert(f);
2568 assert(fds);
2569
2570 (void) serialize_item(f, "state", socket_state_to_string(s->state));
2571 (void) serialize_item(f, "result", socket_result_to_string(s->result));
2572 (void) serialize_item_format(f, "n-accepted", "%u", s->n_accepted);
2573 (void) serialize_item_format(f, "n-refused", "%u", s->n_refused);
2574
2575 if (s->control_pid > 0)
2576 (void) serialize_item_format(f, "control-pid", PID_FMT, s->control_pid);
2577
2578 if (s->control_command_id >= 0)
2579 (void) serialize_item(f, "control-command", socket_exec_command_to_string(s->control_command_id));
2580
2581 LIST_FOREACH(port, p, s->ports) {
2582 int copy;
2583
2584 if (p->fd < 0)
2585 continue;
2586
2587 copy = fdset_put_dup(fds, p->fd);
2588 if (copy < 0)
2589 return log_unit_warning_errno(u, copy, "Failed to serialize socket fd: %m");
2590
2591 if (p->type == SOCKET_SOCKET) {
2592 _cleanup_free_ char *t = NULL;
2593
2594 r = socket_address_print(&p->address, &t);
2595 if (r < 0)
2596 return log_unit_error_errno(u, r, "Failed to format socket address: %m");
2597
2598 if (socket_address_family(&p->address) == AF_NETLINK)
2599 (void) serialize_item_format(f, "netlink", "%i %s", copy, t);
2600 else
2601 (void) serialize_item_format(f, "socket", "%i %i %s", copy, p->address.type, t);
2602 } else if (p->type == SOCKET_SPECIAL)
2603 (void) serialize_item_format(f, "special", "%i %s", copy, p->path);
2604 else if (p->type == SOCKET_MQUEUE)
2605 (void) serialize_item_format(f, "mqueue", "%i %s", copy, p->path);
2606 else if (p->type == SOCKET_USB_FUNCTION)
2607 (void) serialize_item_format(f, "ffs", "%i %s", copy, p->path);
2608 else {
2609 assert(p->type == SOCKET_FIFO);
2610 (void) serialize_item_format(f, "fifo", "%i %s", copy, p->path);
2611 }
2612 }
2613
2614 return 0;
2615 }
2616
2617 static void socket_port_take_fd(SocketPort *p, FDSet *fds, int fd) {
2618 assert(p);
2619
2620 safe_close(p->fd);
2621 p->fd = fdset_remove(fds, fd);
2622 }
2623
2624 static int socket_deserialize_item(Unit *u, const char *key, const char *value, FDSet *fds) {
2625 Socket *s = SOCKET(u);
2626
2627 assert(u);
2628 assert(key);
2629 assert(value);
2630
2631 if (streq(key, "state")) {
2632 SocketState state;
2633
2634 state = socket_state_from_string(value);
2635 if (state < 0)
2636 log_unit_debug(u, "Failed to parse state value: %s", value);
2637 else
2638 s->deserialized_state = state;
2639 } else if (streq(key, "result")) {
2640 SocketResult f;
2641
2642 f = socket_result_from_string(value);
2643 if (f < 0)
2644 log_unit_debug(u, "Failed to parse result value: %s", value);
2645 else if (f != SOCKET_SUCCESS)
2646 s->result = f;
2647
2648 } else if (streq(key, "n-accepted")) {
2649 unsigned k;
2650
2651 if (safe_atou(value, &k) < 0)
2652 log_unit_debug(u, "Failed to parse n-accepted value: %s", value);
2653 else
2654 s->n_accepted += k;
2655 } else if (streq(key, "n-refused")) {
2656 unsigned k;
2657
2658 if (safe_atou(value, &k) < 0)
2659 log_unit_debug(u, "Failed to parse n-refused value: %s", value);
2660 else
2661 s->n_refused += k;
2662 } else if (streq(key, "control-pid")) {
2663 pid_t pid;
2664
2665 if (parse_pid(value, &pid) < 0)
2666 log_unit_debug(u, "Failed to parse control-pid value: %s", value);
2667 else
2668 s->control_pid = pid;
2669 } else if (streq(key, "control-command")) {
2670 SocketExecCommand id;
2671
2672 id = socket_exec_command_from_string(value);
2673 if (id < 0)
2674 log_unit_debug(u, "Failed to parse exec-command value: %s", value);
2675 else {
2676 s->control_command_id = id;
2677 s->control_command = s->exec_command[id];
2678 }
2679 } else if (streq(key, "fifo")) {
2680 int fd, skip = 0;
2681 SocketPort *p;
2682
2683 if (sscanf(value, "%i %n", &fd, &skip) < 1 || fd < 0 || !fdset_contains(fds, fd))
2684 log_unit_debug(u, "Failed to parse fifo value: %s", value);
2685 else
2686 LIST_FOREACH(port, p, s->ports)
2687 if (p->type == SOCKET_FIFO &&
2688 path_equal_or_files_same(p->path, value+skip, 0)) {
2689 socket_port_take_fd(p, fds, fd);
2690 break;
2691 }
2692
2693 } else if (streq(key, "special")) {
2694 int fd, skip = 0;
2695 SocketPort *p;
2696
2697 if (sscanf(value, "%i %n", &fd, &skip) < 1 || fd < 0 || !fdset_contains(fds, fd))
2698 log_unit_debug(u, "Failed to parse special value: %s", value);
2699 else
2700 LIST_FOREACH(port, p, s->ports)
2701 if (p->type == SOCKET_SPECIAL &&
2702 path_equal_or_files_same(p->path, value+skip, 0)) {
2703 socket_port_take_fd(p, fds, fd);
2704 break;
2705 }
2706
2707 } else if (streq(key, "mqueue")) {
2708 int fd, skip = 0;
2709 SocketPort *p;
2710
2711 if (sscanf(value, "%i %n", &fd, &skip) < 1 || fd < 0 || !fdset_contains(fds, fd))
2712 log_unit_debug(u, "Failed to parse mqueue value: %s", value);
2713 else
2714 LIST_FOREACH(port, p, s->ports)
2715 if (p->type == SOCKET_MQUEUE &&
2716 streq(p->path, value+skip)) {
2717 socket_port_take_fd(p, fds, fd);
2718 break;
2719 }
2720
2721 } else if (streq(key, "socket")) {
2722 int fd, type, skip = 0;
2723 SocketPort *p;
2724
2725 if (sscanf(value, "%i %i %n", &fd, &type, &skip) < 2 || fd < 0 || type < 0 || !fdset_contains(fds, fd))
2726 log_unit_debug(u, "Failed to parse socket value: %s", value);
2727 else
2728 LIST_FOREACH(port, p, s->ports)
2729 if (socket_address_is(&p->address, value+skip, type)) {
2730 socket_port_take_fd(p, fds, fd);
2731 break;
2732 }
2733
2734 } else if (streq(key, "netlink")) {
2735 int fd, skip = 0;
2736 SocketPort *p;
2737
2738 if (sscanf(value, "%i %n", &fd, &skip) < 1 || fd < 0 || !fdset_contains(fds, fd))
2739 log_unit_debug(u, "Failed to parse socket value: %s", value);
2740 else
2741 LIST_FOREACH(port, p, s->ports)
2742 if (socket_address_is_netlink(&p->address, value+skip)) {
2743 socket_port_take_fd(p, fds, fd);
2744 break;
2745 }
2746
2747 } else if (streq(key, "ffs")) {
2748 int fd, skip = 0;
2749 SocketPort *p;
2750
2751 if (sscanf(value, "%i %n", &fd, &skip) < 1 || fd < 0 || !fdset_contains(fds, fd))
2752 log_unit_debug(u, "Failed to parse ffs value: %s", value);
2753 else
2754 LIST_FOREACH(port, p, s->ports)
2755 if (p->type == SOCKET_USB_FUNCTION &&
2756 path_equal_or_files_same(p->path, value+skip, 0)) {
2757 socket_port_take_fd(p, fds, fd);
2758 break;
2759 }
2760
2761 } else
2762 log_unit_debug(UNIT(s), "Unknown serialization key: %s", key);
2763
2764 return 0;
2765 }
2766
2767 static void socket_distribute_fds(Unit *u, FDSet *fds) {
2768 Socket *s = SOCKET(u);
2769 SocketPort *p;
2770
2771 assert(u);
2772
2773 LIST_FOREACH(port, p, s->ports) {
2774 Iterator i;
2775 int fd;
2776
2777 if (p->type != SOCKET_SOCKET)
2778 continue;
2779
2780 if (p->fd >= 0)
2781 continue;
2782
2783 FDSET_FOREACH(fd, fds, i) {
2784 if (socket_address_matches_fd(&p->address, fd)) {
2785 p->fd = fdset_remove(fds, fd);
2786 s->deserialized_state = SOCKET_LISTENING;
2787 break;
2788 }
2789 }
2790 }
2791 }
2792
2793 _pure_ static UnitActiveState socket_active_state(Unit *u) {
2794 assert(u);
2795
2796 return state_translation_table[SOCKET(u)->state];
2797 }
2798
2799 _pure_ static const char *socket_sub_state_to_string(Unit *u) {
2800 assert(u);
2801
2802 return socket_state_to_string(SOCKET(u)->state);
2803 }
2804
2805 const char* socket_port_type_to_string(SocketPort *p) {
2806
2807 assert(p);
2808
2809 switch (p->type) {
2810
2811 case SOCKET_SOCKET:
2812
2813 switch (p->address.type) {
2814
2815 case SOCK_STREAM:
2816 return "Stream";
2817
2818 case SOCK_DGRAM:
2819 return "Datagram";
2820
2821 case SOCK_SEQPACKET:
2822 return "SequentialPacket";
2823
2824 case SOCK_RAW:
2825 if (socket_address_family(&p->address) == AF_NETLINK)
2826 return "Netlink";
2827
2828 _fallthrough_;
2829 default:
2830 return NULL;
2831 }
2832
2833 case SOCKET_SPECIAL:
2834 return "Special";
2835
2836 case SOCKET_MQUEUE:
2837 return "MessageQueue";
2838
2839 case SOCKET_FIFO:
2840 return "FIFO";
2841
2842 case SOCKET_USB_FUNCTION:
2843 return "USBFunction";
2844
2845 default:
2846 return NULL;
2847 }
2848 }
2849
2850 SocketType socket_port_type_from_string(const char *s) {
2851 assert(s);
2852
2853 if (STR_IN_SET(s, "Stream", "Datagram", "SequentialPacket", "Netlink"))
2854 return SOCKET_SOCKET;
2855 else if (streq(s, "Special"))
2856 return SOCKET_SPECIAL;
2857 else if (streq(s, "MessageQueue"))
2858 return SOCKET_MQUEUE;
2859 else if (streq(s, "FIFO"))
2860 return SOCKET_FIFO;
2861 else if (streq(s, "USBFunction"))
2862 return SOCKET_USB_FUNCTION;
2863 else
2864 return _SOCKET_TYPE_INVALID;
2865 }
2866
2867 _pure_ static bool socket_may_gc(Unit *u) {
2868 Socket *s = SOCKET(u);
2869
2870 assert(u);
2871
2872 return s->n_connections == 0;
2873 }
2874
2875 static int socket_accept_do(Socket *s, int fd) {
2876 int cfd;
2877
2878 assert(s);
2879 assert(fd >= 0);
2880
2881 cfd = accept4(fd, NULL, NULL, SOCK_NONBLOCK|SOCK_CLOEXEC);
2882 if (cfd < 0)
2883 /* Convert transient network errors into clean and well-defined EAGAIN */
2884 return ERRNO_IS_ACCEPT_AGAIN(errno) ? -EAGAIN : -errno;
2885
2886 return cfd;
2887 }
2888
2889 static int socket_accept_in_cgroup(Socket *s, SocketPort *p, int fd) {
2890 _cleanup_close_pair_ int pair[2] = { -1, -1 };
2891 int cfd, r;
2892 pid_t pid;
2893
2894 assert(s);
2895 assert(p);
2896 assert(fd >= 0);
2897
2898 /* Similar to socket_address_listen_in_cgroup(), but for accept() rather than socket(): make sure that any
2899 * connection socket is also properly associated with the cgroup. */
2900
2901 if (!IN_SET(p->address.sockaddr.sa.sa_family, AF_INET, AF_INET6))
2902 goto shortcut;
2903
2904 r = bpf_firewall_supported();
2905 if (r < 0)
2906 return r;
2907 if (r == BPF_FIREWALL_UNSUPPORTED)
2908 goto shortcut;
2909
2910 if (socketpair(AF_UNIX, SOCK_SEQPACKET|SOCK_CLOEXEC, 0, pair) < 0)
2911 return log_unit_error_errno(UNIT(s), errno, "Failed to create communication channel: %m");
2912
2913 r = unit_fork_helper_process(UNIT(s), "(sd-accept)", &pid);
2914 if (r < 0)
2915 return log_unit_error_errno(UNIT(s), r, "Failed to fork off accept stub process: %m");
2916 if (r == 0) {
2917 /* Child */
2918
2919 pair[0] = safe_close(pair[0]);
2920
2921 cfd = socket_accept_do(s, fd);
2922 if (cfd == -EAGAIN) /* spurious accept() */
2923 _exit(EXIT_SUCCESS);
2924 if (cfd < 0) {
2925 log_unit_error_errno(UNIT(s), cfd, "Failed to accept connection socket: %m");
2926 _exit(EXIT_FAILURE);
2927 }
2928
2929 r = send_one_fd(pair[1], cfd, 0);
2930 if (r < 0) {
2931 log_unit_error_errno(UNIT(s), r, "Failed to send connection socket to parent: %m");
2932 _exit(EXIT_FAILURE);
2933 }
2934
2935 _exit(EXIT_SUCCESS);
2936 }
2937
2938 pair[1] = safe_close(pair[1]);
2939 cfd = receive_one_fd(pair[0], 0);
2940
2941 /* We synchronously wait for the helper, as it shouldn't be slow */
2942 r = wait_for_terminate_and_check("(sd-accept)", pid, WAIT_LOG_ABNORMAL);
2943 if (r < 0) {
2944 safe_close(cfd);
2945 return r;
2946 }
2947
2948 /* If we received no fd, we got EIO here. If this happens with a process exit code of EXIT_SUCCESS
2949 * this is a spurious accept(), let's convert that back to EAGAIN here. */
2950 if (cfd == -EIO)
2951 return -EAGAIN;
2952 if (cfd < 0)
2953 return log_unit_error_errno(UNIT(s), cfd, "Failed to receive connection socket: %m");
2954
2955 return cfd;
2956
2957 shortcut:
2958 cfd = socket_accept_do(s, fd);
2959 if (cfd == -EAGAIN) /* spurious accept(), skip it silently */
2960 return -EAGAIN;
2961 if (cfd < 0)
2962 return log_unit_error_errno(UNIT(s), cfd, "Failed to accept connection socket: %m");
2963
2964 return cfd;
2965 }
2966
2967 static int socket_dispatch_io(sd_event_source *source, int fd, uint32_t revents, void *userdata) {
2968 SocketPort *p = userdata;
2969 int cfd = -1;
2970
2971 assert(p);
2972 assert(fd >= 0);
2973
2974 if (p->socket->state != SOCKET_LISTENING)
2975 return 0;
2976
2977 log_unit_debug(UNIT(p->socket), "Incoming traffic");
2978
2979 if (revents != EPOLLIN) {
2980 if (revents & EPOLLHUP)
2981 log_unit_error(UNIT(p->socket), "Got POLLHUP on a listening socket. The service probably invoked shutdown() on it, and should better not do that.");
2982 else
2983 log_unit_error(UNIT(p->socket), "Got unexpected poll event (0x%x) on socket.", revents);
2984 goto fail;
2985 }
2986
2987 if (p->socket->accept &&
2988 p->type == SOCKET_SOCKET &&
2989 socket_address_can_accept(&p->address)) {
2990
2991 cfd = socket_accept_in_cgroup(p->socket, p, fd);
2992 if (cfd == -EAGAIN) /* Spurious accept() */
2993 return 0;
2994 if (cfd < 0)
2995 goto fail;
2996
2997 socket_apply_socket_options(p->socket, cfd);
2998 }
2999
3000 socket_enter_running(p->socket, cfd);
3001 return 0;
3002
3003 fail:
3004 socket_enter_stop_pre(p->socket, SOCKET_FAILURE_RESOURCES);
3005 return 0;
3006 }
3007
3008 static void socket_sigchld_event(Unit *u, pid_t pid, int code, int status) {
3009 Socket *s = SOCKET(u);
3010 SocketResult f;
3011
3012 assert(s);
3013 assert(pid >= 0);
3014
3015 if (pid != s->control_pid)
3016 return;
3017
3018 s->control_pid = 0;
3019
3020 if (is_clean_exit(code, status, EXIT_CLEAN_COMMAND, NULL))
3021 f = SOCKET_SUCCESS;
3022 else if (code == CLD_EXITED)
3023 f = SOCKET_FAILURE_EXIT_CODE;
3024 else if (code == CLD_KILLED)
3025 f = SOCKET_FAILURE_SIGNAL;
3026 else if (code == CLD_DUMPED)
3027 f = SOCKET_FAILURE_CORE_DUMP;
3028 else
3029 assert_not_reached("Unknown sigchld code");
3030
3031 if (s->control_command) {
3032 exec_status_exit(&s->control_command->exec_status, &s->exec_context, pid, code, status);
3033
3034 if (s->control_command->flags & EXEC_COMMAND_IGNORE_FAILURE)
3035 f = SOCKET_SUCCESS;
3036 }
3037
3038 unit_log_process_exit(
3039 u,
3040 "Control process",
3041 socket_exec_command_to_string(s->control_command_id),
3042 f == SOCKET_SUCCESS,
3043 code, status);
3044
3045 if (s->result == SOCKET_SUCCESS)
3046 s->result = f;
3047
3048 if (s->control_command &&
3049 s->control_command->command_next &&
3050 f == SOCKET_SUCCESS) {
3051
3052 log_unit_debug(u, "Running next command for state %s", socket_state_to_string(s->state));
3053 socket_run_next(s);
3054 } else {
3055 s->control_command = NULL;
3056 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
3057
3058 /* No further commands for this step, so let's figure
3059 * out what to do next */
3060
3061 log_unit_debug(u, "Got final SIGCHLD for state %s", socket_state_to_string(s->state));
3062
3063 switch (s->state) {
3064
3065 case SOCKET_START_PRE:
3066 if (f == SOCKET_SUCCESS)
3067 socket_enter_start_chown(s);
3068 else
3069 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, f);
3070 break;
3071
3072 case SOCKET_START_CHOWN:
3073 if (f == SOCKET_SUCCESS)
3074 socket_enter_start_post(s);
3075 else
3076 socket_enter_stop_pre(s, f);
3077 break;
3078
3079 case SOCKET_START_POST:
3080 if (f == SOCKET_SUCCESS)
3081 socket_enter_listening(s);
3082 else
3083 socket_enter_stop_pre(s, f);
3084 break;
3085
3086 case SOCKET_STOP_PRE:
3087 case SOCKET_STOP_PRE_SIGTERM:
3088 case SOCKET_STOP_PRE_SIGKILL:
3089 socket_enter_stop_post(s, f);
3090 break;
3091
3092 case SOCKET_STOP_POST:
3093 case SOCKET_FINAL_SIGTERM:
3094 case SOCKET_FINAL_SIGKILL:
3095 socket_enter_dead(s, f);
3096 break;
3097
3098 case SOCKET_CLEANING:
3099
3100 if (s->clean_result == SOCKET_SUCCESS)
3101 s->clean_result = f;
3102
3103 socket_enter_dead(s, SOCKET_SUCCESS);
3104 break;
3105
3106 default:
3107 assert_not_reached("Uh, control process died at wrong time.");
3108 }
3109 }
3110
3111 /* Notify clients about changed exit status */
3112 unit_add_to_dbus_queue(u);
3113 }
3114
3115 static int socket_dispatch_timer(sd_event_source *source, usec_t usec, void *userdata) {
3116 Socket *s = SOCKET(userdata);
3117
3118 assert(s);
3119 assert(s->timer_event_source == source);
3120
3121 switch (s->state) {
3122
3123 case SOCKET_START_PRE:
3124 log_unit_warning(UNIT(s), "Starting timed out. Terminating.");
3125 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, SOCKET_FAILURE_TIMEOUT);
3126 break;
3127
3128 case SOCKET_START_CHOWN:
3129 case SOCKET_START_POST:
3130 log_unit_warning(UNIT(s), "Starting timed out. Stopping.");
3131 socket_enter_stop_pre(s, SOCKET_FAILURE_TIMEOUT);
3132 break;
3133
3134 case SOCKET_STOP_PRE:
3135 log_unit_warning(UNIT(s), "Stopping timed out. Terminating.");
3136 socket_enter_signal(s, SOCKET_STOP_PRE_SIGTERM, SOCKET_FAILURE_TIMEOUT);
3137 break;
3138
3139 case SOCKET_STOP_PRE_SIGTERM:
3140 if (s->kill_context.send_sigkill) {
3141 log_unit_warning(UNIT(s), "Stopping timed out. Killing.");
3142 socket_enter_signal(s, SOCKET_STOP_PRE_SIGKILL, SOCKET_FAILURE_TIMEOUT);
3143 } else {
3144 log_unit_warning(UNIT(s), "Stopping timed out. Skipping SIGKILL. Ignoring.");
3145 socket_enter_stop_post(s, SOCKET_FAILURE_TIMEOUT);
3146 }
3147 break;
3148
3149 case SOCKET_STOP_PRE_SIGKILL:
3150 log_unit_warning(UNIT(s), "Processes still around after SIGKILL. Ignoring.");
3151 socket_enter_stop_post(s, SOCKET_FAILURE_TIMEOUT);
3152 break;
3153
3154 case SOCKET_STOP_POST:
3155 log_unit_warning(UNIT(s), "Stopping timed out (2). Terminating.");
3156 socket_enter_signal(s, SOCKET_FINAL_SIGTERM, SOCKET_FAILURE_TIMEOUT);
3157 break;
3158
3159 case SOCKET_FINAL_SIGTERM:
3160 if (s->kill_context.send_sigkill) {
3161 log_unit_warning(UNIT(s), "Stopping timed out (2). Killing.");
3162 socket_enter_signal(s, SOCKET_FINAL_SIGKILL, SOCKET_FAILURE_TIMEOUT);
3163 } else {
3164 log_unit_warning(UNIT(s), "Stopping timed out (2). Skipping SIGKILL. Ignoring.");
3165 socket_enter_dead(s, SOCKET_FAILURE_TIMEOUT);
3166 }
3167 break;
3168
3169 case SOCKET_FINAL_SIGKILL:
3170 log_unit_warning(UNIT(s), "Still around after SIGKILL (2). Entering failed mode.");
3171 socket_enter_dead(s, SOCKET_FAILURE_TIMEOUT);
3172 break;
3173
3174 case SOCKET_CLEANING:
3175 log_unit_warning(UNIT(s), "Cleaning timed out. killing.");
3176
3177 if (s->clean_result == SOCKET_SUCCESS)
3178 s->clean_result = SOCKET_FAILURE_TIMEOUT;
3179
3180 socket_enter_signal(s, SOCKET_FINAL_SIGKILL, 0);
3181 break;
3182
3183 default:
3184 assert_not_reached("Timeout at wrong time.");
3185 }
3186
3187 return 0;
3188 }
3189
3190 int socket_collect_fds(Socket *s, int **fds) {
3191 size_t k = 0, n = 0;
3192 SocketPort *p;
3193 int *rfds;
3194
3195 assert(s);
3196 assert(fds);
3197
3198 /* Called from the service code for requesting our fds */
3199
3200 LIST_FOREACH(port, p, s->ports) {
3201 if (p->fd >= 0)
3202 n++;
3203 n += p->n_auxiliary_fds;
3204 }
3205
3206 if (n <= 0) {
3207 *fds = NULL;
3208 return 0;
3209 }
3210
3211 rfds = new(int, n);
3212 if (!rfds)
3213 return -ENOMEM;
3214
3215 LIST_FOREACH(port, p, s->ports) {
3216 size_t i;
3217
3218 if (p->fd >= 0)
3219 rfds[k++] = p->fd;
3220 for (i = 0; i < p->n_auxiliary_fds; ++i)
3221 rfds[k++] = p->auxiliary_fds[i];
3222 }
3223
3224 assert(k == n);
3225
3226 *fds = rfds;
3227 return (int) n;
3228 }
3229
3230 static void socket_reset_failed(Unit *u) {
3231 Socket *s = SOCKET(u);
3232
3233 assert(s);
3234
3235 if (s->state == SOCKET_FAILED)
3236 socket_set_state(s, SOCKET_DEAD);
3237
3238 s->result = SOCKET_SUCCESS;
3239 s->clean_result = SOCKET_SUCCESS;
3240 }
3241
3242 void socket_connection_unref(Socket *s) {
3243 assert(s);
3244
3245 /* The service is dead. Yay!
3246 *
3247 * This is strictly for one-instance-per-connection
3248 * services. */
3249
3250 assert(s->n_connections > 0);
3251 s->n_connections--;
3252
3253 log_unit_debug(UNIT(s), "One connection closed, %u left.", s->n_connections);
3254 }
3255
3256 static void socket_trigger_notify(Unit *u, Unit *other) {
3257 Socket *s = SOCKET(u);
3258
3259 assert(u);
3260 assert(other);
3261
3262 /* Filter out invocations with bogus state */
3263 if (other->load_state != UNIT_LOADED || other->type != UNIT_SERVICE)
3264 return;
3265
3266 /* Don't propagate state changes from the service if we are already down */
3267 if (!IN_SET(s->state, SOCKET_RUNNING, SOCKET_LISTENING))
3268 return;
3269
3270 /* We don't care for the service state if we are in Accept=yes mode */
3271 if (s->accept)
3272 return;
3273
3274 /* Propagate start limit hit state */
3275 if (other->start_limit_hit) {
3276 socket_enter_stop_pre(s, SOCKET_FAILURE_SERVICE_START_LIMIT_HIT);
3277 return;
3278 }
3279
3280 /* Don't propagate anything if there's still a job queued */
3281 if (other->job)
3282 return;
3283
3284 if (IN_SET(SERVICE(other)->state,
3285 SERVICE_DEAD, SERVICE_FAILED,
3286 SERVICE_FINAL_SIGTERM, SERVICE_FINAL_SIGKILL,
3287 SERVICE_AUTO_RESTART))
3288 socket_enter_listening(s);
3289
3290 if (SERVICE(other)->state == SERVICE_RUNNING)
3291 socket_set_state(s, SOCKET_RUNNING);
3292 }
3293
3294 static int socket_kill(Unit *u, KillWho who, int signo, sd_bus_error *error) {
3295 return unit_kill_common(u, who, signo, -1, SOCKET(u)->control_pid, error);
3296 }
3297
3298 static int socket_get_timeout(Unit *u, usec_t *timeout) {
3299 Socket *s = SOCKET(u);
3300 usec_t t;
3301 int r;
3302
3303 if (!s->timer_event_source)
3304 return 0;
3305
3306 r = sd_event_source_get_time(s->timer_event_source, &t);
3307 if (r < 0)
3308 return r;
3309 if (t == USEC_INFINITY)
3310 return 0;
3311
3312 *timeout = t;
3313 return 1;
3314 }
3315
3316 char *socket_fdname(Socket *s) {
3317 assert(s);
3318
3319 /* Returns the name to use for $LISTEN_NAMES. If the user
3320 * didn't specify anything specifically, use the socket unit's
3321 * name as fallback. */
3322
3323 return s->fdname ?: UNIT(s)->id;
3324 }
3325
3326 static int socket_control_pid(Unit *u) {
3327 Socket *s = SOCKET(u);
3328
3329 assert(s);
3330
3331 return s->control_pid;
3332 }
3333
3334 static int socket_clean(Unit *u, ExecCleanMask mask) {
3335 _cleanup_strv_free_ char **l = NULL;
3336 Socket *s = SOCKET(u);
3337 int r;
3338
3339 assert(s);
3340 assert(mask != 0);
3341
3342 if (s->state != SOCKET_DEAD)
3343 return -EBUSY;
3344
3345 r = exec_context_get_clean_directories(&s->exec_context, u->manager->prefix, mask, &l);
3346 if (r < 0)
3347 return r;
3348
3349 if (strv_isempty(l))
3350 return -EUNATCH;
3351
3352 socket_unwatch_control_pid(s);
3353 s->clean_result = SOCKET_SUCCESS;
3354 s->control_command = NULL;
3355 s->control_command_id = _SOCKET_EXEC_COMMAND_INVALID;
3356
3357 r = socket_arm_timer(s, usec_add(now(CLOCK_MONOTONIC), s->exec_context.timeout_clean_usec));
3358 if (r < 0)
3359 goto fail;
3360
3361 r = unit_fork_and_watch_rm_rf(u, l, &s->control_pid);
3362 if (r < 0)
3363 goto fail;
3364
3365 socket_set_state(s, SOCKET_CLEANING);
3366
3367 return 0;
3368
3369 fail:
3370 log_unit_warning_errno(u, r, "Failed to initiate cleaning: %m");
3371 s->clean_result = SOCKET_FAILURE_RESOURCES;
3372 s->timer_event_source = sd_event_source_unref(s->timer_event_source);
3373 return r;
3374 }
3375
3376 static int socket_can_clean(Unit *u, ExecCleanMask *ret) {
3377 Socket *s = SOCKET(u);
3378
3379 assert(s);
3380
3381 return exec_context_get_clean_mask(&s->exec_context, ret);
3382 }
3383
3384 static const char* const socket_exec_command_table[_SOCKET_EXEC_COMMAND_MAX] = {
3385 [SOCKET_EXEC_START_PRE] = "ExecStartPre",
3386 [SOCKET_EXEC_START_CHOWN] = "ExecStartChown",
3387 [SOCKET_EXEC_START_POST] = "ExecStartPost",
3388 [SOCKET_EXEC_STOP_PRE] = "ExecStopPre",
3389 [SOCKET_EXEC_STOP_POST] = "ExecStopPost"
3390 };
3391
3392 DEFINE_STRING_TABLE_LOOKUP(socket_exec_command, SocketExecCommand);
3393
3394 static const char* const socket_result_table[_SOCKET_RESULT_MAX] = {
3395 [SOCKET_SUCCESS] = "success",
3396 [SOCKET_FAILURE_RESOURCES] = "resources",
3397 [SOCKET_FAILURE_TIMEOUT] = "timeout",
3398 [SOCKET_FAILURE_EXIT_CODE] = "exit-code",
3399 [SOCKET_FAILURE_SIGNAL] = "signal",
3400 [SOCKET_FAILURE_CORE_DUMP] = "core-dump",
3401 [SOCKET_FAILURE_START_LIMIT_HIT] = "start-limit-hit",
3402 [SOCKET_FAILURE_TRIGGER_LIMIT_HIT] = "trigger-limit-hit",
3403 [SOCKET_FAILURE_SERVICE_START_LIMIT_HIT] = "service-start-limit-hit"
3404 };
3405
3406 DEFINE_STRING_TABLE_LOOKUP(socket_result, SocketResult);
3407
3408 const UnitVTable socket_vtable = {
3409 .object_size = sizeof(Socket),
3410 .exec_context_offset = offsetof(Socket, exec_context),
3411 .cgroup_context_offset = offsetof(Socket, cgroup_context),
3412 .kill_context_offset = offsetof(Socket, kill_context),
3413 .exec_runtime_offset = offsetof(Socket, exec_runtime),
3414 .dynamic_creds_offset = offsetof(Socket, dynamic_creds),
3415
3416 .sections =
3417 "Unit\0"
3418 "Socket\0"
3419 "Install\0",
3420 .private_section = "Socket",
3421
3422 .can_transient = true,
3423
3424 .init = socket_init,
3425 .done = socket_done,
3426 .load = socket_load,
3427
3428 .coldplug = socket_coldplug,
3429
3430 .dump = socket_dump,
3431
3432 .start = socket_start,
3433 .stop = socket_stop,
3434
3435 .kill = socket_kill,
3436 .clean = socket_clean,
3437 .can_clean = socket_can_clean,
3438
3439 .get_timeout = socket_get_timeout,
3440
3441 .serialize = socket_serialize,
3442 .deserialize_item = socket_deserialize_item,
3443 .distribute_fds = socket_distribute_fds,
3444
3445 .active_state = socket_active_state,
3446 .sub_state_to_string = socket_sub_state_to_string,
3447
3448 .will_restart = unit_will_restart_default,
3449
3450 .may_gc = socket_may_gc,
3451
3452 .sigchld_event = socket_sigchld_event,
3453
3454 .trigger_notify = socket_trigger_notify,
3455
3456 .reset_failed = socket_reset_failed,
3457
3458 .control_pid = socket_control_pid,
3459
3460 .bus_vtable = bus_socket_vtable,
3461 .bus_set_property = bus_socket_set_property,
3462 .bus_commit_properties = bus_socket_commit_properties,
3463
3464 .status_message_formats = {
3465 /*.starting_stopping = {
3466 [0] = "Starting socket %s...",
3467 [1] = "Stopping socket %s...",
3468 },*/
3469 .finished_start_job = {
3470 [JOB_DONE] = "Listening on %s.",
3471 [JOB_FAILED] = "Failed to listen on %s.",
3472 [JOB_TIMEOUT] = "Timed out starting %s.",
3473 },
3474 .finished_stop_job = {
3475 [JOB_DONE] = "Closed %s.",
3476 [JOB_FAILED] = "Failed stopping %s.",
3477 [JOB_TIMEOUT] = "Timed out stopping %s.",
3478 },
3479 },
3480 };