Add missing CertificateCheckHandler parameter to some APIs (#15)

A-Ovchinnikov-mx · A-Ovchinnikov-mx · commit 46b4119e9936 · 2022-07-18T18:28:03.000+02:00
Bump version to 1.111.100 as it's a breaking change
diff --git a/LibGit2Sharp.Tests/NetworkFixture.cs b/LibGit2Sharp.Tests/NetworkFixture.cs
@@ -127,7 +127,8 @@ public void CanListRemoteReferencesWithCredentials()
             {
                 Remote remote = repo.Network.Remotes.Add(remoteName, Constants.PrivateRepoUrl);
 
-                var references = repo.Network.ListReferences(remote, Constants.PrivateRepoCredentials, new ProxyOptions());
+                var references = repo.Network.ListReferences(remote,
+                    Constants.PrivateRepoCredentials, Constants.PrivateRepoCertificateCheck, new ProxyOptions());
 
                 foreach (var reference in references)
                 {
diff --git a/LibGit2Sharp.Tests/RepositoryFixture.cs b/LibGit2Sharp.Tests/RepositoryFixture.cs
@@ -697,7 +697,7 @@ public void CanListRemoteReferencesWithCredentials()
                 "Populate Constants.PrivateRepo* to run this test");
 
             IEnumerable<Reference> references = Repository.ListRemoteReferences(Constants.PrivateRepoUrl,
-                Constants.PrivateRepoCredentials, new ProxyOptions());
+                Constants.PrivateRepoCredentials, Constants.PrivateRepoCertificateCheck, new ProxyOptions());
 
             foreach (var reference in references)
             {
diff --git a/LibGit2Sharp.Tests/TestHelpers/Constants.cs b/LibGit2Sharp.Tests/TestHelpers/Constants.cs
@@ -51,6 +51,11 @@ public static Credentials PrivateRepoCredentials(string url, string usernameFrom
             return null;
         }
 
+        public static bool PrivateRepoCertificateCheck(Certificate certificate, bool valid, string host)
+        {
+            return true;
+        }
+
         public static string BuildPath()
         {
             string tempPath = null;
diff --git a/LibGit2Sharp/Network.cs b/LibGit2Sharp/Network.cs
@@ -52,7 +52,7 @@ public virtual IEnumerable<Reference> ListReferences(Remote remote)
         {
             Ensure.ArgumentNotNull(remote, "remote");
 
-            return ListReferencesInternal(remote.Url, null, null);
+            return ListReferencesInternal(remote.Url, null, null, null);
         }
 
         /// <summary>
@@ -66,14 +66,19 @@ public virtual IEnumerable<Reference> ListReferences(Remote remote)
         /// </summary>
         /// <param name="remote">The <see cref="Remote"/> to list from.</param>
         /// <param name="credentialsProvider">The <see cref="Func{Credentials}"/> used to connect to remote repository.</param>
+        /// <param name="certificateCheckHandler">The <see cref="CertificateCheckHandler"/> used to resolve SSL certificate errors.</param>
         /// <param name="proxyOptions"><see cref="ProxyOptions"/> controlling proxy settings</param>
         /// <returns>The references in the <see cref="Remote"/> repository.</returns>
-        public virtual IEnumerable<Reference> ListReferences(Remote remote, CredentialsHandler credentialsProvider, ProxyOptions proxyOptions)
+        public virtual IEnumerable<Reference> ListReferences(
+            Remote remote,
+            CredentialsHandler credentialsProvider,
+            CertificateCheckHandler certificateCheckHandler,
+            ProxyOptions proxyOptions)
         {
             Ensure.ArgumentNotNull(remote, "remote");
             Ensure.ArgumentNotNull(credentialsProvider, "credentialsProvider");
 
-            return ListReferencesInternal(remote.Url, credentialsProvider, proxyOptions);
+            return ListReferencesInternal(remote.Url, credentialsProvider, certificateCheckHandler, proxyOptions);
         }
 
         /// <summary>
@@ -91,7 +96,7 @@ public virtual IEnumerable<Reference> ListReferences(string url)
         {
             Ensure.ArgumentNotNull(url, "url");
 
-            return ListReferencesInternal(url, null, null);
+            return ListReferencesInternal(url, null, null, null);
         }
 
         /// <summary>
@@ -105,17 +110,26 @@ public virtual IEnumerable<Reference> ListReferences(string url)
         /// </summary>
         /// <param name="url">The url to list from.</param>
         /// <param name="credentialsProvider">The <see cref="Func{Credentials}"/> used to connect to remote repository.</param>
+        /// <param name="certificateCheckHandler">The <see cref="CertificateCheckHandler"/> used to resolve SSL certificate errors.</param>
         /// <param name="proxyOptions"><see cref="ProxyOptions"/> controlling proxy settings</param>
         /// <returns>The references in the remote repository.</returns>
-        public virtual IEnumerable<Reference> ListReferences(string url, CredentialsHandler credentialsProvider, ProxyOptions proxyOptions)
+        public virtual IEnumerable<Reference> ListReferences(
+            string url,
+            CredentialsHandler credentialsProvider,
+            CertificateCheckHandler certificateCheckHandler,
+            ProxyOptions proxyOptions)
         {
             Ensure.ArgumentNotNull(url, "url");
             Ensure.ArgumentNotNull(credentialsProvider, "credentialsProvider");
 
-            return ListReferencesInternal(url, credentialsProvider, proxyOptions);
+            return ListReferencesInternal(url, credentialsProvider, certificateCheckHandler, proxyOptions);
         }
 
-        private IEnumerable<Reference> ListReferencesInternal(string url, CredentialsHandler credentialsProvider, ProxyOptions proxyOptions)
+        private IEnumerable<Reference> ListReferencesInternal(
+            string url,
+            CredentialsHandler credentialsProvider,
+            CertificateCheckHandler certificateCheckHandler,
+            ProxyOptions proxyOptions)
         {
             using (RemoteHandle remoteHandle = BuildRemoteHandle(repository.Handle, url))
             using (GitProxyOptionsWrapper proxyOptionsWrapper = new GitProxyOptionsWrapper(proxyOptions))
@@ -125,7 +139,7 @@ private IEnumerable<Reference> ListReferencesInternal(string url, CredentialsHan
 
                 if (credentialsProvider != null)
                 {
-                    var callbacks = new RemoteCallbacks(credentialsProvider);
+                    var callbacks = new RemoteCallbacks(credentialsProvider, certificateCheckHandler);
                     gitCallbacks = callbacks.GenerateCallbacks();
                 }
 
diff --git a/LibGit2Sharp/RemoteCallbacks.cs b/LibGit2Sharp/RemoteCallbacks.cs
@@ -18,10 +18,6 @@ internal RemoteCallbacks(CredentialsHandler credentialsProvider, CertificateChec
             CertificateCheck = certificateCheck;
         }
 
-        internal RemoteCallbacks(CredentialsHandler credentialsProvider)
-            : this(credentialsProvider, null)
-        { }
-
         internal RemoteCallbacks(PushOptions pushOptions)
         {
             if (pushOptions == null)
diff --git a/LibGit2Sharp/Repository.cs b/LibGit2Sharp/Repository.cs
@@ -673,7 +673,7 @@ internal Commit LookupCommit(string committish)
         /// <returns>The references in the remote repository.</returns>
         public static IEnumerable<Reference> ListRemoteReferences(string url)
         {
-            return ListRemoteReferences(url, null, null);
+            return ListRemoteReferences(url, null, null, null);
         }
 
         /// <summary>
@@ -686,15 +686,20 @@ public static IEnumerable<Reference> ListRemoteReferences(string url)
         /// </para>
         /// <param name="url">The url to list from.</param>
         /// <param name="credentialsProvider">The <see cref="Func{Credentials}"/> used to connect to remote repository.</param>
+        /// <param name="certificateCheckHandler">The <see cref="CertificateCheckHandler"/> used to resolve SSL certificate errors.</param>
         /// <param name="proxyOptions"><see cref="ProxyOptions"/> controlling proxy settings.</param>
         /// <returns>The references in the remote repository.</returns>
-        public static IEnumerable<Reference> ListRemoteReferences(string url, CredentialsHandler credentialsProvider, ProxyOptions proxyOptions)
+        public static IEnumerable<Reference> ListRemoteReferences(
+            string url,
+            CredentialsHandler credentialsProvider,
+            CertificateCheckHandler certificateCheckHandler,
+            ProxyOptions proxyOptions)
         {
             Ensure.ArgumentNotNull(url, "url");
 
             using (RepositoryHandle repositoryHandle = Proxy.git_repository_new())
             using (GitProxyOptionsWrapper proxyOptionsWrapper = new GitProxyOptionsWrapper(proxyOptions))
-            using (RemoteHandle remoteHandle = ConnectToAnonymousRemote(repositoryHandle, url, credentialsProvider, proxyOptionsWrapper.GitProxyOptions))
+            using (RemoteHandle remoteHandle = ConnectToAnonymousRemote(repositoryHandle, url, credentialsProvider, certificateCheckHandler, proxyOptionsWrapper.GitProxyOptions))
             {
                 return Proxy.git_remote_ls(null, remoteHandle);
             }
@@ -705,29 +710,39 @@ public static IEnumerable<Reference> ListRemoteReferences(string url, Credential
         /// </summary>
         /// <param name="url">The url to retrieve from.</param>
         /// <param name="credentialsProvider">The <see cref="Func{Credentials}"/> used to connect to remote repository.</param>
+        /// <param name="certificateCheckHandler">The <see cref="CertificateCheckHandler"/> used to resolve SSL certificate errors.</param>
         /// <param name="proxyOptions"><see cref="ProxyOptions"/> controlling proxy settings.</param>
         /// <returns>The reference name.</returns>
-        public static string GetRemoteDefaultBranch(string url, CredentialsHandler credentialsProvider, ProxyOptions proxyOptions)
+        public static string GetRemoteDefaultBranch(
+            string url,
+            CredentialsHandler credentialsProvider,
+            CertificateCheckHandler certificateCheckHandler,
+            ProxyOptions proxyOptions)
         {
             Ensure.ArgumentNotNull(url, "url");
 
             using (RepositoryHandle repositoryHandle = Proxy.git_repository_new())
             using (GitProxyOptionsWrapper proxyOptionsWrapper = new GitProxyOptionsWrapper(proxyOptions))
-            using (RemoteHandle remoteHandle = ConnectToAnonymousRemote(repositoryHandle, url, credentialsProvider, proxyOptionsWrapper.GitProxyOptions))
+            using (RemoteHandle remoteHandle = ConnectToAnonymousRemote(repositoryHandle, url, credentialsProvider, certificateCheckHandler, proxyOptionsWrapper.GitProxyOptions))
             {
                 return Proxy.git_remote_default_branch(remoteHandle);
             }
         }
 
-        private static RemoteHandle ConnectToAnonymousRemote(RepositoryHandle repositoryHandle, string url, CredentialsHandler credentialsProvider, GitProxyOptions proxyOptions)
+        private static RemoteHandle ConnectToAnonymousRemote(
+            RepositoryHandle repositoryHandle,
+            string url,
+            CredentialsHandler credentialsProvider,
+            CertificateCheckHandler certificateCheckHandler,
+            GitProxyOptions proxyOptions)
         {
             RemoteHandle remoteHandle = Proxy.git_remote_create_anonymous(repositoryHandle, url);
 
             var gitCallbacks = new GitRemoteCallbacks { version = 1 };
 
             if (credentialsProvider != null)
             {
-                var callbacks = new RemoteCallbacks(credentialsProvider);
+                var callbacks = new RemoteCallbacks(credentialsProvider, certificateCheckHandler);
                 gitCallbacks = callbacks.GenerateCallbacks();
             }
 
diff --git a/version.json b/version.json
@@ -1,6 +1,6 @@
 {
   "$schema": "https://raw.githubusercontent.com/AArnott/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json",
-  "version": "1.111.0",
+  "version": "1.111.100",
   "cloudBuild": {
     "buildNumber": {
       "enabled": true

Original file line number	Diff line number	Diff line change
`@@ -127,7 +127,8 @@ public void CanListRemoteReferencesWithCredentials()`
`127`	`127`	`{`
`128`	`128`	`Remote remote = repo.Network.Remotes.Add(remoteName, Constants.PrivateRepoUrl);`
`129`	`129`
`130`		`- var references = repo.Network.ListReferences(remote, Constants.PrivateRepoCredentials, new ProxyOptions());`
	`130`	`+ var references = repo.Network.ListReferences(remote,`
	`131`	`+ Constants.PrivateRepoCredentials, Constants.PrivateRepoCertificateCheck, new ProxyOptions());`
`131`	`132`
`132`	`133`	`foreach (var reference in references)`
`133`	`134`	`{`
Original file line number	Diff line number	Diff line change
`@@ -697,7 +697,7 @@ public void CanListRemoteReferencesWithCredentials()`
`697`	`697`	`"Populate Constants.PrivateRepo* to run this test");`
`698`	`698`
`699`	`699`	`IEnumerable<Reference> references = Repository.ListRemoteReferences(Constants.PrivateRepoUrl,`
`700`		`- Constants.PrivateRepoCredentials, new ProxyOptions());`
	`700`	`+ Constants.PrivateRepoCredentials, Constants.PrivateRepoCertificateCheck, new ProxyOptions());`
`701`	`701`
`702`	`702`	`foreach (var reference in references)`
`703`	`703`	`{`
Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,11 @@ public static Credentials PrivateRepoCredentials(string url, string usernameFrom`
`51`	`51`	`return null;`
`52`	`52`	`}`
`53`	`53`
	`54`	`+ public static bool PrivateRepoCertificateCheck(Certificate certificate, bool valid, string host)`
	`55`	`+ {`
	`56`	`+ return true;`
	`57`	`+ }`
	`58`	`+`
`54`	`59`	`public static string BuildPath()`
`55`	`60`	`{`
`56`	`61`	`string tempPath = null;`
Original file line number	Diff line number	Diff line change
`@@ -18,10 +18,6 @@ internal RemoteCallbacks(CredentialsHandler credentialsProvider, CertificateChec`
`18`	`18`	`CertificateCheck = certificateCheck;`
`19`	`19`	`}`
`20`	`20`
`21`		`- internal RemoteCallbacks(CredentialsHandler credentialsProvider)`
`22`		`- : this(credentialsProvider, null)`
`23`		`- { }`
`24`		`-`
`25`	`21`	`internal RemoteCallbacks(PushOptions pushOptions)`
`26`	`22`	`{`
`27`	`23`	`if (pushOptions == null)`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"$schema": "https://raw.githubusercontent.com/AArnott/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json",`
`3`		`- "version": "1.111.0",`
	`3`	`+ "version": "1.111.100",`
`4`	`4`	`"cloudBuild": {`
`5`	`5`	`"buildNumber": {`
`6`	`6`	`"enabled": true`