Support libssh2 based callbacks

zentron · zentron · commit d6faf5bce6b4 · 2026-03-16T15:41:26.000+10:00
diff --git a/LibGit2Sharp.Tests/LibGit2Sharp.Tests.csproj b/LibGit2Sharp.Tests/LibGit2Sharp.Tests.csproj
@@ -1,13 +1,13 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks Condition="'$(TargetFrameworks)'==''">net472;net8.0;net9.0</TargetFrameworks>
+    <TargetFrameworks Condition="'$(TargetFrameworks)'==''">net10.0</TargetFrameworks>
   </PropertyGroup>
 
   <ItemGroup>
     <ProjectReference Include="..\LibGit2Sharp\LibGit2Sharp.csproj" />
-    <ProjectReference Include="..\NativeLibraryLoadTestApp\x86\NativeLibraryLoadTestApp.x86.csproj" Condition="'$(TargetFramework)' == 'net472'" ReferenceOutputAssembly="false" OutputItemType="TestAppExe" />
-    <ProjectReference Include="..\NativeLibraryLoadTestApp\x64\NativeLibraryLoadTestApp.x64.csproj" Condition="'$(TargetFramework)' == 'net472'" ReferenceOutputAssembly="false" OutputItemType="TestAppExe" />
+    <!--<ProjectReference Include="..\NativeLibraryLoadTestApp\x86\NativeLibraryLoadTestApp.x86.csproj" Condition="'$(TargetFramework)' == 'net472'" ReferenceOutputAssembly="false" OutputItemType="TestAppExe" />
+    <ProjectReference Include="..\NativeLibraryLoadTestApp\x64\NativeLibraryLoadTestApp.x64.csproj" Condition="'$(TargetFramework)' == 'net472'" ReferenceOutputAssembly="false" OutputItemType="TestAppExe" />-->
   </ItemGroup>
 
   <ItemGroup>
diff --git a/LibGit2Sharp.Tests/NetworkFixture.cs b/LibGit2Sharp.Tests/NetworkFixture.cs
@@ -9,8 +9,8 @@ namespace LibGit2Sharp.Tests
     public class NetworkFixture : BaseFixture
     {
         [Theory]
-        [InlineData("http://github.com/libgit2/TestGitRepository")]
-        [InlineData("https://github.com/libgit2/TestGitRepository")]
+        //[InlineData("http://github.com/libgit2/TestGitRepository")]
+        [InlineData("git@github.com:libgit2/TestGitRepository.git")]
         public void CanListRemoteReferences(string url)
         {
             string remoteName = "testRemote";
@@ -20,7 +20,11 @@ public void CanListRemoteReferences(string url)
             using (var repo = new Repository(repoPath))
             {
                 Remote remote = repo.Network.Remotes.Add(remoteName, url);
-                IList<Reference> references = repo.Network.ListReferences(remote).ToList();
+                IList<Reference> references = repo.Network.ListReferences(remote, (s, fromUrl, types) =>
+                {
+
+                    return null;
+                }).ToList();
 
 
                 foreach (var reference in references)
diff --git a/LibGit2Sharp/Core/SshExtensions.cs b/LibGit2Sharp/Core/SshExtensions.cs
@@ -0,0 +1,141 @@
+
+    using LibGit2Sharp.Core;
+using System;
+using System.Runtime.InteropServices;
+
+namespace LibGit2Sharp.Ssh
+{
+
+    internal static class NativeMethods
+    {
+        private const string libgit2 = NativeDllName.Name;
+
+        [DllImport(libgit2, CallingConvention = CallingConvention.Cdecl)]
+        internal static extern int git_cred_ssh_key_new(
+             out IntPtr cred,
+             [MarshalAs(UnmanagedType.CustomMarshaler, MarshalCookie = UniqueId.UniqueIdentifier, MarshalTypeRef = typeof(StrictUtf8Marshaler))] string username,
+             [MarshalAs(UnmanagedType.CustomMarshaler, MarshalCookie = UniqueId.UniqueIdentifier, MarshalTypeRef = typeof(StrictUtf8Marshaler))] string publickey,
+             [MarshalAs(UnmanagedType.CustomMarshaler, MarshalCookie = UniqueId.UniqueIdentifier, MarshalTypeRef = typeof(StrictUtf8Marshaler))] string privatekey,
+             [MarshalAs(UnmanagedType.CustomMarshaler, MarshalCookie = UniqueId.UniqueIdentifier, MarshalTypeRef = typeof(StrictUtf8Marshaler))] string passphrase);
+
+        [DllImport(libgit2)]
+        internal static extern int git_cred_ssh_key_memory_new(
+              out IntPtr cred,
+              [MarshalAs(UnmanagedType.CustomMarshaler, MarshalCookie = UniqueId.UniqueIdentifier, MarshalTypeRef = typeof(StrictUtf8Marshaler))] string username,
+              [MarshalAs(UnmanagedType.CustomMarshaler, MarshalCookie = UniqueId.UniqueIdentifier, MarshalTypeRef = typeof(StrictUtf8Marshaler))] string publickey,
+              [MarshalAs(UnmanagedType.CustomMarshaler, MarshalCookie = UniqueId.UniqueIdentifier, MarshalTypeRef = typeof(StrictUtf8Marshaler))] string privatekey,
+              [MarshalAs(UnmanagedType.CustomMarshaler, MarshalCookie = UniqueId.UniqueIdentifier, MarshalTypeRef = typeof(StrictUtf8Marshaler))] string passphrase);
+    }
+
+    /// <summary>
+    /// Class that holds SSH username with key credentials for remote repository access.
+    /// </summary>
+    public sealed class SshUserKeyCredentials : Credentials
+    {
+        /// <summary>
+        /// Callback to acquire a credential object.
+        /// </summary>
+        /// <param name="cred">The newly created credential object.</param>
+        /// <returns>0 for success, &lt; 0 to indicate an error, &gt; 0 to indicate no credential was acquired.</returns>
+        protected internal override int GitCredentialHandler(out IntPtr cred)
+        {
+            if (Username == null)
+            {
+                throw new InvalidOperationException("SshUserKeyCredentials contains a null Username.");
+            }
+
+            if (Passphrase == null)
+            {
+                throw new InvalidOperationException("SshUserKeyCredentials contains a null Passphrase.");
+            }
+
+            if (PublicKey == null)
+            {
+                throw new InvalidOperationException("SshUserKeyCredentials contains a null PublicKey.");
+            }
+
+            if (PrivateKey == null)
+            {
+                throw new InvalidOperationException("SshUserKeyCredentials contains a null PrivateKey.");
+            }
+
+            return NativeMethods.git_cred_ssh_key_new(out cred, Username, PublicKey, PrivateKey, Passphrase);
+        }
+
+        /// <summary>
+        /// Username for SSH authentication.
+        /// </summary>
+        public string Username { get; set; }
+
+        /// <summary>
+        /// Public key file location for SSH authentication.
+        /// </summary>
+        public string PublicKey { get; set; }
+
+        /// <summary>
+        /// Private key file location for SSH authentication.
+        /// </summary>
+        public string PrivateKey { get; set; }
+
+        /// <summary>
+        /// Passphrase for SSH authentication.
+        /// </summary>
+        public string Passphrase { get; set; }
+    }
+
+    /// <summary>
+    /// Class that holds SSH username with in-memory key credentials for remote repository access.
+    /// </summary>
+    public sealed class SshUserKeyMemoryCredentials : Credentials
+    {
+        /// <summary>
+        /// Callback to acquire a credential object.
+        /// </summary>
+        /// <param name="cred">The newly created credential object.</param>
+        /// <returns>0 for success, &lt; 0 to indicate an error, &gt; 0 to indicate no credential was acquired.</returns>
+        protected internal override int GitCredentialHandler(out IntPtr cred)
+        {
+            if (Username == null)
+            {
+                throw new InvalidOperationException("SshUserKeyMemoryCredentials contains a null Username.");
+            }
+
+            if (Passphrase == null)
+            {
+                throw new InvalidOperationException("SshUserKeyMemoryCredentials contains a null Passphrase.");
+            }
+
+            if (PublicKey == null)
+            {
+                //throw new InvalidOperationException("SshUserKeyMemoryCredentials contains a null PublicKey.");
+            }
+
+            if (PrivateKey == null)
+            {
+                throw new InvalidOperationException("SshUserKeyMemoryCredentials contains a null PrivateKey.");
+            }
+
+            return NativeMethods.git_cred_ssh_key_memory_new(out cred, Username, PublicKey, PrivateKey, Passphrase);
+        }
+
+        /// <summary>
+        /// Username for SSH authentication.
+        /// </summary>
+        public string Username { get; set; }
+
+        /// <summary>
+        /// Public key for SSH authentication.
+        /// </summary>
+        public string PublicKey { get; set; }
+
+        /// <summary>
+        /// Private key for SSH authentication.
+        /// </summary>
+        public string PrivateKey { get; set; }
+
+        /// <summary>
+        /// Passphrase for SSH authentication.
+        /// </summary>
+        public string Passphrase { get; set; }
+    }
+}
diff --git a/LibGit2Sharp/GlobalSettings.cs b/LibGit2Sharp/GlobalSettings.cs
@@ -20,7 +20,7 @@ public static class GlobalSettings
 
         private static string nativeLibraryPath;
         private static bool nativeLibraryPathLocked;
-        private static readonly string nativeLibraryDefaultPath = null;
+        private static readonly string nativeLibraryDefaultPath = "/Users/robert/Development/Sandbox/libgit2/build";
 
         static GlobalSettings()
         {
diff --git a/LibGit2Sharp/ListRemoteOptions.cs b/LibGit2Sharp/ListRemoteOptions.cs
@@ -0,0 +1,26 @@
+using LibGit2Sharp.Handlers;
+
+namespace LibGit2Sharp;
+
+/// <summary>
+/// Options controlling ListRemote behavior.
+/// </summary>
+public sealed class ListRemoteOptions
+{
+    /// <summary>
+    /// Handler to generate <see cref="LibGit2Sharp.Credentials"/> for authentication.
+    /// </summary>
+    public CredentialsHandler CredentialsProvider { get; set; }
+
+    /// <summary>
+    /// This handler will be called to let the user make a decision on whether to allow
+    /// the connection to proceed based on the certificate presented by the server.
+    /// </summary>
+    public CertificateCheckHandler CertificateCheck { get; set; }
+
+
+    /// <summary>
+    /// Options for connecting through a proxy.
+    /// </summary>
+    public ProxyOptions ProxyOptions { get; set; } = new();
+}
diff --git a/LibGit2Sharp/Network.cs b/LibGit2Sharp/Network.cs
@@ -52,9 +52,34 @@ public virtual IEnumerable<Reference> ListReferences(Remote remote)
         {
             Ensure.ArgumentNotNull(remote, "remote");
 
-            return ListReferencesInternal(remote.Url, null, new ProxyOptions());
+            var options = new ListRemoteOptions()
+            {
+                ProxyOptions = new ProxyOptions()
+            };
+
+            return ListReferencesInternal(remote.Url, options);
+        }
+
+        /// <summary>
+        /// List references in a <see cref="Remote"/> repository.
+        /// <para>
+        /// When the remote tips are ahead of the local ones, the retrieved
+        /// <see cref="DirectReference"/>s may point to non existing
+        /// <see cref="GitObject"/>s in the local repository. In that
+        /// case, <see cref="DirectReference.Target"/> will return <c>null</c>.
+        /// </para>
+        /// </summary>
+        /// <param name="remote">The <see cref="Remote"/> to list from.</param>
+        /// <param name="options">The options for the remote request.</param>
+        /// <returns>The references in the <see cref="Remote"/> repository.</returns>
+        public virtual IEnumerable<Reference> ListReferences(Remote remote, ListRemoteOptions options)
+        {
+            Ensure.ArgumentNotNull(remote, "remote");
+
+            return ListReferencesInternal(remote.Url, options);
         }
 
+
         /// <summary>
         /// List references in a <see cref="Remote"/> repository.
         /// <para>
@@ -71,7 +96,12 @@ public virtual IEnumerable<Reference> ListReferences(Remote remote, ProxyOptions
         {
             Ensure.ArgumentNotNull(remote, "remote");
 
-            return ListReferencesInternal(remote.Url, null, proxyOptions);
+            var options = new ListRemoteOptions()
+            {
+                ProxyOptions = proxyOptions
+            };
+
+            return ListReferencesInternal(remote.Url, options);
         }
 
         /// <summary>
@@ -91,7 +121,13 @@ public virtual IEnumerable<Reference> ListReferences(Remote remote, CredentialsH
             Ensure.ArgumentNotNull(remote, "remote");
             Ensure.ArgumentNotNull(credentialsProvider, "credentialsProvider");
 
-            return ListReferencesInternal(remote.Url, credentialsProvider, new ProxyOptions());
+            var options = new ListRemoteOptions()
+            {
+                ProxyOptions = new ProxyOptions(),
+                CredentialsProvider = credentialsProvider
+            };
+
+            return ListReferencesInternal(remote.Url, options);
         }
 
         /// <summary>
@@ -112,7 +148,32 @@ public virtual IEnumerable<Reference> ListReferences(Remote remote, CredentialsH
             Ensure.ArgumentNotNull(remote, "remote");
             Ensure.ArgumentNotNull(credentialsProvider, "credentialsProvider");
 
-            return ListReferencesInternal(remote.Url, credentialsProvider, proxyOptions);
+            var options = new ListRemoteOptions()
+            {
+                ProxyOptions = proxyOptions,
+                CredentialsProvider = credentialsProvider
+            };
+
+            return ListReferencesInternal(remote.Url, options);
+        }
+
+        /// <summary>
+        /// List references in a remote repository.
+        /// <para>
+        /// When the remote tips are ahead of the local ones, the retrieved
+        /// <see cref="DirectReference"/>s may point to non existing
+        /// <see cref="GitObject"/>s in the local repository. In that
+        /// case, <see cref="DirectReference.Target"/> will return <c>null</c>.
+        /// </para>
+        /// </summary>
+        /// <param name="url">The url to list from.</param>
+        /// <param name="options">The options for the remote request.</param>
+        /// <returns>The references in the remote repository.</returns>
+        public virtual IEnumerable<Reference> ListReferences(string url, ListRemoteOptions options)
+        {
+            Ensure.ArgumentNotNull(url, "url");
+
+            return ListReferencesInternal(url, options);
         }
 
         /// <summary>
@@ -130,7 +191,12 @@ public virtual IEnumerable<Reference> ListReferences(string url)
         {
             Ensure.ArgumentNotNull(url, "url");
 
-            return ListReferencesInternal(url, null, new ProxyOptions());
+            var options = new ListRemoteOptions()
+            {
+                ProxyOptions =  new ProxyOptions()
+            };
+
+            return ListReferencesInternal(url, options);
         }
 
         /// <summary>
@@ -148,8 +214,12 @@ public virtual IEnumerable<Reference> ListReferences(string url)
         public virtual IEnumerable<Reference> ListReferences(string url, ProxyOptions proxyOptions)
         {
             Ensure.ArgumentNotNull(url, "url");
+            var options = new ListRemoteOptions()
+            {
+                ProxyOptions = proxyOptions
+            };
 
-            return ListReferencesInternal(url, null, proxyOptions);
+            return ListReferencesInternal(url, options);
         }
 
         /// <summary>
@@ -169,7 +239,13 @@ public virtual IEnumerable<Reference> ListReferences(string url, CredentialsHand
             Ensure.ArgumentNotNull(url, "url");
             Ensure.ArgumentNotNull(credentialsProvider, "credentialsProvider");
 
-            return ListReferencesInternal(url, credentialsProvider, new ProxyOptions());
+            var options = new ListRemoteOptions()
+            {
+                CredentialsProvider = credentialsProvider,
+                ProxyOptions = new ProxyOptions()
+            };
+
+            return ListReferencesInternal(url, options);
         }
 
         /// <summary>
@@ -190,21 +266,26 @@ public virtual IEnumerable<Reference> ListReferences(string url, CredentialsHand
             Ensure.ArgumentNotNull(url, "url");
             Ensure.ArgumentNotNull(credentialsProvider, "credentialsProvider");
 
-            return ListReferencesInternal(url, credentialsProvider, new ProxyOptions());
+            var options = new ListRemoteOptions()
+            {
+                CredentialsProvider = credentialsProvider,
+                ProxyOptions = new ProxyOptions()
+            };
+            return ListReferencesInternal(url, options);
         }
 
-        private IEnumerable<Reference> ListReferencesInternal(string url, CredentialsHandler credentialsProvider, ProxyOptions proxyOptions)
+        private IEnumerable<Reference> ListReferencesInternal(string url, ListRemoteOptions options)
         {
-            proxyOptions ??= new();
+            var proxyOptions = options?.ProxyOptions ?? new();
 
             using RemoteHandle remoteHandle = BuildRemoteHandle(repository.Handle, url);
             using var proxyOptionsWrapper = new GitProxyOptionsWrapper(proxyOptions.CreateGitProxyOptions());
 
             GitRemoteCallbacks gitCallbacks = new GitRemoteCallbacks { version = 1 };
 
-            if (credentialsProvider != null)
+            if (options != null)
             {
-                var callbacks = new RemoteCallbacks(credentialsProvider);
+                var callbacks = new RemoteCallbacks(options);
                 gitCallbacks = callbacks.GenerateCallbacks();
             }
 
diff --git a/LibGit2Sharp/RemoteCallbacks.cs b/LibGit2Sharp/RemoteCallbacks.cs
diff --git a/LibGit2Sharp/Repository.cs b/LibGit2Sharp/Repository.cs
diff --git a/LibGit2Sharp/SupportedCredentialTypes.cs b/LibGit2Sharp/SupportedCredentialTypes.cs

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ public static class GlobalSettings`
`20`	`20`
`21`	`21`	`private static string nativeLibraryPath;`
`22`	`22`	`private static bool nativeLibraryPathLocked;`
`23`		`- private static readonly string nativeLibraryDefaultPath = null;`
	`23`	`+ private static readonly string nativeLibraryDefaultPath = "/Users/robert/Development/Sandbox/libgit2/build";`
`24`	`24`
`25`	`25`	`static GlobalSettings()`
`26`	`26`	`{`