1 /* SPDX-License-Identifier: LGPL-2.1+ */
15 #include <sys/inotify.h>
16 #include <sys/signalfd.h>
17 #include <sys/socket.h>
25 #include "alloc-util.h"
26 #include "ask-password-api.h"
29 #include "format-util.h"
34 #include "memory-util.h"
37 #include "process-util.h"
38 #include "random-util.h"
39 #include "signal-util.h"
40 #include "socket-util.h"
41 #include "string-util.h"
43 #include "terminal-util.h"
44 #include "time-util.h"
45 #include "tmpfile-util.h"
46 #include "umask-util.h"
49 #define KEYRING_TIMEOUT_USEC ((5 * USEC_PER_MINUTE) / 2)
51 static int lookup_key(const char *keyname
, key_serial_t
*ret
) {
57 serial
= request_key("user", keyname
, NULL
, 0);
59 return negative_errno();
65 static int retrieve_key(key_serial_t serial
, char ***ret
) {
66 _cleanup_free_
char *p
= NULL
;
77 n
= keyctl(KEYCTL_READ
, (unsigned long) serial
, (unsigned long) p
, (unsigned long) m
, 0);
84 explicit_bzero_safe(p
, n
);
89 l
= strv_parse_nulstr(p
, n
);
93 explicit_bzero_safe(p
, n
);
99 static int add_to_keyring(const char *keyname
, AskPasswordFlags flags
, char **passwords
) {
100 _cleanup_strv_free_erase_
char **l
= NULL
;
101 _cleanup_free_
char *p
= NULL
;
109 if (!(flags
& ASK_PASSWORD_PUSH_CACHE
))
112 r
= lookup_key(keyname
, &serial
);
114 r
= retrieve_key(serial
, &l
);
117 } else if (r
!= -ENOKEY
)
120 r
= strv_extend_strv(&l
, passwords
, true);
124 r
= strv_make_nulstr(l
, &p
, &n
);
128 serial
= add_key("user", keyname
, p
, n
, KEY_SPEC_USER_KEYRING
);
129 explicit_bzero_safe(p
, n
);
133 if (keyctl(KEYCTL_SET_TIMEOUT
,
134 (unsigned long) serial
,
135 (unsigned long) DIV_ROUND_UP(KEYRING_TIMEOUT_USEC
, USEC_PER_SEC
), 0, 0) < 0)
136 log_debug_errno(errno
, "Failed to adjust timeout: %m");
138 /* Tell everyone to check the keyring */
139 (void) touch("/run/systemd/ask-password");
141 log_debug("Added key to keyring as %" PRIi32
".", serial
);
146 static int add_to_keyring_and_log(const char *keyname
, AskPasswordFlags flags
, char **passwords
) {
152 r
= add_to_keyring(keyname
, flags
, passwords
);
154 return log_debug_errno(r
, "Failed to add password to keyring: %m");
159 static int ask_password_keyring(const char *keyname
, AskPasswordFlags flags
, char ***ret
) {
167 if (!(flags
& ASK_PASSWORD_ACCEPT_CACHED
))
170 r
= lookup_key(keyname
, &serial
);
171 if (r
== -ENOSYS
) /* when retrieving the distinction doesn't matter */
176 return retrieve_key(serial
, ret
);
179 static void backspace_chars(int ttyfd
, size_t p
) {
187 loop_write(ttyfd
, "\b \b", 3, false);
191 static void backspace_string(int ttyfd
, const char *str
) {
199 /* Backspaces through enough characters to entirely undo printing of the specified string. */
201 m
= utf8_n_codepoints(str
);
202 if (m
== (size_t) -1)
203 m
= strlen(str
); /* Not a valid UTF-8 string? If so, let's backspace the number of bytes output. Most
204 * likely this happened because we are not in an UTF-8 locale, and in that case that
205 * is the correct thing to do. And even if it's not, terminals tend to stop
206 * backspacing at the leftmost column, hence backspacing too much should be mostly
209 backspace_chars(ttyfd
, m
);
212 int ask_password_tty(
217 AskPasswordFlags flags
,
218 const char *flag_file
,
227 bool reset_tty
= false, dirty
= false, use_color
= false;
228 _cleanup_close_
int cttyfd
= -1, notify
= -1;
229 struct termios old_termios
, new_termios
;
230 char passphrase
[LINE_MAX
+ 1] = {}, *x
;
231 _cleanup_strv_free_erase_
char **l
= NULL
;
232 struct pollfd pollfd
[_POLL_MAX
];
233 size_t p
= 0, codepoint
= 0;
238 if (flags
& ASK_PASSWORD_NO_TTY
)
242 message
= "Password:";
244 if (flag_file
|| ((flags
& ASK_PASSWORD_ACCEPT_CACHED
) && keyname
)) {
245 notify
= inotify_init1(IN_CLOEXEC
|IN_NONBLOCK
);
250 if (inotify_add_watch(notify
, flag_file
, IN_ATTRIB
/* for the link count */) < 0)
253 if ((flags
& ASK_PASSWORD_ACCEPT_CACHED
) && keyname
) {
254 r
= ask_password_keyring(keyname
, flags
, ret
);
257 else if (r
!= -ENOKEY
)
260 if (inotify_add_watch(notify
, "/run/systemd/ask-password", IN_ATTRIB
/* for mtime */) < 0)
264 /* If the caller didn't specify a TTY, then use the controlling tty, if we can. */
266 ttyfd
= cttyfd
= open("/dev/tty", O_RDWR
|O_NOCTTY
|O_CLOEXEC
);
269 if (tcgetattr(ttyfd
, &old_termios
) < 0)
272 if (flags
& ASK_PASSWORD_CONSOLE_COLOR
)
273 use_color
= dev_console_colors_enabled();
275 use_color
= colors_enabled();
278 (void) loop_write(ttyfd
, ANSI_HIGHLIGHT
, STRLEN(ANSI_HIGHLIGHT
), false);
280 (void) loop_write(ttyfd
, message
, strlen(message
), false);
281 (void) loop_write(ttyfd
, " ", 1, false);
284 (void) loop_write(ttyfd
, ANSI_NORMAL
, STRLEN(ANSI_NORMAL
), false);
286 new_termios
= old_termios
;
287 new_termios
.c_lflag
&= ~(ICANON
|ECHO
);
288 new_termios
.c_cc
[VMIN
] = 1;
289 new_termios
.c_cc
[VTIME
] = 0;
291 if (tcsetattr(ttyfd
, TCSADRAIN
, &new_termios
) < 0) {
299 pollfd
[POLL_TTY
] = (struct pollfd
) {
300 .fd
= ttyfd
>= 0 ? ttyfd
: STDIN_FILENO
,
303 pollfd
[POLL_INOTIFY
] = (struct pollfd
) {
309 int sleep_for
= -1, k
;
316 y
= now(CLOCK_MONOTONIC
);
323 sleep_for
= (int) DIV_ROUND_UP(until
- y
, USEC_PER_MSEC
);
327 if (access(flag_file
, F_OK
) < 0) {
332 k
= poll(pollfd
, notify
>= 0 ? 2 : 1, sleep_for
);
344 if (notify
>= 0 && pollfd
[POLL_INOTIFY
].revents
!= 0 && keyname
) {
345 (void) flush_fd(notify
);
347 r
= ask_password_keyring(keyname
, flags
, ret
);
351 } else if (r
!= -ENOKEY
)
355 if (pollfd
[POLL_TTY
].revents
== 0)
358 n
= read(ttyfd
>= 0 ? ttyfd
: STDIN_FILENO
, &c
, 1);
360 if (IN_SET(errno
, EINTR
, EAGAIN
))
368 /* We treat EOF, newline and NUL byte all as valid end markers */
369 if (n
== 0 || c
== '\n' || c
== 0)
372 if (c
== 21) { /* C-u */
374 if (!(flags
& ASK_PASSWORD_SILENT
))
375 backspace_string(ttyfd
, passphrase
);
377 explicit_bzero_safe(passphrase
, sizeof(passphrase
));
380 } else if (IN_SET(c
, '\b', 127)) {
385 if (!(flags
& ASK_PASSWORD_SILENT
))
386 backspace_chars(ttyfd
, 1);
388 /* Remove a full UTF-8 codepoint from the end. For that, figure out where the
394 z
= utf8_encoded_valid_unichar(passphrase
+ q
, (size_t) -1);
396 q
= (size_t) -1; /* Invalid UTF8! */
400 if (q
+ z
>= p
) /* This one brings us over the edge */
406 p
= codepoint
= q
== (size_t) -1 ? p
- 1 : q
;
407 explicit_bzero_safe(passphrase
+ p
, sizeof(passphrase
) - p
);
409 } else if (!dirty
&& !(flags
& ASK_PASSWORD_SILENT
)) {
411 flags
|= ASK_PASSWORD_SILENT
;
413 /* There are two ways to enter silent mode. Either by pressing backspace as
414 * first key (and only as first key), or ... */
417 (void) loop_write(ttyfd
, "(no echo) ", 10, false);
419 } else if (ttyfd
>= 0)
420 (void) loop_write(ttyfd
, "\a", 1, false);
422 } else if (c
== '\t' && !(flags
& ASK_PASSWORD_SILENT
)) {
424 backspace_string(ttyfd
, passphrase
);
425 flags
|= ASK_PASSWORD_SILENT
;
427 /* ... or by pressing TAB at any time. */
430 (void) loop_write(ttyfd
, "(no echo) ", 10, false);
432 } else if (p
>= sizeof(passphrase
)-1) {
434 /* Reached the size limit */
436 (void) loop_write(ttyfd
, "\a", 1, false);
441 if (!(flags
& ASK_PASSWORD_SILENT
) && ttyfd
>= 0) {
442 /* Check if we got a complete UTF-8 character now. If so, let's output one '*'. */
443 n
= utf8_encoded_valid_unichar(passphrase
+ codepoint
, (size_t) -1);
445 if (flags
& ASK_PASSWORD_ECHO
)
446 (void) loop_write(ttyfd
, passphrase
+ codepoint
, n
, false);
448 (void) loop_write(ttyfd
, "*", 1, false);
456 /* Let's forget this char, just to not keep needlessly copies of key material around */
460 x
= strndup(passphrase
, p
);
461 explicit_bzero_safe(passphrase
, sizeof(passphrase
));
467 r
= strv_consume(&l
, x
);
472 (void) add_to_keyring_and_log(keyname
, flags
, l
);
478 if (ttyfd
>= 0 && reset_tty
) {
479 (void) loop_write(ttyfd
, "\n", 1, false);
480 (void) tcsetattr(ttyfd
, TCSADRAIN
, &old_termios
);
486 static int create_socket(char **ret
) {
487 _cleanup_free_
char *path
= NULL
;
488 union sockaddr_union sa
= {};
489 _cleanup_close_
int fd
= -1;
494 fd
= socket(AF_UNIX
, SOCK_DGRAM
|SOCK_CLOEXEC
|SOCK_NONBLOCK
, 0);
498 if (asprintf(&path
, "/run/systemd/ask-password/sck.%" PRIx64
, random_u64()) < 0)
501 salen
= sockaddr_un_set_path(&sa
.un
, path
);
505 RUN_WITH_UMASK(0177) {
506 if (bind(fd
, &sa
.sa
, salen
) < 0)
510 r
= setsockopt_int(fd
, SOL_SOCKET
, SO_PASSCRED
, true);
514 *ret
= TAKE_PTR(path
);
518 int ask_password_agent(
524 AskPasswordFlags flags
,
534 _cleanup_close_
int socket_fd
= -1, signal_fd
= -1, notify
= -1, fd
= -1;
535 char temp
[] = "/run/systemd/ask-password/tmp.XXXXXX";
536 char final
[sizeof(temp
)] = "";
537 _cleanup_free_
char *socket_name
= NULL
;
538 _cleanup_strv_free_erase_
char **l
= NULL
;
539 _cleanup_fclose_
FILE *f
= NULL
;
540 struct pollfd pollfd
[_FD_MAX
];
541 sigset_t mask
, oldmask
;
546 if (flags
& ASK_PASSWORD_NO_AGENT
)
549 assert_se(sigemptyset(&mask
) >= 0);
550 assert_se(sigset_add_many(&mask
, SIGINT
, SIGTERM
, -1) >= 0);
551 assert_se(sigprocmask(SIG_BLOCK
, &mask
, &oldmask
) >= 0);
553 (void) mkdir_p_label("/run/systemd/ask-password", 0755);
555 if ((flags
& ASK_PASSWORD_ACCEPT_CACHED
) && keyname
) {
556 r
= ask_password_keyring(keyname
, flags
, ret
);
560 } else if (r
!= -ENOKEY
)
563 notify
= inotify_init1(IN_CLOEXEC
| IN_NONBLOCK
);
568 if (inotify_add_watch(notify
, "/run/systemd/ask-password", IN_ATTRIB
/* for mtime */) < 0) {
574 fd
= mkostemp_safe(temp
);
580 (void) fchmod(fd
, 0644);
590 signal_fd
= signalfd(-1, &mask
, SFD_NONBLOCK
|SFD_CLOEXEC
);
596 socket_fd
= create_socket(&socket_name
);
608 "NotAfter="USEC_FMT
"\n",
611 (flags
& ASK_PASSWORD_ACCEPT_CACHED
) ? 1 : 0,
612 (flags
& ASK_PASSWORD_ECHO
) ? 1 : 0,
616 fprintf(f
, "Message=%s\n", message
);
619 fprintf(f
, "Icon=%s\n", icon
);
622 fprintf(f
, "Id=%s\n", id
);
624 r
= fflush_and_check(f
);
628 memcpy(final
, temp
, sizeof(temp
));
630 final
[sizeof(final
)-11] = 'a';
631 final
[sizeof(final
)-10] = 's';
632 final
[sizeof(final
)-9] = 'k';
634 if (rename(temp
, final
) < 0) {
640 pollfd
[FD_SOCKET
].fd
= socket_fd
;
641 pollfd
[FD_SOCKET
].events
= POLLIN
;
642 pollfd
[FD_SIGNAL
].fd
= signal_fd
;
643 pollfd
[FD_SIGNAL
].events
= POLLIN
;
644 pollfd
[FD_INOTIFY
].fd
= notify
;
645 pollfd
[FD_INOTIFY
].events
= POLLIN
;
648 char passphrase
[LINE_MAX
+1];
649 struct msghdr msghdr
;
653 struct cmsghdr cmsghdr
;
654 uint8_t buf
[CMSG_SPACE(sizeof(struct ucred
))];
660 t
= now(CLOCK_MONOTONIC
);
662 if (until
> 0 && until
<= t
) {
667 k
= poll(pollfd
, notify
>= 0 ? _FD_MAX
: _FD_MAX
- 1, until
> 0 ? (int) ((until
-t
)/USEC_PER_MSEC
) : -1);
681 if (pollfd
[FD_SIGNAL
].revents
& POLLIN
) {
686 if (notify
>= 0 && pollfd
[FD_INOTIFY
].revents
!= 0) {
687 (void) flush_fd(notify
);
689 r
= ask_password_keyring(keyname
, flags
, ret
);
693 } else if (r
!= -ENOKEY
)
697 if (pollfd
[FD_SOCKET
].revents
== 0)
700 if (pollfd
[FD_SOCKET
].revents
!= POLLIN
) {
705 iovec
= IOVEC_MAKE(passphrase
, sizeof(passphrase
));
709 msghdr
.msg_iov
= &iovec
;
710 msghdr
.msg_iovlen
= 1;
711 msghdr
.msg_control
= &control
;
712 msghdr
.msg_controllen
= sizeof(control
);
714 n
= recvmsg(socket_fd
, &msghdr
, 0);
716 if (IN_SET(errno
, EAGAIN
, EINTR
))
723 cmsg_close_all(&msghdr
);
726 log_debug("Message too short");
730 if (msghdr
.msg_controllen
< CMSG_LEN(sizeof(struct ucred
)) ||
731 control
.cmsghdr
.cmsg_level
!= SOL_SOCKET
||
732 control
.cmsghdr
.cmsg_type
!= SCM_CREDENTIALS
||
733 control
.cmsghdr
.cmsg_len
!= CMSG_LEN(sizeof(struct ucred
))) {
734 log_debug("Received message without credentials. Ignoring.");
738 ucred
= (struct ucred
*) CMSG_DATA(&control
.cmsghdr
);
739 if (ucred
->uid
!= 0) {
740 log_debug("Got request from unprivileged user. Ignoring.");
744 if (passphrase
[0] == '+') {
745 /* An empty message refers to the empty password */
749 l
= strv_parse_nulstr(passphrase
+1, n
-1);
750 explicit_bzero_safe(passphrase
, n
);
756 if (strv_isempty(l
)) {
758 log_debug("Invalid packet");
765 if (passphrase
[0] == '-') {
770 log_debug("Invalid packet");
774 (void) add_to_keyring_and_log(keyname
, flags
, l
);
781 (void) unlink(socket_name
);
786 (void) unlink(final
);
788 assert_se(sigprocmask(SIG_SETMASK
, &oldmask
, NULL
) == 0);
792 int ask_password_auto(
798 AskPasswordFlags flags
,
805 if ((flags
& ASK_PASSWORD_ACCEPT_CACHED
) &&
807 ((flags
& ASK_PASSWORD_NO_TTY
) || !isatty(STDIN_FILENO
)) &&
808 (flags
& ASK_PASSWORD_NO_AGENT
)) {
809 r
= ask_password_keyring(keyname
, flags
, ret
);
814 if (!(flags
& ASK_PASSWORD_NO_TTY
) && isatty(STDIN_FILENO
))
815 return ask_password_tty(-1, message
, keyname
, until
, flags
, NULL
, ret
);
817 if (!(flags
& ASK_PASSWORD_NO_AGENT
))
818 return ask_password_agent(message
, icon
, id
, keyname
, until
, flags
, ret
);