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 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 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);
175 /* Read seq number (base 36). */
176 nread = read(fd, buf, sizeof(buf));
179 log_fatal(USE_ERRNO, _("unable to read %s"), pathbuf);
180 id = strtoul(buf, &ep, 36);
181 if (buf == ep || id >= SESSID_MAX)
182 log_fatal(0, _("invalid sequence number %s"), pathbuf);
187 * Convert id to a string and stash in sessid.
188 * Note that that least significant digits go at the end of the string.
190 for (i = 5; i >= 0; i--) {
191 buf[i] = b36char[id % 36];
196 /* Stash id for logging purposes. */
197 memcpy(sessid, buf, 6);
200 /* Rewind and overwrite old seq file. */
201 if (lseek(fd, 0, SEEK_SET) == (off_t)-1 || write(fd, buf, 7) != 7)
202 log_fatal(USE_ERRNO, _("unable to write to %s"), pathbuf);
209 * Copy iolog_path to pathbuf and create the directory and any intermediate
210 * directories. If iolog_path ends in 'XXXXXX', use mkdtemp().
213 mkdir_iopath(const char *iolog_path, char *pathbuf, size_t pathsize)
216 debug_decl(mkdir_iopath, SUDO_DEBUG_UTIL)
218 len = strlcpy(pathbuf, iolog_path, pathsize);
219 if (len >= pathsize) {
220 errno = ENAMETOOLONG;
221 log_fatal(USE_ERRNO, "%s", iolog_path);
225 * Create path and intermediate subdirs as needed.
226 * If path ends in at least 6 Xs (ala POSIX mktemp), use mkdtemp().
228 mkdir_parents(pathbuf);
229 if (len >= 6 && strcmp(&pathbuf[len - 6], "XXXXXX") == 0) {
230 if (mkdtemp(pathbuf) == NULL)
231 log_fatal(USE_ERRNO, _("unable to create %s"), pathbuf);
233 if (mkdir(pathbuf, S_IRWXU) != 0)
234 log_fatal(USE_ERRNO, _("unable to create %s"), pathbuf);
237 debug_return_size_t(len);
241 * Append suffix to pathbuf after len chars and open the resulting file.
242 * Note that the size of pathbuf is assumed to be PATH_MAX.
243 * Uses zlib if docompress is true.
244 * Returns the open file handle which has the close-on-exec flag set.
247 open_io_fd(char *pathbuf, size_t len, const char *suffix, bool docompress)
251 debug_decl(open_io_fd, SUDO_DEBUG_UTIL)
254 strlcat(pathbuf, suffix, PATH_MAX);
255 fd = open(pathbuf, O_CREAT|O_EXCL|O_WRONLY, S_IRUSR|S_IWUSR);
257 fcntl(fd, F_SETFD, FD_CLOEXEC);
260 vfd = gzdopen(fd, "w");
263 vfd = fdopen(fd, "w");
265 debug_return_ptr(vfd);
269 * Pull out I/O log related data from user_info and command_info arrays.
272 iolog_deserialize_info(struct iolog_details *details, char * const user_info[],
273 char * const command_info[])
275 const char *runas_uid_str = "0", *runas_euid_str = NULL;
276 const char *runas_gid_str = "0", *runas_egid_str = NULL;
277 char id[MAX_UID_T_LEN + 2], *ep;
282 debug_decl(iolog_deserialize_info, SUDO_DEBUG_UTIL)
284 memset(details, 0, sizeof(*details));
286 for (cur = user_info; *cur != NULL; cur++) {
289 if (strncmp(*cur, "cwd=", sizeof("cwd=") - 1) == 0) {
290 details->cwd = *cur + sizeof("cwd=") - 1;
295 if (strncmp(*cur, "tty=", sizeof("tty=") - 1) == 0) {
296 details->tty = *cur + sizeof("tty=") - 1;
301 if (strncmp(*cur, "user=", sizeof("user=") - 1) == 0) {
302 details->user = *cur + sizeof("user=") - 1;
309 for (cur = command_info; *cur != NULL; cur++) {
312 if (strncmp(*cur, "command=", sizeof("command=") - 1) == 0) {
313 details->command = *cur + sizeof("command=") - 1;
318 if (strncmp(*cur, "iolog_path=", sizeof("iolog_path=") - 1) == 0) {
319 details->iolog_path = *cur + sizeof("iolog_path=") - 1;
322 if (strncmp(*cur, "iolog_stdin=", sizeof("iolog_stdin=") - 1) == 0) {
323 if (atobool(*cur + sizeof("iolog_stdin=") - 1) == true)
324 details->iolog_stdin = true;
327 if (strncmp(*cur, "iolog_stdout=", sizeof("iolog_stdout=") - 1) == 0) {
328 if (atobool(*cur + sizeof("iolog_stdout=") - 1) == true)
329 details->iolog_stdout = true;
332 if (strncmp(*cur, "iolog_stderr=", sizeof("iolog_stderr=") - 1) == 0) {
333 if (atobool(*cur + sizeof("iolog_stderr=") - 1) == true)
334 details->iolog_stderr = true;
337 if (strncmp(*cur, "iolog_ttyin=", sizeof("iolog_ttyin=") - 1) == 0) {
338 if (atobool(*cur + sizeof("iolog_ttyin=") - 1) == true)
339 details->iolog_ttyin = true;
342 if (strncmp(*cur, "iolog_ttyout=", sizeof("iolog_ttyout=") - 1) == 0) {
343 if (atobool(*cur + sizeof("iolog_ttyout=") - 1) == true)
344 details->iolog_ttyout = true;
347 if (strncmp(*cur, "iolog_compress=", sizeof("iolog_compress=") - 1) == 0) {
348 if (atobool(*cur + sizeof("iolog_compress=") - 1) == true)
349 iolog_compress = true; /* must be global */
354 if (strncmp(*cur, "runas_gid=", sizeof("runas_gid=") - 1) == 0) {
355 runas_gid_str = *cur + sizeof("runas_gid=") - 1;
358 if (strncmp(*cur, "runas_egid=", sizeof("runas_egid=") - 1) == 0) {
359 runas_egid_str = *cur + sizeof("runas_egid=") - 1;
362 if (strncmp(*cur, "runas_uid=", sizeof("runas_uid=") - 1) == 0) {
363 runas_uid_str = *cur + sizeof("runas_uid=") - 1;
366 if (strncmp(*cur, "runas_euid=", sizeof("runas_euid=") - 1) == 0) {
367 runas_euid_str = *cur + sizeof("runas_euid=") - 1;
375 * Lookup runas user and group, preferring effective over real uid/gid.
377 if (runas_euid_str != NULL)
378 runas_uid_str = runas_euid_str;
379 if (runas_uid_str != NULL) {
381 ulval = strtoul(runas_uid_str, &ep, 0);
382 if (*runas_uid_str != '\0' && *ep == '\0' &&
383 (errno != ERANGE || ulval != ULONG_MAX)) {
384 runas_uid = (uid_t)ulval;
387 if (runas_egid_str != NULL)
388 runas_gid_str = runas_egid_str;
389 if (runas_gid_str != NULL) {
391 ulval = strtoul(runas_gid_str, &ep, 0);
392 if (*runas_gid_str != '\0' && *ep == '\0' &&
393 (errno != ERANGE || ulval != ULONG_MAX)) {
394 runas_gid = (gid_t)ulval;
398 details->runas_pw = sudo_getpwuid(runas_uid);
399 if (details->runas_pw == NULL) {
401 strlcpy(&id[1], runas_uid_str, sizeof(id) - 1);
402 details->runas_pw = sudo_fakepwnam(id, runas_gid);
405 if (runas_gid != details->runas_pw->pw_gid) {
406 details->runas_gr = sudo_getgrgid(runas_gid);
407 if (details->runas_gr == NULL) {
409 strlcpy(&id[1], runas_gid_str, sizeof(id) - 1);
410 details->runas_gr = sudo_fakegrnam(id);
417 sudoers_io_open(unsigned int version, sudo_conv_t conversation,
418 sudo_printf_t plugin_printf, char * const settings[],
419 char * const user_info[], char * const command_info[],
420 int argc, char * const argv[], char * const user_env[], char * const args[])
422 struct iolog_details details;
423 char pathbuf[PATH_MAX], sessid[7];
426 const char *debug_flags = NULL;
430 debug_decl(sudoers_io_open, SUDO_DEBUG_PLUGIN)
433 sudo_conv = conversation;
435 sudo_printf = plugin_printf;
437 /* If we have no command (because -V was specified) just return. */
439 debug_return_bool(true);
441 if (sigsetjmp(error_jmp, 1)) {
442 /* called via error(), errorx() or log_fatal() */
447 bindtextdomain("sudoers", LOCALEDIR);
453 * Check for debug flags in settings list.
455 for (cur = settings; *cur != NULL; cur++) {
456 if (strncmp(*cur, "debug_flags=", sizeof("debug_flags=") - 1) == 0)
457 debug_flags = *cur + sizeof("debug_flags=") - 1;
459 if (debug_flags != NULL)
460 sudo_debug_init(NULL, debug_flags);
463 * Pull iolog settings out of command_info, if any.
465 iolog_deserialize_info(&details, user_info, command_info);
466 /* Did policy module disable I/O logging? */
467 if (!details.iolog_stdin && !details.iolog_ttyin &&
468 !details.iolog_stdout && !details.iolog_stderr &&
469 !details.iolog_ttyout) {
474 /* If no I/O log path defined we need to figure it out ourselves. */
475 if (details.iolog_path == NULL) {
476 /* Get next session ID and convert it into a path. */
477 tofree = emalloc(sizeof(_PATH_SUDO_IO_LOGDIR) + sizeof(sessid) + 2);
478 memcpy(tofree, _PATH_SUDO_IO_LOGDIR, sizeof(_PATH_SUDO_IO_LOGDIR));
479 io_nextid(tofree, sessid);
480 snprintf(tofree + sizeof(_PATH_SUDO_IO_LOGDIR), sizeof(sessid) + 2,
481 "%c%c/%c%c/%c%c", sessid[0], sessid[1], sessid[2], sessid[3],
482 sessid[4], sessid[5]);
483 details.iolog_path = tofree;
487 * Make local copy of I/O log path and create it, along with any
488 * intermediate subdirs. Calls mkdtemp() if iolog_path ends in XXXXXX.
490 len = mkdir_iopath(details.iolog_path, pathbuf, sizeof(pathbuf));
491 if (len >= sizeof(pathbuf))
495 * We create 7 files: a log file, a timing file and 5 for input/output.
497 io_logfile = open_io_fd(pathbuf, len, "/log", false);
498 if (io_logfile == NULL)
499 log_fatal(USE_ERRNO, _("unable to create %s"), pathbuf);
501 io_fds[IOFD_TIMING].v = open_io_fd(pathbuf, len, "/timing",
503 if (io_fds[IOFD_TIMING].v == NULL)
504 log_fatal(USE_ERRNO, _("unable to create %s"), pathbuf);
506 if (details.iolog_ttyin) {
507 io_fds[IOFD_TTYIN].v = open_io_fd(pathbuf, len, "/ttyin",
509 if (io_fds[IOFD_TTYIN].v == NULL)
510 log_fatal(USE_ERRNO, _("unable to create %s"), pathbuf);
512 sudoers_io.log_ttyin = NULL;
514 if (details.iolog_stdin) {
515 io_fds[IOFD_STDIN].v = open_io_fd(pathbuf, len, "/stdin",
517 if (io_fds[IOFD_STDIN].v == NULL)
518 log_fatal(USE_ERRNO, _("unable to create %s"), pathbuf);
520 sudoers_io.log_stdin = NULL;
522 if (details.iolog_ttyout) {
523 io_fds[IOFD_TTYOUT].v = open_io_fd(pathbuf, len, "/ttyout",
525 if (io_fds[IOFD_TTYOUT].v == NULL)
526 log_fatal(USE_ERRNO, _("unable to create %s"), pathbuf);
528 sudoers_io.log_ttyout = NULL;
530 if (details.iolog_stdout) {
531 io_fds[IOFD_STDOUT].v = open_io_fd(pathbuf, len, "/stdout",
533 if (io_fds[IOFD_STDOUT].v == NULL)
534 log_fatal(USE_ERRNO, _("unable to create %s"), pathbuf);
536 sudoers_io.log_stdout = NULL;
538 if (details.iolog_stderr) {
539 io_fds[IOFD_STDERR].v = open_io_fd(pathbuf, len, "/stderr",
541 if (io_fds[IOFD_STDERR].v == NULL)
542 log_fatal(USE_ERRNO, _("unable to create %s"), pathbuf);
544 sudoers_io.log_stderr = NULL;
547 gettimeofday(&last_time, NULL);
549 fprintf(io_logfile, "%ld:%s:%s:%s:%s\n", (long)last_time.tv_sec,
550 details.user ? details.user : "unknown", details.runas_pw->pw_name,
551 details.runas_gr ? details.runas_gr->gr_name : "",
552 details.tty ? details.tty : "unknown");
553 fputs(details.cwd ? details.cwd : "unknown", io_logfile);
554 fputc('\n', io_logfile);
555 fputs(details.command ? details.command : "unknown", io_logfile);
556 for (cur = &argv[1]; *cur != NULL; cur++) {
557 fputc(' ', io_logfile);
558 fputs(*cur, io_logfile);
560 fputc('\n', io_logfile);
567 if (details.runas_pw)
568 pw_delref(details.runas_pw);
570 if (details.runas_gr)
571 gr_delref(details.runas_gr);
574 debug_return_bool(rval);
578 sudoers_io_close(int exit_status, int error)
581 debug_decl(sudoers_io_close, SUDO_DEBUG_PLUGIN)
583 if (sigsetjmp(error_jmp, 1)) {
584 /* called via error(), errorx() or log_fatal() */
588 for (i = 0; i < IOFD_MAX; i++) {
589 if (io_fds[i].v == NULL)
593 gzclose(io_fds[i].g);
602 sudoers_io_version(int verbose)
604 debug_decl(sudoers_io_version, SUDO_DEBUG_PLUGIN)
606 if (sigsetjmp(error_jmp, 1)) {
607 /* called via error(), errorx() or log_fatal() */
608 debug_return_bool(-1);
611 sudo_printf(SUDO_CONV_INFO_MSG, "Sudoers I/O plugin version %s\n",
614 debug_return_bool(true);
618 * Generic I/O logging function. Called by the I/O logging entry points.
621 sudoers_io_log(const char *buf, unsigned int len, int idx)
623 struct timeval now, delay;
624 debug_decl(sudoers_io_version, SUDO_DEBUG_PLUGIN)
626 gettimeofday(&now, NULL);
628 if (sigsetjmp(error_jmp, 1)) {
629 /* called via error(), errorx() or log_fatal() */
630 debug_return_bool(-1);
635 ignore_result(gzwrite(io_fds[idx].g, (const voidp)buf, len));
638 ignore_result(fwrite(buf, 1, len, io_fds[idx].f));
639 delay.tv_sec = now.tv_sec;
640 delay.tv_usec = now.tv_usec;
641 timevalsub(&delay, &last_time);
644 gzprintf(io_fds[IOFD_TIMING].g, "%d %f %d\n", idx,
645 delay.tv_sec + ((double)delay.tv_usec / 1000000), len);
648 fprintf(io_fds[IOFD_TIMING].f, "%d %f %d\n", idx,
649 delay.tv_sec + ((double)delay.tv_usec / 1000000), len);
650 last_time.tv_sec = now.tv_sec;
651 last_time.tv_usec = now.tv_usec;
653 debug_return_bool(true);
657 sudoers_io_log_ttyin(const char *buf, unsigned int len)
659 return sudoers_io_log(buf, len, IOFD_TTYIN);
663 sudoers_io_log_ttyout(const char *buf, unsigned int len)
665 return sudoers_io_log(buf, len, IOFD_TTYOUT);
669 sudoers_io_log_stdin(const char *buf, unsigned int len)
671 return sudoers_io_log(buf, len, IOFD_STDIN);
675 sudoers_io_log_stdout(const char *buf, unsigned int len)
677 return sudoers_io_log(buf, len, IOFD_STDOUT);
681 sudoers_io_log_stderr(const char *buf, unsigned int len)
683 return sudoers_io_log(buf, len, IOFD_STDERR);
686 struct io_plugin sudoers_io = {
692 sudoers_io_log_ttyin,
693 sudoers_io_log_ttyout,
694 sudoers_io_log_stdin,
695 sudoers_io_log_stdout,
696 sudoers_io_log_stderr