/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

* mandos: Use the new argparse library instead of optparse.
* debian/control (mandos): Depend on python (<=2.7) | python-argparse

Show diffs side-by-side

added added

removed removed

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