safe.directory: normalize the configured path

The pathname of a repository comes from getcwd() and it could be a
path aliased via symbolic links, e.g., the real directory may be
/home/u/repository but a symbolic link /home/u/repo may point at it,
and the clone request may come as "git clone file:///home/u/repo/"

A request to check if /home/u/repository is safe would be rejected
if the safe.directory configuration allows /home/u/repo/ but not its
alias /home/u/repository/.  Normalize the paths configured for the
safe.directory configuration variable before comparing them with the
path being checked.

Two and a half things to note, compared to the previous step to
normalize the actual path of the suspected repository, are:

 - A configured safe.directory may be coming from .gitignore in the
   home directory that may be shared across machines.  The path
   meant to match with an entry may not necessarily exist on all of
   such machines, so not being able to convert them to real path on
   this machine is *not* a condition that is worthy of warning.
   Hence, we ignore a path that cannot be converted to a real path.

 - A configured safe.directory is essentially a random string that
   user throws at us, written completely unrelated to the directory
   the current process happens to be in.  Hence it makes little
   sense to give a non-absolute path.  Hence we ignore any
   non-absolute paths, except for ".".

 - The safe.directory set to "." was once advertised on the list as
   a valid workaround for the regression caused by the overly tight
   safe.directory check introduced in 2.45.1; we treat it to mean
   "if we are at the top level of a repository, it is OK".
   (cf. <834862fd-b579-438a-b9b3-5246bf27ce8a@gmail.com>).

Suggested-by: Phillip Wood <phillip.wood123@gmail.com>
Helped-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/setup.c b/setup.c
index 54cce7219b9567139f6eb4a8791b6958fe79e0d9..5f81d9fac0d7e8e07827e2ab78919fbb5051adc2 100644 (file)
--- a/setup.c
+++ b/setup.c
@@ -1235,13 +1235,43 @@ static int safe_directory_cb(const char *key, const char *value,
                char *allowed = NULL;
 
                if (!git_config_pathname(&allowed, key, value)) {
-                       if (ends_with(allowed, "/*")) {
-                               size_t len = strlen(allowed);
-                               if (!fspathncmp(allowed, data->path, len - 1))
+                       char *normalized = NULL;
+
+                       /*
+                        * Setting safe.directory to a non-absolute path
+                        * makes little sense---it won't be relative to
+                        * the configuration file the item is defined in.
+                        * Except for ".", which means "if we are at the top
+                        * level of a repository, then it is OK", which is
+                        * slightly tighter than "*" that allows discovery.
+                        */
+                       if (!is_absolute_path(allowed) && strcmp(allowed, ".")) {
+                               warning(_("safe.directory '%s' not absolute"),
+                                       allowed);
+                               goto next;
+                       }
+
+                       /*
+                        * A .gitconfig in $HOME may be shared across
+                        * different machines and safe.directory entries
+                        * may or may not exist as paths on all of these
+                        * machines.  In other words, it is not a warning
+                        * worthy event when there is no such path on this
+                        * machine---the entry may be useful elsewhere.
+                        */
+                       normalized = real_pathdup(allowed, 0);
+                       if (!normalized)
+                               goto next;
+
+                       if (ends_with(normalized, "/*")) {
+                               size_t len = strlen(normalized);
+                               if (!fspathncmp(normalized, data->path, len - 1))
                                        data->is_safe = 1;
-                       } else if (!fspathcmp(data->path, allowed)) {
+                       } else if (!fspathcmp(data->path, normalized)) {
                                data->is_safe = 1;
                        }
+               next:
+                       free(normalized);
                        free(allowed);
                }
        }

diff --git a/t/t0033-safe-directory.sh b/t/t0033-safe-directory.sh
index 07ac0f9a0163232c24c3d98c4990ecdba848c9fc..ea7465725564cfced2ccd945bd32861aa4cd5bce 100755 (executable)
--- a/t/t0033-safe-directory.sh
+++ b/t/t0033-safe-directory.sh
@@ -176,4 +176,61 @@ test_expect_success SYMLINKS 'checked leading paths are normalized' '
        git -C repo/s/.git/ for-each-ref
 '
 
+test_expect_success SYMLINKS 'configured paths are normalized' '
+       test_when_finished "rm -rf repository; rm -f repo" &&
+       (
+               sane_unset GIT_TEST_ASSUME_DIFFERENT_OWNER &&
+               git config --global --unset-all safe.directory
+       ) &&
+       git init repository &&
+       ln -s repository repo &&
+       (
+               cd repository &&
+               sane_unset GIT_TEST_ASSUME_DIFFERENT_OWNER &&
+               test_commit sample
+       ) &&
+
+       (
+               sane_unset GIT_TEST_ASSUME_DIFFERENT_OWNER &&
+               git config --global safe.directory "$(pwd)/repo"
+       ) &&
+       git -C repository for-each-ref &&
+       git -C repository/ for-each-ref &&
+       git -C repo for-each-ref &&
+       git -C repo/ for-each-ref &&
+       test_must_fail git -C repository/.git for-each-ref &&
+       test_must_fail git -C repository/.git/ for-each-ref &&
+       test_must_fail git -C repo/.git for-each-ref &&
+       test_must_fail git -C repo/.git/ for-each-ref
+'
+
+test_expect_success SYMLINKS 'configured leading paths are normalized' '
+       test_when_finished "rm -rf repository; rm -f repo" &&
+       (
+               sane_unset GIT_TEST_ASSUME_DIFFERENT_OWNER &&
+               git config --global --unset-all safe.directory
+       ) &&
+       mkdir -p repository &&
+       git init repository/s &&
+       ln -s repository repo &&
+       (
+               cd repository/s &&
+               sane_unset GIT_TEST_ASSUME_DIFFERENT_OWNER &&
+               test_commit sample
+       ) &&
+
+       (
+               sane_unset GIT_TEST_ASSUME_DIFFERENT_OWNER &&
+               git config --global safe.directory "$(pwd)/repo/*"
+       ) &&
+       git -C repository/s for-each-ref &&
+       git -C repository/s/ for-each-ref &&
+       git -C repository/s/.git for-each-ref &&
+       git -C repository/s/.git/ for-each-ref &&
+       git -C repo/s for-each-ref &&
+       git -C repo/s/ for-each-ref &&
+       git -C repo/s/.git for-each-ref &&
+       git -C repo/s/.git/ for-each-ref
+'
+
 test_done