1
/*  -*- coding: utf-8 -*- */
 
 
3
 * Plymouth - Read a password from Plymouth and output it
 
 
5
 * Copyright © 2010-2019 Teddy Hogeborn
 
 
6
 * Copyright © 2010-2019 Björn Påhlsson
 
 
8
 * This file is part of Mandos.
 
 
10
 * Mandos is free software: you can redistribute it and/or modify it
 
 
11
 * under the terms of the GNU General Public License as published by
 
 
12
 * the Free Software Foundation, either version 3 of the License, or
 
 
13
 * (at your option) any later version.
 
 
15
 * Mandos is distributed in the hope that it will be useful, but
 
 
16
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 
 
17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
 
18
 * General Public License for more details.
 
 
20
 * You should have received a copy of the GNU General Public License
 
 
21
 * along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
 
 
23
 * Contact the authors at <mandos@recompile.se>.
 
 
26
#define _GNU_SOURCE             /* asprintf(), TEMP_FAILURE_RETRY() */
 
 
27
#include <signal.h>             /* sig_atomic_t, struct sigaction,
 
 
28
                                   sigemptyset(), sigaddset(), SIGINT,
 
 
29
                                   SIGHUP, SIGTERM, sigaction(),
 
 
31
#include <stdbool.h>            /* bool, false, true */
 
 
32
#include <fcntl.h>              /* open(), O_RDONLY */
 
 
33
#include <iso646.h>             /* and, or, not*/
 
 
34
#include <sys/types.h>          /* size_t, ssize_t, pid_t, struct
 
 
36
#include <sys/wait.h>           /* waitpid() */
 
 
37
#include <stddef.h>             /* NULL */
 
 
38
#include <string.h>             /* strchr(), memcmp() */
 
 
39
#include <stdio.h>              /* asprintf(), perror(), fopen(),
 
 
40
                                   fscanf(), vasprintf(), fprintf(),
 
 
42
#include <unistd.h>             /* close(), readlink(), read(),
 
 
43
                                   fork(), setsid(), chdir(), dup2(),
 
 
44
                                   STDERR_FILENO, execv(), access() */
 
 
45
#include <stdlib.h>             /* free(), EXIT_FAILURE, realloc(),
 
 
46
                                   EXIT_SUCCESS, malloc(), _exit(),
 
 
48
#include <dirent.h>             /* scandir(), alphasort() */
 
 
49
#include <inttypes.h>           /* intmax_t, strtoumax(), SCNuMAX */
 
 
50
#include <sys/stat.h>           /* struct stat, lstat() */
 
 
51
#include <sysexits.h>           /* EX_OSERR, EX_UNAVAILABLE */
 
 
52
#include <error.h>              /* error() */
 
 
53
#include <errno.h>              /* TEMP_FAILURE_RETRY */
 
 
54
#include <argz.h>               /* argz_count(), argz_extract() */
 
 
55
#include <stdarg.h>             /* va_list, va_start(), ... */
 
 
58
sig_atomic_t interrupted_by_signal = 0;
 
 
59
const char *argp_program_version = "plymouth " VERSION;
 
 
60
const char *argp_program_bug_address = "<mandos@recompile.se>";
 
 
62
/* Used by Ubuntu 11.04 (Natty Narwahl) */
 
 
63
const char plymouth_old_old_pid[] = "/dev/.initramfs/plymouth.pid";
 
 
64
/* Used by Ubuntu 11.10 (Oneiric Ocelot) */
 
 
65
const char plymouth_old_pid[] = "/run/initramfs/plymouth.pid";
 
 
66
/* Used by Debian 9 (stretch) */
 
 
67
const char plymouth_pid[] = "/run/plymouth/pid";
 
 
69
const char plymouth_path[] = "/bin/plymouth";
 
 
70
const char plymouthd_path[] = "/sbin/plymouthd";
 
 
71
const char *plymouthd_default_argv[] = {"/sbin/plymouthd",
 
 
73
                                        "--attach-to-session",
 
 
77
static void termination_handler(__attribute__((unused))int signum){
 
 
78
  if(interrupted_by_signal){
 
 
81
  interrupted_by_signal = 1;
 
 
84
__attribute__((format (gnu_printf, 2, 3), nonnull))
 
 
85
int fprintf_plus(FILE *stream, const char *format, ...){
 
 
87
  va_start (ap, format);
 
 
88
  fprintf(stream, "Mandos plugin %s: ", program_invocation_short_name);
 
 
89
  return vfprintf(stream, format, ap);
 
 
92
/* Function to use when printing errors */
 
 
93
__attribute__((format (gnu_printf, 3, 4)))
 
 
94
void error_plus(int status, int errnum, const char *formatstring,
 
 
100
  va_start(ap, formatstring);
 
 
101
  ret = vasprintf(&text, formatstring, ap);
 
 
103
    fprintf(stderr, "Mandos plugin %s: ",
 
 
104
            program_invocation_short_name);
 
 
105
    vfprintf(stderr, formatstring, ap);
 
 
106
    fprintf(stderr, ": ");
 
 
107
    fprintf(stderr, "%s\n", strerror(errnum));
 
 
108
    error(status, errno, "vasprintf while printing error");
 
 
111
  fprintf(stderr, "Mandos plugin ");
 
 
112
  error(status, errnum, "%s", text);
 
 
116
/* Create prompt string */
 
 
117
char *makeprompt(void){
 
 
120
  const char *const cryptsource = getenv("cryptsource");
 
 
121
  const char *const crypttarget = getenv("crypttarget");
 
 
122
  const char prompt_start[] = "Unlocking the disk";
 
 
123
  const char prompt_end[] = "Enter passphrase";
 
 
125
  if(cryptsource == NULL){
 
 
126
    if(crypttarget == NULL){
 
 
127
      ret = asprintf(&prompt, "%s\n%s", prompt_start, prompt_end);
 
 
129
      ret = asprintf(&prompt, "%s (%s)\n%s", prompt_start,
 
 
130
                     crypttarget, prompt_end);
 
 
133
    if(crypttarget == NULL){
 
 
134
      ret = asprintf(&prompt, "%s %s\n%s", prompt_start, cryptsource,
 
 
137
      ret = asprintf(&prompt, "%s %s (%s)\n%s", prompt_start,
 
 
138
                     cryptsource, crypttarget, prompt_end);
 
 
147
void kill_and_wait(pid_t pid){
 
 
148
  TEMP_FAILURE_RETRY(kill(pid, SIGTERM));
 
 
149
  TEMP_FAILURE_RETRY(waitpid(pid, NULL, 0));
 
 
152
bool become_a_daemon(void){
 
 
153
  int ret = setuid(geteuid());
 
 
155
    error_plus(0, errno, "setuid");
 
 
161
    error_plus(0, errno, "chdir");
 
 
164
  ret = dup2(STDERR_FILENO, STDOUT_FILENO); /* replace our stdout */
 
 
166
    error_plus(0, errno, "dup2");
 
 
172
__attribute__((nonnull (2, 3)))
 
 
173
bool exec_and_wait(pid_t *pid_return, const char *path,
 
 
174
                   const char * const * const argv, bool interruptable,
 
 
180
    for(const char * const *arg = argv; *arg != NULL; arg++){
 
 
181
      fprintf_plus(stderr, "exec_and_wait arg: %s\n", *arg);
 
 
183
    fprintf_plus(stderr, "exec_and_wait end of args\n");
 
 
188
    error_plus(0, errno, "fork");
 
 
194
      if(not become_a_daemon()){
 
 
199
    char **new_argv = malloc(sizeof(const char *));
 
 
200
    if(new_argv == NULL){
 
 
201
      error_plus(0, errno, "malloc");
 
 
206
    for (; argv[i] != NULL; i++){
 
 
207
      tmp = realloc(new_argv, sizeof(const char *) * ((size_t)i + 2));
 
 
209
        error_plus(0, errno, "realloc");
 
 
214
      new_argv[i] = strdup(argv[i]);
 
 
218
    execv(path, (char *const *)new_argv);
 
 
219
    error_plus(0, errno, "execv");
 
 
222
  if(pid_return != NULL){
 
 
226
    ret = waitpid(pid, &status, 0);
 
 
227
  } while(ret == -1 and errno == EINTR
 
 
228
          and ((not interrupted_by_signal)
 
 
229
               or (not interruptable)));
 
 
230
  if(interrupted_by_signal and interruptable){
 
 
232
      fprintf_plus(stderr, "Interrupted by signal\n");
 
 
237
    error_plus(0, errno, "waitpid");
 
 
241
    if(WIFEXITED(status)){
 
 
242
      fprintf_plus(stderr, "exec_and_wait exited: %d\n",
 
 
243
                   WEXITSTATUS(status));
 
 
244
    } else if(WIFSIGNALED(status)) {
 
 
245
      fprintf_plus(stderr, "exec_and_wait signaled: %d\n",
 
 
249
  if(WIFEXITED(status) and (WEXITSTATUS(status) == 0)){
 
 
255
__attribute__((nonnull))
 
 
256
int is_plymouth(const struct dirent *proc_entry){
 
 
262
    proc_id = strtoumax(proc_entry->d_name, &tmp, 10);
 
 
264
    if(errno != 0 or *tmp != '\0'
 
 
265
       or proc_id != (uintmax_t)((pid_t)proc_id)){
 
 
269
  char exe_target[sizeof(plymouthd_path)];
 
 
271
  ret = asprintf(&exe_link, "/proc/%s/exe", proc_entry->d_name);
 
 
273
    error_plus(0, errno, "asprintf");
 
 
277
  struct stat exe_stat;
 
 
278
  ret = lstat(exe_link, &exe_stat);
 
 
282
      error_plus(0, errno, "lstat");
 
 
287
  if(not S_ISLNK(exe_stat.st_mode)
 
 
288
     or exe_stat.st_uid != 0
 
 
289
     or exe_stat.st_gid != 0){
 
 
294
  ssize_t sret = readlink(exe_link, exe_target, sizeof(exe_target));
 
 
296
  if((sret != (ssize_t)sizeof(plymouthd_path)-1) or
 
 
297
      (memcmp(plymouthd_path, exe_target,
 
 
298
              sizeof(plymouthd_path)-1) != 0)){
 
 
306
  uintmax_t proc_id = 0;
 
 
307
  FILE *pidfile = fopen(plymouth_pid, "r");
 
 
308
  /* Try the new pid file location */
 
 
310
    ret = fscanf(pidfile, "%" SCNuMAX, &proc_id);
 
 
316
  /* Try the old pid file location */
 
 
318
    pidfile = fopen(plymouth_old_pid, "r");
 
 
320
      ret = fscanf(pidfile, "%" SCNuMAX, &proc_id);
 
 
327
  /* Try the old old pid file location */
 
 
329
    pidfile = fopen(plymouth_old_old_pid, "r");
 
 
331
      ret = fscanf(pidfile, "%" SCNuMAX, &proc_id);
 
 
338
  /* Look for a plymouth process */
 
 
340
    struct dirent **direntries = NULL;
 
 
341
    ret = scandir("/proc", &direntries, is_plymouth, alphasort);
 
 
343
      error_plus(0, errno, "scandir");
 
 
346
      for(int i = ret-1; i >= 0; i--){
 
 
348
          ret = sscanf(direntries[i]->d_name, "%" SCNuMAX, &proc_id);
 
 
350
            error_plus(0, errno, "sscanf");
 
 
356
    /* scandir might preallocate for this variable (man page unclear).
 
 
357
       even if ret == 0, therefore we need to free it. */
 
 
361
  pid = (pid_t)proc_id;
 
 
362
  if((uintmax_t)pid == proc_id){
 
 
369
char **getargv(pid_t pid){
 
 
371
  char *cmdline_filename;
 
 
375
  ret = asprintf(&cmdline_filename, "/proc/%" PRIuMAX "/cmdline",
 
 
378
    error_plus(0, errno, "asprintf");
 
 
382
  /* Open /proc/<pid>/cmdline  */
 
 
383
  cl_fd = open(cmdline_filename, O_RDONLY);
 
 
384
  free(cmdline_filename);
 
 
386
    error_plus(0, errno, "open");
 
 
390
  size_t cmdline_allocated = 0;
 
 
391
  size_t cmdline_len = 0;
 
 
392
  char *cmdline = NULL;
 
 
394
  const size_t blocksize = 1024;
 
 
396
    /* Allocate more space? */
 
 
397
    if(cmdline_len + blocksize > cmdline_allocated){
 
 
398
      tmp = realloc(cmdline, cmdline_allocated + blocksize);
 
 
400
        error_plus(0, errno, "realloc");
 
 
406
      cmdline_allocated += blocksize;
 
 
410
    sret = read(cl_fd, cmdline + cmdline_len,
 
 
411
                cmdline_allocated - cmdline_len);
 
 
413
      error_plus(0, errno, "read");
 
 
418
    cmdline_len += (size_t)sret;
 
 
422
    error_plus(0, errno, "close");
 
 
427
  /* we got cmdline and cmdline_len, ignore rest... */
 
 
428
  char **argv = malloc((argz_count(cmdline, cmdline_len) + 1)
 
 
429
                       * sizeof(char *)); /* Get number of args */
 
 
431
    error_plus(0, errno, "argv = malloc()");
 
 
435
  argz_extract(cmdline, cmdline_len, argv); /* Create argv */
 
 
439
int main(__attribute__((unused))int argc,
 
 
440
         __attribute__((unused))char **argv){
 
 
443
  pid_t plymouth_command_pid;
 
 
448
    struct argp_option options[] = {
 
 
449
      { .name = "prompt", .key = 128, .arg = "PROMPT",
 
 
450
        .doc = "The prompt to show" },
 
 
451
      { .name = "debug", .key = 129,
 
 
452
        .doc = "Debug mode" },
 
 
456
    __attribute__((nonnull(3)))
 
 
457
    error_t parse_opt (int key, char *arg, __attribute__((unused))
 
 
458
                       struct argp_state *state){
 
 
461
      case 128:                 /* --prompt */
 
 
464
          fprintf_plus(stderr, "Custom prompt \"%s\"\n", prompt);
 
 
467
      case 129:                 /* --debug */
 
 
471
        return ARGP_ERR_UNKNOWN;
 
 
476
    struct argp argp = { .options = options, .parser = parse_opt,
 
 
478
                         .doc = "Mandos plymouth -- Read and"
 
 
479
                         " output a password" };
 
 
480
    ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, NULL, NULL);
 
 
487
      error_plus(0, errno, "argp_parse");
 
 
490
      error_plus(0, errno, "argp_parse");
 
 
495
  /* test -x /bin/plymouth */
 
 
496
  ret = access(plymouth_path, X_OK);
 
 
498
    /* Plymouth is probably not installed.  Don't print an error
 
 
499
       message, just exit. */
 
 
501
      fprintf_plus(stderr, "Plymouth (%s) not found\n",
 
 
504
    exit(EX_UNAVAILABLE);
 
 
507
  { /* Add signal handlers */
 
 
508
    struct sigaction old_action,
 
 
509
      new_action = { .sa_handler = termination_handler,
 
 
511
    sigemptyset(&new_action.sa_mask);
 
 
512
    for(int *sig = (int[]){ SIGINT, SIGHUP, SIGTERM, 0 };
 
 
514
      ret = sigaddset(&new_action.sa_mask, *sig);
 
 
516
        error_plus(EX_OSERR, errno, "sigaddset");
 
 
518
      ret = sigaction(*sig, NULL, &old_action);
 
 
520
        error_plus(EX_OSERR, errno, "sigaction");
 
 
522
      if(old_action.sa_handler != SIG_IGN){
 
 
523
        ret = sigaction(*sig, &new_action, NULL);
 
 
525
          error_plus(EX_OSERR, errno, "sigaction");
 
 
531
  /* plymouth --ping */
 
 
532
  bret = exec_and_wait(&plymouth_command_pid, plymouth_path,
 
 
534
                       { plymouth_path, "--ping", NULL },
 
 
537
    if(interrupted_by_signal){
 
 
538
      kill_and_wait(plymouth_command_pid);
 
 
541
    /* Plymouth is probably not running.  Don't print an error
 
 
542
       message, just exit. */
 
 
544
      fprintf_plus(stderr, "Plymouth not running\n");
 
 
546
    exit(EX_UNAVAILABLE);
 
 
550
    ret = asprintf(&prompt_arg, "--prompt=%s", prompt);
 
 
552
    char *made_prompt = makeprompt();
 
 
553
    ret = asprintf(&prompt_arg, "--prompt=%s", made_prompt);
 
 
557
    error_plus(EX_OSERR, errno, "asprintf");
 
 
560
  /* plymouth ask-for-password --prompt="$prompt" */
 
 
562
    fprintf_plus(stderr, "Prompting for password via Plymouth\n");
 
 
564
  bret = exec_and_wait(&plymouth_command_pid,
 
 
565
                       plymouth_path, (const char *[])
 
 
566
                       { plymouth_path, "ask-for-password",
 
 
573
  if(not interrupted_by_signal){
 
 
574
    /* exec_and_wait failed for some other reason */
 
 
577
  kill_and_wait(plymouth_command_pid);
 
 
579
  char **plymouthd_argv = NULL;
 
 
580
  pid_t pid = get_pid();
 
 
582
    error_plus(0, 0, "plymouthd pid not found");
 
 
584
    plymouthd_argv = getargv(pid);
 
 
587
  bret = exec_and_wait(NULL, plymouth_path, (const char *[])
 
 
588
                       { plymouth_path, "quit", NULL },
 
 
591
    if(plymouthd_argv != NULL){
 
 
592
      free(*plymouthd_argv);
 
 
593
      free(plymouthd_argv);
 
 
597
  bret = exec_and_wait(NULL, plymouthd_path,
 
 
598
                       (plymouthd_argv != NULL)
 
 
599
                       ? (const char * const *)plymouthd_argv
 
 
600
                       : plymouthd_default_argv,
 
 
602
  if(plymouthd_argv != NULL){
 
 
603
    free(*plymouthd_argv);
 
 
604
    free(plymouthd_argv);
 
 
609
  exec_and_wait(NULL, plymouth_path, (const char *[])
 
 
610
                { plymouth_path, "show-splash", NULL },