2 * Copyright (c) 2009-2011 Todd C. Miller <Todd.Miller@courtesan.com>
4 * Permission to use, copy, modify, and distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19 #include <sys/types.h>
20 #include <sys/param.h>
31 #endif /* STDC_HEADERS */
34 #endif /* HAVE_STRING_H */
37 #endif /* HAVE_STRINGS_H */
40 #endif /* HAVE_UNISTD_H */
41 #if TIME_WITH_SYS_TIME
57 extern sigjmp_buf error_jmp;
68 int len; /* buffer length (how much read in) */
69 int off; /* write position (how much already consumed) */
73 /* XXX - separate sudoers.h and iolog.h? */
77 struct iolog_details {
82 const char *iolog_path;
83 struct passwd *runas_pw;
84 struct group *runas_gr;
100 #define SESSID_MAX 2176782336U
102 static int iolog_compress;
103 static struct timeval last_time;
104 static union io_fd io_fds[IOFD_MAX];
105 extern __dso_public struct io_plugin sudoers_io;
108 * Create parent directories for path as needed, but not path itself.
111 mkdir_parents(char *path)
115 debug_decl(mkdir_parents, SUDO_DEBUG_UTIL)
118 if ((slash = strchr(slash + 1, '/')) == NULL)
121 if (stat(path, &sb) != 0) {
122 if (mkdir(path, S_IRWXU) != 0)
123 log_fatal(USE_ERRNO, _("unable to mkdir %s"), path);
124 } else if (!S_ISDIR(sb.st_mode)) {
125 log_fatal(0, _("%s: %s"), path, strerror(ENOTDIR));
133 * Read the on-disk sequence number, set sessid to the next
134 * number, and update the on-disk copy.
135 * Uses file locking to avoid sequence number collisions.
138 io_nextid(char *iolog_dir, char *iolog_dir_fallback, char sessid[7])
143 unsigned long id = 0;
146 char pathbuf[PATH_MAX];
147 static const char b36char[] = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ";
148 debug_decl(io_nextid, SUDO_DEBUG_UTIL)
151 * Create I/O log directory if it doesn't already exist.
153 mkdir_parents(iolog_dir);
154 if (stat(iolog_dir, &sb) != 0) {
155 if (mkdir(iolog_dir, S_IRWXU) != 0)
156 log_fatal(USE_ERRNO, _("unable to mkdir %s"), iolog_dir);
157 } else if (!S_ISDIR(sb.st_mode)) {
158 log_fatal(0, _("%s exists but is not a directory (0%o)"),
159 iolog_dir, (unsigned int) sb.st_mode);
165 len = snprintf(pathbuf, sizeof(pathbuf), "%s/seq", iolog_dir);
166 if (len <= 0 || len >= sizeof(pathbuf)) {
167 errno = ENAMETOOLONG;
168 log_fatal(USE_ERRNO, "%s/seq", pathbuf);
170 fd = open(pathbuf, O_RDWR|O_CREAT, S_IRUSR|S_IWUSR);
172 log_fatal(USE_ERRNO, _("unable to open %s"), pathbuf);
173 lock_file(fd, SUDO_LOCK);
176 * If there is no seq file in iolog_dir and a fallback dir was
177 * specified, look for seq in the fallback dir. This is to work
178 * around a bug in sudo 1.8.5 and older where iolog_dir was not
179 * expanded before the sequence number was updated.
181 if (iolog_dir_fallback != NULL && fstat(fd, &sb) == 0 && sb.st_size == 0) {
182 char fallback[PATH_MAX];
184 len = snprintf(fallback, sizeof(fallback), "%s/seq",
186 if (len > 0 && len < sizeof(fallback)) {
187 int fd2 = open(fallback, O_RDWR|O_CREAT, S_IRUSR|S_IWUSR);
189 nread = read(fd2, buf, sizeof(buf));
191 id = strtoul(buf, &ep, 36);
192 if (buf == ep || id >= SESSID_MAX)
200 /* Read current seq number (base 36). */
202 nread = read(fd, buf, sizeof(buf));
205 log_fatal(USE_ERRNO, _("unable to read %s"), pathbuf);
206 id = strtoul(buf, &ep, 36);
207 if (buf == ep || id >= SESSID_MAX)
208 log_fatal(0, _("invalid sequence number %s"), pathbuf);
214 * Convert id to a string and stash in sessid.
215 * Note that that least significant digits go at the end of the string.
217 for (i = 5; i >= 0; i--) {
218 buf[i] = b36char[id % 36];
223 /* Stash id for logging purposes. */
224 memcpy(sessid, buf, 6);
227 /* Rewind and overwrite old seq file. */
228 if (lseek(fd, (off_t)0, SEEK_SET) == (off_t)-1 || write(fd, buf, 7) != 7)
229 log_fatal(USE_ERRNO, _("unable to write to %s"), pathbuf);
236 * Copy iolog_path to pathbuf and create the directory and any intermediate
237 * directories. If iolog_path ends in 'XXXXXX', use mkdtemp().
240 mkdir_iopath(const char *iolog_path, char *pathbuf, size_t pathsize)
243 debug_decl(mkdir_iopath, SUDO_DEBUG_UTIL)
245 len = strlcpy(pathbuf, iolog_path, pathsize);
246 if (len >= pathsize) {
247 errno = ENAMETOOLONG;
248 log_fatal(USE_ERRNO, "%s", iolog_path);
252 * Create path and intermediate subdirs as needed.
253 * If path ends in at least 6 Xs (ala POSIX mktemp), use mkdtemp().
255 mkdir_parents(pathbuf);
256 if (len >= 6 && strcmp(&pathbuf[len - 6], "XXXXXX") == 0) {
257 if (mkdtemp(pathbuf) == NULL)
258 log_fatal(USE_ERRNO, _("unable to create %s"), pathbuf);
260 if (mkdir(pathbuf, S_IRWXU) != 0)
261 log_fatal(USE_ERRNO, _("unable to create %s"), pathbuf);
264 debug_return_size_t(len);
268 * Append suffix to pathbuf after len chars and open the resulting file.
269 * Note that the size of pathbuf is assumed to be PATH_MAX.
270 * Uses zlib if docompress is true.
271 * Returns the open file handle which has the close-on-exec flag set.
274 open_io_fd(char *pathbuf, size_t len, const char *suffix, bool docompress)
278 debug_decl(open_io_fd, SUDO_DEBUG_UTIL)
281 strlcat(pathbuf, suffix, PATH_MAX);
282 fd = open(pathbuf, O_CREAT|O_EXCL|O_WRONLY, S_IRUSR|S_IWUSR);
284 fcntl(fd, F_SETFD, FD_CLOEXEC);
287 vfd = gzdopen(fd, "w");
290 vfd = fdopen(fd, "w");
292 debug_return_ptr(vfd);
296 * Pull out I/O log related data from user_info and command_info arrays.
299 iolog_deserialize_info(struct iolog_details *details, char * const user_info[],
300 char * const command_info[])
302 const char *runas_uid_str = "0", *runas_euid_str = NULL;
303 const char *runas_gid_str = "0", *runas_egid_str = NULL;
304 char id[MAX_UID_T_LEN + 2], *ep;
309 debug_decl(iolog_deserialize_info, SUDO_DEBUG_UTIL)
311 memset(details, 0, sizeof(*details));
313 for (cur = user_info; *cur != NULL; cur++) {
316 if (strncmp(*cur, "cwd=", sizeof("cwd=") - 1) == 0) {
317 details->cwd = *cur + sizeof("cwd=") - 1;
322 if (strncmp(*cur, "tty=", sizeof("tty=") - 1) == 0) {
323 details->tty = *cur + sizeof("tty=") - 1;
328 if (strncmp(*cur, "user=", sizeof("user=") - 1) == 0) {
329 details->user = *cur + sizeof("user=") - 1;
336 for (cur = command_info; *cur != NULL; cur++) {
339 if (strncmp(*cur, "command=", sizeof("command=") - 1) == 0) {
340 details->command = *cur + sizeof("command=") - 1;
345 if (strncmp(*cur, "iolog_path=", sizeof("iolog_path=") - 1) == 0) {
346 details->iolog_path = *cur + sizeof("iolog_path=") - 1;
349 if (strncmp(*cur, "iolog_stdin=", sizeof("iolog_stdin=") - 1) == 0) {
350 if (atobool(*cur + sizeof("iolog_stdin=") - 1) == true)
351 details->iolog_stdin = true;
354 if (strncmp(*cur, "iolog_stdout=", sizeof("iolog_stdout=") - 1) == 0) {
355 if (atobool(*cur + sizeof("iolog_stdout=") - 1) == true)
356 details->iolog_stdout = true;
359 if (strncmp(*cur, "iolog_stderr=", sizeof("iolog_stderr=") - 1) == 0) {
360 if (atobool(*cur + sizeof("iolog_stderr=") - 1) == true)
361 details->iolog_stderr = true;
364 if (strncmp(*cur, "iolog_ttyin=", sizeof("iolog_ttyin=") - 1) == 0) {
365 if (atobool(*cur + sizeof("iolog_ttyin=") - 1) == true)
366 details->iolog_ttyin = true;
369 if (strncmp(*cur, "iolog_ttyout=", sizeof("iolog_ttyout=") - 1) == 0) {
370 if (atobool(*cur + sizeof("iolog_ttyout=") - 1) == true)
371 details->iolog_ttyout = true;
374 if (strncmp(*cur, "iolog_compress=", sizeof("iolog_compress=") - 1) == 0) {
375 if (atobool(*cur + sizeof("iolog_compress=") - 1) == true)
376 iolog_compress = true; /* must be global */
381 if (strncmp(*cur, "runas_gid=", sizeof("runas_gid=") - 1) == 0) {
382 runas_gid_str = *cur + sizeof("runas_gid=") - 1;
385 if (strncmp(*cur, "runas_egid=", sizeof("runas_egid=") - 1) == 0) {
386 runas_egid_str = *cur + sizeof("runas_egid=") - 1;
389 if (strncmp(*cur, "runas_uid=", sizeof("runas_uid=") - 1) == 0) {
390 runas_uid_str = *cur + sizeof("runas_uid=") - 1;
393 if (strncmp(*cur, "runas_euid=", sizeof("runas_euid=") - 1) == 0) {
394 runas_euid_str = *cur + sizeof("runas_euid=") - 1;
402 * Lookup runas user and group, preferring effective over real uid/gid.
404 if (runas_euid_str != NULL)
405 runas_uid_str = runas_euid_str;
406 if (runas_uid_str != NULL) {
408 ulval = strtoul(runas_uid_str, &ep, 0);
409 if (*runas_uid_str != '\0' && *ep == '\0' &&
410 (errno != ERANGE || ulval != ULONG_MAX)) {
411 runas_uid = (uid_t)ulval;
414 if (runas_egid_str != NULL)
415 runas_gid_str = runas_egid_str;
416 if (runas_gid_str != NULL) {
418 ulval = strtoul(runas_gid_str, &ep, 0);
419 if (*runas_gid_str != '\0' && *ep == '\0' &&
420 (errno != ERANGE || ulval != ULONG_MAX)) {
421 runas_gid = (gid_t)ulval;
425 details->runas_pw = sudo_getpwuid(runas_uid);
426 if (details->runas_pw == NULL) {
428 strlcpy(&id[1], runas_uid_str, sizeof(id) - 1);
429 details->runas_pw = sudo_fakepwnam(id, runas_gid);
432 if (runas_gid != details->runas_pw->pw_gid) {
433 details->runas_gr = sudo_getgrgid(runas_gid);
434 if (details->runas_gr == NULL) {
436 strlcpy(&id[1], runas_gid_str, sizeof(id) - 1);
437 details->runas_gr = sudo_fakegrnam(id);
444 sudoers_io_open(unsigned int version, sudo_conv_t conversation,
445 sudo_printf_t plugin_printf, char * const settings[],
446 char * const user_info[], char * const command_info[],
447 int argc, char * const argv[], char * const user_env[], char * const args[])
449 struct iolog_details details;
450 char pathbuf[PATH_MAX], sessid[7];
453 const char *debug_flags = NULL;
457 debug_decl(sudoers_io_open, SUDO_DEBUG_PLUGIN)
460 sudo_conv = conversation;
462 sudo_printf = plugin_printf;
464 /* If we have no command (because -V was specified) just return. */
466 debug_return_bool(true);
468 if (sigsetjmp(error_jmp, 1)) {
469 /* called via error(), errorx() or log_fatal() */
474 bindtextdomain("sudoers", LOCALEDIR);
480 * Check for debug flags in settings list.
482 for (cur = settings; *cur != NULL; cur++) {
483 if (strncmp(*cur, "debug_flags=", sizeof("debug_flags=") - 1) == 0)
484 debug_flags = *cur + sizeof("debug_flags=") - 1;
486 if (debug_flags != NULL)
487 sudo_debug_init(NULL, debug_flags);
490 * Pull iolog settings out of command_info, if any.
492 iolog_deserialize_info(&details, user_info, command_info);
493 /* Did policy module disable I/O logging? */
494 if (!details.iolog_stdin && !details.iolog_ttyin &&
495 !details.iolog_stdout && !details.iolog_stderr &&
496 !details.iolog_ttyout) {
501 /* If no I/O log path defined we need to figure it out ourselves. */
502 if (details.iolog_path == NULL) {
503 /* Get next session ID and convert it into a path. */
504 tofree = emalloc(sizeof(_PATH_SUDO_IO_LOGDIR) + sizeof(sessid) + 2);
505 memcpy(tofree, _PATH_SUDO_IO_LOGDIR, sizeof(_PATH_SUDO_IO_LOGDIR));
506 io_nextid(tofree, NULL, sessid);
507 snprintf(tofree + sizeof(_PATH_SUDO_IO_LOGDIR), sizeof(sessid) + 2,
508 "%c%c/%c%c/%c%c", sessid[0], sessid[1], sessid[2], sessid[3],
509 sessid[4], sessid[5]);
510 details.iolog_path = tofree;
514 * Make local copy of I/O log path and create it, along with any
515 * intermediate subdirs. Calls mkdtemp() if iolog_path ends in XXXXXX.
517 len = mkdir_iopath(details.iolog_path, pathbuf, sizeof(pathbuf));
518 if (len >= sizeof(pathbuf))
522 * We create 7 files: a log file, a timing file and 5 for input/output.
524 io_logfile = open_io_fd(pathbuf, len, "/log", false);
525 if (io_logfile == NULL)
526 log_fatal(USE_ERRNO, _("unable to create %s"), pathbuf);
528 io_fds[IOFD_TIMING].v = open_io_fd(pathbuf, len, "/timing",
530 if (io_fds[IOFD_TIMING].v == NULL)
531 log_fatal(USE_ERRNO, _("unable to create %s"), pathbuf);
533 if (details.iolog_ttyin) {
534 io_fds[IOFD_TTYIN].v = open_io_fd(pathbuf, len, "/ttyin",
536 if (io_fds[IOFD_TTYIN].v == NULL)
537 log_fatal(USE_ERRNO, _("unable to create %s"), pathbuf);
539 sudoers_io.log_ttyin = NULL;
541 if (details.iolog_stdin) {
542 io_fds[IOFD_STDIN].v = open_io_fd(pathbuf, len, "/stdin",
544 if (io_fds[IOFD_STDIN].v == NULL)
545 log_fatal(USE_ERRNO, _("unable to create %s"), pathbuf);
547 sudoers_io.log_stdin = NULL;
549 if (details.iolog_ttyout) {
550 io_fds[IOFD_TTYOUT].v = open_io_fd(pathbuf, len, "/ttyout",
552 if (io_fds[IOFD_TTYOUT].v == NULL)
553 log_fatal(USE_ERRNO, _("unable to create %s"), pathbuf);
555 sudoers_io.log_ttyout = NULL;
557 if (details.iolog_stdout) {
558 io_fds[IOFD_STDOUT].v = open_io_fd(pathbuf, len, "/stdout",
560 if (io_fds[IOFD_STDOUT].v == NULL)
561 log_fatal(USE_ERRNO, _("unable to create %s"), pathbuf);
563 sudoers_io.log_stdout = NULL;
565 if (details.iolog_stderr) {
566 io_fds[IOFD_STDERR].v = open_io_fd(pathbuf, len, "/stderr",
568 if (io_fds[IOFD_STDERR].v == NULL)
569 log_fatal(USE_ERRNO, _("unable to create %s"), pathbuf);
571 sudoers_io.log_stderr = NULL;
574 gettimeofday(&last_time, NULL);
576 fprintf(io_logfile, "%ld:%s:%s:%s:%s\n", (long)last_time.tv_sec,
577 details.user ? details.user : "unknown", details.runas_pw->pw_name,
578 details.runas_gr ? details.runas_gr->gr_name : "",
579 details.tty ? details.tty : "unknown");
580 fputs(details.cwd ? details.cwd : "unknown", io_logfile);
581 fputc('\n', io_logfile);
582 fputs(details.command ? details.command : "unknown", io_logfile);
583 for (cur = &argv[1]; *cur != NULL; cur++) {
584 fputc(' ', io_logfile);
585 fputs(*cur, io_logfile);
587 fputc('\n', io_logfile);
594 if (details.runas_pw)
595 sudo_pw_delref(details.runas_pw);
597 if (details.runas_gr)
598 sudo_gr_delref(details.runas_gr);
601 debug_return_bool(rval);
605 sudoers_io_close(int exit_status, int error)
608 debug_decl(sudoers_io_close, SUDO_DEBUG_PLUGIN)
610 if (sigsetjmp(error_jmp, 1)) {
611 /* called via error(), errorx() or log_fatal() */
615 for (i = 0; i < IOFD_MAX; i++) {
616 if (io_fds[i].v == NULL)
620 gzclose(io_fds[i].g);
629 sudoers_io_version(int verbose)
631 debug_decl(sudoers_io_version, SUDO_DEBUG_PLUGIN)
633 if (sigsetjmp(error_jmp, 1)) {
634 /* called via error(), errorx() or log_fatal() */
635 debug_return_bool(-1);
638 sudo_printf(SUDO_CONV_INFO_MSG, "Sudoers I/O plugin version %s\n",
641 debug_return_bool(true);
645 * Generic I/O logging function. Called by the I/O logging entry points.
648 sudoers_io_log(const char *buf, unsigned int len, int idx)
650 struct timeval now, delay;
651 debug_decl(sudoers_io_version, SUDO_DEBUG_PLUGIN)
653 gettimeofday(&now, NULL);
655 if (sigsetjmp(error_jmp, 1)) {
656 /* called via error(), errorx() or log_fatal() */
657 debug_return_bool(-1);
662 ignore_result(gzwrite(io_fds[idx].g, (const voidp)buf, len));
665 ignore_result(fwrite(buf, 1, len, io_fds[idx].f));
666 delay.tv_sec = now.tv_sec;
667 delay.tv_usec = now.tv_usec;
668 timevalsub(&delay, &last_time);
671 gzprintf(io_fds[IOFD_TIMING].g, "%d %f %d\n", idx,
672 delay.tv_sec + ((double)delay.tv_usec / 1000000), len);
675 fprintf(io_fds[IOFD_TIMING].f, "%d %f %d\n", idx,
676 delay.tv_sec + ((double)delay.tv_usec / 1000000), len);
677 last_time.tv_sec = now.tv_sec;
678 last_time.tv_usec = now.tv_usec;
680 debug_return_bool(true);
684 sudoers_io_log_ttyin(const char *buf, unsigned int len)
686 return sudoers_io_log(buf, len, IOFD_TTYIN);
690 sudoers_io_log_ttyout(const char *buf, unsigned int len)
692 return sudoers_io_log(buf, len, IOFD_TTYOUT);
696 sudoers_io_log_stdin(const char *buf, unsigned int len)
698 return sudoers_io_log(buf, len, IOFD_STDIN);
702 sudoers_io_log_stdout(const char *buf, unsigned int len)
704 return sudoers_io_log(buf, len, IOFD_STDOUT);
708 sudoers_io_log_stderr(const char *buf, unsigned int len)
710 return sudoers_io_log(buf, len, IOFD_STDERR);
713 __dso_public struct io_plugin sudoers_io = {
719 sudoers_io_log_ttyin,
720 sudoers_io_log_ttyout,
721 sudoers_io_log_stdin,
722 sudoers_io_log_stdout,
723 sudoers_io_log_stderr