]> git.ipfire.org Git - thirdparty/systemd.git/blame - src/shared/ask-password-api.c
mkosi: update arch commit reference
[thirdparty/systemd.git] / src / shared / ask-password-api.c
CommitLineData
db9ecf05 1/* SPDX-License-Identifier: LGPL-2.1-or-later */
00843602 2
7f4e0805
LP
3#include <errno.h>
4#include <fcntl.h>
a8fbdf54
TA
5#include <inttypes.h>
6#include <limits.h>
00843602 7#include <stdbool.h>
7f4e0805 8#include <stddef.h>
a8fbdf54
TA
9#include <stdint.h>
10#include <stdio.h>
11#include <stdlib.h>
00843602 12#include <sys/inotify.h>
7f4e0805 13#include <sys/signalfd.h>
a8fbdf54
TA
14#include <sys/stat.h>
15#include <sys/time.h>
16#include <sys/uio.h>
00843602
LP
17#include <sys/un.h>
18#include <termios.h>
19#include <unistd.h>
7f4e0805 20
b5efdb8a 21#include "alloc-util.h"
b7120388 22#include "ansi-color.h"
3ffd4af2 23#include "ask-password-api.h"
8806bb4b 24#include "creds-util.h"
3ffd4af2 25#include "fd-util.h"
0d39fa9c 26#include "fileio.h"
f97b34a6 27#include "format-util.h"
c7b7d74e 28#include "fs-util.h"
d8e32c47 29#include "glyph-util.h"
c004493c 30#include "io-util.h"
bd1ae178 31#include "iovec-util.h"
cbae575e 32#include "keyring-util.h"
a8fbdf54
TA
33#include "log.h"
34#include "macro.h"
0a970718 35#include "memory-util.h"
f5947a5e 36#include "missing_syscall.h"
35cd0ba5 37#include "mkdir-label.h"
08af3cc5 38#include "nulstr-util.h"
aa25e19b 39#include "plymouth-util.h"
df0ff127 40#include "process-util.h"
3df3e884 41#include "random-util.h"
24882e06 42#include "signal-util.h"
00843602 43#include "socket-util.h"
07630cea 44#include "string-util.h"
00843602
LP
45#include "strv.h"
46#include "terminal-util.h"
a8fbdf54 47#include "time-util.h"
e4de7287 48#include "tmpfile-util.h"
affb60b1 49#include "umask-util.h"
f3149d57 50#include "utf8.h"
7f4e0805 51
e287086b
LP
52#define KEYRING_TIMEOUT_USEC ((5 * USEC_PER_MINUTE) / 2)
53
54static int lookup_key(const char *keyname, key_serial_t *ret) {
55 key_serial_t serial;
56
57 assert(keyname);
58 assert(ret);
59
60 serial = request_key("user", keyname, NULL, 0);
61 if (serial == -1)
9c4615fb 62 return negative_errno();
e287086b
LP
63
64 *ret = serial;
65 return 0;
66}
67
68static int retrieve_key(key_serial_t serial, char ***ret) {
cbae575e 69 _cleanup_(erase_and_freep) void *p = NULL;
e287086b 70 char **l;
cbae575e
LP
71 size_t n;
72 int r;
e287086b
LP
73
74 assert(ret);
75
cbae575e
LP
76 r = keyring_read(serial, &p, &n);
77 if (r < 0)
78 return r;
79
80 l = strv_parse_nulstr(p, n);
e287086b
LP
81 if (!l)
82 return -ENOMEM;
83
84 *ret = l;
85 return 0;
86}
87
88static int add_to_keyring(const char *keyname, AskPasswordFlags flags, char **passwords) {
ab84f5b9 89 _cleanup_strv_free_erase_ char **l = NULL;
e693a932 90 _cleanup_(erase_and_freep) char *p = NULL;
e287086b
LP
91 key_serial_t serial;
92 size_t n;
93 int r;
94
95 assert(keyname);
e287086b 96
9cb5bf91 97 if (!FLAGS_SET(flags, ASK_PASSWORD_PUSH_CACHE))
e287086b 98 return 0;
e013e10d
LP
99 if (strv_isempty(passwords))
100 return 0;
e287086b
LP
101
102 r = lookup_key(keyname, &serial);
103 if (r >= 0) {
104 r = retrieve_key(serial, &l);
105 if (r < 0)
106 return r;
107 } else if (r != -ENOKEY)
108 return r;
109
110 r = strv_extend_strv(&l, passwords, true);
111 if (r <= 0)
112 return r;
113
114 r = strv_make_nulstr(l, &p, &n);
115 if (r < 0)
116 return r;
117
76078ad8
LP
118 /* chop off the final NUL byte. We do this because we want to use the separator NUL bytes only if we
119 * have multiple passwords. */
120 n = LESS_BY(n, (size_t) 1);
121
b60df13b 122 serial = add_key("user", keyname, p, n, KEY_SPEC_USER_KEYRING);
e287086b
LP
123 if (serial == -1)
124 return -errno;
125
126 if (keyctl(KEYCTL_SET_TIMEOUT,
127 (unsigned long) serial,
128 (unsigned long) DIV_ROUND_UP(KEYRING_TIMEOUT_USEC, USEC_PER_SEC), 0, 0) < 0)
e3ac53a2 129 log_debug_errno(errno, "Failed to adjust kernel keyring key timeout: %m");
e287086b 130
c7b7d74e
XF
131 /* Tell everyone to check the keyring */
132 (void) touch("/run/systemd/ask-password");
133
e3ac53a2 134 log_debug("Added key to kernel keyring as %" PRIi32 ".", serial);
e287086b
LP
135
136 return 1;
137}
138
139static int add_to_keyring_and_log(const char *keyname, AskPasswordFlags flags, char **passwords) {
140 int r;
141
142 assert(keyname);
e287086b
LP
143
144 r = add_to_keyring(keyname, flags, passwords);
145 if (r < 0)
e3ac53a2 146 return log_debug_errno(r, "Failed to add password to kernel keyring: %m");
e287086b
LP
147
148 return 0;
149}
150
d08fd4c3 151static int ask_password_keyring(const AskPasswordRequest *req, AskPasswordFlags flags, char ***ret) {
e287086b
LP
152 key_serial_t serial;
153 int r;
154
d08fd4c3 155 assert(req);
e287086b
LP
156 assert(ret);
157
9cb5bf91 158 if (!FLAGS_SET(flags, ASK_PASSWORD_ACCEPT_CACHED))
e287086b
LP
159 return -EUNATCH;
160
d08fd4c3 161 r = lookup_key(req->keyring, &serial);
bb44fd07
ZJS
162 if (ERRNO_IS_NEG_NOT_SUPPORTED(r) || r == -EPERM)
163 /* When retrieving, the distinction between "kernel or container manager don't support or
164 * allow this" and "no matching key known" doesn't matter. Note that we propagate EACCESS
165 * here (even if EPERM not) since that is used if the keyring is available, but we lack
166 * access to the key. */
167 return -ENOKEY;
168 if (r < 0)
e287086b
LP
169 return r;
170
623a8b19
YW
171 _cleanup_strv_free_erase_ char **l = NULL;
172 r = retrieve_key(serial, &l);
173 if (r < 0)
174 return r;
175
176 if (strv_isempty(l))
177 return log_debug_errno(SYNTHETIC_ERRNO(ENOKEY), "Found an empty password from keyring.");
178
179 *ret = TAKE_PTR(l);
180 return 0;
e287086b
LP
181}
182
8e9d1eec 183static int backspace_chars(int ttyfd, size_t p) {
58fc840b 184 if (ttyfd < 0)
8e9d1eec 185 return 0;
58fc840b 186
8e9d1eec
ZJS
187 _cleanup_free_ char *buf = malloc_multiply(3, p);
188 if (!buf)
189 return log_oom();
58fc840b 190
8e9d1eec
ZJS
191 for (size_t i = 0; i < p; i++)
192 memcpy(buf + 3 * i, "\b \b", 3);
58fc840b 193
e22c60a9 194 return loop_write(ttyfd, buf, 3 * p);
8e9d1eec 195}
fd6ac62c 196
8e9d1eec 197static int backspace_string(int ttyfd, const char *str) {
fd6ac62c
LP
198 assert(str);
199
f95dbcc2 200 /* Backspaces through enough characters to entirely undo printing of the specified string. */
fd6ac62c 201
8e9d1eec
ZJS
202 if (ttyfd < 0)
203 return 0;
204
205 size_t m = utf8_n_codepoints(str);
f5fbe71d 206 if (m == SIZE_MAX)
8e9d1eec 207 m = strlen(str); /* Not a valid UTF-8 string? If so, let's backspace the number of bytes
5bc9ea07 208 * output. Most likely this happened because we are not in a UTF-8 locale,
8e9d1eec
ZJS
209 * and in that case that is the correct thing to do. And even if it's not,
210 * terminals tend to stop backspacing at the leftmost column, hence
211 * backspacing too much should be mostly OK. */
fd6ac62c 212
8e9d1eec 213 return backspace_chars(ttyfd, m);
fd6ac62c
LP
214}
215
6b2faba7 216int ask_password_plymouth(
d08fd4c3 217 const AskPasswordRequest *req,
6b2faba7
FB
218 usec_t until,
219 AskPasswordFlags flags,
220 const char *flag_file,
221 char ***ret) {
222
254d1313 223 _cleanup_close_ int fd = -EBADF, notify = -EBADF;
6b2faba7
FB
224 _cleanup_free_ char *packet = NULL;
225 ssize_t k;
226 int r, n;
227 struct pollfd pollfd[2] = {};
228 char buffer[LINE_MAX];
229 size_t p = 0;
230 enum {
231 POLL_SOCKET,
232 POLL_INOTIFY
233 };
234
235 assert(ret);
236
b2ac9280
LP
237 if (FLAGS_SET(flags, ASK_PASSWORD_HEADLESS))
238 return -ENOEXEC;
239
d08fd4c3 240 const char *message = req && req->message ? req->message : "Password:";
66bff73b 241
6b2faba7
FB
242 if (flag_file) {
243 notify = inotify_init1(IN_CLOEXEC|IN_NONBLOCK);
244 if (notify < 0)
245 return -errno;
246
108dfff2 247 if (inotify_add_watch(notify, flag_file, IN_ATTRIB) < 0) /* for the link count */
6b2faba7
FB
248 return -errno;
249 }
250
aa25e19b 251 fd = plymouth_connect(SOCK_NONBLOCK);
6b2faba7 252 if (fd < 0)
aa25e19b 253 return fd;
6b2faba7 254
9cb5bf91 255 if (FLAGS_SET(flags, ASK_PASSWORD_ACCEPT_CACHED)) {
6b2faba7
FB
256 packet = strdup("c");
257 n = 1;
258 } else if (asprintf(&packet, "*\002%c%s%n", (int) (strlen(message) + 1), message, &n) < 0)
259 packet = NULL;
260 if (!packet)
261 return -ENOMEM;
262
e22c60a9 263 r = loop_write_full(fd, packet, n + 1, USEC_INFINITY);
6b2faba7
FB
264 if (r < 0)
265 return r;
266
692597c8
LP
267 CLEANUP_ERASE(buffer);
268
6b2faba7
FB
269 pollfd[POLL_SOCKET].fd = fd;
270 pollfd[POLL_SOCKET].events = POLLIN;
271 pollfd[POLL_INOTIFY].fd = notify;
272 pollfd[POLL_INOTIFY].events = POLLIN;
273
274 for (;;) {
d9e2af0a 275 usec_t timeout;
6b2faba7 276
d9e2af0a
YW
277 if (until > 0)
278 timeout = usec_sub_unsigned(until, now(CLOCK_MONOTONIC));
279 else
280 timeout = USEC_INFINITY;
6b2faba7 281
692597c8
LP
282 if (flag_file && access(flag_file, F_OK) < 0)
283 return -errno;
6b2faba7 284
d9e2af0a
YW
285 r = ppoll_usec(pollfd, notify >= 0 ? 2 : 1, timeout);
286 if (r == -EINTR)
287 continue;
288 if (r < 0)
692597c8
LP
289 return r;
290 if (r == 0)
291 return -ETIME;
6b2faba7
FB
292
293 if (notify >= 0 && pollfd[POLL_INOTIFY].revents != 0)
294 (void) flush_fd(notify);
295
296 if (pollfd[POLL_SOCKET].revents == 0)
297 continue;
298
299 k = read(fd, buffer + p, sizeof(buffer) - p);
300 if (k < 0) {
8add30a0 301 if (ERRNO_IS_TRANSIENT(errno))
6b2faba7
FB
302 continue;
303
692597c8 304 return -errno;
6b2faba7 305 }
692597c8
LP
306 if (k == 0)
307 return -EIO;
6b2faba7
FB
308
309 p += k;
310
6b2faba7
FB
311 if (buffer[0] == 5) {
312
9cb5bf91 313 if (FLAGS_SET(flags, ASK_PASSWORD_ACCEPT_CACHED)) {
6b2faba7
FB
314 /* Hmm, first try with cached
315 * passwords failed, so let's retry
316 * with a normal password request */
317 packet = mfree(packet);
318
692597c8
LP
319 if (asprintf(&packet, "*\002%c%s%n", (int) (strlen(message) + 1), message, &n) < 0)
320 return -ENOMEM;
6b2faba7 321
e22c60a9 322 r = loop_write_full(fd, packet, n + 1, USEC_INFINITY);
6b2faba7 323 if (r < 0)
692597c8 324 return r;
6b2faba7
FB
325
326 flags &= ~ASK_PASSWORD_ACCEPT_CACHED;
327 p = 0;
328 continue;
329 }
330
331 /* No password, because UI not shown */
692597c8 332 return -ENOENT;
6b2faba7
FB
333
334 } else if (IN_SET(buffer[0], 2, 9)) {
623a8b19 335 _cleanup_strv_free_erase_ char **l = NULL;
6b2faba7 336 uint32_t size;
6b2faba7
FB
337
338 /* One or more answers */
339 if (p < 5)
340 continue;
341
342 memcpy(&size, buffer+1, sizeof(size));
343 size = le32toh(size);
692597c8
LP
344 if (size + 5 > sizeof(buffer))
345 return -EIO;
6b2faba7
FB
346
347 if (p-5 < size)
348 continue;
349
350 l = strv_parse_nulstr(buffer + 5, size);
692597c8
LP
351 if (!l)
352 return -ENOMEM;
6b2faba7 353
623a8b19
YW
354 if (strv_isempty(l))
355 return log_debug_errno(SYNTHETIC_ERRNO(ECANCELED), "Received an empty password.");
356
357 *ret = TAKE_PTR(l);
358 return 0;
6b2faba7 359
692597c8 360 } else
6b2faba7 361 /* Unknown packet */
692597c8 362 return -EIO;
6b2faba7 363 }
6b2faba7
FB
364}
365
8aaf18e0
ZJS
366#define NO_ECHO "(no echo) "
367#define PRESS_TAB "(press TAB for no echo) "
368#define SKIPPED "(skipped)"
369
7f4e0805 370int ask_password_tty(
daa55720 371 int ttyfd,
d08fd4c3 372 const AskPasswordRequest *req,
7f4e0805 373 usec_t until,
e287086b 374 AskPasswordFlags flags,
7f4e0805 375 const char *flag_file,
c7b7d74e 376 char ***ret) {
7f4e0805 377
088dcd8e
LP
378 enum {
379 POLL_TTY,
380 POLL_INOTIFY,
381 _POLL_MAX,
382 };
383
8aaf18e0 384 bool reset_tty = false, dirty = false, use_color = false, press_tab_visible = false;
254d1313 385 _cleanup_close_ int cttyfd = -EBADF, notify = -EBADF;
7f4e0805 386 struct termios old_termios, new_termios;
f3149d57 387 char passphrase[LINE_MAX + 1] = {}, *x;
c7b7d74e 388 _cleanup_strv_free_erase_ char **l = NULL;
088dcd8e 389 struct pollfd pollfd[_POLL_MAX];
f3149d57 390 size_t p = 0, codepoint = 0;
088dcd8e 391 int r;
7f4e0805 392
e287086b
LP
393 assert(ret);
394
b2ac9280
LP
395 if (FLAGS_SET(flags, ASK_PASSWORD_HEADLESS))
396 return -ENOEXEC;
397
9cb5bf91 398 if (FLAGS_SET(flags, ASK_PASSWORD_NO_TTY))
e287086b
LP
399 return -EUNATCH;
400
d08fd4c3
LP
401 const char *message = req && req->message ? req->message : "Password:";
402 const char *keyring = req ? req->keyring : NULL;
7f4e0805 403
e390c34d 404 if (!FLAGS_SET(flags, ASK_PASSWORD_HIDE_EMOJI) && emoji_enabled())
52d199e3
LP
405 message = strjoina(special_glyph(SPECIAL_GLYPH_LOCK_AND_KEY), " ", message);
406
d08fd4c3 407 if (flag_file || (FLAGS_SET(flags, ASK_PASSWORD_ACCEPT_CACHED) && keyring)) {
981e4cd3 408 notify = inotify_init1(IN_CLOEXEC|IN_NONBLOCK);
a497a296
LP
409 if (notify < 0)
410 return -errno;
c7b7d74e
XF
411 }
412 if (flag_file) {
a497a296
LP
413 if (inotify_add_watch(notify, flag_file, IN_ATTRIB /* for the link count */) < 0)
414 return -errno;
7f4e0805 415 }
d08fd4c3
LP
416 if (FLAGS_SET(flags, ASK_PASSWORD_ACCEPT_CACHED) && req && keyring) {
417 r = ask_password_keyring(req, flags, ret);
c7b7d74e
XF
418 if (r >= 0)
419 return 0;
420 else if (r != -ENOKEY)
421 return r;
422
423 if (inotify_add_watch(notify, "/run/systemd/ask-password", IN_ATTRIB /* for mtime */) < 0)
424 return -errno;
425 }
7f4e0805 426
692597c8
LP
427 CLEANUP_ERASE(passphrase);
428
daa55720
LP
429 /* If the caller didn't specify a TTY, then use the controlling tty, if we can. */
430 if (ttyfd < 0)
431 ttyfd = cttyfd = open("/dev/tty", O_RDWR|O_NOCTTY|O_CLOEXEC);
7f4e0805 432
daa55720 433 if (ttyfd >= 0) {
a497a296
LP
434 if (tcgetattr(ttyfd, &old_termios) < 0)
435 return -errno;
7f4e0805 436
9cb5bf91 437 if (FLAGS_SET(flags, ASK_PASSWORD_CONSOLE_COLOR))
c2b32159
LP
438 use_color = dev_console_colors_enabled();
439 else
440 use_color = colors_enabled();
441
442 if (use_color)
e22c60a9 443 (void) loop_write(ttyfd, ANSI_HIGHLIGHT, SIZE_MAX);
ac7a9674 444
e22c60a9
MY
445 (void) loop_write(ttyfd, message, SIZE_MAX);
446 (void) loop_write(ttyfd, " ", 1);
ac7a9674 447
9cb5bf91 448 if (!FLAGS_SET(flags, ASK_PASSWORD_SILENT) && !FLAGS_SET(flags, ASK_PASSWORD_ECHO)) {
8aaf18e0 449 if (use_color)
e22c60a9
MY
450 (void) loop_write(ttyfd, ansi_grey(), SIZE_MAX);
451
452 (void) loop_write(ttyfd, PRESS_TAB, SIZE_MAX);
8aaf18e0
ZJS
453 press_tab_visible = true;
454 }
455
c2b32159 456 if (use_color)
e22c60a9 457 (void) loop_write(ttyfd, ANSI_NORMAL, SIZE_MAX);
7f4e0805
LP
458
459 new_termios = old_termios;
d02d4f83 460 termios_disable_echo(&new_termios);
7f4e0805 461
108dfff2
LP
462 r = RET_NERRNO(tcsetattr(ttyfd, TCSADRAIN, &new_termios));
463 if (r < 0)
7f4e0805 464 goto finish;
7f4e0805
LP
465
466 reset_tty = true;
467 }
468
70dee475
LP
469 pollfd[POLL_TTY] = (struct pollfd) {
470 .fd = ttyfd >= 0 ? ttyfd : STDIN_FILENO,
471 .events = POLLIN,
472 };
473 pollfd[POLL_INOTIFY] = (struct pollfd) {
474 .fd = notify,
475 .events = POLLIN,
476 };
7f4e0805
LP
477
478 for (;;) {
e1ed99c8 479 _cleanup_(erase_char) char c;
d9e2af0a 480 usec_t timeout;
7f4e0805
LP
481 ssize_t n;
482
d9e2af0a
YW
483 if (until > 0)
484 timeout = usec_sub_unsigned(until, now(CLOCK_MONOTONIC));
485 else
486 timeout = USEC_INFINITY;
7f4e0805 487
108dfff2
LP
488 if (flag_file) {
489 r = RET_NERRNO(access(flag_file, F_OK));
490 if (r < 0)
7f4e0805 491 goto finish;
108dfff2 492 }
7f4e0805 493
d9e2af0a
YW
494 r = ppoll_usec(pollfd, notify >= 0 ? 2 : 1, timeout);
495 if (r == -EINTR)
496 continue;
497 if (r < 0)
7f4e0805 498 goto finish;
d9e2af0a 499 if (r == 0) {
ccc80078 500 r = -ETIME;
7f4e0805
LP
501 goto finish;
502 }
503
d08fd4c3 504 if (notify >= 0 && pollfd[POLL_INOTIFY].revents != 0 && keyring) {
665dfe93 505 (void) flush_fd(notify);
7f4e0805 506
d08fd4c3 507 r = ask_password_keyring(req, flags, ret);
c7b7d74e
XF
508 if (r >= 0) {
509 r = 0;
510 goto finish;
511 } else if (r != -ENOKEY)
512 goto finish;
513 }
514
7f4e0805
LP
515 if (pollfd[POLL_TTY].revents == 0)
516 continue;
517
981e4cd3
LP
518 n = read(ttyfd >= 0 ? ttyfd : STDIN_FILENO, &c, 1);
519 if (n < 0) {
8add30a0 520 if (ERRNO_IS_TRANSIENT(errno))
7f4e0805
LP
521 continue;
522
523 r = -errno;
524 goto finish;
525
fd6ac62c 526 }
7f4e0805 527
8aaf18e0
ZJS
528 if (press_tab_visible) {
529 assert(ttyfd >= 0);
530 backspace_chars(ttyfd, strlen(PRESS_TAB));
531 press_tab_visible = false;
532 }
533
fd6ac62c
LP
534 /* We treat EOF, newline and NUL byte all as valid end markers */
535 if (n == 0 || c == '\n' || c == 0)
7f4e0805 536 break;
fd6ac62c 537
d325f244
FB
538 if (c == 4) { /* C-d also known as EOT */
539 if (ttyfd >= 0)
e22c60a9 540 (void) loop_write(ttyfd, SKIPPED, SIZE_MAX);
d325f244
FB
541
542 goto skipped;
543 }
544
fd6ac62c 545 if (c == 21) { /* C-u */
7f4e0805 546
9cb5bf91 547 if (!FLAGS_SET(flags, ASK_PASSWORD_SILENT))
8e9d1eec 548 (void) backspace_string(ttyfd, passphrase);
fd6ac62c 549
87f54463 550 explicit_bzero_safe(passphrase, sizeof(passphrase));
fd6ac62c 551 p = codepoint = 0;
7f4e0805 552
4c701096 553 } else if (IN_SET(c, '\b', 127)) {
58fc840b
LP
554
555 if (p > 0) {
fd6ac62c 556 size_t q;
58fc840b 557
9cb5bf91 558 if (!FLAGS_SET(flags, ASK_PASSWORD_SILENT))
8e9d1eec 559 (void) backspace_chars(ttyfd, 1);
58fc840b 560
92e068b4
ZJS
561 /* Remove a full UTF-8 codepoint from the end. For that, figure out where the
562 * last one begins */
fd6ac62c
LP
563 q = 0;
564 for (;;) {
37ca78a3 565 int z;
fd6ac62c 566
f5fbe71d 567 z = utf8_encoded_valid_unichar(passphrase + q, SIZE_MAX);
37ca78a3 568 if (z <= 0) {
f5fbe71d 569 q = SIZE_MAX; /* Invalid UTF8! */
fd6ac62c
LP
570 break;
571 }
572
573 if (q + z >= p) /* This one brings us over the edge */
574 break;
575
576 q += z;
577 }
578
f5fbe71d 579 p = codepoint = q == SIZE_MAX ? p - 1 : q;
87f54463 580 explicit_bzero_safe(passphrase + p, sizeof(passphrase) - p);
fd6ac62c 581
9cb5bf91 582 } else if (!dirty && !FLAGS_SET(flags, ASK_PASSWORD_SILENT)) {
441dfe09 583
e287086b 584 flags |= ASK_PASSWORD_SILENT;
441dfe09 585
92e068b4
ZJS
586 /* There are two ways to enter silent mode. Either by pressing backspace as
587 * first key (and only as first key), or ... */
fd6ac62c 588
441dfe09 589 if (ttyfd >= 0)
e22c60a9 590 (void) loop_write(ttyfd, NO_ECHO, SIZE_MAX);
441dfe09 591
58fc840b 592 } else if (ttyfd >= 0)
e22c60a9 593 (void) loop_write(ttyfd, "\a", 1);
7f4e0805 594
9cb5bf91 595 } else if (c == '\t' && !FLAGS_SET(flags, ASK_PASSWORD_SILENT)) {
58fc840b 596
8e9d1eec 597 (void) backspace_string(ttyfd, passphrase);
e287086b 598 flags |= ASK_PASSWORD_SILENT;
58fc840b 599
441dfe09
LP
600 /* ... or by pressing TAB at any time. */
601
58fc840b 602 if (ttyfd >= 0)
e22c60a9 603 (void) loop_write(ttyfd, NO_ECHO, SIZE_MAX);
036eeac5 604
fd6ac62c
LP
605 } else if (p >= sizeof(passphrase)-1) {
606
607 /* Reached the size limit */
608 if (ttyfd >= 0)
e22c60a9 609 (void) loop_write(ttyfd, "\a", 1);
fd6ac62c
LP
610
611 } else {
7f4e0805
LP
612 passphrase[p++] = c;
613
9cb5bf91 614 if (!FLAGS_SET(flags, ASK_PASSWORD_SILENT) && ttyfd >= 0) {
fd6ac62c 615 /* Check if we got a complete UTF-8 character now. If so, let's output one '*'. */
f5fbe71d 616 n = utf8_encoded_valid_unichar(passphrase + codepoint, SIZE_MAX);
f3149d57 617 if (n >= 0) {
9cb5bf91 618 if (FLAGS_SET(flags, ASK_PASSWORD_ECHO))
e22c60a9 619 (void) loop_write(ttyfd, passphrase + codepoint, n);
d26eef92 620 else
e22c60a9
MY
621 (void) loop_write(ttyfd,
622 special_glyph(SPECIAL_GLYPH_BULLET),
623 SIZE_MAX);
f3149d57 624 codepoint = p;
f3149d57
ZJS
625 }
626 }
441dfe09
LP
627
628 dirty = true;
7f4e0805
LP
629 }
630 }
631
981e4cd3
LP
632 x = strndup(passphrase, p);
633 if (!x) {
7f4e0805
LP
634 r = -ENOMEM;
635 goto finish;
636 }
637
0e28c86f
LP
638 r = strv_consume(&l, x);
639 if (r < 0)
c7b7d74e 640 goto finish;
c7b7d74e 641
d325f244 642skipped:
72c08a47
ZJS
643 if (strv_isempty(l))
644 r = log_debug_errno(SYNTHETIC_ERRNO(ECANCELED), "Password query was cancelled.");
645 else {
d08fd4c3
LP
646 if (keyring)
647 (void) add_to_keyring_and_log(keyring, flags, l);
72c08a47
ZJS
648
649 *ret = TAKE_PTR(l);
650 r = 0;
651 }
7f4e0805
LP
652
653finish:
981e4cd3 654 if (ttyfd >= 0 && reset_tty) {
e22c60a9 655 (void) loop_write(ttyfd, "\n", 1);
ac7a9674 656 (void) tcsetattr(ttyfd, TCSADRAIN, &old_termios);
7f4e0805
LP
657 }
658
659 return r;
660}
661
15a3e96f
LP
662static int create_socket(char **ret) {
663 _cleanup_free_ char *path = NULL;
f36a9d59
ZJS
664 union sockaddr_union sa;
665 socklen_t sa_len;
254d1313 666 _cleanup_close_ int fd = -EBADF;
f36a9d59 667 int r;
7f4e0805 668
15a3e96f 669 assert(ret);
7f4e0805 670
e62d8c39 671 fd = socket(AF_UNIX, SOCK_DGRAM|SOCK_CLOEXEC|SOCK_NONBLOCK, 0);
4a62c710 672 if (fd < 0)
00843602 673 return -errno;
7f4e0805 674
15a3e96f
LP
675 if (asprintf(&path, "/run/systemd/ask-password/sck.%" PRIx64, random_u64()) < 0)
676 return -ENOMEM;
677
f36a9d59
ZJS
678 r = sockaddr_un_set_path(&sa.un, path);
679 if (r < 0)
680 return r;
681 sa_len = r;
7f4e0805 682
2053593f 683 WITH_UMASK(0177)
f36a9d59 684 if (bind(fd, &sa.sa, sa_len) < 0)
00843602 685 return -errno;
1d6702e8 686
2ff48e98
LP
687 r = setsockopt_int(fd, SOL_SOCKET, SO_PASSCRED, true);
688 if (r < 0)
689 return r;
7f4e0805 690
15a3e96f
LP
691 *ret = TAKE_PTR(path);
692 return TAKE_FD(fd);
7f4e0805
LP
693}
694
7f4e0805 695int ask_password_agent(
d08fd4c3 696 const AskPasswordRequest *req,
7f4e0805 697 usec_t until,
e287086b
LP
698 AskPasswordFlags flags,
699 char ***ret) {
7f4e0805
LP
700
701 enum {
702 FD_SOCKET,
703 FD_SIGNAL,
c7b7d74e 704 FD_INOTIFY,
7f4e0805
LP
705 _FD_MAX
706 };
707
254d1313 708 _cleanup_close_ int socket_fd = -EBADF, signal_fd = -EBADF, notify = -EBADF, fd = -EBADF;
2b583ce6 709 char temp[] = "/run/systemd/ask-password/tmp.XXXXXX";
7f4e0805 710 char final[sizeof(temp)] = "";
981e4cd3 711 _cleanup_free_ char *socket_name = NULL;
c7b7d74e 712 _cleanup_strv_free_erase_ char **l = NULL;
e287086b 713 _cleanup_fclose_ FILE *f = NULL;
7f4e0805 714 struct pollfd pollfd[_FD_MAX];
e287086b 715 sigset_t mask, oldmask;
981e4cd3 716 int r;
7f4e0805 717
e287086b 718 assert(ret);
21bc923a 719
b2ac9280
LP
720 if (FLAGS_SET(flags, ASK_PASSWORD_HEADLESS))
721 return -ENOEXEC;
722
9cb5bf91 723 if (FLAGS_SET(flags, ASK_PASSWORD_NO_AGENT))
e287086b 724 return -EUNATCH;
00843602 725
72c0a2c2 726 assert_se(sigemptyset(&mask) >= 0);
db7136ec 727 assert_se(sigset_add_many(&mask, SIGINT, SIGTERM) >= 0);
72c0a2c2 728 assert_se(sigprocmask(SIG_BLOCK, &mask, &oldmask) >= 0);
f9b72cd8 729
00843602 730 (void) mkdir_p_label("/run/systemd/ask-password", 0755);
7f4e0805 731
d08fd4c3
LP
732 if (FLAGS_SET(flags, ASK_PASSWORD_ACCEPT_CACHED) && req && req->keyring) {
733 r = ask_password_keyring(req, flags, ret);
c7b7d74e
XF
734 if (r >= 0) {
735 r = 0;
736 goto finish;
737 } else if (r != -ENOKEY)
738 goto finish;
739
740 notify = inotify_init1(IN_CLOEXEC | IN_NONBLOCK);
741 if (notify < 0) {
742 r = -errno;
743 goto finish;
744 }
108dfff2
LP
745
746 r = RET_NERRNO(inotify_add_watch(notify, "/run/systemd/ask-password", IN_ATTRIB /* for mtime */));
747 if (r < 0)
c7b7d74e 748 goto finish;
c7b7d74e
XF
749 }
750
646853bd 751 fd = mkostemp_safe(temp);
1d6702e8 752 if (fd < 0) {
709f6e46 753 r = fd;
7f4e0805
LP
754 goto finish;
755 }
756
00843602 757 (void) fchmod(fd, 0644);
7f4e0805 758
4fa744a3 759 f = take_fdopen(&fd, "w");
981e4cd3 760 if (!f) {
00843602 761 r = -errno;
7f4e0805
LP
762 goto finish;
763 }
764
981e4cd3
LP
765 signal_fd = signalfd(-1, &mask, SFD_NONBLOCK|SFD_CLOEXEC);
766 if (signal_fd < 0) {
00843602 767 r = -errno;
7f4e0805
LP
768 goto finish;
769 }
770
981e4cd3
LP
771 socket_fd = create_socket(&socket_name);
772 if (socket_fd < 0) {
7f4e0805
LP
773 r = socket_fd;
774 goto finish;
775 }
776
777 fprintf(f,
778 "[Ask]\n"
de0671ee 779 "PID="PID_FMT"\n"
7f4e0805 780 "Socket=%s\n"
21bc923a 781 "AcceptCached=%i\n"
64845bdc 782 "Echo=%i\n"
1fa94a31
SB
783 "NotAfter="USEC_FMT"\n"
784 "Silent=%i\n",
df0ff127 785 getpid_cached(),
7f4e0805 786 socket_name,
9cb5bf91
CH
787 FLAGS_SET(flags, ASK_PASSWORD_ACCEPT_CACHED),
788 FLAGS_SET(flags, ASK_PASSWORD_ECHO),
1fa94a31 789 until,
9cb5bf91 790 FLAGS_SET(flags, ASK_PASSWORD_SILENT));
7f4e0805 791
d08fd4c3
LP
792 if (req) {
793 if (req->message)
794 fprintf(f, "Message=%s\n", req->message);
7f4e0805 795
d08fd4c3
LP
796 if (req->icon)
797 fprintf(f, "Icon=%s\n", req->icon);
7f4e0805 798
d08fd4c3
LP
799 if (req->id)
800 fprintf(f, "Id=%s\n", req->id);
801 }
9fa1de96 802
dacd6cee 803 r = fflush_and_check(f);
00843602 804 if (r < 0)
7f4e0805 805 goto finish;
7f4e0805
LP
806
807 memcpy(final, temp, sizeof(temp));
808
809 final[sizeof(final)-11] = 'a';
810 final[sizeof(final)-10] = 's';
811 final[sizeof(final)-9] = 'k';
812
108dfff2
LP
813 r = RET_NERRNO(rename(temp, final));
814 if (r < 0)
7f4e0805 815 goto finish;
7f4e0805
LP
816
817 zero(pollfd);
818 pollfd[FD_SOCKET].fd = socket_fd;
819 pollfd[FD_SOCKET].events = POLLIN;
820 pollfd[FD_SIGNAL].fd = signal_fd;
821 pollfd[FD_SIGNAL].events = POLLIN;
c7b7d74e
XF
822 pollfd[FD_INOTIFY].fd = notify;
823 pollfd[FD_INOTIFY].events = POLLIN;
7f4e0805
LP
824
825 for (;;) {
fb29cdbe 826 CMSG_BUFFER_TYPE(CMSG_SPACE(sizeof(struct ucred))) control;
7f4e0805 827 char passphrase[LINE_MAX+1];
7f4e0805
LP
828 struct iovec iovec;
829 struct ucred *ucred;
d9e2af0a 830 usec_t timeout;
7f4e0805 831 ssize_t n;
7f4e0805 832
d9e2af0a
YW
833 if (until > 0)
834 timeout = usec_sub_unsigned(until, now(CLOCK_MONOTONIC));
835 else
836 timeout = USEC_INFINITY;
7f4e0805 837
d9e2af0a
YW
838 r = ppoll_usec(pollfd, notify >= 0 ? _FD_MAX : _FD_MAX - 1, timeout);
839 if (r == -EINTR)
840 continue;
841 if (r < 0)
7f4e0805 842 goto finish;
d9e2af0a 843 if (r == 0) {
7f4e0805
LP
844 r = -ETIME;
845 goto finish;
846 }
847
21bc923a
LP
848 if (pollfd[FD_SIGNAL].revents & POLLIN) {
849 r = -EINTR;
850 goto finish;
851 }
7f4e0805 852
c7b7d74e
XF
853 if (notify >= 0 && pollfd[FD_INOTIFY].revents != 0) {
854 (void) flush_fd(notify);
855
d08fd4c3
LP
856 if (req && req->keyring) {
857 r = ask_password_keyring(req, flags, ret);
858 if (r >= 0) {
859 r = 0;
860 goto finish;
861 } else if (r != -ENOKEY)
862 goto finish;
863 }
c7b7d74e
XF
864 }
865
866 if (pollfd[FD_SOCKET].revents == 0)
867 continue;
868
7f4e0805 869 if (pollfd[FD_SOCKET].revents != POLLIN) {
7f4e0805
LP
870 r = -EIO;
871 goto finish;
872 }
873
5cfa2c3d 874 iovec = IOVEC_MAKE(passphrase, sizeof(passphrase));
7f4e0805 875
41ab8c67
LP
876 struct msghdr msghdr = {
877 .msg_iov = &iovec,
878 .msg_iovlen = 1,
879 .msg_control = &control,
880 .msg_controllen = sizeof(control),
881 };
7f4e0805 882
3691bcf3 883 n = recvmsg_safe(socket_fd, &msghdr, 0);
bb44fd07
ZJS
884 if (ERRNO_IS_NEG_TRANSIENT(n))
885 continue;
ad501930
MY
886 if (n == -ECHRNG) {
887 log_debug_errno(n, "Got message with truncated control data (unexpected fds sent?), ignoring.");
bb44fd07 888 continue;
ad501930
MY
889 }
890 if (n == -EXFULL) {
891 log_debug_errno(n, "Got message with truncated payload data, ignoring.");
892 continue;
893 }
894 if (n < 0) {
3691bcf3 895 r = (int) n;
7f4e0805
LP
896 goto finish;
897 }
898
692597c8
LP
899 CLEANUP_ERASE(passphrase);
900
1c8da044
LP
901 cmsg_close_all(&msghdr);
902
8add30a0 903 if (n == 0) {
00843602 904 log_debug("Message too short");
7f4e0805
LP
905 continue;
906 }
907
371d72e0
LP
908 ucred = CMSG_FIND_DATA(&msghdr, SOL_SOCKET, SCM_CREDENTIALS, struct ucred);
909 if (!ucred) {
00843602 910 log_debug("Received message without credentials. Ignoring.");
7f4e0805
LP
911 continue;
912 }
913
7f4e0805 914 if (ucred->uid != 0) {
00843602 915 log_debug("Got request from unprivileged user. Ignoring.");
7f4e0805
LP
916 continue;
917 }
918
919 if (passphrase[0] == '+') {
e287086b 920 /* An empty message refers to the empty password */
8254a475 921 if (n == 1)
bea1a013 922 l = strv_new("");
8254a475
LP
923 else
924 l = strv_parse_nulstr(passphrase+1, n-1);
8254a475 925 if (!l) {
7f4e0805
LP
926 r = -ENOMEM;
927 goto finish;
928 }
929
58629001 930 if (strv_isempty(l)) {
e287086b 931 l = strv_free(l);
00843602 932 log_debug("Invalid packet");
21bc923a
LP
933 continue;
934 }
935
e287086b
LP
936 break;
937 }
21bc923a 938
e287086b 939 if (passphrase[0] == '-') {
7f4e0805
LP
940 r = -ECANCELED;
941 goto finish;
7f4e0805
LP
942 }
943
e287086b 944 log_debug("Invalid packet");
7f4e0805
LP
945 }
946
d08fd4c3
LP
947 if (req && req->keyring)
948 (void) add_to_keyring_and_log(req->keyring, flags, l);
e287086b 949
ae2a15bc 950 *ret = TAKE_PTR(l);
7f4e0805
LP
951 r = 0;
952
953finish:
981e4cd3 954 if (socket_name)
00843602 955 (void) unlink(socket_name);
7f4e0805 956
00843602 957 (void) unlink(temp);
7f4e0805
LP
958
959 if (final[0])
00843602 960 (void) unlink(final);
7f4e0805 961
f9b72cd8 962 assert_se(sigprocmask(SIG_SETMASK, &oldmask, NULL) == 0);
7f4e0805
LP
963 return r;
964}
260ab287 965
d08fd4c3 966static int ask_password_credential(const AskPasswordRequest *req, AskPasswordFlags flags, char ***ret) {
8806bb4b 967 _cleanup_(erase_and_freep) char *buffer = NULL;
623a8b19 968 _cleanup_strv_free_erase_ char **l = NULL;
8806bb4b 969 size_t size;
8806bb4b
LP
970 int r;
971
d08fd4c3
LP
972 assert(req);
973 assert(req->credential);
8806bb4b
LP
974 assert(ret);
975
d08fd4c3 976 r = read_credential(req->credential, (void**) &buffer, &size);
8806bb4b
LP
977 if (IN_SET(r, -ENXIO, -ENOENT)) /* No credentials passed or this credential not defined? */
978 return -ENOKEY;
979
980 l = strv_parse_nulstr(buffer, size);
981 if (!l)
982 return -ENOMEM;
983
623a8b19
YW
984 if (strv_isempty(l))
985 return log_debug_errno(SYNTHETIC_ERRNO(ENOKEY), "Found an empty password in credential.");
986
987 *ret = TAKE_PTR(l);
8806bb4b
LP
988 return 0;
989}
990
00843602 991int ask_password_auto(
d08fd4c3 992 const AskPasswordRequest *req,
00843602 993 usec_t until,
e287086b
LP
994 AskPasswordFlags flags,
995 char ***ret) {
00843602
LP
996
997 int r;
998
e287086b 999 assert(ret);
21bc923a 1000
d08fd4c3
LP
1001 if (!FLAGS_SET(flags, ASK_PASSWORD_NO_CREDENTIAL) && req && req->credential) {
1002 r = ask_password_credential(req, flags, ret);
8806bb4b
LP
1003 if (r != -ENOKEY)
1004 return r;
1005 }
1006
9cb5bf91 1007 if (FLAGS_SET(flags, ASK_PASSWORD_ACCEPT_CACHED) &&
d08fd4c3 1008 req && req->keyring &&
300b7e76 1009 (FLAGS_SET(flags, ASK_PASSWORD_NO_TTY) || !isatty_safe(STDIN_FILENO)) &&
9cb5bf91 1010 FLAGS_SET(flags, ASK_PASSWORD_NO_AGENT)) {
d08fd4c3 1011 r = ask_password_keyring(req, flags, ret);
e287086b
LP
1012 if (r != -ENOKEY)
1013 return r;
1014 }
1015
300b7e76 1016 if (!FLAGS_SET(flags, ASK_PASSWORD_NO_TTY) && isatty_safe(STDIN_FILENO))
d08fd4c3 1017 return ask_password_tty(-EBADF, req, until, flags, NULL, ret);
00843602 1018
9cb5bf91 1019 if (!FLAGS_SET(flags, ASK_PASSWORD_NO_AGENT))
d08fd4c3 1020 return ask_password_agent(req, until, flags, ret);
e287086b
LP
1021
1022 return -EUNATCH;
260ab287 1023}