/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: 2011-09-18 15:59:05 UTC
  • mfrom: (24.1.179 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20110918155905-ngj2ig0yheralj1s
* DBUS-API: Document new "Expires" and "ExtendedTimeout" properties.
* README: Refer to the installed manual page more simply.
* mandos (Client.extended_timeout, Client.expires): New attributes.
  (Client.extended_timeout_milliseconds): New.
  (Client.__init__, Client.enable, Client.disable): Set new attributes.
  (Client.checked_ok): Take new "timeout" argument.
  (ClientDBus.expires): Transform into a property which sends a D-Bus
                        signal when changed.
  (ClientDBus._datetime_to_dbus): Return empty D-Bus string on None.
                                  All callers changed to use this.

  (ClientDBus.ApprovedByDefault_dbus_property,
  ClientDBus.ApprovalDelay_dbus_property,
  ClientDBus.ApprovalDuration_dbus_property,
  ClientDBus.Host_dbus_property, ClientDBus.Timeout_dbus_property,
  ClientDBus.Interval_dbus_property,
  ClientDBus.Checker_dbus_property): Bug fix: Only send D-Bus signal
                                     if new value is different.
  (ClientDBus.Timeout_dbus_property): Use new "expires" attribute.
  (ClientDBus.Expires_dbus_property,
  ClientDBus.ExtendedTimeout_dbus_property): New D-Bus properties.
  (ClientHandler.handle): Bump time using extended_timeout value.
  (main.client_defaults): Change default values of "timeout" and
                          "interval", added new default value for
                          "extended_timeout".
* mandos-clients.conf.xml (OPTIONS): Changed default values of
                                     "interval" and "timeout".  Add
                                     new "extended_timeout" option.
  (EXAMPLE): Updated default values.
* mandos-ctl: Show new "ExtendedTimeout" D-Bus property and change it
              using new "--extended-timeout" option.
* mandos-ctl.xml (SYNOPSIS, OPTIONS): Document new
                                      "--extended-timeout" option.
* mandos-monitor (MandosClientWidget.update): Use new "Expires" D-Bus
                                              property.
* mandos.xml (DESCRIPTION): Add reference to intro(8mandos) manual
                            page.
  (CHECKING): Refer to the new "extended_timeout" option in
  clients.conf.

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