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