/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: 2008-10-05 17:38:31 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081005173831-fysrfayl4yvhlo6x
* INSTALL: Add instructions on how to set the correct network
           interface on the cient, and also how to test the server and
           verify the password.

* TODO: Clean up old stuff.

* debian/mandos-client.README.Debian: Separate into sections with
                                      headlines.  Add instructions on
                                      how to test the server and
                                      verify the password.

* plugin-runner.conf: Add reminder to update initrd image.

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