git-diff.txt: don't mark required argument as optional
[git/debian.git] / fsck.c
blob73f30773f28acc06f4b9c04dda1e1a54b46c6930
1 #include "cache.h"
2 #include "object-store.h"
3 #include "repository.h"
4 #include "object.h"
5 #include "blob.h"
6 #include "tree.h"
7 #include "tree-walk.h"
8 #include "commit.h"
9 #include "tag.h"
10 #include "fsck.h"
11 #include "refs.h"
12 #include "url.h"
13 #include "utf8.h"
14 #include "decorate.h"
15 #include "oidset.h"
16 #include "packfile.h"
17 #include "submodule-config.h"
18 #include "config.h"
19 #include "credential.h"
20 #include "help.h"
22 static struct oidset gitmodules_found = OIDSET_INIT;
23 static struct oidset gitmodules_done = OIDSET_INIT;
25 #define FSCK_FATAL -1
26 #define FSCK_INFO -2
28 #define FOREACH_MSG_ID(FUNC) \
29 /* fatal errors */ \
30 FUNC(NUL_IN_HEADER, FATAL) \
31 FUNC(UNTERMINATED_HEADER, FATAL) \
32 /* errors */ \
33 FUNC(BAD_DATE, ERROR) \
34 FUNC(BAD_DATE_OVERFLOW, ERROR) \
35 FUNC(BAD_EMAIL, ERROR) \
36 FUNC(BAD_NAME, ERROR) \
37 FUNC(BAD_OBJECT_SHA1, ERROR) \
38 FUNC(BAD_PARENT_SHA1, ERROR) \
39 FUNC(BAD_TAG_OBJECT, ERROR) \
40 FUNC(BAD_TIMEZONE, ERROR) \
41 FUNC(BAD_TREE, ERROR) \
42 FUNC(BAD_TREE_SHA1, ERROR) \
43 FUNC(BAD_TYPE, ERROR) \
44 FUNC(DUPLICATE_ENTRIES, ERROR) \
45 FUNC(MISSING_AUTHOR, ERROR) \
46 FUNC(MISSING_COMMITTER, ERROR) \
47 FUNC(MISSING_EMAIL, ERROR) \
48 FUNC(MISSING_NAME_BEFORE_EMAIL, ERROR) \
49 FUNC(MISSING_OBJECT, ERROR) \
50 FUNC(MISSING_SPACE_BEFORE_DATE, ERROR) \
51 FUNC(MISSING_SPACE_BEFORE_EMAIL, ERROR) \
52 FUNC(MISSING_TAG, ERROR) \
53 FUNC(MISSING_TAG_ENTRY, ERROR) \
54 FUNC(MISSING_TREE, ERROR) \
55 FUNC(MISSING_TREE_OBJECT, ERROR) \
56 FUNC(MISSING_TYPE, ERROR) \
57 FUNC(MISSING_TYPE_ENTRY, ERROR) \
58 FUNC(MULTIPLE_AUTHORS, ERROR) \
59 FUNC(TREE_NOT_SORTED, ERROR) \
60 FUNC(UNKNOWN_TYPE, ERROR) \
61 FUNC(ZERO_PADDED_DATE, ERROR) \
62 FUNC(GITMODULES_MISSING, ERROR) \
63 FUNC(GITMODULES_BLOB, ERROR) \
64 FUNC(GITMODULES_LARGE, ERROR) \
65 FUNC(GITMODULES_NAME, ERROR) \
66 FUNC(GITMODULES_SYMLINK, ERROR) \
67 FUNC(GITMODULES_URL, ERROR) \
68 FUNC(GITMODULES_PATH, ERROR) \
69 FUNC(GITMODULES_UPDATE, ERROR) \
70 /* warnings */ \
71 FUNC(BAD_FILEMODE, WARN) \
72 FUNC(EMPTY_NAME, WARN) \
73 FUNC(FULL_PATHNAME, WARN) \
74 FUNC(HAS_DOT, WARN) \
75 FUNC(HAS_DOTDOT, WARN) \
76 FUNC(HAS_DOTGIT, WARN) \
77 FUNC(NULL_SHA1, WARN) \
78 FUNC(ZERO_PADDED_FILEMODE, WARN) \
79 FUNC(NUL_IN_COMMIT, WARN) \
80 /* infos (reported as warnings, but ignored by default) */ \
81 FUNC(GITMODULES_PARSE, INFO) \
82 FUNC(BAD_TAG_NAME, INFO) \
83 FUNC(MISSING_TAGGER_ENTRY, INFO)
85 #define MSG_ID(id, msg_type) FSCK_MSG_##id,
86 enum fsck_msg_id {
87 FOREACH_MSG_ID(MSG_ID)
88 FSCK_MSG_MAX
90 #undef MSG_ID
92 #define STR(x) #x
93 #define MSG_ID(id, msg_type) { STR(id), NULL, NULL, FSCK_##msg_type },
94 static struct {
95 const char *id_string;
96 const char *downcased;
97 const char *camelcased;
98 int msg_type;
99 } msg_id_info[FSCK_MSG_MAX + 1] = {
100 FOREACH_MSG_ID(MSG_ID)
101 { NULL, NULL, NULL, -1 }
103 #undef MSG_ID
105 static void prepare_msg_ids(void)
107 int i;
109 if (msg_id_info[0].downcased)
110 return;
112 /* convert id_string to lower case, without underscores. */
113 for (i = 0; i < FSCK_MSG_MAX; i++) {
114 const char *p = msg_id_info[i].id_string;
115 int len = strlen(p);
116 char *q = xmalloc(len);
118 msg_id_info[i].downcased = q;
119 while (*p)
120 if (*p == '_')
121 p++;
122 else
123 *(q)++ = tolower(*(p)++);
124 *q = '\0';
126 p = msg_id_info[i].id_string;
127 q = xmalloc(len);
128 msg_id_info[i].camelcased = q;
129 while (*p) {
130 if (*p == '_') {
131 p++;
132 if (*p)
133 *q++ = *p++;
134 } else {
135 *q++ = tolower(*p++);
138 *q = '\0';
142 static int parse_msg_id(const char *text)
144 int i;
146 prepare_msg_ids();
148 for (i = 0; i < FSCK_MSG_MAX; i++)
149 if (!strcmp(text, msg_id_info[i].downcased))
150 return i;
152 return -1;
155 void list_config_fsck_msg_ids(struct string_list *list, const char *prefix)
157 int i;
159 prepare_msg_ids();
161 for (i = 0; i < FSCK_MSG_MAX; i++)
162 list_config_item(list, prefix, msg_id_info[i].camelcased);
165 static int fsck_msg_type(enum fsck_msg_id msg_id,
166 struct fsck_options *options)
168 int msg_type;
170 assert(msg_id >= 0 && msg_id < FSCK_MSG_MAX);
172 if (options->msg_type)
173 msg_type = options->msg_type[msg_id];
174 else {
175 msg_type = msg_id_info[msg_id].msg_type;
176 if (options->strict && msg_type == FSCK_WARN)
177 msg_type = FSCK_ERROR;
180 return msg_type;
183 static int parse_msg_type(const char *str)
185 if (!strcmp(str, "error"))
186 return FSCK_ERROR;
187 else if (!strcmp(str, "warn"))
188 return FSCK_WARN;
189 else if (!strcmp(str, "ignore"))
190 return FSCK_IGNORE;
191 else
192 die("Unknown fsck message type: '%s'", str);
195 int is_valid_msg_type(const char *msg_id, const char *msg_type)
197 if (parse_msg_id(msg_id) < 0)
198 return 0;
199 parse_msg_type(msg_type);
200 return 1;
203 void fsck_set_msg_type(struct fsck_options *options,
204 const char *msg_id, const char *msg_type)
206 int id = parse_msg_id(msg_id), type;
208 if (id < 0)
209 die("Unhandled message id: %s", msg_id);
210 type = parse_msg_type(msg_type);
212 if (type != FSCK_ERROR && msg_id_info[id].msg_type == FSCK_FATAL)
213 die("Cannot demote %s to %s", msg_id, msg_type);
215 if (!options->msg_type) {
216 int i;
217 int *msg_type;
218 ALLOC_ARRAY(msg_type, FSCK_MSG_MAX);
219 for (i = 0; i < FSCK_MSG_MAX; i++)
220 msg_type[i] = fsck_msg_type(i, options);
221 options->msg_type = msg_type;
224 options->msg_type[id] = type;
227 void fsck_set_msg_types(struct fsck_options *options, const char *values)
229 char *buf = xstrdup(values), *to_free = buf;
230 int done = 0;
232 while (!done) {
233 int len = strcspn(buf, " ,|"), equal;
235 done = !buf[len];
236 if (!len) {
237 buf++;
238 continue;
240 buf[len] = '\0';
242 for (equal = 0;
243 equal < len && buf[equal] != '=' && buf[equal] != ':';
244 equal++)
245 buf[equal] = tolower(buf[equal]);
246 buf[equal] = '\0';
248 if (!strcmp(buf, "skiplist")) {
249 if (equal == len)
250 die("skiplist requires a path");
251 oidset_parse_file(&options->skiplist, buf + equal + 1);
252 buf += len + 1;
253 continue;
256 if (equal == len)
257 die("Missing '=': '%s'", buf);
259 fsck_set_msg_type(options, buf, buf + equal + 1);
260 buf += len + 1;
262 free(to_free);
265 static void append_msg_id(struct strbuf *sb, const char *msg_id)
267 for (;;) {
268 char c = *(msg_id)++;
270 if (!c)
271 break;
272 if (c != '_')
273 strbuf_addch(sb, tolower(c));
274 else {
275 assert(*msg_id);
276 strbuf_addch(sb, *(msg_id)++);
280 strbuf_addstr(sb, ": ");
283 static int object_on_skiplist(struct fsck_options *opts,
284 const struct object_id *oid)
286 return opts && oid && oidset_contains(&opts->skiplist, oid);
289 __attribute__((format (printf, 5, 6)))
290 static int report(struct fsck_options *options,
291 const struct object_id *oid, enum object_type object_type,
292 enum fsck_msg_id id, const char *fmt, ...)
294 va_list ap;
295 struct strbuf sb = STRBUF_INIT;
296 int msg_type = fsck_msg_type(id, options), result;
298 if (msg_type == FSCK_IGNORE)
299 return 0;
301 if (object_on_skiplist(options, oid))
302 return 0;
304 if (msg_type == FSCK_FATAL)
305 msg_type = FSCK_ERROR;
306 else if (msg_type == FSCK_INFO)
307 msg_type = FSCK_WARN;
309 append_msg_id(&sb, msg_id_info[id].id_string);
311 va_start(ap, fmt);
312 strbuf_vaddf(&sb, fmt, ap);
313 result = options->error_func(options, oid, object_type,
314 msg_type, sb.buf);
315 strbuf_release(&sb);
316 va_end(ap);
318 return result;
321 void fsck_enable_object_names(struct fsck_options *options)
323 if (!options->object_names)
324 options->object_names = kh_init_oid_map();
327 const char *fsck_get_object_name(struct fsck_options *options,
328 const struct object_id *oid)
330 khiter_t pos;
331 if (!options->object_names)
332 return NULL;
333 pos = kh_get_oid_map(options->object_names, *oid);
334 if (pos >= kh_end(options->object_names))
335 return NULL;
336 return kh_value(options->object_names, pos);
339 void fsck_put_object_name(struct fsck_options *options,
340 const struct object_id *oid,
341 const char *fmt, ...)
343 va_list ap;
344 struct strbuf buf = STRBUF_INIT;
345 khiter_t pos;
346 int hashret;
348 if (!options->object_names)
349 return;
351 pos = kh_put_oid_map(options->object_names, *oid, &hashret);
352 if (!hashret)
353 return;
354 va_start(ap, fmt);
355 strbuf_vaddf(&buf, fmt, ap);
356 kh_value(options->object_names, pos) = strbuf_detach(&buf, NULL);
357 va_end(ap);
360 const char *fsck_describe_object(struct fsck_options *options,
361 const struct object_id *oid)
363 static struct strbuf bufs[] = {
364 STRBUF_INIT, STRBUF_INIT, STRBUF_INIT, STRBUF_INIT
366 static int b = 0;
367 struct strbuf *buf;
368 const char *name = fsck_get_object_name(options, oid);
370 buf = bufs + b;
371 b = (b + 1) % ARRAY_SIZE(bufs);
372 strbuf_reset(buf);
373 strbuf_addstr(buf, oid_to_hex(oid));
374 if (name)
375 strbuf_addf(buf, " (%s)", name);
377 return buf->buf;
380 static int fsck_walk_tree(struct tree *tree, void *data, struct fsck_options *options)
382 struct tree_desc desc;
383 struct name_entry entry;
384 int res = 0;
385 const char *name;
387 if (parse_tree(tree))
388 return -1;
390 name = fsck_get_object_name(options, &tree->object.oid);
391 if (init_tree_desc_gently(&desc, tree->buffer, tree->size))
392 return -1;
393 while (tree_entry_gently(&desc, &entry)) {
394 struct object *obj;
395 int result;
397 if (S_ISGITLINK(entry.mode))
398 continue;
400 if (S_ISDIR(entry.mode)) {
401 obj = (struct object *)lookup_tree(the_repository, &entry.oid);
402 if (name && obj)
403 fsck_put_object_name(options, &entry.oid, "%s%s/",
404 name, entry.path);
405 result = options->walk(obj, OBJ_TREE, data, options);
407 else if (S_ISREG(entry.mode) || S_ISLNK(entry.mode)) {
408 obj = (struct object *)lookup_blob(the_repository, &entry.oid);
409 if (name && obj)
410 fsck_put_object_name(options, &entry.oid, "%s%s",
411 name, entry.path);
412 result = options->walk(obj, OBJ_BLOB, data, options);
414 else {
415 result = error("in tree %s: entry %s has bad mode %.6o",
416 fsck_describe_object(options, &tree->object.oid),
417 entry.path, entry.mode);
419 if (result < 0)
420 return result;
421 if (!res)
422 res = result;
424 return res;
427 static int fsck_walk_commit(struct commit *commit, void *data, struct fsck_options *options)
429 int counter = 0, generation = 0, name_prefix_len = 0;
430 struct commit_list *parents;
431 int res;
432 int result;
433 const char *name;
435 if (parse_commit(commit))
436 return -1;
438 name = fsck_get_object_name(options, &commit->object.oid);
439 if (name)
440 fsck_put_object_name(options, get_commit_tree_oid(commit),
441 "%s:", name);
443 result = options->walk((struct object *)get_commit_tree(commit),
444 OBJ_TREE, data, options);
445 if (result < 0)
446 return result;
447 res = result;
449 parents = commit->parents;
450 if (name && parents) {
451 int len = strlen(name), power;
453 if (len && name[len - 1] == '^') {
454 generation = 1;
455 name_prefix_len = len - 1;
457 else { /* parse ~<generation> suffix */
458 for (generation = 0, power = 1;
459 len && isdigit(name[len - 1]);
460 power *= 10)
461 generation += power * (name[--len] - '0');
462 if (power > 1 && len && name[len - 1] == '~')
463 name_prefix_len = len - 1;
467 while (parents) {
468 if (name) {
469 struct object_id *oid = &parents->item->object.oid;
471 if (counter++)
472 fsck_put_object_name(options, oid, "%s^%d",
473 name, counter);
474 else if (generation > 0)
475 fsck_put_object_name(options, oid, "%.*s~%d",
476 name_prefix_len, name,
477 generation + 1);
478 else
479 fsck_put_object_name(options, oid, "%s^", name);
481 result = options->walk((struct object *)parents->item, OBJ_COMMIT, data, options);
482 if (result < 0)
483 return result;
484 if (!res)
485 res = result;
486 parents = parents->next;
488 return res;
491 static int fsck_walk_tag(struct tag *tag, void *data, struct fsck_options *options)
493 const char *name = fsck_get_object_name(options, &tag->object.oid);
495 if (parse_tag(tag))
496 return -1;
497 if (name)
498 fsck_put_object_name(options, &tag->tagged->oid, "%s", name);
499 return options->walk(tag->tagged, OBJ_ANY, data, options);
502 int fsck_walk(struct object *obj, void *data, struct fsck_options *options)
504 if (!obj)
505 return -1;
507 if (obj->type == OBJ_NONE)
508 parse_object(the_repository, &obj->oid);
510 switch (obj->type) {
511 case OBJ_BLOB:
512 return 0;
513 case OBJ_TREE:
514 return fsck_walk_tree((struct tree *)obj, data, options);
515 case OBJ_COMMIT:
516 return fsck_walk_commit((struct commit *)obj, data, options);
517 case OBJ_TAG:
518 return fsck_walk_tag((struct tag *)obj, data, options);
519 default:
520 error("Unknown object type for %s",
521 fsck_describe_object(options, &obj->oid));
522 return -1;
527 * The entries in a tree are ordered in the _path_ order,
528 * which means that a directory entry is ordered by adding
529 * a slash to the end of it.
531 * So a directory called "a" is ordered _after_ a file
532 * called "a.c", because "a/" sorts after "a.c".
534 #define TREE_UNORDERED (-1)
535 #define TREE_HAS_DUPS (-2)
537 static int verify_ordered(unsigned mode1, const char *name1, unsigned mode2, const char *name2)
539 int len1 = strlen(name1);
540 int len2 = strlen(name2);
541 int len = len1 < len2 ? len1 : len2;
542 unsigned char c1, c2;
543 int cmp;
545 cmp = memcmp(name1, name2, len);
546 if (cmp < 0)
547 return 0;
548 if (cmp > 0)
549 return TREE_UNORDERED;
552 * Ok, the first <len> characters are the same.
553 * Now we need to order the next one, but turn
554 * a '\0' into a '/' for a directory entry.
556 c1 = name1[len];
557 c2 = name2[len];
558 if (!c1 && !c2)
560 * git-write-tree used to write out a nonsense tree that has
561 * entries with the same name, one blob and one tree. Make
562 * sure we do not have duplicate entries.
564 return TREE_HAS_DUPS;
565 if (!c1 && S_ISDIR(mode1))
566 c1 = '/';
567 if (!c2 && S_ISDIR(mode2))
568 c2 = '/';
569 return c1 < c2 ? 0 : TREE_UNORDERED;
572 static int fsck_tree(const struct object_id *oid,
573 const char *buffer, unsigned long size,
574 struct fsck_options *options)
576 int retval = 0;
577 int has_null_sha1 = 0;
578 int has_full_path = 0;
579 int has_empty_name = 0;
580 int has_dot = 0;
581 int has_dotdot = 0;
582 int has_dotgit = 0;
583 int has_zero_pad = 0;
584 int has_bad_modes = 0;
585 int has_dup_entries = 0;
586 int not_properly_sorted = 0;
587 struct tree_desc desc;
588 unsigned o_mode;
589 const char *o_name;
591 if (init_tree_desc_gently(&desc, buffer, size)) {
592 retval += report(options, oid, OBJ_TREE, FSCK_MSG_BAD_TREE, "cannot be parsed as a tree");
593 return retval;
596 o_mode = 0;
597 o_name = NULL;
599 while (desc.size) {
600 unsigned short mode;
601 const char *name, *backslash;
602 const struct object_id *oid;
604 oid = tree_entry_extract(&desc, &name, &mode);
606 has_null_sha1 |= is_null_oid(oid);
607 has_full_path |= !!strchr(name, '/');
608 has_empty_name |= !*name;
609 has_dot |= !strcmp(name, ".");
610 has_dotdot |= !strcmp(name, "..");
611 has_dotgit |= is_hfs_dotgit(name) || is_ntfs_dotgit(name);
612 has_zero_pad |= *(char *)desc.buffer == '0';
614 if (is_hfs_dotgitmodules(name) || is_ntfs_dotgitmodules(name)) {
615 if (!S_ISLNK(mode))
616 oidset_insert(&gitmodules_found, oid);
617 else
618 retval += report(options,
619 oid, OBJ_TREE,
620 FSCK_MSG_GITMODULES_SYMLINK,
621 ".gitmodules is a symbolic link");
624 if ((backslash = strchr(name, '\\'))) {
625 while (backslash) {
626 backslash++;
627 has_dotgit |= is_ntfs_dotgit(backslash);
628 if (is_ntfs_dotgitmodules(backslash)) {
629 if (!S_ISLNK(mode))
630 oidset_insert(&gitmodules_found, oid);
631 else
632 retval += report(options, oid, OBJ_TREE,
633 FSCK_MSG_GITMODULES_SYMLINK,
634 ".gitmodules is a symbolic link");
636 backslash = strchr(backslash, '\\');
640 if (update_tree_entry_gently(&desc)) {
641 retval += report(options, oid, OBJ_TREE, FSCK_MSG_BAD_TREE, "cannot be parsed as a tree");
642 break;
645 switch (mode) {
647 * Standard modes..
649 case S_IFREG | 0755:
650 case S_IFREG | 0644:
651 case S_IFLNK:
652 case S_IFDIR:
653 case S_IFGITLINK:
654 break;
656 * This is nonstandard, but we had a few of these
657 * early on when we honored the full set of mode
658 * bits..
660 case S_IFREG | 0664:
661 if (!options->strict)
662 break;
663 /* fallthrough */
664 default:
665 has_bad_modes = 1;
668 if (o_name) {
669 switch (verify_ordered(o_mode, o_name, mode, name)) {
670 case TREE_UNORDERED:
671 not_properly_sorted = 1;
672 break;
673 case TREE_HAS_DUPS:
674 has_dup_entries = 1;
675 break;
676 default:
677 break;
681 o_mode = mode;
682 o_name = name;
685 if (has_null_sha1)
686 retval += report(options, oid, OBJ_TREE, FSCK_MSG_NULL_SHA1, "contains entries pointing to null sha1");
687 if (has_full_path)
688 retval += report(options, oid, OBJ_TREE, FSCK_MSG_FULL_PATHNAME, "contains full pathnames");
689 if (has_empty_name)
690 retval += report(options, oid, OBJ_TREE, FSCK_MSG_EMPTY_NAME, "contains empty pathname");
691 if (has_dot)
692 retval += report(options, oid, OBJ_TREE, FSCK_MSG_HAS_DOT, "contains '.'");
693 if (has_dotdot)
694 retval += report(options, oid, OBJ_TREE, FSCK_MSG_HAS_DOTDOT, "contains '..'");
695 if (has_dotgit)
696 retval += report(options, oid, OBJ_TREE, FSCK_MSG_HAS_DOTGIT, "contains '.git'");
697 if (has_zero_pad)
698 retval += report(options, oid, OBJ_TREE, FSCK_MSG_ZERO_PADDED_FILEMODE, "contains zero-padded file modes");
699 if (has_bad_modes)
700 retval += report(options, oid, OBJ_TREE, FSCK_MSG_BAD_FILEMODE, "contains bad file modes");
701 if (has_dup_entries)
702 retval += report(options, oid, OBJ_TREE, FSCK_MSG_DUPLICATE_ENTRIES, "contains duplicate file entries");
703 if (not_properly_sorted)
704 retval += report(options, oid, OBJ_TREE, FSCK_MSG_TREE_NOT_SORTED, "not properly sorted");
705 return retval;
708 static int verify_headers(const void *data, unsigned long size,
709 const struct object_id *oid, enum object_type type,
710 struct fsck_options *options)
712 const char *buffer = (const char *)data;
713 unsigned long i;
715 for (i = 0; i < size; i++) {
716 switch (buffer[i]) {
717 case '\0':
718 return report(options, oid, type,
719 FSCK_MSG_NUL_IN_HEADER,
720 "unterminated header: NUL at offset %ld", i);
721 case '\n':
722 if (i + 1 < size && buffer[i + 1] == '\n')
723 return 0;
728 * We did not find double-LF that separates the header
729 * and the body. Not having a body is not a crime but
730 * we do want to see the terminating LF for the last header
731 * line.
733 if (size && buffer[size - 1] == '\n')
734 return 0;
736 return report(options, oid, type,
737 FSCK_MSG_UNTERMINATED_HEADER, "unterminated header");
740 static int fsck_ident(const char **ident,
741 const struct object_id *oid, enum object_type type,
742 struct fsck_options *options)
744 const char *p = *ident;
745 char *end;
747 *ident = strchrnul(*ident, '\n');
748 if (**ident == '\n')
749 (*ident)++;
751 if (*p == '<')
752 return report(options, oid, type, FSCK_MSG_MISSING_NAME_BEFORE_EMAIL, "invalid author/committer line - missing space before email");
753 p += strcspn(p, "<>\n");
754 if (*p == '>')
755 return report(options, oid, type, FSCK_MSG_BAD_NAME, "invalid author/committer line - bad name");
756 if (*p != '<')
757 return report(options, oid, type, FSCK_MSG_MISSING_EMAIL, "invalid author/committer line - missing email");
758 if (p[-1] != ' ')
759 return report(options, oid, type, FSCK_MSG_MISSING_SPACE_BEFORE_EMAIL, "invalid author/committer line - missing space before email");
760 p++;
761 p += strcspn(p, "<>\n");
762 if (*p != '>')
763 return report(options, oid, type, FSCK_MSG_BAD_EMAIL, "invalid author/committer line - bad email");
764 p++;
765 if (*p != ' ')
766 return report(options, oid, type, FSCK_MSG_MISSING_SPACE_BEFORE_DATE, "invalid author/committer line - missing space before date");
767 p++;
768 if (*p == '0' && p[1] != ' ')
769 return report(options, oid, type, FSCK_MSG_ZERO_PADDED_DATE, "invalid author/committer line - zero-padded date");
770 if (date_overflows(parse_timestamp(p, &end, 10)))
771 return report(options, oid, type, FSCK_MSG_BAD_DATE_OVERFLOW, "invalid author/committer line - date causes integer overflow");
772 if ((end == p || *end != ' '))
773 return report(options, oid, type, FSCK_MSG_BAD_DATE, "invalid author/committer line - bad date");
774 p = end + 1;
775 if ((*p != '+' && *p != '-') ||
776 !isdigit(p[1]) ||
777 !isdigit(p[2]) ||
778 !isdigit(p[3]) ||
779 !isdigit(p[4]) ||
780 (p[5] != '\n'))
781 return report(options, oid, type, FSCK_MSG_BAD_TIMEZONE, "invalid author/committer line - bad time zone");
782 p += 6;
783 return 0;
786 static int fsck_commit(const struct object_id *oid,
787 const char *buffer, unsigned long size,
788 struct fsck_options *options)
790 struct object_id tree_oid, parent_oid;
791 unsigned author_count;
792 int err;
793 const char *buffer_begin = buffer;
794 const char *p;
796 if (verify_headers(buffer, size, oid, OBJ_COMMIT, options))
797 return -1;
799 if (!skip_prefix(buffer, "tree ", &buffer))
800 return report(options, oid, OBJ_COMMIT, FSCK_MSG_MISSING_TREE, "invalid format - expected 'tree' line");
801 if (parse_oid_hex(buffer, &tree_oid, &p) || *p != '\n') {
802 err = report(options, oid, OBJ_COMMIT, FSCK_MSG_BAD_TREE_SHA1, "invalid 'tree' line format - bad sha1");
803 if (err)
804 return err;
806 buffer = p + 1;
807 while (skip_prefix(buffer, "parent ", &buffer)) {
808 if (parse_oid_hex(buffer, &parent_oid, &p) || *p != '\n') {
809 err = report(options, oid, OBJ_COMMIT, FSCK_MSG_BAD_PARENT_SHA1, "invalid 'parent' line format - bad sha1");
810 if (err)
811 return err;
813 buffer = p + 1;
815 author_count = 0;
816 while (skip_prefix(buffer, "author ", &buffer)) {
817 author_count++;
818 err = fsck_ident(&buffer, oid, OBJ_COMMIT, options);
819 if (err)
820 return err;
822 if (author_count < 1)
823 err = report(options, oid, OBJ_COMMIT, FSCK_MSG_MISSING_AUTHOR, "invalid format - expected 'author' line");
824 else if (author_count > 1)
825 err = report(options, oid, OBJ_COMMIT, FSCK_MSG_MULTIPLE_AUTHORS, "invalid format - multiple 'author' lines");
826 if (err)
827 return err;
828 if (!skip_prefix(buffer, "committer ", &buffer))
829 return report(options, oid, OBJ_COMMIT, FSCK_MSG_MISSING_COMMITTER, "invalid format - expected 'committer' line");
830 err = fsck_ident(&buffer, oid, OBJ_COMMIT, options);
831 if (err)
832 return err;
833 if (memchr(buffer_begin, '\0', size)) {
834 err = report(options, oid, OBJ_COMMIT, FSCK_MSG_NUL_IN_COMMIT,
835 "NUL byte in the commit object body");
836 if (err)
837 return err;
839 return 0;
842 static int fsck_tag(const struct object_id *oid, const char *buffer,
843 unsigned long size, struct fsck_options *options)
845 struct object_id tagged_oid;
846 int ret = 0;
847 char *eol;
848 struct strbuf sb = STRBUF_INIT;
849 const char *p;
851 ret = verify_headers(buffer, size, oid, OBJ_TAG, options);
852 if (ret)
853 goto done;
855 if (!skip_prefix(buffer, "object ", &buffer)) {
856 ret = report(options, oid, OBJ_TAG, FSCK_MSG_MISSING_OBJECT, "invalid format - expected 'object' line");
857 goto done;
859 if (parse_oid_hex(buffer, &tagged_oid, &p) || *p != '\n') {
860 ret = report(options, oid, OBJ_TAG, FSCK_MSG_BAD_OBJECT_SHA1, "invalid 'object' line format - bad sha1");
861 if (ret)
862 goto done;
864 buffer = p + 1;
866 if (!skip_prefix(buffer, "type ", &buffer)) {
867 ret = report(options, oid, OBJ_TAG, FSCK_MSG_MISSING_TYPE_ENTRY, "invalid format - expected 'type' line");
868 goto done;
870 eol = strchr(buffer, '\n');
871 if (!eol) {
872 ret = report(options, oid, OBJ_TAG, FSCK_MSG_MISSING_TYPE, "invalid format - unexpected end after 'type' line");
873 goto done;
875 if (type_from_string_gently(buffer, eol - buffer, 1) < 0)
876 ret = report(options, oid, OBJ_TAG, FSCK_MSG_BAD_TYPE, "invalid 'type' value");
877 if (ret)
878 goto done;
879 buffer = eol + 1;
881 if (!skip_prefix(buffer, "tag ", &buffer)) {
882 ret = report(options, oid, OBJ_TAG, FSCK_MSG_MISSING_TAG_ENTRY, "invalid format - expected 'tag' line");
883 goto done;
885 eol = strchr(buffer, '\n');
886 if (!eol) {
887 ret = report(options, oid, OBJ_TAG, FSCK_MSG_MISSING_TAG, "invalid format - unexpected end after 'type' line");
888 goto done;
890 strbuf_addf(&sb, "refs/tags/%.*s", (int)(eol - buffer), buffer);
891 if (check_refname_format(sb.buf, 0)) {
892 ret = report(options, oid, OBJ_TAG,
893 FSCK_MSG_BAD_TAG_NAME,
894 "invalid 'tag' name: %.*s",
895 (int)(eol - buffer), buffer);
896 if (ret)
897 goto done;
899 buffer = eol + 1;
901 if (!skip_prefix(buffer, "tagger ", &buffer)) {
902 /* early tags do not contain 'tagger' lines; warn only */
903 ret = report(options, oid, OBJ_TAG, FSCK_MSG_MISSING_TAGGER_ENTRY, "invalid format - expected 'tagger' line");
904 if (ret)
905 goto done;
907 else
908 ret = fsck_ident(&buffer, oid, OBJ_TAG, options);
910 done:
911 strbuf_release(&sb);
912 return ret;
916 * Like builtin/submodule--helper.c's starts_with_dot_slash, but without
917 * relying on the platform-dependent is_dir_sep helper.
919 * This is for use in checking whether a submodule URL is interpreted as
920 * relative to the current directory on any platform, since \ is a
921 * directory separator on Windows but not on other platforms.
923 static int starts_with_dot_slash(const char *str)
925 return str[0] == '.' && (str[1] == '/' || str[1] == '\\');
929 * Like starts_with_dot_slash, this is a variant of submodule--helper's
930 * helper of the same name with the twist that it accepts backslash as a
931 * directory separator even on non-Windows platforms.
933 static int starts_with_dot_dot_slash(const char *str)
935 return str[0] == '.' && starts_with_dot_slash(str + 1);
938 static int submodule_url_is_relative(const char *url)
940 return starts_with_dot_slash(url) || starts_with_dot_dot_slash(url);
944 * Count directory components that a relative submodule URL should chop
945 * from the remote_url it is to be resolved against.
947 * In other words, this counts "../" components at the start of a
948 * submodule URL.
950 * Returns the number of directory components to chop and writes a
951 * pointer to the next character of url after all leading "./" and
952 * "../" components to out.
954 static int count_leading_dotdots(const char *url, const char **out)
956 int result = 0;
957 while (1) {
958 if (starts_with_dot_dot_slash(url)) {
959 result++;
960 url += strlen("../");
961 continue;
963 if (starts_with_dot_slash(url)) {
964 url += strlen("./");
965 continue;
967 *out = url;
968 return result;
972 * Check whether a transport is implemented by git-remote-curl.
974 * If it is, returns 1 and writes the URL that would be passed to
975 * git-remote-curl to the "out" parameter.
977 * Otherwise, returns 0 and leaves "out" untouched.
979 * Examples:
980 * http::https://example.com/repo.git -> 1, https://example.com/repo.git
981 * https://example.com/repo.git -> 1, https://example.com/repo.git
982 * git://example.com/repo.git -> 0
984 * This is for use in checking for previously exploitable bugs that
985 * required a submodule URL to be passed to git-remote-curl.
987 static int url_to_curl_url(const char *url, const char **out)
990 * We don't need to check for case-aliases, "http.exe", and so
991 * on because in the default configuration, is_transport_allowed
992 * prevents URLs with those schemes from being cloned
993 * automatically.
995 if (skip_prefix(url, "http::", out) ||
996 skip_prefix(url, "https::", out) ||
997 skip_prefix(url, "ftp::", out) ||
998 skip_prefix(url, "ftps::", out))
999 return 1;
1000 if (starts_with(url, "http://") ||
1001 starts_with(url, "https://") ||
1002 starts_with(url, "ftp://") ||
1003 starts_with(url, "ftps://")) {
1004 *out = url;
1005 return 1;
1007 return 0;
1010 static int check_submodule_url(const char *url)
1012 const char *curl_url;
1014 if (looks_like_command_line_option(url))
1015 return -1;
1017 if (submodule_url_is_relative(url)) {
1018 char *decoded;
1019 const char *next;
1020 int has_nl;
1023 * This could be appended to an http URL and url-decoded;
1024 * check for malicious characters.
1026 decoded = url_decode(url);
1027 has_nl = !!strchr(decoded, '\n');
1029 free(decoded);
1030 if (has_nl)
1031 return -1;
1034 * URLs which escape their root via "../" can overwrite
1035 * the host field and previous components, resolving to
1036 * URLs like https::example.com/submodule.git and
1037 * https:///example.com/submodule.git that were
1038 * susceptible to CVE-2020-11008.
1040 if (count_leading_dotdots(url, &next) > 0 &&
1041 (*next == ':' || *next == '/'))
1042 return -1;
1045 else if (url_to_curl_url(url, &curl_url)) {
1046 struct credential c = CREDENTIAL_INIT;
1047 int ret = 0;
1048 if (credential_from_url_gently(&c, curl_url, 1) ||
1049 !*c.host)
1050 ret = -1;
1051 credential_clear(&c);
1052 return ret;
1055 return 0;
1058 struct fsck_gitmodules_data {
1059 const struct object_id *oid;
1060 struct fsck_options *options;
1061 int ret;
1064 static int fsck_gitmodules_fn(const char *var, const char *value, void *vdata)
1066 struct fsck_gitmodules_data *data = vdata;
1067 const char *subsection, *key;
1068 int subsection_len;
1069 char *name;
1071 if (parse_config_key(var, "submodule", &subsection, &subsection_len, &key) < 0 ||
1072 !subsection)
1073 return 0;
1075 name = xmemdupz(subsection, subsection_len);
1076 if (check_submodule_name(name) < 0)
1077 data->ret |= report(data->options,
1078 data->oid, OBJ_BLOB,
1079 FSCK_MSG_GITMODULES_NAME,
1080 "disallowed submodule name: %s",
1081 name);
1082 if (!strcmp(key, "url") && value &&
1083 check_submodule_url(value) < 0)
1084 data->ret |= report(data->options,
1085 data->oid, OBJ_BLOB,
1086 FSCK_MSG_GITMODULES_URL,
1087 "disallowed submodule url: %s",
1088 value);
1089 if (!strcmp(key, "path") && value &&
1090 looks_like_command_line_option(value))
1091 data->ret |= report(data->options,
1092 data->oid, OBJ_BLOB,
1093 FSCK_MSG_GITMODULES_PATH,
1094 "disallowed submodule path: %s",
1095 value);
1096 if (!strcmp(key, "update") && value &&
1097 parse_submodule_update_type(value) == SM_UPDATE_COMMAND)
1098 data->ret |= report(data->options, data->oid, OBJ_BLOB,
1099 FSCK_MSG_GITMODULES_UPDATE,
1100 "disallowed submodule update setting: %s",
1101 value);
1102 free(name);
1104 return 0;
1107 static int fsck_blob(const struct object_id *oid, const char *buf,
1108 unsigned long size, struct fsck_options *options)
1110 struct fsck_gitmodules_data data;
1111 struct config_options config_opts = { 0 };
1113 if (!oidset_contains(&gitmodules_found, oid))
1114 return 0;
1115 oidset_insert(&gitmodules_done, oid);
1117 if (object_on_skiplist(options, oid))
1118 return 0;
1120 if (!buf) {
1122 * A missing buffer here is a sign that the caller found the
1123 * blob too gigantic to load into memory. Let's just consider
1124 * that an error.
1126 return report(options, oid, OBJ_BLOB,
1127 FSCK_MSG_GITMODULES_LARGE,
1128 ".gitmodules too large to parse");
1131 data.oid = oid;
1132 data.options = options;
1133 data.ret = 0;
1134 config_opts.error_action = CONFIG_ERROR_SILENT;
1135 if (git_config_from_mem(fsck_gitmodules_fn, CONFIG_ORIGIN_BLOB,
1136 ".gitmodules", buf, size, &data, &config_opts))
1137 data.ret |= report(options, oid, OBJ_BLOB,
1138 FSCK_MSG_GITMODULES_PARSE,
1139 "could not parse gitmodules blob");
1141 return data.ret;
1144 int fsck_object(struct object *obj, void *data, unsigned long size,
1145 struct fsck_options *options)
1147 if (!obj)
1148 return report(options, NULL, OBJ_NONE, FSCK_MSG_BAD_OBJECT_SHA1, "no valid object to fsck");
1150 if (obj->type == OBJ_BLOB)
1151 return fsck_blob(&obj->oid, data, size, options);
1152 if (obj->type == OBJ_TREE)
1153 return fsck_tree(&obj->oid, data, size, options);
1154 if (obj->type == OBJ_COMMIT)
1155 return fsck_commit(&obj->oid, data, size, options);
1156 if (obj->type == OBJ_TAG)
1157 return fsck_tag(&obj->oid, data, size, options);
1159 return report(options, &obj->oid, obj->type,
1160 FSCK_MSG_UNKNOWN_TYPE,
1161 "unknown type '%d' (internal fsck error)",
1162 obj->type);
1165 int fsck_error_function(struct fsck_options *o,
1166 const struct object_id *oid,
1167 enum object_type object_type,
1168 int msg_type, const char *message)
1170 if (msg_type == FSCK_WARN) {
1171 warning("object %s: %s", fsck_describe_object(o, oid), message);
1172 return 0;
1174 error("object %s: %s", fsck_describe_object(o, oid), message);
1175 return 1;
1178 int fsck_finish(struct fsck_options *options)
1180 int ret = 0;
1181 struct oidset_iter iter;
1182 const struct object_id *oid;
1184 oidset_iter_init(&gitmodules_found, &iter);
1185 while ((oid = oidset_iter_next(&iter))) {
1186 enum object_type type;
1187 unsigned long size;
1188 char *buf;
1190 if (oidset_contains(&gitmodules_done, oid))
1191 continue;
1193 buf = read_object_file(oid, &type, &size);
1194 if (!buf) {
1195 if (is_promisor_object(oid))
1196 continue;
1197 ret |= report(options,
1198 oid, OBJ_BLOB,
1199 FSCK_MSG_GITMODULES_MISSING,
1200 "unable to read .gitmodules blob");
1201 continue;
1204 if (type == OBJ_BLOB)
1205 ret |= fsck_blob(oid, buf, size, options);
1206 else
1207 ret |= report(options,
1208 oid, type,
1209 FSCK_MSG_GITMODULES_BLOB,
1210 "non-blob found at .gitmodules");
1211 free(buf);
1215 oidset_clear(&gitmodules_found);
1216 oidset_clear(&gitmodules_done);
1217 return ret;