/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-07-04 09:04:03 UTC
  • Revision ID: teddy@recompile.se-20200704090403-genhux7261tjpcou
mandos-ctl: Correct and add some comments

* mandos-ctl: Correct program description in file header comment.
  (dbussy_adapter.SystemBus.call_method): Correct comment about DBussy
  return values.
  (dbussy_adapter.SystemBus.type_filter): Add comment about the
  representation of DBussy "Variant" values.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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() */
43
44
                                   STDERR_FILENO, execv(), access() */
44
45
#include <stdlib.h>             /* free(), EXIT_FAILURE, realloc(),
45
46
                                   EXIT_SUCCESS, malloc(), _exit(),
46
 
                                   getenv() */
 
47
                                   getenv(), reallocarray() */
47
48
#include <dirent.h>             /* scandir(), alphasort() */
48
49
#include <inttypes.h>           /* intmax_t, strtoumax(), SCNuMAX */
49
50
#include <sys/stat.h>           /* struct stat, lstat() */
52
53
#include <errno.h>              /* TEMP_FAILURE_RETRY */
53
54
#include <argz.h>               /* argz_count(), argz_extract() */
54
55
#include <stdarg.h>             /* va_list, va_start(), ... */
 
56
#include <argp.h>
55
57
 
56
58
sig_atomic_t interrupted_by_signal = 0;
57
 
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
 
58
69
const char plymouth_path[] = "/bin/plymouth";
59
70
const char plymouthd_path[] = "/sbin/plymouthd";
60
71
const char *plymouthd_default_argv[] = {"/sbin/plymouthd",
61
72
                                        "--mode=boot",
62
73
                                        "--attach-to-session",
63
 
                                        "--pid-file="
64
 
                                        "/dev/.initramfs/"
65
 
                                        "plymouth.pid",
66
74
                                        NULL };
 
75
bool debug = false;
67
76
 
68
77
static void termination_handler(__attribute__((unused))int signum){
69
78
  if(interrupted_by_signal){
72
81
  interrupted_by_signal = 1;
73
82
}
74
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
 
75
92
/* Function to use when printing errors */
 
93
__attribute__((format (gnu_printf, 3, 4)))
76
94
void error_plus(int status, int errnum, const char *formatstring,
77
95
                ...){
78
96
  va_list ap;
81
99
  
82
100
  va_start(ap, formatstring);
83
101
  ret = vasprintf(&text, formatstring, ap);
84
 
  if (ret == -1){
 
102
  if(ret == -1){
85
103
    fprintf(stderr, "Mandos plugin %s: ",
86
104
            program_invocation_short_name);
87
105
    vfprintf(stderr, formatstring, ap);
151
169
  return true;
152
170
}
153
171
 
 
172
__attribute__((nonnull (2, 3)))
154
173
bool exec_and_wait(pid_t *pid_return, const char *path,
155
 
                   const char **argv, bool interruptable,
 
174
                   const char * const * const argv, bool interruptable,
156
175
                   bool daemonize){
157
176
  int status;
158
177
  int ret;
159
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
 
160
186
  pid = fork();
161
187
  if(pid == -1){
162
188
    error_plus(0, errno, "fork");
170
196
      }
171
197
    }
172
198
    
173
 
    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
    }
174
204
    char **tmp;
175
205
    int i = 0;
176
 
    for (; argv[i]!=NULL; i++){
177
 
      tmp = realloc(new_argv, sizeof(const char *) * ((size_t)i + 1));
178
 
      if (tmp == NULL){
179
 
        error_plus(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");
180
221
        free(new_argv);
181
222
        _exit(EX_OSERR);
182
223
      }
198
239
          and ((not interrupted_by_signal)
199
240
               or (not interruptable)));
200
241
  if(interrupted_by_signal and interruptable){
 
242
    if(debug){
 
243
      fprintf_plus(stderr, "Interrupted by signal\n");
 
244
    }
201
245
    return false;
202
246
  }
203
247
  if(ret == -1){
204
248
    error_plus(0, errno, "waitpid");
205
249
    return false;
206
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
  }
207
260
  if(WIFEXITED(status) and (WEXITSTATUS(status) == 0)){
208
261
    return true;
209
262
  }
210
263
  return false;
211
264
}
212
265
 
 
266
__attribute__((nonnull))
213
267
int is_plymouth(const struct dirent *proc_entry){
214
268
  int ret;
215
269
  {
216
 
    uintmax_t maxvalue;
 
270
    uintmax_t proc_id;
217
271
    char *tmp;
218
272
    errno = 0;
219
 
    maxvalue = strtoumax(proc_entry->d_name, &tmp, 10);
 
273
    proc_id = strtoumax(proc_entry->d_name, &tmp, 10);
220
274
 
221
275
    if(errno != 0 or *tmp != '\0'
222
 
       or maxvalue != (uintmax_t)((pid_t)maxvalue)){
 
276
       or proc_id != (uintmax_t)((pid_t)proc_id)){
223
277
      return 0;
224
278
    }
225
279
  }
260
314
 
261
315
pid_t get_pid(void){
262
316
  int ret;
 
317
  uintmax_t proc_id = 0;
263
318
  FILE *pidfile = fopen(plymouth_pid, "r");
264
 
  uintmax_t maxvalue = 0;
 
319
  /* Try the new pid file location */
265
320
  if(pidfile != NULL){
266
 
    ret = fscanf(pidfile, "%" SCNuMAX, &maxvalue);
 
321
    ret = fscanf(pidfile, "%" SCNuMAX, &proc_id);
267
322
    if(ret != 1){
268
 
      maxvalue = 0;
 
323
      proc_id = 0;
269
324
    }
270
325
    fclose(pidfile);
271
326
  }
272
 
  if(maxvalue == 0){
 
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){
273
351
    struct dirent **direntries = NULL;
274
352
    ret = scandir("/proc", &direntries, is_plymouth, alphasort);
275
 
    if (ret == -1){
 
353
    if(ret == -1){
276
354
      error_plus(0, errno, "scandir");
277
355
    }
278
 
    if (ret > 0){
279
 
      ret = sscanf(direntries[0]->d_name, "%" SCNuMAX, &maxvalue);
280
 
      if (ret < 0){
281
 
        error_plus(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]);
282
365
      }
283
366
    }
284
367
    /* scandir might preallocate for this variable (man page unclear).
286
369
    free(direntries);
287
370
  }
288
371
  pid_t pid;
289
 
  pid = (pid_t)maxvalue;
290
 
  if((uintmax_t)pid == maxvalue){
 
372
  pid = (pid_t)proc_id;
 
373
  if((uintmax_t)pid == proc_id){
291
374
    return pid;
292
375
  }
293
376
  
294
377
  return 0;
295
378
}
296
379
 
297
 
const char **getargv(pid_t pid){
 
380
char **getargv(pid_t pid){
298
381
  int cl_fd;
299
382
  char *cmdline_filename;
300
383
  ssize_t sret;
361
444
    return NULL;
362
445
  }
363
446
  argz_extract(cmdline, cmdline_len, argv); /* Create argv */
364
 
  return (const char **)argv;
 
447
  return argv;
365
448
}
366
449
 
367
450
int main(__attribute__((unused))int argc,
368
451
         __attribute__((unused))char **argv){
369
 
  char *prompt;
 
452
  char *prompt = NULL;
370
453
  char *prompt_arg;
371
454
  pid_t plymouth_command_pid;
372
455
  int ret;
373
456
  bool bret;
374
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
  
375
506
  /* test -x /bin/plymouth */
376
507
  ret = access(plymouth_path, X_OK);
377
508
  if(ret == -1){
378
509
    /* Plymouth is probably not installed.  Don't print an error
379
510
       message, just exit. */
 
511
    if(debug){
 
512
      fprintf_plus(stderr, "Plymouth (%s) not found\n",
 
513
                   plymouth_path);
 
514
    }
380
515
    exit(EX_UNAVAILABLE);
381
516
  }
382
517
  
416
551
    }
417
552
    /* Plymouth is probably not running.  Don't print an error
418
553
       message, just exit. */
 
554
    if(debug){
 
555
      fprintf_plus(stderr, "Plymouth not running\n");
 
556
    }
419
557
    exit(EX_UNAVAILABLE);
420
558
  }
421
559
  
422
 
  prompt = makeprompt();
423
 
  ret = asprintf(&prompt_arg, "--prompt=%s", prompt);
424
 
  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
  }
425
567
  if(ret == -1){
426
568
    error_plus(EX_OSERR, errno, "asprintf");
427
569
  }
428
570
  
429
571
  /* plymouth ask-for-password --prompt="$prompt" */
 
572
  if(debug){
 
573
    fprintf_plus(stderr, "Prompting for password via Plymouth\n");
 
574
  }
430
575
  bret = exec_and_wait(&plymouth_command_pid,
431
576
                       plymouth_path, (const char *[])
432
577
                       { plymouth_path, "ask-for-password",
442
587
  }
443
588
  kill_and_wait(plymouth_command_pid);
444
589
  
445
 
  const char **plymouthd_argv;
 
590
  char **plymouthd_argv = NULL;
446
591
  pid_t pid = get_pid();
447
592
  if(pid == 0){
448
593
    error_plus(0, 0, "plymouthd pid not found");
449
 
    plymouthd_argv = plymouthd_default_argv;
450
594
  } else {
451
595
    plymouthd_argv = getargv(pid);
452
596
  }
455
599
                       { plymouth_path, "quit", NULL },
456
600
                       false, false);
457
601
  if(not bret){
 
602
    if(plymouthd_argv != NULL){
 
603
      free(*plymouthd_argv);
 
604
      free(plymouthd_argv);
 
605
    }
458
606
    exit(EXIT_FAILURE);
459
607
  }
460
 
  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,
461
612
                       false, true);
 
613
  if(plymouthd_argv != NULL){
 
614
    free(*plymouthd_argv);
 
615
    free(plymouthd_argv);
 
616
  }
462
617
  if(not bret){
463
618
    exit(EXIT_FAILURE);
464
619
  }