/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: 2008-08-29 05:53:59 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829055359-wkdasnyxtylmnxus
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
                        "&COMMANDNAME;".

* plugins.d/password-prompt.c (main): Improved some documentation
                                      strings.  Do perror() of
                                      tcgetattr() fails.  Add debug
                                      output if interrupted by signal.
                                      Loop over write() instead of
                                      using fwrite() when outputting
                                      password.  Add debug output if
                                      getline() returns 0, unless it
                                      was caused by a signal.  Add
                                      exit status code to debug
                                      output.

* plugins.d/password-prompt.xml: Changed all single quotes to double
                                 quotes for consistency.  Removed
                                 <?xml-stylesheet>.
  (ENTITY TIMESTAMP): New.  Automatically updated by Emacs time-stamp
                      by using Emacs local variables.
  (/refentry/refentryinfo/title): Changed to "Mandos Manual".
  (/refentry/refentryinfo/productname): Changed to "Mandos".
  (/refentry/refentryinfo/date): New; set to "&TIMESTAMP;".
  (/refentry/refentryinfo/copyright): Split copyright holders.
  (/refentry/refnamediv/refpurpose): Improved wording.
  (SYNOPSIS): Fix to use correct markup.  Add short options.
  (DESCRIPTION, OPTIONS): Improved wording.
  (OPTIONS): Improved wording.  Use more correct markup.  Document
             short options.
  (EXIT STATUS): Add text.
  (ENVIRONMENT): Document use of "cryptsource" and "crypttarget".
  (FILES): REMOVED.
  (BUGS): Add text.
  (EXAMPLE): Added some examples.
  (SECURITY): Added text.
  (SEE ALSO): Remove reference to mandos(8).  Add reference to
              crypttab(5).

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-prompt.c
 
1
/*  -*- coding: utf-8 -*- */
 
2
/*
 
3
 * Passprompt - Read a password from the terminal and print it
 
4
 *
 
5
 * Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
 
6
 * 
 
7
 * This program is free software: you can redistribute it and/or
 
8
 * modify it under the terms of the GNU General Public License as
 
9
 * published by the Free Software Foundation, either version 3 of the
 
10
 * License, or (at your option) any later version.
 
11
 * 
 
12
 * This program is distributed in the hope that it will be useful, but
 
13
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 
14
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
15
 * General Public License for more details.
 
16
 * 
 
17
 * You should have received a copy of the GNU General Public License
 
18
 * along with this program.  If not, see
 
19
 * <http://www.gnu.org/licenses/>.
 
20
 * 
 
21
 * Contact the authors at <https://www.fukt.bsnet.se/~belorn/> and
 
22
 * <https://www.fukt.bsnet.se/~teddy/>.
 
23
 */
 
24
 
 
25
#define _GNU_SOURCE             /* getline() */
 
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 */
 
32
#include <signal.h>             /* sig_atomic_t, raise(), struct
 
33
                                   sigaction, sigemptyset(),
 
34
                                   sigaction(), sigaddset(), SIGINT,
 
35
                                   SIGQUIT, SIGHUP, SIGTERM */
 
36
#include <stddef.h>             /* NULL, size_t, ssize_t */
 
37
#include <sys/types.h>          /* ssize_t */
 
38
#include <stdlib.h>             /* EXIT_SUCCESS, EXIT_FAILURE,
 
39
                                   getopt_long, getenv() */
 
40
#include <stdio.h>              /* fprintf(), stderr, getline(),
 
41
                                   stdin, feof(), perror(), fputc(),
 
42
                                   stdout, getopt_long */
 
43
#include <errno.h>              /* errno, EINVAL */
 
44
#include <iso646.h>             /* or, not */
 
45
#include <stdbool.h>            /* bool, false, true */
 
46
#include <string.h>             /* strlen, rindex, strncmp, strcmp */
 
47
#include <argp.h>               /* struct argp_option, struct
 
48
                                   argp_state, struct argp,
 
49
                                   argp_parse(), error_t,
 
50
                                   ARGP_KEY_ARG, ARGP_KEY_END,
 
51
                                   ARGP_ERR_UNKNOWN */
 
52
 
 
53
volatile bool quit_now = false;
 
54
bool debug = false;
 
55
const char *argp_program_version = "password-prompt 1.0";
 
56
const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";
 
57
 
 
58
static void termination_handler(__attribute__((unused))int signum){
 
59
  quit_now = true;
 
60
}
 
61
 
 
62
int main(int argc, char **argv){
 
63
  ssize_t ret;
 
64
  size_t n;
 
65
  struct termios t_new, t_old;
 
66
  char *buffer = NULL;
 
67
  char *prefix = NULL;
 
68
  int status = EXIT_SUCCESS;
 
69
  struct sigaction old_action,
 
70
    new_action = { .sa_handler = termination_handler,
 
71
                   .sa_flags = 0 };
 
72
  {
 
73
    struct argp_option options[] = {
 
74
      { .name = "prefix", .key = 'p',
 
75
        .arg = "PREFIX", .flags = 0,
 
76
        .doc = "Prefix shown before the prompt", .group = 2 },
 
77
      { .name = "debug", .key = 128,
 
78
        .doc = "Debug mode", .group = 3 },
 
79
      { .name = NULL }
 
80
    };
 
81
  
 
82
    error_t parse_opt (int key, char *arg, struct argp_state *state) {
 
83
      /* Get the INPUT argument from `argp_parse', which we know is a
 
84
         pointer to our plugin list pointer. */
 
85
      switch (key) {
 
86
      case 'p':
 
87
        prefix = arg;
 
88
        break;
 
89
      case 128:
 
90
        debug = true;
 
91
        break;
 
92
      case ARGP_KEY_ARG:
 
93
        argp_usage (state);
 
94
        break;
 
95
      case ARGP_KEY_END:
 
96
        break;
 
97
      default:
 
98
        return ARGP_ERR_UNKNOWN;
 
99
      }
 
100
      return 0;
 
101
    }
 
102
  
 
103
    struct argp argp = { .options = options, .parser = parse_opt,
 
104
                         .args_doc = "",
 
105
                         .doc = "Mandos password-prompt -- Read and"
 
106
                         " output a password" };
 
107
    ret = argp_parse (&argp, argc, argv, 0, 0, NULL);
 
108
    if (ret == ARGP_ERR_UNKNOWN){
 
109
      fprintf(stderr, "Unknown error while parsing arguments\n");
 
110
      return EXIT_FAILURE;
 
111
    }
 
112
  }
 
113
    
 
114
  if (debug){
 
115
    fprintf(stderr, "Starting %s\n", argv[0]);
 
116
  }
 
117
  if (debug){
 
118
    fprintf(stderr, "Storing current terminal attributes\n");
 
119
  }
 
120
  
 
121
  if (tcgetattr(STDIN_FILENO, &t_old) != 0){
 
122
    perror("tcgetattr");
 
123
    return EXIT_FAILURE;
 
124
  }
 
125
  
 
126
  sigemptyset(&new_action.sa_mask);
 
127
  sigaddset(&new_action.sa_mask, SIGINT);
 
128
  sigaddset(&new_action.sa_mask, SIGHUP);
 
129
  sigaddset(&new_action.sa_mask, SIGTERM);
 
130
  ret = sigaction(SIGINT, NULL, &old_action);
 
131
  if(ret == -1){
 
132
    perror("sigaction");
 
133
    return EXIT_FAILURE;
 
134
  }
 
135
  if (old_action.sa_handler != SIG_IGN){
 
136
    ret = sigaction(SIGINT, &new_action, NULL);
 
137
    if(ret == -1){
 
138
      perror("sigaction");
 
139
      return EXIT_FAILURE;
 
140
    }
 
141
  }
 
142
  ret = sigaction(SIGHUP, NULL, &old_action);
 
143
  if(ret == -1){
 
144
    perror("sigaction");
 
145
    return EXIT_FAILURE;
 
146
  }
 
147
  if (old_action.sa_handler != SIG_IGN){
 
148
    ret = sigaction(SIGHUP, &new_action, NULL);
 
149
    if(ret == -1){
 
150
      perror("sigaction");
 
151
      return EXIT_FAILURE;
 
152
    }
 
153
  }
 
154
  ret = sigaction(SIGTERM, NULL, &old_action);
 
155
  if(ret == -1){
 
156
    perror("sigaction");
 
157
    return EXIT_FAILURE;
 
158
  }
 
159
  if (old_action.sa_handler != SIG_IGN){
 
160
    ret = sigaction(SIGTERM, &new_action, NULL);
 
161
    if(ret == -1){
 
162
      perror("sigaction");
 
163
      return EXIT_FAILURE;
 
164
    }
 
165
  }
 
166
  
 
167
  
 
168
  if (debug){
 
169
    fprintf(stderr, "Removing echo flag from terminal attributes\n");
 
170
  }
 
171
  
 
172
  t_new = t_old;
 
173
  t_new.c_lflag &= ~ECHO;
 
174
  if (tcsetattr(STDIN_FILENO, TCSAFLUSH, &t_new) != 0){
 
175
    perror("tcsetattr-echo");
 
176
    return EXIT_FAILURE;
 
177
  }
 
178
 
 
179
  if (debug){
 
180
    fprintf(stderr, "Waiting for input from stdin \n");
 
181
  }
 
182
  while(true){
 
183
    if (quit_now){
 
184
      if(debug){
 
185
        fprintf(stderr, "Interrupted by signal, exiting.\n");
 
186
      }
 
187
      status = EXIT_FAILURE;
 
188
      break;
 
189
    }
 
190
 
 
191
    if(prefix){
 
192
      fprintf(stderr, "%s ", prefix);
 
193
    }
 
194
    {
 
195
      const char *cryptsource = getenv("cryptsource");
 
196
      const char *crypttarget = getenv("crypttarget");
 
197
      const char *const prompt
 
198
        = "Enter passphrase to unlock the disk";
 
199
      if(cryptsource == NULL){
 
200
        if(crypttarget == NULL){
 
201
          fprintf(stderr, "%s: ", prompt);
 
202
        } else {
 
203
          fprintf(stderr, "%s (%s): ", prompt, crypttarget);
 
204
        }
 
205
      } else {
 
206
        if(crypttarget == NULL){
 
207
          fprintf(stderr, "%s %s: ", prompt, cryptsource);
 
208
        } else {
 
209
          fprintf(stderr, "%s %s (%s): ", prompt, cryptsource,
 
210
                  crypttarget);
 
211
        }
 
212
      }
 
213
    }
 
214
    ret = getline(&buffer, &n, stdin);
 
215
    if (ret > 0){
 
216
      status = EXIT_SUCCESS;
 
217
      /* Make n = data size instead of allocated buffer size */
 
218
      n = (size_t)ret;
 
219
      size_t written = 0;
 
220
      while(written < n){
 
221
        ret = write(STDOUT_FILENO, buffer + written, n - written);
 
222
        if(ret < 0){
 
223
          perror("write");
 
224
          status = EXIT_FAILURE;
 
225
          break;
 
226
        }
 
227
        written += (size_t)ret;
 
228
      }
 
229
      break;
 
230
    }
 
231
    if (ret < 0){
 
232
      if (errno != EINTR and not feof(stdin)){
 
233
        perror("getline");
 
234
        status = EXIT_FAILURE;
 
235
        break;
 
236
      }
 
237
    }
 
238
    /* if(ret == 0), then the only sensible thing to do is to retry to
 
239
       read from stdin */
 
240
    fputc('\n', stderr);
 
241
    if(debug and not quit_now){
 
242
      /* If quit_now is true, we were interrupted by a signal, and
 
243
         will print that later, so no need to show this too. */
 
244
      fprintf(stderr, "getline() returned 0, retrying.\n");
 
245
    }
 
246
  }
 
247
  
 
248
  if (debug){
 
249
    fprintf(stderr, "Restoring terminal attributes\n");
 
250
  }
 
251
  if (tcsetattr(STDIN_FILENO, TCSAFLUSH, &t_old) != 0){
 
252
    perror("tcsetattr+echo");
 
253
  }
 
254
  
 
255
  if (debug){
 
256
    fprintf(stderr, "%s is exiting with status %d\n", argv[0],
 
257
            status);
 
258
  }
 
259
  
 
260
  return status;
 
261
}