Merge pull request #5473 from libgit2/ethomson/v0.28.5 fetchhead: strip credentials from remote URL
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
diff --git a/docs/changelog.md b/docs/changelog.md
index e882875..b842e31 100644
--- a/docs/changelog.md
+++ b/docs/changelog.md
@@ -43,6 +43,11 @@ This is a bugfix release with the following changes:
- Fixes for several memory leaks.
+- When fetching from an anonymous remote using a URL with authentication
+ information provided in the URL (eg `https://foo:bar@example.com/repo`),
+ we would erroneously include the literal URL in the FETCH_HEAD file.
+ We now remove that to match git's behavior.
+
v0.28.4
--------
diff --git a/src/fetchhead.c b/src/fetchhead.c
index bdded02..5dd82fc 100644
--- a/src/fetchhead.c
+++ b/src/fetchhead.c
@@ -13,6 +13,7 @@
#include "buffer.h"
#include "fileops.h"
#include "filebuf.h"
+#include "netops.h"
#include "refs.h"
#include "repository.h"
@@ -36,6 +37,33 @@ int git_fetchhead_ref_cmp(const void *a, const void *b)
return 0;
}
+static char *sanitized_remote_url(const char *remote_url)
+{
+ gitno_connection_data url = {0};
+ char *sanitized = NULL;
+ int error;
+
+ if (gitno_connection_data_from_url(&url, remote_url, NULL) == 0) {
+ git_buf buf = GIT_BUF_INIT;
+
+ git__free(url.user);
+ git__free(url.pass);
+ url.user = url.pass = NULL;
+
+ if ((error = gitno_connection_data_fmt(&buf, &url)) < 0)
+ goto fallback;
+
+ sanitized = git_buf_detach(&buf);
+ }
+
+fallback:
+ if (!sanitized)
+ sanitized = git__strdup(remote_url);
+
+ gitno_connection_data_free_ptrs(&url);
+ return sanitized;
+}
+
int git_fetchhead_ref_create(
git_fetchhead_ref **out,
git_oid *oid,
@@ -57,11 +85,15 @@ int git_fetchhead_ref_create(
git_oid_cpy(&fetchhead_ref->oid, oid);
fetchhead_ref->is_merge = is_merge;
- if (ref_name)
+ if (ref_name) {
fetchhead_ref->ref_name = git__strdup(ref_name);
+ GIT_ERROR_CHECK_ALLOC(fetchhead_ref->ref_name);
+ }
- if (remote_url)
- fetchhead_ref->remote_url = git__strdup(remote_url);
+ if (remote_url) {
+ fetchhead_ref->remote_url = sanitized_remote_url(remote_url);
+ GIT_ERROR_CHECK_ALLOC(fetchhead_ref->remote_url);
+ }
*out = fetchhead_ref;
diff --git a/src/netops.c b/src/netops.c
index ecbc2ae..f63ff38 100644
--- a/src/netops.c
+++ b/src/netops.c
@@ -206,6 +206,35 @@ cleanup:
return error;
}
+int gitno_connection_data_fmt(git_buf *buf, gitno_connection_data *d)
+{
+ if (d->host) {
+ git_buf_puts(buf, d->use_ssl ? prefix_https : prefix_http);
+
+ if (d->user) {
+ git_buf_puts(buf, d->user);
+
+ if (d->pass) {
+ git_buf_puts(buf, ":");
+ git_buf_puts(buf, d->pass);
+ }
+
+ git_buf_putc(buf, '@');
+ }
+
+ git_buf_puts(buf, d->host);
+
+ if (d->port && strcmp(d->port, gitno__default_port(d))) {
+ git_buf_putc(buf, ':');
+ git_buf_puts(buf, d->port);
+ }
+ }
+
+ git_buf_puts(buf, d->path ? d->path : "/");
+
+ return git_buf_oom(buf) ? -1 : 0;
+}
+
void gitno_connection_data_free_ptrs(gitno_connection_data *d)
{
git__free(d->host); d->host = NULL;
diff --git a/src/netops.h b/src/netops.h
index f376bd9..fcdbccf 100644
--- a/src/netops.h
+++ b/src/netops.h
@@ -84,6 +84,9 @@ int gitno_connection_data_from_url(
const char *url,
const char *service_suffix);
+/* Format a URL into a buffer */
+int gitno_connection_data_fmt(git_buf *buf, gitno_connection_data *data);
+
/* This frees all the pointers IN the struct, but not the struct itself. */
void gitno_connection_data_free_ptrs(gitno_connection_data *data);
diff --git a/tests/fetchhead/nonetwork.c b/tests/fetchhead/nonetwork.c
index 6589432..ccfb4f7 100644
--- a/tests/fetchhead/nonetwork.c
+++ b/tests/fetchhead/nonetwork.c
@@ -108,7 +108,7 @@ void test_fetchhead_nonetwork__write(void)
typedef struct {
git_vector *fetchhead_vector;
size_t idx;
-} fetchhead_ref_cb_data;
+} fetchhead_ref_cb_data;
static int fetchhead_ref_cb(const char *name, const char *url,
const git_oid *oid, unsigned int is_merge, void *payload)
@@ -493,3 +493,21 @@ void test_fetchhead_nonetwork__create_with_multiple_refspecs(void)
git_remote_free(remote);
git_buf_dispose(&path);
}
+
+void test_fetchhead_nonetwork__credentials_are_stripped(void)
+{
+ git_fetchhead_ref *ref;
+ git_oid oid;
+
+ cl_git_pass(git_oid_fromstr(&oid, "49322bb17d3acc9146f98c97d078513228bbf3c0"));
+ cl_git_pass(git_fetchhead_ref_create(&ref, &oid, 0,
+ "refs/tags/commit_tree", "http://foo:bar@github.com/libgit2/TestGitRepository"));
+ cl_assert_equal_s(ref->remote_url, "http://github.com/libgit2/TestGitRepository");
+ git_fetchhead_ref_free(ref);
+
+ cl_git_pass(git_oid_fromstr(&oid, "49322bb17d3acc9146f98c97d078513228bbf3c0"));
+ cl_git_pass(git_fetchhead_ref_create(&ref, &oid, 0,
+ "refs/tags/commit_tree", "https://foo:bar@github.com/libgit2/TestGitRepository"));
+ cl_assert_equal_s(ref->remote_url, "https://github.com/libgit2/TestGitRepository");
+ git_fetchhead_ref_free(ref);
+}
diff --git a/tests/online/fetchhead.c b/tests/online/fetchhead.c
index ae72dde..5e35866 100644
--- a/tests/online/fetchhead.c
+++ b/tests/online/fetchhead.c
@@ -154,3 +154,20 @@ void test_online_fetchhead__colon_only_dst_refspec_creates_no_branch(void)
cl_assert_equal_i(refs, count_references());
}
+
+void test_online_fetchhead__creds_get_stripped(void)
+{
+ git_buf buf = GIT_BUF_INIT;
+ git_remote *remote;
+
+ cl_git_pass(git_repository_init(&g_repo, "./foo", 0));
+ cl_git_pass(git_remote_create_anonymous(&remote, g_repo, "https://libgit3:libgit3@bitbucket.org/libgit2/testgitrepository.git"));
+ cl_git_pass(git_remote_fetch(remote, NULL, NULL, NULL));
+
+ cl_git_pass(git_futils_readbuffer(&buf, "./foo/.git/FETCH_HEAD"));
+ cl_assert_equal_s(buf.ptr,
+ "49322bb17d3acc9146f98c97d078513228bbf3c0\t\thttps://bitbucket.org/libgit2/testgitrepository.git\n");
+
+ git_remote_free(remote);
+ git_buf_dispose(&buf);
+}