/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/splashy.c

  • Committer: Teddy Hogeborn
  • Date: 2019-07-29 16:35:53 UTC
  • mto: This revision was merged to the branch mainline in revision 384.
  • Revision ID: teddy@recompile.se-20190729163553-1i442i2cbx64c537
Make tests and man page examples match

Make the tests test_manual_page_example[1-5] match exactly what is
written in the manual page, and add comments to manual page as
reminders to keep tests and manual page examples in sync.

* mandos-ctl (Test_commands_from_options.test_manual_page_example_1):
  Remove "--verbose" option, since the manual does not have it as the
  first example, and change assertion to match.
* mandos-ctl.xml (EXAMPLE): Add comments to all examples documenting
  which test function they correspond to.  Also remove unnecessary
  quotes from option arguments in fourth example, and clarify language
  slightly in fifth example.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/splashy.c
2
2
/*
3
3
 * Splashy - Read a password from splashy and output it
4
4
 * 
5
 
 * Copyright © 2008,2009 Teddy Hogeborn
6
 
 * Copyright © 2008,2009 Björn Påhlsson
7
 
 * 
8
 
 * This program is free software: you can redistribute it and/or
9
 
 * modify it under the terms of the GNU General Public License as
10
 
 * published by the Free Software Foundation, either version 3 of the
11
 
 * License, or (at your option) any later version.
12
 
 * 
13
 
 * This program is distributed in the hope that it will be useful, but
 
5
 * Copyright © 2008-2018 Teddy Hogeborn
 
6
 * Copyright © 2008-2018 Björn Påhlsson
 
7
 * 
 
8
 * This file is part of Mandos.
 
9
 * 
 
10
 * Mandos is free software: you can redistribute it and/or modify it
 
11
 * under the terms of the GNU General Public License as published by
 
12
 * the Free Software Foundation, either version 3 of the License, or
 
13
 * (at your option) any later version.
 
14
 * 
 
15
 * Mandos is distributed in the hope that it will be useful, but
14
16
 * WITHOUT ANY WARRANTY; without even the implied warranty of
15
17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16
18
 * General Public License for more details.
17
19
 * 
18
20
 * You should have received a copy of the GNU General Public License
19
 
 * along with this program.  If not, see
20
 
 * <http://www.gnu.org/licenses/>.
 
21
 * along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
21
22
 * 
22
 
 * Contact the authors at <https://www.fukt.bsnet.se/~belorn/> and
23
 
 * <https://www.fukt.bsnet.se/~teddy/>.
 
23
 * Contact the authors at <mandos@recompile.se>.
24
24
 */
25
25
 
26
 
#define _GNU_SOURCE             /* asprintf() */
 
26
#define _GNU_SOURCE             /* TEMP_FAILURE_RETRY(), asprintf() */
27
27
#include <signal.h>             /* sig_atomic_t, struct sigaction,
28
28
                                   sigemptyset(), sigaddset(), SIGINT,
29
29
                                   SIGHUP, SIGTERM, sigaction,
30
30
                                   SIG_IGN, kill(), SIGKILL */
31
31
#include <stddef.h>             /* NULL */
32
32
#include <stdlib.h>             /* getenv() */
33
 
#include <stdio.h>              /* asprintf(), perror() */
 
33
#include <stdio.h>              /* asprintf(), vasprintf(), vprintf(),
 
34
                                   fprintf() */
34
35
#include <stdlib.h>             /* EXIT_FAILURE, free(),
35
36
                                   EXIT_SUCCESS */
36
37
#include <sys/types.h>          /* pid_t, DIR, struct dirent,
41
42
#include <iso646.h>             /* not, or, and */
42
43
#include <unistd.h>             /* readlink(), fork(), execl(),
43
44
                                   sleep(), dup2() STDERR_FILENO,
44
 
                                   STDOUT_FILENO, _exit() */
45
 
#include <string.h>             /* memcmp() */
46
 
#include <errno.h>              /* errno */
 
45
                                   STDOUT_FILENO, _exit(),
 
46
                                   pause() */
 
47
#include <string.h>             /* memcmp(), strerror() */
 
48
#include <errno.h>              /* errno, EACCES, ENOTDIR, ELOOP,
 
49
                                   ENOENT, ENAMETOOLONG, EMFILE,
 
50
                                   ENFILE, ENOMEM, ENOEXEC, EINVAL,
 
51
                                   E2BIG, EFAULT, EIO, ETXTBSY,
 
52
                                   EISDIR, ELIBBAD, EPERM, EINTR,
 
53
                                   ECHILD */
 
54
#include <error.h>              /* error() */
47
55
#include <sys/wait.h>           /* waitpid(), WIFEXITED(),
48
56
                                   WEXITSTATUS() */
 
57
#include <sysexits.h>           /* EX_OSERR, EX_OSFILE,
 
58
                                   EX_UNAVAILABLE */
 
59
#include <stdarg.h>             /* va_list, va_start(), ... */
49
60
 
50
61
sig_atomic_t interrupted_by_signal = 0;
51
62
int signal_received;
52
63
 
 
64
/* Function to use when printing errors */
 
65
__attribute__((format (gnu_printf, 3, 4)))
 
66
void error_plus(int status, int errnum, const char *formatstring,
 
67
                ...){
 
68
  va_list ap;
 
69
  char *text;
 
70
  int ret;
 
71
  
 
72
  va_start(ap, formatstring);
 
73
  ret = vasprintf(&text, formatstring, ap);
 
74
  if(ret == -1){
 
75
    fprintf(stderr, "Mandos plugin %s: ",
 
76
            program_invocation_short_name);
 
77
    vfprintf(stderr, formatstring, ap);
 
78
    fprintf(stderr, ": ");
 
79
    fprintf(stderr, "%s\n", strerror(errnum));
 
80
    error(status, errno, "vasprintf while printing error");
 
81
    return;
 
82
  }
 
83
  fprintf(stderr, "Mandos plugin ");
 
84
  error(status, errnum, "%s", text);
 
85
  free(text);
 
86
}
 
87
 
 
88
 
53
89
static void termination_handler(int signum){
54
90
  if(interrupted_by_signal){
55
91
    return;
61
97
int main(__attribute__((unused))int argc,
62
98
         __attribute__((unused))char **argv){
63
99
  int ret = 0;
 
100
  char *prompt = NULL;
 
101
  DIR *proc_dir = NULL;
 
102
  pid_t splashy_pid = 0;
 
103
  pid_t splashy_command_pid = 0;
 
104
  int exitstatus = EXIT_FAILURE;
64
105
  
65
106
  /* Create prompt string */
66
 
  char *prompt = NULL;
67
107
  {
68
108
    const char *const cryptsource = getenv("cryptsource");
69
109
    const char *const crypttarget = getenv("crypttarget");
86
126
      }
87
127
    }
88
128
    if(ret == -1){
89
 
      return EXIT_FAILURE;
 
129
      prompt = NULL;
 
130
      exitstatus = EX_OSERR;
 
131
      goto failure;
90
132
    }
91
133
  }
92
134
  
93
135
  /* Find splashy process */
94
 
  pid_t splashy_pid = 0;
95
136
  {
96
137
    const char splashy_name[] = "/sbin/splashy";
97
 
    DIR *proc_dir = opendir("/proc");
 
138
    proc_dir = opendir("/proc");
98
139
    if(proc_dir == NULL){
99
 
      free(prompt);
100
 
      perror("opendir");
101
 
      return EXIT_FAILURE;
 
140
      int e = errno;
 
141
      error_plus(0, errno, "opendir");
 
142
      switch(e){
 
143
      case EACCES:
 
144
      case ENOTDIR:
 
145
      case ELOOP:
 
146
      case ENOENT:
 
147
      default:
 
148
        exitstatus = EX_OSFILE;
 
149
        break;
 
150
      case ENAMETOOLONG:
 
151
      case EMFILE:
 
152
      case ENFILE:
 
153
      case ENOMEM:
 
154
        exitstatus = EX_OSERR;
 
155
        break;
 
156
      }
 
157
      goto failure;
102
158
    }
103
159
    for(struct dirent *proc_ent = readdir(proc_dir);
104
160
        proc_ent != NULL;
124
180
        char *exe_link;
125
181
        ret = asprintf(&exe_link, "/proc/%s/exe", proc_ent->d_name);
126
182
        if(ret == -1){
127
 
          perror("asprintf");
128
 
          free(prompt);
129
 
          closedir(proc_dir);
130
 
          return EXIT_FAILURE;
 
183
          error_plus(0, errno, "asprintf");
 
184
          exitstatus = EX_OSERR;
 
185
          goto failure;
131
186
        }
132
187
        
133
188
        /* Check that it refers to a symlink owned by root:root */
138
193
            free(exe_link);
139
194
            continue;
140
195
          }
141
 
          perror("lstat");
 
196
          int e = errno;
 
197
          error_plus(0, errno, "lstat");
142
198
          free(exe_link);
143
 
          free(prompt);
144
 
          closedir(proc_dir);
145
 
          return EXIT_FAILURE;
 
199
          switch(e){
 
200
          case EACCES:
 
201
          case ENOTDIR:
 
202
          case ELOOP:
 
203
          default:
 
204
            exitstatus = EX_OSFILE;
 
205
            break;
 
206
          case ENAMETOOLONG:
 
207
            exitstatus = EX_OSERR;
 
208
            break;
 
209
          }
 
210
          goto failure;
146
211
        }
147
212
        if(not S_ISLNK(exe_stat.st_mode)
148
213
           or exe_stat.st_uid != 0
162
227
      }
163
228
    }
164
229
    closedir(proc_dir);
 
230
    proc_dir = NULL;
165
231
  }
166
232
  if(splashy_pid == 0){
167
 
    free(prompt);
168
 
    return EXIT_FAILURE;
 
233
    exitstatus = EX_UNAVAILABLE;
 
234
    goto failure;
169
235
  }
170
236
  
171
237
  /* Set up the signal handler */
174
240
      new_action = { .sa_handler = termination_handler,
175
241
                     .sa_flags = 0 };
176
242
    sigemptyset(&new_action.sa_mask);
177
 
    sigaddset(&new_action.sa_mask, SIGINT);
178
 
    if(ret == -1){
179
 
      perror("sigaddset");
180
 
      free(prompt);
181
 
      return EXIT_FAILURE;
182
 
    }
183
 
    sigaddset(&new_action.sa_mask, SIGHUP);
184
 
    if(ret == -1){
185
 
      perror("sigaddset");
186
 
      free(prompt);
187
 
      return EXIT_FAILURE;
188
 
    }
189
 
    sigaddset(&new_action.sa_mask, SIGTERM);
190
 
    if(ret == -1){
191
 
      perror("sigaddset");
192
 
      free(prompt);
193
 
      return EXIT_FAILURE;
 
243
    ret = sigaddset(&new_action.sa_mask, SIGINT);
 
244
    if(ret == -1){
 
245
      error_plus(0, errno, "sigaddset");
 
246
      exitstatus = EX_OSERR;
 
247
      goto failure;
 
248
    }
 
249
    ret = sigaddset(&new_action.sa_mask, SIGHUP);
 
250
    if(ret == -1){
 
251
      error_plus(0, errno, "sigaddset");
 
252
      exitstatus = EX_OSERR;
 
253
      goto failure;
 
254
    }
 
255
    ret = sigaddset(&new_action.sa_mask, SIGTERM);
 
256
    if(ret == -1){
 
257
      error_plus(0, errno, "sigaddset");
 
258
      exitstatus = EX_OSERR;
 
259
      goto failure;
194
260
    }
195
261
    ret = sigaction(SIGINT, NULL, &old_action);
196
262
    if(ret == -1){
197
 
      perror("sigaction");
198
 
      free(prompt);
199
 
      return EXIT_FAILURE;
 
263
      error_plus(0, errno, "sigaction");
 
264
      exitstatus = EX_OSERR;
 
265
      goto failure;
200
266
    }
201
267
    if(old_action.sa_handler != SIG_IGN){
202
268
      ret = sigaction(SIGINT, &new_action, NULL);
203
269
      if(ret == -1){
204
 
        perror("sigaction");
205
 
        free(prompt);
206
 
        return EXIT_FAILURE;
 
270
        error_plus(0, errno, "sigaction");
 
271
        exitstatus = EX_OSERR;
 
272
        goto failure;
207
273
      }
208
274
    }
209
275
    ret = sigaction(SIGHUP, NULL, &old_action);
210
276
    if(ret == -1){
211
 
      perror("sigaction");
212
 
      free(prompt);
213
 
      return EXIT_FAILURE;
 
277
      error_plus(0, errno, "sigaction");
 
278
      exitstatus = EX_OSERR;
 
279
      goto failure;
214
280
    }
215
281
    if(old_action.sa_handler != SIG_IGN){
216
282
      ret = sigaction(SIGHUP, &new_action, NULL);
217
283
      if(ret == -1){
218
 
        perror("sigaction");
219
 
        free(prompt);
220
 
        return EXIT_FAILURE;
 
284
        error_plus(0, errno, "sigaction");
 
285
        exitstatus = EX_OSERR;
 
286
        goto failure;
221
287
      }
222
288
    }
223
289
    ret = sigaction(SIGTERM, NULL, &old_action);
224
290
    if(ret == -1){
225
 
      perror("sigaction");
226
 
      free(prompt);
227
 
      return EXIT_FAILURE;
 
291
      error_plus(0, errno, "sigaction");
 
292
      exitstatus = EX_OSERR;
 
293
      goto failure;
228
294
    }
229
295
    if(old_action.sa_handler != SIG_IGN){
230
296
      ret = sigaction(SIGTERM, &new_action, NULL);
231
297
      if(ret == -1){
232
 
        perror("sigaction");
233
 
        free(prompt);
234
 
        return EXIT_FAILURE;
 
298
        error_plus(0, errno, "sigaction");
 
299
        exitstatus = EX_OSERR;
 
300
        goto failure;
235
301
      }
236
302
    }
237
303
  }
238
304
  
 
305
  if(interrupted_by_signal){
 
306
    goto failure;
 
307
  }
 
308
  
239
309
  /* Fork off the splashy command to prompt for password */
240
 
  pid_t splashy_command_pid = 0;
241
 
  if(not interrupted_by_signal){
242
 
    splashy_command_pid = fork();
243
 
    if(splashy_command_pid == -1){
244
 
      if(not interrupted_by_signal){
245
 
        perror("fork");
246
 
      }
247
 
      return EXIT_FAILURE;
248
 
    }
249
 
    /* Child */
250
 
    if(splashy_command_pid == 0){
 
310
  splashy_command_pid = fork();
 
311
  if(splashy_command_pid != 0 and interrupted_by_signal){
 
312
    goto failure;
 
313
  }
 
314
  if(splashy_command_pid == -1){
 
315
    error_plus(0, errno, "fork");
 
316
    exitstatus = EX_OSERR;
 
317
    goto failure;
 
318
  }
 
319
  /* Child */
 
320
  if(splashy_command_pid == 0){
 
321
    if(not interrupted_by_signal){
251
322
      const char splashy_command[] = "/sbin/splashy_update";
252
 
      ret = execl(splashy_command, splashy_command, prompt,
253
 
                  (char *)NULL);
254
 
      if(not interrupted_by_signal){
255
 
        perror("execl");
 
323
      execl(splashy_command, splashy_command, prompt, (char *)NULL);
 
324
      int e = errno;
 
325
      error_plus(0, errno, "execl");
 
326
      switch(e){
 
327
      case EACCES:
 
328
      case ENOENT:
 
329
      case ENOEXEC:
 
330
      case EINVAL:
 
331
        _exit(EX_UNAVAILABLE);
 
332
      case ENAMETOOLONG:
 
333
      case E2BIG:
 
334
      case ENOMEM:
 
335
      case EFAULT:
 
336
      case EIO:
 
337
      case EMFILE:
 
338
      case ENFILE:
 
339
      case ETXTBSY:
 
340
      default:
 
341
        _exit(EX_OSERR);
 
342
      case ENOTDIR:
 
343
      case ELOOP:
 
344
      case EISDIR:
 
345
#ifdef ELIBBAD
 
346
      case ELIBBAD:             /* Linux only */
 
347
#endif
 
348
      case EPERM:
 
349
        _exit(EX_OSFILE);
256
350
      }
257
 
      free(prompt);
258
 
      _exit(EXIT_FAILURE);
259
351
    }
 
352
    free(prompt);
 
353
    _exit(EXIT_FAILURE);
260
354
  }
261
355
  
262
356
  /* Parent */
263
357
  free(prompt);
 
358
  prompt = NULL;
 
359
  
 
360
  if(interrupted_by_signal){
 
361
    goto failure;
 
362
  }
264
363
  
265
364
  /* Wait for command to complete */
266
 
  if(not interrupted_by_signal and splashy_command_pid != 0){
 
365
  {
267
366
    int status;
268
 
    ret = waitpid(splashy_command_pid, &status, 0);
 
367
    do {
 
368
      ret = waitpid(splashy_command_pid, &status, 0);
 
369
    } while(ret == -1 and errno == EINTR
 
370
            and not interrupted_by_signal);
 
371
    if(interrupted_by_signal){
 
372
      goto failure;
 
373
    }
269
374
    if(ret == -1){
270
 
      if(errno != EINTR){
271
 
        perror("waitpid");
272
 
      }
 
375
      error_plus(0, errno, "waitpid");
273
376
      if(errno == ECHILD){
274
377
        splashy_command_pid = 0;
275
378
      }
276
379
    } else {
277
380
      /* The child process has exited */
278
381
      splashy_command_pid = 0;
279
 
      if(not interrupted_by_signal and WIFEXITED(status)
280
 
         and WEXITSTATUS(status)==0){
 
382
      if(WIFEXITED(status) and WEXITSTATUS(status) == 0){
281
383
        return EXIT_SUCCESS;
282
384
      }
283
385
    }
284
386
  }
285
 
  kill(splashy_pid, SIGTERM);
286
 
  if(interrupted_by_signal and splashy_command_pid != 0){
287
 
    kill(splashy_command_pid, SIGTERM);
288
 
  }
289
 
  sleep(2);
290
 
  while(kill(splashy_pid, 0) == 0){
291
 
    kill(splashy_pid, SIGKILL);
292
 
    sleep(1);
293
 
  }
294
 
  pid_t new_splashy_pid = fork();
295
 
  if(new_splashy_pid == 0){
296
 
    /* Child; will become new splashy process */
297
 
    
298
 
    /* Make the effective user ID (root) the only user ID instead of
299
 
       the real user ID (_mandos) */
300
 
    ret = setuid(geteuid());
301
 
    if(ret == -1){
302
 
      perror("setuid");
303
 
    }
304
 
    
305
 
    setsid();
306
 
    ret = chdir("/");
307
 
/*     if(fork() != 0){ */
308
 
/*       _exit(EXIT_SUCCESS); */
309
 
/*     } */
310
 
    ret = dup2(STDERR_FILENO, STDOUT_FILENO); /* replace our stdout */
311
 
    if(ret == -1){
312
 
      perror("dup2");
313
 
      _exit(EXIT_FAILURE);
314
 
    }
315
 
    
316
 
    execl("/sbin/splashy", "/sbin/splashy", "boot", (char *)NULL);
317
 
    if(not interrupted_by_signal){
318
 
      perror("execl");
319
 
    }
320
 
    _exit(EXIT_FAILURE);
321
 
  }
322
 
  
323
 
  return EXIT_FAILURE;
 
387
  
 
388
 failure:
 
389
  
 
390
  free(prompt);
 
391
  
 
392
  if(proc_dir != NULL){
 
393
    TEMP_FAILURE_RETRY(closedir(proc_dir));
 
394
  }
 
395
  
 
396
  if(splashy_command_pid != 0){
 
397
    TEMP_FAILURE_RETRY(kill(splashy_command_pid, SIGTERM));
 
398
    
 
399
    TEMP_FAILURE_RETRY(kill(splashy_pid, SIGTERM));
 
400
    sleep(2);
 
401
    while(TEMP_FAILURE_RETRY(kill(splashy_pid, 0)) == 0){
 
402
      TEMP_FAILURE_RETRY(kill(splashy_pid, SIGKILL));
 
403
      sleep(1);
 
404
    }
 
405
    pid_t new_splashy_pid = (pid_t)TEMP_FAILURE_RETRY(fork());
 
406
    if(new_splashy_pid == 0){
 
407
      /* Child; will become new splashy process */
 
408
      
 
409
      /* Make the effective user ID (root) the only user ID instead of
 
410
         the real user ID (_mandos) */
 
411
      ret = setuid(geteuid());
 
412
      if(ret == -1){
 
413
        error_plus(0, errno, "setuid");
 
414
      }
 
415
      
 
416
      setsid();
 
417
      ret = chdir("/");
 
418
      if(ret == -1){
 
419
        error_plus(0, errno, "chdir");
 
420
      }
 
421
/*       if(fork() != 0){ */
 
422
/*      _exit(EXIT_SUCCESS); */
 
423
/*       } */
 
424
      ret = dup2(STDERR_FILENO, STDOUT_FILENO); /* replace stdout */
 
425
      if(ret == -1){
 
426
        error_plus(0, errno, "dup2");
 
427
        _exit(EX_OSERR);
 
428
      }
 
429
      
 
430
      execl("/sbin/splashy", "/sbin/splashy", "boot", (char *)NULL);
 
431
      {
 
432
        int e = errno;
 
433
        error_plus(0, errno, "execl");
 
434
        switch(e){
 
435
        case EACCES:
 
436
        case ENOENT:
 
437
        case ENOEXEC:
 
438
        default:
 
439
          _exit(EX_UNAVAILABLE);
 
440
        case ENAMETOOLONG:
 
441
        case E2BIG:
 
442
        case ENOMEM:
 
443
          _exit(EX_OSERR);
 
444
        case ENOTDIR:
 
445
        case ELOOP:
 
446
          _exit(EX_OSFILE);
 
447
        }
 
448
      }
 
449
    }
 
450
  }
 
451
  
 
452
  if(interrupted_by_signal){
 
453
    struct sigaction signal_action;
 
454
    sigemptyset(&signal_action.sa_mask);
 
455
    signal_action.sa_handler = SIG_DFL;
 
456
    ret = (int)TEMP_FAILURE_RETRY(sigaction(signal_received,
 
457
                                            &signal_action, NULL));
 
458
    if(ret == -1){
 
459
      error_plus(0, errno, "sigaction");
 
460
    }
 
461
    do {
 
462
      ret = raise(signal_received);
 
463
    } while(ret != 0 and errno == EINTR);
 
464
    if(ret != 0){
 
465
      error_plus(0, errno, "raise");
 
466
      abort();
 
467
    }
 
468
    TEMP_FAILURE_RETRY(pause());
 
469
  }
 
470
  
 
471
  return exitstatus;
324
472
}