Merge pull request libgit2#6191 from libgit2/ethomson/sha256_poc

RFC: SHA256 proof of concept

Author: ethomson

.github/workflows/main.yml

@@ -120,7 +120,61 @@ jobs:
             CMAKE_OPTIONS: -DUSE_HTTPS=mbedTLS -DUSE_SHA1=HTTPS -DREGEX_BACKEND=pcre -DDEPRECATE_HARD=ON -DUSE_LEAK_CHECKER=valgrind -DUSE_GSSAPI=ON -DUSE_SSH=ON
             CMAKE_GENERATOR: Ninja
           os: ubuntu-latest
-        - name: "Linux (MemorySanitizer)"
+        - name: "macOS"
+          id: macos
+          os: macos-10.15
+          env:
+            CC: clang
+            CMAKE_OPTIONS: -DREGEX_BACKEND=regcomp_l -DDEPRECATE_HARD=ON -DUSE_LEAK_CHECKER=leaks -DUSE_GSSAPI=ON
+            PKG_CONFIG_PATH: /usr/local/opt/openssl/lib/pkgconfig
+            SKIP_SSH_TESTS: true
+            SKIP_NEGOTIATE_TESTS: true
+          setup-script: osx
+        - name: "Windows (amd64, Visual Studio)"
+          id: windows-amd64-vs
+          os: windows-2019
+          env:
+            ARCH: amd64
+            CMAKE_GENERATOR: Visual Studio 16 2019
+            CMAKE_OPTIONS: -A x64 -DWIN32_LEAKCHECK=ON -DDEPRECATE_HARD=ON
+            SKIP_SSH_TESTS: true
+            SKIP_NEGOTIATE_TESTS: true
+        - name: "Windows (x86, Visual Studio)"
+          id: windows-x86-vs
+          os: windows-2019
+          env:
+            ARCH: x86
+            CMAKE_GENERATOR: Visual Studio 16 2019
+            CMAKE_OPTIONS: -A Win32 -DWIN32_LEAKCHECK=ON -DDEPRECATE_HARD=ON -DUSE_SHA1=HTTPS -DUSE_BUNDLED_ZLIB=ON
+            SKIP_SSH_TESTS: true
+            SKIP_NEGOTIATE_TESTS: true
+        - name: "Windows (amd64, mingw)"
+          id: windows-amd64-mingw
+          os: windows-2019
+          setup-script: mingw
+          env:
+            ARCH: amd64
+            CMAKE_GENERATOR: MinGW Makefiles
+            CMAKE_OPTIONS: -DDEPRECATE_HARD=ON
+            BUILD_TEMP: D:\Temp
+            BUILD_PATH: D:\Temp\mingw64\bin;C:\Windows\system32;C:\Windows;C:\Windows\System32\Wbem;C:\Program Files (x86)\CMake\bin
+            SKIP_SSH_TESTS: true
+            SKIP_NEGOTIATE_TESTS: true
+        - name: "Windows (x86, mingw)"
+          id: windows-x86-mingw
+          os: windows-2019
+          setup-script: mingw
+          env:
+            ARCH: x86
+            CMAKE_GENERATOR: MinGW Makefiles
+            CMAKE_OPTIONS: -DDEPRECATE_HARD=ON
+            BUILD_TEMP: D:\Temp
+            BUILD_PATH: D:\Temp\mingw32\bin;C:\Windows\system32;C:\Windows;C:\Windows\System32\Wbem;C:\Program Files (x86)\CMake\bin
+            SKIP_SSH_TESTS: true
+            SKIP_NEGOTIATE_TESTS: true
+
+        # Sanitizers
+        - name: "Sanitizer (Memory)"
           id: memorysanitizer
           container:
             name: focal
@@ -134,7 +188,7 @@ jobs:
             ASAN_SYMBOLIZER_PATH: /usr/bin/llvm-symbolizer-10
             UBSAN_OPTIONS: print_stacktrace=1
           os: ubuntu-latest
-        - name: "Linux (UndefinedBehaviorSanitizer)"
+        - name: "Sanitizer (UndefinedBehavior)"
           id: ubsanitizer
           container:
             name: focal
@@ -148,7 +202,7 @@ jobs:
             ASAN_SYMBOLIZER_PATH: /usr/bin/llvm-symbolizer-10
             UBSAN_OPTIONS: print_stacktrace=1
           os: ubuntu-latest
-        - name: "Linux (ThreadSanitizer)"
+        - name: "Sanitizer (Thread)"
           id: threadsanitizer
           container:
             name: focal
@@ -163,56 +217,34 @@ jobs:
             UBSAN_OPTIONS: print_stacktrace=1
             TSAN_OPTIONS: suppressions=/home/libgit2/source/script/thread-sanitizer.supp second_deadlock_stack=1
           os: ubuntu-latest
-        - name: "macOS"
+
+        # Experimental: SHA256 support
+        - name: "Linux (SHA256, Xenial, Clang, OpenSSL)"
+          id: xenial-clang-openssl
+          container:
+            name: xenial
+          env:
+            CC: clang
+            CMAKE_GENERATOR: Ninja
+            CMAKE_OPTIONS: -DUSE_HTTPS=OpenSSL -DDEPRECATE_HARD=ON -DUSE_LEAK_CHECKER=valgrind -DUSE_GSSAPI=ON -DUSE_SSH=ON
+          os: ubuntu-latest
+        - name: "macOS (SHA256)"
           id: macos
           os: macos-10.15
           env:
             CC: clang
-            CMAKE_OPTIONS: -DREGEX_BACKEND=regcomp_l -DDEPRECATE_HARD=ON -DUSE_LEAK_CHECKER=leaks -DUSE_GSSAPI=ON
+            CMAKE_OPTIONS: -DREGEX_BACKEND=regcomp_l -DDEPRECATE_HARD=ON -DUSE_LEAK_CHECKER=leaks -DUSE_GSSAPI=ON -DEXPERIMENTAL_SHA256=ON
             PKG_CONFIG_PATH: /usr/local/opt/openssl/lib/pkgconfig
             SKIP_SSH_TESTS: true
             SKIP_NEGOTIATE_TESTS: true
           setup-script: osx
-        - name: "Windows (amd64, Visual Studio)"
+        - name: "Windows (SHA256, amd64, Visual Studio)"
           id: windows-amd64-vs
           os: windows-2019
           env:
             ARCH: amd64
             CMAKE_GENERATOR: Visual Studio 16 2019
-            CMAKE_OPTIONS: -A x64 -DWIN32_LEAKCHECK=ON -DDEPRECATE_HARD=ON
-            SKIP_SSH_TESTS: true
-            SKIP_NEGOTIATE_TESTS: true
-        - name: "Windows (x86, Visual Studio)"
-          id: windows-x86-vs
-          os: windows-2019
-          env:
-            ARCH: x86
-            CMAKE_GENERATOR: Visual Studio 16 2019
-            CMAKE_OPTIONS: -A Win32 -DWIN32_LEAKCHECK=ON -DDEPRECATE_HARD=ON -DUSE_SHA1=HTTPS -DUSE_BUNDLED_ZLIB=ON
-            SKIP_SSH_TESTS: true
-            SKIP_NEGOTIATE_TESTS: true
-        - name: "Windows (amd64, mingw)"
-          id: windows-amd64-mingw
-          os: windows-2019
-          setup-script: mingw
-          env:
-            ARCH: amd64
-            CMAKE_GENERATOR: MinGW Makefiles
-            CMAKE_OPTIONS: -DDEPRECATE_HARD=ON
-            BUILD_TEMP: D:\Temp
-            BUILD_PATH: D:\Temp\mingw64\bin;C:\Windows\system32;C:\Windows;C:\Windows\System32\Wbem;C:\Program Files (x86)\CMake\bin
-            SKIP_SSH_TESTS: true
-            SKIP_NEGOTIATE_TESTS: true
-        - name: "Windows (x86, mingw)"
-          id: windows-x86-mingw
-          os: windows-2019
-          setup-script: mingw
-          env:
-            ARCH: x86
-            CMAKE_GENERATOR: MinGW Makefiles
-            CMAKE_OPTIONS: -DDEPRECATE_HARD=ON
-            BUILD_TEMP: D:\Temp
-            BUILD_PATH: D:\Temp\mingw32\bin;C:\Windows\system32;C:\Windows;C:\Windows\System32\Wbem;C:\Program Files (x86)\CMake\bin
+            CMAKE_OPTIONS: -A x64 -DWIN32_LEAKCHECK=ON -DDEPRECATE_HARD=ON -DEXPERIMENTAL_SHA256=ON
             SKIP_SSH_TESTS: true
             SKIP_NEGOTIATE_TESTS: true
       fail-fast: false

CMakeLists.txt

@@ -15,6 +15,9 @@ set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${PROJECT_SOURCE_DIR}/cmake")
 # Build options
 #
 
+# Experimental features
+option(EXPERIMENTAL_SHA256     "Enable experimental SHA256 support (for R&D/testing)"  OFF)
+
 # Optional subsystems
 option(BUILD_SHARED_LIBS       "Build Shared Library (OFF for Static)"                  ON)
 option(BUILD_TESTS             "Build Tests using the Clar suite"                       ON)
@@ -107,6 +110,7 @@ include(IdeSplitSources)
 include(FeatureSummary)
 include(EnableWarnings)
 include(DefaultCFlags)
+include(ExperimentalFeatures)
 
 
 #

cmake/ExperimentalFeatures.cmake

@@ -0,0 +1,12 @@
+if(EXPERIMENTAL_SHA256)
+	add_feature_info("SHA256 API" ON "experimental SHA256 APIs")
+
+	set(EXPERIMENTAL 1)
+	set(GIT_EXPERIMENTAL_SHA256 1)
+else()
+	add_feature_info("SHA256 API" OFF "experimental SHA256 APIs")
+endif()
+
+if(EXPERIMENTAL)
+	set(LIBGIT2_FILENAME "${LIBGIT2_FILENAME}-experimental")
+endif()

examples/cat-file.c

@@ -49,7 +49,7 @@ static void show_blob(const git_blob *blob)
 static void show_tree(const git_tree *tree)
 {
 	size_t i, max_i = (int)git_tree_entrycount(tree);
-	char oidstr[GIT_OID_HEXSZ + 1];
+	char oidstr[GIT_OID_SHA1_HEXSIZE + 1];
 	const git_tree_entry *te;
 
 	for (i = 0; i < max_i; ++i) {
@@ -70,7 +70,7 @@ static void show_tree(const git_tree *tree)
 static void show_commit(const git_commit *commit)
 {
 	unsigned int i, max_i;
-	char oidstr[GIT_OID_HEXSZ + 1];
+	char oidstr[GIT_OID_SHA1_HEXSIZE + 1];
 
 	git_oid_tostr(oidstr, sizeof(oidstr), git_commit_tree_id(commit));
 	printf("tree %s\n", oidstr);
@@ -90,7 +90,7 @@ static void show_commit(const git_commit *commit)
 
 static void show_tag(const git_tag *tag)
 {
-	char oidstr[GIT_OID_HEXSZ + 1];
+	char oidstr[GIT_OID_SHA1_HEXSIZE + 1];
 
 	git_oid_tostr(oidstr, sizeof(oidstr), git_tag_target_id(tag));;
 	printf("object %s\n", oidstr);
@@ -125,15 +125,15 @@ int lg2_cat_file(git_repository *repo, int argc, char *argv[])
 {
 	struct catfile_options o = { ".", NULL, 0, 0 };
 	git_object *obj = NULL;
-	char oidstr[GIT_OID_HEXSZ + 1];
+	char oidstr[GIT_OID_SHA1_HEXSIZE + 1];
 
 	parse_opts(&o, argc, argv);
 
 	check_lg2(git_revparse_single(&obj, repo, o.rev),
 			"Could not resolve", o.rev);
 
 	if (o.verbose) {
-		char oidstr[GIT_OID_HEXSZ + 1];
+		char oidstr[GIT_OID_SHA1_HEXSIZE + 1];
 		git_oid_tostr(oidstr, sizeof(oidstr), git_object_id(obj));
 
 		printf("%s %s\n--\n",

examples/fetch.c

@@ -15,17 +15,17 @@ static int progress_cb(const char *str, int len, void *data)
  */
 static int update_cb(const char *refname, const git_oid *a, const git_oid *b, void *data)
 {
-	char a_str[GIT_OID_HEXSZ+1], b_str[GIT_OID_HEXSZ+1];
+	char a_str[GIT_OID_SHA1_HEXSIZE+1], b_str[GIT_OID_SHA1_HEXSIZE+1];
 	(void)data;
 
 	git_oid_fmt(b_str, b);
-	b_str[GIT_OID_HEXSZ] = '\0';
+	b_str[GIT_OID_SHA1_HEXSIZE] = '\0';
 
 	if (git_oid_is_zero(a)) {
 		printf("[new]     %.20s %s\n", b_str, refname);
 	} else {
 		git_oid_fmt(a_str, a);
-		a_str[GIT_OID_HEXSZ] = '\0';
+		a_str[GIT_OID_SHA1_HEXSIZE] = '\0';
 		printf("[updated] %.10s..%.10s %s\n", a_str, b_str, refname);
 	}
 

examples/for-each-ref.c

@@ -5,7 +5,7 @@ static int show_ref(git_reference *ref, void *data)
 {
 	git_repository *repo = data;
 	git_reference *resolved = NULL;
-	char hex[GIT_OID_HEXSZ+1];
+	char hex[GIT_OID_SHA1_HEXSIZE+1];
 	const git_oid *oid;
 	git_object *obj;
 
@@ -16,7 +16,7 @@ static int show_ref(git_reference *ref, void *data)
 
 	oid = git_reference_target(resolved ? resolved : ref);
 	git_oid_fmt(hex, oid);
-	hex[GIT_OID_HEXSZ] = 0;
+	hex[GIT_OID_SHA1_HEXSIZE] = 0;
 	check_lg2(git_object_lookup(&obj, repo, oid, GIT_OBJECT_ANY),
 			  "Unable to lookup object", hex);
 

examples/general.c

@@ -129,7 +129,7 @@ int lg2_general(git_repository *repo, int argc, char** argv)
  */
 static void oid_parsing(git_oid *oid)
 {
-	char out[GIT_OID_HEXSZ+1];
+	char out[GIT_OID_SHA1_HEXSIZE+1];
 	char hex[] = "4a202b346bb0fb0db7eff3cffeb3c70babbd2045";
 
 	printf("*Hex to Raw*\n");
@@ -142,7 +142,7 @@ static void oid_parsing(git_oid *oid)
 	 * this throughout the example for storing the value of the current SHA
 	 * key we're working with.
 	 */
-	git_oid_fromstr(oid, hex);
+	git_oid_fromstr(oid, hex, GIT_OID_SHA1);
 
 	/*
 	 * Once we've converted the string into the oid value, we can get the raw
@@ -152,7 +152,7 @@ static void oid_parsing(git_oid *oid)
 	 * char hex value.
 	 */
 	printf("\n*Raw to Hex*\n");
-	out[GIT_OID_HEXSZ] = '\0';
+	out[GIT_OID_SHA1_HEXSIZE] = '\0';
 
 	/**
 	 * If you have a oid, you can easily get the hex value of the SHA as well.
@@ -173,7 +173,7 @@ static void oid_parsing(git_oid *oid)
  */
 static void object_database(git_repository *repo, git_oid *oid)
 {
-	char oid_hex[GIT_OID_HEXSZ+1] = { 0 };
+	char oid_hex[GIT_OID_SHA1_HEXSIZE+1] = { 0 };
 	const unsigned char *data;
 	const char *str_type;
 	int error;
@@ -266,7 +266,7 @@ static void commit_writing(git_repository *repo)
 	git_tree *tree;
 	git_commit *parent;
 	git_signature *author, *committer;
-	char oid_hex[GIT_OID_HEXSZ+1] = { 0 };
+	char oid_hex[GIT_OID_SHA1_HEXSIZE+1] = { 0 };
 
 	printf("\n*Commit Writing*\n");
 
@@ -287,9 +287,9 @@ static void commit_writing(git_repository *repo)
 	 * parents.  Here we're creating oid objects to create the commit with,
 	 * but you can also use
 	 */
-	git_oid_fromstr(&tree_id, "f60079018b664e4e79329a7ef9559c8d9e0378d1");
+	git_oid_fromstr(&tree_id, "f60079018b664e4e79329a7ef9559c8d9e0378d1", GIT_OID_SHA1);
 	git_tree_lookup(&tree, repo, &tree_id);
-	git_oid_fromstr(&parent_id, "5b5b025afb0b4c913b4c338a42934a3863bf3644");
+	git_oid_fromstr(&parent_id, "5b5b025afb0b4c913b4c338a42934a3863bf3644", GIT_OID_SHA1);
 	git_commit_lookup(&parent, repo, &parent_id);
 
 	/**
@@ -345,15 +345,15 @@ static void commit_parsing(git_repository *repo)
 	const git_signature *author, *cmtter;
 	git_commit *commit, *parent;
 	git_oid oid;
-	char oid_hex[GIT_OID_HEXSZ+1];
+	char oid_hex[GIT_OID_SHA1_HEXSIZE+1];
 	const char *message;
 	unsigned int parents, p;
 	int error;
 	time_t time;
 
 	printf("\n*Commit Parsing*\n");
 
-	git_oid_fromstr(&oid, "8496071c1b46c854b31185ea97743be6a8774479");
+	git_oid_fromstr(&oid, "8496071c1b46c854b31185ea97743be6a8774479", GIT_OID_SHA1);
 
 	error = git_commit_lookup(&commit, repo, &oid);
 	check_error(error, "looking up commit");
@@ -422,7 +422,7 @@ static void tag_parsing(git_repository *repo)
 	 * We create an oid for the tag object if we know the SHA and look it up
 	 * the same way that we would a commit (or any other object).
 	 */
-	git_oid_fromstr(&oid, "b25fa35b38051e4ae45d4222e795f9df2e43f1d1");
+	git_oid_fromstr(&oid, "b25fa35b38051e4ae45d4222e795f9df2e43f1d1", GIT_OID_SHA1);
 
 	error = git_tag_lookup(&tag, repo, &oid);
 	check_error(error, "looking up tag");
@@ -470,7 +470,7 @@ static void tree_parsing(git_repository *repo)
 	/**
 	 * Create the oid and lookup the tree object just like the other objects.
 	 */
-	git_oid_fromstr(&oid, "f60079018b664e4e79329a7ef9559c8d9e0378d1");
+	git_oid_fromstr(&oid, "f60079018b664e4e79329a7ef9559c8d9e0378d1", GIT_OID_SHA1);
 	git_tree_lookup(&tree, repo, &oid);
 
 	/**
@@ -524,7 +524,7 @@ static void blob_parsing(git_repository *repo)
 
 	printf("\n*Blob Parsing*\n");
 
-	git_oid_fromstr(&oid, "1385f264afb75a56a5bec74243be9b367ba4ca08");
+	git_oid_fromstr(&oid, "1385f264afb75a56a5bec74243be9b367ba4ca08", GIT_OID_SHA1);
 	git_blob_lookup(&blob, repo, &oid);
 
 	/**
@@ -566,7 +566,7 @@ static void revwalking(git_repository *repo)
 
 	printf("\n*Revwalking*\n");
 
-	git_oid_fromstr(&oid, "5b5b025afb0b4c913b4c338a42934a3863bf3644");
+	git_oid_fromstr(&oid, "5b5b025afb0b4c913b4c338a42934a3863bf3644", GIT_OID_SHA1);
 
 	/**
 	 * To use the revwalker, create a new walker, tell it how you want to sort
@@ -679,7 +679,7 @@ static void reference_listing(git_repository *repo)
 
 	for (i = 0; i < ref_list.count; ++i) {
 		git_reference *ref;
-		char oid_hex[GIT_OID_HEXSZ+1] = GIT_OID_HEX_ZERO;
+		char oid_hex[GIT_OID_SHA1_HEXSIZE+1] = GIT_OID_SHA1_HEXZERO;
 		const char *refname;
 
 		refname = ref_list.strings[i];

examples/log.c

@@ -329,7 +329,7 @@ static void print_time(const git_time *intime, const char *prefix)
 /** Helper to print a commit object. */
 static void print_commit(git_commit *commit, struct log_options *opts)
 {
-	char buf[GIT_OID_HEXSZ + 1];
+	char buf[GIT_OID_SHA1_HEXSIZE + 1];
 	int i, count;
 	const git_signature *sig;
 	const char *scan, *eol;