/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

* Makefile (DOCS): Added "plymouth.8mandos".
  (install-server): Also install "mandos-monitor.8" and
                    "mandos-ctl.8".
  (install-client-nokey): Also install "plymouth.8mandos".
  (uninstall-server): Also remove "mandos-monitor.8" and
                      "mandos-ctl.8".
  (uninstall-client): Also remove "plymouth.8mandos".
* plugins.d/plymouth.xml: New.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
/*  -*- coding: utf-8 -*- */
2
 
/*
3
 
 * Plymouth - Read a password from Plymouth and output it
4
 
 * 
5
 
 * Copyright © 2010-2012 Teddy Hogeborn
6
 
 * Copyright © 2010-2012 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
14
 
 * WITHOUT ANY WARRANTY; without even the implied warranty of
15
 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16
 
 * General Public License for more details.
17
 
 * 
18
 
 * 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
 
 * 
22
 
 * Contact the authors at <mandos@recompile.se>.
23
 
 */
24
 
 
25
1
#define _GNU_SOURCE             /* asprintf(), TEMP_FAILURE_RETRY() */
26
2
#include <signal.h>             /* sig_atomic_t, struct sigaction,
27
3
                                   sigemptyset(), sigaddset(), SIGINT,
30
6
#include <stdbool.h>            /* bool, false, true */
31
7
#include <fcntl.h>              /* open(), O_RDONLY */
32
8
#include <iso646.h>             /* and, or, not*/
33
 
#include <sys/types.h>          /* size_t, ssize_t, pid_t, struct
34
 
                                   dirent, waitpid() */
 
9
#include <sys/types.h>          /* size_t, ssize_t, pid_t, struct dirent,
 
10
                                   waitpid() */
35
11
#include <sys/wait.h>           /* waitpid() */
36
12
#include <stddef.h>             /* NULL */
37
13
#include <string.h>             /* strchr(), memcmp() */
38
 
#include <stdio.h>              /* asprintf(), perror(), fopen(),
39
 
                                   fscanf(), vasprintf(), fprintf(),
40
 
                                   vfprintf() */
41
 
#include <unistd.h>             /* close(), readlink(), read(),
42
 
                                   fork(), setsid(), chdir(), dup2(),
 
14
#include <stdio.h>              /* asprintf(), perror(), fopen(), fscanf() */
 
15
#include <unistd.h>             /* close(), readlink(), read(), fork()
 
16
                                   setsid(), chdir(), dup2()
43
17
                                   STDERR_FILENO, execv(), access() */
44
18
#include <stdlib.h>             /* free(), EXIT_FAILURE, realloc(),
45
19
                                   EXIT_SUCCESS, malloc(), _exit(),
47
21
#include <dirent.h>             /* scandir(), alphasort() */
48
22
#include <inttypes.h>           /* intmax_t, strtoumax(), SCNuMAX */
49
23
#include <sys/stat.h>           /* struct stat, lstat() */
50
 
#include <sysexits.h>           /* EX_OSERR, EX_UNAVAILABLE */
 
24
#include <sysexits.h>           /* EX_OSERR */
51
25
#include <error.h>              /* error() */
52
26
#include <errno.h>              /* TEMP_FAILURE_RETRY */
53
27
#include <argz.h>               /* argz_count(), argz_extract() */
54
 
#include <stdarg.h>             /* va_list, va_start(), ... */
55
28
 
56
29
sig_atomic_t interrupted_by_signal = 0;
57
 
 
58
 
/* Used by Ubuntu 11.04 (Natty Narwahl) */
59
 
const char plymouth_old_pid[] = "/dev/.initramfs/plymouth.pid";
60
 
/* Used by Ubuntu 11.10 (Oneiric Ocelot) */
61
 
const char plymouth_pid[] = "/run/initramfs/plymouth.pid";
62
 
 
 
30
const char plymouth_pid[] = "/dev/.initramfs/plymouth.pid";
63
31
const char plymouth_path[] = "/bin/plymouth";
64
32
const char plymouthd_path[] = "/sbin/plymouthd";
65
 
const char *plymouthd_default_argv[] = {"/sbin/plymouthd",
66
 
                                        "--mode=boot",
 
33
const char *plymouthd_default_argv[] = {"/sbin/plymouthd", "--mode=boot",
67
34
                                        "--attach-to-session",
 
35
                                        "--pid-file=/dev/.initramfs/plymouth.pid",
68
36
                                        NULL };
69
37
 
70
38
static void termination_handler(__attribute__((unused))int signum){
74
42
  interrupted_by_signal = 1;
75
43
}
76
44
 
77
 
/* Function to use when printing errors */
78
 
__attribute__((format (gnu_printf, 3, 4)))
79
 
void error_plus(int status, int errnum, const char *formatstring,
80
 
                ...){
81
 
  va_list ap;
82
 
  char *text;
83
 
  int ret;
84
 
  
85
 
  va_start(ap, formatstring);
86
 
  ret = vasprintf(&text, formatstring, ap);
87
 
  if (ret == -1){
88
 
    fprintf(stderr, "Mandos plugin %s: ",
89
 
            program_invocation_short_name);
90
 
    vfprintf(stderr, formatstring, ap);
91
 
    fprintf(stderr, ": ");
92
 
    fprintf(stderr, "%s\n", strerror(errnum));
93
 
    error(status, errno, "vasprintf while printing error");
94
 
    return;
95
 
  }
96
 
  fprintf(stderr, "Mandos plugin ");
97
 
  error(status, errnum, "%s", text);
98
 
  free(text);
99
 
}
100
 
 
101
45
/* Create prompt string */
102
46
char *makeprompt(void){
103
47
  int ret = 0;
104
48
  char *prompt;
105
49
  const char *const cryptsource = getenv("cryptsource");
106
50
  const char *const crypttarget = getenv("crypttarget");
107
 
  const char prompt_start[] = "Unlocking the disk";
108
 
  const char prompt_end[] = "Enter passphrase";
 
51
  const char prompt_start[] = "Enter passphrase to unlock the disk";
109
52
  
110
53
  if(cryptsource == NULL){
111
54
    if(crypttarget == NULL){
112
 
      ret = asprintf(&prompt, "%s\n%s", prompt_start, prompt_end);
 
55
      ret = asprintf(&prompt, "%s: ", prompt_start);
113
56
    } else {
114
 
      ret = asprintf(&prompt, "%s (%s)\n%s", prompt_start,
115
 
                     crypttarget, prompt_end);
 
57
      ret = asprintf(&prompt, "%s (%s): ", prompt_start,
 
58
                     crypttarget);
116
59
    }
117
60
  } else {
118
61
    if(crypttarget == NULL){
119
 
      ret = asprintf(&prompt, "%s %s\n%s", prompt_start, cryptsource,
120
 
                     prompt_end);
 
62
      ret = asprintf(&prompt, "%s %s: ", prompt_start, cryptsource);
121
63
    } else {
122
 
      ret = asprintf(&prompt, "%s %s (%s)\n%s", prompt_start,
123
 
                     cryptsource, crypttarget, prompt_end);
 
64
      ret = asprintf(&prompt, "%s %s (%s): ", prompt_start,
 
65
                     cryptsource, crypttarget);
124
66
    }
125
67
  }
126
68
  if(ret == -1){
137
79
bool become_a_daemon(void){
138
80
  int ret = setuid(geteuid());
139
81
  if(ret == -1){
140
 
    error_plus(0, errno, "setuid");
 
82
    error(0, errno, "setuid");
141
83
  }
142
84
    
143
85
  setsid();
144
86
  ret = chdir("/");
145
87
  if(ret == -1){
146
 
    error_plus(0, errno, "chdir");
 
88
    error(0, errno, "chdir");
147
89
    return false;
148
90
  }
149
91
  ret = dup2(STDERR_FILENO, STDOUT_FILENO); /* replace our stdout */
150
92
  if(ret == -1){
151
 
    error_plus(0, errno, "dup2");
 
93
    error(0, errno, "dup2");
152
94
    return false;
153
95
  }
154
96
  return true;
155
97
}
156
98
 
157
 
__attribute__((nonnull (2, 3)))
158
99
bool exec_and_wait(pid_t *pid_return, const char *path,
159
100
                   const char **argv, bool interruptable,
160
101
                   bool daemonize){
163
104
  pid_t pid;
164
105
  pid = fork();
165
106
  if(pid == -1){
166
 
    error_plus(0, errno, "fork");
 
107
    error(0, errno, "fork");
167
108
    return false;
168
109
  }
169
110
  if(pid == 0){
173
114
        _exit(EX_OSERR);
174
115
      }
175
116
    }
176
 
    
 
117
 
177
118
    char **new_argv = NULL;
178
 
    char **tmp;
 
119
    char *tmp;
179
120
    int i = 0;
180
 
    for (; argv[i]!=NULL; i++){
 
121
    for (; argv[i]!=(char *)NULL; i++){
181
122
      tmp = realloc(new_argv, sizeof(const char *) * ((size_t)i + 1));
182
123
      if (tmp == NULL){
183
 
        error_plus(0, errno, "realloc");
 
124
        error(0, errno, "realloc");
184
125
        free(new_argv);
185
 
        _exit(EX_OSERR);
 
126
        _exit(EXIT_FAILURE);
186
127
      }
187
 
      new_argv = tmp;
 
128
      new_argv = (char **)tmp;
188
129
      new_argv[i] = strdup(argv[i]);
189
130
    }
190
 
    new_argv[i] = NULL;
 
131
    new_argv[i] = (char *) NULL;
191
132
    
192
133
    execv(path, (char *const *)new_argv);
193
 
    error_plus(0, errno, "execv");
 
134
    error(0, errno, "execv");
194
135
    _exit(EXIT_FAILURE);
195
136
  }
196
137
  if(pid_return != NULL){
205
146
    return false;
206
147
  }
207
148
  if(ret == -1){
208
 
    error_plus(0, errno, "waitpid");
 
149
    error(0, errno, "waitpid");
209
150
    return false;
210
151
  }
211
 
  if(WIFEXITED(status) and (WEXITSTATUS(status) == 0)){
 
152
  if(WIFEXITED(status) and WEXITSTATUS(status) == 0){
212
153
    return true;
213
154
  }
214
155
  return false;
215
156
}
216
157
 
217
 
__attribute__((nonnull))
218
158
int is_plymouth(const struct dirent *proc_entry){
219
159
  int ret;
220
160
  {
221
 
    uintmax_t proc_id;
 
161
    uintmax_t maxvalue;
222
162
    char *tmp;
223
163
    errno = 0;
224
 
    proc_id = strtoumax(proc_entry->d_name, &tmp, 10);
 
164
    maxvalue = strtoumax(proc_entry->d_name, &tmp, 10);
225
165
 
226
 
    if(errno != 0 or *tmp != '\0'
227
 
       or proc_id != (uintmax_t)((pid_t)proc_id)){
 
166
    if(errno != 0 or *tmp != '\0' or maxvalue != (uintmax_t)((pid_t)maxvalue)){
228
167
      return 0;
229
168
    }
230
169
  }
231
 
  char exe_target[sizeof(plymouthd_path)];
 
170
  char exe_target[sizeof(plymouth_path)];
232
171
  char *exe_link;
233
172
  ret = asprintf(&exe_link, "/proc/%s/exe", proc_entry->d_name);
234
173
  if(ret == -1){
235
 
    error_plus(0, errno, "asprintf");
 
174
    error(0, errno, "asprintf");
236
175
    return 0;
237
176
  }
238
 
  
 
177
 
239
178
  struct stat exe_stat;
240
179
  ret = lstat(exe_link, &exe_stat);
241
180
  if(ret == -1){
242
181
    free(exe_link);
243
182
    if(errno != ENOENT){
244
 
      error_plus(0, errno, "lstat");
 
183
      error(0, errno, "lstat");
245
184
    }
246
185
    return 0;
247
186
  }
252
191
    free(exe_link);
253
192
    return 0;
254
193
  }
255
 
  
 
194
 
256
195
  ssize_t sret = readlink(exe_link, exe_target, sizeof(exe_target));
257
196
  free(exe_link);
258
 
  if((sret != (ssize_t)sizeof(plymouthd_path)-1) or
259
 
      (memcmp(plymouthd_path, exe_target,
260
 
              sizeof(plymouthd_path)-1) != 0)){
 
197
  if((sret != (ssize_t)sizeof(plymouth_path)-1) or
 
198
      (memcmp(plymouth_path, exe_target,
 
199
              sizeof(plymouth_path)-1) != 0)){
261
200
    return 0;
262
201
  }
263
202
  return 1;
265
204
 
266
205
pid_t get_pid(void){
267
206
  int ret;
268
 
  uintmax_t proc_id = 0;
269
207
  FILE *pidfile = fopen(plymouth_pid, "r");
270
 
  /* Try the new pid file location */
 
208
  uintmax_t maxvalue = 0;
271
209
  if(pidfile != NULL){
272
 
    ret = fscanf(pidfile, "%" SCNuMAX, &proc_id);
 
210
    ret = fscanf(pidfile, "%" SCNuMAX, &maxvalue);
273
211
    if(ret != 1){
274
 
      proc_id = 0;
 
212
      maxvalue = 0;
275
213
    }
276
214
    fclose(pidfile);
277
215
  }
278
 
  /* Try the old pid file location */
279
 
  if(proc_id == 0){
280
 
    pidfile = fopen(plymouth_pid, "r");
281
 
    if(pidfile != NULL){
282
 
      ret = fscanf(pidfile, "%" SCNuMAX, &proc_id);
283
 
      if(ret != 1){
284
 
        proc_id = 0;
285
 
      }
286
 
      fclose(pidfile);
287
 
    }
288
 
  }
289
 
  /* Look for a plymouth process */
290
 
  if(proc_id == 0){
291
 
    struct dirent **direntries = NULL;
 
216
  if(maxvalue == 0){
 
217
    struct dirent **direntries;
292
218
    ret = scandir("/proc", &direntries, is_plymouth, alphasort);
293
 
    if (ret == -1){
294
 
      error_plus(0, errno, "scandir");
295
 
    }
296
 
    if (ret > 0){
297
 
      ret = sscanf(direntries[0]->d_name, "%" SCNuMAX, &proc_id);
298
 
      if (ret < 0){
299
 
        error_plus(0, errno, "sscanf");
300
 
      }
301
 
    }
302
 
    /* scandir might preallocate for this variable (man page unclear).
303
 
       even if ret == 0, therefore we need to free it. */
304
 
    free(direntries);
 
219
    sscanf(direntries[0]->d_name, "%" SCNuMAX, &maxvalue);
305
220
  }
306
221
  pid_t pid;
307
 
  pid = (pid_t)proc_id;
308
 
  if((uintmax_t)pid == proc_id){
 
222
  pid = (pid_t)maxvalue;
 
223
  if((uintmax_t)pid == maxvalue){
309
224
    return pid;
310
225
  }
311
226
  
321
236
  ret = asprintf(&cmdline_filename, "/proc/%" PRIuMAX "/cmdline",
322
237
                 (uintmax_t)pid);
323
238
  if(ret == -1){
324
 
    error_plus(0, errno, "asprintf");
 
239
    error(0, errno, "asprintf");
325
240
    return NULL;
326
241
  }
327
242
  
329
244
  cl_fd = open(cmdline_filename, O_RDONLY);
330
245
  free(cmdline_filename);
331
246
  if(cl_fd == -1){
332
 
    error_plus(0, errno, "open");
 
247
    error(0, errno, "open");
333
248
    return NULL;
334
249
  }
335
250
  
343
258
    if(cmdline_len + blocksize > cmdline_allocated){
344
259
      tmp = realloc(cmdline, cmdline_allocated + blocksize);
345
260
      if(tmp == NULL){
346
 
        error_plus(0, errno, "realloc");
 
261
        error(0, errno, "realloc");
347
262
        free(cmdline);
348
263
        close(cl_fd);
349
264
        return NULL;
356
271
    sret = read(cl_fd, cmdline + cmdline_len,
357
272
                cmdline_allocated - cmdline_len);
358
273
    if(sret == -1){
359
 
      error_plus(0, errno, "read");
 
274
      error(0, errno, "read");
360
275
      free(cmdline);
361
276
      close(cl_fd);
362
277
      return NULL;
365
280
  } while(sret != 0);
366
281
  ret = close(cl_fd);
367
282
  if(ret == -1){
368
 
    error_plus(0, errno, "close");
 
283
    error(0, errno, "close");
369
284
    free(cmdline);
370
285
    return NULL;
371
286
  }
374
289
  char **argv = malloc((argz_count(cmdline, cmdline_len) + 1)
375
290
                       * sizeof(char *)); /* Get number of args */
376
291
  if(argv == NULL){
377
 
    error_plus(0, errno, "argv = malloc()");
 
292
    error(0, errno, "argv = malloc()");
378
293
    free(cmdline);
379
294
    return NULL;
380
295
  }
393
308
  /* test -x /bin/plymouth */
394
309
  ret = access(plymouth_path, X_OK);
395
310
  if(ret == -1){
396
 
    /* Plymouth is probably not installed.  Don't print an error
397
 
       message, just exit. */
398
 
    exit(EX_UNAVAILABLE);
 
311
    exit(EXIT_FAILURE);
399
312
  }
400
 
  
 
313
 
401
314
  { /* Add signal handlers */
402
315
    struct sigaction old_action,
403
316
      new_action = { .sa_handler = termination_handler,
404
317
                     .sa_flags = 0 };
405
318
    sigemptyset(&new_action.sa_mask);
406
 
    for(int *sig = (int[]){ SIGINT, SIGHUP, SIGTERM, 0 };
407
 
        *sig != 0; sig++){
 
319
    for(int *sig = (int[]){ SIGINT, SIGHUP, SIGTERM, 0 }; *sig != 0; sig++){
408
320
      ret = sigaddset(&new_action.sa_mask, *sig);
409
321
      if(ret == -1){
410
 
        error_plus(EX_OSERR, errno, "sigaddset");
 
322
        error(0, errno, "sigaddset");
 
323
        exit(EX_OSERR);
411
324
      }
412
325
      ret = sigaction(*sig, NULL, &old_action);
413
326
      if(ret == -1){
414
 
        error_plus(EX_OSERR, errno, "sigaction");
 
327
        error(0, errno, "sigaction");
 
328
        exit(EX_OSERR);
415
329
      }
416
330
      if(old_action.sa_handler != SIG_IGN){
417
331
        ret = sigaction(*sig, &new_action, NULL);
418
332
        if(ret == -1){
419
 
          error_plus(EX_OSERR, errno, "sigaction");
 
333
          error(0, errno, "sigaction");
 
334
          exit(EX_OSERR);
420
335
        }
421
336
      }
422
337
    }
423
338
  }
424
 
  
 
339
    
425
340
  /* plymouth --ping */
426
341
  bret = exec_and_wait(&plymouth_command_pid, plymouth_path,
427
 
                       (const char *[])
428
 
                       { plymouth_path, "--ping", NULL },
 
342
                       (const char *[]){ (const char *)plymouth_path, (const char *)"--ping", (const char *)NULL},
429
343
                       true, false);
430
344
  if(not bret){
431
345
    if(interrupted_by_signal){
432
346
      kill_and_wait(plymouth_command_pid);
433
 
      exit(EXIT_FAILURE);
434
347
    }
435
 
    /* Plymouth is probably not running.  Don't print an error
436
 
       message, just exit. */
437
 
    exit(EX_UNAVAILABLE);
 
348
    exit(EXIT_FAILURE);
438
349
  }
439
350
  
440
351
  prompt = makeprompt();
441
352
  ret = asprintf(&prompt_arg, "--prompt=%s", prompt);
442
353
  free(prompt);
443
354
  if(ret == -1){
444
 
    error_plus(EX_OSERR, errno, "asprintf");
 
355
    error(0, errno, "asprintf");
 
356
    exit(EXIT_FAILURE);
445
357
  }
446
358
  
447
359
  /* plymouth ask-for-password --prompt="$prompt" */
448
 
  bret = exec_and_wait(&plymouth_command_pid,
449
 
                       plymouth_path, (const char *[])
450
 
                       { plymouth_path, "ask-for-password",
451
 
                           prompt_arg, NULL },
 
360
  bret = exec_and_wait(&plymouth_command_pid, plymouth_path,
 
361
                       (const char *[]){plymouth_path, "ask-for-password", prompt_arg, NULL},
452
362
                       true, false);
453
363
  free(prompt_arg);
 
364
  if(not bret){
 
365
    if(interrupted_by_signal){
 
366
      kill_and_wait(plymouth_command_pid);
 
367
    } else {
 
368
      exit(EXIT_FAILURE);
 
369
    }
 
370
  }
 
371
  
454
372
  if(bret){
455
373
    exit(EXIT_SUCCESS);
456
374
  }
457
 
  if(not interrupted_by_signal){
458
 
    /* exec_and_wait failed for some other reason */
459
 
    exit(EXIT_FAILURE);
460
 
  }
461
 
  kill_and_wait(plymouth_command_pid);
462
375
  
463
 
  const char **plymouthd_argv;
 
376
  const char **plymouthd_argv = NULL;
464
377
  pid_t pid = get_pid();
465
378
  if(pid == 0){
466
 
    error_plus(0, 0, "plymouthd pid not found");
 
379
    error(0, 0, "plymouthd pid not found");
 
380
  } else {
 
381
    plymouthd_argv = getargv(pid);
 
382
  }
 
383
  if(plymouthd_argv == NULL){
467
384
    plymouthd_argv = plymouthd_default_argv;
468
 
  } else {
469
 
    plymouthd_argv = getargv(pid);
470
385
  }
471
386
  
472
 
  bret = exec_and_wait(NULL, plymouth_path, (const char *[])
473
 
                       { plymouth_path, "quit", NULL },
474
 
                       false, false);
475
 
  if(not bret){
476
 
    exit(EXIT_FAILURE);
477
 
  }
478
 
  bret = exec_and_wait(NULL, plymouthd_path, plymouthd_argv,
479
 
                       false, true);
480
 
  if(not bret){
481
 
    exit(EXIT_FAILURE);
482
 
  }
483
 
  exec_and_wait(NULL, plymouth_path, (const char *[])
484
 
                { plymouth_path, "show-splash", NULL },
485
 
                false, false);
 
387
  bret = exec_and_wait(NULL, plymouth_path,
 
388
                       (const char *[]){plymouth_path, "quit", NULL}, false, false);
 
389
  if(not bret){
 
390
    exit(EXIT_FAILURE);
 
391
  }
 
392
  bret = exec_and_wait(NULL, plymouthd_path, plymouthd_argv, false, true);
 
393
  if(not bret){
 
394
    exit(EXIT_FAILURE);
 
395
  }
 
396
  exec_and_wait(NULL, plymouth_path,
 
397
                (const char *[]){ plymouth_path, "show-splash", NULL }, false, false);
486
398
  exit(EXIT_FAILURE);
487
399
}