2 * Secure Shell (ssh) backend for QEMU.
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 #include "qemu/osdep.h"
27 #include <libssh/libssh.h>
28 #include <libssh/sftp.h>
30 #include "block/block_int.h"
31 #include "block/qdict.h"
32 #include "qapi/error.h"
33 #include "qemu/error-report.h"
34 #include "qemu/module.h"
35 #include "qemu/option.h"
36 #include "qemu/ctype.h"
37 #include "qemu/cutils.h"
38 #include "qemu/sockets.h"
40 #include "qapi/qapi-visit-sockets.h"
41 #include "qapi/qapi-visit-block-core.h"
42 #include "qapi/qmp/qdict.h"
43 #include "qapi/qmp/qstring.h"
44 #include "qapi/qobject-input-visitor.h"
45 #include "qapi/qobject-output-visitor.h"
49 * TRACE_LIBSSH=<level> enables tracing in libssh itself.
50 * The meaning of <level> is described here:
51 * http://api.libssh.org/master/group__libssh__log.html
53 #define TRACE_LIBSSH 0 /* see: SSH_LOG_* */
55 typedef struct BDRVSSHState {
60 int sock; /* socket */
61 ssh_session session; /* ssh session */
62 sftp_session sftp; /* sftp session */
63 sftp_file sftp_handle; /* sftp remote file handle */
66 * File attributes at open. We try to keep the .size field
67 * updated if it changes (eg by writing at the end of the file).
69 sftp_attributes attrs;
71 InetSocketAddress *inet;
73 /* Used to warn if 'flush' is not supported. */
74 bool unsafe_flush_warning;
77 * Store the user name for ssh_refresh_filename() because the
78 * default depends on the system you are on -- therefore, when we
79 * generate a filename, it should always contain the user name we
85 static void ssh_state_init(BDRVSSHState *s)
87 memset(s, 0, sizeof *s);
89 qemu_co_mutex_init(&s->lock);
92 static void ssh_state_free(BDRVSSHState *s)
97 sftp_attributes_free(s->attrs);
100 sftp_close(s->sftp_handle);
106 ssh_disconnect(s->session);
107 ssh_free(s->session); /* This frees s->sock */
111 static void GCC_FMT_ATTR(3, 4)
112 session_error_setg(Error **errp, BDRVSSHState *s, const char *fs, ...)
118 msg = g_strdup_vprintf(fs, args);
125 /* This is not an errno. See <libssh/libssh.h>. */
126 ssh_err = ssh_get_error(s->session);
127 ssh_err_code = ssh_get_error_code(s->session);
128 error_setg(errp, "%s: %s (libssh error code: %d)",
129 msg, ssh_err, ssh_err_code);
131 error_setg(errp, "%s", msg);
136 static void GCC_FMT_ATTR(3, 4)
137 sftp_error_setg(Error **errp, BDRVSSHState *s, const char *fs, ...)
143 msg = g_strdup_vprintf(fs, args);
151 /* This is not an errno. See <libssh/libssh.h>. */
152 ssh_err = ssh_get_error(s->session);
153 ssh_err_code = ssh_get_error_code(s->session);
154 /* See <libssh/sftp.h>. */
155 sftp_err_code = sftp_get_error(s->sftp);
158 "%s: %s (libssh error code: %d, sftp error code: %d)",
159 msg, ssh_err, ssh_err_code, sftp_err_code);
161 error_setg(errp, "%s", msg);
166 static void sftp_error_trace(BDRVSSHState *s, const char *op)
172 /* This is not an errno. See <libssh/libssh.h>. */
173 ssh_err = ssh_get_error(s->session);
174 ssh_err_code = ssh_get_error_code(s->session);
175 /* See <libssh/sftp.h>. */
176 sftp_err_code = sftp_get_error(s->sftp);
178 trace_sftp_error(op, ssh_err, ssh_err_code, sftp_err_code);
181 static int parse_uri(const char *filename, QDict *options, Error **errp)
188 uri = uri_parse(filename);
193 if (g_strcmp0(uri->scheme, "ssh") != 0) {
194 error_setg(errp, "URI scheme must be 'ssh'");
198 if (!uri->server || strcmp(uri->server, "") == 0) {
199 error_setg(errp, "missing hostname in URI");
203 if (!uri->path || strcmp(uri->path, "") == 0) {
204 error_setg(errp, "missing remote path in URI");
208 qp = query_params_parse(uri->query);
210 error_setg(errp, "could not parse query parameters");
214 if(uri->user && strcmp(uri->user, "") != 0) {
215 qdict_put_str(options, "user", uri->user);
218 qdict_put_str(options, "server.host", uri->server);
220 port_str = g_strdup_printf("%d", uri->port ?: 22);
221 qdict_put_str(options, "server.port", port_str);
224 qdict_put_str(options, "path", uri->path);
226 /* Pick out any query parameters that we understand, and ignore
229 for (i = 0; i < qp->n; ++i) {
230 if (strcmp(qp->p[i].name, "host_key_check") == 0) {
231 qdict_put_str(options, "host_key_check", qp->p[i].value);
235 query_params_free(qp);
246 static bool ssh_has_filename_options_conflict(QDict *options, Error **errp)
248 const QDictEntry *qe;
250 for (qe = qdict_first(options); qe; qe = qdict_next(options, qe)) {
251 if (!strcmp(qe->key, "host") ||
252 !strcmp(qe->key, "port") ||
253 !strcmp(qe->key, "path") ||
254 !strcmp(qe->key, "user") ||
255 !strcmp(qe->key, "host_key_check") ||
256 strstart(qe->key, "server.", NULL))
258 error_setg(errp, "Option '%s' cannot be used with a file name",
267 static void ssh_parse_filename(const char *filename, QDict *options,
270 if (ssh_has_filename_options_conflict(options, errp)) {
274 parse_uri(filename, options, errp);
277 static int check_host_key_knownhosts(BDRVSSHState *s, Error **errp)
280 #ifdef HAVE_LIBSSH_0_8
281 enum ssh_known_hosts_e state;
284 enum ssh_keytypes_e pubkey_type;
285 unsigned char *server_hash = NULL;
286 size_t server_hash_len;
287 char *fingerprint = NULL;
289 state = ssh_session_is_known_server(s->session);
290 trace_ssh_server_status(state);
293 case SSH_KNOWN_HOSTS_OK:
295 trace_ssh_check_host_key_knownhosts();
297 case SSH_KNOWN_HOSTS_CHANGED:
299 r = ssh_get_server_publickey(s->session, &pubkey);
301 r = ssh_get_publickey_hash(pubkey, SSH_PUBLICKEY_HASH_SHA256,
302 &server_hash, &server_hash_len);
303 pubkey_type = ssh_key_type(pubkey);
304 ssh_key_free(pubkey);
307 fingerprint = ssh_get_fingerprint_hash(SSH_PUBLICKEY_HASH_SHA256,
310 ssh_clean_pubkey_hash(&server_hash);
314 "host key (%s key with fingerprint %s) does not match "
315 "the one in known_hosts; this may be a possible attack",
316 ssh_key_type_to_char(pubkey_type), fingerprint);
317 ssh_string_free_char(fingerprint);
320 "host key does not match the one in known_hosts; this "
321 "may be a possible attack");
324 case SSH_KNOWN_HOSTS_OTHER:
327 "host key for this server not found, another type exists");
329 case SSH_KNOWN_HOSTS_UNKNOWN:
331 error_setg(errp, "no host key was found in known_hosts");
333 case SSH_KNOWN_HOSTS_NOT_FOUND:
335 error_setg(errp, "known_hosts file not found");
337 case SSH_KNOWN_HOSTS_ERROR:
339 error_setg(errp, "error while checking the host");
343 error_setg(errp, "error while checking for known server (%d)", state);
346 #else /* !HAVE_LIBSSH_0_8 */
349 state = ssh_is_server_known(s->session);
350 trace_ssh_server_status(state);
353 case SSH_SERVER_KNOWN_OK:
355 trace_ssh_check_host_key_knownhosts();
357 case SSH_SERVER_KNOWN_CHANGED:
360 "host key does not match the one in known_hosts; this "
361 "may be a possible attack");
363 case SSH_SERVER_FOUND_OTHER:
366 "host key for this server not found, another type exists");
368 case SSH_SERVER_FILE_NOT_FOUND:
370 error_setg(errp, "known_hosts file not found");
372 case SSH_SERVER_NOT_KNOWN:
374 error_setg(errp, "no host key was found in known_hosts");
376 case SSH_SERVER_ERROR:
378 error_setg(errp, "server error");
382 error_setg(errp, "error while checking for known server (%d)", state);
385 #endif /* !HAVE_LIBSSH_0_8 */
387 /* known_hosts checking successful. */
394 static unsigned hex2decimal(char ch)
396 if (ch >= '0' && ch <= '9') {
398 } else if (ch >= 'a' && ch <= 'f') {
399 return 10 + (ch - 'a');
400 } else if (ch >= 'A' && ch <= 'F') {
401 return 10 + (ch - 'A');
407 /* Compare the binary fingerprint (hash of host key) with the
408 * host_key_check parameter.
410 static int compare_fingerprint(const unsigned char *fingerprint, size_t len,
411 const char *host_key_check)
416 while (*host_key_check == ':')
418 if (!qemu_isxdigit(host_key_check[0]) ||
419 !qemu_isxdigit(host_key_check[1]))
421 c = hex2decimal(host_key_check[0]) * 16 +
422 hex2decimal(host_key_check[1]);
423 if (c - *fingerprint != 0)
424 return c - *fingerprint;
429 return *host_key_check - '\0';
433 check_host_key_hash(BDRVSSHState *s, const char *hash,
434 enum ssh_publickey_hash_type type, Error **errp)
438 unsigned char *server_hash;
439 size_t server_hash_len;
441 #ifdef HAVE_LIBSSH_0_8
442 r = ssh_get_server_publickey(s->session, &pubkey);
444 r = ssh_get_publickey(s->session, &pubkey);
447 session_error_setg(errp, s, "failed to read remote host key");
451 r = ssh_get_publickey_hash(pubkey, type, &server_hash, &server_hash_len);
452 ssh_key_free(pubkey);
454 session_error_setg(errp, s,
455 "failed reading the hash of the server SSH key");
459 r = compare_fingerprint(server_hash, server_hash_len, hash);
460 ssh_clean_pubkey_hash(&server_hash);
462 error_setg(errp, "remote host key does not match host_key_check '%s'",
470 static int check_host_key(BDRVSSHState *s, SshHostKeyCheck *hkc, Error **errp)
472 SshHostKeyCheckMode mode;
477 mode = SSH_HOST_KEY_CHECK_MODE_KNOWN_HOSTS;
481 case SSH_HOST_KEY_CHECK_MODE_NONE:
483 case SSH_HOST_KEY_CHECK_MODE_HASH:
484 if (hkc->u.hash.type == SSH_HOST_KEY_CHECK_HASH_TYPE_MD5) {
485 return check_host_key_hash(s, hkc->u.hash.hash,
486 SSH_PUBLICKEY_HASH_MD5, errp);
487 } else if (hkc->u.hash.type == SSH_HOST_KEY_CHECK_HASH_TYPE_SHA1) {
488 return check_host_key_hash(s, hkc->u.hash.hash,
489 SSH_PUBLICKEY_HASH_SHA1, errp);
491 g_assert_not_reached();
493 case SSH_HOST_KEY_CHECK_MODE_KNOWN_HOSTS:
494 return check_host_key_knownhosts(s, errp);
496 g_assert_not_reached();
502 static int authenticate(BDRVSSHState *s, Error **errp)
507 /* Try to authenticate with the "none" method. */
508 r = ssh_userauth_none(s->session, NULL);
509 if (r == SSH_AUTH_ERROR) {
511 session_error_setg(errp, s, "failed to authenticate using none "
514 } else if (r == SSH_AUTH_SUCCESS) {
520 method = ssh_userauth_list(s->session, NULL);
521 trace_ssh_auth_methods(method);
524 * Try to authenticate with publickey, using the ssh-agent
527 if (method & SSH_AUTH_METHOD_PUBLICKEY) {
528 r = ssh_userauth_publickey_auto(s->session, NULL, NULL);
529 if (r == SSH_AUTH_ERROR) {
531 session_error_setg(errp, s, "failed to authenticate using "
532 "publickey authentication");
534 } else if (r == SSH_AUTH_SUCCESS) {
542 error_setg(errp, "failed to authenticate using publickey authentication "
543 "and the identities held by your ssh-agent");
549 static QemuOptsList ssh_runtime_opts = {
551 .head = QTAILQ_HEAD_INITIALIZER(ssh_runtime_opts.head),
555 .type = QEMU_OPT_STRING,
556 .help = "Host to connect to",
560 .type = QEMU_OPT_NUMBER,
561 .help = "Port to connect to",
564 .name = "host_key_check",
565 .type = QEMU_OPT_STRING,
566 .help = "Defines how and what to check the host key against",
568 { /* end of list */ }
572 static bool ssh_process_legacy_options(QDict *output_opts,
573 QemuOpts *legacy_opts,
576 const char *host = qemu_opt_get(legacy_opts, "host");
577 const char *port = qemu_opt_get(legacy_opts, "port");
578 const char *host_key_check = qemu_opt_get(legacy_opts, "host_key_check");
581 error_setg(errp, "port may not be used without host");
586 qdict_put_str(output_opts, "server.host", host);
587 qdict_put_str(output_opts, "server.port", port ?: stringify(22));
590 if (host_key_check) {
591 if (strcmp(host_key_check, "no") == 0) {
592 qdict_put_str(output_opts, "host-key-check.mode", "none");
593 } else if (strncmp(host_key_check, "md5:", 4) == 0) {
594 qdict_put_str(output_opts, "host-key-check.mode", "hash");
595 qdict_put_str(output_opts, "host-key-check.type", "md5");
596 qdict_put_str(output_opts, "host-key-check.hash",
598 } else if (strncmp(host_key_check, "sha1:", 5) == 0) {
599 qdict_put_str(output_opts, "host-key-check.mode", "hash");
600 qdict_put_str(output_opts, "host-key-check.type", "sha1");
601 qdict_put_str(output_opts, "host-key-check.hash",
603 } else if (strcmp(host_key_check, "yes") == 0) {
604 qdict_put_str(output_opts, "host-key-check.mode", "known_hosts");
606 error_setg(errp, "unknown host_key_check setting (%s)",
615 static BlockdevOptionsSsh *ssh_parse_options(QDict *options, Error **errp)
617 BlockdevOptionsSsh *result = NULL;
618 QemuOpts *opts = NULL;
619 Error *local_err = NULL;
623 /* Translate legacy options */
624 opts = qemu_opts_create(&ssh_runtime_opts, NULL, 0, &error_abort);
625 qemu_opts_absorb_qdict(opts, options, &local_err);
627 error_propagate(errp, local_err);
631 if (!ssh_process_legacy_options(options, opts, errp)) {
635 /* Create the QAPI object */
636 v = qobject_input_visitor_new_flat_confused(options, errp);
641 visit_type_BlockdevOptionsSsh(v, NULL, &result, &local_err);
645 error_propagate(errp, local_err);
649 /* Remove the processed options from the QDict (the visitor processes
650 * _all_ options in the QDict) */
651 while ((e = qdict_first(options))) {
652 qdict_del(options, e->key);
660 static int connect_to_ssh(BDRVSSHState *s, BlockdevOptionsSsh *opts,
661 int ssh_flags, int creat_mode, Error **errp)
664 unsigned int port = 0;
667 if (opts->has_user) {
668 s->user = g_strdup(opts->user);
670 s->user = g_strdup(g_get_user_name());
672 error_setg_errno(errp, errno, "Can't get user name");
678 /* Pop the config into our state object, Exit if invalid */
679 s->inet = opts->server;
682 if (qemu_strtoui(s->inet->port, NULL, 10, &port) < 0) {
683 error_setg(errp, "Use only numeric port value");
688 /* Open the socket and connect. */
689 new_sock = inet_connect_saddr(s->inet, errp);
696 * Try to disable the Nagle algorithm on TCP sockets to reduce latency,
697 * but do not fail if it cannot be disabled.
699 r = socket_set_nodelay(new_sock);
701 warn_report("can't set TCP_NODELAY for the ssh server %s: %s",
702 s->inet->host, strerror(errno));
705 /* Create SSH session. */
706 s->session = ssh_new();
709 session_error_setg(errp, s, "failed to initialize libssh session");
714 * Make sure we are in blocking mode during the connection and
715 * authentication phases.
717 ssh_set_blocking(s->session, 1);
719 r = ssh_options_set(s->session, SSH_OPTIONS_USER, s->user);
722 session_error_setg(errp, s,
723 "failed to set the user in the libssh session");
727 r = ssh_options_set(s->session, SSH_OPTIONS_HOST, s->inet->host);
730 session_error_setg(errp, s,
731 "failed to set the host in the libssh session");
736 r = ssh_options_set(s->session, SSH_OPTIONS_PORT, &port);
739 session_error_setg(errp, s,
740 "failed to set the port in the libssh session");
745 r = ssh_options_set(s->session, SSH_OPTIONS_COMPRESSION, "none");
748 session_error_setg(errp, s,
749 "failed to disable the compression in the libssh "
754 /* Read ~/.ssh/config. */
755 r = ssh_options_parse_config(s->session, NULL);
758 session_error_setg(errp, s, "failed to parse ~/.ssh/config");
762 r = ssh_options_set(s->session, SSH_OPTIONS_FD, &new_sock);
765 session_error_setg(errp, s,
766 "failed to set the socket in the libssh session");
769 /* libssh took ownership of the socket. */
774 r = ssh_connect(s->session);
777 session_error_setg(errp, s, "failed to establish SSH session");
781 /* Check the remote host's key against known_hosts. */
782 ret = check_host_key(s, opts->host_key_check, errp);
788 ret = authenticate(s, errp);
794 s->sftp = sftp_new(s->session);
796 session_error_setg(errp, s, "failed to create sftp handle");
801 r = sftp_init(s->sftp);
803 sftp_error_setg(errp, s, "failed to initialize sftp handle");
808 /* Open the remote file. */
809 trace_ssh_connect_to_ssh(opts->path, ssh_flags, creat_mode);
810 s->sftp_handle = sftp_open(s->sftp, opts->path, ssh_flags, creat_mode);
811 if (!s->sftp_handle) {
812 sftp_error_setg(errp, s, "failed to open remote file '%s'",
818 /* Make sure the SFTP file is handled in blocking mode. */
819 sftp_file_set_blocking(s->sftp_handle);
821 s->attrs = sftp_fstat(s->sftp_handle);
823 sftp_error_setg(errp, s, "failed to read file attributes");
831 sftp_attributes_free(s->attrs);
834 if (s->sftp_handle) {
835 sftp_close(s->sftp_handle);
837 s->sftp_handle = NULL;
843 ssh_disconnect(s->session);
844 ssh_free(s->session);
855 static int ssh_file_open(BlockDriverState *bs, QDict *options, int bdrv_flags,
858 BDRVSSHState *s = bs->opaque;
859 BlockdevOptionsSsh *opts;
866 if (bdrv_flags & BDRV_O_RDWR) {
869 ssh_flags |= O_RDONLY;
872 opts = ssh_parse_options(options, errp);
878 ret = connect_to_ssh(s, opts, ssh_flags, 0, errp);
883 /* Go non-blocking. */
884 ssh_set_blocking(s->session, 0);
886 qapi_free_BlockdevOptionsSsh(opts);
891 qapi_free_BlockdevOptionsSsh(opts);
896 /* Note: This is a blocking operation */
897 static int ssh_grow_file(BDRVSSHState *s, int64_t offset, Error **errp)
900 char c[1] = { '\0' };
901 int was_blocking = ssh_is_blocking(s->session);
903 /* offset must be strictly greater than the current size so we do
904 * not overwrite anything */
905 assert(offset > 0 && offset > s->attrs->size);
907 ssh_set_blocking(s->session, 1);
909 sftp_seek64(s->sftp_handle, offset - 1);
910 ret = sftp_write(s->sftp_handle, c, 1);
912 ssh_set_blocking(s->session, was_blocking);
915 sftp_error_setg(errp, s, "Failed to grow file");
919 s->attrs->size = offset;
923 static QemuOptsList ssh_create_opts = {
924 .name = "ssh-create-opts",
925 .head = QTAILQ_HEAD_INITIALIZER(ssh_create_opts.head),
928 .name = BLOCK_OPT_SIZE,
929 .type = QEMU_OPT_SIZE,
930 .help = "Virtual disk size"
932 { /* end of list */ }
936 static int ssh_co_create(BlockdevCreateOptions *options, Error **errp)
938 BlockdevCreateOptionsSsh *opts = &options->u.ssh;
942 assert(options->driver == BLOCKDEV_DRIVER_SSH);
946 ret = connect_to_ssh(&s, opts->location,
947 O_RDWR | O_CREAT | O_TRUNC,
953 if (opts->size > 0) {
954 ret = ssh_grow_file(&s, opts->size, errp);
966 static int coroutine_fn ssh_co_create_opts(const char *filename, QemuOpts *opts,
969 BlockdevCreateOptions *create_options;
970 BlockdevCreateOptionsSsh *ssh_opts;
972 QDict *uri_options = NULL;
974 create_options = g_new0(BlockdevCreateOptions, 1);
975 create_options->driver = BLOCKDEV_DRIVER_SSH;
976 ssh_opts = &create_options->u.ssh;
978 /* Get desired file size. */
979 ssh_opts->size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
981 trace_ssh_co_create_opts(ssh_opts->size);
983 uri_options = qdict_new();
984 ret = parse_uri(filename, uri_options, errp);
989 ssh_opts->location = ssh_parse_options(uri_options, errp);
990 if (ssh_opts->location == NULL) {
995 ret = ssh_co_create(create_options, errp);
998 qobject_unref(uri_options);
999 qapi_free_BlockdevCreateOptions(create_options);
1003 static void ssh_close(BlockDriverState *bs)
1005 BDRVSSHState *s = bs->opaque;
1010 static int ssh_has_zero_init(BlockDriverState *bs)
1012 BDRVSSHState *s = bs->opaque;
1013 /* Assume false, unless we can positively prove it's true. */
1014 int has_zero_init = 0;
1016 if (s->attrs->type == SSH_FILEXFER_TYPE_REGULAR) {
1020 return has_zero_init;
1023 typedef struct BDRVSSHRestart {
1024 BlockDriverState *bs;
1028 static void restart_coroutine(void *opaque)
1030 BDRVSSHRestart *restart = opaque;
1031 BlockDriverState *bs = restart->bs;
1032 BDRVSSHState *s = bs->opaque;
1033 AioContext *ctx = bdrv_get_aio_context(bs);
1035 trace_ssh_restart_coroutine(restart->co);
1036 aio_set_fd_handler(ctx, s->sock, false, NULL, NULL, NULL, NULL);
1038 aio_co_wake(restart->co);
1041 /* A non-blocking call returned EAGAIN, so yield, ensuring the
1042 * handlers are set up so that we'll be rescheduled when there is an
1043 * interesting event on the socket.
1045 static coroutine_fn void co_yield(BDRVSSHState *s, BlockDriverState *bs)
1048 IOHandler *rd_handler = NULL, *wr_handler = NULL;
1049 BDRVSSHRestart restart = {
1051 .co = qemu_coroutine_self()
1054 r = ssh_get_poll_flags(s->session);
1056 if (r & SSH_READ_PENDING) {
1057 rd_handler = restart_coroutine;
1059 if (r & SSH_WRITE_PENDING) {
1060 wr_handler = restart_coroutine;
1063 trace_ssh_co_yield(s->sock, rd_handler, wr_handler);
1065 aio_set_fd_handler(bdrv_get_aio_context(bs), s->sock,
1066 false, rd_handler, wr_handler, NULL, &restart);
1067 qemu_coroutine_yield();
1068 trace_ssh_co_yield_back(s->sock);
1071 static coroutine_fn int ssh_read(BDRVSSHState *s, BlockDriverState *bs,
1072 int64_t offset, size_t size,
1077 char *buf, *end_of_vec;
1080 trace_ssh_read(offset, size);
1082 trace_ssh_seek(offset);
1083 sftp_seek64(s->sftp_handle, offset);
1085 /* This keeps track of the current iovec element ('i'), where we
1086 * will write to next ('buf'), and the end of the current iovec
1091 end_of_vec = i->iov_base + i->iov_len;
1093 for (got = 0; got < size; ) {
1094 size_t request_read_size;
1097 * The size of SFTP packets is limited to 32K bytes, so limit
1098 * the amount of data requested to 16K, as libssh currently
1099 * does not handle multiple requests on its own.
1101 request_read_size = MIN(end_of_vec - buf, 16384);
1102 trace_ssh_read_buf(buf, end_of_vec - buf, request_read_size);
1103 r = sftp_read(s->sftp_handle, buf, request_read_size);
1104 trace_ssh_read_return(r, sftp_get_error(s->sftp));
1106 if (r == SSH_AGAIN) {
1110 if (r == SSH_EOF || (r == 0 && sftp_get_error(s->sftp) == SSH_FX_EOF)) {
1111 /* EOF: Short read so pad the buffer with zeroes and return it. */
1112 qemu_iovec_memset(qiov, got, 0, size - got);
1116 sftp_error_trace(s, "read");
1122 if (buf >= end_of_vec && got < size) {
1125 end_of_vec = i->iov_base + i->iov_len;
1132 static coroutine_fn int ssh_co_readv(BlockDriverState *bs,
1134 int nb_sectors, QEMUIOVector *qiov)
1136 BDRVSSHState *s = bs->opaque;
1139 qemu_co_mutex_lock(&s->lock);
1140 ret = ssh_read(s, bs, sector_num * BDRV_SECTOR_SIZE,
1141 nb_sectors * BDRV_SECTOR_SIZE, qiov);
1142 qemu_co_mutex_unlock(&s->lock);
1147 static int ssh_write(BDRVSSHState *s, BlockDriverState *bs,
1148 int64_t offset, size_t size,
1153 char *buf, *end_of_vec;
1156 trace_ssh_write(offset, size);
1158 trace_ssh_seek(offset);
1159 sftp_seek64(s->sftp_handle, offset);
1161 /* This keeps track of the current iovec element ('i'), where we
1162 * will read from next ('buf'), and the end of the current iovec
1167 end_of_vec = i->iov_base + i->iov_len;
1169 for (written = 0; written < size; ) {
1170 size_t request_write_size;
1173 * Avoid too large data packets, as libssh currently does not
1174 * handle multiple requests on its own.
1176 request_write_size = MIN(end_of_vec - buf, 131072);
1177 trace_ssh_write_buf(buf, end_of_vec - buf, request_write_size);
1178 r = sftp_write(s->sftp_handle, buf, request_write_size);
1179 trace_ssh_write_return(r, sftp_get_error(s->sftp));
1181 if (r == SSH_AGAIN) {
1186 sftp_error_trace(s, "write");
1192 if (buf >= end_of_vec && written < size) {
1195 end_of_vec = i->iov_base + i->iov_len;
1198 if (offset + written > s->attrs->size) {
1199 s->attrs->size = offset + written;
1206 static coroutine_fn int ssh_co_writev(BlockDriverState *bs,
1208 int nb_sectors, QEMUIOVector *qiov,
1211 BDRVSSHState *s = bs->opaque;
1215 qemu_co_mutex_lock(&s->lock);
1216 ret = ssh_write(s, bs, sector_num * BDRV_SECTOR_SIZE,
1217 nb_sectors * BDRV_SECTOR_SIZE, qiov);
1218 qemu_co_mutex_unlock(&s->lock);
1223 static void unsafe_flush_warning(BDRVSSHState *s, const char *what)
1225 if (!s->unsafe_flush_warning) {
1226 warn_report("ssh server %s does not support fsync",
1229 error_report("to support fsync, you need %s", what);
1231 s->unsafe_flush_warning = true;
1235 #ifdef HAVE_LIBSSH_0_8
1237 static coroutine_fn int ssh_flush(BDRVSSHState *s, BlockDriverState *bs)
1244 unsafe_flush_warning(s, "OpenSSH >= 6.3");
1248 r = sftp_fsync(s->sftp_handle);
1249 if (r == SSH_AGAIN) {
1254 sftp_error_trace(s, "fsync");
1261 static coroutine_fn int ssh_co_flush(BlockDriverState *bs)
1263 BDRVSSHState *s = bs->opaque;
1266 qemu_co_mutex_lock(&s->lock);
1267 ret = ssh_flush(s, bs);
1268 qemu_co_mutex_unlock(&s->lock);
1273 #else /* !HAVE_LIBSSH_0_8 */
1275 static coroutine_fn int ssh_co_flush(BlockDriverState *bs)
1277 BDRVSSHState *s = bs->opaque;
1279 unsafe_flush_warning(s, "libssh >= 0.8.0");
1283 #endif /* !HAVE_LIBSSH_0_8 */
1285 static int64_t ssh_getlength(BlockDriverState *bs)
1287 BDRVSSHState *s = bs->opaque;
1290 /* Note we cannot make a libssh call here. */
1291 length = (int64_t) s->attrs->size;
1292 trace_ssh_getlength(length);
1297 static int coroutine_fn ssh_co_truncate(BlockDriverState *bs, int64_t offset,
1298 bool exact, PreallocMode prealloc,
1301 BDRVSSHState *s = bs->opaque;
1303 if (prealloc != PREALLOC_MODE_OFF) {
1304 error_setg(errp, "Unsupported preallocation mode '%s'",
1305 PreallocMode_str(prealloc));
1309 if (offset < s->attrs->size) {
1310 error_setg(errp, "ssh driver does not support shrinking files");
1314 if (offset == s->attrs->size) {
1318 return ssh_grow_file(s, offset, errp);
1321 static void ssh_refresh_filename(BlockDriverState *bs)
1323 BDRVSSHState *s = bs->opaque;
1324 const char *path, *host_key_check;
1328 * None of these options can be represented in a plain "host:port"
1329 * format, so if any was given, we have to abort.
1331 if (s->inet->has_ipv4 || s->inet->has_ipv6 || s->inet->has_to ||
1332 s->inet->has_numeric)
1337 path = qdict_get_try_str(bs->full_open_options, "path");
1338 assert(path); /* mandatory option */
1340 host_key_check = qdict_get_try_str(bs->full_open_options, "host_key_check");
1342 ret = snprintf(bs->exact_filename, sizeof(bs->exact_filename),
1343 "ssh://%s@%s:%s%s%s%s",
1344 s->user, s->inet->host, s->inet->port, path,
1345 host_key_check ? "?host_key_check=" : "",
1346 host_key_check ?: "");
1347 if (ret >= sizeof(bs->exact_filename)) {
1348 /* An overflow makes the filename unusable, so do not report any */
1349 bs->exact_filename[0] = '\0';
1353 static char *ssh_bdrv_dirname(BlockDriverState *bs, Error **errp)
1355 if (qdict_haskey(bs->full_open_options, "host_key_check")) {
1357 * We cannot generate a simple prefix if we would have to
1358 * append a query string.
1361 "Cannot generate a base directory with host_key_check set");
1365 if (bs->exact_filename[0] == '\0') {
1366 error_setg(errp, "Cannot generate a base directory for this ssh node");
1370 return path_combine(bs->exact_filename, "");
1373 static const char *const ssh_strong_runtime_opts[] = {
1384 static BlockDriver bdrv_ssh = {
1385 .format_name = "ssh",
1386 .protocol_name = "ssh",
1387 .instance_size = sizeof(BDRVSSHState),
1388 .bdrv_parse_filename = ssh_parse_filename,
1389 .bdrv_file_open = ssh_file_open,
1390 .bdrv_co_create = ssh_co_create,
1391 .bdrv_co_create_opts = ssh_co_create_opts,
1392 .bdrv_close = ssh_close,
1393 .bdrv_has_zero_init = ssh_has_zero_init,
1394 .bdrv_has_zero_init_truncate = ssh_has_zero_init,
1395 .bdrv_co_readv = ssh_co_readv,
1396 .bdrv_co_writev = ssh_co_writev,
1397 .bdrv_getlength = ssh_getlength,
1398 .bdrv_co_truncate = ssh_co_truncate,
1399 .bdrv_co_flush_to_disk = ssh_co_flush,
1400 .bdrv_refresh_filename = ssh_refresh_filename,
1401 .bdrv_dirname = ssh_bdrv_dirname,
1402 .create_opts = &ssh_create_opts,
1403 .strong_runtime_opts = ssh_strong_runtime_opts,
1406 static void bdrv_ssh_init(void)
1412 fprintf(stderr, "libssh initialization failed, %d\n", r);
1416 #if TRACE_LIBSSH != 0
1417 ssh_set_log_level(TRACE_LIBSSH);
1420 bdrv_register(&bdrv_ssh);
1423 block_init(bdrv_ssh_init);