ssh: switch from libssh2 to libssh
PATCH v8 1/1 ssh: switch from libssh2 to libssh
Rewrite the implementation of the ssh block driver to use libssh instead of libssh2. The libssh library has various advantages over libssh2:
- easier API for authentication (for example for using ssh-agent)
- easier API for known_hosts handling
- supports newer types of keys in known_hosts
Use APIs/features available in libssh 0.8 conditionally, to support older versions (which are not recommended though).
Adjust the various Docker/Travis scripts to use libssh when available instead of libssh2.
---
Changes from v7:
- #if HAVE_LIBSSH_0_8 -> #ifdef HAVE_LIBSSH_0_8
- ptrdiff_t -> size_t
Changes from v6:
- fixed few checkpatch style issues
- detect libssh 0.8 via symbol detection
- adjust travis/docker test material
- remove dead "default" case in a switch
- use variables for storing MIN() results
- adapt a documentation bit
Changes from v5:
- adapt to newer tracing APIs
- disable ssh compression (mimic what libssh2 does by default)
- use build time checks for libssh 0.8, and use newer APIs directly
Changes from v4:
- fix wrong usages of error_setg/session_error_setg/sftp_error_setg
- fix few return code checks
- remove now-unused parameters in few internal functions
- allow authentication with "none" method
- switch to unsigned int for the port number
- enable TCP_NODELAY on the socket
- fix one reference error message in iotest 207
Changes from v3:
- fix socket cleanup in connect_to_ssh()
- add comments about the socket cleanup
- improve the error reporting (closer to what was with libssh2)
- improve EOF detection on sftp_read()
Changes from v2:
- used again an own fd
- fixed co_yield() implementation
Changes from v1:
- fixed jumbo packets writing
- fixed missing 'err' assignment
- fixed commit message
.travis.yml | 4 +- block/Makefile.objs | 6 +- block/ssh.c | 622 +++++++++--------- block/trace-events | 14 +- configure | 65 +- docs/qemu-block-drivers.texi | 2 +- .../dockerfiles/debian-win32-cross.docker | 1 - .../dockerfiles/debian-win64-cross.docker | 1 - tests/docker/dockerfiles/fedora.docker | 4 +- tests/docker/dockerfiles/ubuntu.docker | 2 +- tests/docker/dockerfiles/ubuntu1804.docker | 2 +- tests/qemu-iotests/207.out | 2 +- 12 files changed, 374 insertions(+), 351 deletions(-)
.travis.yml +2 -2
@@ -31,7 +31,7 @@ addons: - libseccomp-dev - libspice-protocol-dev - libspice-server-dev - - libssh2-1-dev + - libssh-dev - liburcu-dev - libusb-1.0-0-dev - libvte-2.91-dev
@@ -261,7 +261,7 @@ matrix: - libseccomp-dev - libspice-protocol-dev - libspice-server-dev - - libssh2-1-dev + - libssh-dev - liburcu-dev - libusb-1.0-0-dev - libvte-2.91-dev
block/Makefile.objs +3 -3
@@ -31,7 +31,7 @@ block-obj-$(CONFIG_CURL) += curl.o block-obj-$(CONFIG_RBD) += rbd.o block-obj-$(CONFIG_GLUSTERFS) += gluster.o block-obj-$(CONFIG_VXHS) += vxhs.o -block-obj-$(CONFIG_LIBSSH2) += ssh.o +block-obj-$(CONFIG_LIBSSH) += ssh.o block-obj-y += accounting.o dirty-bitmap.o block-obj-y += write-threshold.o block-obj-y += backup.o
@@ -52,8 +52,8 @@ rbd.o-libs := $(RBD_LIBS) gluster.o-cflags := $(GLUSTERFS_CFLAGS) gluster.o-libs := $(GLUSTERFS_LIBS) vxhs.o-libs := $(VXHS_LIBS) -ssh.o-cflags := $(LIBSSH2_CFLAGS) -ssh.o-libs := $(LIBSSH2_LIBS) +ssh.o-cflags := $(LIBSSH_CFLAGS) +ssh.o-libs := $(LIBSSH_LIBS) block-obj-dmg-bz2-$(CONFIG_BZIP2) += dmg-bz2.o block-obj-$(if $(CONFIG_DMG),m,n) += $(block-obj-dmg-bz2-y) dmg-bz2.o-libs := $(BZIP2_LIBS)
block/ssh.c +328 -294
1,016 lines not on this page · raw message
block/trace-events +8 -6
@@ -169,19 +169,21 @@ nbd_co_request_fail(uint64_t from, uint32_t len, uint64_t handle, uint16_t flags # ssh.c ssh_restart_coroutine(void *co) "co=%p" ssh_flush(void) "fsync" -ssh_check_host_key_knownhosts(const char *key) "host key OK: %s" +ssh_check_host_key_knownhosts(void) "host key OK" ssh_connect_to_ssh(char *path, int flags, int mode) "opening file %s flags=0x%x creat_mode=0%o" ssh_co_yield(int sock, void *rd_handler, void *wr_handler) "s->sock=%d rd_handler=%p wr_handler=%p" ssh_co_yield_back(int sock) "s->sock=%d - back" ssh_getlength(int64_t length) "length=%" PRIi64 ssh_co_create_opts(uint64_t size) "total_size=%" PRIu64 ssh_read(int64_t offset, size_t size) "offset=%" PRIi64 " size=%zu" -ssh_read_buf(void *buf, size_t size) "sftp_read buf=%p size=%zu" -ssh_read_return(ssize_t ret) "sftp_read returned %zd" +ssh_read_buf(void *buf, size_t size, size_t actual_size) "sftp_read buf=%p size=%zu (actual size=%zu)" +ssh_read_return(ssize_t ret, int sftp_err) "sftp_read returned %zd (sftp error=%d)" ssh_write(int64_t offset, size_t size) "offset=%" PRIi64 " size=%zu" -ssh_write_buf(void *buf, size_t size) "sftp_write buf=%p size=%zu" -ssh_write_return(ssize_t ret) "sftp_write returned %zd" +ssh_write_buf(void *buf, size_t size, size_t actual_size) "sftp_write buf=%p size=%zu (actual size=%zu)" +ssh_write_return(ssize_t ret, int sftp_err) "sftp_write returned %zd (sftp error=%d)" ssh_seek(int64_t offset) "seeking to offset=%" PRIi64 +ssh_auth_methods(int methods) "auth methods=0x%x" +ssh_server_status(int status) "server status=%d" # curl.c curl_timer_cb(long timeout_ms) "timer callback timeout_ms %ld"
@@ -214,4 +216,4 @@ sheepdog_snapshot_create(const char *sn_name, const char *id) "%s %s" sheepdog_snapshot_create_inode(const char *name, uint32_t snap, uint32_t vdi) "s->inode: name %s snap_id 0x%" PRIx32 " vdi 0x%" PRIx32 # ssh.c -sftp_error(const char *op, const char *ssh_err, int ssh_err_code, unsigned long sftp_err_code) "%s failed: %s (libssh2 error code: %d, sftp error code: %lu)" +sftp_error(const char *op, const char *ssh_err, int ssh_err_code, int sftp_err_code) "%s failed: %s (libssh error code: %d, sftp error code: %d)"
configure +28 -37
111 lines not on this page · raw message
docs/qemu-block-drivers.texi +1 -1
@@ -782,7 +782,7 @@ print a warning when @code{fsync} is not supported: warning: ssh server @code{ssh.example.com:22} does not support fsync -With sufficiently new versions of libssh2 and OpenSSH, @code{fsync} is +With sufficiently new versions of libssh and OpenSSH, @code{fsync} is supported. @node disk_images_nvme
tests/docker/dockerfiles/debian-win32-cross.docker +0 -1
@@ -15,7 +15,6 @@ RUN DEBIAN_FRONTEND=noninteractive eatmydata \ mxe-$TARGET-w64-mingw32.shared-curl \ mxe-$TARGET-w64-mingw32.shared-glib \ mxe-$TARGET-w64-mingw32.shared-libgcrypt \ - mxe-$TARGET-w64-mingw32.shared-libssh2 \ mxe-$TARGET-w64-mingw32.shared-libusb1 \ mxe-$TARGET-w64-mingw32.shared-lzo \ mxe-$TARGET-w64-mingw32.shared-nettle \
tests/docker/dockerfiles/debian-win64-cross.docker +0 -1
@@ -15,7 +15,6 @@ RUN DEBIAN_FRONTEND=noninteractive eatmydata \ mxe-$TARGET-w64-mingw32.shared-curl \ mxe-$TARGET-w64-mingw32.shared-glib \ mxe-$TARGET-w64-mingw32.shared-libgcrypt \ - mxe-$TARGET-w64-mingw32.shared-libssh2 \ mxe-$TARGET-w64-mingw32.shared-libusb1 \ mxe-$TARGET-w64-mingw32.shared-lzo \ mxe-$TARGET-w64-mingw32.shared-nettle \
tests/docker/dockerfiles/fedora.docker +1 -3
@@ -35,7 +35,7 @@ ENV PACKAGES \ libpng-devel \ librbd-devel \ libseccomp-devel \ - libssh2-devel \ + libssh-devel \ libubsan \ libusbx-devel \ libxml2-devel \
@@ -50,7 +50,6 @@ ENV PACKAGES \ mingw32-gtk3 \ mingw32-libjpeg-turbo \ mingw32-libpng \ - mingw32-libssh2 \ mingw32-libtasn1 \ mingw32-nettle \ mingw32-pixman \
@@ -64,7 +63,6 @@ ENV PACKAGES \ mingw64-gtk3 \ mingw64-libjpeg-turbo \ mingw64-libpng \ - mingw64-libssh2 \ mingw64-libtasn1 \ mingw64-nettle \ mingw64-pixman \
tests/docker/dockerfiles/ubuntu.docker +1 -1
@@ -44,7 +44,7 @@ ENV PACKAGES flex bison \ libsnappy-dev \ libspice-protocol-dev \ libspice-server-dev \ - libssh2-1-dev \ + libssh-dev \ libusb-1.0-0-dev \ libusbredirhost-dev \ libvdeplug-dev \
tests/docker/dockerfiles/ubuntu1804.docker +1 -1
@@ -40,7 +40,7 @@ ENV PACKAGES flex bison \ libsnappy-dev \ libspice-protocol-dev \ libspice-server-dev \ - libssh2-1-dev \ + libssh-dev \ libusb-1.0-0-dev \ libusbredirhost-dev \ libvdeplug-dev \
tests/qemu-iotests/207.out +1 -1
@@ -68,7 +68,7 @@ virtual size: 4 MiB (4194304 bytes) {"execute": "blockdev-create", "arguments": {"job-id": "job0", "options": {"driver": "ssh", "location": {"host-key-check": {"mode": "none"}, "path": "/this/is/not/an/existing/path", "server": {"host": "127.0.0.1", "port": "22"}}, "size": 4194304}}} {"return": {}} -Job failed: failed to open remote file '/this/is/not/an/existing/path': Failed opening remote file (libssh2 error code: -31) +Job failed: failed to open remote file '/this/is/not/an/existing/path': SFTP server: No such file (libssh error code: 1, sftp error code: 2) {"execute": "job-dismiss", "arguments": {"id": "job0"}} {"return": {}}
Signature · 1 line
2.21.0
Hi Pino,
Please Cc the different maintainers (doing that for you).
Quoted 11 lines · Pino Toscano
Rewrite the implementation of the ssh block driver to use libssh instead of libssh2. The libssh library has various advantages over libssh2:
- easier API for authentication (for example for using ssh-agent)
- easier API forknown_hostshandling
- supports newer types of keys inknown_hostsUse APIs/features available in libssh 0.8 conditionally, to support older versions (which are not recommended though).
Adjust the various Docker/Travis scripts to use libssh when available instead of libssh2.
Please add a comment this patch remove the possibility to use the ssh block driver on MinGW. Stefan only read QEMU emails during the week-end.
Quoted 947 lines
Signed-off-by Pino Toscano <[email protected]>---
Changes from v7:
- #ifHAVE_LIBSSH_0_8-> #ifdefHAVE_LIBSSH_0_8
-ptrdiff_t->size_tChanges from v6:
- fixed few checkpatch style issues
- detect libssh 0.8 via symbol detection
- adjust travis/docker test material
- remove dead "default" case in a switch
- use variables for storingMIN()results
- adapt a documentation bitChanges from v5:
- adapt to newer tracing APIs
- disable ssh compression (mimic what libssh2 does by default)
- use build time checks for libssh 0.8, and use newer APIs directlyChanges from v4:
- fix wrong usages of error_setg/session_error_setg/sftp_error_setg
- fix few return code checks
- remove now-unused parameters in few internal functions
- allow authentication with "none" method
- switch to unsigned int for the port number
- enableTCP_NODELAYon the socket
- fix one reference error message in iotest 207Changes from v3:
- fix socket cleanup inconnect_to_ssh()
- add comments about the socket cleanup
- improve the error reporting (closer to what was with libssh2)
- improve EOF detection onsftp_read()Changes from v2:
- used again an own fd
- fixedco_yield()implementationChanges from v1:
- fixed jumbo packets writing
- fixed missing 'err' assignment
- fixed commit message.travis.yml | 4 +- block/Makefile.objs | 6 +- block/ssh.c | 622 +++++++++--------- block/trace-events | 14 +- configure | 65 +- docs/qemu-block-drivers.texi | 2 +- .../dockerfiles/debian-win32-cross.docker | 1 - .../dockerfiles/debian-win64-cross.docker | 1 - tests/docker/dockerfiles/fedora.docker | 4 +- tests/docker/dockerfiles/ubuntu.docker | 2 +- tests/docker/dockerfiles/ubuntu1804.docker | 2 +- tests/qemu-iotests/207.out | 2 +- 12 files changed, 374 insertions(+), 351 deletions(-).travis.yml +2
-2@@ -31,7 +31,7 @@ addons: - libseccomp-dev - libspice-protocol-dev - libspice-server-dev - - libssh2-1-dev + - libssh-dev - liburcu-dev - libusb-1.0-0-dev - libvte-2.91-dev@@ -261,7 +261,7 @@ matrix: - libseccomp-dev - libspice-protocol-dev - libspice-server-dev - - libssh2-1-dev + - libssh-dev - liburcu-dev - libusb-1.0-0-dev - libvte-2.91-devblock/Makefile.objs +3
-3@@ -31,7 +31,7 @@ block-obj-$(CONFIG_CURL) += curl.o block-obj-$(CONFIG_RBD) += rbd.o block-obj-$(CONFIG_GLUSTERFS) += gluster.o block-obj-$(CONFIG_VXHS) += vxhs.o -block-obj-$(CONFIG_LIBSSH2) += ssh.o +block-obj-$(CONFIG_LIBSSH) += ssh.o block-obj-y += accounting.o dirty-bitmap.o block-obj-y += write-threshold.o block-obj-y += backup.o@@ -52,8 +52,8 @@ rbd.o-libs := $(RBD_LIBS) gluster.o-cflags := $(GLUSTERFS_CFLAGS) gluster.o-libs := $(GLUSTERFS_LIBS) vxhs.o-libs := $(VXHS_LIBS) -ssh.o-cflags := $(LIBSSH2_CFLAGS) -ssh.o-libs := $(LIBSSH2_LIBS) +ssh.o-cflags := $(LIBSSH_CFLAGS) +ssh.o-libs := $(LIBSSH_LIBS) block-obj-dmg-bz2-$(CONFIG_BZIP2) += dmg-bz2.o block-obj-$(if $(CONFIG_DMG),m,n) += $(block-obj-dmg-bz2-y) dmg-bz2.o-libs := $(BZIP2_LIBS)block/ssh.c +277
-243@@ -24,8 +24,8 @@#include "qemu/osdep.h" -#include <libssh2.h> -#include <libssh2_sftp.h> +#include <libssh/libssh.h> +#include <libssh/sftp.h> #include "block/block_int.h" #include "block/qdict.h" @@ -46,13 +46,11 @@#include "trace.h" /* -* TRACE_LIBSSH2=<bitmask> enables tracing in libssh2 itself. Note -* that this requires that libssh2 was specially compiled with the -* `./configure --enable-debug' option, so most likely you will have -* to compile it yourself. The meaning of <bitmask> is described -* here: http://www.libssh2.org/libssh2_trace.html +* TRACE_LIBSSH=<level> enables tracing in libssh itself. +* The meaning of <level> is described here: +* http://api.libssh.org/master/group__libssh__log.html */ -#define TRACE_LIBSSH2 0/* or try: LIBSSH2_TRACE_SFTP */ +#define TRACE_LIBSSH 0/* see: SSH_LOG_* */ typedef struct BDRVSSHState { /* Coroutine. */@@ -60,18 +58,15 @@ typedef struct BDRVSSHState {/* SSH connection. */ int sock;/* socket */ -LIBSSH2_SESSION *session;/* ssh session */ -LIBSSH2_SFTP *sftp;/* sftp session */ -LIBSSH2_SFTP_HANDLE *sftp_handle;/* sftp remote file handle */ +ssh_session session;/* ssh session */ +sftp_session sftp;/* sftp session */ +sftp_file sftp_handle;/* sftp remote file handle */ -/* See ssh_seek() function below. */ -int64_t offset; -bool offset_op_read; - -/* File attributes at open. We try to keep the .filesize field +/* +* File attributes at open. We try to keep the .size field * updated if it changes (eg by writing at the end of the file). */ -LIBSSH2_SFTP_ATTRIBUTES attrs; +sftp_attributes attrs;InetSocketAddress *inet;@@ -91,7 +86,6 @@ static void ssh_state_init(BDRVSSHState *s) {memset (s,0 ,sizeof *s); s->sock =-1 ; - s->offset =-1 ;qemu_co_mutex_init (&s->lock); }@@ -99,20 +93,18 @@ static void ssh_state_free(BDRVSSHState *s) {g_free (s->user); +if (s->attrs) { +sftp_attributes_free (s->attrs); + }if (s->sftp_handle) { -libssh2_sftp_close (s->sftp_handle); +sftp_close (s->sftp_handle); }if (s->sftp) { -libssh2_sftp_shutdown (s->sftp); +sftp_free (s->sftp); }if (s->session) { -libssh2_session_disconnect (s->session, -"from qemu ssh client: " -"user closed the connection" ); -libssh2_session_free (s->session); - } -if (s->sock >=0 ) { -close (s->sock); +ssh_disconnect (s->session); +ssh_free (s->session);/* This frees s->sock */ } }@@ -127,13 +119,13 @@ session_error_setg(Error **errp, BDRVSSHState *s, const char *fs, ...)va_end (args);if (s->session) { -char *ssh_err; +const char *ssh_err;int ssh_err_code; -/* This is not an errno. See <libssh2.h>. */ - ssh_err_code =libssh2_session_last_error (s->session, - &ssh_err,NULL ,0 ); -error_setg (errp,"%s: %s (libssh2 error code: %d)" , +/* This is not an errno. See <libssh/libssh.h>. */ + ssh_err =ssh_get_error (s->session); + ssh_err_code =ssh_get_error_code (s->session); +error_setg (errp,"%s: %s (libssh error code: %d)" , msg, ssh_err, ssh_err_code); }else {error_setg (errp,"%s" , msg);@@ -152,18 +144,18 @@ sftp_error_setg(Error **errp, BDRVSSHState *s, const char *fs, ...)va_end (args);if (s->sftp) { -char *ssh_err; +const char *ssh_err;int ssh_err_code; -unsigned long sftp_err_code; +int sftp_err_code; -/* This is not an errno. See <libssh2.h>. */ - ssh_err_code =libssh2_session_last_error (s->session, - &ssh_err,NULL ,0 ); -/* See <libssh2_sftp.h>. */ - sftp_err_code =libssh2_sftp_last_error ((s)->sftp); +/* This is not an errno. See <libssh/libssh.h>. */ + ssh_err =ssh_get_error (s->session); + ssh_err_code =ssh_get_error_code (s->session); +/* See <libssh/sftp.h>. */ + sftp_err_code =sftp_get_error (s->sftp);error_setg (errp, -"%s: %s (libssh2 error code: %d, sftp error code: %lu)" , +"%s: %s (libssh error code: %d, sftp error code: %d)" , msg, ssh_err, ssh_err_code, sftp_err_code); }else {error_setg (errp,"%s" , msg);@@ -173,15 +165,15 @@ sftp_error_setg(Error **errp, BDRVSSHState *s, const char *fs, ...)static void sftp_error_trace (BDRVSSHState *s,const char *op) { -char *ssh_err; +const char *ssh_err;int ssh_err_code; -unsigned long sftp_err_code; +int sftp_err_code; -/* This is not an errno. See <libssh2.h>. */ - ssh_err_code =libssh2_session_last_error (s->session, - &ssh_err,NULL ,0 ); -/* See <libssh2_sftp.h>. */ - sftp_err_code =libssh2_sftp_last_error ((s)->sftp); +/* This is not an errno. See <libssh/libssh.h>. */ + ssh_err =ssh_get_error (s->session); + ssh_err_code =ssh_get_error_code (s->session); +/* See <libssh/sftp.h>. */ + sftp_err_code =sftp_get_error (s->sftp);trace_sftp_error (op, ssh_err, ssh_err_code, sftp_err_code); }@@ -282,82 +274,85 @@ static void ssh_parse_filename(const char *filename, QDict *options,parse_uri (filename, options, errp); } -static int check_host_key_knownhosts (BDRVSSHState *s, -const char *host,int port,Error **errp) +static int check_host_key_knownhosts (BDRVSSHState *s,Error **errp) { -const char *home; -char *knh_file =NULL ; -LIBSSH2_KNOWNHOSTS *knh =NULL ; -struct libssh2_knownhost *found; -int ret, r; -const char *hostkey; -size_t len; -int type; +int ret; +#ifdef HAVE_LIBSSH_0_8 +enum ssh_known_hosts_e state; - hostkey =libssh2_session_hostkey (s->session, &len, &type); -if (!hostkey) { - ret = -EINVAL ; -session_error_setg (errp, s,"failed to read remote host key" ); - goto out; - } + state =ssh_session_is_known_server (s->session); +trace_ssh_server_status (state); - knh =libssh2_knownhost_init (s->session); -if (!knh) { - ret = -EINVAL ; -session_error_setg (errp, s, -"failed to initialize known hosts support" ); - goto out; - } - - home =getenv ("HOME" ); -if (home) { - knh_file =g_strdup_printf ("%s/.ssh/known_hosts" , home); - }else { - knh_file =g_strdup_printf ("/root/.ssh/known_hosts" ); - } - -/* Read all known hosts from OpenSSH-style known_hosts file. */ -libssh2_knownhost_readfile (knh, knh_file,LIBSSH2_KNOWNHOST_FILE_OPENSSH ); - - r =libssh2_knownhost_checkp (knh, host, port, hostkey, len, -LIBSSH2_KNOWNHOST_TYPE_PLAIN | -LIBSSH2_KNOWNHOST_KEYENC_RAW , - &found); -switch (r) { -case LIBSSH2_KNOWNHOST_CHECK_MATCH : +switch (state) { +case SSH_KNOWN_HOSTS_OK :/* OK */ -trace_ssh_check_host_key_knownhosts (found->key); +trace_ssh_check_host_key_knownhosts ();break ; -case LIBSSH2_KNOWNHOST_CHECK_MISMATCH : +case SSH_KNOWN_HOSTS_CHANGED : ret = -EINVAL ; -session_error_setg (errp, s, -"host key does not match the one in known_hosts" -" (found key %s)" , found->key); +error_setg (errp,"host key does not match the one in known_hosts" ); goto out; -case LIBSSH2_KNOWNHOST_CHECK_NOTFOUND : +case SSH_KNOWN_HOSTS_OTHER : ret = -EINVAL ; -session_error_setg (errp, s,"no host key was found in known_hosts" ); +error_setg (errp, +"host key for this server not found, another type exists" ); goto out; -case LIBSSH2_KNOWNHOST_CHECK_FAILURE : +case SSH_KNOWN_HOSTS_UNKNOWN : ret = -EINVAL ; -session_error_setg (errp, s, -"failure matching the host key with known_hosts" ); +error_setg (errp,"no host key was found in known_hosts" ); + goto out; +case SSH_KNOWN_HOSTS_NOT_FOUND : + ret = -ENOENT ; +error_setg (errp,"known_hosts file not found" ); + goto out; +case SSH_KNOWN_HOSTS_ERROR : + ret = -EINVAL ; +error_setg (errp,"error while checking the host" ); goto out;default : ret = -EINVAL ; -session_error_setg (errp, s,"unknown error matching the host key" -" with known_hosts (%d)" , r); +error_setg (errp,"error while checking for known server" ); goto out; } +#else /* !HAVE_LIBSSH_0_8 */ +int state; + + state =ssh_is_server_known (s->session); +trace_ssh_server_status (state); + +switch (state) { +case SSH_SERVER_KNOWN_OK : +/* OK */ +trace_ssh_check_host_key_knownhosts (); +break ; +case SSH_SERVER_KNOWN_CHANGED : + ret = -EINVAL ; +error_setg (errp,"host key does not match the one in known_hosts" ); + goto out; +case SSH_SERVER_FOUND_OTHER : + ret = -EINVAL ; +error_setg (errp, +"host key for this server not found, another type exists" ); + goto out; +case SSH_SERVER_FILE_NOT_FOUND : + ret = -ENOENT ; +error_setg (errp,"known_hosts file not found" ); + goto out; +case SSH_SERVER_NOT_KNOWN : + ret = -EINVAL ; +error_setg (errp,"no host key was found in known_hosts" ); + goto out; +case SSH_SERVER_ERROR : + ret = -EINVAL ; +error_setg (errp,"server error" ); + goto out; + } +#endif /* !HAVE_LIBSSH_0_8 */ /* known_hosts checking successful. */ ret =0 ; out: -if (knh !=NULL ) { -libssh2_knownhost_free (knh); - } -g_free (knh_file);return ret; }@@ -401,18 +396,34 @@ static int compare_fingerprint(const unsigned char *fingerprint, size_t len,static int check_host_key_hash (BDRVSSHState *s,const char *hash, -int hash_type,size_t fingerprint_len,Error **errp) +enum ssh_publickey_hash_type type,Error **errp) { -const char *fingerprint; +int r; +ssh_key pubkey; +unsigned char *server_hash; +size_t server_hash_len; - fingerprint =libssh2_hostkey_hash (s->session, hash_type); -if (!fingerprint) { +#ifdef HAVE_LIBSSH_0_8 + r =ssh_get_server_publickey (s->session, &pubkey); +#else + r =ssh_get_publickey (s->session, &pubkey); +#endif +if (r !=SSH_OK ) {session_error_setg (errp, s,"failed to read remote host key" );return -EINVAL ; } -if (compare_fingerprint ((unsigned char *) fingerprint, fingerprint_len, - hash) !=0 ) { + r =ssh_get_publickey_hash (pubkey, type, &server_hash, &server_hash_len); +ssh_key_free (pubkey); +if (r !=0 ) { +session_error_setg (errp, s, +"failed reading the hash of the server SSH key" ); +return -EINVAL ; + } + + r =compare_fingerprint (server_hash, server_hash_len, hash); +ssh_clean_pubkey_hash (&server_hash); +if (r !=0 ) {error_setg (errp,"remote host key does not match host_key_check '%s'" , hash);return -EPERM ;@@ -421,8 +432,7 @@ check_host_key_hash(BDRVSSHState *s, const char *hash,return 0 ; } -static int check_host_key (BDRVSSHState *s,const char *host,int port, -SshHostKeyCheck *hkc,Error **errp) +static int check_host_key (BDRVSSHState *s,SshHostKeyCheck *hkc,Error **errp) {SshHostKeyCheckMode mode;@@ -438,15 +448,15 @@ static int check_host_key(BDRVSSHState *s, const char *host, int port,case SSH_HOST_KEY_CHECK_MODE_HASH :if (hkc->u.hash.type ==SSH_HOST_KEY_CHECK_HASH_TYPE_MD5 ) {return check_host_key_hash (s, hkc->u.hash.hash, -LIBSSH2_HOSTKEY_HASH_MD5 ,16 , errp); +SSH_PUBLICKEY_HASH_MD5 , errp); }else if (hkc->u.hash.type ==SSH_HOST_KEY_CHECK_HASH_TYPE_SHA1 ) {return check_host_key_hash (s, hkc->u.hash.hash, -LIBSSH2_HOSTKEY_HASH_SHA1 ,20 , errp); +SSH_PUBLICKEY_HASH_SHA1 , errp); }g_assert_not_reached ();break ;case SSH_HOST_KEY_CHECK_MODE_KNOWN_HOSTS : -return check_host_key_knownhosts (s, host, port, errp); +return check_host_key_knownhosts (s, errp);default :g_assert_not_reached (); }@@ -454,60 +464,43 @@ static int check_host_key(BDRVSSHState *s, const char *host, int port,return -EINVAL ; } -static int authenticate (BDRVSSHState *s,const char *user,Error **errp) +static int authenticate (BDRVSSHState *s,Error **errp) {int r, ret; -const char *userauthlist; -LIBSSH2_AGENT *agent =NULL ; -struct libssh2_agent_publickey *identity; -struct libssh2_agent_publickey *prev_identity =NULL ; +int method; - userauthlist =libssh2_userauth_list (s->session, user,strlen (user)); -if (strstr (userauthlist,"publickey" ) ==NULL ) { +/* Try to authenticate with the "none" method. */ + r =ssh_userauth_none (s->session,NULL ); +if (r ==SSH_AUTH_ERROR ) { ret = -EPERM ; -error_setg (errp, -"remote server does not support \"publickey\" authentication" ); +session_error_setg (errp, s,"failed to authenticate using none " +"authentication" ); goto out; - } - -/* Connect to ssh-agent and try each identity in turn. */ - agent =libssh2_agent_init (s->session); -if (!agent) { - ret = -EINVAL ; -session_error_setg (errp, s,"failed to initialize ssh-agent support" ); - goto out; - } -if (libssh2_agent_connect (agent)) { - ret = -ECONNREFUSED ; -session_error_setg (errp, s,"failed to connect to ssh-agent" ); - goto out; - } -if (libssh2_agent_list_identities (agent)) { - ret = -EINVAL ; -session_error_setg (errp, s, -"failed requesting identities from ssh-agent" ); + }else if (r ==SSH_AUTH_SUCCESS ) { +/* Authenticated! */ + ret =0 ; goto out; } -for (;;) { - r =libssh2_agent_get_identity (agent, &identity, prev_identity); -if (r ==1 ) {/* end of list */ -break ; - } -if (r <0 ) { + method =ssh_userauth_list (s->session,NULL ); +trace_ssh_auth_methods (method); + +/* +* Try to authenticate with publickey, using the ssh-agent +* if available. +*/ +if (method &SSH_AUTH_METHOD_PUBLICKEY ) { + r =ssh_userauth_publickey_auto (s->session,NULL ,NULL ); +if (r ==SSH_AUTH_ERROR ) { ret = -EINVAL ; -session_error_setg (errp, s, -"failed to obtain identity from ssh-agent" ); +session_error_setg (errp, s,"failed to authenticate using " +"publickey authentication" ); goto out; - } - r =libssh2_agent_userauth (agent, user, identity); -if (r ==0 ) { + }else if (r ==SSH_AUTH_SUCCESS ) {/* Authenticated! */ ret =0 ; goto out; } -/* Failed to authenticate with this identity, try the next one. */ - prev_identity = identity; } ret = -EPERM ;@@ -515,13 +508,6 @@ static int authenticate(BDRVSSHState *s, const char *user, Error **errp) "and the identities held by your ssh-agent"); out: -if (agent !=NULL ) { -/* Note: libssh2 implementation implicitly calls -* libssh2_agent_disconnect if necessary. -*/ -libssh2_agent_free (agent); - } -return ret; }@@ -640,7 +626,8 @@ static int connect_to_ssh(BDRVSSHState *s, BlockdevOptionsSsh *opts, int ssh_flags, int creat_mode, Error **errp) { int r, ret; -long port =0 ; +unsigned int port =0 ; +int new_sock =-1 ;if (opts->has_user) { s->user =g_strdup (opts->user);@@ -657,71 +644,147 @@ static int connect_to_ssh(BDRVSSHState *s, BlockdevOptionsSsh *opts, s->inet = opts->server; opts->server =NULL ; -if (qemu_strtol (s->inet->port,NULL ,10 , &port) <0 ) { +if (qemu_strtoui (s->inet->port,NULL ,10 , &port) <0 ) {error_setg (errp,"Use only numeric port value" ); ret = -EINVAL ; goto err; }/* Open the socket and connect. */ - s->sock =inet_connect_saddr (s->inet, errp); -if (s->sock <0 ) { + new_sock =inet_connect_saddr (s->inet, errp); +if (new_sock <0 ) { ret = -EIO ; goto err; } +/* +* Try to disable the Nagle algorithm on TCP sockets to reduce latency, +* but do not fail if it cannot be disabled. +*/ + r =socket_set_nodelay (new_sock); +if (r <0 ) { +warn_report ("setting NODELAY for the ssh server %s failed: %m" , + s->inet->host); + } +/* Create SSH session. */ - s->session =libssh2_session_init (); + s->session =ssh_new ();if (!s->session) { ret = -EINVAL ; -session_error_setg (errp, s,"failed to initialize libssh2 session" ); +session_error_setg (errp, s,"failed to initialize libssh session" ); goto err; } -#if TRACE_LIBSSH2 !=0 -libssh2_trace (s->session,TRACE_LIBSSH2 ); -#endif +/* +* Make sure we are in blocking mode during the connection and +* authentication phases. +*/ +ssh_set_blocking (s->session,1 ); - r =libssh2_session_handshake (s->session, s->sock); -if (r !=0 ) { + r =ssh_options_set (s->session,SSH_OPTIONS_USER , s->user); +if (r <0 ) { + ret = -EINVAL ; +session_error_setg (errp, s, +"failed to set the user in the libssh session" ); + goto err; + } + + r =ssh_options_set (s->session,SSH_OPTIONS_HOST , s->inet->host); +if (r <0 ) { + ret = -EINVAL ; +session_error_setg (errp, s, +"failed to set the host in the libssh session" ); + goto err; + } + +if (port >0 ) { + r =ssh_options_set (s->session,SSH_OPTIONS_PORT , &port); +if (r <0 ) { + ret = -EINVAL ; +session_error_setg (errp, s, +"failed to set the port in the libssh session" ); + goto err; + } + } + + r =ssh_options_set (s->session,SSH_OPTIONS_COMPRESSION ,"none" ); +if (r <0 ) { + ret = -EINVAL ; +session_error_setg (errp, s, +"failed to disable the compression in the libssh " +"session" ); + goto err; + } + +/* Read ~/.ssh/config. */ + r =ssh_options_parse_config (s->session,NULL ); +if (r <0 ) { + ret = -EINVAL ; +session_error_setg (errp, s,"failed to parse ~/.ssh/config" ); + goto err; + } + + r =ssh_options_set (s->session,SSH_OPTIONS_FD , &new_sock); +if (r <0 ) { + ret = -EINVAL ; +session_error_setg (errp, s, +"failed to set the socket in the libssh session" ); + goto err; + } +/* libssh took ownership of the socket. */ + s->sock = new_sock; + new_sock =-1 ; + +/* Connect. */ + r =ssh_connect (s->session); +if (r !=SSH_OK ) { ret = -EINVAL ;session_error_setg (errp, s,"failed to establish SSH session" ); goto err; }/* Check the remote host's key against known_hosts. */ - ret =check_host_key (s, s->inet->host, port, opts->host_key_check, errp); + ret =check_host_key (s, opts->host_key_check, errp);if (ret <0 ) { goto err; }/* Authenticate. */ - ret =authenticate (s, s->user, errp); + ret =authenticate (s, errp);if (ret <0 ) { goto err; }/* Start SFTP. */ - s->sftp =libssh2_sftp_init (s->session); + s->sftp =sftp_new (s->session);if (!s->sftp) { -session_error_setg (errp, s,"failed to initialize sftp handle" ); +session_error_setg (errp, s,"failed to create sftp handle" ); + ret = -EINVAL ; + goto err; + } + + r =sftp_init (s->sftp); +if (r <0 ) { +sftp_error_setg (errp, s,"failed to initialize sftp handle" ); ret = -EINVAL ; goto err; }/* Open the remote file. */ trace_ssh_connect_to_ssh (opts->path, ssh_flags, creat_mode); - s->sftp_handle =libssh2_sftp_open (s->sftp, opts->path, ssh_flags, - creat_mode); + s->sftp_handle =sftp_open (s->sftp, opts->path, ssh_flags, creat_mode);if (!s->sftp_handle) { -session_error_setg (errp, s,"failed to open remote file '%s'" , - opts->path); +sftp_error_setg (errp, s,"failed to open remote file '%s'" , + opts->path); ret = -EINVAL ; goto err; } - r =libssh2_sftp_fstat (s->sftp_handle, &s->attrs); -if (r <0 ) { +/* Make sure the SFTP file is handled in blocking mode. */ +sftp_file_set_blocking (s->sftp_handle); + + s->attrs =sftp_fstat (s->sftp_handle); +if (!s->attrs) {sftp_error_setg (errp, s,"failed to read file attributes" );return -EINVAL ; }@@ -729,21 +792,26 @@ static int connect_to_ssh(BDRVSSHState *s, BlockdevOptionsSsh *opts,return 0 ; err: +if (s->attrs) { +sftp_attributes_free (s->attrs); + } + s->attrs =NULL ;if (s->sftp_handle) { -libssh2_sftp_close (s->sftp_handle); +sftp_close (s->sftp_handle); } s->sftp_handle =NULL ;if (s->sftp) { -libssh2_sftp_shutdown (s->sftp); +sftp_free (s->sftp); } s->sftp =NULL ;if (s->session) { -libssh2_session_disconnect (s->session, -"from qemu ssh client: " -"error opening connection" ); -libssh2_session_free (s->session); +ssh_disconnect (s->session); +ssh_free (s->session); } s->session =NULL ; +if (new_sock >=0 ) { +close (new_sock); + }return ret; }@@ -758,9 +826,11 @@ static int ssh_file_open(BlockDriverState *bs, QDict *options, int bdrv_flags,ssh_state_init (s); - ssh_flags =LIBSSH2_FXF_READ ; + ssh_flags =0 ;if (bdrv_flags &BDRV_O_RDWR ) { - ssh_flags |=LIBSSH2_FXF_WRITE ; + ssh_flags |=O_RDWR ; + }else { + ssh_flags |=O_RDONLY ; } opts =ssh_parse_options (options, errp);@@ -775,16 +845,13 @@ static int ssh_file_open(BlockDriverState *bs, QDict *options, int bdrv_flags, }/* Go non-blocking. */ -libssh2_session_set_blocking (s->session,0 ); +ssh_set_blocking (s->session,0 );qapi_free_BlockdevOptionsSsh (opts);return 0 ; err: -if (s->sock >=0 ) { -close (s->sock); - } s->sock =-1 ;qapi_free_BlockdevOptionsSsh (opts);@@ -797,25 +864,25 @@ static int ssh_grow_file(BDRVSSHState *s, int64_t offset, Error **errp) {ssize_t ret;char c[1 ] = {'\0' }; -int was_blocking =libssh2_session_get_blocking (s->session); +int was_blocking =ssh_is_blocking (s->session);/* offset must be strictly greater than the current size so we do * not overwrite anything */ -assert (offset >0 && offset > s->attrs.filesize); +assert (offset >0 && offset > s->attrs->size); -libssh2_session_set_blocking (s->session,1 ); +ssh_set_blocking (s->session,1 ); -libssh2_sftp_seek64 (s->sftp_handle, offset -1 ); - ret =libssh2_sftp_write (s->sftp_handle, c,1 ); +sftp_seek64 (s->sftp_handle, offset -1 ); + ret =sftp_write (s->sftp_handle, c,1 ); -libssh2_session_set_blocking (s->session, was_blocking); +ssh_set_blocking (s->session, was_blocking);if (ret <0 ) {sftp_error_setg (errp, s,"Failed to grow file" );return -EIO ; } - s->attrs.filesize = offset; + s->attrs->size = offset;return 0 ; }@@ -843,8 +910,7 @@ static int ssh_co_create(BlockdevCreateOptions *options, Error **errp)ssh_state_init (&s); ret =connect_to_ssh (&s, opts->location, -LIBSSH2_FXF_READ |LIBSSH2_FXF_WRITE | -LIBSSH2_FXF_CREAT |LIBSSH2_FXF_TRUNC , +O_RDWR |O_CREAT |O_TRUNC ,0644 , errp);if (ret <0 ) { goto fail;@@ -913,10 +979,8 @@ static int ssh_has_zero_init(BlockDriverState *bs)/* Assume false, unless we can positively prove it's true. */ int has_zero_init =0 ; -if (s->attrs.flags &LIBSSH2_SFTP_ATTR_PERMISSIONS ) { -if (s->attrs.permissions &LIBSSH2_SFTP_S_IFREG ) { - has_zero_init =1 ; - } +if (s->attrs->type ==SSH_FILEXFER_TYPE_REGULAR ) { + has_zero_init =1 ; }return has_zero_init;@@ -953,12 +1017,12 @@ static coroutine_fn void co_yield(BDRVSSHState *s, BlockDriverState *bs) .co = qemu_coroutine_self() }; - r =libssh2_session_block_directions (s->session); + r =ssh_get_poll_flags (s->session); -if (r &LIBSSH2_SESSION_BLOCK_INBOUND ) { +if (r &SSH_READ_PENDING ) { rd_handler = restart_coroutine; } -if (r &LIBSSH2_SESSION_BLOCK_OUTBOUND ) { +if (r &SSH_WRITE_PENDING ) { wr_handler = restart_coroutine; }@@ -970,33 +1034,6 @@ static coroutine_fn void co_yield(BDRVSSHState *s, BlockDriverState *bs)trace_ssh_co_yield_back (s->sock); } -/* SFTP has a function `libssh2_sftp_seek64' which seeks to a position -* in the remote file. Notice that it just updates a field in the -* sftp_handle structure, so there is no network traffic and it cannot -* fail. -* -* However, `libssh2_sftp_seek64' does have a catastrophic effect on -* performance since it causes the handle to throw away all in-flight -* reads and buffered readahead data. Therefore this function tries -* to be intelligent about when to call the underlying libssh2 function. -*/ -#define SSH_SEEK_WRITE 0 -#define SSH_SEEK_READ 1 -#define SSH_SEEK_FORCE 2 - -static void ssh_seek (BDRVSSHState *s,int64_t offset,int flags) -{ -bool op_read = (flags &SSH_SEEK_READ ) !=0 ; -bool force = (flags &SSH_SEEK_FORCE ) !=0 ; - -if (force || op_read != s->offset_op_read || offset != s->offset) { -trace_ssh_seek (offset); -libssh2_sftp_seek64 (s->sftp_handle, offset); - s->offset = offset; - s->offset_op_read = op_read; - } -} - static coroutine_fn int ssh_read(BDRVSSHState *s, BlockDriverState *bs,int64_t offset,size_t size,QEMUIOVector *qiov)@@ -1008,7 +1045,8 @@ static coroutine_fn int ssh_read(BDRVSSHState *s, BlockDriverState *bs,trace_ssh_read (offset, size); -ssh_seek (s, offset,SSH_SEEK_READ ); +trace_ssh_seek (offset); +sftp_seek64 (s->sftp_handle, offset);/* This keeps track of the current iovec element ('i'), where we * will write to next ('buf'), and the end of the current iovec @@ -1018,35 +1056,35 @@ static coroutine_fn int ssh_read(BDRVSSHState *s, BlockDriverState *bs, buf = i->iov_base; end_of_vec = i->iov_base + i->iov_len; -/* libssh2 has a hard-coded limit of 2000 bytes per request, -* although it will also do readahead behind our backs. Therefore -* we may have to do repeated reads here until we have read 'size' -* bytes. -*/ for (got =0 ; got < size; ) { +size_t request_read_size;
block/ssh.c static coroutine_fn int ssh_read(BDRVSSHState *s, BlockDriverState *bs, · line 1067
Quoted 10 lines
block/ssh.c +6
-3again: -trace_ssh_read_buf (buf, end_of_vec - buf); - r =libssh2_sftp_read (s->sftp_handle, buf, end_of_vec - buf); -trace_ssh_read_return (r); +/* +* The size of SFTP packets is limited to 32K bytes, so limit +* the amount of data requested to 16K, as libssh currently +* does not handle multiple requests on its own. +*/ + request_read_size =MIN (end_of_vec - buf,16384 );
It is not obvious that 'end_of_vec - buf >= 0' (due to the arithmetic at the end of this statement), but I won't block this patch for that (a compiler/static analyzer might start to complain in the future).
Quoted 455 lines
block/ssh.c +45
-48+trace_ssh_read_buf (buf, end_of_vec - buf, request_read_size); + r =sftp_read (s->sftp_handle, buf, request_read_size); +trace_ssh_read_return (r,sftp_get_error (s->sftp)); -if (r ==LIBSSH2_ERROR_EAGAIN || r ==LIBSSH2_ERROR_TIMEOUT ) { +if (r ==SSH_AGAIN ) {co_yield (s, bs); goto again; } -if (r <0 ) { -sftp_error_trace (s,"read" ); - s->offset =-1 ; -return -EIO ; - } -if (r ==0 ) { +if (r ==SSH_EOF || (r ==0 &&sftp_get_error (s->sftp) ==SSH_FX_EOF )) {/* EOF: Short read so pad the buffer with zeroes and return it. */ qemu_iovec_memset (qiov, got,0 , size - got);return 0 ; } +if (r <=0 ) { +sftp_error_trace (s,"read" ); +return -EIO ; + } got += r; buf += r; - s->offset += r;if (buf >= end_of_vec && got < size) { i++; buf = i->iov_base;@@ -1083,7 +1121,8 @@ static int ssh_write(BDRVSSHState *s, BlockDriverState *bs,trace_ssh_write (offset, size); -ssh_seek (s, offset,SSH_SEEK_WRITE ); +trace_ssh_seek (offset); +sftp_seek64 (s->sftp_handle, offset);/* This keeps track of the current iovec element ('i'), where we * will read from next ('buf'), and the end of the current iovec @@ -1094,46 +1133,37 @@ static int ssh_write(BDRVSSHState *s, BlockDriverState *bs, end_of_vec = i->iov_base + i->iov_len;for (written =0 ; written < size; ) { +size_t request_write_size; again: -trace_ssh_write_buf (buf, end_of_vec - buf); - r =libssh2_sftp_write (s->sftp_handle, buf, end_of_vec - buf); -trace_ssh_write_return (r); +/* +* Avoid too large data packets, as libssh currently does not +* handle multiple requests on its own. +*/ + request_write_size =MIN (end_of_vec - buf,131072 ); +trace_ssh_write_buf (buf, end_of_vec - buf, request_write_size); + r =sftp_write (s->sftp_handle, buf, request_write_size); +trace_ssh_write_return (r,sftp_get_error (s->sftp)); -if (r ==LIBSSH2_ERROR_EAGAIN || r ==LIBSSH2_ERROR_TIMEOUT ) { +if (r ==SSH_AGAIN ) {co_yield (s, bs); goto again; }if (r <0 ) {sftp_error_trace (s,"write" ); - s->offset =-1 ;return -EIO ; } -/* The libssh2 API is very unclear about this. A comment in -* the code says "nothing was acked, and no EAGAIN was -* received!" which apparently means that no data got sent -* out, and the underlying channel didn't return any EAGAIN -* indication. I think this is a bug in either libssh2 or -* OpenSSH (server-side). In any case, forcing a seek (to -* discard libssh2 internal buffers), and then trying again -* works for me. -*/ -if (r ==0 ) { -ssh_seek (s, offset + written,SSH_SEEK_WRITE |SSH_SEEK_FORCE ); -co_yield (s, bs); - goto again; - } written += r; buf += r; - s->offset += r;if (buf >= end_of_vec && written < size) { i++; buf = i->iov_base; end_of_vec = i->iov_base + i->iov_len; } -if (offset + written > s->attrs.filesize) - s->attrs.filesize = offset + written; +if (offset + written > s->attrs->size) { + s->attrs->size = offset + written; + } }return 0 ;@@ -1168,24 +1198,24 @@ static void unsafe_flush_warning(BDRVSSHState *s, const char *what) } } -#ifdef HAS_LIBSSH2_SFTP_FSYNC +#ifdef HAVE_LIBSSH_0_8 static coroutine_fn int ssh_flush(BDRVSSHState *s, BlockDriverState *bs) {int r;trace_ssh_flush (); + +if (!sftp_extension_supported (s->sftp,"[email protected]" ,"1" )) { +unsafe_flush_warning (s,"OpenSSH >= 6.3" ); +return 0 ; + } again: - r =libssh2_sftp_fsync (s->sftp_handle); -if (r ==LIBSSH2_ERROR_EAGAIN || r ==LIBSSH2_ERROR_TIMEOUT ) { + r =sftp_fsync (s->sftp_handle); +if (r ==SSH_AGAIN ) {co_yield (s, bs); goto again; } -if (r ==LIBSSH2_ERROR_SFTP_PROTOCOL && -libssh2_sftp_last_error (s->sftp) ==LIBSSH2_FX_OP_UNSUPPORTED ) { -unsafe_flush_warning (s,"OpenSSH >= 6.3" ); -return 0 ; - }if (r <0 ) {sftp_error_trace (s,"fsync" );return -EIO ;@@ -1206,25 +1236,25 @@ static coroutine_fn int ssh_co_flush(BlockDriverState *bs)return ret; } -#else /* !HAS_LIBSSH2_SFTP_FSYNC */ +#else /* !HAVE_LIBSSH_0_8 */ static coroutine_fn int ssh_co_flush(BlockDriverState *bs) {BDRVSSHState *s = bs->opaque; -unsafe_flush_warning (s,"libssh2 >= 1.4.4" ); +unsafe_flush_warning (s,"libssh >= 0.8.0" );return 0 ; } -#endif /* !HAS_LIBSSH2_SFTP_FSYNC */ +#endif /* !HAVE_LIBSSH_0_8 */ static int64_t ssh_getlength (BlockDriverState *bs) {BDRVSSHState *s = bs->opaque;int64_t length; -/* Note we cannot make a libssh2 call here. */ - length = (int64_t ) s->attrs.filesize; +/* Note we cannot make a libssh call here. */ + length = (int64_t ) s->attrs->size;trace_ssh_getlength (length);return length;@@ -1241,12 +1271,12 @@ static int coroutine_fn ssh_co_truncate(BlockDriverState *bs, int64_t offset,return -ENOTSUP ; } -if (offset < s->attrs.filesize) { +if (offset < s->attrs->size) {error_setg (errp,"ssh driver does not support shrinking files" );return -ENOTSUP ; } -if (offset == s->attrs.filesize) { +if (offset == s->attrs->size) {return 0 ; }@@ -1341,12 +1371,16 @@ static void bdrv_ssh_init(void) {int r; - r =libssh2_init (0 ); + r =ssh_init ();if (r !=0 ) { -fprintf (stderr,"libssh2 initialization failed, %d\n" , r); +fprintf (stderr,"libssh initialization failed, %d\n" , r);exit (EXIT_FAILURE ); } +#if TRACE_LIBSSH !=0 +ssh_set_log_level (TRACE_LIBSSH ); +#endif +bdrv_register (&bdrv_ssh); }block/trace-events +8
-6@@ -169,19 +169,21 @@ nbd_co_request_fail(uint64_t from, uint32_t len, uint64_t handle, uint16_t flags # ssh.c ssh_restart_coroutine(void *co) "co=%p" ssh_flush(void) "fsync" -ssh_check_host_key_knownhosts(const char *key) "host key OK: %s" +ssh_check_host_key_knownhosts(void) "host key OK" ssh_connect_to_ssh(char *path, int flags, int mode) "opening file %s flags=0x%x creat_mode=0%o" ssh_co_yield(int sock, void *rd_handler, void *wr_handler) "s->sock=%d rd_handler=%p wr_handler=%p" ssh_co_yield_back(int sock) "s->sock=%d - back" ssh_getlength(int64_t length) "length=%" PRIi64 ssh_co_create_opts(uint64_t size) "total_size=%" PRIu64 ssh_read(int64_t offset, size_t size) "offset=%" PRIi64 " size=%zu" -ssh_read_buf(void *buf, size_t size) "sftp_read buf=%p size=%zu" -ssh_read_return(ssize_t ret) "sftp_read returned %zd" +ssh_read_buf(void *buf, size_t size, size_t actual_size) "sftp_read buf=%p size=%zu (actual size=%zu)" +ssh_read_return(ssize_t ret, int sftp_err) "sftp_read returned %zd (sftp error=%d)" ssh_write(int64_t offset, size_t size) "offset=%" PRIi64 " size=%zu" -ssh_write_buf(void *buf, size_t size) "sftp_write buf=%p size=%zu" -ssh_write_return(ssize_t ret) "sftp_write returned %zd" +ssh_write_buf(void *buf, size_t size, size_t actual_size) "sftp_write buf=%p size=%zu (actual size=%zu)" +ssh_write_return(ssize_t ret, int sftp_err) "sftp_write returned %zd (sftp error=%d)" ssh_seek(int64_t offset) "seeking to offset=%" PRIi64 +ssh_auth_methods(int methods) "auth methods=0x%x" +ssh_server_status(int status) "server status=%d" # curl.c curl_timer_cb(long timeout_ms) "timer callback timeout_ms %ld"@@ -214,4 +216,4 @@ sheepdog_snapshot_create(const char *sn_name, const char *id) "%s %s" sheepdog_snapshot_create_inode(const char *name, uint32_t snap, uint32_t vdi) "s->inode: name %s snap_id 0x%" PRIx32 " vdi 0x%" PRIx32 # ssh.c -sftp_error(const char *op, const char *ssh_err, int ssh_err_code, unsigned long sftp_err_code) "%s failed: %s (libssh2 error code: %d, sftp error code: %lu)" +sftp_error(const char *op, const char *ssh_err, int ssh_err_code, int sftp_err_code) "%s failed: %s (libssh error code: %d, sftp error code: %d)"configure +28
-37@@ -472,7 +472,7 @@ auth_pam="" vte="" virglrenderer="" tpm="" -libssh2="" +libssh="" live_block_migration="yes" numa="" tcmalloc="no"@@ -1439,9 +1439,9 @@ for opt do ;; --enable-tpm) tpm="yes" ;; - --disable-libssh2) libssh2="no" + --disable-libssh) libssh="no" ;; - --enable-libssh2) libssh2="yes" + --enable-libssh) libssh="yes" ;; --disable-live-block-migration) live_block_migration="no" ;;@@ -1810,7 +1810,7 @@ disabled with --disable-FEATURE, default is enabled if available: coroutine-pool coroutine freelist (better performance) glusterfs GlusterFS backend tpm TPM support - libssh2 ssh block device support + libssh ssh block device support numa libnuma support libxml2 for Parallels image format tcmalloc tcmalloc support@@ -3914,43 +3914,34 @@ EOF fi ########################################## -# libssh2 probe -min_libssh2_version=1.2.8 -if test "$libssh2" != "no" ; then - if $pkg_config --atleast-version=$min_libssh2_version libssh2; then - libssh2_cflags=$($pkg_config libssh2 --cflags) - libssh2_libs=$($pkg_config libssh2 --libs) - libssh2=yes +# libssh probe +if test "$libssh" != "no" ; then + if $pkg_config --exists libssh; then + libssh_cflags=$($pkg_config libssh --cflags) + libssh_libs=$($pkg_config libssh --libs) + libssh=yes else - if test "$libssh2" = "yes" ; then - error_exit "libssh2 >= $min_libssh2_version required for --enable-libssh2" + if test "$libssh" = "yes" ; then + error_exit "libssh required for --enable-libssh" fi - libssh2=no + libssh=no fi fi ########################################## -# libssh2_sftp_fsync probe +# Check for libssh 0.8 +# This is done like this instead of using the LIBSSH_VERSION_* and +# SSH_VERSION_* macros because some distributions in the past shipped +# snapshots of the future 0.8 from Git, and those snapshots did not +# have updated version numbers (still referring to 0.7.0). -if test "$libssh2" = "yes"; then +if test "$libssh" = "yes"; then cat > $TMPC <<EOF -#include <stdio.h> -#include <libssh2.h> -#include <libssh2_sftp.h> -int main(void) { - LIBSSH2_SESSION *session; - LIBSSH2_SFTP *sftp; - LIBSSH2_SFTP_HANDLE *sftp_handle; - session = libssh2_session_init (); - sftp = libssh2_sftp_init (session); - sftp_handle = libssh2_sftp_open (sftp, "/", 0, 0); - libssh2_sftp_fsync (sftp_handle); - return 0; -} +#include <libssh/libssh.h> +int main(void) { return ssh_get_server_publickey(NULL, NULL); } EOF - # libssh2_cflags/libssh2_libs defined in previous test. - if compile_prog "$libssh2_cflags" "$libssh2_libs" ; then - QEMU_CFLAGS="-DHAS_LIBSSH2_SFTP_FSYNC $QEMU_CFLAGS" + if compile_prog "$libssh_cflags" "$libssh_libs"; then + libssh_cflags="-DHAVE_LIBSSH_0_8 $libssh_cflags" fi fi@@ -6451,7 +6442,7 @@ echo "GlusterFS support $glusterfs" echo "gcov $gcov_tool" echo "gcov enabled $gcov" echo "TPM support $tpm" -echo "libssh2 support $libssh2" +echo "libssh support $libssh" echo "QOM debugging $qom_cast_debug" echo "Live block migration $live_block_migration" echo "lzo support $lzo"@@ -7144,10 +7135,10 @@ if test "$glusterfs_iocb_has_stat" = "yes" ; then echo "CONFIG_GLUSTERFS_IOCB_HAS_STAT=y" >> $config_host_mak fi -if test "$libssh2" = "yes" ; then - echo "CONFIG_LIBSSH2=m" >> $config_host_mak - echo "LIBSSH2_CFLAGS=$libssh2_cflags" >> $config_host_mak - echo "LIBSSH2_LIBS=$libssh2_libs" >> $config_host_mak +if test "$libssh" = "yes" ; then + echo "CONFIG_LIBSSH=m" >> $config_host_mak + echo "LIBSSH_CFLAGS=$libssh_cflags" >> $config_host_mak + echo "LIBSSH_LIBS=$libssh_libs" >> $config_host_mak fi if test "$live_block_migration" = "yes" ; thendocs/qemu-block-drivers.texi +1
-1@@ -782,7 +782,7 @@ print a warning when @code{fsync} is not supported: warning: ssh server @code{ssh.example.com:22} does not support fsync -With sufficiently new versions of libssh2 and OpenSSH, @code{fsync} is +With sufficiently new versions of libssh and OpenSSH, @code{fsync} is supported. @node disk_images_nvmetests/docker/dockerfiles/debian-win32-cross.docker +0
-1@@ -15,7 +15,6 @@ RUN DEBIAN_FRONTEND=noninteractive eatmydata \ mxe-$TARGET-w64-mingw32.shared-curl \ mxe-$TARGET-w64-mingw32.shared-glib \ mxe-$TARGET-w64-mingw32.shared-libgcrypt \ - mxe-$TARGET-w64-mingw32.shared-libssh2 \ mxe-$TARGET-w64-mingw32.shared-libusb1 \ mxe-$TARGET-w64-mingw32.shared-lzo \ mxe-$TARGET-w64-mingw32.shared-nettle \tests/docker/dockerfiles/debian-win64-cross.docker +0
-1@@ -15,7 +15,6 @@ RUN DEBIAN_FRONTEND=noninteractive eatmydata \ mxe-$TARGET-w64-mingw32.shared-curl \ mxe-$TARGET-w64-mingw32.shared-glib \ mxe-$TARGET-w64-mingw32.shared-libgcrypt \ - mxe-$TARGET-w64-mingw32.shared-libssh2 \ mxe-$TARGET-w64-mingw32.shared-libusb1 \ mxe-$TARGET-w64-mingw32.shared-lzo \ mxe-$TARGET-w64-mingw32.shared-nettle \tests/docker/dockerfiles/fedora.docker +1
-3@@ -35,7 +35,7 @@ ENV PACKAGES \ libpng-devel \ librbd-devel \ libseccomp-devel \ - libssh2-devel \ + libssh-devel \ libubsan \ libusbx-devel \ libxml2-devel \@@ -50,7 +50,6 @@ ENV PACKAGES \ mingw32-gtk3 \ mingw32-libjpeg-turbo \ mingw32-libpng \ - mingw32-libssh2 \ mingw32-libtasn1 \ mingw32-nettle \ mingw32-pixman \@@ -64,7 +63,6 @@ ENV PACKAGES \ mingw64-gtk3 \ mingw64-libjpeg-turbo \ mingw64-libpng \ - mingw64-libssh2 \ mingw64-libtasn1 \ mingw64-nettle \ mingw64-pixman \tests/docker/dockerfiles/ubuntu.docker +1
-1@@ -44,7 +44,7 @@ ENV PACKAGES flex bison \ libsnappy-dev \ libspice-protocol-dev \ libspice-server-dev \ - libssh2-1-dev \ + libssh-dev \ libusb-1.0-0-dev \ libusbredirhost-dev \ libvdeplug-dev \tests/docker/dockerfiles/ubuntu1804.docker +1
-1@@ -40,7 +40,7 @@ ENV PACKAGES flex bison \ libsnappy-dev \ libspice-protocol-dev \ libspice-server-dev \ - libssh2-1-dev \ + libssh-dev \ libusb-1.0-0-dev \ libusbredirhost-dev \ libvdeplug-dev \tests/qemu-iotests/207.out +0
-0
tests/qemu-iotests/207.out virtual size: 4 MiB (4194304 bytes) · line 74
Quoted 8 lines
tests/qemu-iotests/207.out +1
-1@@ -68,7 +68,7 @@ virtual size: 4 MiB (4194304 bytes) {"execute": "blockdev-create", "arguments": {"job-id": "job0", "options": {"driver": "ssh", "location": {"host-key-check": {"mode": "none"}, "path": "/this/is/not/an/existing/path", "server": {"host": "127.0.0.1", "port": "22"}}, "size": 4194304}}} {"return": {}} -Job failed: failed to open remote file '/this/is/not/an/existing/path': Failed opening remote file (libssh2 error code: -31) +Job failed: failed to open remote file '/this/is/not/an/existing/path': SFTP server: No such file (libssh error code: 1, sftp error code: 2) {"execute": "job-dismiss", "arguments": {"id": "job0"}} {"return": {}}
Personally I had to use this patch to have the iotest succeed:
-- >8 --
tests/qemu-iotests/207 +1 -1
@@ -115,7 +115,7 @@ with iotests.FilePath('t.img') as disk_path, \ iotests.img_info_log(remote_path) md5_key = subprocess.check_output( - 'ssh-keyscan -t rsa 127.0.0.1 2>/dev/null | grep -v "\\^#" | ' + + 'ssh-keyscan -t ecdsa-sha2-nistp256 127.0.0.1 2>/dev/null |
grep -v "\\^#" | ' +
'cut -d" " -f3 | base64 -d | md5sum -b | cut -d" " -f1',
shell=True).rstrip().decode('ascii')@@ -154,7 +154,7 @@ with iotests.FilePath('t.img') as disk_path, \
iotests.img_info_log(remote_path)
sha1_key = subprocess.check_output(
- 'ssh-keyscan -t rsa 127.0.0.1 2>/dev/null | grep -v "\\^#" | ' +
+ 'ssh-keyscan -t ecdsa-sha2-nistp256 127.0.0.1 2>/dev/null |
grep -v "\\^#" | ' +
'cut -d" " -f3 | base64 -d | sha1sum -b | cut -d" " -f1',
shell=True).rstrip().decode('ascii')---
(Pino told me on IRC he had to do s/rsa/ssh-ed25519/ to have the test working on his workstation).
Regards,
Phil.