Updated session, channel, agent and pkey to accept any string type arguments.

Added scp function signatures to sftp.
Updated sftp test to clean up test file.

Author: Pan

embedded_server/openssh.py

@@ -41,7 +41,7 @@ def _wait_for_port(self):
         sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
         while sock.connect_ex(('127.0.0.1', self.port)) != 0:
             sleep(.1)
-        sleep(.1)
+        sleep(.2)
         del sock
 
     def stop(self):

ssh2/agent.c

@@ -18,6 +18,7 @@ cimport c_ssh2
 from pkey cimport PublicKey, PyPublicKey
 from exceptions cimport AgentConnectError, AgentListIdentitiesError, \
     AgentGetIdentityError, AgentAuthenticationError
+from utils cimport to_bytes
 
 
 cdef int auth_identity(const char *username,
@@ -64,15 +65,16 @@ cdef class Agent:
             clear_agent(self._agent)
 
     def list_identities(self):
-        """This method is a no-op - use get_identities to list and retrieve
+        """This method is a no-op - use
+          :py:func:`ssh2.agent.Agent.get_identities` to list and retrieve
         identities
         """
         pass
 
-    def get_identities(self, const char *username):
+    def get_identities(self):
         """List and get identities from agent
 
-        :rtype: list(:py:class:`PublicKey`)
+        :rtype: list(:py:class:`ssh2.pkey.PublicKey`)
         """
         cdef int rc
         cdef list identities = []
@@ -91,19 +93,25 @@ cdef class Agent:
                 prev = identity
         return identities
 
-    def userauth(self, const char *username,
+    def userauth(self, username,
                  PublicKey pkey):
         """Perform user authentication with specific public key
 
         :param username: User name to authenticate as
         :type username: str
         :param pkey: Public key to authenticate with
         :type pkey: py:class:`PublicKey`
+
+        :raises: :py:class:`ssh2.exceptions.AgentAuthenticationError` on errors
+          authenticating.
+
+        :rtype: int
         """
         cdef int rc
+        cdef char *_username = to_bytes(username)
         with nogil:
             rc = c_ssh2.libssh2_agent_userauth(
-                self._agent, username, pkey._pkey)
+                self._agent, _username, pkey._pkey)
             if rc != 0 and rc != c_ssh2._LIBSSH2_ERROR_EAGAIN:
                 with gil:
                     raise AgentAuthenticationError(

ssh2/agent.pyx

@@ -22,7 +22,7 @@ cimport error_codes
 
 from session cimport Session
 from exceptions cimport ChannelError
-# from utils cimport to_bytes
+from utils cimport to_bytes
 
 
 cdef object PyChannel(c_ssh2.LIBSSH2_CHANNEL *channel, Session session):
@@ -39,6 +39,7 @@ cdef class Channel:
 
     def __dealloc__(self):
         with nogil:
+            c_ssh2.libssh2_channel_close(self._channel)
             c_ssh2.libssh2_channel_free(self._channel)
 
     def pty(self, term="vt100"):
@@ -54,27 +55,39 @@ cdef class Channel:
                         rc)
         return rc
 
-    def execute(self, const char *command):
+    def execute(self, command):
+        """Execute command.
+
+        :param command: Command to execute
+        :type command: str
+
+        :raises: :py:class:`ssh2.exceptions.ChannelError` on errors executing
+          command
+
+        :rtype: int
+        """
         cdef int rc
+        cdef char *_command = to_bytes(command)
         with nogil:
             rc = c_ssh2.libssh2_channel_exec(
-                self._channel, command)
+                self._channel, _command)
             if rc != 0 and rc != c_ssh2._LIBSSH2_ERROR_EAGAIN:
                 with gil:
                     raise ChannelError(
                         "Error executing command %s - error code %s",
                         command, rc)
         return rc
 
-    def subsystem(self, const char *subsystem):
+    def subsystem(self, subsystem):
         """Request subsystem from channel
 
         :param subsystem: Name of subsystem
         :type subsystem: str"""
         cdef int rc
+        cdef char *_subsystem = to_bytes(subsystem)
         with nogil:
             rc = c_ssh2.libssh2_channel_subsystem(
-                self._channel, subsystem)
+                self._channel, _subsystem)
             if rc != 0 and rc != c_ssh2._LIBSSH2_ERROR_EAGAIN:
                 with gil:
                     raise ChannelError(
@@ -233,11 +246,13 @@ cdef class Channel:
             py_langtag = langtag[:py_langlen]
         return rc, py_exitsignal, py_errmsg, py_langtag
 
-    def setenv(self, const char *varname, const char *value):
+    def setenv(self, varname, value):
         cdef int rc
+        cdef char *_varname = to_bytes(varname)
+        cdef char *_value = to_bytes(value)
         with nogil:
             rc = c_ssh2.libssh2_channel_setenv(
-                self._channel, varname, value)
+                self._channel, _varname, _value)
         return rc
 
     def window_read_ex(self, unsigned long read_avail,
@@ -267,29 +282,29 @@ cdef class Channel:
             rc = c_ssh2.libssh2_channel_window_write(self._channel)
         return rc
 
-    def write(self, bytes buf):
+    def write(self, buf):
         """Write buffer to stdin"""
-        cdef const char *_buf = buf
-        cdef size_t buflen = len(buf)
+        cdef const char *_buf = to_bytes(buf)
+        cdef size_t buflen = len(_buf)
         cdef ssize_t rc
         with nogil:
             rc = c_ssh2.libssh2_channel_write(self._channel, _buf, buflen)
         return rc
 
-    def write_ex(self, int stream_id, bytes buf):
+    def write_ex(self, int stream_id, buf):
         """Write buffer to specified stream id"""
-        cdef const char *_buf = buf
-        cdef size_t buflen = len(buf)
+        cdef const char *_buf = to_bytes(buf)
+        cdef size_t buflen = len(_buf)
         cdef ssize_t rc
         with nogil:
             rc = c_ssh2.libssh2_channel_write_ex(
                 self._channel, stream_id, _buf, buflen)
         return rc
 
-    def write_stderr(self, bytes buf):
+    def write_stderr(self, buf):
         """Write buffer to stderr"""
-        cdef const char *_buf = buf
-        cdef size_t buflen = len(buf)
+        cdef const char *_buf = to_bytes(buf)
+        cdef size_t buflen = len(_buf)
         cdef ssize_t rc
         with nogil:
             rc = c_ssh2.libssh2_channel_write_stderr(