/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

* plugins.d/password-prompt.c: Use environment variables and prompt
                               text from cryptsetup 1.1.
* plugins.d/password-prompt.xml (ENVIRONMENT): Document change in
                                               environment variables
                                               used.

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-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
 
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
16
14
 * WITHOUT ANY WARRANTY; without even the implied warranty of
17
15
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18
16
 * General Public License for more details.
19
17
 * 
20
18
 * You should have received a copy of the GNU General Public License
21
 
 * along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
 
19
 * along with this program.  If not, see
 
20
 * <http://www.gnu.org/licenses/>.
22
21
 * 
23
 
 * Contact the authors at <mandos@recompile.se>.
 
22
 * Contact the authors at <mandos@fukt.bsnet.se>.
24
23
 */
25
24
 
26
 
#define _GNU_SOURCE             /* getline(), asprintf() */
 
25
#define _GNU_SOURCE             /* getline() */
27
26
 
28
 
#include <termios.h>            /* struct termios, tcsetattr(),
 
27
#include <termios.h>            /* struct termios, tcsetattr(),
29
28
                                   TCSAFLUSH, tcgetattr(), ECHO */
30
 
#include <unistd.h>             /* access(), struct termios,
31
 
                                   tcsetattr(), STDIN_FILENO,
32
 
                                   TCSAFLUSH, tcgetattr(), ECHO,
33
 
                                   readlink() */
 
29
#include <unistd.h>             /* struct termios, tcsetattr(),
 
30
                                   STDIN_FILENO, TCSAFLUSH,
 
31
                                   tcgetattr(), ECHO */
34
32
#include <signal.h>             /* sig_atomic_t, raise(), struct
35
33
                                   sigaction, sigemptyset(),
36
34
                                   sigaction(), sigaddset(), SIGINT,
37
35
                                   SIGQUIT, SIGHUP, SIGTERM,
38
36
                                   raise() */
39
37
#include <stddef.h>             /* NULL, size_t, ssize_t */
40
 
#include <sys/types.h>          /* ssize_t, struct dirent, pid_t,
41
 
                                   ssize_t, open() */
 
38
#include <sys/types.h>          /* ssize_t */
42
39
#include <stdlib.h>             /* EXIT_SUCCESS, EXIT_FAILURE,
43
 
                                   getenv(), free() */
44
 
#include <dirent.h>             /* scandir(), alphasort() */
 
40
                                   getenv() */
45
41
#include <stdio.h>              /* fprintf(), stderr, getline(),
46
 
                                   stdin, feof(), fputc(), vfprintf(),
47
 
                                   vasprintf() */
 
42
                                   stdin, feof(), perror(), fputc()
 
43
                                */
48
44
#include <errno.h>              /* errno, EBADF, ENOTTY, EINVAL,
49
45
                                   EFAULT, EFBIG, EIO, ENOSPC, EINTR
50
46
                                */
51
 
#include <error.h>              /* error() */
52
47
#include <iso646.h>             /* or, not */
53
48
#include <stdbool.h>            /* bool, false, true */
54
 
#include <inttypes.h>           /* strtoumax() */
55
 
#include <sys/stat.h>           /* struct stat, lstat(), open() */
56
 
#include <string.h>             /* strlen, rindex, memcmp, strerror()
57
 
                                 */
 
49
#include <string.h>             /* strlen, rindex, strncmp, strcmp */
58
50
#include <argp.h>               /* struct argp_option, struct
59
51
                                   argp_state, struct argp,
60
52
                                   argp_parse(), error_t,
62
54
                                   ARGP_ERR_UNKNOWN */
63
55
#include <sysexits.h>           /* EX_SOFTWARE, EX_OSERR,
64
56
                                   EX_UNAVAILABLE, EX_IOERR, EX_OK */
65
 
#include <fcntl.h>              /* open() */
66
 
#include <stdarg.h>             /* va_list, va_start(), ... */
67
57
 
68
58
volatile sig_atomic_t quit_now = 0;
69
59
int signal_received;
70
60
bool debug = false;
71
61
const char *argp_program_version = "password-prompt " VERSION;
72
 
const char *argp_program_bug_address = "<mandos@recompile.se>";
73
 
 
74
 
/* Needed for conflict resolution */
75
 
const char plymouth_name[] = "plymouthd";
76
 
 
77
 
/* Function to use when printing errors */
78
 
__attribute__((format (gnu_printf, 3, 4)))
79
 
void error_plus(int status, int errnum, const char *formatstring,
80
 
                ...){
81
 
  va_list ap;
82
 
  char *text;
83
 
  int ret;
84
 
  
85
 
  va_start(ap, formatstring);
86
 
  ret = vasprintf(&text, formatstring, ap);
87
 
  if(ret == -1){
88
 
    fprintf(stderr, "Mandos plugin %s: ",
89
 
            program_invocation_short_name);
90
 
    vfprintf(stderr, formatstring, ap);
91
 
    fprintf(stderr, ": %s\n", strerror(errnum));
92
 
    error(status, errno, "vasprintf while printing error");
93
 
    return;
94
 
  }
95
 
  fprintf(stderr, "Mandos plugin ");
96
 
  error(status, errnum, "%s", text);
97
 
  free(text);
98
 
}
 
62
const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";
99
63
 
100
64
static void termination_handler(int signum){
101
65
  if(quit_now){
105
69
  signal_received = signum;
106
70
}
107
71
 
108
 
bool conflict_detection(void){
109
 
 
110
 
  /* plymouth conflicts with password-prompt since both want to read
111
 
     from the terminal.  Password-prompt will exit if it detects
112
 
     plymouth since plymouth performs the same functionality.
113
 
   */
114
 
  if(access("/run/plymouth/pid", R_OK) == 0){
115
 
    return true;
116
 
  }
117
 
  
118
 
  __attribute__((nonnull))
119
 
  int is_plymouth(const struct dirent *proc_entry){
120
 
    int ret;
121
 
    int cl_fd;
122
 
    {
123
 
      uintmax_t proc_id;
124
 
      char *tmp;
125
 
      errno = 0;
126
 
      proc_id = strtoumax(proc_entry->d_name, &tmp, 10);
127
 
      
128
 
      if(errno != 0 or *tmp != '\0'
129
 
         or proc_id != (uintmax_t)((pid_t)proc_id)){
130
 
        return 0;
131
 
      }
132
 
    }
133
 
    
134
 
    char *cmdline_filename;
135
 
    ret = asprintf(&cmdline_filename, "/proc/%s/cmdline",
136
 
                   proc_entry->d_name);
137
 
    if(ret == -1){
138
 
      error_plus(0, errno, "asprintf");
139
 
      return 0;
140
 
    }
141
 
    
142
 
    /* Open /proc/<pid>/cmdline */
143
 
    cl_fd = open(cmdline_filename, O_RDONLY);
144
 
    free(cmdline_filename);
145
 
    if(cl_fd == -1){
146
 
      if(errno != ENOENT){
147
 
        error_plus(0, errno, "open");
148
 
      }
149
 
      return 0;
150
 
    }
151
 
    
152
 
    char *cmdline = NULL;
153
 
    {
154
 
      size_t cmdline_len = 0;
155
 
      size_t cmdline_allocated = 0;
156
 
      char *tmp;
157
 
      const size_t blocksize = 1024;
158
 
      ssize_t sret;
159
 
      do {
160
 
        /* Allocate more space? */
161
 
        if(cmdline_len + blocksize + 1 > cmdline_allocated){
162
 
          tmp = realloc(cmdline, cmdline_allocated + blocksize + 1);
163
 
          if(tmp == NULL){
164
 
            error_plus(0, errno, "realloc");
165
 
            free(cmdline);
166
 
            close(cl_fd);
167
 
            return 0;
168
 
          }
169
 
          cmdline = tmp;
170
 
          cmdline_allocated += blocksize;
171
 
        }
172
 
        
173
 
        /* Read data */
174
 
        sret = read(cl_fd, cmdline + cmdline_len,
175
 
                    cmdline_allocated - cmdline_len);
176
 
        if(sret == -1){
177
 
          error_plus(0, errno, "read");
178
 
          free(cmdline);
179
 
          close(cl_fd);
180
 
          return 0;
181
 
        }
182
 
        cmdline_len += (size_t)sret;
183
 
      } while(sret != 0);
184
 
      ret = close(cl_fd);
185
 
      if(ret == -1){
186
 
        error_plus(0, errno, "close");
187
 
        free(cmdline);
188
 
        return 0;
189
 
      }
190
 
      cmdline[cmdline_len] = '\0'; /* Make sure it is terminated */
191
 
    }
192
 
    /* we now have cmdline */
193
 
    
194
 
    /* get basename */
195
 
    char *cmdline_base = strrchr(cmdline, '/');
196
 
    if(cmdline_base != NULL){
197
 
      cmdline_base += 1;                /* skip the slash */
198
 
    } else {
199
 
      cmdline_base = cmdline;
200
 
    }
201
 
    
202
 
    if(strcmp(cmdline_base, plymouth_name) != 0){
203
 
      if(debug){
204
 
        fprintf(stderr, "\"%s\" is not \"%s\"\n", cmdline_base,
205
 
                plymouth_name);
206
 
      }
207
 
      free(cmdline);
208
 
      return 0;
209
 
    }
210
 
    if(debug){
211
 
      fprintf(stderr, "\"%s\" equals \"%s\"\n", cmdline_base,
212
 
              plymouth_name);
213
 
    }
214
 
    free(cmdline);
215
 
    return 1;
216
 
  }
217
 
  
218
 
  struct dirent **direntries = NULL;
219
 
  int ret;
220
 
  ret = scandir("/proc", &direntries, is_plymouth, alphasort);
221
 
  if(ret == -1){
222
 
    error_plus(1, errno, "scandir");
223
 
  }
224
 
  {
225
 
    int i = ret;
226
 
    while(i--){
227
 
      free(direntries[i]);
228
 
    }
229
 
  }
230
 
  free(direntries);
231
 
  return ret > 0;
232
 
}
233
 
 
234
 
 
235
72
int main(int argc, char **argv){
236
 
  ssize_t sret;
237
 
  int ret;
 
73
  ssize_t ret;
238
74
  size_t n;
239
75
  struct termios t_new, t_old;
240
76
  char *buffer = NULL;
241
77
  char *prefix = NULL;
242
 
  char *prompt = NULL;
243
78
  int status = EXIT_SUCCESS;
244
79
  struct sigaction old_action,
245
80
    new_action = { .sa_handler = termination_handler,
249
84
      { .name = "prefix", .key = 'p',
250
85
        .arg = "PREFIX", .flags = 0,
251
86
        .doc = "Prefix shown before the prompt", .group = 2 },
252
 
      { .name = "prompt", .key = 129,
253
 
        .arg = "PROMPT", .flags = 0,
254
 
        .doc = "The prompt to show", .group = 2 },
255
87
      { .name = "debug", .key = 128,
256
88
        .doc = "Debug mode", .group = 3 },
257
89
      /*
266
98
      { .name = NULL }
267
99
    };
268
100
    
269
 
    __attribute__((nonnull(3)))
270
101
    error_t parse_opt (int key, char *arg, struct argp_state *state){
271
102
      errno = 0;
272
103
      switch (key){
273
 
      case 'p':                 /* --prefix */
 
104
      case 'p':
274
105
        prefix = arg;
275
106
        break;
276
 
      case 128:                 /* --debug */
 
107
      case 128:
277
108
        debug = true;
278
109
        break;
279
 
      case 129:                 /* --prompt */
280
 
        prompt = arg;
281
 
        break;
282
110
        /*
283
111
         * These reproduce what we would get without ARGP_NO_HELP
284
112
         */
286
114
        argp_state_help(state, state->out_stream,
287
115
                        (ARGP_HELP_STD_HELP | ARGP_HELP_EXIT_ERR)
288
116
                        & ~(unsigned int)ARGP_HELP_EXIT_OK);
289
 
        __builtin_unreachable();
290
117
      case -3:                  /* --usage */
291
118
        argp_state_help(state, state->out_stream,
292
119
                        ARGP_HELP_USAGE | ARGP_HELP_EXIT_ERR);
293
 
        __builtin_unreachable();
294
120
      case 'V':                 /* --version */
295
121
        fprintf(state->out_stream, "%s\n", argp_program_version);
296
122
        exit(argp_err_exit_status);
313
139
    case ENOMEM:
314
140
    default:
315
141
      errno = ret;
316
 
      error_plus(0, errno, "argp_parse");
 
142
      perror("argp_parse");
317
143
      return EX_OSERR;
318
144
    case EINVAL:
319
145
      return EX_USAGE;
323
149
  if(debug){
324
150
    fprintf(stderr, "Starting %s\n", argv[0]);
325
151
  }
326
 
 
327
 
  if(conflict_detection()){
328
 
    if(debug){
329
 
      fprintf(stderr, "Stopping %s because of conflict\n", argv[0]);
330
 
    }
331
 
    return EXIT_FAILURE;
332
 
  }
333
 
  
334
152
  if(debug){
335
153
    fprintf(stderr, "Storing current terminal attributes\n");
336
154
  }
337
155
  
338
156
  if(tcgetattr(STDIN_FILENO, &t_old) != 0){
339
157
    int e = errno;
340
 
    error_plus(0, errno, "tcgetattr");
 
158
    perror("tcgetattr");
341
159
    switch(e){
342
160
    case EBADF:
343
161
    case ENOTTY:
350
168
  sigemptyset(&new_action.sa_mask);
351
169
  ret = sigaddset(&new_action.sa_mask, SIGINT);
352
170
  if(ret == -1){
353
 
    error_plus(0, errno, "sigaddset");
 
171
    perror("sigaddset");
354
172
    return EX_OSERR;
355
173
  }
356
174
  ret = sigaddset(&new_action.sa_mask, SIGHUP);
357
175
  if(ret == -1){
358
 
    error_plus(0, errno, "sigaddset");
 
176
    perror("sigaddset");
359
177
    return EX_OSERR;
360
178
  }
361
179
  ret = sigaddset(&new_action.sa_mask, SIGTERM);
362
180
  if(ret == -1){
363
 
    error_plus(0, errno, "sigaddset");
 
181
    perror("sigaddset");
364
182
    return EX_OSERR;
365
183
  }
366
184
  /* Need to check if the handler is SIG_IGN before handling:
369
187
  */
370
188
  ret = sigaction(SIGINT, NULL, &old_action);
371
189
  if(ret == -1){
372
 
    error_plus(0, errno, "sigaction");
 
190
    perror("sigaction");
373
191
    return EX_OSERR;
374
192
  }
375
193
  if(old_action.sa_handler != SIG_IGN){
376
194
    ret = sigaction(SIGINT, &new_action, NULL);
377
195
    if(ret == -1){
378
 
      error_plus(0, errno, "sigaction");
 
196
      perror("sigaction");
379
197
      return EX_OSERR;
380
198
    }
381
199
  }
382
200
  ret = sigaction(SIGHUP, NULL, &old_action);
383
201
  if(ret == -1){
384
 
    error_plus(0, errno, "sigaction");
 
202
    perror("sigaction");
385
203
    return EX_OSERR;
386
204
  }
387
205
  if(old_action.sa_handler != SIG_IGN){
388
206
    ret = sigaction(SIGHUP, &new_action, NULL);
389
207
    if(ret == -1){
390
 
      error_plus(0, errno, "sigaction");
 
208
      perror("sigaction");
391
209
      return EX_OSERR;
392
210
    }
393
211
  }
394
212
  ret = sigaction(SIGTERM, NULL, &old_action);
395
213
  if(ret == -1){
396
 
    error_plus(0, errno, "sigaction");
 
214
    perror("sigaction");
397
215
    return EX_OSERR;
398
216
  }
399
217
  if(old_action.sa_handler != SIG_IGN){
400
218
    ret = sigaction(SIGTERM, &new_action, NULL);
401
219
    if(ret == -1){
402
 
      error_plus(0, errno, "sigaction");
 
220
      perror("sigaction");
403
221
      return EX_OSERR;
404
222
    }
405
223
  }
413
231
  t_new.c_lflag &= ~(tcflag_t)ECHO;
414
232
  if(tcsetattr(STDIN_FILENO, TCSAFLUSH, &t_new) != 0){
415
233
    int e = errno;
416
 
    error_plus(0, errno, "tcsetattr-echo");
 
234
    perror("tcsetattr-echo");
417
235
    switch(e){
418
236
    case EBADF:
419
237
    case ENOTTY:
439
257
    if(prefix){
440
258
      fprintf(stderr, "%s ", prefix);
441
259
    }
442
 
    if(prompt != NULL){
443
 
      fprintf(stderr, "%s: ", prompt);
444
 
    } else {
 
260
    {
445
261
      const char *cryptsource = getenv("CRYPTTAB_SOURCE");
446
262
      const char *crypttarget = getenv("CRYPTTAB_NAME");
447
263
      /* Before cryptsetup 1.1.0~rc2 */
470
286
        }
471
287
      }
472
288
    }
473
 
    sret = getline(&buffer, &n, stdin);
474
 
    if(sret > 0){
 
289
    ret = getline(&buffer, &n, stdin);
 
290
    if(ret > 0){
475
291
      status = EXIT_SUCCESS;
476
292
      /* Make n = data size instead of allocated buffer size */
477
 
      n = (size_t)sret;
 
293
      n = (size_t)ret;
478
294
      /* Strip final newline */
479
295
      if(n > 0 and buffer[n-1] == '\n'){
480
296
        buffer[n-1] = '\0';     /* not strictly necessary */
482
298
      }
483
299
      size_t written = 0;
484
300
      while(written < n){
485
 
        sret = write(STDOUT_FILENO, buffer + written, n - written);
486
 
        if(sret < 0){
 
301
        ret = write(STDOUT_FILENO, buffer + written, n - written);
 
302
        if(ret < 0){
487
303
          int e = errno;
488
 
          error_plus(0, errno, "write");
 
304
          perror("write");
489
305
          switch(e){
490
306
          case EBADF:
491
307
          case EFAULT:
502
318
          }
503
319
          break;
504
320
        }
505
 
        written += (size_t)sret;
 
321
        written += (size_t)ret;
506
322
      }
507
 
      sret = close(STDOUT_FILENO);
508
 
      if(sret == -1){
 
323
      ret = close(STDOUT_FILENO);
 
324
      if(ret == -1){
509
325
        int e = errno;
510
 
        error_plus(0, errno, "close");
 
326
        perror("close");
511
327
        switch(e){
512
328
        case EBADF:
513
329
          status = EX_OSFILE;
520
336
      }
521
337
      break;
522
338
    }
523
 
    if(sret < 0){
 
339
    if(ret < 0){
524
340
      int e = errno;
525
 
      if(errno != EINTR){
526
 
        if(not feof(stdin)){
527
 
          error_plus(0, errno, "getline");
528
 
          switch(e){
529
 
          case EBADF:
530
 
            status = EX_UNAVAILABLE;
531
 
            break;
532
 
          case EIO:
533
 
          case EINVAL:
534
 
          default:
535
 
            status = EX_IOERR;
536
 
            break;
537
 
          }
 
341
      if(errno != EINTR and not feof(stdin)){
 
342
        perror("getline");
 
343
        switch(e){
 
344
        case EBADF:
 
345
          status = EX_UNAVAILABLE;
 
346
        case EIO:
 
347
        case EINVAL:
 
348
        default:
 
349
          status = EX_IOERR;
538
350
          break;
539
 
        } else {
540
 
          clearerr(stdin);
541
351
        }
 
352
        break;
542
353
      }
543
354
    }
544
 
    /* if(sret == 0), then the only sensible thing to do is to retry
545
 
       to read from stdin */
 
355
    /* if(ret == 0), then the only sensible thing to do is to retry to
 
356
       read from stdin */
546
357
    fputc('\n', stderr);
547
358
    if(debug and not quit_now){
548
359
      /* If quit_now is nonzero, we were interrupted by a signal, and
557
368
    fprintf(stderr, "Restoring terminal attributes\n");
558
369
  }
559
370
  if(tcsetattr(STDIN_FILENO, TCSAFLUSH, &t_old) != 0){
560
 
    error_plus(0, errno, "tcsetattr+echo");
 
371
    perror("tcsetattr+echo");
561
372
  }
562
373
  
563
374
  if(quit_now){
565
376
    old_action.sa_handler = SIG_DFL;
566
377
    ret = sigaction(signal_received, &old_action, NULL);
567
378
    if(ret == -1){
568
 
      error_plus(0, errno, "sigaction");
 
379
      perror("sigaction");
569
380
    }
570
381
    raise(signal_received);
571
382
  }