/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

  • Committer: Teddy Hogeborn
  • Date: 2019-02-28 18:48:33 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 382.
  • Revision ID: teddy@recompile.se-20190228184833-nlg1xxlhnldso9ya
Make mandos-ctl use unittest instead of doctest module

* mandos-ctl: Before running main(), check if we should only run tests
              by seeing if the --check option was passed.
  (main): Don't look for the --check option.
  (should_only_run_tests): New.
  (load_tests): New.

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