A helper file for cleanup.c.
[rsync/rsync.git] / util.c
diff --git a/util.c b/util.c
index db0275a..632a242 100644 (file)
--- a/util.c
+++ b/util.c
@@ -1,8 +1,10 @@
-/*  -*- c-file-style: "linux" -*-
+/*
+ * Utility routines used in rsync.
  *
- * Copyright (C) 1996-2000 by Andrew Tridgell
- * Copyright (C) Paul Mackerras 1996
- * Copyright (C) 2001, 2002 by Martin Pool <mbp@samba.org>
+ * Copyright (C) 1996-2000 Andrew Tridgell
+ * Copyright (C) 1996 Paul Mackerras
+ * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
+ * Copyright (C) 2003, 2004, 2005, 2006 Wayne Davison
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
  */
 
-/**
- * @file
- *
- * Utilities used in rsync
- **/
-
 #include "rsync.h"
 
 extern int verbose;
@@ -33,22 +29,23 @@ extern int module_id;
 extern int modify_window;
 extern int relative_paths;
 extern int human_readable;
+extern unsigned int module_dirlen;
 extern mode_t orig_umask;
 extern char *partial_dir;
 extern struct filter_list_struct server_filter_list;
 
 int sanitize_paths = 0;
 
+char curr_dir[MAXPATHLEN];
+unsigned int curr_dir_len;
+int curr_dir_depth; /* This is only set for a sanitizing daemon. */
 
-
-/**
- * Set a fd into nonblocking mode
- **/
+/* Set a fd into nonblocking mode. */
 void set_nonblocking(int fd)
 {
        int val;
 
-       if ((val = fcntl(fd, F_GETFL, 0)) == -1)
+       if ((val = fcntl(fd, F_GETFL)) == -1)
                return;
        if (!(val & NONBLOCK_FLAG)) {
                val |= NONBLOCK_FLAG;
@@ -56,14 +53,12 @@ void set_nonblocking(int fd)
        }
 }
 
-/**
- * Set a fd into blocking mode
- **/
+/* Set a fd into blocking mode. */
 void set_blocking(int fd)
 {
        int val;
 
-       if ((val = fcntl(fd, F_GETFL, 0)) == -1)
+       if ((val = fcntl(fd, F_GETFL)) == -1)
                return;
        if (val & NONBLOCK_FLAG) {
                val &= ~NONBLOCK_FLAG;
@@ -97,7 +92,7 @@ int fd_pair(int fd[2])
 
 void print_child_argv(char **cmd)
 {
-       rprintf(FINFO, "opening connection using ");
+       rprintf(FCLIENT, "opening connection using ");
        for (; *cmd; cmd++) {
                /* Look for characters that ought to be quoted.  This
                * is not a great quoting algorithm, but it's
@@ -106,23 +101,23 @@ void print_child_argv(char **cmd)
                           "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
                           "0123456789"
                           ",.-_=+@/") != strlen(*cmd)) {
-                       rprintf(FINFO, "\"%s\" ", *cmd);
+                       rprintf(FCLIENT, "\"%s\" ", *cmd);
                } else {
-                       rprintf(FINFO, "%s ", *cmd);
+                       rprintf(FCLIENT, "%s ", *cmd);
                }
        }
-       rprintf(FINFO, "\n");
+       rprintf(FCLIENT, "\n");
 }
 
-void out_of_memory(char *str)
+NORETURN void out_of_memory(char *str)
 {
-       rprintf(FERROR, "ERROR: out of memory in %s\n", str);
+       rprintf(FERROR, "ERROR: out of memory in %s [%s]\n", str, who_am_i());
        exit_cleanup(RERR_MALLOC);
 }
 
-void overflow_exit(char *str)
+NORETURN void overflow_exit(char *str)
 {
-       rprintf(FERROR, "ERROR: buffer overflow in %s\n", str);
+       rprintf(FERROR, "ERROR: buffer overflow in %s [%s]\n", str, who_am_i());
        exit_cleanup(RERR_MALLOC);
 }
 
@@ -184,28 +179,29 @@ int mkdir_defmode(char *fname)
        return ret;
 }
 
-/**
-   Create any necessary directories in fname. Unfortunately we don't know
-   what perms to give the directory when this is called so we need to rely
-   on the umask
-**/
+/* Create any necessary directories in fname.  Any missing directories are
+ * created with default permissions. */
 int create_directory_path(char *fname)
 {
        char *p;
+       int ret = 0;
 
        while (*fname == '/')
                fname++;
        while (strncmp(fname, "./", 2) == 0)
                fname += 2;
 
+       umask(orig_umask);
        p = fname;
        while ((p = strchr(p,'/')) != NULL) {
-               *p = 0;
-               mkdir_defmode(fname);
-               *p = '/';
-               p++;
+               *p = '\0';
+               if (do_mkdir(fname, ACCESSPERMS) < 0 && errno != EEXIST)
+                   ret = -1;
+               *p++ = '/';
        }
-       return 0;
+       umask(0);
+
+       return ret;
 }
 
 /**
@@ -363,7 +359,7 @@ int robust_unlink(const char *fname)
        /* start where the last one left off to reduce chance of clashes */
        start = counter;
        do {
-               sprintf(&path[pos], "%03d", counter);
+               snprintf(&path[pos], MAX_RENAMES_DIGITS+1, "%03d", counter);
                if (++counter >= MAX_RENAMES)
                        counter = 1;
        } while ((rc = access(path, 0)) == 0 && counter != start);
@@ -548,7 +544,7 @@ static void glob_expand_one(char *s, char ***argv_ptr, int *argc_ptr,
                s = ".";
 
        if (sanitize_paths)
-               s = sanitize_path(NULL, s, "", 0);
+               s = sanitize_path(NULL, s, "", 0, NULL);
        else
                s = strdup(s);
 
@@ -679,7 +675,7 @@ int count_dir_elements(const char *p)
        int cnt = 0, new_component = 1;
        while (*p) {
                if (*p++ == '/')
-                       new_component = 1;
+                       new_component = (*p != '.' || (p[1] != '/' && p[1] != '\0'));
                else if (new_component) {
                        new_component = 0;
                        cnt++;
@@ -754,22 +750,29 @@ unsigned int clean_fname(char *name, BOOL collapse_dot_dot)
  * The rootdir string contains a value to use in place of a leading slash.
  * Specify NULL to get the default of lp_path(module_id).
  *
- * If depth is >= 0, it is a count of how many '..'s to allow at the start
- * of the path.  Use -1 to allow unlimited depth.
+ * The depth var is a count of how many '..'s to allow at the start of the
+ * path.  If symlink is set, combine its value with the "p" value to get
+ * the target path, and **return NULL if any '..'s try to escape**.
  *
  * We also clean the path in a manner similar to clean_fname() but with a
- * few differences: 
+ * few differences:
  *
  * Turns multiple adjacent slashes into a single slash, gets rid of "." dir
  * elements (INCLUDING a trailing dot dir), PRESERVES a trailing slash, and
  * ALWAYS collapses ".." elements (except for those at the start of the
  * string up to "depth" deep).  If the resulting name would be empty,
  * change it into a ".". */
-char *sanitize_path(char *dest, const char *p, const char *rootdir, int depth)
+char *sanitize_path(char *dest, const char *p, const char *rootdir, int depth,
+                   const char *symlink)
 {
-       char *start, *sanp;
+       char *start, *sanp, *save_dest = dest;
        int rlen = 0, leave_one_dotdir = relative_paths;
 
+       if (symlink && *symlink == '/') {
+               p = symlink;
+               symlink = "";
+       }
+
        if (dest != p) {
                int plen = strlen(p);
                if (*p == '/') {
@@ -792,7 +795,18 @@ char *sanitize_path(char *dest, const char *p, const char *rootdir, int depth)
        }
 
        start = sanp = dest + rlen;
-       while (*p != '\0') {
+       while (1) {
+               if (*p == '\0') {
+                       if (!symlink || !*symlink)
+                               break;
+                       while (sanp != start && sanp[-1] != '/') {
+                               /* strip last element */
+                               sanp--;
+                       }
+                       /* Append a relative symlink */
+                       p = symlink;
+                       symlink = "";
+               }
                /* discard leading or extra slashes */
                if (*p == '/') {
                        p++;
@@ -814,6 +828,11 @@ char *sanitize_path(char *dest, const char *p, const char *rootdir, int depth)
                if (*p == '.' && p[1] == '.' && (p[2] == '/' || p[2] == '\0')) {
                        /* ".." component followed by slash or end */
                        if (depth <= 0 || sanp != start) {
+                               if (symlink && sanp == start) {
+                                       if (!save_dest)
+                                               free(dest);
+                                       return NULL;
+                               }
                                p += 2;
                                if (sanp != start) {
                                        /* back up sanp one level */
@@ -842,15 +861,10 @@ char *sanitize_path(char *dest, const char *p, const char *rootdir, int depth)
        return dest;
 }
 
-char curr_dir[MAXPATHLEN];
-unsigned int curr_dir_len;
-
-/**
- * Like chdir(), but it keeps track of the current directory (in the
+/* Like chdir(), but it keeps track of the current directory (in the
  * global "curr_dir"), and ensures that the path size doesn't overflow.
- * Also cleans the path using the clean_fname() function.
- **/
-int push_dir(char *dir)
+ * Also cleans the path using the clean_fname() function. */
+int push_dir(char *dir, int set_path_only)
 {
        static int initialised;
        unsigned int len;
@@ -871,7 +885,7 @@ int push_dir(char *dir)
        if ((*dir == '/' ? len : curr_dir_len + 1 + len) >= sizeof curr_dir)
                return 0;
 
-       if (chdir(dir))
+       if (!set_path_only && chdir(dir))
                return 0;
 
        if (*dir == '/') {
@@ -884,6 +898,11 @@ int push_dir(char *dir)
        }
 
        curr_dir_len = clean_fname(curr_dir, 1);
+       if (sanitize_paths) {
+               if (module_dirlen > curr_dir_len)
+                       module_dirlen = curr_dir_len;
+               curr_dir_depth = count_dir_elements(curr_dir + module_dirlen);
+       }
 
        return 1;
 }
@@ -900,6 +919,8 @@ int pop_dir(char *dir)
        curr_dir_len = strlcpy(curr_dir, dir, sizeof curr_dir);
        if (curr_dir_len >= sizeof curr_dir)
                curr_dir_len = sizeof curr_dir - 1;
+       if (sanitize_paths)
+               curr_dir_depth = count_dir_elements(curr_dir + module_dirlen);
 
        return 1;
 }
@@ -921,7 +942,7 @@ char *full_fname(const char *fn)
        if (*fn == '/')
                p1 = p2 = "";
        else {
-               p1 = curr_dir;
+               p1 = curr_dir + module_dirlen;
                for (p2 = p1; *p2 == '/'; p2++) {}
                if (*p2)
                        p2 = "/";
@@ -930,17 +951,11 @@ char *full_fname(const char *fn)
                m1 = " (in ";
                m2 = lp_name(module_id);
                m3 = ")";
-               if (p1 == curr_dir) {
-                       if (!lp_use_chroot(module_id)) {
-                               char *p = lp_path(module_id);
-                               if (*p != '/' || p[1])
-                                       p1 += strlen(p);
-                       }
-               }
        } else
                m1 = m2 = m3 = "";
 
-       asprintf(&result, "\"%s%s%s\"%s%s%s", p1, p2, fn, m1, m2, m3);
+       if (asprintf(&result, "\"%s%s%s\"%s%s%s", p1, p2, fn, m1, m2, m3) <= 0)
+               out_of_memory("full_fname");
 
        return result;
 }
@@ -966,13 +981,11 @@ char *partial_dir_fname(const char *fname)
        if ((int)pathjoin(t, sz, partial_dir, fn) >= sz)
                return NULL;
        if (server_filter_list.head) {
-               static int len;
-               if (!len)
-                       len = strlen(partial_dir);
-               t[len] = '\0';
+               t = strrchr(partial_fname, '/');
+               *t = '\0';
                if (check_filter(&server_filter_list, partial_fname, 1) < 0)
                        return NULL;
-               t[len] = '/';
+               *t = '/';
                if (check_filter(&server_filter_list, partial_fname, 0) < 0)
                        return NULL;
        }
@@ -1102,7 +1115,7 @@ char *human_num(int64 num)
                        units = 'K';
                }
                if (units) {
-                       sprintf(bufs[n], "%.2f%c", dnum, units);
+                       snprintf(bufs[n], sizeof bufs[0], "%.2f%c", dnum, units);
                        return bufs[n];
                }
        }