/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

Added manual pages for:
      clients.conf
      mandos.conf
      mandos
      mandos-client
      password-prompt
      password-request

Show diffs side-by-side

added added

removed removed

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