diff options
author | Klaus Aehlig <klaus.aehlig@huawei.com> | 2024-02-19 13:04:07 +0100 |
---|---|---|
committer | Klaus Aehlig <klaus.aehlig@huawei.com> | 2024-02-20 17:18:10 +0100 |
commit | ca54778751856d77f7da2dba051c473a488f7d1e (patch) | |
tree | 3ff7820684956c2851e73cbfa49597fe46ec5299 /src/other_tools/root_maps/commit_git_map.cpp | |
parent | 08f3b06e3f6d5d702e754e8809b3c2e3cee73066 (diff) | |
download | justbuild-ca54778751856d77f7da2dba051c473a488f7d1e.tar.gz |
Git URL scheme handling: whitelist path instead of non-path protocols
At some point we have to decide if a given git repository URL is
a path. So far, we assumed that anything not starting with ssh://,
http://, or https:// is a path. This ignores the facts that
- the file:// scheme, while referring to a file, does not denote
a relative path starting file://,
- the [user@]host:path scheme is not a path on the local machine,
- there exist the URL schemes git://, ftp://, and ftps://, and
- future extension might add additional schemes.
To also correctly handle new schemes that git might add (which we
indeed can handle, as we simply shell out to the git binary), we
reverse the approach: we give the user the means to unambigiously
specify that they refer to a path on the local machine, by either
- using the file:// scheme,
- providing an absolute path starting with /, or
- providing a relative path starting with ./
All other schemes will not be modified. The file scheme, as well
as the git://, http://, and https:// scheme, are handled interally
using libgit2; all others are passed on to git in an unmodified form.
Diffstat (limited to 'src/other_tools/root_maps/commit_git_map.cpp')
-rw-r--r-- | src/other_tools/root_maps/commit_git_map.cpp | 42 |
1 files changed, 29 insertions, 13 deletions
diff --git a/src/other_tools/root_maps/commit_git_map.cpp b/src/other_tools/root_maps/commit_git_map.cpp index ddbe3a88..08680531 100644 --- a/src/other_tools/root_maps/commit_git_map.cpp +++ b/src/other_tools/root_maps/commit_git_map.cpp @@ -15,6 +15,8 @@ #include "src/other_tools/root_maps/commit_git_map.hpp" #include <algorithm> +#include <optional> +#include <string> #include "fmt/core.h" #include "src/buildtool/file_system/file_root.hpp" @@ -31,13 +33,23 @@ namespace { -[[nodiscard]] auto GitURLIsPath(std::string const& url) noexcept -> bool { - auto prefixes = std::vector<std::string>{"ssh://", "http://", "https://"}; - // return true if no URL prefix exists - return std::none_of( - prefixes.begin(), prefixes.end(), [url](auto const& prefix) { - return (url.rfind(prefix, 0) == 0); - }); +[[nodiscard]] auto GitURLIsPath(std::string const& url) noexcept + -> std::optional<std::string> { + static auto const kAbsPath = std::string{"/"}; + static auto const kRelPath = std::string{"./"}; + static auto const kFileScheme = std::string{"file://"}; + + if (url.starts_with(kAbsPath)) { + return url; + } + if (url.starts_with(kRelPath)) { + return url.substr(kRelPath.length()); + } + if (url.starts_with(kFileScheme)) { + return url.substr(kFileScheme.length()); + } + + return std::nullopt; } /// \brief Helper function for ensuring the serve endpoint, if given, has the @@ -485,8 +497,9 @@ void EnsureCommit( auto local_mirrors = MirrorsUtils::GetLocalMirrors(additional_mirrors, fetch_repo); for (auto mirror : local_mirrors) { - if (GitURLIsPath(mirror)) { - mirror = std::filesystem::absolute(mirror).string(); + auto mirror_path = GitURLIsPath(mirror); + if (mirror_path) { + mirror = std::filesystem::absolute(*mirror_path).string(); } auto wrapped_logger = std::make_shared<AsyncMapConsumerLogger>( [mirror, &err_messages](auto const& msg, bool /*fatal*/) { @@ -572,8 +585,10 @@ void EnsureCommit( remotes_buffer.append(fmt::format("\n> {}", fetch_repo)); // now try to fetch from mirrors, in order, if given for (auto mirror : repo_info.mirrors) { - if (GitURLIsPath(mirror)) { - mirror = std::filesystem::absolute(mirror).string(); + auto mirror_path = GitURLIsPath(mirror); + if (mirror_path) { + mirror = std::filesystem::absolute(*mirror_path) + .string(); } else { // if non-path, try each of the preferred hostnames @@ -811,8 +826,9 @@ auto CreateCommitGitMap( // get root for repo (making sure that if repo is a path, it is // absolute) std::string fetch_repo = key.repo_url; - if (GitURLIsPath(fetch_repo)) { - fetch_repo = std::filesystem::absolute(fetch_repo).string(); + auto fetch_repo_path = GitURLIsPath(fetch_repo); + if (fetch_repo_path) { + fetch_repo = std::filesystem::absolute(*fetch_repo_path).string(); } std::filesystem::path repo_root = StorageUtils::GetGitRoot(just_mr_paths, fetch_repo); |