/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
3
 * Password-prompt - Read a password from the terminal and print it
4
4
 * 
19
19
 * along with this program.  If not, see
20
20
 * <http://www.gnu.org/licenses/>.
21
21
 * 
22
 
 * Contact the authors at <https://www.fukt.bsnet.se/~belorn/> and
23
 
 * <https://www.fukt.bsnet.se/~teddy/>.
 
22
 * Contact the authors at <mandos@fukt.bsnet.se>.
24
23
 */
25
24
 
26
25
#define _GNU_SOURCE             /* getline() */
33
32
#include <signal.h>             /* sig_atomic_t, raise(), struct
34
33
                                   sigaction, sigemptyset(),
35
34
                                   sigaction(), sigaddset(), SIGINT,
36
 
                                   SIGQUIT, SIGHUP, SIGTERM */
 
35
                                   SIGQUIT, SIGHUP, SIGTERM,
 
36
                                   raise() */
37
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, getenv() */
 
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 */
50
52
                                   argp_parse(), error_t,
51
53
                                   ARGP_KEY_ARG, ARGP_KEY_END,
52
54
                                   ARGP_ERR_UNKNOWN */
 
55
#include <sysexits.h>           /* EX_SOFTWARE, EX_OSERR,
 
56
                                   EX_UNAVAILABLE, EX_IOERR, EX_OK */
53
57
 
54
58
volatile sig_atomic_t quit_now = 0;
 
59
int signal_received;
55
60
bool debug = false;
56
61
const char *argp_program_version = "password-prompt " VERSION;
57
62
const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";
58
63
 
59
 
static void termination_handler(__attribute__((unused))int signum){
 
64
static void termination_handler(int signum){
 
65
  if(quit_now){
 
66
    return;
 
67
  }
60
68
  quit_now = 1;
 
69
  signal_received = signum;
61
70
}
62
71
 
63
72
int main(int argc, char **argv){
77
86
        .doc = "Prefix shown before the prompt", .group = 2 },
78
87
      { .name = "debug", .key = 128,
79
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 },
80
98
      { .name = NULL }
81
99
    };
82
100
    
83
101
    error_t parse_opt (int key, char *arg, struct argp_state *state){
 
102
      errno = 0;
84
103
      switch (key){
85
104
      case 'p':
86
105
        prefix = arg;
88
107
      case 128:
89
108
        debug = true;
90
109
        break;
91
 
      case ARGP_KEY_ARG:
92
 
        argp_usage(state);
93
 
        break;
94
 
      case ARGP_KEY_END:
 
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);
95
123
        break;
96
124
      default:
97
125
        return ARGP_ERR_UNKNOWN;
98
126
      }
99
 
      return 0;
 
127
      return errno;
100
128
    }
101
129
    
102
130
    struct argp argp = { .options = options, .parser = parse_opt,
103
131
                         .args_doc = "",
104
132
                         .doc = "Mandos password-prompt -- Read and"
105
133
                         " output a password" };
106
 
    ret = argp_parse(&argp, argc, argv, 0, 0, NULL);
107
 
    if(ret == ARGP_ERR_UNKNOWN){
108
 
      fprintf(stderr, "Unknown error while parsing arguments\n");
109
 
      return EXIT_FAILURE;
 
134
    ret = argp_parse(&argp, argc, argv,
 
135
                     ARGP_IN_ORDER | ARGP_NO_HELP, NULL, NULL);
 
136
    switch(ret){
 
137
    case 0:
 
138
      break;
 
139
    case ENOMEM:
 
140
    default:
 
141
      errno = ret;
 
142
      perror("argp_parse");
 
143
      return EX_OSERR;
 
144
    case EINVAL:
 
145
      return EX_USAGE;
110
146
    }
111
147
  }
112
148
  
118
154
  }
119
155
  
120
156
  if(tcgetattr(STDIN_FILENO, &t_old) != 0){
 
157
    int e = errno;
121
158
    perror("tcgetattr");
122
 
    return EXIT_FAILURE;
 
159
    switch(e){
 
160
    case EBADF:
 
161
    case ENOTTY:
 
162
      return EX_UNAVAILABLE;
 
163
    default:
 
164
      return EX_OSERR;
 
165
    }
123
166
  }
124
167
  
125
168
  sigemptyset(&new_action.sa_mask);
126
 
  sigaddset(&new_action.sa_mask, SIGINT);
127
 
  sigaddset(&new_action.sa_mask, SIGHUP);
128
 
  sigaddset(&new_action.sa_mask, SIGTERM);
 
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
  */
129
188
  ret = sigaction(SIGINT, NULL, &old_action);
130
189
  if(ret == -1){
131
190
    perror("sigaction");
132
 
    return EXIT_FAILURE;
 
191
    return EX_OSERR;
133
192
  }
134
193
  if(old_action.sa_handler != SIG_IGN){
135
194
    ret = sigaction(SIGINT, &new_action, NULL);
136
195
    if(ret == -1){
137
196
      perror("sigaction");
138
 
      return EXIT_FAILURE;
 
197
      return EX_OSERR;
139
198
    }
140
199
  }
141
200
  ret = sigaction(SIGHUP, NULL, &old_action);
142
201
  if(ret == -1){
143
202
    perror("sigaction");
144
 
    return EXIT_FAILURE;
 
203
    return EX_OSERR;
145
204
  }
146
205
  if(old_action.sa_handler != SIG_IGN){
147
206
    ret = sigaction(SIGHUP, &new_action, NULL);
148
207
    if(ret == -1){
149
208
      perror("sigaction");
150
 
      return EXIT_FAILURE;
 
209
      return EX_OSERR;
151
210
    }
152
211
  }
153
212
  ret = sigaction(SIGTERM, NULL, &old_action);
154
213
  if(ret == -1){
155
214
    perror("sigaction");
156
 
    return EXIT_FAILURE;
 
215
    return EX_OSERR;
157
216
  }
158
217
  if(old_action.sa_handler != SIG_IGN){
159
218
    ret = sigaction(SIGTERM, &new_action, NULL);
160
219
    if(ret == -1){
161
220
      perror("sigaction");
162
 
      return EXIT_FAILURE;
 
221
      return EX_OSERR;
163
222
    }
164
223
  }
165
224
  
169
228
  }
170
229
  
171
230
  t_new = t_old;
172
 
  t_new.c_lflag &= ~ECHO;
 
231
  t_new.c_lflag &= ~(tcflag_t)ECHO;
173
232
  if(tcsetattr(STDIN_FILENO, TCSAFLUSH, &t_new) != 0){
 
233
    int e = errno;
174
234
    perror("tcsetattr-echo");
175
 
    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
    }
176
243
  }
177
 
 
 
244
  
178
245
  if(debug){
179
246
    fprintf(stderr, "Waiting for input from stdin \n");
180
247
  }
194
261
      const char *cryptsource = getenv("cryptsource");
195
262
      const char *crypttarget = getenv("crypttarget");
196
263
      const char *const prompt
197
 
        = "Enter passphrase to unlock the disk";      
 
264
        = "Enter passphrase to unlock the disk";
198
265
      if(cryptsource == NULL){
199
266
        if(crypttarget == NULL){
200
267
          fprintf(stderr, "%s: ", prompt);
216
283
      /* Make n = data size instead of allocated buffer size */
217
284
      n = (size_t)ret;
218
285
      /* Strip final newline */
219
 
      if(n>0 and buffer[n-1] == '\n'){
 
286
      if(n > 0 and buffer[n-1] == '\n'){
220
287
        buffer[n-1] = '\0';     /* not strictly necessary */
221
288
        n--;
222
289
      }
224
291
      while(written < n){
225
292
        ret = write(STDOUT_FILENO, buffer + written, n - written);
226
293
        if(ret < 0){
 
294
          int e = errno;
227
295
          perror("write");
228
 
          status = EXIT_FAILURE;
 
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
          }
229
310
          break;
230
311
        }
231
312
        written += (size_t)ret;
232
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
      }
233
328
      break;
234
329
    }
235
330
    if(ret < 0){
 
331
      int e = errno;
236
332
      if(errno != EINTR and not feof(stdin)){
237
333
        perror("getline");
238
 
        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
        }
239
343
        break;
240
344
      }
241
345
    }
242
346
    /* if(ret == 0), then the only sensible thing to do is to retry to
243
347
       read from stdin */
244
348
    fputc('\n', stderr);
245
 
    if(debug and quit_now == 0){
 
349
    if(debug and not quit_now){
246
350
      /* If quit_now is nonzero, we were interrupted by a signal, and
247
351
         will print that later, so no need to show this too. */
248
352
      fprintf(stderr, "getline() returned 0, retrying.\n");
258
362
    perror("tcsetattr+echo");
259
363
  }
260
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
  
261
375
  if(debug){
262
376
    fprintf(stderr, "%s is exiting with status %d\n", argv[0],
263
377
            status);
264
378
  }
265
 
  if(status == EXIT_SUCCESS){
 
379
  if(status == EXIT_SUCCESS or status == EX_OK){
266
380
    fputc('\n', stderr);
267
381
  }
268
382