]> git.ipfire.org Git - thirdparty/systemd.git/blame - src/tty-ask-password-agent.c
systemctl: always null-terminate the password
[thirdparty/systemd.git] / src / tty-ask-password-agent.c
CommitLineData
ec863ba6
LP
1/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
2
3/***
4 This file is part of systemd.
5
6 Copyright 2010 Lennart Poettering
7
8 systemd is free software; you can redistribute it and/or modify it
9 under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
12
13 systemd is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with systemd; If not, see <http://www.gnu.org/licenses/>.
20***/
21
22#include <stdbool.h>
23#include <errno.h>
24#include <string.h>
25#include <sys/socket.h>
26#include <sys/un.h>
27#include <stddef.h>
28#include <sys/poll.h>
29#include <sys/inotify.h>
30#include <unistd.h>
31#include <getopt.h>
b9ba604e 32#include <sys/signalfd.h>
7af53310 33#include <fcntl.h>
ec863ba6
LP
34
35#include "util.h"
36#include "conf-parser.h"
37#include "utmp-wtmp.h"
e5ebf783 38#include "socket-util.h"
7f4e0805 39#include "ask-password-api.h"
21bc923a 40#include "strv.h"
ec863ba6
LP
41
42static enum {
43 ACTION_LIST,
44 ACTION_QUERY,
45 ACTION_WATCH,
46 ACTION_WALL
47} arg_action = ACTION_QUERY;
48
e5ebf783 49static bool arg_plymouth = false;
0cf84693 50static bool arg_console = false;
e5ebf783 51
21bc923a
LP
52static int ask_password_plymouth(
53 const char *message,
54 usec_t until,
55 const char *flag_file,
56 bool accept_cached,
57 char ***_passphrases) {
58
e5ebf783
LP
59 int fd = -1, notify = -1;
60 union sockaddr_union sa;
61 char *packet = NULL;
62 ssize_t k;
63 int r, n;
64 struct pollfd pollfd[2];
65 char buffer[LINE_MAX];
66 size_t p = 0;
67 enum {
68 POLL_SOCKET,
69 POLL_INOTIFY
70 };
71
21bc923a
LP
72 assert(_passphrases);
73
e5ebf783
LP
74 if (flag_file) {
75 if ((notify = inotify_init1(IN_CLOEXEC|IN_NONBLOCK)) < 0) {
76 r = -errno;
77 goto finish;
78 }
79
80 if (inotify_add_watch(notify, flag_file, IN_ATTRIB /* for the link count */) < 0) {
81 r = -errno;
82 goto finish;
83 }
84 }
85
86 if ((fd = socket(AF_UNIX, SOCK_STREAM|SOCK_CLOEXEC|SOCK_NONBLOCK, 0)) < 0) {
87 r = -errno;
88 goto finish;
89 }
90
91 zero(sa);
92 sa.sa.sa_family = AF_UNIX;
96707269
LP
93 strncpy(sa.un.sun_path+1, "/org/freedesktop/plymouthd", sizeof(sa.un.sun_path)-1);
94 if (connect(fd, &sa.sa, offsetof(struct sockaddr_un, sun_path) + 1 + strlen(sa.un.sun_path+1)) < 0) {
c0f9c7da 95 log_error("Failed to connect to Plymouth: %m");
e5ebf783
LP
96 r = -errno;
97 goto finish;
98 }
99
21bc923a
LP
100 if (accept_cached) {
101 packet = strdup("c");
102 n = 1;
103 } else
104 asprintf(&packet, "*\002%c%s%n", (int) (strlen(message) + 1), message, &n);
105
106 if (!packet) {
e5ebf783
LP
107 r = -ENOMEM;
108 goto finish;
109 }
110
111 if ((k = loop_write(fd, packet, n+1, true)) != n+1) {
112 r = k < 0 ? (int) k : -EIO;
113 goto finish;
114 }
115
116 zero(pollfd);
117 pollfd[POLL_SOCKET].fd = fd;
118 pollfd[POLL_SOCKET].events = POLLIN;
119 pollfd[POLL_INOTIFY].fd = notify;
120 pollfd[POLL_INOTIFY].events = POLLIN;
121
122 for (;;) {
123 int sleep_for = -1, j;
124
125 if (until > 0) {
126 usec_t y;
127
128 y = now(CLOCK_MONOTONIC);
129
130 if (y > until) {
ccc80078 131 r = -ETIME;
e5ebf783
LP
132 goto finish;
133 }
134
135 sleep_for = (int) ((until - y) / USEC_PER_MSEC);
136 }
137
138 if (flag_file)
139 if (access(flag_file, F_OK) < 0) {
140 r = -errno;
141 goto finish;
142 }
143
144 if ((j = poll(pollfd, notify > 0 ? 2 : 1, sleep_for)) < 0) {
145
146 if (errno == EINTR)
147 continue;
148
149 r = -errno;
150 goto finish;
151 } else if (j == 0) {
ccc80078 152 r = -ETIME;
e5ebf783
LP
153 goto finish;
154 }
155
156 if (notify > 0 && pollfd[POLL_INOTIFY].revents != 0)
157 flush_fd(notify);
158
159 if (pollfd[POLL_SOCKET].revents == 0)
160 continue;
161
162 if ((k = read(fd, buffer + p, sizeof(buffer) - p)) <= 0) {
163 r = k < 0 ? -errno : -EIO;
164 goto finish;
165 }
166
167 p += k;
168
169 if (p < 1)
170 continue;
171
172 if (buffer[0] == 5) {
21bc923a
LP
173
174 if (accept_cached) {
175 /* Hmm, first try with cached
176 * passwords failed, so let's retry
177 * with a normal password request */
178 free(packet);
179 packet = NULL;
180
181 if (asprintf(&packet, "*\002%c%s%n", (int) (strlen(message) + 1), message, &n) < 0) {
182 r = -ENOMEM;
183 goto finish;
184 }
185
186 if ((k = loop_write(fd, packet, n+1, true)) != n+1) {
187 r = k < 0 ? (int) k : -EIO;
188 goto finish;
189 }
190
191 accept_cached = false;
192 p = 0;
193 continue;
194 }
195
e5ebf783
LP
196 /* No password, because UI not shown */
197 r = -ENOENT;
198 goto finish;
199
21bc923a 200 } else if (buffer[0] == 2 || buffer[0] == 9) {
e5ebf783 201 uint32_t size;
21bc923a 202 char **l;
e5ebf783 203
21bc923a 204 /* One ore more answers */
e5ebf783
LP
205 if (p < 5)
206 continue;
207
208 memcpy(&size, buffer+1, sizeof(size));
209 if (size+5 > sizeof(buffer)) {
210 r = -EIO;
211 goto finish;
212 }
213
214 if (p-5 < size)
215 continue;
216
21bc923a 217 if (!(l = strv_parse_nulstr(buffer + 5, size))) {
e5ebf783
LP
218 r = -ENOMEM;
219 goto finish;
220 }
221
21bc923a 222 *_passphrases = l;
e5ebf783 223 break;
21bc923a 224
e5ebf783
LP
225 } else {
226 /* Unknown packet */
227 r = -EIO;
228 goto finish;
229 }
230 }
231
232 r = 0;
233
234finish:
235 if (notify >= 0)
236 close_nointr_nofail(notify);
237
238 if (fd >= 0)
239 close_nointr_nofail(fd);
240
241 free(packet);
242
243 return r;
244}
245
0ddf1d3a 246static int parse_password(const char *filename, char **wall) {
ec863ba6
LP
247 char *socket_name = NULL, *message = NULL, *packet = NULL;
248 uint64_t not_after = 0;
249 unsigned pid = 0;
250 int socket_fd = -1;
21bc923a 251 bool accept_cached = false;
ec863ba6
LP
252
253 const ConfigItem items[] = {
21bc923a
LP
254 { "Socket", config_parse_string, &socket_name, "Ask" },
255 { "NotAfter", config_parse_uint64, &not_after, "Ask" },
256 { "Message", config_parse_string, &message, "Ask" },
257 { "PID", config_parse_unsigned, &pid, "Ask" },
258 { "AcceptCached", config_parse_bool, &accept_cached, "Ask" },
53d3afa8 259 { NULL, NULL, NULL, NULL }
ec863ba6
LP
260 };
261
262 FILE *f;
263 int r;
264 usec_t n;
265
266 assert(filename);
267
268 if (!(f = fopen(filename, "re"))) {
269
270 if (errno == ENOENT)
271 return 0;
272
273 log_error("open(%s): %m", filename);
274 return -errno;
275 }
276
656ce8f7 277 if ((r = config_parse(filename, f, NULL, items, true, NULL)) < 0) {
ec863ba6
LP
278 log_error("Failed to parse password file %s: %s", filename, strerror(-r));
279 goto finish;
280 }
281
282 if (!socket_name || not_after <= 0) {
283 log_error("Invalid password file %s", filename);
284 r = -EBADMSG;
285 goto finish;
286 }
287
288 n = now(CLOCK_MONOTONIC);
289 if (n > not_after) {
290 r = 0;
291 goto finish;
292 }
293
294 if (arg_action == ACTION_LIST)
295 printf("'%s' (PID %u)\n", message, pid);
296 else if (arg_action == ACTION_WALL) {
0ddf1d3a 297 char *_wall;
ec863ba6 298
0ddf1d3a
LP
299 if (asprintf(&_wall,
300 "%s%sPassword entry required for \'%s\' (PID %u).\r\n"
9d3e691e 301 "Please enter password with the systemd-tty-ask-password-agent tool!",
0ddf1d3a
LP
302 *wall ? *wall : "",
303 *wall ? "\r\n\r\n" : "",
ec863ba6
LP
304 message,
305 pid) < 0) {
306 log_error("Out of memory");
307 r = -ENOMEM;
308 goto finish;
309 }
310
0ddf1d3a
LP
311 free(*wall);
312 *wall = _wall;
ec863ba6
LP
313 } else {
314 union {
315 struct sockaddr sa;
316 struct sockaddr_un un;
317 } sa;
21bc923a 318 size_t packet_length;
ec863ba6
LP
319
320 assert(arg_action == ACTION_QUERY ||
321 arg_action == ACTION_WATCH);
322
323 if (access(socket_name, W_OK) < 0) {
324
325 if (arg_action == ACTION_QUERY)
326 log_info("Not querying '%s' (PID %u), lacking privileges.", message, pid);
327
328 r = 0;
329 goto finish;
330 }
331
21bc923a
LP
332 if (arg_plymouth) {
333 char **passwords;
334
335 if ((r = ask_password_plymouth(message, not_after, filename, accept_cached, &passwords)) >= 0) {
336 char **p;
337
338 packet_length = 1;
339 STRV_FOREACH(p, passwords)
340 packet_length += strlen(*p) + 1;
341
342 if (!(packet = new(char, packet_length)))
343 r = -ENOMEM;
344 else {
345 char *d;
346
347 packet[0] = '+';
348 d = packet+1;
349
350 STRV_FOREACH(p, passwords)
351 d = stpcpy(d, *p) + 1;
352 }
353 }
354
355 } else {
0cf84693 356 int tty_fd = -1;
21bc923a 357 char *password;
0cf84693
LP
358
359 if (arg_console)
360 if ((tty_fd = acquire_terminal("/dev/console", false, false, false)) < 0) {
361 r = tty_fd;
362 goto finish;
363 }
364
e5ebf783
LP
365 r = ask_password_tty(message, not_after, filename, &password);
366
0cf84693
LP
367 if (arg_console) {
368 close_nointr_nofail(tty_fd);
369 release_terminal();
370 }
21bc923a
LP
371
372 asprintf(&packet, "+%s", password);
373 free(password);
374
375 packet_length = strlen(packet);
0cf84693
LP
376 }
377
446f0046
LP
378 if (r == -ETIME || r == -ENOENT) {
379 /* If the query went away, that's OK */
380 r = 0;
381 goto finish;
382 }
383
e5ebf783 384 if (r < 0) {
446f0046 385
e5ebf783 386 log_error("Failed to query password: %s", strerror(-r));
ec863ba6
LP
387 goto finish;
388 }
389
ec863ba6
LP
390 if (!packet) {
391 log_error("Out of memory");
392 r = -ENOMEM;
393 goto finish;
394 }
395
396 if ((socket_fd = socket(AF_UNIX, SOCK_DGRAM|SOCK_CLOEXEC, 0)) < 0) {
397 log_error("socket(): %m");
398 r = -errno;
399 goto finish;
400 }
401
402 zero(sa);
403 sa.un.sun_family = AF_UNIX;
404 strncpy(sa.un.sun_path, socket_name, sizeof(sa.un.sun_path));
405
21bc923a 406 if (sendto(socket_fd, packet, packet_length, MSG_NOSIGNAL, &sa.sa, offsetof(struct sockaddr_un, sun_path) + strlen(socket_name)) < 0) {
ec863ba6
LP
407 log_error("Failed to send: %m");
408 r = -errno;
409 goto finish;
410 }
411 }
412
413finish:
414 fclose(f);
415
416 if (socket_fd >= 0)
417 close_nointr_nofail(socket_fd);
418
419 free(packet);
420 free(socket_name);
421 free(message);
422
423 return r;
424}
425
0cf84693 426static int wall_tty_block(void) {
7af53310 427 char *p;
fc116c6a
LP
428 int fd, r;
429 dev_t devnr;
7af53310 430
fc116c6a
LP
431 if ((r = get_ctty_devnr(&devnr)) < 0)
432 return -r;
7af53310 433
fc116c6a 434 if (asprintf(&p, "/dev/.systemd/ask-password-block/%u:%u", major(devnr), minor(devnr)) < 0)
7af53310
LP
435 return -ENOMEM;
436
437 mkdir_parents(p, 0700);
438 mkfifo(p, 0600);
439
440 fd = open(p, O_RDONLY|O_CLOEXEC|O_NONBLOCK|O_NOCTTY);
441 free(p);
442
443 if (fd < 0)
444 return -errno;
445
446 return fd;
447}
448
0cf84693 449static bool wall_tty_match(const char *path) {
fc116c6a 450 int fd, k;
7af53310 451 char *p;
fc116c6a
LP
452 struct stat st;
453
454 if (path_is_absolute(path))
455 k = lstat(path, &st);
456 else {
457 if (asprintf(&p, "/dev/%s", path) < 0)
458 return true;
459
460 k = lstat(p, &st);
461 free(p);
462 }
463
464 if (k < 0)
465 return true;
466
467 if (!S_ISCHR(st.st_mode))
468 return true;
7af53310
LP
469
470 /* We use named pipes to ensure that wall messages suggesting
471 * password entry are not printed over password prompts
472 * already shown. We use the fact here that opening a pipe in
473 * non-blocking mode for write-only will succeed only if
474 * there's some writer behind it. Using pipes has the
475 * advantage that the block will automatically go away if the
476 * process dies. */
477
fc116c6a 478 if (asprintf(&p, "/dev/.systemd/ask-password-block/%u:%u", major(st.st_rdev), minor(st.st_rdev)) < 0)
7af53310
LP
479 return true;
480
481 fd = open(p, O_WRONLY|O_CLOEXEC|O_NONBLOCK|O_NOCTTY);
482 free(p);
483
484 if (fd < 0)
485 return true;
486
487 /* What, we managed to open the pipe? Then this tty is filtered. */
488 close_nointr_nofail(fd);
489 return false;
490}
491
ec863ba6
LP
492static int show_passwords(void) {
493 DIR *d;
494 struct dirent *de;
495 int r = 0;
496
497 if (!(d = opendir("/dev/.systemd/ask-password"))) {
498 if (errno == ENOENT)
499 return 0;
500
501 log_error("opendir(): %m");
502 return -errno;
503 }
504
505 while ((de = readdir(d))) {
506 char *p;
507 int q;
0ddf1d3a 508 char *wall;
ec863ba6
LP
509
510 if (de->d_type != DT_REG)
511 continue;
512
513 if (ignore_file(de->d_name))
514 continue;
515
516 if (!startswith(de->d_name, "ask."))
517 continue;
518
519 if (!(p = strappend("/dev/.systemd/ask-password/", de->d_name))) {
520 log_error("Out of memory");
521 r = -ENOMEM;
522 goto finish;
523 }
524
0ddf1d3a
LP
525 wall = NULL;
526 if ((q = parse_password(p, &wall)) < 0)
ec863ba6
LP
527 r = q;
528
529 free(p);
0ddf1d3a
LP
530
531 if (wall) {
0cf84693 532 utmp_wall(wall, wall_tty_match);
0ddf1d3a
LP
533 free(wall);
534 }
ec863ba6
LP
535 }
536
537finish:
538 if (d)
539 closedir(d);
540
541 return r;
542}
543
544static int watch_passwords(void) {
b9ba604e
LP
545 enum {
546 FD_INOTIFY,
547 FD_SIGNAL,
548 _FD_MAX
549 };
550
7af53310 551 int notify = -1, signal_fd = -1, tty_block_fd = -1;
b9ba604e
LP
552 struct pollfd pollfd[_FD_MAX];
553 sigset_t mask;
ec863ba6
LP
554 int r;
555
0cf84693 556 tty_block_fd = wall_tty_block();
7af53310 557
ec863ba6
LP
558 mkdir_p("/dev/.systemd/ask-password", 0755);
559
560 if ((notify = inotify_init1(IN_CLOEXEC)) < 0) {
561 r = -errno;
562 goto finish;
563 }
564
565 if (inotify_add_watch(notify, "/dev/.systemd/ask-password", IN_CLOSE_WRITE|IN_MOVED_TO) < 0) {
566 r = -errno;
567 goto finish;
568 }
569
b9ba604e
LP
570 assert_se(sigemptyset(&mask) == 0);
571 sigset_add_many(&mask, SIGINT, SIGTERM, -1);
572 assert_se(sigprocmask(SIG_SETMASK, &mask, NULL) == 0);
573
574 if ((signal_fd = signalfd(-1, &mask, SFD_NONBLOCK|SFD_CLOEXEC)) < 0) {
575 log_error("signalfd(): %m");
576 r = -errno;
577 goto finish;
578 }
579
ec863ba6 580 zero(pollfd);
b9ba604e
LP
581 pollfd[FD_INOTIFY].fd = notify;
582 pollfd[FD_INOTIFY].events = POLLIN;
583 pollfd[FD_SIGNAL].fd = signal_fd;
584 pollfd[FD_SIGNAL].events = POLLIN;
ec863ba6
LP
585
586 for (;;) {
587 if ((r = show_passwords()) < 0)
0cf84693 588 log_error("Failed to show password: %s", strerror(-r));
ec863ba6 589
b9ba604e 590 if (poll(pollfd, _FD_MAX, -1) < 0) {
ec863ba6
LP
591
592 if (errno == EINTR)
593 continue;
594
595 r = -errno;
596 goto finish;
597 }
598
b9ba604e 599 if (pollfd[FD_INOTIFY].revents != 0)
ec863ba6 600 flush_fd(notify);
b9ba604e
LP
601
602 if (pollfd[FD_SIGNAL].revents != 0)
603 break;
ec863ba6
LP
604 }
605
606 r = 0;
607
608finish:
609 if (notify >= 0)
610 close_nointr_nofail(notify);
611
b9ba604e
LP
612 if (signal_fd >= 0)
613 close_nointr_nofail(signal_fd);
614
7af53310
LP
615 if (tty_block_fd >= 0)
616 close_nointr_nofail(tty_block_fd);
617
ec863ba6
LP
618 return r;
619}
620
621static int help(void) {
622
623 printf("%s [OPTIONS...]\n\n"
624 "Process system password requests.\n\n"
e5ebf783
LP
625 " -h --help Show this help\n"
626 " --list Show pending password requests\n"
627 " --query Process pending password requests\n"
628 " --watch Continously process password requests\n"
629 " --wall Continously forward password requests to wall\n"
0cf84693
LP
630 " --plymouth Ask question with Plymouth instead of on TTY\n"
631 " --console Ask question on /dev/console instead of current TTY\n",
ec863ba6
LP
632 program_invocation_short_name);
633
634 return 0;
635}
636
637static int parse_argv(int argc, char *argv[]) {
638
639 enum {
640 ARG_LIST = 0x100,
641 ARG_QUERY,
642 ARG_WATCH,
643 ARG_WALL,
0cf84693
LP
644 ARG_PLYMOUTH,
645 ARG_CONSOLE
ec863ba6
LP
646 };
647
648 static const struct option options[] = {
e5ebf783
LP
649 { "help", no_argument, NULL, 'h' },
650 { "list", no_argument, NULL, ARG_LIST },
651 { "query", no_argument, NULL, ARG_QUERY },
652 { "watch", no_argument, NULL, ARG_WATCH },
653 { "wall", no_argument, NULL, ARG_WALL },
654 { "plymouth", no_argument, NULL, ARG_PLYMOUTH },
0cf84693 655 { "console", no_argument, NULL, ARG_CONSOLE },
e5ebf783 656 { NULL, 0, NULL, 0 }
ec863ba6
LP
657 };
658
659 int c;
660
661 assert(argc >= 0);
662 assert(argv);
663
664 while ((c = getopt_long(argc, argv, "h", options, NULL)) >= 0) {
665
666 switch (c) {
667
668 case 'h':
669 help();
670 return 0;
671
672 case ARG_LIST:
673 arg_action = ACTION_LIST;
674 break;
675
676 case ARG_QUERY:
677 arg_action = ACTION_QUERY;
678 break;
679
680 case ARG_WATCH:
681 arg_action = ACTION_WATCH;
682 break;
683
684 case ARG_WALL:
685 arg_action = ACTION_WALL;
686 break;
687
e5ebf783
LP
688 case ARG_PLYMOUTH:
689 arg_plymouth = true;
690 break;
691
0cf84693
LP
692 case ARG_CONSOLE:
693 arg_console = true;
694 break;
695
ec863ba6
LP
696 case '?':
697 return -EINVAL;
698
699 default:
700 log_error("Unknown option code %c", c);
701 return -EINVAL;
702 }
703 }
704
705 if (optind != argc) {
706 help();
707 return -EINVAL;
708 }
709
710 return 1;
711}
712
713int main(int argc, char *argv[]) {
714 int r;
715
716 log_parse_environment();
717 log_open();
718
719 if ((r = parse_argv(argc, argv)) <= 0)
720 goto finish;
721
0cf84693
LP
722 if (arg_console) {
723 setsid();
724 release_terminal();
725 }
726
ec863ba6
LP
727 if (arg_action == ACTION_WATCH ||
728 arg_action == ACTION_WALL)
729 r = watch_passwords();
730 else
731 r = show_passwords();
732
96707269
LP
733 if (r < 0)
734 log_error("Error: %s", strerror(-r));
735
ec863ba6
LP
736finish:
737 return r < 0 ? EXIT_FAILURE : EXIT_SUCCESS;
738}