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

  • Committer: Teddy Hogeborn
  • Date: 2024-09-08 00:24:32 UTC
  • Revision ID: teddy@recompile.se-20240908002432-0exnlv1fp73hps8j
Document how to add options to mandos-client when using dracut

* debian/mandos-client.README.Debian: Remove unnecessary word
  "simply".  Also add instructions on how to add the --connect=
  options to mandos-client when using dracut.
* dracut-module/ask-password-mandos.service ([Service]): Add comments
  that this file should *not* be modified, and explicit instructions
  on how to instead add extra options, like --debug, to mandos-client:
  using a systemd override unit file to set an environment variable.

Show diffs side-by-side

added added

removed removed

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