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

  • Committer: Teddy Hogeborn
  • Date: 2009-01-18 06:41:57 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090118064157-8o4oia1y0t8di0xj
* debian/mandos-client.lintian-overrides: Remove override for
                                          unbreakable line in
                                          plugin-runner manual page.
* plugin-runner.xml (EXAMPLES): Make long command line more breakable.

Show diffs side-by-side

added added

removed removed

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