Commit b8c1f901 authored by Max Reitz's avatar Max Reitz
Browse files

block/ssh: Implement .bdrv_refresh_filename() 



This requires some changes to keep iotests 104 and 207 working.

qemu-img info in 104 will now return a filename including the user name
and the port, which need to be filtered by adjusting REMOTE_TEST_DIR in
common.rc.  This additional information has to be marked optional,
however (which is simple as REMOTE_TEST_DIR is a regex), because
otherwise 197 and 215 would fail: They use it (indirectly) to filter
qemu-img create output which contains a backing filename they have
passed to it -- which probably does not contain a user name or port
number.

The problem in 207 is a nice one to have: qemu-img info used to return
json:{} filenames, but with this patch it returns nice plain ones.  We
now need to adjust the filtering to hide the user name (and port number
while we are at it).  The simplest way to do this is to include both in
iotests.remote_filename() so that bdrv_refresh_filename() will not
change it, and then iotests.img_info_log() will filter it correctly
automatically.

Signed-off-by: default avatarMax Reitz <mreitz@redhat.com>
Tested-by: default avatarRichard W.M. Jones <rjones@redhat.com>
Message-id: 20190225190828.17726-2-mreitz@redhat.com
Signed-off-by: default avatarMax Reitz <mreitz@redhat.com>
parent 444b8236

block/ssh.c

+47 −5
Original line number Diff line number Diff line
@@ -75,6 +75,14 @@ typedef struct BDRVSSHState { 


    /* Used to warn if 'flush' is not supported. */

    bool unsafe_flush_warning;



    /*

     * Store the user name for ssh_refresh_filename() because the

     * default depends on the system you are on -- therefore, when we

     * generate a filename, it should always contain the user name we

     * are actually using.

     */

    char *user;

} BDRVSSHState;



static void ssh_state_init(BDRVSSHState *s)
@@ -87,6 +95,8 @@ static void ssh_state_init(BDRVSSHState *s) 


static void ssh_state_free(BDRVSSHState *s)

{

    g_free(s->user);



    if (s->sftp_handle) {

        libssh2_sftp_close(s->sftp_handle);

    }
@@ -628,14 +638,13 @@ static int connect_to_ssh(BDRVSSHState *s, BlockdevOptionsSsh *opts, 
                          int ssh_flags, int creat_mode, Error **errp)

{

    int r, ret;

    const char *user;

    long port = 0;



    if (opts->has_user) {

        user = opts->user;

        s->user = g_strdup(opts->user);

    } else {

        user = g_get_user_name();

        if (!user) {

        s->user = g_strdup(g_get_user_name());

        if (!s->user) {

            error_setg_errno(errp, errno, "Can't get user name");

            ret = -errno;

            goto err;
@@ -685,7 +694,7 @@ static int connect_to_ssh(BDRVSSHState *s, BlockdevOptionsSsh *opts, 
    }



    /* Authenticate. */

    ret = authenticate(s, user, errp);

    ret = authenticate(s, s->user, errp);

    if (ret < 0) {

        goto err;

    }
@@ -1242,6 +1251,38 @@ static int coroutine_fn ssh_co_truncate(BlockDriverState *bs, int64_t offset, 
    return ssh_grow_file(s, offset, errp);

}



static void ssh_refresh_filename(BlockDriverState *bs)

{

    BDRVSSHState *s = bs->opaque;

    const char *path, *host_key_check;

    int ret;



    /*

     * None of these options can be represented in a plain "host:port"

     * format, so if any was given, we have to abort.

     */

    if (s->inet->has_ipv4 || s->inet->has_ipv6 || s->inet->has_to ||

        s->inet->has_numeric)

    {

        return;

    }



    path = qdict_get_try_str(bs->full_open_options, "path");

    assert(path); /* mandatory option */



    host_key_check = qdict_get_try_str(bs->full_open_options, "host_key_check");



    ret = snprintf(bs->exact_filename, sizeof(bs->exact_filename),

                   "ssh://%s@%s:%s%s%s%s",

                   s->user, s->inet->host, s->inet->port, path,

                   host_key_check ? "?host_key_check=" : "",

                   host_key_check ?: "");

    if (ret >= sizeof(bs->exact_filename)) {

        /* An overflow makes the filename unusable, so do not report any */

        bs->exact_filename[0] = '\0';

    }

}



static const char *const ssh_strong_runtime_opts[] = {

    "host",

    "port",
@@ -1268,6 +1309,7 @@ static BlockDriver bdrv_ssh = { 
    .bdrv_getlength               = ssh_getlength,

    .bdrv_co_truncate             = ssh_co_truncate,

    .bdrv_co_flush_to_disk        = ssh_co_flush,

    .bdrv_refresh_filename        = ssh_refresh_filename,

    .create_opts                  = &ssh_create_opts,

    .strong_runtime_opts          = ssh_strong_runtime_opts,

};

tests/qemu-iotests/207

+5 −5
Original line number Diff line number Diff line
@@ -66,7 +66,7 @@ with iotests.FilePath('t.img') as disk_path, \ 
                          'size': 4194304 })

    vm.shutdown()



    iotests.img_info_log(remote_path, filter_path=disk_path)

    iotests.img_info_log(remote_path)

    iotests.log("")

    iotests.img_info_log(disk_path)
@@ -91,7 +91,7 @@ with iotests.FilePath('t.img') as disk_path, \ 
                          'size': 8388608 })

    vm.shutdown()



    iotests.img_info_log(remote_path, filter_path=disk_path)

    iotests.img_info_log(remote_path)



    vm.launch()

    blockdev_create(vm, { 'driver': 'ssh',
@@ -108,7 +108,7 @@ with iotests.FilePath('t.img') as disk_path, \ 
                          'size': 4194304 })

    vm.shutdown()



    iotests.img_info_log(remote_path, filter_path=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 "\\^#" | ' +
@@ -146,7 +146,7 @@ with iotests.FilePath('t.img') as disk_path, \ 
                          'size': 8388608 })

    vm.shutdown()



    iotests.img_info_log(remote_path, filter_path=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 "\\^#" | ' +
@@ -184,7 +184,7 @@ with iotests.FilePath('t.img') as disk_path, \ 
                          'size': 4194304 })

    vm.shutdown()



    iotests.img_info_log(remote_path, filter_path=disk_path)

    iotests.img_info_log(remote_path)



    #

    # Invalid path and user

tests/qemu-iotests/207.out

+5 −5
Original line number Diff line number Diff line
@@ -5,7 +5,7 @@ 
{"execute": "job-dismiss", "arguments": {"id": "job0"}}

{"return": {}}



image: json:{"driver": "IMGFMT", "file": {"server.host": "127.0.0.1", "server.port": "22", "driver": "ssh", "path": "TEST_IMG"}}

image: TEST_IMG

file format: IMGFMT

virtual size: 4 MiB (4194304 bytes)
@@ -21,7 +21,7 @@ virtual size: 4 MiB (4194304 bytes) 
{"execute": "job-dismiss", "arguments": {"id": "job0"}}

{"return": {}}



image: json:{"driver": "IMGFMT", "file": {"server.host": "127.0.0.1", "server.port": "22", "driver": "ssh", "path": "TEST_IMG"}}

image: TEST_IMG

file format: IMGFMT

virtual size: 8 MiB (8388608 bytes)
@@ -30,7 +30,7 @@ virtual size: 8 MiB (8388608 bytes) 
{"execute": "job-dismiss", "arguments": {"id": "job0"}}

{"return": {}}



image: json:{"driver": "IMGFMT", "file": {"server.host": "127.0.0.1", "server.port": "22", "driver": "ssh", "path": "TEST_IMG"}}

image: TEST_IMG

file format: IMGFMT

virtual size: 4 MiB (4194304 bytes)
@@ -45,7 +45,7 @@ Job failed: remote host key does not match host_key_check 'wrong' 
{"execute": "job-dismiss", "arguments": {"id": "job0"}}

{"return": {}}



image: json:{"driver": "IMGFMT", "file": {"server.host": "127.0.0.1", "server.port": "22", "driver": "ssh", "path": "TEST_IMG"}}

image: TEST_IMG

file format: IMGFMT

virtual size: 8 MiB (8388608 bytes)
@@ -60,7 +60,7 @@ Job failed: remote host key does not match host_key_check 'wrong' 
{"execute": "job-dismiss", "arguments": {"id": "job0"}}

{"return": {}}



image: json:{"driver": "IMGFMT", "file": {"server.host": "127.0.0.1", "server.port": "22", "driver": "ssh", "path": "TEST_IMG"}}

image: TEST_IMG

file format: IMGFMT

virtual size: 4 MiB (4194304 bytes)

tests/qemu-iotests/common.rc

+1 −1
Original line number Diff line number Diff line
@@ -158,7 +158,7 @@ else 
        TEST_IMG="nbd:127.0.0.1:10810"

    elif [ "$IMGPROTO" = "ssh" ]; then

        TEST_IMG_FILE=$TEST_DIR/t.$IMGFMT

        REMOTE_TEST_DIR="ssh://127.0.0.1$TEST_DIR"

        REMOTE_TEST_DIR="ssh://\\($USER@\\)\\?127.0.0.1\\(:[0-9]\\+\\)\\?$TEST_DIR"

        TEST_IMG="ssh://127.0.0.1$TEST_IMG_FILE"

    elif [ "$IMGPROTO" = "nfs" ]; then

        TEST_IMG_FILE=$TEST_DIR/t.$IMGFMT

tests/qemu-iotests/iotests.py

+1 −1
Original line number Diff line number Diff line
@@ -411,7 +411,7 @@ def remote_filename(path): 
    if imgproto == 'file':

        return path

    elif imgproto == 'ssh':

        return "ssh://127.0.0.1%s" % (path)

        return "ssh://%s@127.0.0.1:22%s" % (os.environ.get('USER'), path)

    else:

        raise Exception("Protocol %s not supported" % (imgproto))