parallel-ssh 2.13.0rc1__py3-none-any.whl → 2.15.0__py3-none-any.whl

pssh/clients/native/tunnel.py

@@ -1,27 +1,28 @@
-# This file is part of parallel-ssh.
+#  This file is part of parallel-ssh.
+#  Copyright (C) 2014-2025 Panos Kittenis.
+#  Copyright (C) 2014-2025 parallel-ssh Contributors.
 #
-# Copyright (C) 2014-2022 Panos Kittenis and contributors.
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation, version 2.1.
 #
-# This library is free software; you can redistribute it and/or
-# modify it under the terms of the GNU Lesser General Public
-# License as published by the Free Software Foundation, version 2.1.
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
 #
-# This library is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-# Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public
-# License along with this library; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
+import atexit
 import logging
-from queue import Queue
-from threading import Thread, Event
-
-from gevent import spawn, joinall, get_hub, sleep
+from gevent import joinall, get_hub, sleep
+from gevent.pool import Pool
 from gevent.server import StreamServer
+from queue import Queue
 from ssh2.error_codes import LIBSSH2_ERROR_EAGAIN
+from threading import Thread, Event
 
 from ...constants import DEFAULT_RETRIES
 
@@ -39,25 +40,39 @@ class LocalForwarder(Thread):
         and get port to connect to via ``out_q`` once a target has been put into the input queue.
 
         ``SSHClient`` is the client for the SSH host that will be proxying.
+
+        There can be as many LocalForwarder(s) as needed to scale.
+
+        Relationship of clients to forwarders to servers is:
+
+        One client -> One Forwarder -> Many Servers <-> Many proxy hosts -> one target host per proxy host
+
+        A Forwarder starts servers. Servers communicate with clients directly via Forwarder thread.
+
+        Multiple forwarder threads can be used to scale clients to more threads as number of clients increases causing
+        contention in forwarder threads handling proxy connections.
         """
-        Thread.__init__(self)
+        Thread.__init__(self, daemon=True)
         self.in_q = Queue(1)
         self.out_q = Queue(1)
+        self._pool = None
         self._servers = {}
         self._hub = None
         self.started = Event()
         self._cleanup_let = None
+        self.shutdown_triggered = Event()
 
     def _start_server(self):
         client, host, port = self.in_q.get()
+        logger.debug("Starting server for %s:%s", host, port)
         server = TunnelServer(client, host, port)
+        self._servers[client] = server
         server.start()
-        self._get_server_listen_port(client, server)
+        self._get_server_listen_port(server)
 
-    def _get_server_listen_port(self, client, server):
+    def _get_server_listen_port(self, server):
         while not server.started:
             sleep(0.01)
-        self._servers[client] = server
         local_port = server.listen_port
         self.out_q.put(local_port)
 
@@ -74,9 +89,20 @@ class LocalForwarder(Thread):
         self.in_q.put((client, host, port))
 
     def shutdown(self):
-        """Stop all tunnel servers."""
+        """Stop all tunnel servers and shutdown LocalForwarder thread.
+
+        This function will join the current thread and wait for it to shutdown if needed.
+        """
         for client, server in self._servers.items():
             server.stop()
+        self._servers = {}
+        if self.started:
+            self.shutdown_triggered.set()
+            try:
+                self.join()
+            except RuntimeError:
+                # Re-entry protection
+                pass
 
     def _cleanup_servers_let(self):
         while True:
@@ -89,19 +115,22 @@ class LocalForwarder(Thread):
                 self.cleanup_server(client)
 
     def run(self):
-        """Thread runner ensures a non main hub has been created for all subsequent
+        """Thread runner ensures a non-main hub has been created for all subsequent
         greenlets and waits for (client, host, port) tuples to be put into self.in_q.
 
-        A server is created once something is in the queue and the port to connect to
-        is put into self.out_q.
+        A server is created once something is in the queue and only then is the port to connect to
+        put into self.out_q.
         """
         self._hub = get_hub()
         assert self._hub.main_hub is False
+        self._pool = Pool(1)
         self.started.set()
-        self._cleanup_let = spawn(self._cleanup_servers_let)
+        self._cleanup_let = self._pool.spawn(self._cleanup_servers_let)
         logger.debug("Hub in server runner is main hub: %s", self._hub.main_hub)
         try:
             while True:
+                if self.shutdown_triggered.is_set():
+                    return
                 if self.in_q.empty():
                     sleep(.01)
                     continue
@@ -111,8 +140,9 @@ class LocalForwarder(Thread):
             self.shutdown()
 
     def cleanup_server(self, client):
-        """The purpose of this function is for a proxied client to notify the LocalForwarder that it
-         is shutting down and its corresponding server can also be shut down."""
+        """
+        Stop server for given proxy client and remove client from this forwarder.
+        """
         server = self._servers[client]
         server.stop()
         del self._servers[client]
@@ -123,16 +153,18 @@ class TunnelServer(StreamServer):
 
     Accepts connections on an available bind_address port once started and tunnels data
     to/from remote SSH host for each connection.
+
+    TunnelServer.listen_port will return listening port for server on given host once TunnelServer.started is True.
     """
 
     def __init__(self, client, host, port, bind_address='127.0.0.1',
                  num_retries=DEFAULT_RETRIES):
-        StreamServer.__init__(self, (bind_address, 0), self._read_rw)
         self.client = client
+        self._pool = Pool()
+        StreamServer.__init__(self, (bind_address, 0), self._read_rw, spawn=self._pool)
         self.host = host
         self.port = port
         self.session = client.session
-        self._client = client
         self._retries = num_retries
         self.bind_address = bind_address
         self.exception = None
@@ -154,41 +186,40 @@ class TunnelServer(StreamServer):
                          self.host, self.port, ex)
             self.exception = ex
             return
-        source = spawn(self._read_forward_sock, socket, channel)
-        dest = spawn(self._read_channel, socket, channel)
+        # Channel remains alive while this handler function is alive
+        source = self._pool.spawn(self._read_forward_sock, socket, channel)
+        dest = self._pool.spawn(self._read_channel, socket, channel)
         logger.debug("Waiting for read/write greenlets")
-        self._source_let = source
-        self._dest_let = dest
         self._wait_send_receive_lets(source, dest, channel)
 
     def _wait_send_receive_lets(self, source, dest, channel):
         try:
             joinall((source, dest), raise_error=True)
         finally:
-            # Forward socket does not need to be closed here; StreamServer does it in do_close
-            logger.debug("Closing channel")
-            self._client.close_channel(channel)
-
-            # Disconnect client here to make sure it happens AFTER close_channel
-            self._client.disconnect()
+            logger.debug("Read/Write greenlets for tunnel target %s:%s finished, closing forwarding channel",
+                         self.host, self.port)
+            self.client.close_channel(channel)
 
     def _read_forward_sock(self, forward_sock, channel):
         while True:
             if channel is None or channel.eof():
                 logger.debug("Channel closed, tunnel forward socket reader exiting")
                 return
+            if not forward_sock or forward_sock.closed:
+                logger.debug("Forward socket closed, tunnel forward socket reader exiting")
+                return
             try:
                 data = forward_sock.recv(1024)
             except Exception as ex:
                 logger.error("Forward socket read error: %s", ex)
                 raise
             data_len = len(data)
-            # logger.debug("Read %s data from forward socket", data_len,)
+            # logger.debug("Read %s data from forward socket", data_len)
             if data_len == 0:
                 sleep(.01)
                 continue
             try:
-                self._client.eagain_write(channel.write, data)
+                self.client.eagain_write(channel.write, data)
             except Exception as ex:
                 logger.error("Error writing data to channel - %s", ex)
                 raise
@@ -204,9 +235,9 @@ class TunnelServer(StreamServer):
             except Exception as ex:
                 logger.error("Error reading from channel - %s", ex)
                 raise
-            # logger.debug("Read %s data from channel" % (size,))
+            # logger.debug("Read %s data from channel", size)
             if size == LIBSSH2_ERROR_EAGAIN:
-                self._client.poll()
+                self.client.poll()
                 continue
             elif size == 0:
                 sleep(.01)
@@ -224,7 +255,7 @@ class TunnelServer(StreamServer):
             fw_host, fw_port, self.bind_address,
             local_port)
         while channel == LIBSSH2_ERROR_EAGAIN:
-            self._client.poll()
+            self.client.poll()
             channel = self.session.direct_tcpip_ex(
                 fw_host, fw_port, self.bind_address,
                 local_port)
@@ -249,4 +280,4 @@ class TunnelServer(StreamServer):
 
 
 FORWARDER = LocalForwarder()
-FORWARDER.daemon = True
+atexit.register(FORWARDER.shutdown)

pssh/clients/reader.py

@@ -1,19 +1,19 @@
-# This file is part of parallel-ssh.
+#  This file is part of parallel-ssh.
+#  Copyright (C) 2014-2025 Panos Kittenis.
+#  Copyright (C) 2014-2025 parallel-ssh Contributors.
 #
-# Copyright (C) 2014-2022 Panos Kittenis and contributors.
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation, version 2.1.
 #
-# This library is free software; you can redistribute it and/or
-# modify it under the terms of the GNU Lesser General Public
-# License as published by the Free Software Foundation, version 2.1.
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
 #
-# This library is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-# Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public
-# License along with this library; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
 from io import BytesIO
 

pssh/clients/ssh/__init__.py

@@ -1,19 +1,19 @@
-# This file is part of parallel-ssh.
+#  This file is part of parallel-ssh.
+#  Copyright (C) 2014-2025 Panos Kittenis.
+#  Copyright (C) 2014-2025 parallel-ssh Contributors.
 #
-# Copyright (C) 2014-2022 Panos Kittenis and contributors.
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation, version 2.1.
 #
-# This library is free software; you can redistribute it and/or
-# modify it under the terms of the GNU Lesser General Public
-# License as published by the Free Software Foundation, version 2.1.
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
 #
-# This library is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-# Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public
-# License along with this library; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
 # flake8: noqa: F401
 from .parallel import ParallelSSHClient

pssh/clients/ssh/parallel.py

@@ -1,19 +1,19 @@
-# This file is part of parallel-ssh.
+#  This file is part of parallel-ssh.
+#  Copyright (C) 2014-2025 Panos Kittenis.
+#  Copyright (C) 2014-2025 parallel-ssh Contributors.
 #
-# Copyright (C) 2014-2022 Panos Kittenis and contributors.
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation, version 2.1.
 #
-# This library is free software; you can redistribute it and/or
-# modify it under the terms of the GNU Lesser General Public
-# License as published by the Free Software Foundation, version 2.1.
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
 #
-# This library is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-# Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public
-# License along with this library; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
 import logging
 
@@ -40,6 +40,7 @@ class ParallelSSHClient(BaseParallelSSHClient):
                  gssapi_delegate_credentials=False,
                  identity_auth=True,
                  ipv6_only=False,
+                 compress=False,
                  ):
         """
         :param hosts: Hosts to connect to
@@ -114,6 +115,8 @@ class ParallelSSHClient(BaseParallelSSHClient):
           for the host or raise NoIPv6AddressFoundError otherwise. Note this will
           disable connecting to an IPv4 address if an IP address is provided instead.
         :type ipv6_only: bool
+        :param compress: Enable/Disable compression on the client. Defaults to off.
+        :type compress: bool
 
         :raises: :py:class:`pssh.exceptions.PKeyFileError` on errors finding
           provided private key.
@@ -125,6 +128,7 @@ class ParallelSSHClient(BaseParallelSSHClient):
             host_config=host_config, retry_delay=retry_delay,
             identity_auth=identity_auth,
             ipv6_only=ipv6_only,
+            compress=compress,
         )
         self.pkey = _validate_pkey(pkey)
         self.cert_file = _validate_pkey_path(cert_file)
@@ -228,5 +232,6 @@ class ParallelSSHClient(BaseParallelSSHClient):
             gssapi_client_identity=self.gssapi_client_identity,
             gssapi_delegate_credentials=self.gssapi_delegate_credentials,
             cert_file=cfg.cert_file,
+            compress=cfg.compress or self.compress,
         )
         return _client

pssh/clients/ssh/single.py

@@ -1,23 +1,23 @@
-# This file is part of parallel-ssh.
+#  This file is part of parallel-ssh.
+#  Copyright (C) 2014-2025 Panos Kittenis.
+#  Copyright (C) 2014-2025 parallel-ssh Contributors.
 #
-# Copyright (C) 2014-2022 Panos Kittenis and contributors.
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation, version 2.1.
 #
-# This library is free software; you can redistribute it and/or
-# modify it under the terms of the GNU Lesser General Public
-# License as published by the Free Software Foundation, version 2.1.
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
 #
-# This library is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-# Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public
-# License along with this library; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
 import logging
-
 from gevent import sleep, spawn, Timeout as GTimeout, joinall
+from gevent.socket import SHUT_RDWR
 from ssh import options
 from ssh.error_codes import SSH_AGAIN
 from ssh.exceptions import EOF
@@ -50,6 +50,7 @@ class SSHClient(BaseSSHClient):
                  gssapi_client_identity=None,
                  gssapi_delegate_credentials=False,
                  ipv6_only=False,
+                 compress=False,
                  _auth_thread_pool=True):
         """:param host: Host name or IP to connect to.
         :type host: str
@@ -81,9 +82,11 @@ class SSHClient(BaseSSHClient):
         :type retry_delay: int or float
         :param timeout: (Optional) If provided, all commands will timeout after
           <timeout> number of seconds.
+          Also currently sets socket as well as per function timeout in some cases, see
+          function descriptions.
         :type timeout: int or float
         :param allow_agent: (Optional) set to False to disable connecting to
-          the system's SSH agent. Currently unused.
+          the system's SSH agent.
         :type allow_agent: bool
         :param identity_auth: (Optional) set to False to disable attempting to
           authenticate with default identity files from
@@ -105,6 +108,8 @@ class SSHClient(BaseSSHClient):
           for the host or raise NoIPv6AddressFoundError otherwise. Note this will
           disable connecting to an IPv4 address if an IP address is provided instead.
         :type ipv6_only: bool
+        :param compress: Enable/Disable compression on the client. Defaults to off.
+        :type compress: bool
 
         :raises: :py:class:`pssh.exceptions.PKeyFileError` on errors finding
           provided private key.
@@ -122,12 +127,21 @@ class SSHClient(BaseSSHClient):
             timeout=timeout,
             identity_auth=identity_auth,
             ipv6_only=ipv6_only,
+            compress=compress,
         )
 
-    def disconnect(self):
-        """Close socket if needed."""
-        if self.sock is not None and not self.sock.closed:
-            self.sock.close()
+    def _disconnect(self):
+        """Shutdown socket if needed.
+
+        Does not need to be called directly - called when client object is de-allocated.
+        """
+        if self.session is not None and self.sock is not None and not self.sock.closed:
+            try:
+                self.sock.shutdown(SHUT_RDWR)
+                self.sock.detach()
+            except Exception:
+                pass
+        self.sock = None
 
     def _agent_auth(self):
         self.session.userauth_agent(self.user)
@@ -141,6 +155,8 @@ class SSHClient(BaseSSHClient):
         self.session = Session()
         self.session.options_set(options.USER, self.user)
         self.session.options_set(options.HOST, self.host)
+        if self.compress:
+            self.session.options_set(options.COMPRESSION, "yes")
         self.session.options_set_port(self.port)
         if self.gssapi_server_identity:
             self.session.options_set(
@@ -201,12 +217,12 @@ class SSHClient(BaseSSHClient):
         logger.debug("Imported certificate file %s for pkey %s", self.cert_file, self.pkey)
 
     def _shell(self, channel):
-        return self._eagain(channel.request_shell)
+        return self.eagain(channel.request_shell)
 
     def _open_session(self):
         channel = self.session.channel_new()
         channel.set_blocking(0)
-        self._eagain(channel.open_session)
+        self.eagain(channel.open_session)
         return channel
 
     def open_session(self):
@@ -225,7 +241,7 @@ class SSHClient(BaseSSHClient):
             self._read_output_to_buffer, channel, stderr_buffer, is_stderr=True)
         return _stdout_reader, _stderr_reader
 
-    def execute(self, cmd, use_pty=False, channel=None):
+    def _execute(self, cmd, use_pty=False, channel=None):
         """Execute command on remote host.
 
         :param cmd: The command string to execute.
@@ -235,12 +251,13 @@ class SSHClient(BaseSSHClient):
         :type use_pty: bool
         :param channel: Channel to use. New channel is created if not provided.
         :type channel: :py:class:`ssh.channel.Channel`"""
-        channel = self.open_session() if not channel else channel
-        if use_pty:
-            self._eagain(channel.request_pty, timeout=self.timeout)
-        logger.debug("Executing command '%s'", cmd)
-        self._eagain(channel.request_exec, cmd)
-        return channel
+        with GTimeout(seconds=self.timeout, exception=Timeout):
+            channel = self.open_session() if not channel else channel
+            if use_pty:
+                self.eagain(channel.request_pty)
+            logger.debug("Executing command '%s'", cmd)
+            self.eagain(channel.request_exec, cmd)
+            return channel
 
     def _read_output_to_buffer(self, channel, _buffer, is_stderr=False):
         try:
@@ -276,7 +293,7 @@ class SSHClient(BaseSSHClient):
         if channel is None:
             return
         logger.debug("Sending EOF on channel %s", channel)
-        self._eagain(channel.send_eof, timeout=self.timeout)
+        self.eagain(channel.send_eof)
         logger.debug("Waiting for readers, timeout %s", timeout)
         with GTimeout(seconds=timeout, exception=Timeout):
             joinall((host_output.buffers.stdout.reader, host_output.buffers.stderr.reader))
@@ -311,7 +328,7 @@ class SSHClient(BaseSSHClient):
         :type channel: :py:class:`ssh.channel.Channel`
         """
         logger.debug("Closing channel")
-        self._eagain(channel.close)
+        self.eagain(channel.close)
 
     def poll(self, timeout=None):
         """ssh-python based co-operative gevent poll on session socket.
@@ -323,9 +340,9 @@ class SSHClient(BaseSSHClient):
             SSH_WRITE_PENDING,
         )
 
-    def _eagain(self, func, *args, **kwargs):
+    def eagain(self, func, *args, **kwargs):
         """Run function given and handle EAGAIN for an ssh-python session"""
         return self._eagain_errcode(func, SSH_AGAIN, *args, **kwargs)
 
-    def _eagain_write(self, write_func, data):
+    def eagain_write(self, write_func, data):
         return self._eagain_write_errcode(write_func, data, SSH_AGAIN)

pssh/config.py

@@ -1,23 +1,25 @@
-# This file is part of parallel-ssh.
+#  This file is part of parallel-ssh.
+#  Copyright (C) 2014-2025 Panos Kittenis.
+#  Copyright (C) 2014-2025 parallel-ssh Contributors.
 #
-# Copyright (C) 2014-2022 Panos Kittenis and contributors.
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation, version 2.1.
 #
-# This library is free software; you can redistribute it and/or
-# modify it under the terms of the GNU Lesser General Public
-# License as published by the Free Software Foundation, version 2.1.
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
 #
-# This library is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-# Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public
-# License along with this library; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
 
 """Host specific configuration."""
 
+from .exceptions import InvalidAPIUseError
+
 
 class HostConfig(object):
     """Host configuration for ParallelSSHClient.
@@ -29,7 +31,7 @@ class HostConfig(object):
                  'proxy_host', 'proxy_port', 'proxy_user', 'proxy_password', 'proxy_pkey',
                  'keepalive_seconds', 'ipv6_only', 'cert_file', 'auth_thread_pool', 'gssapi_auth',
                  'gssapi_server_identity', 'gssapi_client_identity', 'gssapi_delegate_credentials',
-                 'forward_ssh_agent',
+                 'forward_ssh_agent', 'compress', 'keyboard_interactive',
                  )
 
     def __init__(self, user=None, port=None, password=None, private_key=None,
@@ -46,6 +48,8 @@ class HostConfig(object):
                  gssapi_client_identity=None,
                  gssapi_delegate_credentials=False,
                  forward_ssh_agent=False,
+                 compress=False,
+                 keyboard_interactive=False,
                  ):
         """
         :param user: Username to login as.
@@ -99,6 +103,15 @@ class HostConfig(object):
         :param gssapi_delegate_credentials: Enable/disable server credentials
           delegation. (pssh.clients.ssh only)
         :type gssapi_delegate_credentials: bool
+        :param compress: Enable/Disable compression on the client. Defaults to off.
+        :type compress: bool
+        :param keyboard_interactive: Enable/Disable keyboard interactive authentication with provided username and
+          password. An `InvalidAPIUse` error is raised when keyboard_interactive is enabled without a provided password.
+          Defaults to off.
+        :type keyboard_interactive: bool
+
+        :raises: :py:class:`pssh.exceptions.InvalidAPIUseError` when `keyboard_interactive=True` with no password
+          provided.
         """
         self.user = user
         self.port = port
@@ -124,6 +137,10 @@ class HostConfig(object):
         self.gssapi_server_identity = gssapi_server_identity
         self.gssapi_client_identity = gssapi_client_identity
         self.gssapi_delegate_credentials = gssapi_delegate_credentials
+        self.compress = compress
+        self.keyboard_interactive = keyboard_interactive
+        if self.keyboard_interactive and not self.password:
+            raise InvalidAPIUseError("Keyboard interactive authentication is enabled but no password is provided")
         self._sanity_checks()
 
     def _sanity_checks(self):
@@ -181,3 +198,7 @@ class HostConfig(object):
             raise ValueError("GSSAPI client identity %s is not a string", self.gssapi_client_identity)
         if self.gssapi_delegate_credentials is not None and not isinstance(self.gssapi_delegate_credentials, bool):
             raise ValueError("GSSAPI delegate credentials %s is not a bool", self.gssapi_delegate_credentials)
+        if self.compress is not None and not isinstance(self.compress, bool):
+            raise ValueError("Compress %s is not a bool", self.compress)
+        if self.keyboard_interactive is not None and not isinstance(self.keyboard_interactive, bool):
+            raise ValueError("keyboard_interactive %s is not a bool", self.keyboard_interactive)