Added none checks on method arguments.

Added docstrings.
Removed unused parameter from agent get identities method.
Updated example for changed API.
Updated tests to only start one server.
Updated embedded server config.
Updated tests to correctly decode output.

Author: Pan

embedded_server/openssh.py

@@ -32,7 +32,7 @@ def __init__(self, port=2222):
 
     def start_server(self):
         cmd = ['/usr/sbin/sshd', '-D', '-p', str(self.port),
-               '-h', SERVER_KEY, '-f', SSHD_CONFIG]
+               '-q', '-h', SERVER_KEY, '-f', SSHD_CONFIG]
         server = Popen(cmd)
         self.server_proc = server
         self._wait_for_port()
@@ -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(.2)
+        sleep(.3)
         del sock
 
     def stop(self):

embedded_server/sshd_config

@@ -5,7 +5,7 @@ RhostsRSAAuthentication no
 HostbasedAuthentication no
 IgnoreUserKnownHosts yes
 GSSAPIAuthentication no
-
+ListenAddress 127.0.0.1
 KeyRegenerationInterval 3600
 ServerKeyBits 1024
 

examples/example_echo.py

@@ -26,7 +26,7 @@
 # Agent capabilities
 agent = session.agent_init()
 agent.connect()
-identities = agent.get_identities(user)
+identities = agent.get_identities()
 print(identities)
 print(identities[0].magic)
 del agent

ssh2/agent.c

@@ -93,14 +93,14 @@ cdef class Agent:
                 prev = identity
         return identities
 
-    def userauth(self, username,
+    def userauth(self, username not None,
                  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`
+        :type pkey: py:class:`ssh2.pkey.PublicKey`
 
         :raises: :py:class:`ssh2.exceptions.AgentAuthenticationError` on errors
           authenticating.
@@ -120,12 +120,21 @@ cdef class Agent:
         return rc
 
     def disconnect(self):
+        """Disconnect from agent.
+
+        :rtype: int"""
         cdef int rc
         with nogil:
             rc = c_ssh2.libssh2_agent_disconnect(self._agent)
         return rc
 
     def connect(self):
+        """Connect to agent.
+
+        :raises: :py:class:`ssh2.exceptions.AgentConnectError` on errors
+          connecting to agent.
+
+        :rtype: int"""
         cdef int rc
         with nogil:
             rc = c_ssh2.libssh2_agent_connect(self._agent)

ssh2/agent.pyx

@@ -42,6 +42,31 @@ cdef extern from "libssh2_sftp.h" nogil:
         uint64_t  f_fsid     # file system ID
         uint64_t  f_flag     # mount flags
         uint64_t  f_namemax  # maximum filename length
+    # SFTP File Transfer Flags
+    enum:
+        LIBSSH2_FXF_READ
+        LIBSSH2_FXF_WRITE
+        LIBSSH2_FXF_APPEND
+        LIBSSH2_FXF_CREAT
+        LIBSSH2_FXF_TRUNC
+        LIBSSH2_FXF_EXCL
+    # SFTP File modes
+    enum:
+        # Read, write, execute/search by owner
+        LIBSSH2_SFTP_S_IRWXU        # RWX mask for owner
+        LIBSSH2_SFTP_S_IRUSR        # R for owner
+        LIBSSH2_SFTP_S_IWUSR        # W for owner
+        LIBSSH2_SFTP_S_IXUSR        # X for owner
+        # Read, write, execute/search by group
+        LIBSSH2_SFTP_S_IRWXG        # RWX mask for group
+        LIBSSH2_SFTP_S_IRGRP        # R for group
+        LIBSSH2_SFTP_S_IWGRP        # W for group
+        LIBSSH2_SFTP_S_IXGRP        # X for group
+        # Read, write, execute/search by others
+        LIBSSH2_SFTP_S_IRWXO        # RWX mask for other
+        LIBSSH2_SFTP_S_IROTH        # R for other
+        LIBSSH2_SFTP_S_IWOTH        # W for other
+        LIBSSH2_SFTP_S_IXOTH        # X for other
     LIBSSH2_SFTP *libssh2_sftp_init(LIBSSH2_SESSION *session)
     int libssh2_sftp_shutdown(LIBSSH2_SFTP *sftp)
     unsigned long libssh2_sftp_last_error(LIBSSH2_SFTP *sftp)