/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 Hogeborn
  • Date: 2019-07-29 16:35:53 UTC
  • Revision ID: teddy@recompile.se-20190729163553-1i442i2cbx64c537
Make tests and man page examples match

Make the tests test_manual_page_example[1-5] match exactly what is
written in the manual page, and add comments to manual page as
reminders to keep tests and manual page examples in sync.

* mandos-ctl (Test_commands_from_options.test_manual_page_example_1):
  Remove "--verbose" option, since the manual does not have it as the
  first example, and change assertion to match.
* mandos-ctl.xml (EXAMPLE): Add comments to all examples documenting
  which test function they correspond to.  Also remove unnecessary
  quotes from option arguments in fourth example, and clarify language
  slightly in fifth example.

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
23
 * Contact the authors at <mandos@recompile.se>.
23
24
 */
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;
 
59
const char *argp_program_version = "plymouth " VERSION;
 
60
const char *argp_program_bug_address = "<mandos@recompile.se>";
57
61
 
58
62
/* Used by Ubuntu 11.04 (Natty Narwahl) */
59
 
const char plymouth_old_pid[] = "/dev/.initramfs/plymouth.pid";
 
63
const char plymouth_old_old_pid[] = "/dev/.initramfs/plymouth.pid";
60
64
/* Used by Ubuntu 11.10 (Oneiric Ocelot) */
61
 
const char plymouth_pid[] = "/run/initramfs/plymouth.pid";
 
65
const char plymouth_old_pid[] = "/run/initramfs/plymouth.pid";
 
66
/* Used by Debian 9 (stretch) */
 
67
const char plymouth_pid[] = "/run/plymouth/pid";
62
68
 
63
69
const char plymouth_path[] = "/bin/plymouth";
64
70
const char plymouthd_path[] = "/sbin/plymouthd";
66
72
                                        "--mode=boot",
67
73
                                        "--attach-to-session",
68
74
                                        NULL };
 
75
bool debug = false;
69
76
 
70
77
static void termination_handler(__attribute__((unused))int signum){
71
78
  if(interrupted_by_signal){
74
81
  interrupted_by_signal = 1;
75
82
}
76
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
 
77
92
/* Function to use when printing errors */
78
93
__attribute__((format (gnu_printf, 3, 4)))
79
94
void error_plus(int status, int errnum, const char *formatstring,
84
99
  
85
100
  va_start(ap, formatstring);
86
101
  ret = vasprintf(&text, formatstring, ap);
87
 
  if (ret == -1){
 
102
  if(ret == -1){
88
103
    fprintf(stderr, "Mandos plugin %s: ",
89
104
            program_invocation_short_name);
90
105
    vfprintf(stderr, formatstring, ap);
154
169
  return true;
155
170
}
156
171
 
 
172
__attribute__((nonnull (2, 3)))
157
173
bool exec_and_wait(pid_t *pid_return, const char *path,
158
 
                   const char **argv, bool interruptable,
 
174
                   const char * const * const argv, bool interruptable,
159
175
                   bool daemonize){
160
176
  int status;
161
177
  int ret;
162
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
 
163
186
  pid = fork();
164
187
  if(pid == -1){
165
188
    error_plus(0, errno, "fork");
173
196
      }
174
197
    }
175
198
    
176
 
    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
    }
177
204
    char **tmp;
178
205
    int i = 0;
179
 
    for (; argv[i]!=NULL; i++){
180
 
      tmp = realloc(new_argv, sizeof(const char *) * ((size_t)i + 1));
181
 
      if (tmp == NULL){
 
206
    for (; argv[i] != NULL; i++){
 
207
      tmp = realloc(new_argv, sizeof(const char *) * ((size_t)i + 2));
 
208
      if(tmp == NULL){
182
209
        error_plus(0, errno, "realloc");
183
210
        free(new_argv);
184
211
        _exit(EX_OSERR);
201
228
          and ((not interrupted_by_signal)
202
229
               or (not interruptable)));
203
230
  if(interrupted_by_signal and interruptable){
 
231
    if(debug){
 
232
      fprintf_plus(stderr, "Interrupted by signal\n");
 
233
    }
204
234
    return false;
205
235
  }
206
236
  if(ret == -1){
207
237
    error_plus(0, errno, "waitpid");
208
238
    return false;
209
239
  }
 
240
  if(debug){
 
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",
 
246
                   WTERMSIG(status));
 
247
    }
 
248
  }
210
249
  if(WIFEXITED(status) and (WEXITSTATUS(status) == 0)){
211
250
    return true;
212
251
  }
213
252
  return false;
214
253
}
215
254
 
 
255
__attribute__((nonnull))
216
256
int is_plymouth(const struct dirent *proc_entry){
217
257
  int ret;
218
258
  {
219
 
    uintmax_t maxvalue;
 
259
    uintmax_t proc_id;
220
260
    char *tmp;
221
261
    errno = 0;
222
 
    maxvalue = strtoumax(proc_entry->d_name, &tmp, 10);
 
262
    proc_id = strtoumax(proc_entry->d_name, &tmp, 10);
223
263
 
224
264
    if(errno != 0 or *tmp != '\0'
225
 
       or maxvalue != (uintmax_t)((pid_t)maxvalue)){
 
265
       or proc_id != (uintmax_t)((pid_t)proc_id)){
226
266
      return 0;
227
267
    }
228
268
  }
263
303
 
264
304
pid_t get_pid(void){
265
305
  int ret;
266
 
  uintmax_t maxvalue = 0;
 
306
  uintmax_t proc_id = 0;
267
307
  FILE *pidfile = fopen(plymouth_pid, "r");
268
308
  /* Try the new pid file location */
269
309
  if(pidfile != NULL){
270
 
    ret = fscanf(pidfile, "%" SCNuMAX, &maxvalue);
 
310
    ret = fscanf(pidfile, "%" SCNuMAX, &proc_id);
271
311
    if(ret != 1){
272
 
      maxvalue = 0;
 
312
      proc_id = 0;
273
313
    }
274
314
    fclose(pidfile);
275
315
  }
276
316
  /* Try the old pid file location */
277
 
  if(maxvalue == 0){
278
 
    pidfile = fopen(plymouth_pid, "r");
279
 
    if(pidfile != NULL){
280
 
      ret = fscanf(pidfile, "%" SCNuMAX, &maxvalue);
281
 
      if(ret != 1){
282
 
        maxvalue = 0;
 
317
  if(proc_id == 0){
 
318
    pidfile = fopen(plymouth_old_pid, "r");
 
319
    if(pidfile != NULL){
 
320
      ret = fscanf(pidfile, "%" SCNuMAX, &proc_id);
 
321
      if(ret != 1){
 
322
        proc_id = 0;
 
323
      }
 
324
      fclose(pidfile);
 
325
    }
 
326
  }
 
327
  /* Try the old old pid file location */
 
328
  if(proc_id == 0){
 
329
    pidfile = fopen(plymouth_old_old_pid, "r");
 
330
    if(pidfile != NULL){
 
331
      ret = fscanf(pidfile, "%" SCNuMAX, &proc_id);
 
332
      if(ret != 1){
 
333
        proc_id = 0;
283
334
      }
284
335
      fclose(pidfile);
285
336
    }
286
337
  }
287
338
  /* Look for a plymouth process */
288
 
  if(maxvalue == 0){
 
339
  if(proc_id == 0){
289
340
    struct dirent **direntries = NULL;
290
341
    ret = scandir("/proc", &direntries, is_plymouth, alphasort);
291
 
    if (ret == -1){
 
342
    if(ret == -1){
292
343
      error_plus(0, errno, "scandir");
293
344
    }
294
 
    if (ret > 0){
295
 
      ret = sscanf(direntries[0]->d_name, "%" SCNuMAX, &maxvalue);
296
 
      if (ret < 0){
297
 
        error_plus(0, errno, "sscanf");
 
345
    if(ret > 0){
 
346
      for(int i = ret-1; i >= 0; i--){
 
347
        if(proc_id == 0){
 
348
          ret = sscanf(direntries[i]->d_name, "%" SCNuMAX, &proc_id);
 
349
          if(ret < 0){
 
350
            error_plus(0, errno, "sscanf");
 
351
          }
 
352
        }
 
353
        free(direntries[i]);
298
354
      }
299
355
    }
300
356
    /* scandir might preallocate for this variable (man page unclear).
302
358
    free(direntries);
303
359
  }
304
360
  pid_t pid;
305
 
  pid = (pid_t)maxvalue;
306
 
  if((uintmax_t)pid == maxvalue){
 
361
  pid = (pid_t)proc_id;
 
362
  if((uintmax_t)pid == proc_id){
307
363
    return pid;
308
364
  }
309
365
  
310
366
  return 0;
311
367
}
312
368
 
313
 
const char **getargv(pid_t pid){
 
369
char **getargv(pid_t pid){
314
370
  int cl_fd;
315
371
  char *cmdline_filename;
316
372
  ssize_t sret;
377
433
    return NULL;
378
434
  }
379
435
  argz_extract(cmdline, cmdline_len, argv); /* Create argv */
380
 
  return (const char **)argv;
 
436
  return argv;
381
437
}
382
438
 
383
439
int main(__attribute__((unused))int argc,
384
440
         __attribute__((unused))char **argv){
385
 
  char *prompt;
 
441
  char *prompt = NULL;
386
442
  char *prompt_arg;
387
443
  pid_t plymouth_command_pid;
388
444
  int ret;
389
445
  bool bret;
390
446
 
 
447
  {
 
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" },
 
453
      { .name = NULL }
 
454
    };
 
455
    
 
456
    __attribute__((nonnull(3)))
 
457
    error_t parse_opt (int key, char *arg, __attribute__((unused))
 
458
                       struct argp_state *state){
 
459
      errno = 0;
 
460
      switch (key){
 
461
      case 128:                 /* --prompt */
 
462
        prompt = arg;
 
463
        if(debug){
 
464
          fprintf_plus(stderr, "Custom prompt \"%s\"\n", prompt);
 
465
        }
 
466
        break;
 
467
      case 129:                 /* --debug */
 
468
        debug = true;
 
469
        break;
 
470
      default:
 
471
        return ARGP_ERR_UNKNOWN;
 
472
      }
 
473
      return errno;
 
474
    }
 
475
    
 
476
    struct argp argp = { .options = options, .parser = parse_opt,
 
477
                         .args_doc = "",
 
478
                         .doc = "Mandos plymouth -- Read and"
 
479
                         " output a password" };
 
480
    ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, NULL, NULL);
 
481
    switch(ret){
 
482
    case 0:
 
483
      break;
 
484
    case ENOMEM:
 
485
    default:
 
486
      errno = ret;
 
487
      error_plus(0, errno, "argp_parse");
 
488
      return EX_OSERR;
 
489
    case EINVAL:
 
490
      error_plus(0, errno, "argp_parse");
 
491
      return EX_USAGE;
 
492
    }
 
493
  }
 
494
  
391
495
  /* test -x /bin/plymouth */
392
496
  ret = access(plymouth_path, X_OK);
393
497
  if(ret == -1){
394
498
    /* Plymouth is probably not installed.  Don't print an error
395
499
       message, just exit. */
 
500
    if(debug){
 
501
      fprintf_plus(stderr, "Plymouth (%s) not found\n",
 
502
                   plymouth_path);
 
503
    }
396
504
    exit(EX_UNAVAILABLE);
397
505
  }
398
506
  
432
540
    }
433
541
    /* Plymouth is probably not running.  Don't print an error
434
542
       message, just exit. */
 
543
    if(debug){
 
544
      fprintf_plus(stderr, "Plymouth not running\n");
 
545
    }
435
546
    exit(EX_UNAVAILABLE);
436
547
  }
437
548
  
438
 
  prompt = makeprompt();
439
 
  ret = asprintf(&prompt_arg, "--prompt=%s", prompt);
440
 
  free(prompt);
 
549
  if(prompt != NULL){
 
550
    ret = asprintf(&prompt_arg, "--prompt=%s", prompt);
 
551
  } else {
 
552
    char *made_prompt = makeprompt();
 
553
    ret = asprintf(&prompt_arg, "--prompt=%s", made_prompt);
 
554
    free(made_prompt);
 
555
  }
441
556
  if(ret == -1){
442
557
    error_plus(EX_OSERR, errno, "asprintf");
443
558
  }
444
559
  
445
560
  /* plymouth ask-for-password --prompt="$prompt" */
 
561
  if(debug){
 
562
    fprintf_plus(stderr, "Prompting for password via Plymouth\n");
 
563
  }
446
564
  bret = exec_and_wait(&plymouth_command_pid,
447
565
                       plymouth_path, (const char *[])
448
566
                       { plymouth_path, "ask-for-password",
458
576
  }
459
577
  kill_and_wait(plymouth_command_pid);
460
578
  
461
 
  const char **plymouthd_argv;
 
579
  char **plymouthd_argv = NULL;
462
580
  pid_t pid = get_pid();
463
581
  if(pid == 0){
464
582
    error_plus(0, 0, "plymouthd pid not found");
465
 
    plymouthd_argv = plymouthd_default_argv;
466
583
  } else {
467
584
    plymouthd_argv = getargv(pid);
468
585
  }
471
588
                       { plymouth_path, "quit", NULL },
472
589
                       false, false);
473
590
  if(not bret){
 
591
    if(plymouthd_argv != NULL){
 
592
      free(*plymouthd_argv);
 
593
      free(plymouthd_argv);
 
594
    }
474
595
    exit(EXIT_FAILURE);
475
596
  }
476
 
  bret = exec_and_wait(NULL, plymouthd_path, plymouthd_argv,
 
597
  bret = exec_and_wait(NULL, plymouthd_path,
 
598
                       (plymouthd_argv != NULL)
 
599
                       ? (const char * const *)plymouthd_argv
 
600
                       : plymouthd_default_argv,
477
601
                       false, true);
 
602
  if(plymouthd_argv != NULL){
 
603
    free(*plymouthd_argv);
 
604
    free(plymouthd_argv);
 
605
  }
478
606
  if(not bret){
479
607
    exit(EXIT_FAILURE);
480
608
  }