/mandos/release

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

« back to all changes in this revision

Viewing changes to plugins.d/plymouth.c

* DBUS-API: Fix grammar.

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-2020 Teddy Hogeborn
6
 
 * Copyright © 2010-2020 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
 
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
16
14
 * WITHOUT ANY WARRANTY; without even the implied warranty of
17
15
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18
16
 * General Public License for more details.
19
17
 * 
20
18
 * You should have received a copy of the GNU General Public License
21
 
 * along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
 
19
 * along with this program.  If not, see
 
20
 * <http://www.gnu.org/licenses/>.
22
21
 * 
23
 
 * Contact the authors at <mandos@recompile.se>.
 
22
 * Contact the authors at <mandos@fukt.bsnet.se>.
24
23
 */
25
24
 
26
25
#define _GNU_SOURCE             /* asprintf(), TEMP_FAILURE_RETRY() */
37
36
#include <stddef.h>             /* NULL */
38
37
#include <string.h>             /* strchr(), memcmp() */
39
38
#include <stdio.h>              /* asprintf(), perror(), fopen(),
40
 
                                   fscanf(), vasprintf(), fprintf(),
41
 
                                   vfprintf() */
 
39
                                   fscanf() */
42
40
#include <unistd.h>             /* close(), readlink(), read(),
43
41
                                   fork(), setsid(), chdir(), dup2(),
44
42
                                   STDERR_FILENO, execv(), access() */
45
43
#include <stdlib.h>             /* free(), EXIT_FAILURE, realloc(),
46
44
                                   EXIT_SUCCESS, malloc(), _exit(),
47
 
                                   getenv(), reallocarray() */
 
45
                                   getenv() */
48
46
#include <dirent.h>             /* scandir(), alphasort() */
49
47
#include <inttypes.h>           /* intmax_t, strtoumax(), SCNuMAX */
50
48
#include <sys/stat.h>           /* struct stat, lstat() */
52
50
#include <error.h>              /* error() */
53
51
#include <errno.h>              /* TEMP_FAILURE_RETRY */
54
52
#include <argz.h>               /* argz_count(), argz_extract() */
55
 
#include <stdarg.h>             /* va_list, va_start(), ... */
56
 
#include <argp.h>
57
53
 
58
54
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>";
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
 
 
 
55
const char plymouth_pid[] = "/dev/.initramfs/plymouth.pid";
69
56
const char plymouth_path[] = "/bin/plymouth";
70
57
const char plymouthd_path[] = "/sbin/plymouthd";
71
58
const char *plymouthd_default_argv[] = {"/sbin/plymouthd",
72
59
                                        "--mode=boot",
73
60
                                        "--attach-to-session",
 
61
                                        "--pid-file="
 
62
                                        "/dev/.initramfs/"
 
63
                                        "plymouth.pid",
74
64
                                        NULL };
75
 
bool debug = false;
76
65
 
77
66
static void termination_handler(__attribute__((unused))int signum){
78
67
  if(interrupted_by_signal){
81
70
  interrupted_by_signal = 1;
82
71
}
83
72
 
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
 
 
116
73
/* Create prompt string */
117
74
char *makeprompt(void){
118
75
  int ret = 0;
152
109
bool become_a_daemon(void){
153
110
  int ret = setuid(geteuid());
154
111
  if(ret == -1){
155
 
    error_plus(0, errno, "setuid");
 
112
    error(0, errno, "setuid");
156
113
  }
157
114
    
158
115
  setsid();
159
116
  ret = chdir("/");
160
117
  if(ret == -1){
161
 
    error_plus(0, errno, "chdir");
 
118
    error(0, errno, "chdir");
162
119
    return false;
163
120
  }
164
121
  ret = dup2(STDERR_FILENO, STDOUT_FILENO); /* replace our stdout */
165
122
  if(ret == -1){
166
 
    error_plus(0, errno, "dup2");
 
123
    error(0, errno, "dup2");
167
124
    return false;
168
125
  }
169
126
  return true;
170
127
}
171
128
 
172
 
__attribute__((nonnull (2, 3)))
173
129
bool exec_and_wait(pid_t *pid_return, const char *path,
174
 
                   const char * const * const argv, bool interruptable,
 
130
                   const char **argv, bool interruptable,
175
131
                   bool daemonize){
176
132
  int status;
177
133
  int ret;
178
134
  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
 
 
186
135
  pid = fork();
187
136
  if(pid == -1){
188
 
    error_plus(0, errno, "fork");
 
137
    error(0, errno, "fork");
189
138
    return false;
190
139
  }
191
140
  if(pid == 0){
196
145
      }
197
146
    }
198
147
    
199
 
    char **new_argv = malloc(sizeof(const char *));
200
 
    if(new_argv == NULL){
201
 
      error_plus(0, errno, "malloc");
202
 
      _exit(EX_OSERR);
203
 
    }
 
148
    char **new_argv = NULL;
204
149
    char **tmp;
205
150
    int i = 0;
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");
 
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");
221
155
        free(new_argv);
222
156
        _exit(EX_OSERR);
223
157
      }
227
161
    new_argv[i] = NULL;
228
162
    
229
163
    execv(path, (char *const *)new_argv);
230
 
    error_plus(0, errno, "execv");
 
164
    error(0, errno, "execv");
231
165
    _exit(EXIT_FAILURE);
232
166
  }
233
167
  if(pid_return != NULL){
239
173
          and ((not interrupted_by_signal)
240
174
               or (not interruptable)));
241
175
  if(interrupted_by_signal and interruptable){
242
 
    if(debug){
243
 
      fprintf_plus(stderr, "Interrupted by signal\n");
244
 
    }
245
176
    return false;
246
177
  }
247
178
  if(ret == -1){
248
 
    error_plus(0, errno, "waitpid");
 
179
    error(0, errno, "waitpid");
249
180
    return false;
250
181
  }
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
 
  }
260
182
  if(WIFEXITED(status) and (WEXITSTATUS(status) == 0)){
261
183
    return true;
262
184
  }
263
185
  return false;
264
186
}
265
187
 
266
 
__attribute__((nonnull))
267
188
int is_plymouth(const struct dirent *proc_entry){
268
189
  int ret;
269
190
  {
270
 
    uintmax_t proc_id;
 
191
    uintmax_t maxvalue;
271
192
    char *tmp;
272
193
    errno = 0;
273
 
    proc_id = strtoumax(proc_entry->d_name, &tmp, 10);
 
194
    maxvalue = strtoumax(proc_entry->d_name, &tmp, 10);
274
195
 
275
196
    if(errno != 0 or *tmp != '\0'
276
 
       or proc_id != (uintmax_t)((pid_t)proc_id)){
 
197
       or maxvalue != (uintmax_t)((pid_t)maxvalue)){
277
198
      return 0;
278
199
    }
279
200
  }
281
202
  char *exe_link;
282
203
  ret = asprintf(&exe_link, "/proc/%s/exe", proc_entry->d_name);
283
204
  if(ret == -1){
284
 
    error_plus(0, errno, "asprintf");
 
205
    error(0, errno, "asprintf");
285
206
    return 0;
286
207
  }
287
208
  
290
211
  if(ret == -1){
291
212
    free(exe_link);
292
213
    if(errno != ENOENT){
293
 
      error_plus(0, errno, "lstat");
 
214
      error(0, errno, "lstat");
294
215
    }
295
216
    return 0;
296
217
  }
314
235
 
315
236
pid_t get_pid(void){
316
237
  int ret;
317
 
  uintmax_t proc_id = 0;
318
238
  FILE *pidfile = fopen(plymouth_pid, "r");
319
 
  /* Try the new pid file location */
 
239
  uintmax_t maxvalue = 0;
320
240
  if(pidfile != NULL){
321
 
    ret = fscanf(pidfile, "%" SCNuMAX, &proc_id);
 
241
    ret = fscanf(pidfile, "%" SCNuMAX, &maxvalue);
322
242
    if(ret != 1){
323
 
      proc_id = 0;
 
243
      maxvalue = 0;
324
244
    }
325
245
    fclose(pidfile);
326
246
  }
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;
 
247
  if(maxvalue == 0){
 
248
    struct dirent **direntries;
352
249
    ret = scandir("/proc", &direntries, is_plymouth, alphasort);
353
 
    if(ret == -1){
354
 
      error_plus(0, errno, "scandir");
 
250
    if (ret == -1){
 
251
      error(0, errno, "scandir");
355
252
    }
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]);
 
253
    if (ret > 0){
 
254
      ret = sscanf(direntries[0]->d_name, "%" SCNuMAX, &maxvalue);
 
255
      if (ret < 0){
 
256
        error(0, errno, "sscanf");
365
257
      }
366
258
    }
367
 
    /* scandir might preallocate for this variable (man page unclear).
368
 
       even if ret == 0, therefore we need to free it. */
369
 
    free(direntries);
370
259
  }
371
260
  pid_t pid;
372
 
  pid = (pid_t)proc_id;
373
 
  if((uintmax_t)pid == proc_id){
 
261
  pid = (pid_t)maxvalue;
 
262
  if((uintmax_t)pid == maxvalue){
374
263
    return pid;
375
264
  }
376
265
  
377
266
  return 0;
378
267
}
379
268
 
380
 
char **getargv(pid_t pid){
 
269
const char **getargv(pid_t pid){
381
270
  int cl_fd;
382
271
  char *cmdline_filename;
383
272
  ssize_t sret;
386
275
  ret = asprintf(&cmdline_filename, "/proc/%" PRIuMAX "/cmdline",
387
276
                 (uintmax_t)pid);
388
277
  if(ret == -1){
389
 
    error_plus(0, errno, "asprintf");
 
278
    error(0, errno, "asprintf");
390
279
    return NULL;
391
280
  }
392
281
  
394
283
  cl_fd = open(cmdline_filename, O_RDONLY);
395
284
  free(cmdline_filename);
396
285
  if(cl_fd == -1){
397
 
    error_plus(0, errno, "open");
 
286
    error(0, errno, "open");
398
287
    return NULL;
399
288
  }
400
289
  
408
297
    if(cmdline_len + blocksize > cmdline_allocated){
409
298
      tmp = realloc(cmdline, cmdline_allocated + blocksize);
410
299
      if(tmp == NULL){
411
 
        error_plus(0, errno, "realloc");
 
300
        error(0, errno, "realloc");
412
301
        free(cmdline);
413
302
        close(cl_fd);
414
303
        return NULL;
421
310
    sret = read(cl_fd, cmdline + cmdline_len,
422
311
                cmdline_allocated - cmdline_len);
423
312
    if(sret == -1){
424
 
      error_plus(0, errno, "read");
 
313
      error(0, errno, "read");
425
314
      free(cmdline);
426
315
      close(cl_fd);
427
316
      return NULL;
430
319
  } while(sret != 0);
431
320
  ret = close(cl_fd);
432
321
  if(ret == -1){
433
 
    error_plus(0, errno, "close");
 
322
    error(0, errno, "close");
434
323
    free(cmdline);
435
324
    return NULL;
436
325
  }
439
328
  char **argv = malloc((argz_count(cmdline, cmdline_len) + 1)
440
329
                       * sizeof(char *)); /* Get number of args */
441
330
  if(argv == NULL){
442
 
    error_plus(0, errno, "argv = malloc()");
 
331
    error(0, errno, "argv = malloc()");
443
332
    free(cmdline);
444
333
    return NULL;
445
334
  }
446
335
  argz_extract(cmdline, cmdline_len, argv); /* Create argv */
447
 
  return argv;
 
336
  return (const char **)argv;
448
337
}
449
338
 
450
339
int main(__attribute__((unused))int argc,
451
340
         __attribute__((unused))char **argv){
452
 
  char *prompt = NULL;
 
341
  char *prompt;
453
342
  char *prompt_arg;
454
343
  pid_t plymouth_command_pid;
455
344
  int ret;
456
345
  bool bret;
457
346
 
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
 
  
506
347
  /* test -x /bin/plymouth */
507
348
  ret = access(plymouth_path, X_OK);
508
349
  if(ret == -1){
509
350
    /* Plymouth is probably not installed.  Don't print an error
510
351
       message, just exit. */
511
 
    if(debug){
512
 
      fprintf_plus(stderr, "Plymouth (%s) not found\n",
513
 
                   plymouth_path);
514
 
    }
515
352
    exit(EX_UNAVAILABLE);
516
353
  }
517
354
  
524
361
        *sig != 0; sig++){
525
362
      ret = sigaddset(&new_action.sa_mask, *sig);
526
363
      if(ret == -1){
527
 
        error_plus(EX_OSERR, errno, "sigaddset");
 
364
        error(EX_OSERR, errno, "sigaddset");
528
365
      }
529
366
      ret = sigaction(*sig, NULL, &old_action);
530
367
      if(ret == -1){
531
 
        error_plus(EX_OSERR, errno, "sigaction");
 
368
        error(EX_OSERR, errno, "sigaction");
532
369
      }
533
370
      if(old_action.sa_handler != SIG_IGN){
534
371
        ret = sigaction(*sig, &new_action, NULL);
535
372
        if(ret == -1){
536
 
          error_plus(EX_OSERR, errno, "sigaction");
 
373
          error(EX_OSERR, errno, "sigaction");
537
374
        }
538
375
      }
539
376
    }
551
388
    }
552
389
    /* Plymouth is probably not running.  Don't print an error
553
390
       message, just exit. */
554
 
    if(debug){
555
 
      fprintf_plus(stderr, "Plymouth not running\n");
556
 
    }
557
391
    exit(EX_UNAVAILABLE);
558
392
  }
559
393
  
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
 
  }
 
394
  prompt = makeprompt();
 
395
  ret = asprintf(&prompt_arg, "--prompt=%s", prompt);
 
396
  free(prompt);
567
397
  if(ret == -1){
568
 
    error_plus(EX_OSERR, errno, "asprintf");
 
398
    error(EX_OSERR, errno, "asprintf");
569
399
  }
570
400
  
571
401
  /* plymouth ask-for-password --prompt="$prompt" */
572
 
  if(debug){
573
 
    fprintf_plus(stderr, "Prompting for password via Plymouth\n");
574
 
  }
575
402
  bret = exec_and_wait(&plymouth_command_pid,
576
403
                       plymouth_path, (const char *[])
577
404
                       { plymouth_path, "ask-for-password",
587
414
  }
588
415
  kill_and_wait(plymouth_command_pid);
589
416
  
590
 
  char **plymouthd_argv = NULL;
 
417
  const char **plymouthd_argv;
591
418
  pid_t pid = get_pid();
592
419
  if(pid == 0){
593
 
    error_plus(0, 0, "plymouthd pid not found");
 
420
    error(0, 0, "plymouthd pid not found");
 
421
    plymouthd_argv = plymouthd_default_argv;
594
422
  } else {
595
423
    plymouthd_argv = getargv(pid);
596
424
  }
599
427
                       { plymouth_path, "quit", NULL },
600
428
                       false, false);
601
429
  if(not bret){
602
 
    if(plymouthd_argv != NULL){
603
 
      free(*plymouthd_argv);
604
 
      free(plymouthd_argv);
605
 
    }
606
430
    exit(EXIT_FAILURE);
607
431
  }
608
 
  bret = exec_and_wait(NULL, plymouthd_path,
609
 
                       (plymouthd_argv != NULL)
610
 
                       ? (const char * const *)plymouthd_argv
611
 
                       : plymouthd_default_argv,
 
432
  bret = exec_and_wait(NULL, plymouthd_path, plymouthd_argv,
612
433
                       false, true);
613
 
  if(plymouthd_argv != NULL){
614
 
    free(*plymouthd_argv);
615
 
    free(plymouthd_argv);
616
 
  }
617
434
  if(not bret){
618
435
    exit(EXIT_FAILURE);
619
436
  }