/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

Hooks take new "modules" argument, and hook names can contain periods.

* debian/mandos-client.README.Debian: Adjust wording.
* debian/rules (binary-common): Exclude nework-hooks.d directory from
                                dh_fixperms.
* initramfs-tools-hook: Also create network hook directory.  Allow
                        periods in hook names.  Only run executable
                        files in hook directory.  Copy needed modules.
* network-hooks.d/bridge: Fix "/usr/bin/brctl" to "/usr/sbin/brctl".
                          Also take "modules" argument.
* plugins.d/mandos-client.xml (NETWORK HOOKS/REQUIREMENTS): Document
                                                            the
                                                            allowing
                                                            of periods
                                                            in hook
                                                            names.
  (NETWORK HOOKS/REQUIREMENTS/files): Adjust wording.
  (NETWORK HOOKS/REQUIREMENTS/modules): New.
  (NETWORK HOOKS/REQUIREMENTS/MANDOSNETHOOKDIR): Clarify.
  (NETWORK HOOKS/REQUIREMENTS/MODE): Add "modules".

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