/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
1
 
/*  -*- coding: utf-8 -*- */
 
1
/*  -*- coding: utf-8; mode: c; mode: orgtbl -*- */
2
2
/*
3
 
 * Passprompt - Read a password from the terminal and print it
4
 
 *
5
 
 * Copyright © 2007-2008 Teddy Hogeborn and Björn Påhlsson.
 
3
 * Password-prompt - Read a password from the terminal and print it
 
4
 * 
 
5
 * Copyright © 2008,2009 Teddy Hogeborn
 
6
 * Copyright © 2008,2009 Björn Påhlsson
6
7
 * 
7
8
 * This program is free software: you can redistribute it and/or
8
9
 * modify it under the terms of the GNU General Public License as
18
19
 * along with this program.  If not, see
19
20
 * <http://www.gnu.org/licenses/>.
20
21
 * 
21
 
 * Contact the authors at <https://www.fukt.bsnet.se/~belorn/> and
22
 
 * <https://www.fukt.bsnet.se/~teddy/>.
 
22
 * Contact the authors at <mandos@fukt.bsnet.se>.
23
23
 */
24
24
 
25
25
#define _GNU_SOURCE             /* getline() */
26
 
#define _FORTIFY_SOURCE 2
27
26
 
28
27
#include <termios.h>            /* struct termios, tcsetattr(),
29
28
                                   TCSAFLUSH, tcgetattr(), ECHO */
33
32
#include <signal.h>             /* sig_atomic_t, raise(), struct
34
33
                                   sigaction, sigemptyset(),
35
34
                                   sigaction(), sigaddset(), SIGINT,
36
 
                                   SIGQUIT, SIGHUP, SIGTERM */
37
 
#include <stddef.h>             /* NULL, size_t */
 
35
                                   SIGQUIT, SIGHUP, SIGTERM,
 
36
                                   raise() */
 
37
#include <stddef.h>             /* NULL, size_t, ssize_t */
38
38
#include <sys/types.h>          /* ssize_t */
39
39
#include <stdlib.h>             /* EXIT_SUCCESS, EXIT_FAILURE,
40
 
                                   getopt_long */
 
40
                                   getenv() */
41
41
#include <stdio.h>              /* fprintf(), stderr, getline(),
42
 
                                   stdin, feof(), perror(), fputc(),
43
 
                                   stdout, getopt_long */
44
 
#include <errno.h>              /* errno, EINVAL */
 
42
                                   stdin, feof(), perror(), fputc()
 
43
                                */
 
44
#include <errno.h>              /* errno, EBADF, ENOTTY, EINVAL,
 
45
                                   EFAULT, EFBIG, EIO, ENOSPC, EINTR
 
46
                                */
45
47
#include <iso646.h>             /* or, not */
46
48
#include <stdbool.h>            /* bool, false, true */
47
49
#include <string.h>             /* strlen, rindex, strncmp, strcmp */
48
 
#include <getopt.h>             /* getopt_long */
 
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 */
49
57
 
50
 
volatile bool quit_now = false;
 
58
volatile sig_atomic_t quit_now = 0;
 
59
int signal_received;
51
60
bool debug = false;
 
61
const char *argp_program_version = "password-prompt " VERSION;
 
62
const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";
52
63
 
53
 
void termination_handler(__attribute__((unused))int signum){
54
 
  quit_now = true;
 
64
static void termination_handler(int signum){
 
65
  if(quit_now){
 
66
    return;
 
67
  }
 
68
  quit_now = 1;
 
69
  signal_received = signum;
55
70
}
56
71
 
57
72
int main(int argc, char **argv){
64
79
  struct sigaction old_action,
65
80
    new_action = { .sa_handler = termination_handler,
66
81
                   .sa_flags = 0 };
67
 
 
68
 
  while (true){
69
 
    static struct option long_options[] = {
70
 
      {"debug", no_argument, (int *)&debug, 1},
71
 
      {"prefix", required_argument, 0, 'p'},
72
 
      {0, 0, 0, 0} };
73
 
 
74
 
    int option_index = 0;
75
 
    ret = getopt_long (argc, argv, "p:", long_options, &option_index);
76
 
 
77
 
    if (ret == -1){
78
 
      break;
 
82
  {
 
83
    struct argp_option options[] = {
 
84
      { .name = "prefix", .key = 'p',
 
85
        .arg = "PREFIX", .flags = 0,
 
86
        .doc = "Prefix shown before the prompt", .group = 2 },
 
87
      { .name = "debug", .key = 128,
 
88
        .doc = "Debug mode", .group = 3 },
 
89
      /*
 
90
       * These reproduce what we would get without ARGP_NO_HELP
 
91
       */
 
92
      { .name = "help", .key = '?',
 
93
        .doc = "Give this help list", .group = -1 },
 
94
      { .name = "usage", .key = -3,
 
95
        .doc = "Give a short usage message", .group = -1 },
 
96
      { .name = "version", .key = 'V',
 
97
        .doc = "Print program version", .group = -1 },
 
98
      { .name = NULL }
 
99
    };
 
100
    
 
101
    error_t parse_opt (int key, char *arg, struct argp_state *state){
 
102
      errno = 0;
 
103
      switch (key){
 
104
      case 'p':
 
105
        prefix = arg;
 
106
        break;
 
107
      case 128:
 
108
        debug = true;
 
109
        break;
 
110
        /*
 
111
         * These reproduce what we would get without ARGP_NO_HELP
 
112
         */
 
113
      case '?':                 /* --help */
 
114
        argp_state_help(state, state->out_stream,
 
115
                        (ARGP_HELP_STD_HELP | ARGP_HELP_EXIT_ERR)
 
116
                        & ~(unsigned int)ARGP_HELP_EXIT_OK);
 
117
      case -3:                  /* --usage */
 
118
        argp_state_help(state, state->out_stream,
 
119
                        ARGP_HELP_USAGE | ARGP_HELP_EXIT_ERR);
 
120
      case 'V':                 /* --version */
 
121
        fprintf(state->out_stream, "%s\n", argp_program_version);
 
122
        exit(argp_err_exit_status);
 
123
        break;
 
124
      default:
 
125
        return ARGP_ERR_UNKNOWN;
 
126
      }
 
127
      return errno;
79
128
    }
80
 
      
 
129
    
 
130
    struct argp argp = { .options = options, .parser = parse_opt,
 
131
                         .args_doc = "",
 
132
                         .doc = "Mandos password-prompt -- Read and"
 
133
                         " output a password" };
 
134
    ret = argp_parse(&argp, argc, argv,
 
135
                     ARGP_IN_ORDER | ARGP_NO_HELP, NULL, NULL);
81
136
    switch(ret){
82
137
    case 0:
83
138
      break;
84
 
    case 'p':
85
 
      prefix = optarg;
86
 
      break;
 
139
    case ENOMEM:
87
140
    default:
88
 
      fprintf(stderr, "bad arguments\n");
89
 
      exit(EXIT_FAILURE);
 
141
      errno = ret;
 
142
      perror("argp_parse");
 
143
      return EX_OSERR;
 
144
    case EINVAL:
 
145
      return EX_USAGE;
90
146
    }
91
147
  }
92
 
      
93
 
  if (debug){
 
148
  
 
149
  if(debug){
94
150
    fprintf(stderr, "Starting %s\n", argv[0]);
95
151
  }
96
 
  if (debug){
 
152
  if(debug){
97
153
    fprintf(stderr, "Storing current terminal attributes\n");
98
154
  }
99
155
  
100
 
  if (tcgetattr(STDIN_FILENO, &t_old) != 0){
101
 
    return EXIT_FAILURE;
 
156
  if(tcgetattr(STDIN_FILENO, &t_old) != 0){
 
157
    int e = errno;
 
158
    perror("tcgetattr");
 
159
    switch(e){
 
160
    case EBADF:
 
161
    case ENOTTY:
 
162
      return EX_UNAVAILABLE;
 
163
    default:
 
164
      return EX_OSERR;
 
165
    }
102
166
  }
103
167
  
104
168
  sigemptyset(&new_action.sa_mask);
105
 
  sigaddset(&new_action.sa_mask, SIGINT);
106
 
  sigaddset(&new_action.sa_mask, SIGQUIT);
107
 
  sigaddset(&new_action.sa_mask, SIGHUP);
108
 
  sigaddset(&new_action.sa_mask, SIGTERM);
109
 
  sigaction(SIGINT, NULL, &old_action);
110
 
  if (old_action.sa_handler != SIG_IGN)
111
 
    sigaction(SIGINT, &new_action, NULL);
112
 
  sigaction(SIGQUIT, NULL, &old_action);
113
 
  if (old_action.sa_handler != SIG_IGN)
114
 
    sigaction(SIGQUIT, &new_action, NULL);
115
 
  sigaction(SIGHUP, NULL, &old_action);
116
 
  if (old_action.sa_handler != SIG_IGN)
117
 
    sigaction(SIGHUP, &new_action, NULL);
118
 
  sigaction(SIGTERM, NULL, &old_action);
119
 
  if (old_action.sa_handler != SIG_IGN)
120
 
    sigaction(SIGTERM, &new_action, NULL);
121
 
 
122
 
  
123
 
  if (debug){
 
169
  ret = sigaddset(&new_action.sa_mask, SIGINT);
 
170
  if(ret == -1){
 
171
    perror("sigaddset");
 
172
    return EX_OSERR;
 
173
  }
 
174
  ret = sigaddset(&new_action.sa_mask, SIGHUP);
 
175
  if(ret == -1){
 
176
    perror("sigaddset");
 
177
    return EX_OSERR;
 
178
  }
 
179
  ret = sigaddset(&new_action.sa_mask, SIGTERM);
 
180
  if(ret == -1){
 
181
    perror("sigaddset");
 
182
    return EX_OSERR;
 
183
  }
 
184
  /* Need to check if the handler is SIG_IGN before handling:
 
185
     | [[info:libc:Initial Signal Actions]] |
 
186
     | [[info:libc:Basic Signal Handling]]  |
 
187
  */
 
188
  ret = sigaction(SIGINT, NULL, &old_action);
 
189
  if(ret == -1){
 
190
    perror("sigaction");
 
191
    return EX_OSERR;
 
192
  }
 
193
  if(old_action.sa_handler != SIG_IGN){
 
194
    ret = sigaction(SIGINT, &new_action, NULL);
 
195
    if(ret == -1){
 
196
      perror("sigaction");
 
197
      return EX_OSERR;
 
198
    }
 
199
  }
 
200
  ret = sigaction(SIGHUP, NULL, &old_action);
 
201
  if(ret == -1){
 
202
    perror("sigaction");
 
203
    return EX_OSERR;
 
204
  }
 
205
  if(old_action.sa_handler != SIG_IGN){
 
206
    ret = sigaction(SIGHUP, &new_action, NULL);
 
207
    if(ret == -1){
 
208
      perror("sigaction");
 
209
      return EX_OSERR;
 
210
    }
 
211
  }
 
212
  ret = sigaction(SIGTERM, NULL, &old_action);
 
213
  if(ret == -1){
 
214
    perror("sigaction");
 
215
    return EX_OSERR;
 
216
  }
 
217
  if(old_action.sa_handler != SIG_IGN){
 
218
    ret = sigaction(SIGTERM, &new_action, NULL);
 
219
    if(ret == -1){
 
220
      perror("sigaction");
 
221
      return EX_OSERR;
 
222
    }
 
223
  }
 
224
  
 
225
  
 
226
  if(debug){
124
227
    fprintf(stderr, "Removing echo flag from terminal attributes\n");
125
228
  }
126
229
  
127
230
  t_new = t_old;
128
 
  t_new.c_lflag &= ~ECHO;
129
 
  if (tcsetattr(STDIN_FILENO, TCSAFLUSH, &t_new) != 0){
 
231
  t_new.c_lflag &= ~(tcflag_t)ECHO;
 
232
  if(tcsetattr(STDIN_FILENO, TCSAFLUSH, &t_new) != 0){
 
233
    int e = errno;
130
234
    perror("tcsetattr-echo");
131
 
    return EXIT_FAILURE;
 
235
    switch(e){
 
236
    case EBADF:
 
237
    case ENOTTY:
 
238
      return EX_UNAVAILABLE;
 
239
    case EINVAL:
 
240
    default:
 
241
      return EX_OSERR;
 
242
    }
132
243
  }
133
 
 
134
 
  if (debug){
 
244
  
 
245
  if(debug){
135
246
    fprintf(stderr, "Waiting for input from stdin \n");
136
247
  }
137
248
  while(true){
138
 
    if (quit_now){
 
249
    if(quit_now){
 
250
      if(debug){
 
251
        fprintf(stderr, "Interrupted by signal, exiting.\n");
 
252
      }
139
253
      status = EXIT_FAILURE;
140
254
      break;
141
255
    }
142
256
 
143
257
    if(prefix){
144
 
      fprintf(stderr, "%s Password: ", prefix);
145
 
    } else {
146
 
      fprintf(stderr, "Password: ");
147
 
    }      
 
258
      fprintf(stderr, "%s ", prefix);
 
259
    }
 
260
    {
 
261
      const char *cryptsource = getenv("cryptsource");
 
262
      const char *crypttarget = getenv("crypttarget");
 
263
      const char *const prompt
 
264
        = "Enter passphrase to unlock the disk";
 
265
      if(cryptsource == NULL){
 
266
        if(crypttarget == NULL){
 
267
          fprintf(stderr, "%s: ", prompt);
 
268
        } else {
 
269
          fprintf(stderr, "%s (%s): ", prompt, crypttarget);
 
270
        }
 
271
      } else {
 
272
        if(crypttarget == NULL){
 
273
          fprintf(stderr, "%s %s: ", prompt, cryptsource);
 
274
        } else {
 
275
          fprintf(stderr, "%s %s (%s): ", prompt, cryptsource,
 
276
                  crypttarget);
 
277
        }
 
278
      }
 
279
    }
148
280
    ret = getline(&buffer, &n, stdin);
149
 
    if (ret > 0){
150
 
      fprintf(stdout, "%s", buffer);
 
281
    if(ret > 0){
151
282
      status = EXIT_SUCCESS;
 
283
      /* Make n = data size instead of allocated buffer size */
 
284
      n = (size_t)ret;
 
285
      /* Strip final newline */
 
286
      if(n > 0 and buffer[n-1] == '\n'){
 
287
        buffer[n-1] = '\0';     /* not strictly necessary */
 
288
        n--;
 
289
      }
 
290
      size_t written = 0;
 
291
      while(written < n){
 
292
        ret = write(STDOUT_FILENO, buffer + written, n - written);
 
293
        if(ret < 0){
 
294
          int e = errno;
 
295
          perror("write");
 
296
          switch(e){
 
297
          case EBADF:
 
298
          case EFAULT:
 
299
          case EINVAL:
 
300
          case EFBIG:
 
301
          case EIO:
 
302
          case ENOSPC:
 
303
          default:
 
304
            status = EX_IOERR;
 
305
            break;
 
306
          case EINTR:
 
307
            status = EXIT_FAILURE;
 
308
            break;
 
309
          }
 
310
          break;
 
311
        }
 
312
        written += (size_t)ret;
 
313
      }
 
314
      ret = close(STDOUT_FILENO);
 
315
      if(ret == -1){
 
316
        int e = errno;
 
317
        perror("close");
 
318
        switch(e){
 
319
        case EBADF:
 
320
          status = EX_OSFILE;
 
321
          break;
 
322
        case EIO:
 
323
        default:
 
324
          status = EX_IOERR;
 
325
          break;
 
326
        }
 
327
      }
152
328
      break;
153
329
    }
154
 
    // ret == 0 makes no other sence than to retry to read from stdin
155
 
    if (ret < 0){
156
 
      if (errno != EINTR and not feof(stdin)){
 
330
    if(ret < 0){
 
331
      int e = errno;
 
332
      if(errno != EINTR and not feof(stdin)){
157
333
        perror("getline");
158
 
        status = EXIT_FAILURE;
 
334
        switch(e){
 
335
        case EBADF:
 
336
          status = EX_UNAVAILABLE;
 
337
        case EIO:
 
338
        case EINVAL:
 
339
        default:
 
340
          status = EX_IOERR;
 
341
          break;
 
342
        }
159
343
        break;
160
344
      }
161
345
    }
 
346
    /* if(ret == 0), then the only sensible thing to do is to retry to
 
347
       read from stdin */
162
348
    fputc('\n', stderr);
 
349
    if(debug and not quit_now){
 
350
      /* If quit_now is nonzero, we were interrupted by a signal, and
 
351
         will print that later, so no need to show this too. */
 
352
      fprintf(stderr, "getline() returned 0, retrying.\n");
 
353
    }
163
354
  }
164
 
 
165
 
  if (debug){
 
355
  
 
356
  free(buffer);
 
357
  
 
358
  if(debug){
166
359
    fprintf(stderr, "Restoring terminal attributes\n");
167
360
  }
168
 
  if (tcsetattr(STDIN_FILENO, TCSAFLUSH, &t_old) != 0){
 
361
  if(tcsetattr(STDIN_FILENO, TCSAFLUSH, &t_old) != 0){
169
362
    perror("tcsetattr+echo");
170
363
  }
171
 
 
172
 
  if (debug){
173
 
    fprintf(stderr, "%s is exiting\n", argv[0]);
 
364
  
 
365
  if(quit_now){
 
366
    sigemptyset(&old_action.sa_mask);
 
367
    old_action.sa_handler = SIG_DFL;
 
368
    ret = sigaction(signal_received, &old_action, NULL);
 
369
    if(ret == -1){
 
370
      perror("sigaction");
 
371
    }
 
372
    raise(signal_received);
 
373
  }
 
374
  
 
375
  if(debug){
 
376
    fprintf(stderr, "%s is exiting with status %d\n", argv[0],
 
377
            status);
 
378
  }
 
379
  if(status == EXIT_SUCCESS or status == EX_OK){
 
380
    fputc('\n', stderr);
174
381
  }
175
382
  
176
383
  return status;