/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/password-prompt.c

* plugin-runner.c (main): When a plugin is killed by a signal, show
                          the signal name, not just the number, in the
                          debug log message.

* plugins.d/password-prompt.c (termination_handler): Store received
                                                     signal in
                                                     "signal_received".
  (main): If exiting due to signal, re-raise signal received instead
          of returning.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-prompt.c
2
2
/*
3
3
 * Password-prompt - Read a password from the terminal and print it
4
4
 * 
5
 
 * Copyright © 2008-2011 Teddy Hogeborn
6
 
 * Copyright © 2008-2011 Björn Påhlsson
 
5
 * Copyright © 2008,2009 Teddy Hogeborn
 
6
 * Copyright © 2008,2009 Björn Påhlsson
7
7
 * 
8
8
 * This program is free software: you can redistribute it and/or
9
9
 * modify it under the terms of the GNU General Public License as
19
19
 * along with this program.  If not, see
20
20
 * <http://www.gnu.org/licenses/>.
21
21
 * 
22
 
 * Contact the authors at <mandos@recompile.se>.
 
22
 * Contact the authors at <https://www.fukt.bsnet.se/~belorn/> and
 
23
 * <https://www.fukt.bsnet.se/~teddy/>.
23
24
 */
24
25
 
25
 
#define _GNU_SOURCE             /* getline(), asprintf() */
 
26
#define _GNU_SOURCE             /* getline() */
26
27
 
27
 
#include <termios.h>            /* struct termios, tcsetattr(),
 
28
#include <termios.h>            /* struct termios, tcsetattr(),
28
29
                                   TCSAFLUSH, tcgetattr(), ECHO */
29
30
#include <unistd.h>             /* struct termios, tcsetattr(),
30
31
                                   STDIN_FILENO, TCSAFLUSH,
31
 
                                   tcgetattr(), ECHO, readlink() */
 
32
                                   tcgetattr(), ECHO */
32
33
#include <signal.h>             /* sig_atomic_t, raise(), struct
33
34
                                   sigaction, sigemptyset(),
34
35
                                   sigaction(), sigaddset(), SIGINT,
35
36
                                   SIGQUIT, SIGHUP, SIGTERM,
36
37
                                   raise() */
37
38
#include <stddef.h>             /* NULL, size_t, ssize_t */
38
 
#include <sys/types.h>          /* ssize_t, struct dirent, pid_t,
39
 
                                   ssize_t, open() */
 
39
#include <sys/types.h>          /* ssize_t */
40
40
#include <stdlib.h>             /* EXIT_SUCCESS, EXIT_FAILURE,
41
 
                                   getenv(), free() */
42
 
#include <dirent.h>             /* scandir(), alphasort() */
 
41
                                   getopt_long, getenv() */
43
42
#include <stdio.h>              /* fprintf(), stderr, getline(),
44
 
                                   stdin, feof(), fputc(), vfprintf(),
45
 
                                   vasprintf() */
46
 
#include <errno.h>              /* errno, EBADF, ENOTTY, EINVAL,
47
 
                                   EFAULT, EFBIG, EIO, ENOSPC, EINTR
48
 
                                */
49
 
#include <error.h>              /* error() */
 
43
                                   stdin, feof(), perror(), fputc(),
 
44
                                   stdout, getopt_long */
 
45
#include <errno.h>              /* errno, EINVAL */
50
46
#include <iso646.h>             /* or, not */
51
47
#include <stdbool.h>            /* bool, false, true */
52
 
#include <inttypes.h>           /* strtoumax() */
53
 
#include <sys/stat.h>           /* struct stat, lstat(), open() */
54
 
#include <string.h>             /* strlen, rindex, memcmp, strerror()
55
 
                                 */
 
48
#include <string.h>             /* strlen, rindex, strncmp, strcmp */
56
49
#include <argp.h>               /* struct argp_option, struct
57
50
                                   argp_state, struct argp,
58
51
                                   argp_parse(), error_t,
59
52
                                   ARGP_KEY_ARG, ARGP_KEY_END,
60
53
                                   ARGP_ERR_UNKNOWN */
61
 
#include <sysexits.h>           /* EX_SOFTWARE, EX_OSERR,
62
 
                                   EX_UNAVAILABLE, EX_IOERR, EX_OK */
63
 
#include <fcntl.h>              /* open() */
64
 
#include <stdarg.h>             /* va_list, va_start(), ... */
65
54
 
66
55
volatile sig_atomic_t quit_now = 0;
67
56
int signal_received;
68
57
bool debug = false;
69
58
const char *argp_program_version = "password-prompt " VERSION;
70
 
const char *argp_program_bug_address = "<mandos@recompile.se>";
71
 
 
72
 
/* Needed for conflict resolution */
73
 
const char plymouth_name[] = "plymouthd";
74
 
 
75
 
/* Function to use when printing errors */
76
 
void error_plus(int status, int errnum, const char *formatstring,
77
 
                ...){
78
 
  va_list ap;
79
 
  char *text;
80
 
  int ret;
81
 
  
82
 
  va_start(ap, formatstring);
83
 
  ret = vasprintf(&text, formatstring, ap);
84
 
  if (ret == -1){
85
 
    fprintf(stderr, "Mandos plugin %s: ",
86
 
            program_invocation_short_name);
87
 
    vfprintf(stderr, formatstring, ap);
88
 
    fprintf(stderr, ": ");
89
 
    fprintf(stderr, "%s\n", strerror(errnum));
90
 
    error(status, errno, "vasprintf while printing error");
91
 
    return;
92
 
  }
93
 
  fprintf(stderr, "Mandos plugin ");
94
 
  error(status, errnum, "%s", text);
95
 
  free(text);
96
 
}
 
59
const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";
97
60
 
98
61
static void termination_handler(int signum){
99
62
  if(quit_now){
103
66
  signal_received = signum;
104
67
}
105
68
 
106
 
bool conflict_detection(void){
107
 
 
108
 
  /* plymouth conflicts with password-prompt since both want to read
109
 
     from the terminal.  Password-prompt will exit if it detects
110
 
     plymouth since plymouth performs the same functionality.
111
 
   */
112
 
  int is_plymouth(const struct dirent *proc_entry){
113
 
    int ret;
114
 
    int cl_fd;
115
 
    {
116
 
      uintmax_t maxvalue;
117
 
      char *tmp;
118
 
      errno = 0;
119
 
      maxvalue = strtoumax(proc_entry->d_name, &tmp, 10);
120
 
      
121
 
      if(errno != 0 or *tmp != '\0'
122
 
         or maxvalue != (uintmax_t)((pid_t)maxvalue)){
123
 
        return 0;
124
 
      }
125
 
    }
126
 
    
127
 
    char *cmdline_filename;
128
 
    ret = asprintf(&cmdline_filename, "/proc/%s/cmdline",
129
 
                   proc_entry->d_name);
130
 
    if(ret == -1){
131
 
      error(0, errno, "asprintf");
132
 
      return 0;
133
 
    }
134
 
    
135
 
    /* Open /proc/<pid>/cmdline */
136
 
    cl_fd = open(cmdline_filename, O_RDONLY);
137
 
    free(cmdline_filename);
138
 
    if(cl_fd == -1){
139
 
      if(errno != ENOENT){
140
 
        error(0, errno, "open");
141
 
      }
142
 
      return 0;
143
 
    }
144
 
    
145
 
    char *cmdline = NULL;
146
 
    {
147
 
      size_t cmdline_len = 0;
148
 
      size_t cmdline_allocated = 0;
149
 
      char *tmp;
150
 
      const size_t blocksize = 1024;
151
 
      ssize_t sret;
152
 
      do {
153
 
        /* Allocate more space? */
154
 
        if(cmdline_len + blocksize + 1 > cmdline_allocated){
155
 
          tmp = realloc(cmdline, cmdline_allocated + blocksize + 1);
156
 
          if(tmp == NULL){
157
 
            error(0, errno, "realloc");
158
 
            free(cmdline);
159
 
            close(cl_fd);
160
 
            return 0;
161
 
          }
162
 
          cmdline = tmp;
163
 
          cmdline_allocated += blocksize;
164
 
        }
165
 
        
166
 
        /* Read data */
167
 
        sret = read(cl_fd, cmdline + cmdline_len,
168
 
                    cmdline_allocated - cmdline_len);
169
 
        if(sret == -1){
170
 
          error(0, errno, "read");
171
 
          free(cmdline);
172
 
          close(cl_fd);
173
 
          return 0;
174
 
        }
175
 
        cmdline_len += (size_t)sret;
176
 
      } while(sret != 0);
177
 
      ret = close(cl_fd);
178
 
      if(ret == -1){
179
 
        error(0, errno, "close");
180
 
        free(cmdline);
181
 
        return 0;
182
 
      }
183
 
      cmdline[cmdline_len] = '\0'; /* Make sure it is terminated */
184
 
    }
185
 
    /* we now have cmdline */
186
 
    
187
 
    /* get basename */
188
 
    char *cmdline_base = strrchr(cmdline, '/');
189
 
    if(cmdline_base != NULL){
190
 
      cmdline_base += 1;                /* skip the slash */
191
 
    } else {
192
 
      cmdline_base = cmdline;
193
 
    }
194
 
    
195
 
    if(strcmp(cmdline_base, plymouth_name) != 0){
196
 
      if(debug){
197
 
        fprintf(stderr, "\"%s\" is not \"%s\"\n", cmdline_base,
198
 
                plymouth_name);
199
 
      }
200
 
      free(cmdline);
201
 
      return 0;
202
 
    }
203
 
    if(debug){
204
 
      fprintf(stderr, "\"%s\" equals \"%s\"\n", cmdline_base,
205
 
              plymouth_name);
206
 
    }
207
 
    free(cmdline);
208
 
    return 1;
209
 
  }
210
 
  
211
 
  struct dirent **direntries = NULL;
212
 
  int ret;
213
 
  ret = scandir("/proc", &direntries, is_plymouth, alphasort);
214
 
  if (ret == -1){
215
 
    error(1, errno, "scandir");
216
 
  }
217
 
  free(direntries);
218
 
  return ret > 0;
219
 
}
220
 
 
221
 
 
222
69
int main(int argc, char **argv){
223
 
  ssize_t sret;
224
 
  int ret;
 
70
  ssize_t ret;
225
71
  size_t n;
226
72
  struct termios t_new, t_old;
227
73
  char *buffer = NULL;
237
83
        .doc = "Prefix shown before the prompt", .group = 2 },
238
84
      { .name = "debug", .key = 128,
239
85
        .doc = "Debug mode", .group = 3 },
240
 
      /*
241
 
       * These reproduce what we would get without ARGP_NO_HELP
242
 
       */
243
 
      { .name = "help", .key = '?',
244
 
        .doc = "Give this help list", .group = -1 },
245
 
      { .name = "usage", .key = -3,
246
 
        .doc = "Give a short usage message", .group = -1 },
247
 
      { .name = "version", .key = 'V',
248
 
        .doc = "Print program version", .group = -1 },
249
86
      { .name = NULL }
250
87
    };
251
88
    
252
89
    error_t parse_opt (int key, char *arg, struct argp_state *state){
253
 
      errno = 0;
254
90
      switch (key){
255
91
      case 'p':
256
92
        prefix = arg;
258
94
      case 128:
259
95
        debug = true;
260
96
        break;
261
 
        /*
262
 
         * These reproduce what we would get without ARGP_NO_HELP
263
 
         */
264
 
      case '?':                 /* --help */
265
 
        argp_state_help(state, state->out_stream,
266
 
                        (ARGP_HELP_STD_HELP | ARGP_HELP_EXIT_ERR)
267
 
                        & ~(unsigned int)ARGP_HELP_EXIT_OK);
268
 
      case -3:                  /* --usage */
269
 
        argp_state_help(state, state->out_stream,
270
 
                        ARGP_HELP_USAGE | ARGP_HELP_EXIT_ERR);
271
 
      case 'V':                 /* --version */
272
 
        fprintf(state->out_stream, "%s\n", argp_program_version);
273
 
        exit(argp_err_exit_status);
 
97
      case ARGP_KEY_ARG:
 
98
        argp_usage(state);
 
99
        break;
 
100
      case ARGP_KEY_END:
274
101
        break;
275
102
      default:
276
103
        return ARGP_ERR_UNKNOWN;
277
104
      }
278
 
      return errno;
 
105
      return 0;
279
106
    }
280
107
    
281
108
    struct argp argp = { .options = options, .parser = parse_opt,
282
109
                         .args_doc = "",
283
110
                         .doc = "Mandos password-prompt -- Read and"
284
111
                         " output a password" };
285
 
    ret = argp_parse(&argp, argc, argv,
286
 
                     ARGP_IN_ORDER | ARGP_NO_HELP, NULL, NULL);
287
 
    switch(ret){
288
 
    case 0:
289
 
      break;
290
 
    case ENOMEM:
291
 
    default:
292
 
      errno = ret;
293
 
      error(0, errno, "argp_parse");
294
 
      return EX_OSERR;
295
 
    case EINVAL:
296
 
      return EX_USAGE;
 
112
    ret = argp_parse(&argp, argc, argv, 0, 0, NULL);
 
113
    if(ret == ARGP_ERR_UNKNOWN){
 
114
      fprintf(stderr, "Unknown error while parsing arguments\n");
 
115
      return EXIT_FAILURE;
297
116
    }
298
117
  }
299
118
  
300
119
  if(debug){
301
120
    fprintf(stderr, "Starting %s\n", argv[0]);
302
121
  }
303
 
 
304
 
  if (conflict_detection()){
305
 
    if(debug){
306
 
      fprintf(stderr, "Stopping %s because of conflict\n", argv[0]);
307
 
    }
308
 
    return EXIT_FAILURE;
309
 
  }
310
 
  
311
122
  if(debug){
312
123
    fprintf(stderr, "Storing current terminal attributes\n");
313
124
  }
314
125
  
315
126
  if(tcgetattr(STDIN_FILENO, &t_old) != 0){
316
 
    int e = errno;
317
 
    error(0, errno, "tcgetattr");
318
 
    switch(e){
319
 
    case EBADF:
320
 
    case ENOTTY:
321
 
      return EX_UNAVAILABLE;
322
 
    default:
323
 
      return EX_OSERR;
324
 
    }
 
127
    perror("tcgetattr");
 
128
    return EXIT_FAILURE;
325
129
  }
326
130
  
327
131
  sigemptyset(&new_action.sa_mask);
328
 
  ret = sigaddset(&new_action.sa_mask, SIGINT);
329
 
  if(ret == -1){
330
 
    error(0, errno, "sigaddset");
331
 
    return EX_OSERR;
332
 
  }
333
 
  ret = sigaddset(&new_action.sa_mask, SIGHUP);
334
 
  if(ret == -1){
335
 
    error(0, errno, "sigaddset");
336
 
    return EX_OSERR;
337
 
  }
338
 
  ret = sigaddset(&new_action.sa_mask, SIGTERM);
339
 
  if(ret == -1){
340
 
    error(0, errno, "sigaddset");
341
 
    return EX_OSERR;
 
132
  sigaddset(&new_action.sa_mask, SIGINT);
 
133
  sigaddset(&new_action.sa_mask, SIGHUP);
 
134
  sigaddset(&new_action.sa_mask, SIGTERM);
 
135
  ret = sigaction(SIGINT, NULL, &old_action);
 
136
  if(ret == -1){
 
137
    perror("sigaction");
 
138
    return EXIT_FAILURE;
342
139
  }
343
140
  /* Need to check if the handler is SIG_IGN before handling:
344
141
     | [[info:libc:Initial Signal Actions]] |
345
142
     | [[info:libc:Basic Signal Handling]]  |
346
143
  */
347
 
  ret = sigaction(SIGINT, NULL, &old_action);
348
 
  if(ret == -1){
349
 
    error(0, errno, "sigaction");
350
 
    return EX_OSERR;
351
 
  }
352
144
  if(old_action.sa_handler != SIG_IGN){
353
145
    ret = sigaction(SIGINT, &new_action, NULL);
354
146
    if(ret == -1){
355
 
      error(0, errno, "sigaction");
356
 
      return EX_OSERR;
 
147
      perror("sigaction");
 
148
      return EXIT_FAILURE;
357
149
    }
358
150
  }
359
151
  ret = sigaction(SIGHUP, NULL, &old_action);
360
152
  if(ret == -1){
361
 
    error(0, errno, "sigaction");
362
 
    return EX_OSERR;
 
153
    perror("sigaction");
 
154
    return EXIT_FAILURE;
363
155
  }
364
156
  if(old_action.sa_handler != SIG_IGN){
365
157
    ret = sigaction(SIGHUP, &new_action, NULL);
366
158
    if(ret == -1){
367
 
      error(0, errno, "sigaction");
368
 
      return EX_OSERR;
 
159
      perror("sigaction");
 
160
      return EXIT_FAILURE;
369
161
    }
370
162
  }
371
163
  ret = sigaction(SIGTERM, NULL, &old_action);
372
164
  if(ret == -1){
373
 
    error(0, errno, "sigaction");
374
 
    return EX_OSERR;
 
165
    perror("sigaction");
 
166
    return EXIT_FAILURE;
375
167
  }
376
168
  if(old_action.sa_handler != SIG_IGN){
377
169
    ret = sigaction(SIGTERM, &new_action, NULL);
378
170
    if(ret == -1){
379
 
      error(0, errno, "sigaction");
380
 
      return EX_OSERR;
 
171
      perror("sigaction");
 
172
      return EXIT_FAILURE;
381
173
    }
382
174
  }
383
175
  
387
179
  }
388
180
  
389
181
  t_new = t_old;
390
 
  t_new.c_lflag &= ~(tcflag_t)ECHO;
 
182
  t_new.c_lflag &= ~ECHO;
391
183
  if(tcsetattr(STDIN_FILENO, TCSAFLUSH, &t_new) != 0){
392
 
    int e = errno;
393
 
    error(0, errno, "tcsetattr-echo");
394
 
    switch(e){
395
 
    case EBADF:
396
 
    case ENOTTY:
397
 
      return EX_UNAVAILABLE;
398
 
    case EINVAL:
399
 
    default:
400
 
      return EX_OSERR;
401
 
    }
 
184
    perror("tcsetattr-echo");
 
185
    return EXIT_FAILURE;
402
186
  }
403
 
  
 
187
 
404
188
  if(debug){
405
189
    fprintf(stderr, "Waiting for input from stdin \n");
406
190
  }
417
201
      fprintf(stderr, "%s ", prefix);
418
202
    }
419
203
    {
420
 
      const char *cryptsource = getenv("CRYPTTAB_SOURCE");
421
 
      const char *crypttarget = getenv("CRYPTTAB_NAME");
422
 
      /* Before cryptsetup 1.1.0~rc2 */
423
 
      if(cryptsource == NULL){
424
 
        cryptsource = getenv("cryptsource");
425
 
      }
426
 
      if(crypttarget == NULL){
427
 
        crypttarget = getenv("crypttarget");
428
 
      }
429
 
      const char *const prompt1 = "Unlocking the disk";
430
 
      const char *const prompt2 = "Enter passphrase";
 
204
      const char *cryptsource = getenv("cryptsource");
 
205
      const char *crypttarget = getenv("crypttarget");
 
206
      const char *const prompt
 
207
        = "Enter passphrase to unlock the disk";
431
208
      if(cryptsource == NULL){
432
209
        if(crypttarget == NULL){
433
 
          fprintf(stderr, "%s to unlock the disk: ", prompt2);
 
210
          fprintf(stderr, "%s: ", prompt);
434
211
        } else {
435
 
          fprintf(stderr, "%s (%s)\n%s: ", prompt1, crypttarget,
436
 
                  prompt2);
 
212
          fprintf(stderr, "%s (%s): ", prompt, crypttarget);
437
213
        }
438
214
      } else {
439
215
        if(crypttarget == NULL){
440
 
          fprintf(stderr, "%s %s\n%s: ", prompt1, cryptsource,
441
 
                  prompt2);
 
216
          fprintf(stderr, "%s %s: ", prompt, cryptsource);
442
217
        } else {
443
 
          fprintf(stderr, "%s %s (%s)\n%s: ", prompt1, cryptsource,
444
 
                  crypttarget, prompt2);
 
218
          fprintf(stderr, "%s %s (%s): ", prompt, cryptsource,
 
219
                  crypttarget);
445
220
        }
446
221
      }
447
222
    }
448
 
    sret = getline(&buffer, &n, stdin);
449
 
    if(sret > 0){
 
223
    ret = getline(&buffer, &n, stdin);
 
224
    if(ret > 0){
450
225
      status = EXIT_SUCCESS;
451
226
      /* Make n = data size instead of allocated buffer size */
452
 
      n = (size_t)sret;
 
227
      n = (size_t)ret;
453
228
      /* Strip final newline */
454
 
      if(n > 0 and buffer[n-1] == '\n'){
 
229
      if(n>0 and buffer[n-1] == '\n'){
455
230
        buffer[n-1] = '\0';     /* not strictly necessary */
456
231
        n--;
457
232
      }
458
233
      size_t written = 0;
459
234
      while(written < n){
460
 
        sret = write(STDOUT_FILENO, buffer + written, n - written);
461
 
        if(sret < 0){
462
 
          int e = errno;
463
 
          error(0, errno, "write");
464
 
          switch(e){
465
 
          case EBADF:
466
 
          case EFAULT:
467
 
          case EINVAL:
468
 
          case EFBIG:
469
 
          case EIO:
470
 
          case ENOSPC:
471
 
          default:
472
 
            status = EX_IOERR;
473
 
            break;
474
 
          case EINTR:
475
 
            status = EXIT_FAILURE;
476
 
            break;
477
 
          }
478
 
          break;
479
 
        }
480
 
        written += (size_t)sret;
481
 
      }
482
 
      sret = close(STDOUT_FILENO);
483
 
      if(sret == -1){
484
 
        int e = errno;
485
 
        error(0, errno, "close");
486
 
        switch(e){
487
 
        case EBADF:
488
 
          status = EX_OSFILE;
489
 
          break;
490
 
        case EIO:
491
 
        default:
492
 
          status = EX_IOERR;
493
 
          break;
494
 
        }
 
235
        ret = write(STDOUT_FILENO, buffer + written, n - written);
 
236
        if(ret < 0){
 
237
          perror("write");
 
238
          status = EXIT_FAILURE;
 
239
          break;
 
240
        }
 
241
        written += (size_t)ret;
495
242
      }
496
243
      break;
497
244
    }
498
 
    if(sret < 0){
499
 
      int e = errno;
 
245
    if(ret < 0){
500
246
      if(errno != EINTR and not feof(stdin)){
501
 
        error(0, errno, "getline");
502
 
        switch(e){
503
 
        case EBADF:
504
 
          status = EX_UNAVAILABLE;
505
 
        case EIO:
506
 
        case EINVAL:
507
 
        default:
508
 
          status = EX_IOERR;
509
 
          break;
510
 
        }
 
247
        perror("getline");
 
248
        status = EXIT_FAILURE;
511
249
        break;
512
250
      }
513
251
    }
514
 
    /* if(sret == 0), then the only sensible thing to do is to retry
515
 
       to read from stdin */
 
252
    /* if(ret == 0), then the only sensible thing to do is to retry to
 
253
       read from stdin */
516
254
    fputc('\n', stderr);
517
255
    if(debug and not quit_now){
518
256
      /* If quit_now is nonzero, we were interrupted by a signal, and
527
265
    fprintf(stderr, "Restoring terminal attributes\n");
528
266
  }
529
267
  if(tcsetattr(STDIN_FILENO, TCSAFLUSH, &t_old) != 0){
530
 
    error(0, errno, "tcsetattr+echo");
 
268
    perror("tcsetattr+echo");
531
269
  }
532
270
  
533
271
  if(quit_now){
535
273
    old_action.sa_handler = SIG_DFL;
536
274
    ret = sigaction(signal_received, &old_action, NULL);
537
275
    if(ret == -1){
538
 
      error(0, errno, "sigaction");
 
276
      perror("sigaction");
539
277
    }
540
278
    raise(signal_received);
541
279
  }
544
282
    fprintf(stderr, "%s is exiting with status %d\n", argv[0],
545
283
            status);
546
284
  }
547
 
  if(status == EXIT_SUCCESS or status == EX_OK){
 
285
  if(status == EXIT_SUCCESS){
548
286
    fputc('\n', stderr);
549
287
  }
550
288