/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to plugins.d/plymouth.c

  • Committer: teddy at recompile
  • Date: 2020-02-09 03:42:50 UTC
  • Revision ID: teddy@recompile.se-20200209034250-dxkkuq0eevnzk8py
Update formatting in TODO file

* TODO: Add markup, links and a file-wide tag.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/plymouth.c
2
2
/*
3
3
 * Plymouth - Read a password from Plymouth and output it
4
4
 * 
5
 
 * Copyright © 2010-2011 Teddy Hogeborn
6
 
 * Copyright © 2010-2011 Björn Påhlsson
7
 
 * 
8
 
 * This program is free software: you can redistribute it and/or
9
 
 * modify it under the terms of the GNU General Public License as
10
 
 * published by the Free Software Foundation, either version 3 of the
11
 
 * License, or (at your option) any later version.
12
 
 * 
13
 
 * This program is distributed in the hope that it will be useful, but
 
5
 * Copyright © 2010-2019 Teddy Hogeborn
 
6
 * Copyright © 2010-2019 Björn Påhlsson
 
7
 * 
 
8
 * This file is part of Mandos.
 
9
 * 
 
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.
 
14
 * 
 
15
 * Mandos is distributed in the hope that it will be useful, but
14
16
 * WITHOUT ANY WARRANTY; without even the implied warranty of
15
17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16
18
 * General Public License for more details.
17
19
 * 
18
20
 * You should have received a copy of the GNU General Public License
19
 
 * along with this program.  If not, see
20
 
 * <http://www.gnu.org/licenses/>.
 
21
 * along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
21
22
 * 
22
 
 * Contact the authors at <mandos@fukt.bsnet.se>.
 
23
 * Contact the authors at <mandos@recompile.se>.
23
24
 */
24
25
 
25
26
#define _GNU_SOURCE             /* asprintf(), TEMP_FAILURE_RETRY() */
36
37
#include <stddef.h>             /* NULL */
37
38
#include <string.h>             /* strchr(), memcmp() */
38
39
#include <stdio.h>              /* asprintf(), perror(), fopen(),
39
 
                                   fscanf() */
 
40
                                   fscanf(), vasprintf(), fprintf(),
 
41
                                   vfprintf() */
40
42
#include <unistd.h>             /* close(), readlink(), read(),
41
43
                                   fork(), setsid(), chdir(), dup2(),
42
44
                                   STDERR_FILENO, execv(), access() */
43
45
#include <stdlib.h>             /* free(), EXIT_FAILURE, realloc(),
44
46
                                   EXIT_SUCCESS, malloc(), _exit(),
45
 
                                   getenv() */
 
47
                                   getenv(), reallocarray() */
46
48
#include <dirent.h>             /* scandir(), alphasort() */
47
49
#include <inttypes.h>           /* intmax_t, strtoumax(), SCNuMAX */
48
50
#include <sys/stat.h>           /* struct stat, lstat() */
50
52
#include <error.h>              /* error() */
51
53
#include <errno.h>              /* TEMP_FAILURE_RETRY */
52
54
#include <argz.h>               /* argz_count(), argz_extract() */
 
55
#include <stdarg.h>             /* va_list, va_start(), ... */
 
56
#include <argp.h>
53
57
 
54
58
sig_atomic_t interrupted_by_signal = 0;
55
 
const char plymouth_pid[] = "/dev/.initramfs/plymouth.pid";
 
59
const char *argp_program_version = "plymouth " VERSION;
 
60
const char *argp_program_bug_address = "<mandos@recompile.se>";
 
61
 
 
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";
 
68
 
56
69
const char plymouth_path[] = "/bin/plymouth";
57
70
const char plymouthd_path[] = "/sbin/plymouthd";
58
71
const char *plymouthd_default_argv[] = {"/sbin/plymouthd",
59
72
                                        "--mode=boot",
60
73
                                        "--attach-to-session",
61
 
                                        "--pid-file="
62
 
                                        "/dev/.initramfs/"
63
 
                                        "plymouth.pid",
64
74
                                        NULL };
 
75
bool debug = false;
65
76
 
66
77
static void termination_handler(__attribute__((unused))int signum){
67
78
  if(interrupted_by_signal){
70
81
  interrupted_by_signal = 1;
71
82
}
72
83
 
 
84
__attribute__((format (gnu_printf, 2, 3), nonnull))
 
85
int fprintf_plus(FILE *stream, const char *format, ...){
 
86
  va_list ap;
 
87
  va_start (ap, format);
 
88
  fprintf(stream, "Mandos plugin %s: ", program_invocation_short_name);
 
89
  return vfprintf(stream, format, ap);
 
90
}
 
91
 
 
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,
 
95
                ...){
 
96
  va_list ap;
 
97
  char *text;
 
98
  int ret;
 
99
  
 
100
  va_start(ap, formatstring);
 
101
  ret = vasprintf(&text, formatstring, ap);
 
102
  if(ret == -1){
 
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");
 
109
    return;
 
110
  }
 
111
  fprintf(stderr, "Mandos plugin ");
 
112
  error(status, errnum, "%s", text);
 
113
  free(text);
 
114
}
 
115
 
73
116
/* Create prompt string */
74
117
char *makeprompt(void){
75
118
  int ret = 0;
109
152
bool become_a_daemon(void){
110
153
  int ret = setuid(geteuid());
111
154
  if(ret == -1){
112
 
    error(0, errno, "setuid");
 
155
    error_plus(0, errno, "setuid");
113
156
  }
114
157
    
115
158
  setsid();
116
159
  ret = chdir("/");
117
160
  if(ret == -1){
118
 
    error(0, errno, "chdir");
 
161
    error_plus(0, errno, "chdir");
119
162
    return false;
120
163
  }
121
164
  ret = dup2(STDERR_FILENO, STDOUT_FILENO); /* replace our stdout */
122
165
  if(ret == -1){
123
 
    error(0, errno, "dup2");
 
166
    error_plus(0, errno, "dup2");
124
167
    return false;
125
168
  }
126
169
  return true;
127
170
}
128
171
 
 
172
__attribute__((nonnull (2, 3)))
129
173
bool exec_and_wait(pid_t *pid_return, const char *path,
130
 
                   const char **argv, bool interruptable,
 
174
                   const char * const * const argv, bool interruptable,
131
175
                   bool daemonize){
132
176
  int status;
133
177
  int ret;
134
178
  pid_t pid;
 
179
  if(debug){
 
180
    for(const char * const *arg = argv; *arg != NULL; arg++){
 
181
      fprintf_plus(stderr, "exec_and_wait arg: %s\n", *arg);
 
182
    }
 
183
    fprintf_plus(stderr, "exec_and_wait end of args\n");
 
184
  }
 
185
 
135
186
  pid = fork();
136
187
  if(pid == -1){
137
 
    error(0, errno, "fork");
 
188
    error_plus(0, errno, "fork");
138
189
    return false;
139
190
  }
140
191
  if(pid == 0){
145
196
      }
146
197
    }
147
198
    
148
 
    char **new_argv = NULL;
 
199
    char **new_argv = malloc(sizeof(const char *));
 
200
    if(new_argv == NULL){
 
201
      error_plus(0, errno, "malloc");
 
202
      _exit(EX_OSERR);
 
203
    }
149
204
    char **tmp;
150
205
    int i = 0;
151
 
    for (; argv[i]!=NULL; i++){
152
 
      tmp = realloc(new_argv, sizeof(const char *) * ((size_t)i + 1));
153
 
      if (tmp == NULL){
154
 
        error(0, errno, "realloc");
 
206
    for (; argv[i] != NULL; i++){
 
207
#if defined(__GLIBC_PREREQ) and __GLIBC_PREREQ(2, 26)
 
208
      tmp = reallocarray(new_argv, ((size_t)i + 2),
 
209
                         sizeof(const char *));
 
210
#else
 
211
      if(((size_t)i + 2) > (SIZE_MAX / sizeof(const char *))){
 
212
        /* overflow */
 
213
        tmp = NULL;
 
214
        errno = ENOMEM;
 
215
      } else {
 
216
        tmp = realloc(new_argv, ((size_t)i + 2) * sizeof(const char *));
 
217
      }
 
218
#endif
 
219
      if(tmp == NULL){
 
220
        error_plus(0, errno, "reallocarray");
155
221
        free(new_argv);
156
222
        _exit(EX_OSERR);
157
223
      }
161
227
    new_argv[i] = NULL;
162
228
    
163
229
    execv(path, (char *const *)new_argv);
164
 
    error(0, errno, "execv");
 
230
    error_plus(0, errno, "execv");
165
231
    _exit(EXIT_FAILURE);
166
232
  }
167
233
  if(pid_return != NULL){
173
239
          and ((not interrupted_by_signal)
174
240
               or (not interruptable)));
175
241
  if(interrupted_by_signal and interruptable){
 
242
    if(debug){
 
243
      fprintf_plus(stderr, "Interrupted by signal\n");
 
244
    }
176
245
    return false;
177
246
  }
178
247
  if(ret == -1){
179
 
    error(0, errno, "waitpid");
 
248
    error_plus(0, errno, "waitpid");
180
249
    return false;
181
250
  }
 
251
  if(debug){
 
252
    if(WIFEXITED(status)){
 
253
      fprintf_plus(stderr, "exec_and_wait exited: %d\n",
 
254
                   WEXITSTATUS(status));
 
255
    } else if(WIFSIGNALED(status)) {
 
256
      fprintf_plus(stderr, "exec_and_wait signaled: %d\n",
 
257
                   WTERMSIG(status));
 
258
    }
 
259
  }
182
260
  if(WIFEXITED(status) and (WEXITSTATUS(status) == 0)){
183
261
    return true;
184
262
  }
185
263
  return false;
186
264
}
187
265
 
 
266
__attribute__((nonnull))
188
267
int is_plymouth(const struct dirent *proc_entry){
189
268
  int ret;
190
269
  {
191
 
    uintmax_t maxvalue;
 
270
    uintmax_t proc_id;
192
271
    char *tmp;
193
272
    errno = 0;
194
 
    maxvalue = strtoumax(proc_entry->d_name, &tmp, 10);
 
273
    proc_id = strtoumax(proc_entry->d_name, &tmp, 10);
195
274
 
196
275
    if(errno != 0 or *tmp != '\0'
197
 
       or maxvalue != (uintmax_t)((pid_t)maxvalue)){
 
276
       or proc_id != (uintmax_t)((pid_t)proc_id)){
198
277
      return 0;
199
278
    }
200
279
  }
202
281
  char *exe_link;
203
282
  ret = asprintf(&exe_link, "/proc/%s/exe", proc_entry->d_name);
204
283
  if(ret == -1){
205
 
    error(0, errno, "asprintf");
 
284
    error_plus(0, errno, "asprintf");
206
285
    return 0;
207
286
  }
208
287
  
211
290
  if(ret == -1){
212
291
    free(exe_link);
213
292
    if(errno != ENOENT){
214
 
      error(0, errno, "lstat");
 
293
      error_plus(0, errno, "lstat");
215
294
    }
216
295
    return 0;
217
296
  }
235
314
 
236
315
pid_t get_pid(void){
237
316
  int ret;
 
317
  uintmax_t proc_id = 0;
238
318
  FILE *pidfile = fopen(plymouth_pid, "r");
239
 
  uintmax_t maxvalue = 0;
 
319
  /* Try the new pid file location */
240
320
  if(pidfile != NULL){
241
 
    ret = fscanf(pidfile, "%" SCNuMAX, &maxvalue);
 
321
    ret = fscanf(pidfile, "%" SCNuMAX, &proc_id);
242
322
    if(ret != 1){
243
 
      maxvalue = 0;
 
323
      proc_id = 0;
244
324
    }
245
325
    fclose(pidfile);
246
326
  }
247
 
  if(maxvalue == 0){
248
 
    struct dirent **direntries;
 
327
  /* Try the old pid file location */
 
328
  if(proc_id == 0){
 
329
    pidfile = fopen(plymouth_old_pid, "r");
 
330
    if(pidfile != NULL){
 
331
      ret = fscanf(pidfile, "%" SCNuMAX, &proc_id);
 
332
      if(ret != 1){
 
333
        proc_id = 0;
 
334
      }
 
335
      fclose(pidfile);
 
336
    }
 
337
  }
 
338
  /* Try the old old pid file location */
 
339
  if(proc_id == 0){
 
340
    pidfile = fopen(plymouth_old_old_pid, "r");
 
341
    if(pidfile != NULL){
 
342
      ret = fscanf(pidfile, "%" SCNuMAX, &proc_id);
 
343
      if(ret != 1){
 
344
        proc_id = 0;
 
345
      }
 
346
      fclose(pidfile);
 
347
    }
 
348
  }
 
349
  /* Look for a plymouth process */
 
350
  if(proc_id == 0){
 
351
    struct dirent **direntries = NULL;
249
352
    ret = scandir("/proc", &direntries, is_plymouth, alphasort);
250
 
    if (ret == -1){
251
 
      error(0, errno, "scandir");
 
353
    if(ret == -1){
 
354
      error_plus(0, errno, "scandir");
252
355
    }
253
 
    if (ret > 0){
254
 
      ret = sscanf(direntries[0]->d_name, "%" SCNuMAX, &maxvalue);
255
 
      if (ret < 0){
256
 
        error(0, errno, "sscanf");
 
356
    if(ret > 0){
 
357
      for(int i = ret-1; i >= 0; i--){
 
358
        if(proc_id == 0){
 
359
          ret = sscanf(direntries[i]->d_name, "%" SCNuMAX, &proc_id);
 
360
          if(ret < 0){
 
361
            error_plus(0, errno, "sscanf");
 
362
          }
 
363
        }
 
364
        free(direntries[i]);
257
365
      }
258
366
    }
 
367
    /* scandir might preallocate for this variable (man page unclear).
 
368
       even if ret == 0, therefore we need to free it. */
 
369
    free(direntries);
259
370
  }
260
371
  pid_t pid;
261
 
  pid = (pid_t)maxvalue;
262
 
  if((uintmax_t)pid == maxvalue){
 
372
  pid = (pid_t)proc_id;
 
373
  if((uintmax_t)pid == proc_id){
263
374
    return pid;
264
375
  }
265
376
  
266
377
  return 0;
267
378
}
268
379
 
269
 
const char **getargv(pid_t pid){
 
380
char **getargv(pid_t pid){
270
381
  int cl_fd;
271
382
  char *cmdline_filename;
272
383
  ssize_t sret;
275
386
  ret = asprintf(&cmdline_filename, "/proc/%" PRIuMAX "/cmdline",
276
387
                 (uintmax_t)pid);
277
388
  if(ret == -1){
278
 
    error(0, errno, "asprintf");
 
389
    error_plus(0, errno, "asprintf");
279
390
    return NULL;
280
391
  }
281
392
  
283
394
  cl_fd = open(cmdline_filename, O_RDONLY);
284
395
  free(cmdline_filename);
285
396
  if(cl_fd == -1){
286
 
    error(0, errno, "open");
 
397
    error_plus(0, errno, "open");
287
398
    return NULL;
288
399
  }
289
400
  
297
408
    if(cmdline_len + blocksize > cmdline_allocated){
298
409
      tmp = realloc(cmdline, cmdline_allocated + blocksize);
299
410
      if(tmp == NULL){
300
 
        error(0, errno, "realloc");
 
411
        error_plus(0, errno, "realloc");
301
412
        free(cmdline);
302
413
        close(cl_fd);
303
414
        return NULL;
310
421
    sret = read(cl_fd, cmdline + cmdline_len,
311
422
                cmdline_allocated - cmdline_len);
312
423
    if(sret == -1){
313
 
      error(0, errno, "read");
 
424
      error_plus(0, errno, "read");
314
425
      free(cmdline);
315
426
      close(cl_fd);
316
427
      return NULL;
319
430
  } while(sret != 0);
320
431
  ret = close(cl_fd);
321
432
  if(ret == -1){
322
 
    error(0, errno, "close");
 
433
    error_plus(0, errno, "close");
323
434
    free(cmdline);
324
435
    return NULL;
325
436
  }
328
439
  char **argv = malloc((argz_count(cmdline, cmdline_len) + 1)
329
440
                       * sizeof(char *)); /* Get number of args */
330
441
  if(argv == NULL){
331
 
    error(0, errno, "argv = malloc()");
 
442
    error_plus(0, errno, "argv = malloc()");
332
443
    free(cmdline);
333
444
    return NULL;
334
445
  }
335
446
  argz_extract(cmdline, cmdline_len, argv); /* Create argv */
336
 
  return (const char **)argv;
 
447
  return argv;
337
448
}
338
449
 
339
450
int main(__attribute__((unused))int argc,
340
451
         __attribute__((unused))char **argv){
341
 
  char *prompt;
 
452
  char *prompt = NULL;
342
453
  char *prompt_arg;
343
454
  pid_t plymouth_command_pid;
344
455
  int ret;
345
456
  bool bret;
346
457
 
 
458
  {
 
459
    struct argp_option options[] = {
 
460
      { .name = "prompt", .key = 128, .arg = "PROMPT",
 
461
        .doc = "The prompt to show" },
 
462
      { .name = "debug", .key = 129,
 
463
        .doc = "Debug mode" },
 
464
      { .name = NULL }
 
465
    };
 
466
    
 
467
    __attribute__((nonnull(3)))
 
468
    error_t parse_opt (int key, char *arg, __attribute__((unused))
 
469
                       struct argp_state *state){
 
470
      errno = 0;
 
471
      switch (key){
 
472
      case 128:                 /* --prompt */
 
473
        prompt = arg;
 
474
        if(debug){
 
475
          fprintf_plus(stderr, "Custom prompt \"%s\"\n", prompt);
 
476
        }
 
477
        break;
 
478
      case 129:                 /* --debug */
 
479
        debug = true;
 
480
        break;
 
481
      default:
 
482
        return ARGP_ERR_UNKNOWN;
 
483
      }
 
484
      return errno;
 
485
    }
 
486
    
 
487
    struct argp argp = { .options = options, .parser = parse_opt,
 
488
                         .args_doc = "",
 
489
                         .doc = "Mandos plymouth -- Read and"
 
490
                         " output a password" };
 
491
    ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, NULL, NULL);
 
492
    switch(ret){
 
493
    case 0:
 
494
      break;
 
495
    case ENOMEM:
 
496
    default:
 
497
      errno = ret;
 
498
      error_plus(0, errno, "argp_parse");
 
499
      return EX_OSERR;
 
500
    case EINVAL:
 
501
      error_plus(0, errno, "argp_parse");
 
502
      return EX_USAGE;
 
503
    }
 
504
  }
 
505
  
347
506
  /* test -x /bin/plymouth */
348
507
  ret = access(plymouth_path, X_OK);
349
508
  if(ret == -1){
350
509
    /* Plymouth is probably not installed.  Don't print an error
351
510
       message, just exit. */
 
511
    if(debug){
 
512
      fprintf_plus(stderr, "Plymouth (%s) not found\n",
 
513
                   plymouth_path);
 
514
    }
352
515
    exit(EX_UNAVAILABLE);
353
516
  }
354
517
  
361
524
        *sig != 0; sig++){
362
525
      ret = sigaddset(&new_action.sa_mask, *sig);
363
526
      if(ret == -1){
364
 
        error(EX_OSERR, errno, "sigaddset");
 
527
        error_plus(EX_OSERR, errno, "sigaddset");
365
528
      }
366
529
      ret = sigaction(*sig, NULL, &old_action);
367
530
      if(ret == -1){
368
 
        error(EX_OSERR, errno, "sigaction");
 
531
        error_plus(EX_OSERR, errno, "sigaction");
369
532
      }
370
533
      if(old_action.sa_handler != SIG_IGN){
371
534
        ret = sigaction(*sig, &new_action, NULL);
372
535
        if(ret == -1){
373
 
          error(EX_OSERR, errno, "sigaction");
 
536
          error_plus(EX_OSERR, errno, "sigaction");
374
537
        }
375
538
      }
376
539
    }
388
551
    }
389
552
    /* Plymouth is probably not running.  Don't print an error
390
553
       message, just exit. */
 
554
    if(debug){
 
555
      fprintf_plus(stderr, "Plymouth not running\n");
 
556
    }
391
557
    exit(EX_UNAVAILABLE);
392
558
  }
393
559
  
394
 
  prompt = makeprompt();
395
 
  ret = asprintf(&prompt_arg, "--prompt=%s", prompt);
396
 
  free(prompt);
 
560
  if(prompt != NULL){
 
561
    ret = asprintf(&prompt_arg, "--prompt=%s", prompt);
 
562
  } else {
 
563
    char *made_prompt = makeprompt();
 
564
    ret = asprintf(&prompt_arg, "--prompt=%s", made_prompt);
 
565
    free(made_prompt);
 
566
  }
397
567
  if(ret == -1){
398
 
    error(EX_OSERR, errno, "asprintf");
 
568
    error_plus(EX_OSERR, errno, "asprintf");
399
569
  }
400
570
  
401
571
  /* plymouth ask-for-password --prompt="$prompt" */
 
572
  if(debug){
 
573
    fprintf_plus(stderr, "Prompting for password via Plymouth\n");
 
574
  }
402
575
  bret = exec_and_wait(&plymouth_command_pid,
403
576
                       plymouth_path, (const char *[])
404
577
                       { plymouth_path, "ask-for-password",
414
587
  }
415
588
  kill_and_wait(plymouth_command_pid);
416
589
  
417
 
  const char **plymouthd_argv;
 
590
  char **plymouthd_argv = NULL;
418
591
  pid_t pid = get_pid();
419
592
  if(pid == 0){
420
 
    error(0, 0, "plymouthd pid not found");
421
 
    plymouthd_argv = plymouthd_default_argv;
 
593
    error_plus(0, 0, "plymouthd pid not found");
422
594
  } else {
423
595
    plymouthd_argv = getargv(pid);
424
596
  }
427
599
                       { plymouth_path, "quit", NULL },
428
600
                       false, false);
429
601
  if(not bret){
 
602
    if(plymouthd_argv != NULL){
 
603
      free(*plymouthd_argv);
 
604
      free(plymouthd_argv);
 
605
    }
430
606
    exit(EXIT_FAILURE);
431
607
  }
432
 
  bret = exec_and_wait(NULL, plymouthd_path, plymouthd_argv,
 
608
  bret = exec_and_wait(NULL, plymouthd_path,
 
609
                       (plymouthd_argv != NULL)
 
610
                       ? (const char * const *)plymouthd_argv
 
611
                       : plymouthd_default_argv,
433
612
                       false, true);
 
613
  if(plymouthd_argv != NULL){
 
614
    free(*plymouthd_argv);
 
615
    free(plymouthd_argv);
 
616
  }
434
617
  if(not bret){
435
618
    exit(EXIT_FAILURE);
436
619
  }