Introduce SshAgentCredentials, SshUserKeyCredentials and SshUserCredentials.

Author: Therzok

LibGit2Sharp/Core/GitCredentialType.cs

@@ -32,5 +32,10 @@ public enum GitCredentialType
         /// TODO
         /// </summary>
         SshInteractive = (1 << 4),
+
+        /// <summary>
+        /// Username only information.
+        /// </summary>
+        SshUsername = (1 << 5),
     }
 }

LibGit2Sharp/Core/NativeMethods.cs

@@ -420,6 +420,24 @@ internal static extern int git_cred_userpass_plaintext_new(
             [MarshalAs(UnmanagedType.CustomMarshaler, MarshalCookie = UniqueId.UniqueIdentifier, MarshalTypeRef = typeof (StrictUtf8Marshaler))] string username,
             [MarshalAs(UnmanagedType.CustomMarshaler, MarshalCookie = UniqueId.UniqueIdentifier, MarshalTypeRef = typeof (StrictUtf8Marshaler))] string password);
 
+        [DllImport(libgit2)]
+        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_username_new(
+            out IntPtr cred,
+            [MarshalAs(UnmanagedType.CustomMarshaler, MarshalCookie = UniqueId.UniqueIdentifier, MarshalTypeRef = typeof(StrictUtf8Marshaler))] string username);
+
+        [DllImport(libgit2)]
+        internal static extern int git_cred_ssh_key_from_agent(
+            out IntPtr cred,
+            [MarshalAs(UnmanagedType.CustomMarshaler, MarshalCookie = UniqueId.UniqueIdentifier, MarshalTypeRef = typeof(StrictUtf8Marshaler))] string username);
+
         [DllImport(libgit2)]
         internal static extern void git_diff_free(IntPtr diff);
 

LibGit2Sharp/LibGit2Sharp.csproj

@@ -337,6 +337,9 @@
     <Compile Include="Core\RawContentStream.cs" />
     <Compile Include="Core\Handles\OdbStreamSafeHandle.cs" />
     <Compile Include="SupportedCredentialTypes.cs" />
+    <Compile Include="SshUserCredentials.cs" />
+    <Compile Include="SshUserKeyCredentials.cs" />
+    <Compile Include="SshAgentCredentials.cs" />
   </ItemGroup>
   <ItemGroup>
     <CodeAnalysisDictionary Include="CustomDictionary.xml" />

LibGit2Sharp/RemoteCallbacks.cs

@@ -179,6 +179,14 @@ private int GitCredentialHandler(out IntPtr ptr, IntPtr cUrl, IntPtr usernameFro
             {
                 types |= SupportedCredentialTypes.Default;
             }
+            if (credTypes.HasFlag(GitCredentialType.SshKey))
+            {
+                types |= SupportedCredentialTypes.Ssh;
+            }
+            if (credTypes.HasFlag(GitCredentialType.SshUsername))
+            {
+                types |= SupportedCredentialTypes.SshUsername;
+            }
 
             var cred = CredentialsProvider(url, username, types);
 

LibGit2Sharp/SshAgentCredentials.cs

@@ -0,0 +1,36 @@
+using System;
+using LibGit2Sharp.Core;
+
+namespace LibGit2Sharp
+{
+    /// <summary>
+    /// Class that holds ssh agent credentials for remote repository access.
+    /// </summary>
+    public sealed class SshAgentCredentials : Credentials
+    {
+        /// <summary>
+        /// Callback to acquire a credential object.
+        /// </summary>
+        /// <param name="cred">The newly created credential object.</param>
+        /// <param name="url">The resource for which we are demanding a credential.</param>
+        /// <param name="usernameFromUrl">The username that was embedded in a "user@host"</param>
+        /// <param name="types">A bitmask stating which cred types are OK to return.</param>
+        /// <param name="payload">The payload provided when specifying this callback.</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, IntPtr url, IntPtr usernameFromUrl, GitCredentialType types, IntPtr payload)
+        {
+            if (Username == null)
+            {
+                throw new InvalidOperationException("SshCredentials contains a null Username.");
+            }
+
+            return NativeMethods.git_cred_ssh_key_from_agent(out cred, Username);
+        }
+
+        /// <summary>
+        /// Username for SSH authentication.
+        /// </summary>
+        public string Username { get; set; }
+    }
+}
+

LibGit2Sharp/SshUserCredentials.cs

@@ -0,0 +1,35 @@
+using System;
+using LibGit2Sharp.Core;
+
+namespace LibGit2Sharp
+{
+    /// <summary>
+    /// Class that holds ssh username credentials for remote repository access.
+    /// </summary>
+    public sealed class SshUserCredentials : Credentials
+    {
+        /// <summary>
+        /// Callback to acquire a credential object.
+        /// </summary>
+        /// <param name="cred">The newly created credential object.</param>
+        /// <param name="url">The resource for which we are demanding a credential.</param>
+        /// <param name="usernameFromUrl">The username that was embedded in a "user@host"</param>
+        /// <param name="types">A bitmask stating which cred types are OK to return.</param>
+        /// <param name="payload">The payload provided when specifying this callback.</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, IntPtr url, IntPtr usernameFromUrl, GitCredentialType types, IntPtr payload)
+        {
+            if (Username == null)
+            {
+                throw new InvalidOperationException("SshCredentials contains a null Username.");
+            }
+
+            return NativeMethods.git_cred_username_new(out cred, Username);
+        }
+
+        /// <summary>
+        /// Username for SSH authentication.
+        /// </summary>
+        public string Username { get; set; }
+    }
+}

LibGit2Sharp/SshUserKeyCredentials.cs

@@ -0,0 +1,50 @@
+using System;
+using LibGit2Sharp.Core;
+
+namespace LibGit2Sharp
+{
+    /// <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>
+        /// <param name="url">The resource for which we are demanding a credential.</param>
+        /// <param name="usernameFromUrl">The username that was embedded in a "user@host"</param>
+        /// <param name="types">A bitmask stating which cred types are OK to return.</param>
+        /// <param name="payload">The payload provided when specifying this callback.</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, IntPtr url, IntPtr usernameFromUrl, GitCredentialType types, IntPtr payload)
+        {
+            if (Username == null || PublicKey == null || PrivateKey == null || Passphrase == null)
+            {
+                throw new InvalidOperationException("SshCredentials contains a null Username or Key or Passphrase.");
+            }
+
+            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; }
+    }
+}

LibGit2Sharp/SupportedCredentialTypes.cs

@@ -18,5 +18,15 @@ public enum SupportedCredentialTypes
         /// Ask Windows to provide its default credentials for the current user (e.g. NTLM)
         /// </summary>
         Default = (1 << 1),
+
+        /// <summary>
+        /// Ssh with username and public/private key. (SshUserKeyCredentials, SshAgentCredentials)
+        /// </summary>
+        Ssh = (1 << 2),
+
+        /// <summary>
+        /// Ssh with username for supported methods querying.
+        /// </summary>
+        SshUsername = (1 << 3),
     }
 }