/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: 2009-10-24 19:17:52 UTC
  • Revision ID: teddy@fukt.bsnet.se-20091024191752-7g6xlf6wpp2pdexb
Convert some programs to use the exit codes from <sysexits.h>.  Change
all programs using the "argp" parsing functions to use them correctly;
checking return value, using argp_error() to report parse errors etc.

* plugin-runner.c: Use <sysexits.h> exit codes.  Always use fallback,
                   even on option errors, except for "--help", etc.
  (getplugin): Make sure "errno" is set correctly on return.
  (main): Declare our own "--help", "--usage", and "--version"
          options which do not cause the fallback to be invoked.
          In all other options, use fallback on any error.
  (parse_opt, parse_opt_config_file): Reset errno at start and return
                                      errno.  No need to check "arg"
                                      for NULL.  New "--help",
                                      "--usage", and "--version"
                                      options.
  (parse_opt): Accept empty string as global option.  Do not print
               errors which will be detected and reported later.  Do
               "argp_error()" on parse error or empty plugin names.
* plugins.d/mandos-client.c: Use <sysexits.h> exit codes.  Do not
                             return successful exit code on "--help",
                             etc. since this would give the wrong
                             message to "plugin-runner".
  (main): Declare our own "--help", "--usage", and "--version"
          options which do not return a successful exit code.
  (parse_opt): Reset errno at start and return errno.  Do
               "argp_error()" on parse errors.  New "--help",
               "--usage", and "--version" options.
* plugins.d/password-prompt.c: Use exit codes from <sysexits.h>.  Do
                               not return successful exit code on
                               "--help", etc. since this would give
                               the wrong message to "plugin-runner".
  (main): Declare our own "--help", "--usage", and "--version" options
          which do not return a successful exit code.  Do
          close(STDOUT_FILENO) after writing to check its return code.
  (parse_opt): Reset errno at start and return errno.

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