Merge remote-tracking branch 'ssh_agent/connection_open_allow_ssh_agent' into release

Author: marian-code

ssh_utilities/connection.py

@@ -299,7 +299,8 @@ def open(ssh_username: str, ssh_server: None = None,
              ssh_key_file: Optional[Union[str, "Path"]] = None,
              ssh_password: Optional[str] = None,
              server_name: Optional[str] = None, quiet: bool = False,
-             thread_safe: bool = False) -> LocalConnection:
+             thread_safe: bool = False,
+             ssh_allow_agent: bool = False) -> LocalConnection:
         ...
 
     @overload
@@ -308,15 +309,17 @@ def open(ssh_username: str, ssh_server: str,
              ssh_key_file: Optional[Union[str, "Path"]] = None,
              ssh_password: Optional[str] = None,
              server_name: Optional[str] = None, quiet: bool = False,
-             thread_safe: bool = False) -> SSHConnection:
+             thread_safe: bool = False,
+             ssh_allow_agent: bool = False) -> SSHConnection:
         ...
 
     @staticmethod
     def open(ssh_username: str, ssh_server: Optional[str] = "",
              ssh_key_file: Optional[Union[str, "Path"]] = None,
              ssh_password: Optional[str] = None,
              server_name: Optional[str] = None, quiet: bool = False,
-             thread_safe: bool = False):
+             thread_safe: bool = False,
+             ssh_allow_agent: bool = False):
         """Initialize SSH or local connection.
 
         Local connection is only a wrapper around os and shutil module methods
@@ -343,6 +346,8 @@ def open(ssh_username: str, ssh_server: Optional[str] = "",
             make connection object thread safe so it can be safely accessed
             from  any number of threads, it is disabled by default to avoid
             performance  penalty of threading locks
+        ssh_allow_agent: bool
+            allow the use of the ssh-agent to connect. Will disable ssh_key_file.
 
         Warnings
         --------
@@ -354,7 +359,12 @@ def open(ssh_username: str, ssh_server: Optional[str] = "",
                                    pkey_file=ssh_key_file,
                                    server_name=server_name, quiet=quiet)
         else:
-            if ssh_key_file:
+            if ssh_allow_agent:
+                c = SSHConnection(ssh_server, ssh_username,
+                                  allow_agent=ssh_allow_agent, line_rewrite=True,
+                                  server_name=server_name, quiet=quiet,
+                                  thread_safe=thread_safe)
+            elif ssh_key_file:
                 c = SSHConnection(ssh_server, ssh_username,
                                   pkey_file=ssh_key_file, line_rewrite=True,
                                   server_name=server_name, quiet=quiet,

ssh_utilities/remote/remote.py

@@ -66,8 +66,8 @@ class SSHConnection(ConnectionABC):
 
     Warnings
     --------
-    At least one of (password, pkey_file) must be specified, if both are,
-    RSA key will be used
+    At least one of (password, pkey_file, allow_agent) must be specified, priority used is
+    SSH-Agent -> RSA Key -> password
 
     thread_safe parameter is not implemented yet!!!
 
@@ -84,7 +84,8 @@ def __init__(self, address: str, username: str,
                  password: Optional[str] = None,
                  pkey_file: Optional[Union[str, Path]] = None,
                  line_rewrite: bool = True, server_name: Optional[str] = None,
-                 quiet: bool = False, thread_safe: bool = False) -> None:
+                 quiet: bool = False, thread_safe: bool = False,
+                 allow_agent: Optional[bool] = False) -> None:
 
         log.info(f"Connection object will {'' if thread_safe else 'not'} be "
                  f"thread safe")
@@ -99,6 +100,10 @@ def __init__(self, address: str, username: str,
         lprint.line_rewrite = line_rewrite
         lprnt = lprint(quiet)
 
+        if allow_agent:
+            msg = f"Will login with ssh-agent"
+            lprnt(msg)
+            log.info(msg)
         if pkey_file:
             msg = f"Will login with private RSA key located in {pkey_file}"
             lprnt(msg)
@@ -130,9 +135,13 @@ def __init__(self, address: str, username: str,
         self.address = address
         self.username = username
         self.pkey_file = pkey_file
+        self.allow_agent = allow_agent
 
         # paramiko connection
-        if pkey_file:
+        if allow_agent:
+            self.pkey = None
+            self.password = None
+        elif pkey_file:
             for key in _KEYS:
                 try:
                     self.pkey = key.from_private_key_file(
@@ -246,6 +255,9 @@ def _get_ssh(self, authentication_attempts: int = 0):
 
         with self.__lock:
             try:
+                if self.allow_agent:
+                    # connect using ssh-agent
+                    self.c.connect(self.address, username=self.username, allow_agent=True)
                 if self.pkey:
                     # connect with public key
                     self.c.connect(self.address, username=self.username,