Go to file
Jeff King 0383bbb901 submodule-config: verify submodule names as paths
Submodule "names" come from the untrusted .gitmodules file,
but we blindly append them to $GIT_DIR/modules to create our
on-disk repo paths. This means you can do bad things by
putting "../" into the name (among other things).

Let's sanity-check these names to avoid building a path that
can be exploited. There are two main decisions:

  1. What should the allowed syntax be?

     It's tempting to reuse verify_path(), since submodule
     names typically come from in-repo paths. But there are
     two reasons not to:

       a. It's technically more strict than what we need, as
          we really care only about breaking out of the
          $GIT_DIR/modules/ hierarchy.  E.g., having a
          submodule named "foo/.git" isn't actually
          dangerous, and it's possible that somebody has
          manually given such a funny name.

       b. Since we'll eventually use this checking logic in
          fsck to prevent downstream repositories, it should
          be consistent across platforms. Because
          verify_path() relies on is_dir_sep(), it wouldn't
          block "foo\..\bar" on a non-Windows machine.

  2. Where should we enforce it? These days most of the
     .gitmodules reads go through submodule-config.c, so
     I've put it there in the reading step. That should
     cover all of the C code.

     We also construct the name for "git submodule add"
     inside the git-submodule.sh script. This is probably
     not a big deal for security since the name is coming
     from the user anyway, but it would be polite to remind
     them if the name they pick is invalid (and we need to
     expose the name-checker to the shell anyway for our
     test scripts).

     This patch issues a warning when reading .gitmodules
     and just ignores the related config entry completely.
     This will generally end up producing a sensible error,
     as it works the same as a .gitmodules file which is
     missing a submodule entry (so "submodule update" will
     barf, but "git clone --recurse-submodules" will print
     an error but not abort the clone.

     There is one minor oddity, which is that we print the
     warning once per malformed config key (since that's how
     the config subsystem gives us the entries). So in the
     new test, for example, the user would see three
     warnings. That's OK, since the intent is that this case
     should never come up outside of malicious repositories
     (and then it might even benefit the user to see the
     message multiple times).

Credit for finding this vulnerability and the proof of
concept from which the test script was adapted goes to
Etienne Stalmans.

Signed-off-by: Jeff King <peff@peff.net>
2018-05-21 23:50:11 -04:00
.github Configure Git contribution guidelines for github.com 2017-06-13 08:41:47 -07:00
Documentation Git 2.13.6 2017-09-22 14:49:24 +09:00
block-sha1
builtin submodule-config: verify submodule names as paths 2018-05-21 23:50:11 -04:00
ci Merge branch 'ls/travis-doc-asciidoctor' into maint 2017-06-05 09:03:10 +09:00
compat cygwin: allow pushing to UNC paths 2017-07-05 14:01:03 -07:00
contrib Merge branch 'aw/contrib-subtree-doc-asciidoctor' into maint 2017-07-10 13:59:06 -07:00
ewah
git-gui Fix build with core.autocrlf=true 2017-05-10 13:32:50 +09:00
gitk-git
gitweb doc: use https links to Wikipedia to avoid http redirects 2017-05-15 13:04:54 +09:00
mergetools mergetools/meld: improve compatibiilty with Meld on macOS X 2017-06-18 22:11:29 -07:00
perl Git::unquote_path(): throw an exception on bad path 2017-06-30 08:04:59 -07:00
po l10n: de.po: fix typo 2017-07-10 11:44:18 -07:00
ppc
refs Merge branch 'mh/separate-ref-cache' 2017-04-26 15:39:13 +09:00
sha1dc sha1dc: update from upstream 2017-07-03 10:09:22 -07:00
t submodule-config: verify submodule names as paths 2018-05-21 23:50:11 -04:00
templates pre-rebase hook: capture documentation in a <<here document 2017-07-11 08:56:33 -07:00
vcs-svn
xdiff
.gitattributes Fix build with core.autocrlf=true 2017-05-10 13:32:50 +09:00
.gitignore
.mailmap
.travis.yml Merge branch 'ls/travis-doc-asciidoctor' into maint 2017-06-05 09:03:10 +09:00
COPYING
GIT-VERSION-GEN Git 2.13.6 2017-09-22 14:49:24 +09:00
INSTALL
LGPL-2.1
Makefile sha1dc: update from upstream 2017-05-22 10:20:46 +09:00
README.md
RelNotes Git 2.13.6 2017-09-22 14:49:24 +09:00
abspath.c
aclocal.m4
advice.c
advice.h
alias.c alias: compare alias name *case-insensitively* 2017-07-17 14:00:12 -07:00
alloc.c
apply.c Merge branch 'rs/apply-avoid-over-reading' into maint 2017-07-31 13:51:04 -07:00
apply.h
archive-tar.c
archive-zip.c
archive.c
archive.h
argv-array.c
argv-array.h
attr.c
attr.h
base85.c
bisect.c Merge branch 'ab/c-translators-comment-style' into maint 2017-06-05 09:03:10 +09:00
bisect.h
blob.c
blob.h
branch.c create_branch: use xstrfmt for reflog message 2017-03-30 14:59:50 -07:00
branch.h
builtin.h
bulk-checkin.c
bulk-checkin.h
bundle.c
bundle.h
cache-tree.c
cache-tree.h
cache.h Git 2.12.4 2017-08-01 12:27:31 -07:00
check-builtins.sh
check-racy.c
check_bindir
color.c
color.h
column.c
column.h
combine-diff.c Merge branch 'bc/object-id' 2017-04-19 21:37:13 -07:00
command-list.txt
commit-slab.h
commit.c interpret-trailers: honor the cut line 2017-05-18 15:00:48 +09:00
commit.h Rename sha1_array to oid_array 2017-03-31 08:33:56 -07:00
common-main.c
config.c Merge branch 'js/alias-early-config' into maint 2017-07-10 13:58:58 -07:00
config.mak.in
config.mak.uname cygwin: allow pushing to UNC paths 2017-07-05 14:01:03 -07:00
configure.ac
connect.c Git 2.12.4 2017-08-01 12:27:31 -07:00
connect.h
connected.c
connected.h
convert.c
convert.h
copy.c
credential-cache--daemon.c
credential-cache.c Merge branch 'nd/conditional-config-include' 2017-04-23 22:07:46 -07:00
credential-store.c path.c: and an option to call real_path() in expand_user_path() 2017-04-14 23:51:38 -07:00
credential.c
credential.h
csum-file.c
csum-file.h
ctype.c
daemon.c Merge branch 'dt/xgethostname-nul-termination' 2017-04-23 22:07:57 -07:00
date.c
decorate.c
decorate.h
delta.h
diff-delta.c
diff-lib.c
diff-no-index.c
diff.c fix minor typos 2017-05-01 11:01:52 +09:00
diff.h Rename sha1_array to oid_array 2017-03-31 08:33:56 -07:00
diffcore-break.c
diffcore-delta.c
diffcore-order.c
diffcore-pickaxe.c
diffcore-rename.c
diffcore.h
dir-iterator.c
dir-iterator.h
dir.c Merge branch 'sl/clean-d-ignored-fix' into maint 2017-06-13 13:27:02 -07:00
dir.h dir: expose cmp_name() and check_contains() 2017-05-22 12:14:13 +09:00
editor.c
entry.c
environment.c setup_git_env: convert die("BUG") to BUG() 2017-05-15 11:30:00 +09:00
exec_cmd.c
exec_cmd.h
fast-import.c Merge branch 'jk/war-on-git-path' 2017-04-26 15:39:08 +09:00
fetch-pack.c Merge branch 'dt/xgethostname-nul-termination' 2017-04-23 22:07:57 -07:00
fetch-pack.h Rename sha1_array to oid_array 2017-03-31 08:33:56 -07:00
fmt-merge-msg.h
fsck.c Rename sha1_array to oid_array 2017-03-31 08:33:56 -07:00
fsck.h Rename sha1_array to oid_array 2017-03-31 08:33:56 -07:00
generate-cmdlist.sh
gettext.c
gettext.h
git-add--interactive.perl Merge branch 'pw/unquote-path-in-git-pm' into maint 2017-07-31 13:51:05 -07:00
git-archimport.perl archimport: use safe_pipe_capture for user input 2017-09-12 11:08:15 +09:00
git-bisect.sh
git-compat-util.h cygwin: allow pushing to UNC paths 2017-07-05 14:01:03 -07:00
git-cvsexportcommit.perl
git-cvsimport.perl cvsimport: shell-quote variable used in backticks 2017-09-12 11:10:22 +09:00
git-cvsserver.perl cvsserver: use safe_pipe_capture for `constant commands` as well 2017-09-11 14:52:29 +09:00
git-difftool--helper.sh
git-filter-branch.sh git-filter-branch: be more direct in an error message 2017-05-12 15:27:10 +09:00
git-instaweb.sh
git-merge-octopus.sh
git-merge-one-file.sh
git-merge-resolve.sh
git-mergetool--lib.sh
git-mergetool.sh
git-p4.py git-p4: don't use name-rev to get current branch 2017-04-16 21:13:26 -07:00
git-parse-remote.sh
git-quiltimport.sh
git-rebase--am.sh
git-rebase--interactive.sh doc: replace more gmane links 2017-05-09 21:13:13 -07:00
git-rebase--merge.sh
git-rebase.sh Merge branch 'pw/rebase-i-regression-fix-tests' into maint 2017-07-10 13:59:00 -07:00
git-remote-testgit.sh
git-request-pull.sh
git-send-email.perl send-email: Net::SMTP::starttls was introduced in v2.34 2017-06-01 11:23:35 +09:00
git-sh-i18n.sh
git-sh-setup.sh
git-stash.sh git-stash: fix pushing stash with pathspec from subdir 2017-06-13 08:27:13 -07:00
git-submodule.sh submodule-config: verify submodule names as paths 2018-05-21 23:50:11 -04:00
git-svn.perl
git-web--browse.sh
git.c alias: use the early config machinery to expand aliases 2017-06-15 12:31:50 -07:00
git.rc
gpg-interface.c
gpg-interface.h
graph.c
graph.h
grep.c convert unchecked snprintf into xsnprintf 2017-03-30 14:59:50 -07:00
grep.h
hash.h
hashmap.c
hashmap.h
help.c Merge branch 'mb/reword-autocomplete-message' into maint 2017-07-10 13:59:04 -07:00
help.h
hex.c
http-backend.c
http-fetch.c
http-push.c
http-walker.c
http.c Merge branch 'dt/http-postbuffer-can-be-large' 2017-04-23 22:07:45 -07:00
http.h http.postbuffer: allow full range of ssize_t values 2017-04-13 18:24:32 -07:00
ident.c Merge branch 'dt/xgethostname-nul-termination' 2017-04-23 22:07:57 -07:00
imap-send.c convert unchecked snprintf into xsnprintf 2017-03-30 14:59:50 -07:00
iterator.h
khash.h
kwset.c
kwset.h
levenshtein.c
levenshtein.h
line-log.c line-log: avoid memory leak 2017-05-08 12:18:20 +09:00
line-log.h
line-range.c
line-range.h
list-objects.c
list-objects.h
list.h
ll-merge.c
ll-merge.h
lockfile.c
lockfile.h
log-tree.c
log-tree.h
mailinfo.c mailinfo & mailsplit: check for EOF while parsing 2017-05-08 12:18:19 +09:00
mailinfo.h
mailmap.c
mailmap.h
match-trees.c
merge-blobs.c
merge-blobs.h
merge-recursive.c merge-recursive: use DIFF_XDL_SET macro 2017-06-30 10:56:37 -07:00
merge-recursive.h
merge.c
mergesort.c
mergesort.h
mru.c
mru.h
name-hash.c name-hash: fix buffer overrun 2017-03-31 20:57:18 -07:00
notes-cache.c
notes-cache.h
notes-merge.c replace strbuf_addstr(git_path()) with git_path_buf() 2017-04-20 21:04:20 -07:00
notes-merge.h
notes-utils.c C style: use standard style for "TRANSLATORS" comments 2017-05-31 08:01:42 +09:00
notes-utils.h
notes.c
notes.h
object.c
object.h
oidset.c
oidset.h
pack-bitmap-write.c odb_mkstemp: write filename into strbuf 2017-03-28 15:28:04 -07:00
pack-bitmap.c Merge branch 'jc/pack-bitmap-unaligned' into maint 2017-07-10 13:59:00 -07:00
pack-bitmap.h
pack-check.c
pack-objects.c
pack-objects.h
pack-revindex.c
pack-revindex.h
pack-write.c odb_mkstemp: write filename into strbuf 2017-03-28 15:28:04 -07:00
pack.h
pager.c Merge branch 'jk/pager-in-use' 2017-03-28 14:05:59 -07:00
parse-options-cb.c Rename sha1_array to oid_array 2017-03-31 08:33:56 -07:00
parse-options.c C style: use standard style for "TRANSLATORS" comments 2017-05-31 08:01:42 +09:00
parse-options.h
patch-delta.c
patch-ids.c add_commit_patch_id(): avoid allocating memory unnecessarily 2017-05-08 12:18:19 +09:00
patch-ids.h
path.c Git 2.12.4 2017-08-01 12:27:31 -07:00
pathspec.c Merge branch 'ps/pathspec-empty-prefix-origin' 2017-04-26 15:39:03 +09:00
pathspec.h
pkt-line.c
pkt-line.h
preload-index.c
pretty.c Merge branch 'rs/pretty-add-again' into maint 2017-07-10 13:58:57 -07:00
prio-queue.c Merge branch 'jk/prio-queue-avoid-swap-with-self' 2017-05-01 14:14:43 +09:00
prio-queue.h
progress.c progress: show overall rate in last update 2017-07-09 09:54:20 -07:00
progress.h
prompt.c
prompt.h
quote.c
quote.h
reachable.c
reachable.h
read-cache.c read-cache: use shared perms when writing shared index 2017-06-25 10:42:52 -07:00
ref-filter.c Merge branch 'kn/ref-filter-branch-list' into maint 2017-07-12 15:23:09 -07:00
ref-filter.h Merge branch 'bc/object-id' 2017-04-19 21:37:13 -07:00
reflog-walk.c reflog-walk: include all fields when freeing complete_reflogs 2017-07-07 09:04:34 -07:00
reflog-walk.h
refs.c Merge branch 'mh/separate-ref-cache' 2017-04-26 15:39:13 +09:00
refs.h refs_verify_refname_available(): implement once for all backends 2017-04-16 21:32:45 -07:00
remote-curl.c Merge branch 'dt/http-postbuffer-can-be-large' 2017-04-23 22:07:45 -07:00
remote-testsvn.c
remote.c Merge branch 'jk/drop-free-refspecs' into maint 2017-06-13 13:27:06 -07:00
remote.h Merge branch 'bw/push-options-recursively-to-submodules' 2017-04-19 21:37:14 -07:00
replace_object.c
rerere.c
rerere.h
resolve-undo.c
resolve-undo.h
revision.c Merge branch 'sg/revision-parser-skip-prefix' into maint 2017-06-24 15:29:34 -07:00
revision.h Merge branch 'sg/revision-parser-skip-prefix' into maint 2017-06-24 15:29:34 -07:00
run-command.c run-command: restrict PATH search to executable files 2017-04-25 23:17:36 -07:00
run-command.h run-command: expose is_executable function 2017-04-25 18:45:29 -07:00
send-pack.c Merge branch 'bc/object-id' 2017-04-19 21:37:13 -07:00
send-pack.h Rename sha1_array to oid_array 2017-03-31 08:33:56 -07:00
sequencer.c Merge branch 'pw/rebase-i-regression-fix-tests' into maint 2017-07-10 13:59:00 -07:00
sequencer.h
server-info.c server-info: avoid calling fclose(3) twice in update_info_file() 2017-04-17 17:37:28 -07:00
setup.c Merge branch 'js/alias-early-config' into maint 2017-07-10 13:58:58 -07:00
sh-i18n--envsubst.c
sha1-array.c Rename sha1_array to oid_array 2017-03-31 08:33:56 -07:00
sha1-array.h Rename sha1_array to oid_array 2017-03-31 08:33:56 -07:00
sha1-lookup.c
sha1-lookup.h
sha1_file.c Merge branch 'ew/fd-cloexec-fix' into maint 2017-07-21 15:03:40 -07:00
sha1_name.c get_sha1_with_context: dynamically allocate oc->path 2017-05-24 10:59:27 +09:00
sha1dc_git.c sha1dc: update from upstream 2017-05-22 10:20:46 +09:00
sha1dc_git.h sha1dc: update from upstream 2017-05-22 10:20:46 +09:00
shallow.c shallow: avoid memory leak 2017-05-08 12:18:20 +09:00
shell.c shell: drop git-cvsserver support by default 2017-09-12 11:05:58 +09:00
shortlog.h
show-index.c
sideband.c
sideband.h
sigchain.c
sigchain.h
split-index.c
split-index.h
strbuf.c Merge branch 'rs/pretty-add-again' into maint 2017-07-10 13:58:57 -07:00
strbuf.h Merge branch 'rs/pretty-add-again' into maint 2017-07-10 13:58:57 -07:00
streaming.c
streaming.h
string-list.c Merge branch 'bw/forking-and-threading' into maint 2017-06-13 13:27:00 -07:00
string-list.h string-list: add string_list_remove function 2017-04-20 17:55:32 -07:00
submodule-config.c submodule-config: verify submodule names as paths 2018-05-21 23:50:11 -04:00
submodule-config.h submodule-config: verify submodule names as paths 2018-05-21 23:50:11 -04:00
submodule.c submodule: properly recurse for read-tree and checkout 2017-05-04 13:42:05 +09:00
submodule.h Merge branch 'nd/files-backend-git-dir' 2017-04-19 21:37:19 -07:00
symlinks.c
tag.c
tag.h
tar.h
tempfile.c
tempfile.h
thread-utils.c
thread-utils.h
tmp-objdir.c
tmp-objdir.h
trace.c
trace.h
trailer.c
trailer.h
transport-helper.c transport-helper: replace checked snprintf with xsnprintf 2017-03-30 14:59:50 -07:00
transport.c Merge branch 'bw/push-options-recursively-to-submodules' 2017-04-19 21:37:14 -07:00
transport.h
tree-diff.c
tree-walk.c Merge branch 'jk/diff-blob' into maint 2017-06-24 15:29:28 -07:00
tree-walk.h
tree.c
tree.h
unicode_width.h unicode: update the width tables to Unicode 10 2017-07-07 10:33:30 -07:00
unimplemented.sh
unix-socket.c
unix-socket.h
unpack-trees.c Merge branch 'jh/unpack-trees-micro-optim' 2017-04-23 22:07:48 -07:00
unpack-trees.h
upload-pack.c
url.c
url.h
urlmatch.c
urlmatch.h
usage.c Merge branch 'bw/forking-and-threading' into maint 2017-06-13 13:27:00 -07:00
userdiff.c
userdiff.h
utf8.c
utf8.h
varint.c
varint.h
version.c
version.h
versioncmp.c
walker.c
walker.h
wildmatch.c
wildmatch.h
worktree.c submodule_uses_worktrees(): plug memory leak 2017-05-08 12:18:20 +09:00
worktree.h
wrap-for-bin.sh
wrapper.c Merge branch 'dt/xgethostname-nul-termination' 2017-04-23 22:07:57 -07:00
write_or_die.c
ws.c
wt-status.c Merge branch 'bm/interpret-trailers-cut-line-is-eom' into maint 2017-06-05 09:03:13 +09:00
wt-status.h interpret-trailers: honor the cut line 2017-05-18 15:00:48 +09:00
xdiff-interface.c
xdiff-interface.h
zlib.c

README.md

Git - fast, scalable, distributed revision control system

Git is a fast, scalable, distributed revision control system with an unusually rich command set that provides both high-level operations and full access to internals.

Git is an Open Source project covered by the GNU General Public License version 2 (some parts of it are under different licenses, compatible with the GPLv2). It was originally written by Linus Torvalds with help of a group of hackers around the net.

Please read the file INSTALL for installation instructions.

Many Git online resources are accessible from https://git-scm.com/ including full documentation and Git related tools.

See Documentation/gittutorial.txt to get started, then see Documentation/giteveryday.txt for a useful minimum set of commands, and Documentation/git-.txt for documentation of each command. If git has been correctly installed, then the tutorial can also be read with man gittutorial or git help tutorial, and the documentation of each command with man git-<commandname> or git help <commandname>.

CVS users may also want to read Documentation/gitcvs-migration.txt (man gitcvs-migration or git help cvs-migration if git is installed).

The user discussion and development of Git take place on the Git mailing list -- everyone is welcome to post bug reports, feature requests, comments and patches to git@vger.kernel.org (read Documentation/SubmittingPatches for instructions on patch submission). To subscribe to the list, send an email with just "subscribe git" in the body to majordomo@vger.kernel.org. The mailing list archives are available at https://public-inbox.org/git/, http://marc.info/?l=git and other archival sites.

The maintainer frequently sends the "What's cooking" reports that list the current status of various development topics to the mailing list. The discussion following them give a good reference for project status, development direction and remaining tasks.

The name "git" was given by Linus Torvalds when he wrote the very first version. He described the tool as "the stupid content tracker" and the name as (depending on your mood):

  • random three-letter combination that is pronounceable, and not actually used by any common UNIX command. The fact that it is a mispronunciation of "get" may or may not be relevant.
  • stupid. contemptible and despicable. simple. Take your pick from the dictionary of slang.
  • "global information tracker": you're in a good mood, and it actually works for you. Angels sing, and a light suddenly fills the room.
  • "goddamn idiotic truckload of sh*t": when it breaks