/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: 2024-09-09 02:51:47 UTC
  • Revision ID: teddy@recompile.se-20240909025147-0o7tx2njlr8hujgw
Change to new lintian override syntax

Lintian has changed its output for warnings, and as a result, its
syntax for overriding those warnings has also changed.  (See Debian
bug #1007002 for further information.)  Therefore, change the syntax
in the lintian override files.

* debian/mandos-client.lintian-overrides: Change to new lintian
  "pointed hints" syntax.
* debian/mandos.lintian-overrides: - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
/*
3
3
 * Password-prompt - Read a password from the terminal and print it
4
4
 * 
5
 
 * Copyright © 2008-2010 Teddy Hogeborn
6
 
 * Copyright © 2008-2010 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, 2021-2022 Teddy Hogeborn
 
6
 * Copyright © 2008-2019, 2021-2022 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(), asprintf() */
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, readlink() */
32
 
#include <signal.h>             /* sig_atomic_t, raise(), struct
33
 
                                   sigaction, sigemptyset(),
34
 
                                   sigaction(), sigaddset(), SIGINT,
35
 
                                   SIGQUIT, SIGHUP, SIGTERM,
 
26
#define _GNU_SOURCE             /* vasprintf(),
 
27
                                   program_invocation_short_name,
 
28
                                   asprintf(), getline() */
 
29
#include <sys/types.h>          /* sig_atomic_t, pid_t */
 
30
#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,
36
69
                                   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() */
40
 
#include <stdlib.h>             /* EXIT_SUCCESS, EXIT_FAILURE,
41
 
                                   getenv(), free() */
42
 
#include <dirent.h>             /* scandir(), alphasort() */
43
 
#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() */
50
 
#include <iso646.h>             /* or, not */
51
 
#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() */
 
70
#include <sysexits.h>           /* EX_OSERR, EX_USAGE, EX_UNAVAILABLE,
 
71
                                   EX_IOERR, EX_OSFILE, EX_OK */
63
72
 
64
73
volatile sig_atomic_t quit_now = 0;
65
74
int signal_received;
66
75
bool debug = false;
67
76
const char *argp_program_version = "password-prompt " VERSION;
68
 
const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";
 
77
const char *argp_program_bug_address = "<mandos@recompile.se>";
69
78
 
70
79
/* Needed for conflict resolution */
71
80
const char plymouth_name[] = "plymouthd";
72
 
const char plymouth_alt_name[] = "plymouthd";
73
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
}
74
104
 
75
105
static void termination_handler(int signum){
76
106
  if(quit_now){
86
116
     from the terminal.  Password-prompt will exit if it detects
87
117
     plymouth since plymouth performs the same functionality.
88
118
   */
 
119
  if(access("/run/plymouth/pid", R_OK) == 0){
 
120
    return true;
 
121
  }
 
122
  
 
123
  __attribute__((nonnull))
89
124
  int is_plymouth(const struct dirent *proc_entry){
90
125
    int ret;
91
126
    int cl_fd;
92
127
    {
93
 
      uintmax_t maxvalue;
 
128
      uintmax_t proc_id;
94
129
      char *tmp;
95
130
      errno = 0;
96
 
      maxvalue = strtoumax(proc_entry->d_name, &tmp, 10);
 
131
      proc_id = strtoumax(proc_entry->d_name, &tmp, 10);
97
132
      
98
133
      if(errno != 0 or *tmp != '\0'
99
 
         or maxvalue != (uintmax_t)((pid_t)maxvalue)){
 
134
         or proc_id != (uintmax_t)((pid_t)proc_id)){
100
135
        return 0;
101
136
      }
102
137
    }
105
140
    ret = asprintf(&cmdline_filename, "/proc/%s/cmdline",
106
141
                   proc_entry->d_name);
107
142
    if(ret == -1){
108
 
      error(0, errno, "asprintf");
 
143
      error_plus(0, errno, "asprintf");
109
144
      return 0;
110
145
    }
111
146
    
113
148
    cl_fd = open(cmdline_filename, O_RDONLY);
114
149
    free(cmdline_filename);
115
150
    if(cl_fd == -1){
116
 
      error(0, errno, "open");
 
151
      if(errno != ENOENT){
 
152
        error_plus(0, errno, "open");
 
153
      }
117
154
      return 0;
118
155
    }
119
156
    
129
166
        if(cmdline_len + blocksize + 1 > cmdline_allocated){
130
167
          tmp = realloc(cmdline, cmdline_allocated + blocksize + 1);
131
168
          if(tmp == NULL){
132
 
            error(0, errno, "realloc");
 
169
            error_plus(0, errno, "realloc");
133
170
            free(cmdline);
134
171
            close(cl_fd);
135
172
            return 0;
142
179
        sret = read(cl_fd, cmdline + cmdline_len,
143
180
                    cmdline_allocated - cmdline_len);
144
181
        if(sret == -1){
145
 
          error(0, errno, "read");
 
182
          error_plus(0, errno, "read");
146
183
          free(cmdline);
147
184
          close(cl_fd);
148
185
          return 0;
151
188
      } while(sret != 0);
152
189
      ret = close(cl_fd);
153
190
      if(ret == -1){
154
 
        error(0, errno, "close");
 
191
        error_plus(0, errno, "close");
155
192
        free(cmdline);
156
193
        return 0;
157
194
      }
167
204
      cmdline_base = cmdline;
168
205
    }
169
206
    
170
 
    if((strcmp(cmdline_base, plymouth_name) != 0)
171
 
       and (strcmp(cmdline_base, plymouth_alt_name) != 0)){
 
207
    if(strcmp(cmdline_base, plymouth_name) != 0){
172
208
      if(debug){
173
 
        fprintf(stderr, "\"%s\" is not \"%s\" or \"%s\"\n",
174
 
                cmdline_base, plymouth_name, plymouth_alt_name);
 
209
        fprintf(stderr, "\"%s\" is not \"%s\"\n", cmdline_base,
 
210
                plymouth_name);
175
211
      }
176
212
      free(cmdline);
177
213
      return 0;
178
214
    }
179
 
    fprintf(stderr, "\"%s\" equals \"%s\" or \"%s\"\n",
180
 
            cmdline_base, plymouth_name, plymouth_alt_name);
 
215
    if(debug){
 
216
      fprintf(stderr, "\"%s\" equals \"%s\"\n", cmdline_base,
 
217
              plymouth_name);
 
218
    }
181
219
    free(cmdline);
182
220
    return 1;
183
221
  }
184
222
  
185
 
  struct dirent **direntries;
 
223
  struct dirent **direntries = NULL;
186
224
  int ret;
187
225
  ret = scandir("/proc", &direntries, is_plymouth, alphasort);
188
 
  if (ret == -1){
189
 
    error(1, errno, "scandir");
190
 
  }
 
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);
191
236
  return ret > 0;
192
237
}
193
238
 
199
244
  struct termios t_new, t_old;
200
245
  char *buffer = NULL;
201
246
  char *prefix = NULL;
 
247
  char *prompt = NULL;
202
248
  int status = EXIT_SUCCESS;
203
249
  struct sigaction old_action,
204
250
    new_action = { .sa_handler = termination_handler,
208
254
      { .name = "prefix", .key = 'p',
209
255
        .arg = "PREFIX", .flags = 0,
210
256
        .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 },
211
260
      { .name = "debug", .key = 128,
212
261
        .doc = "Debug mode", .group = 3 },
213
262
      /*
222
271
      { .name = NULL }
223
272
    };
224
273
    
 
274
    __attribute__((nonnull(3)))
225
275
    error_t parse_opt (int key, char *arg, struct argp_state *state){
226
276
      errno = 0;
227
277
      switch (key){
228
 
      case 'p':
 
278
      case 'p':                 /* --prefix */
229
279
        prefix = arg;
230
280
        break;
231
 
      case 128:
 
281
      case 128:                 /* --debug */
232
282
        debug = true;
233
283
        break;
 
284
      case 129:                 /* --prompt */
 
285
        prompt = arg;
 
286
        break;
234
287
        /*
235
288
         * These reproduce what we would get without ARGP_NO_HELP
236
289
         */
238
291
        argp_state_help(state, state->out_stream,
239
292
                        (ARGP_HELP_STD_HELP | ARGP_HELP_EXIT_ERR)
240
293
                        & ~(unsigned int)ARGP_HELP_EXIT_OK);
 
294
        __builtin_unreachable();
241
295
      case -3:                  /* --usage */
242
296
        argp_state_help(state, state->out_stream,
243
297
                        ARGP_HELP_USAGE | ARGP_HELP_EXIT_ERR);
 
298
        __builtin_unreachable();
244
299
      case 'V':                 /* --version */
245
300
        fprintf(state->out_stream, "%s\n", argp_program_version);
246
301
        exit(argp_err_exit_status);
263
318
    case ENOMEM:
264
319
    default:
265
320
      errno = ret;
266
 
      error(0, errno, "argp_parse");
 
321
      error_plus(0, errno, "argp_parse");
267
322
      return EX_OSERR;
268
323
    case EINVAL:
269
324
      return EX_USAGE;
274
329
    fprintf(stderr, "Starting %s\n", argv[0]);
275
330
  }
276
331
 
277
 
  if (conflict_detection()){
 
332
  if(conflict_detection()){
278
333
    if(debug){
279
334
      fprintf(stderr, "Stopping %s because of conflict\n", argv[0]);
280
335
    }
287
342
  
288
343
  if(tcgetattr(STDIN_FILENO, &t_old) != 0){
289
344
    int e = errno;
290
 
    error(0, errno, "tcgetattr");
 
345
    error_plus(0, errno, "tcgetattr");
291
346
    switch(e){
292
347
    case EBADF:
293
348
    case ENOTTY:
300
355
  sigemptyset(&new_action.sa_mask);
301
356
  ret = sigaddset(&new_action.sa_mask, SIGINT);
302
357
  if(ret == -1){
303
 
    error(0, errno, "sigaddset");
 
358
    error_plus(0, errno, "sigaddset");
304
359
    return EX_OSERR;
305
360
  }
306
361
  ret = sigaddset(&new_action.sa_mask, SIGHUP);
307
362
  if(ret == -1){
308
 
    error(0, errno, "sigaddset");
 
363
    error_plus(0, errno, "sigaddset");
309
364
    return EX_OSERR;
310
365
  }
311
366
  ret = sigaddset(&new_action.sa_mask, SIGTERM);
312
367
  if(ret == -1){
313
 
    error(0, errno, "sigaddset");
 
368
    error_plus(0, errno, "sigaddset");
314
369
    return EX_OSERR;
315
370
  }
316
371
  /* Need to check if the handler is SIG_IGN before handling:
319
374
  */
320
375
  ret = sigaction(SIGINT, NULL, &old_action);
321
376
  if(ret == -1){
322
 
    error(0, errno, "sigaction");
 
377
    error_plus(0, errno, "sigaction");
323
378
    return EX_OSERR;
324
379
  }
325
380
  if(old_action.sa_handler != SIG_IGN){
326
381
    ret = sigaction(SIGINT, &new_action, NULL);
327
382
    if(ret == -1){
328
 
      error(0, errno, "sigaction");
 
383
      error_plus(0, errno, "sigaction");
329
384
      return EX_OSERR;
330
385
    }
331
386
  }
332
387
  ret = sigaction(SIGHUP, NULL, &old_action);
333
388
  if(ret == -1){
334
 
    error(0, errno, "sigaction");
 
389
    error_plus(0, errno, "sigaction");
335
390
    return EX_OSERR;
336
391
  }
337
392
  if(old_action.sa_handler != SIG_IGN){
338
393
    ret = sigaction(SIGHUP, &new_action, NULL);
339
394
    if(ret == -1){
340
 
      error(0, errno, "sigaction");
 
395
      error_plus(0, errno, "sigaction");
341
396
      return EX_OSERR;
342
397
    }
343
398
  }
344
399
  ret = sigaction(SIGTERM, NULL, &old_action);
345
400
  if(ret == -1){
346
 
    error(0, errno, "sigaction");
 
401
    error_plus(0, errno, "sigaction");
347
402
    return EX_OSERR;
348
403
  }
349
404
  if(old_action.sa_handler != SIG_IGN){
350
405
    ret = sigaction(SIGTERM, &new_action, NULL);
351
406
    if(ret == -1){
352
 
      error(0, errno, "sigaction");
 
407
      error_plus(0, errno, "sigaction");
353
408
      return EX_OSERR;
354
409
    }
355
410
  }
363
418
  t_new.c_lflag &= ~(tcflag_t)ECHO;
364
419
  if(tcsetattr(STDIN_FILENO, TCSAFLUSH, &t_new) != 0){
365
420
    int e = errno;
366
 
    error(0, errno, "tcsetattr-echo");
 
421
    error_plus(0, errno, "tcsetattr-echo");
367
422
    switch(e){
368
423
    case EBADF:
369
424
    case ENOTTY:
389
444
    if(prefix){
390
445
      fprintf(stderr, "%s ", prefix);
391
446
    }
392
 
    {
 
447
    if(prompt != NULL){
 
448
      fprintf(stderr, "%s: ", prompt);
 
449
    } else {
393
450
      const char *cryptsource = getenv("CRYPTTAB_SOURCE");
394
451
      const char *crypttarget = getenv("CRYPTTAB_NAME");
395
452
      /* Before cryptsetup 1.1.0~rc2 */
433
490
        sret = write(STDOUT_FILENO, buffer + written, n - written);
434
491
        if(sret < 0){
435
492
          int e = errno;
436
 
          error(0, errno, "write");
 
493
          error_plus(0, errno, "write");
437
494
          switch(e){
438
495
          case EBADF:
439
496
          case EFAULT:
455
512
      sret = close(STDOUT_FILENO);
456
513
      if(sret == -1){
457
514
        int e = errno;
458
 
        error(0, errno, "close");
 
515
        error_plus(0, errno, "close");
459
516
        switch(e){
460
517
        case EBADF:
461
518
          status = EX_OSFILE;
470
527
    }
471
528
    if(sret < 0){
472
529
      int e = errno;
473
 
      if(errno != EINTR and not feof(stdin)){
474
 
        error(0, errno, "getline");
475
 
        switch(e){
476
 
        case EBADF:
477
 
          status = EX_UNAVAILABLE;
478
 
        case EIO:
479
 
        case EINVAL:
480
 
        default:
481
 
          status = EX_IOERR;
 
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
          }
482
543
          break;
 
544
        } else {
 
545
          clearerr(stdin);
483
546
        }
484
 
        break;
485
547
      }
486
548
    }
487
549
    /* if(sret == 0), then the only sensible thing to do is to retry
500
562
    fprintf(stderr, "Restoring terminal attributes\n");
501
563
  }
502
564
  if(tcsetattr(STDIN_FILENO, TCSAFLUSH, &t_old) != 0){
503
 
    error(0, errno, "tcsetattr+echo");
 
565
    error_plus(0, errno, "tcsetattr+echo");
504
566
  }
505
567
  
506
568
  if(quit_now){
508
570
    old_action.sa_handler = SIG_DFL;
509
571
    ret = sigaction(signal_received, &old_action, NULL);
510
572
    if(ret == -1){
511
 
      error(0, errno, "sigaction");
 
573
      error_plus(0, errno, "sigaction");
512
574
    }
513
575
    raise(signal_received);
514
576
  }