/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

* mandos: Fixed "--help" output.
* mandos.xml (SYNOPSIS, OPTIONS): Document new option "--debuglevel".

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