Added connector implementation and tests. Updated options.

Author: Pan

ssh/connector.pxd

@@ -0,0 +1,34 @@
+# This file is part of ssh-python.
+# Copyright (C) 2018 Panos Kittenis
+#
+# 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.
+#
+# 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-130
+
+from session cimport Session
+
+cimport c_ssh
+
+
+cdef class Flag:
+    cdef c_ssh.ssh_connector_flags_e _flag
+
+    @staticmethod
+    cdef Flag from_flag(c_ssh.ssh_connector_flags_e flag)
+
+
+cdef class Connector:
+    cdef c_ssh.ssh_connector _connector
+    cdef Session session
+
+    @staticmethod
+    cdef Connector from_ptr(c_ssh.ssh_connector _connector, Session session)

ssh/connector.pyx

@@ -0,0 +1,91 @@
+# This file is part of ssh-python.
+# Copyright (C) 2018 Panos Kittenis
+#
+# 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.
+#
+# 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-130
+
+from cpython cimport PyObject_AsFileDescriptor
+
+from channel cimport Channel
+from session cimport Session
+
+cimport c_ssh
+
+from utils cimport handle_ssh_error_codes
+
+
+cdef class Flag:
+
+    @staticmethod
+    cdef Flag from_flag(c_ssh.ssh_connector_flags_e flag):
+        cdef Flag _flag = Flag.__new__(Flag)
+        _flag._flag = flag
+        return _flag
+
+    def __eq__(self, Flag other):
+        return self._flag == other._flag
+
+    def __str__(self):
+        return str(self._flag)
+
+    def __repr__(self):
+        return self.__str__()
+
+
+CONNECTOR_STDOUT = Flag.from_flag(
+    c_ssh.ssh_connector_flags_e.SSH_CONNECTOR_STDOUT)
+CONNECTOR_STDERR = Flag.from_flag(
+    c_ssh.ssh_connector_flags_e.SSH_CONNECTOR_STDERR)
+CONNECTOR_BOTH = Flag.from_flag(
+    c_ssh.ssh_connector_flags_e.SSH_CONNECTOR_BOTH)
+
+
+cdef class Connector:
+
+    def __cinit__(self, Session session):
+        self.session = session
+
+    def __dealloc__(self):
+        if self._connector is not NULL:
+            c_ssh.ssh_connector_free(self._connector)
+            self._connector = NULL
+
+    @staticmethod
+    cdef Connector from_ptr(c_ssh.ssh_connector _connector, Session session):
+        cdef Connector connector = Connector.__new__(Connector, session)
+        connector._connector = _connector
+        return connector
+
+    def set_in_channel(self, Channel channel, Flag flag):
+        cdef int rc
+        with nogil:
+            rc = c_ssh.ssh_connector_set_in_channel(
+                self._connector, channel._channel, flag._flag)
+        return handle_ssh_error_codes(rc, self.session._session)
+
+    def set_out_channel(self, Channel channel, Flag flag):
+        cdef int rc
+        with nogil:
+            rc = c_ssh.ssh_connector_set_out_channel(
+                self._connector, channel._channel, flag._flag)
+        return handle_ssh_error_codes(rc, self.session._session)
+
+    def set_in_fd(self, socket):
+        cdef c_ssh.socket_t _sock = PyObject_AsFileDescriptor(socket)
+        with nogil:
+            c_ssh.ssh_connector_set_in_fd(self._connector, _sock)
+
+    def set_out_fd(self, socket):
+        cdef c_ssh.socket_t _sock = PyObject_AsFileDescriptor(socket)
+        with nogil:
+            c_ssh.ssh_connector_set_out_fd(self._connector, _sock)

ssh/options.pxd

@@ -21,44 +21,4 @@ cdef class Option:
     cdef ssh_options_e _option
 
     @staticmethod
-    cdef object from_option(ssh_options_e option)
-
-
-# cdef ssh_options_e HOST
-# cdef ssh_options_e USER
-# cdef ssh_options_e PORT
-# cdef ssh_options_e PORT_STR
-# cdef ssh_options_e FD
-# cdef ssh_options_e USER
-# cdef ssh_options_e SSH_DIR
-# cdef ssh_options_e IDENTITY
-# cdef ssh_options_e ADD_IDENTITY
-# cdef ssh_options_e KNOWNHOSTS
-# cdef ssh_options_e TIMEOUT
-# cdef ssh_options_e TIMEOUT_USEC
-# cdef ssh_options_e SSH1
-# cdef ssh_options_e SSH2
-# cdef ssh_options_e LOG_VERBOSITY
-# cdef ssh_options_e LOG_VERBOSITY_STR
-# cdef ssh_options_e CIPHERS_C_S
-# cdef ssh_options_e CIPHERS_S_C
-# cdef ssh_options_e COMPRESSION_C_S
-# cdef ssh_options_e COMPRESSION_S_C
-# cdef ssh_options_e PROXYCOMMAND
-# cdef ssh_options_e BINDADDR
-# cdef ssh_options_e STRICTHOSTKEYCHECK
-# cdef ssh_options_e COMPRESSION
-# cdef ssh_options_e COMPRESSION_LEVEL
-# cdef ssh_options_e KEY_EXCHANGE
-# cdef ssh_options_e HOSTKEYS
-# cdef ssh_options_e GSSAPI_SERVER_IDENTITY
-# cdef ssh_options_e GSSAPI_CLIENT_IDENTITY
-# cdef ssh_options_e GSSAPI_DELEGATE_CREDENTIALS
-# cdef ssh_options_e HMAC_C_S
-# cdef ssh_options_e HMAC_S_C
-# cdef ssh_options_e PASSWORD_AUTH
-# cdef ssh_options_e PUBKEY_AUTH
-# cdef ssh_options_e KBDINT_AUTH
-# cdef ssh_options_e GSSAPI_AUTH
-# cdef ssh_options_e GLOBAL_KNOWNHOSTS
-# cdef ssh_options_e NODELAY
+    cdef Option from_option(ssh_options_e option)

ssh/options.pyx

@@ -21,11 +21,14 @@ cdef class Option:
     """Class for representing an SSH option."""
 
     @staticmethod
-    cdef object from_option(ssh_options_e option):
+    cdef Option from_option(ssh_options_e option):
         cdef Option _option = Option.__new__(Option)
         _option._option = option
         return _option
 
+    def __eq__(self, Option other):
+        return self._option == other._option
+
     @property
     def value(self):
         return self._option

ssh/session.pyx

@@ -19,6 +19,7 @@ from libc.stdlib cimport malloc, free
 from libc.string cimport const_char
 
 from channel cimport Channel
+from connector cimport Connector
 from utils cimport to_bytes, to_str, handle_ssh_error_codes, \
     handle_auth_error_codes
 from options cimport Option
@@ -91,16 +92,23 @@ cdef class Session:
         with nogil:
             c_ssh.ssh_disconnect(self._session)
 
-    def new_connector(self):
+    def connector_new(self):
         cdef c_ssh.ssh_connector _connector
         with nogil:
             _connector = c_ssh.ssh_connector_new(self._session)
+        if _connector is NULL:
+            return
+        return Connector.from_ptr(_connector, self)
 
     def accept_forward(self, int timeout, int dest_port):
         cdef c_ssh.ssh_channel _channel
         with nogil:
+            _check_connected(self._session)
             _channel = c_ssh.ssh_channel_accept_forward(
                 self._session, timeout, &dest_port)
+        if _channel is NULL:
+            return
+        return Channel.from_ptr(_channel, self)
 
     def cancel_forward(self, address, int port):
         cdef bytes b_address = to_bytes(address)

tests/test_connector.py

@@ -0,0 +1,41 @@
+# This file is part of ssh-python.
+# Copyright (C) 2018 Panos Kittenis
+#
+# 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.
+#
+# 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-130
+
+import unittest
+import socket
+
+from .base_test import SSHTestCase
+
+from ssh.connector import Connector, CONNECTOR_STDOUT, CONNECTOR_STDERR, \
+    CONNECTOR_BOTH
+
+
+class ConnectorTest(SSHTestCase):
+
+    def test_connector(self):
+        self._auth()
+        connector = self.session.connector_new()
+        self.assertIsInstance(connector, Connector)
+        chan = self.session.channel_new()
+        self.assertEqual(
+            connector.set_in_channel(chan, CONNECTOR_STDOUT), 0)
+        self.assertEqual(
+            connector.set_out_channel(chan, CONNECTOR_STDERR), 0)
+        self.assertEqual(
+            connector.set_in_channel(chan, CONNECTOR_BOTH), 0)
+        sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+        self.assertIsNone(connector.set_in_fd(sock))
+        self.assertIsNone(connector.set_out_fd(sock))

tests/test_session.py

@@ -49,6 +49,7 @@ def test_should_not_segfault(self):
         self.assertIsNone(session.get_hmac_in())
         self.assertIsNone(session.get_hmac_out())
         self.assertIsNotNone(session.get_error_code())
+        session.connector_new()
 
     def test_socket_connect(self):
         sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)