Track SSH agent state in CredentialPayload

Author: omus

base/libgit2/callbacks.jl

@@ -61,16 +61,16 @@ function authenticate_ssh(libgit2credptr::Ptr{Ptr{Void}}, p::CredentialPayload,
     errcls, errmsg = Error.last_error()
     if errcls != Error.None
         # Check if we used ssh-agent
-        if creds.usesshagent == "U"
-            creds.usesshagent = "E" # reported ssh-agent error, disables ssh agent use for the future
+        if p.use_ssh_agent == 'U'
+            p.use_ssh_agent = 'E' # reported ssh-agent error, disables ssh agent use for the future
         end
     end
 
     # first try ssh-agent if credentials support its usage
-    if creds.usesshagent == "Y" || creds.usesshagent == "U"
+    if p.use_ssh_agent == 'Y' || p.use_ssh_agent == 'U'
         err = ccall((:git_cred_ssh_key_from_agent, :libgit2), Cint,
                      (Ptr{Ptr{Void}}, Cstring), libgit2credptr, username_ptr)
-        creds.usesshagent = "U" # used ssh-agent only one time
+        p.use_ssh_agent = 'U' # used ssh-agent only one time
         err == 0 && return Cint(0)
     end
 
@@ -221,7 +221,7 @@ For `LibGit2.Consts.CREDTYPE_SSH_KEY` type, if the payload contains fields:
 Typing `^D` (control key together with the `d` key) will abort the credential prompt.
 
 Credentials are checked in the following order (if supported):
-- ssh key pair (`ssh-agent` if specified in payload's `usesshagent` field)
+- ssh key pair (`ssh-agent` if specified in payload's `use_ssh_agent` field)
 - plain text
 
 **Note**: Due to the specifics of the `libgit2` authentication procedure, when

base/libgit2/types.jl

@@ -1100,10 +1100,9 @@ mutable struct SSHCredentials <: AbstractCredentials
     pass::String
     prvkey::String
     pubkey::String
-    usesshagent::String  # used for ssh-agent authentication
     prompt_if_incorrect::Bool    # Whether to allow interactive prompting if the credentials are incorrect
     function SSHCredentials(u::AbstractString,p::AbstractString,prvkey::AbstractString,pubkey::AbstractString,prompt_if_incorrect::Bool=false)
-        c = new(u,p,prvkey,pubkey,"Y",prompt_if_incorrect)
+        c = new(u,p,prvkey,pubkey,prompt_if_incorrect)
         finalizer(c, securezero!)
         return c
     end
@@ -1148,13 +1147,14 @@ mutable struct CredentialPayload <: Payload
     credential::Nullable{AbstractCredentials}
     cache::Nullable{CachedCredentials}
     first_pass::Bool
+    use_ssh_agent::Char
     scheme::String
     username::String
     host::String
     path::String
 
     function CredentialPayload(credential::Nullable{<:AbstractCredentials}, cache::Nullable{CachedCredentials})
-        new(credential, cache, true, "", "", "", "")
+        new(credential, cache, true, 'Y', "", "", "", "")
     end
 end
 

test/libgit2-helpers.jl

@@ -65,15 +65,7 @@ function credential_loop(
         use_ssh_agent::Bool=false)
 
     if !use_ssh_agent
-        if isnull(payload.cache)
-            payload.cache = Nullable(CachedCredentials())
-        end
-        cache = get(payload.cache)
-
-        m = match(LibGit2.URL_REGEX, url)
-        default_cred = SSHCredentials(true)
-        default_cred.usesshagent = "N"
-        LibGit2.get_creds!(cache, "ssh://$(m[:host])", default_cred)
+        payload.use_ssh_agent = 'N'
     end
 
     credential_loop(valid_credential, url, user, 0x000046, payload)

test/libgit2.jl

@@ -1921,9 +1921,8 @@ mktempdir() do dir
                 include($LIBGIT2_HELPER_PATH)
                 valid_cred = LibGit2.SSHCredentials($username, $passphrase, $valid_p_key, $(valid_p_key * ".pub"))
                 invalid_cred = LibGit2.SSHCredentials($username, "", $invalid_key, $(invalid_key * ".pub"))
-                invalid_cred.usesshagent = "N"  # Disable SSH agent use
                 payload = CredentialPayload(Nullable(invalid_cred))
-                credential_loop(valid_cred, $url, $username, payload)
+                credential_loop(valid_cred, $url, $username, payload, use_ssh_agent=false)
             end
 
             # Explicitly provided credential is correct