/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

* TODO: Clarifications.

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