block/ssh.c

   1 /*
   2  * Secure Shell (ssh) backend for QEMU.
   3  *
   4  * Copyright (C) 2013 Red Hat Inc., Richard W.M. Jones <[email protected]>
   5  *
   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:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  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
  22  * THE SOFTWARE.
  23  */
  24
  25 #include <stdio.h>
  26 #include <stdlib.h>
  27 #include <stdarg.h>
  28
  29 #include <libssh2.h>
  30 #include <libssh2_sftp.h>
  31
  32 #include "block/block_int.h"
  33 #include "qemu/error-report.h"
  34 #include "qemu/sockets.h"
  35 #include "qemu/uri.h"
  36 #include "qapi/qmp/qint.h"
  37 #include "qapi/qmp/qstring.h"
  38
  39 /* DEBUG_SSH=1 enables the DPRINTF (debugging printf) statements in
  40  * this block driver code.
  41  *
  42  * TRACE_LIBSSH2=<bitmask> enables tracing in libssh2 itself.  Note
  43  * that this requires that libssh2 was specially compiled with the
  44  * `./configure --enable-debug' option, so most likely you will have
  45  * to compile it yourself.  The meaning of <bitmask> is described
  46  * here: http://www.libssh2.org/libssh2_trace.html
  47  */
  48 #define DEBUG_SSH     0
  49 #define TRACE_LIBSSH2 0 /* or try: LIBSSH2_TRACE_SFTP */
  50
  51 #define DPRINTF(fmt, ...)                           \
  52     do {                                            \
  53         if (DEBUG_SSH) {                            \
  54             fprintf(stderr, "ssh: %-15s " fmt "\n", \
  55                     __func__, ##__VA_ARGS__);       \
  56         }                                           \
  57     } while (0)
  58
  59 typedef struct BDRVSSHState {
  60     /* Coroutine. */
  61     CoMutex lock;
  62
  63     /* SSH connection. */
  64     int sock;                         /* socket */
  65     LIBSSH2_SESSION *session;         /* ssh session */
  66     LIBSSH2_SFTP *sftp;               /* sftp session */
  67     LIBSSH2_SFTP_HANDLE *sftp_handle; /* sftp remote file handle */
  68
  69     /* See ssh_seek() function below. */
  70     int64_t offset;
  71     bool offset_op_read;
  72
  73     /* File attributes at open.  We try to keep the .filesize field
  74      * updated if it changes (eg by writing at the end of the file).
  75      */
  76     LIBSSH2_SFTP_ATTRIBUTES attrs;
  77
  78     /* Used to warn if 'flush' is not supported. */
  79     char *hostport;
  80     bool unsafe_flush_warning;
  81 } BDRVSSHState;
  82
  83 static void ssh_state_init(BDRVSSHState *s)
  84 {
  85     memset(s, 0, sizeof *s);
  86     s->sock = -1;
  87     s->offset = -1;
  88     qemu_co_mutex_init(&s->lock);
  89 }
  90
  91 static void ssh_state_free(BDRVSSHState *s)
  92 {
  93     g_free(s->hostport);
  94     if (s->sftp_handle) {
  95         libssh2_sftp_close(s->sftp_handle);
  96     }
  97     if (s->sftp) {
  98         libssh2_sftp_shutdown(s->sftp);
  99     }
 100     if (s->session) {
 101         libssh2_session_disconnect(s->session,
 102                                    "from qemu ssh client: "
 103                                    "user closed the connection");
 104         libssh2_session_free(s->session);
 105     }
 106     if (s->sock >= 0) {
 107         close(s->sock);
 108     }
 109 }
 110
 111 static void GCC_FMT_ATTR(3, 4)
 112 session_error_setg(Error **errp, BDRVSSHState *s, const char *fs, ...)
 113 {
 114     va_list args;
 115     char *msg;
 116
 117     va_start(args, fs);
 118     msg = g_strdup_vprintf(fs, args);
 119     va_end(args);
 120
 121     if (s->session) {
 122         char *ssh_err;
 123         int ssh_err_code;
 124
 125         /* This is not an errno.  See <libssh2.h>. */
 126         ssh_err_code = libssh2_session_last_error(s->session,
 127                                                   &ssh_err, NULL, 0);
 128         error_setg(errp, "%s: %s (libssh2 error code: %d)",
 129                    msg, ssh_err, ssh_err_code);
 130     } else {
 131         error_setg(errp, "%s", msg);
 132     }
 133     g_free(msg);
 134 }
 135
 136 static void GCC_FMT_ATTR(3, 4)
 137 sftp_error_setg(Error **errp, BDRVSSHState *s, const char *fs, ...)
 138 {
 139     va_list args;
 140     char *msg;
 141
 142     va_start(args, fs);
 143     msg = g_strdup_vprintf(fs, args);
 144     va_end(args);
 145
 146     if (s->sftp) {
 147         char *ssh_err;
 148         int ssh_err_code;
 149         unsigned long sftp_err_code;
 150
 151         /* This is not an errno.  See <libssh2.h>. */
 152         ssh_err_code = libssh2_session_last_error(s->session,
 153                                                   &ssh_err, NULL, 0);
 154         /* See <libssh2_sftp.h>. */
 155         sftp_err_code = libssh2_sftp_last_error((s)->sftp);
 156
 157         error_setg(errp,
 158                    "%s: %s (libssh2 error code: %d, sftp error code: %lu)",
 159                    msg, ssh_err, ssh_err_code, sftp_err_code);
 160     } else {
 161         error_setg(errp, "%s", msg);
 162     }
 163     g_free(msg);
 164 }
 165
 166 static void GCC_FMT_ATTR(2, 3)
 167 sftp_error_report(BDRVSSHState *s, const char *fs, ...)
 168 {
 169     va_list args;
 170
 171     va_start(args, fs);
 172     error_vprintf(fs, args);
 173
 174     if ((s)->sftp) {
 175         char *ssh_err;
 176         int ssh_err_code;
 177         unsigned long sftp_err_code;
 178
 179         /* This is not an errno.  See <libssh2.h>. */
 180         ssh_err_code = libssh2_session_last_error(s->session,
 181                                                   &ssh_err, NULL, 0);
 182         /* See <libssh2_sftp.h>. */
 183         sftp_err_code = libssh2_sftp_last_error((s)->sftp);
 184
 185         error_printf(": %s (libssh2 error code: %d, sftp error code: %lu)",
 186                      ssh_err, ssh_err_code, sftp_err_code);
 187     }
 188
 189     va_end(args);
 190     error_printf("\n");
 191 }
 192
 193 static int parse_uri(const char *filename, QDict *options, Error **errp)
 194 {
 195     URI *uri = NULL;
 196     QueryParams *qp;
 197     int i;
 198
 199     uri = uri_parse(filename);
 200     if (!uri) {
 201         return -EINVAL;
 202     }
 203
 204     if (strcmp(uri->scheme, "ssh") != 0) {
 205         error_setg(errp, "URI scheme must be 'ssh'");
 206         goto err;
 207     }
 208
 209     if (!uri->server || strcmp(uri->server, "") == 0) {
 210         error_setg(errp, "missing hostname in URI");
 211         goto err;
 212     }
 213
 214     if (!uri->path || strcmp(uri->path, "") == 0) {
 215         error_setg(errp, "missing remote path in URI");
 216         goto err;
 217     }
 218
 219     qp = query_params_parse(uri->query);
 220     if (!qp) {
 221         error_setg(errp, "could not parse query parameters");
 222         goto err;
 223     }
 224
 225     if(uri->user && strcmp(uri->user, "") != 0) {
 226         qdict_put(options, "user", qstring_from_str(uri->user));
 227     }
 228
 229     qdict_put(options, "host", qstring_from_str(uri->server));
 230
 231     if (uri->port) {
 232         qdict_put(options, "port", qint_from_int(uri->port));
 233     }
 234
 235     qdict_put(options, "path", qstring_from_str(uri->path));
 236
 237     /* Pick out any query parameters that we understand, and ignore
 238      * the rest.
 239      */
 240     for (i = 0; i < qp->n; ++i) {
 241         if (strcmp(qp->p[i].name, "host_key_check") == 0) {
 242             qdict_put(options, "host_key_check",
 243                       qstring_from_str(qp->p[i].value));
 244         }
 245     }
 246
 247     query_params_free(qp);
 248     uri_free(uri);
 249     return 0;
 250
 251  err:
 252     if (uri) {
 253       uri_free(uri);
 254     }
 255     return -EINVAL;
 256 }
 257
 258 static void ssh_parse_filename(const char *filename, QDict *options,
 259                                Error **errp)
 260 {
 261     if (qdict_haskey(options, "user") ||
 262         qdict_haskey(options, "host") ||
 263         qdict_haskey(options, "port") ||
 264         qdict_haskey(options, "path") ||
 265         qdict_haskey(options, "host_key_check")) {
 266         error_setg(errp, "user, host, port, path, host_key_check cannot be used at the same time as a file option");
 267         return;
 268     }
 269
 270     parse_uri(filename, options, errp);
 271 }
 272
 273 static int check_host_key_knownhosts(BDRVSSHState *s,
 274                                      const char *host, int port, Error **errp)
 275 {
 276     const char *home;
 277     char *knh_file = NULL;
 278     LIBSSH2_KNOWNHOSTS *knh = NULL;
 279     struct libssh2_knownhost *found;
 280     int ret, r;
 281     const char *hostkey;
 282     size_t len;
 283     int type;
 284
 285     hostkey = libssh2_session_hostkey(s->session, &len, &type);
 286     if (!hostkey) {
 287         ret = -EINVAL;
 288         session_error_setg(errp, s, "failed to read remote host key");
 289         goto out;
 290     }
 291
 292     knh = libssh2_knownhost_init(s->session);
 293     if (!knh) {
 294         ret = -EINVAL;
 295         session_error_setg(errp, s,
 296                            "failed to initialize known hosts support");
 297         goto out;
 298     }
 299
 300     home = getenv("HOME");
 301     if (home) {
 302         knh_file = g_strdup_printf("%s/.ssh/known_hosts", home);
 303     } else {
 304         knh_file = g_strdup_printf("/root/.ssh/known_hosts");
 305     }
 306
 307     /* Read all known hosts from OpenSSH-style known_hosts file. */
 308     libssh2_knownhost_readfile(knh, knh_file, LIBSSH2_KNOWNHOST_FILE_OPENSSH);
 309
 310     r = libssh2_knownhost_checkp(knh, host, port, hostkey, len,
 311                                  LIBSSH2_KNOWNHOST_TYPE_PLAIN|
 312                                  LIBSSH2_KNOWNHOST_KEYENC_RAW,
 313                                  &found);
 314     switch (r) {
 315     case LIBSSH2_KNOWNHOST_CHECK_MATCH:
 316         /* OK */
 317         DPRINTF("host key OK: %s", found->key);
 318         break;
 319     case LIBSSH2_KNOWNHOST_CHECK_MISMATCH:
 320         ret = -EINVAL;
 321         session_error_setg(errp, s,
 322                       "host key does not match the one in known_hosts"
 323                       " (found key %s)", found->key);
 324         goto out;
 325     case LIBSSH2_KNOWNHOST_CHECK_NOTFOUND:
 326         ret = -EINVAL;
 327         session_error_setg(errp, s, "no host key was found in known_hosts");
 328         goto out;
 329     case LIBSSH2_KNOWNHOST_CHECK_FAILURE:
 330         ret = -EINVAL;
 331         session_error_setg(errp, s,
 332                       "failure matching the host key with known_hosts");
 333         goto out;
 334     default:
 335         ret = -EINVAL;
 336         session_error_setg(errp, s, "unknown error matching the host key"
 337                       " with known_hosts (%d)", r);
 338         goto out;
 339     }
 340
 341     /* known_hosts checking successful. */
 342     ret = 0;
 343
 344  out:
 345     if (knh != NULL) {
 346         libssh2_knownhost_free(knh);
 347     }
 348     g_free(knh_file);
 349     return ret;
 350 }
 351
 352 static unsigned hex2decimal(char ch)
 353 {
 354     if (ch >= '0' && ch <= '9') {
 355         return (ch - '0');
 356     } else if (ch >= 'a' && ch <= 'f') {
 357         return 10 + (ch - 'a');
 358     } else if (ch >= 'A' && ch <= 'F') {
 359         return 10 + (ch - 'A');
 360     }
 361
 362     return -1;
 363 }
 364
 365 /* Compare the binary fingerprint (hash of host key) with the
 366  * host_key_check parameter.
 367  */
 368 static int compare_fingerprint(const unsigned char *fingerprint, size_t len,
 369                                const char *host_key_check)
 370 {
 371     unsigned c;
 372
 373     while (len > 0) {
 374         while (*host_key_check == ':')
 375             host_key_check++;
 376         if (!qemu_isxdigit(host_key_check[0]) ||
 377             !qemu_isxdigit(host_key_check[1]))
 378             return 1;
 379         c = hex2decimal(host_key_check[0]) * 16 +
 380             hex2decimal(host_key_check[1]);
 381         if (c - *fingerprint != 0)
 382             return c - *fingerprint;
 383         fingerprint++;
 384         len--;
 385         host_key_check += 2;
 386     }
 387     return *host_key_check - '\0';
 388 }
 389
 390 static int
 391 check_host_key_hash(BDRVSSHState *s, const char *hash,
 392                     int hash_type, size_t fingerprint_len, Error **errp)
 393 {
 394     const char *fingerprint;
 395
 396     fingerprint = libssh2_hostkey_hash(s->session, hash_type);
 397     if (!fingerprint) {
 398         session_error_setg(errp, s, "failed to read remote host key");
 399         return -EINVAL;
 400     }
 401
 402     if(compare_fingerprint((unsigned char *) fingerprint, fingerprint_len,
 403                            hash) != 0) {
 404         error_setg(errp, "remote host key does not match host_key_check '%s'",
 405                    hash);
 406         return -EPERM;
 407     }
 408
 409     return 0;
 410 }
 411
 412 static int check_host_key(BDRVSSHState *s, const char *host, int port,
 413                           const char *host_key_check, Error **errp)
 414 {
 415     /* host_key_check=no */
 416     if (strcmp(host_key_check, "no") == 0) {
 417         return 0;
 418     }
 419
 420     /* host_key_check=md5:xx:yy:zz:... */
 421     if (strncmp(host_key_check, "md5:", 4) == 0) {
 422         return check_host_key_hash(s, &host_key_check[4],
 423                                    LIBSSH2_HOSTKEY_HASH_MD5, 16, errp);
 424     }
 425
 426     /* host_key_check=sha1:xx:yy:zz:... */
 427     if (strncmp(host_key_check, "sha1:", 5) == 0) {
 428         return check_host_key_hash(s, &host_key_check[5],
 429                                    LIBSSH2_HOSTKEY_HASH_SHA1, 20, errp);
 430     }
 431
 432     /* host_key_check=yes */
 433     if (strcmp(host_key_check, "yes") == 0) {
 434         return check_host_key_knownhosts(s, host, port, errp);
 435     }
 436
 437     error_setg(errp, "unknown host_key_check setting (%s)", host_key_check);
 438     return -EINVAL;
 439 }
 440
 441 static int authenticate(BDRVSSHState *s, const char *user, Error **errp)
 442 {
 443     int r, ret;
 444     const char *userauthlist;
 445     LIBSSH2_AGENT *agent = NULL;
 446     struct libssh2_agent_publickey *identity;
 447     struct libssh2_agent_publickey *prev_identity = NULL;
 448
 449     userauthlist = libssh2_userauth_list(s->session, user, strlen(user));
 450     if (strstr(userauthlist, "publickey") == NULL) {
 451         ret = -EPERM;
 452         error_setg(errp,
 453                 "remote server does not support \"publickey\" authentication");
 454         goto out;
 455     }
 456
 457     /* Connect to ssh-agent and try each identity in turn. */
 458     agent = libssh2_agent_init(s->session);
 459     if (!agent) {
 460         ret = -EINVAL;
 461         session_error_setg(errp, s, "failed to initialize ssh-agent support");
 462         goto out;
 463     }
 464     if (libssh2_agent_connect(agent)) {
 465         ret = -ECONNREFUSED;
 466         session_error_setg(errp, s, "failed to connect to ssh-agent");
 467         goto out;
 468     }
 469     if (libssh2_agent_list_identities(agent)) {
 470         ret = -EINVAL;
 471         session_error_setg(errp, s,
 472                            "failed requesting identities from ssh-agent");
 473         goto out;
 474     }
 475
 476     for(;;) {
 477         r = libssh2_agent_get_identity(agent, &identity, prev_identity);
 478         if (r == 1) {           /* end of list */
 479             break;
 480         }
 481         if (r < 0) {
 482             ret = -EINVAL;
 483             session_error_setg(errp, s,
 484                                "failed to obtain identity from ssh-agent");
 485             goto out;
 486         }
 487         r = libssh2_agent_userauth(agent, user, identity);
 488         if (r == 0) {
 489             /* Authenticated! */
 490             ret = 0;
 491             goto out;
 492         }
 493         /* Failed to authenticate with this identity, try the next one. */
 494         prev_identity = identity;
 495     }
 496
 497     ret = -EPERM;
 498     error_setg(errp, "failed to authenticate using publickey authentication "
 499                "and the identities held by your ssh-agent");
 500
 501  out:
 502     if (agent != NULL) {
 503         /* Note: libssh2 implementation implicitly calls
 504          * libssh2_agent_disconnect if necessary.
 505          */
 506         libssh2_agent_free(agent);
 507     }
 508
 509     return ret;
 510 }
 511
 512 static int connect_to_ssh(BDRVSSHState *s, QDict *options,
 513                           int ssh_flags, int creat_mode, Error **errp)
 514 {
 515     int r, ret;
 516     const char *host, *user, *path, *host_key_check;
 517     int port;
 518
 519     if (!qdict_haskey(options, "host")) {
 520         ret = -EINVAL;
 521         error_setg(errp, "No hostname was specified");
 522         goto err;
 523     }
 524     host = qdict_get_str(options, "host");
 525
 526     if (qdict_haskey(options, "port")) {
 527         port = qdict_get_int(options, "port");
 528     } else {
 529         port = 22;
 530     }
 531
 532     if (!qdict_haskey(options, "path")) {
 533         ret = -EINVAL;
 534         error_setg(errp, "No path was specified");
 535         goto err;
 536     }
 537     path = qdict_get_str(options, "path");
 538
 539     if (qdict_haskey(options, "user")) {
 540         user = qdict_get_str(options, "user");
 541     } else {
 542         user = g_get_user_name();
 543         if (!user) {
 544             error_setg_errno(errp, errno, "Can't get user name");
 545             ret = -errno;
 546             goto err;
 547         }
 548     }
 549
 550     if (qdict_haskey(options, "host_key_check")) {
 551         host_key_check = qdict_get_str(options, "host_key_check");
 552     } else {
 553         host_key_check = "yes";
 554     }
 555
 556     /* Construct the host:port name for inet_connect. */
 557     g_free(s->hostport);
 558     s->hostport = g_strdup_printf("%s:%d", host, port);
 559
 560     /* Open the socket and connect. */
 561     s->sock = inet_connect(s->hostport, errp);
 562     if (s->sock < 0) {
 563         ret = -EIO;
 564         goto err;
 565     }
 566
 567     /* Create SSH session. */
 568     s->session = libssh2_session_init();
 569     if (!s->session) {
 570         ret = -EINVAL;
 571         session_error_setg(errp, s, "failed to initialize libssh2 session");
 572         goto err;
 573     }
 574
 575 #if TRACE_LIBSSH2 != 0
 576     libssh2_trace(s->session, TRACE_LIBSSH2);
 577 #endif
 578
 579     r = libssh2_session_handshake(s->session, s->sock);
 580     if (r != 0) {
 581         ret = -EINVAL;
 582         session_error_setg(errp, s, "failed to establish SSH session");
 583         goto err;
 584     }
 585
 586     /* Check the remote host's key against known_hosts. */
 587     ret = check_host_key(s, host, port, host_key_check, errp);
 588     if (ret < 0) {
 589         goto err;
 590     }
 591
 592     /* Authenticate. */
 593     ret = authenticate(s, user, errp);
 594     if (ret < 0) {
 595         goto err;
 596     }
 597
 598     /* Start SFTP. */
 599     s->sftp = libssh2_sftp_init(s->session);
 600     if (!s->sftp) {
 601         session_error_setg(errp, s, "failed to initialize sftp handle");
 602         ret = -EINVAL;
 603         goto err;
 604     }
 605
 606     /* Open the remote file. */
 607     DPRINTF("opening file %s flags=0x%x creat_mode=0%o",
 608             path, ssh_flags, creat_mode);
 609     s->sftp_handle = libssh2_sftp_open(s->sftp, path, ssh_flags, creat_mode);
 610     if (!s->sftp_handle) {
 611         session_error_setg(errp, s, "failed to open remote file '%s'", path);
 612         ret = -EINVAL;
 613         goto err;
 614     }
 615
 616     r = libssh2_sftp_fstat(s->sftp_handle, &s->attrs);
 617     if (r < 0) {
 618         sftp_error_setg(errp, s, "failed to read file attributes");
 619         return -EINVAL;
 620     }
 621
 622     /* Delete the options we've used; any not deleted will cause the
 623      * block layer to give an error about unused options.
 624      */
 625     qdict_del(options, "host");
 626     qdict_del(options, "port");
 627     qdict_del(options, "user");
 628     qdict_del(options, "path");
 629     qdict_del(options, "host_key_check");
 630
 631     return 0;
 632
 633  err:
 634     if (s->sftp_handle) {
 635         libssh2_sftp_close(s->sftp_handle);
 636     }
 637     s->sftp_handle = NULL;
 638     if (s->sftp) {
 639         libssh2_sftp_shutdown(s->sftp);
 640     }
 641     s->sftp = NULL;
 642     if (s->session) {
 643         libssh2_session_disconnect(s->session,
 644                                    "from qemu ssh client: "
 645                                    "error opening connection");
 646         libssh2_session_free(s->session);
 647     }
 648     s->session = NULL;
 649
 650     return ret;
 651 }
 652
 653 static int ssh_file_open(BlockDriverState *bs, QDict *options, int bdrv_flags,
 654                          Error **errp)
 655 {
 656     BDRVSSHState *s = bs->opaque;
 657     int ret;
 658     int ssh_flags;
 659
 660     ssh_state_init(s);
 661
 662     ssh_flags = LIBSSH2_FXF_READ;
 663     if (bdrv_flags & BDRV_O_RDWR) {
 664         ssh_flags |= LIBSSH2_FXF_WRITE;
 665     }
 666
 667     /* Start up SSH. */
 668     ret = connect_to_ssh(s, options, ssh_flags, 0, errp);
 669     if (ret < 0) {
 670         goto err;
 671     }
 672
 673     /* Go non-blocking. */
 674     libssh2_session_set_blocking(s->session, 0);
 675
 676     return 0;
 677
 678  err:
 679     if (s->sock >= 0) {
 680         close(s->sock);
 681     }
 682     s->sock = -1;
 683
 684     return ret;
 685 }
 686
 687 static QemuOptsList ssh_create_opts = {
 688     .name = "ssh-create-opts",
 689     .head = QTAILQ_HEAD_INITIALIZER(ssh_create_opts.head),
 690     .desc = {
 691         {
 692             .name = BLOCK_OPT_SIZE,
 693             .type = QEMU_OPT_SIZE,
 694             .help = "Virtual disk size"
 695         },
 696         { /* end of list */ }
 697     }
 698 };
 699
 700 static int ssh_create(const char *filename, QemuOpts *opts, Error **errp)
 701 {
 702     int r, ret;
 703     int64_t total_size = 0;
 704     QDict *uri_options = NULL;
 705     BDRVSSHState s;
 706     ssize_t r2;
 707     char c[1] = { '\0' };
 708
 709     ssh_state_init(&s);
 710
 711     /* Get desired file size. */
 712     total_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
 713                           BDRV_SECTOR_SIZE);
 714     DPRINTF("total_size=%" PRIi64, total_size);
 715
 716     uri_options = qdict_new();
 717     r = parse_uri(filename, uri_options, errp);
 718     if (r < 0) {
 719         ret = r;
 720         goto out;
 721     }
 722
 723     r = connect_to_ssh(&s, uri_options,
 724                        LIBSSH2_FXF_READ|LIBSSH2_FXF_WRITE|
 725                        LIBSSH2_FXF_CREAT|LIBSSH2_FXF_TRUNC,
 726                        0644, errp);
 727     if (r < 0) {
 728         ret = r;
 729         goto out;
 730     }
 731
 732     if (total_size > 0) {
 733         libssh2_sftp_seek64(s.sftp_handle, total_size-1);
 734         r2 = libssh2_sftp_write(s.sftp_handle, c, 1);
 735         if (r2 < 0) {
 736             sftp_error_setg(errp, &s, "truncate failed");
 737             ret = -EINVAL;
 738             goto out;
 739         }
 740         s.attrs.filesize = total_size;
 741     }
 742
 743     ret = 0;
 744
 745  out:
 746     ssh_state_free(&s);
 747     if (uri_options != NULL) {
 748         QDECREF(uri_options);
 749     }
 750     return ret;
 751 }
 752
 753 static void ssh_close(BlockDriverState *bs)
 754 {
 755     BDRVSSHState *s = bs->opaque;
 756
 757     ssh_state_free(s);
 758 }
 759
 760 static int ssh_has_zero_init(BlockDriverState *bs)
 761 {
 762     BDRVSSHState *s = bs->opaque;
 763     /* Assume false, unless we can positively prove it's true. */
 764     int has_zero_init = 0;
 765
 766     if (s->attrs.flags & LIBSSH2_SFTP_ATTR_PERMISSIONS) {
 767         if (s->attrs.permissions & LIBSSH2_SFTP_S_IFREG) {
 768             has_zero_init = 1;
 769         }
 770     }
 771
 772     return has_zero_init;
 773 }
 774
 775 static void restart_coroutine(void *opaque)
 776 {
 777     Coroutine *co = opaque;
 778
 779     DPRINTF("co=%p", co);
 780
 781     qemu_coroutine_enter(co, NULL);
 782 }
 783
 784 static coroutine_fn void set_fd_handler(BDRVSSHState *s, BlockDriverState *bs)
 785 {
 786     int r;
 787     IOHandler *rd_handler = NULL, *wr_handler = NULL;
 788     Coroutine *co = qemu_coroutine_self();
 789
 790     r = libssh2_session_block_directions(s->session);
 791
 792     if (r & LIBSSH2_SESSION_BLOCK_INBOUND) {
 793         rd_handler = restart_coroutine;
 794     }
 795     if (r & LIBSSH2_SESSION_BLOCK_OUTBOUND) {
 796         wr_handler = restart_coroutine;
 797     }
 798
 799     DPRINTF("s->sock=%d rd_handler=%p wr_handler=%p", s->sock,
 800             rd_handler, wr_handler);
 801
 802     aio_set_fd_handler(bdrv_get_aio_context(bs), s->sock,
 803                        false, rd_handler, wr_handler, co);
 804 }
 805
 806 static coroutine_fn void clear_fd_handler(BDRVSSHState *s,
 807                                           BlockDriverState *bs)
 808 {
 809     DPRINTF("s->sock=%d", s->sock);
 810     aio_set_fd_handler(bdrv_get_aio_context(bs), s->sock,
 811                        false, NULL, NULL, NULL);
 812 }
 813
 814 /* A non-blocking call returned EAGAIN, so yield, ensuring the
 815  * handlers are set up so that we'll be rescheduled when there is an
 816  * interesting event on the socket.
 817  */
 818 static coroutine_fn void co_yield(BDRVSSHState *s, BlockDriverState *bs)
 819 {
 820     set_fd_handler(s, bs);
 821     qemu_coroutine_yield();
 822     clear_fd_handler(s, bs);
 823 }
 824
 825 /* SFTP has a function `libssh2_sftp_seek64' which seeks to a position
 826  * in the remote file.  Notice that it just updates a field in the
 827  * sftp_handle structure, so there is no network traffic and it cannot
 828  * fail.
 829  *
 830  * However, `libssh2_sftp_seek64' does have a catastrophic effect on
 831  * performance since it causes the handle to throw away all in-flight
 832  * reads and buffered readahead data.  Therefore this function tries
 833  * to be intelligent about when to call the underlying libssh2 function.
 834  */
 835 #define SSH_SEEK_WRITE 0
 836 #define SSH_SEEK_READ  1
 837 #define SSH_SEEK_FORCE 2
 838
 839 static void ssh_seek(BDRVSSHState *s, int64_t offset, int flags)
 840 {
 841     bool op_read = (flags & SSH_SEEK_READ) != 0;
 842     bool force = (flags & SSH_SEEK_FORCE) != 0;
 843
 844     if (force || op_read != s->offset_op_read || offset != s->offset) {
 845         DPRINTF("seeking to offset=%" PRIi64, offset);
 846         libssh2_sftp_seek64(s->sftp_handle, offset);
 847         s->offset = offset;
 848         s->offset_op_read = op_read;
 849     }
 850 }
 851
 852 static coroutine_fn int ssh_read(BDRVSSHState *s, BlockDriverState *bs,
 853                                  int64_t offset, size_t size,
 854                                  QEMUIOVector *qiov)
 855 {
 856     ssize_t r;
 857     size_t got;
 858     char *buf, *end_of_vec;
 859     struct iovec *i;
 860
 861     DPRINTF("offset=%" PRIi64 " size=%zu", offset, size);
 862
 863     ssh_seek(s, offset, SSH_SEEK_READ);
 864
 865     /* This keeps track of the current iovec element ('i'), where we
 866      * will write to next ('buf'), and the end of the current iovec
 867      * ('end_of_vec').
 868      */
 869     i = &qiov->iov[0];
 870     buf = i->iov_base;
 871     end_of_vec = i->iov_base + i->iov_len;
 872
 873     /* libssh2 has a hard-coded limit of 2000 bytes per request,
 874      * although it will also do readahead behind our backs.  Therefore
 875      * we may have to do repeated reads here until we have read 'size'
 876      * bytes.
 877      */
 878     for (got = 0; got < size; ) {
 879     again:
 880         DPRINTF("sftp_read buf=%p size=%zu", buf, end_of_vec - buf);
 881         r = libssh2_sftp_read(s->sftp_handle, buf, end_of_vec - buf);
 882         DPRINTF("sftp_read returned %zd", r);
 883
 884         if (r == LIBSSH2_ERROR_EAGAIN || r == LIBSSH2_ERROR_TIMEOUT) {
 885             co_yield(s, bs);
 886             goto again;
 887         }
 888         if (r < 0) {
 889             sftp_error_report(s, "read failed");
 890             s->offset = -1;
 891             return -EIO;
 892         }
 893         if (r == 0) {
 894             /* EOF: Short read so pad the buffer with zeroes and return it. */
 895             qemu_iovec_memset(qiov, got, 0, size - got);
 896             return 0;
 897         }
 898
 899         got += r;
 900         buf += r;
 901         s->offset += r;
 902         if (buf >= end_of_vec && got < size) {
 903             i++;
 904             buf = i->iov_base;
 905             end_of_vec = i->iov_base + i->iov_len;
 906         }
 907     }
 908
 909     return 0;
 910 }
 911
 912 static coroutine_fn int ssh_co_readv(BlockDriverState *bs,
 913                                      int64_t sector_num,
 914                                      int nb_sectors, QEMUIOVector *qiov)
 915 {
 916     BDRVSSHState *s = bs->opaque;
 917     int ret;
 918
 919     qemu_co_mutex_lock(&s->lock);
 920     ret = ssh_read(s, bs, sector_num * BDRV_SECTOR_SIZE,
 921                    nb_sectors * BDRV_SECTOR_SIZE, qiov);
 922     qemu_co_mutex_unlock(&s->lock);
 923
 924     return ret;
 925 }
 926
 927 static int ssh_write(BDRVSSHState *s, BlockDriverState *bs,
 928                      int64_t offset, size_t size,
 929                      QEMUIOVector *qiov)
 930 {
 931     ssize_t r;
 932     size_t written;
 933     char *buf, *end_of_vec;
 934     struct iovec *i;
 935
 936     DPRINTF("offset=%" PRIi64 " size=%zu", offset, size);
 937
 938     ssh_seek(s, offset, SSH_SEEK_WRITE);
 939
 940     /* This keeps track of the current iovec element ('i'), where we
 941      * will read from next ('buf'), and the end of the current iovec
 942      * ('end_of_vec').
 943      */
 944     i = &qiov->iov[0];
 945     buf = i->iov_base;
 946     end_of_vec = i->iov_base + i->iov_len;
 947
 948     for (written = 0; written < size; ) {
 949     again:
 950         DPRINTF("sftp_write buf=%p size=%zu", buf, end_of_vec - buf);
 951         r = libssh2_sftp_write(s->sftp_handle, buf, end_of_vec - buf);
 952         DPRINTF("sftp_write returned %zd", r);
 953
 954         if (r == LIBSSH2_ERROR_EAGAIN || r == LIBSSH2_ERROR_TIMEOUT) {
 955             co_yield(s, bs);
 956             goto again;
 957         }
 958         if (r < 0) {
 959             sftp_error_report(s, "write failed");
 960             s->offset = -1;
 961             return -EIO;
 962         }
 963         /* The libssh2 API is very unclear about this.  A comment in
 964          * the code says "nothing was acked, and no EAGAIN was
 965          * received!" which apparently means that no data got sent
 966          * out, and the underlying channel didn't return any EAGAIN
 967          * indication.  I think this is a bug in either libssh2 or
 968          * OpenSSH (server-side).  In any case, forcing a seek (to
 969          * discard libssh2 internal buffers), and then trying again
 970          * works for me.
 971          */
 972         if (r == 0) {
 973             ssh_seek(s, offset + written, SSH_SEEK_WRITE|SSH_SEEK_FORCE);
 974             co_yield(s, bs);
 975             goto again;
 976         }
 977
 978         written += r;
 979         buf += r;
 980         s->offset += r;
 981         if (buf >= end_of_vec && written < size) {
 982             i++;
 983             buf = i->iov_base;
 984             end_of_vec = i->iov_base + i->iov_len;
 985         }
 986
 987         if (offset + written > s->attrs.filesize)
 988             s->attrs.filesize = offset + written;
 989     }
 990
 991     return 0;
 992 }
 993
 994 static coroutine_fn int ssh_co_writev(BlockDriverState *bs,
 995                                       int64_t sector_num,
 996                                       int nb_sectors, QEMUIOVector *qiov)
 997 {
 998     BDRVSSHState *s = bs->opaque;
 999     int ret;
1000
1001     qemu_co_mutex_lock(&s->lock);
1002     ret = ssh_write(s, bs, sector_num * BDRV_SECTOR_SIZE,
1003                     nb_sectors * BDRV_SECTOR_SIZE, qiov);
1004     qemu_co_mutex_unlock(&s->lock);
1005
1006     return ret;
1007 }
1008
1009 static void unsafe_flush_warning(BDRVSSHState *s, const char *what)
1010 {
1011     if (!s->unsafe_flush_warning) {
1012         error_report("warning: ssh server %s does not support fsync",
1013                      s->hostport);
1014         if (what) {
1015             error_report("to support fsync, you need %s", what);
1016         }
1017         s->unsafe_flush_warning = true;
1018     }
1019 }
1020
1021 #ifdef HAS_LIBSSH2_SFTP_FSYNC
1022
1023 static coroutine_fn int ssh_flush(BDRVSSHState *s, BlockDriverState *bs)
1024 {
1025     int r;
1026
1027     DPRINTF("fsync");
1028  again:
1029     r = libssh2_sftp_fsync(s->sftp_handle);
1030     if (r == LIBSSH2_ERROR_EAGAIN || r == LIBSSH2_ERROR_TIMEOUT) {
1031         co_yield(s, bs);
1032         goto again;
1033     }
1034     if (r == LIBSSH2_ERROR_SFTP_PROTOCOL &&
1035         libssh2_sftp_last_error(s->sftp) == LIBSSH2_FX_OP_UNSUPPORTED) {
1036         unsafe_flush_warning(s, "OpenSSH >= 6.3");
1037         return 0;
1038     }
1039     if (r < 0) {
1040         sftp_error_report(s, "fsync failed");
1041         return -EIO;
1042     }
1043
1044     return 0;
1045 }
1046
1047 static coroutine_fn int ssh_co_flush(BlockDriverState *bs)
1048 {
1049     BDRVSSHState *s = bs->opaque;
1050     int ret;
1051
1052     qemu_co_mutex_lock(&s->lock);
1053     ret = ssh_flush(s, bs);
1054     qemu_co_mutex_unlock(&s->lock);
1055
1056     return ret;
1057 }
1058
1059 #else /* !HAS_LIBSSH2_SFTP_FSYNC */
1060
1061 static coroutine_fn int ssh_co_flush(BlockDriverState *bs)
1062 {
1063     BDRVSSHState *s = bs->opaque;
1064
1065     unsafe_flush_warning(s, "libssh2 >= 1.4.4");
1066     return 0;
1067 }
1068
1069 #endif /* !HAS_LIBSSH2_SFTP_FSYNC */
1070
1071 static int64_t ssh_getlength(BlockDriverState *bs)
1072 {
1073     BDRVSSHState *s = bs->opaque;
1074     int64_t length;
1075
1076     /* Note we cannot make a libssh2 call here. */
1077     length = (int64_t) s->attrs.filesize;
1078     DPRINTF("length=%" PRIi64, length);
1079
1080     return length;
1081 }
1082
1083 static BlockDriver bdrv_ssh = {
1084     .format_name                  = "ssh",
1085     .protocol_name                = "ssh",
1086     .instance_size                = sizeof(BDRVSSHState),
1087     .bdrv_parse_filename          = ssh_parse_filename,
1088     .bdrv_file_open               = ssh_file_open,
1089     .bdrv_create                  = ssh_create,
1090     .bdrv_close                   = ssh_close,
1091     .bdrv_has_zero_init           = ssh_has_zero_init,
1092     .bdrv_co_readv                = ssh_co_readv,
1093     .bdrv_co_writev               = ssh_co_writev,
1094     .bdrv_getlength               = ssh_getlength,
1095     .bdrv_co_flush_to_disk        = ssh_co_flush,
1096     .create_opts                  = &ssh_create_opts,
1097 };
1098
1099 static void bdrv_ssh_init(void)
1100 {
1101     int r;
1102
1103     r = libssh2_init(0);
1104     if (r != 0) {
1105         fprintf(stderr, "libssh2 initialization failed, %d\n", r);
1106         exit(EXIT_FAILURE);
1107     }
1108
1109     bdrv_register(&bdrv_ssh);
1110 }
1111
1112 block_init(bdrv_ssh_init);