From 41beea618d3da3b0351b3d8aa7eb7be40f369877 Mon Sep 17 00:00:00 2001 From: "Richard W.M. Jones" Date: Mon, 29 Jul 2013 14:47:56 +0100 Subject: [PATCH 3/5] RHEL: Disable unsupported remote drive protocols (RHBZ#962113). This disables support for unsupported remote drive protocols: * ftp * ftps * http * https * tftp * gluster * iscsi * sheepdog * ssh Note 'nbd' is not disabled, and of course 'file' works. We hope to gradually add some of these back over the lifetime of RHEL. --- docs/guestfs-testing.pod | 20 ----- fish/guestfish.pod | 66 ++-------------- fish/test-add-uri.sh | 32 -------- generator/actions_core.ml | 50 +------------ lib/drives.c | 8 ++ lib/guestfs.pod | 100 ------------------------- tests/disks/test-qemu-drive-libvirt.sh | 28 ------- tests/disks/test-qemu-drive.sh | 60 --------------- 8 files changed, 16 insertions(+), 348 deletions(-) diff --git a/docs/guestfs-testing.pod b/docs/guestfs-testing.pod index f558964bf..8f264ed17 100644 --- a/docs/guestfs-testing.pod +++ b/docs/guestfs-testing.pod @@ -109,26 +109,6 @@ image. To exit, type C. If you get an error, try enabling debugging (add C<-v> to the command line). Also make sure that L succeeds. -=head2 Try to open a remote guest image with guestfish. - -You may also have to disable libvirt by setting this: - - export LIBGUESTFS_BACKEND=direct - -If you have a disk image available over HTTP/FTP, try to open it. - - guestfish --ro -i --format=raw -a http://www.example.com/disk.img - -For SSH you will need to make sure that ssh-agent is set up so you -don't need a password to log in to the remote machine. Then a command -similar to this should work: - - guestfish --ro -i --format=raw \ - -a ssh://remote.example.com/path/to/disk.img - -If you get an error, try enabling debugging (add C<-v> to the command -line). Also make sure that L succeeds. - =head2 Run virt-alignment-scan on all your guests. Run L on guests or disk images: diff --git a/fish/guestfish.pod b/fish/guestfish.pod index 9f086f110..bb4167b06 100644 --- a/fish/guestfish.pod +++ b/fish/guestfish.pod @@ -131,9 +131,9 @@ To list what is available do: =head2 Remote drives -Access a remote disk using ssh: +Access a remote disk using NBD: - guestfish -a ssh://example.com/path/to/disk.img + guestfish -a nbd://example.com =head2 Remote control @@ -1134,12 +1134,12 @@ L>. On the command line, you can use the I<-a> option to add network block devices using a URI-style format, for example: - guestfish -a ssh://root@example.com/disk.img + guestfish -a nbd://example.com URIs I be used with the L command. The equivalent command using the API directly is: - > add /disk.img protocol:ssh server:tcp:example.com username:root + > add /disk.img protocol:nbd server:tcp:example.com The possible I<-a URI> formats are described below. @@ -1149,40 +1149,6 @@ The possible I<-a URI> formats are described below. Add the local disk image (or device) called F. -=head2 B<-a ftp://[user@]example.com[:port]/disk.img> - -=head2 B<-a ftps://[user@]example.com[:port]/disk.img> - -=head2 B<-a http://[user@]example.com[:port]/disk.img> - -=head2 B<-a https://[user@]example.com[:port]/disk.img> - -=head2 B<-a tftp://[user@]example.com[:port]/disk.img> - -Add a disk located on a remote FTP, HTTP or TFTP server. - -The equivalent API command would be: - - > add /disk.img protocol:(ftp|...) server:tcp:example.com - -=head2 B<-a gluster://example.com[:port]/volname/image> - -Add a disk image located on GlusterFS storage. - -The server is the one running C, and may be C. - -The equivalent API command would be: - - > add volname/image protocol:gluster server:tcp:example.com - -=head2 B<-a iscsi://example.com[:port]/target-iqn-name[/lun]> - -Add a disk located on an iSCSI server. - -The equivalent API command would be: - - > add target-iqn-name/lun protocol:iscsi server:tcp:example.com - =head2 B<-a nbd://example.com[:port]> =head2 B<-a nbd://example.com[:port]/exportname> @@ -1217,35 +1183,13 @@ The equivalent API command would be: > add pool/disk protocol:rbd server:tcp:example.com:port -=head2 B<-a sheepdog://[example.com[:port]]/volume/image> - -Add a disk image located on a Sheepdog volume. - -The server name is optional. Although libguestfs and Sheepdog -supports multiple servers, only at most one server can be specified -when using this URI syntax. - -The equivalent API command would be: - - > add volume protocol:sheepdog [server:tcp:example.com] - -=head2 B<-a ssh://[user@]example.com[:port]/disk.img> - -Add a disk image located on a remote server, accessed using the Secure -Shell (ssh) SFTP protocol. SFTP is supported out of the box by all -major SSH servers. - -The equivalent API command would be: - - > add /disk protocol:ssh server:tcp:example.com [username:user] - Note that the URIs follow the syntax of L: in particular, there are restrictions on the allowed characters for the various components of the URI. Characters such as C<:>, C<@>, and C B be percent-encoded: - $ guestfish -a ssh://user:pass%40word@example.com/disk.img + $ guestfish -a rbd://user:pass%40word@example.com[:port]/pool/disk In this case, the password is C. diff --git a/fish/test-add-uri.sh b/fish/test-add-uri.sh index 21d424984..ddabeb639 100755 --- a/fish/test-add-uri.sh +++ b/fish/test-add-uri.sh @@ -40,14 +40,6 @@ function fail () $VG guestfish -x -a file://$abs_builddir/test-add-uri.img test-add-uri.out 2>&1 grep -sq 'add_drive ".*/test-add-uri.img"' test-add-uri.out || fail -# curl -$VG guestfish -x -a ftp://user@example.com/disk.img test-add-uri.out 2>&1 -grep -sq 'add_drive "/disk.img" "protocol:ftp" "server:tcp:example.com" "username:user"' test-add-uri.out || fail - -# gluster -$VG guestfish -x -a gluster://example.com/disk test-add-uri.out 2>&1 -grep -sq 'add_drive "disk" "protocol:gluster" "server:tcp:example.com"' test-add-uri.out || fail - # NBD $VG guestfish -x -a nbd://example.com test-add-uri.out 2>&1 grep -sq 'add_drive "" "protocol:nbd" "server:tcp:example.com"' test-add-uri.out || fail @@ -67,29 +59,5 @@ grep -sq 'add_drive "pool/disk" "protocol:rbd" "server:tcp:example.com:6789"' te $VG guestfish -x -a rbd:///pool/disk test-add-uri.out 2>&1 grep -sq 'add_drive "pool/disk" "protocol:rbd"' test-add-uri.out || fail -# sheepdog -$VG guestfish -x -a sheepdog:///volume/image test-add-uri.out 2>&1 -grep -sq 'add_drive "volume/image" "protocol:sheepdog"' test-add-uri.out || fail - -$VG guestfish -x -a sheepdog://example.com:3000/volume/image test-add-uri.out 2>&1 -grep -sq 'add_drive "volume/image" "protocol:sheepdog" "server:tcp:example.com:3000"' test-add-uri.out || fail - -# ssh -$VG guestfish -x -a ssh://example.com/disk.img test-add-uri.out 2>&1 -grep -sq 'add_drive "/disk.img" "protocol:ssh" "server:tcp:example.com"' test-add-uri.out || fail - -$VG guestfish -x -a ssh://user@example.com/disk.img test-add-uri.out 2>&1 -grep -sq 'add_drive "/disk.img" "protocol:ssh" "server:tcp:example.com" "username:user"' test-add-uri.out || fail - -$VG guestfish -x -a ssh://user@example.com:2000/disk.img test-add-uri.out 2>&1 -grep -sq 'add_drive "/disk.img" "protocol:ssh" "server:tcp:example.com:2000" "username:user"' test-add-uri.out || fail - -# iSCSI -$VG guestfish -x -a iscsi://example.com/iqn.2015-12.com.libguestfs:test1/0 test-add-uri.out 2>&1 -grep -sq 'add_drive "iqn.2015-12.com.libguestfs:test1/0" "protocol:iscsi" "server:tcp:example.com"' test-add-uri.out || fail - -$VG guestfish -x -a iscsi://user:password@example.com/iqn.2015-12.com.libguestfs:test2/0 test-add-uri.out 2>&1 -grep -sq 'add_drive "iqn.2015-12.com.libguestfs:test2/0" "protocol:iscsi" "server:tcp:example.com" "username:user" "secret:password"' test-add-uri.out || fail - rm test-add-uri.out rm test-add-uri.img diff --git a/generator/actions_core.ml b/generator/actions_core.ml index 5f849bad1..f6f8844b8 100644 --- a/generator/actions_core.ml +++ b/generator/actions_core.ml @@ -297,29 +297,6 @@ F is interpreted as a local file or device. This is the default if the optional protocol parameter is omitted. -=item C - -Connect to a remote FTP, HTTP or TFTP server. -The C parameter must also be supplied - see below. - -See also: L - -=item C - -Connect to the GlusterFS server. -The C parameter must also be supplied - see below. - -See also: L - -=item C - -Connect to the iSCSI server. -The C parameter must also be supplied - see below. -The C parameter may be supplied. See below. -The C parameter may be supplied. See below. - -See also: L. - =item C Connect to the Network Block Device server. @@ -336,22 +313,6 @@ The C parameter may be supplied. See below. See also: L. -=item C - -Connect to the Sheepdog server. -The C parameter may also be supplied - see below. - -See also: L. - -=item C - -Connect to the Secure Shell (ssh) server. - -The C parameter must be supplied. -The C parameter may be supplied. See below. - -See also: L. - =back =item C @@ -362,13 +323,8 @@ is a list of server(s). Protocol Number of servers required -------- -------------------------- file List must be empty or param not used at all - ftp|ftps|http|https|tftp Exactly one - gluster Exactly one - iscsi Exactly one nbd Exactly one rbd Zero or more - sheepdog Zero or more - ssh Exactly one Each list element is a string specifying a server. The string must be in one of the following formats: @@ -384,10 +340,10 @@ for the protocol is used (see F). =item C -For the C, C, C, C, C, C, C -and C protocols, this specifies the remote username. +For the C +protocol, this specifies the remote username. -If not given, then the local username is used for C, and no authentication +If not given, then no authentication is attempted for ceph. But note this sometimes may give unexpected results, for example if using the libvirt backend and if the libvirt backend is configured to start the qemu appliance as a special user such as C. If in doubt, diff --git a/lib/drives.c b/lib/drives.c index 46af66db4..c81ded5d7 100644 --- a/lib/drives.c +++ b/lib/drives.c @@ -168,6 +168,7 @@ create_drive_non_file (guestfs_h *g, return drv; } +#if 0 /* DISABLED IN RHEL 8 */ static struct drive * create_drive_curl (guestfs_h *g, const struct drive_create_data *data) @@ -226,6 +227,7 @@ create_drive_gluster (guestfs_h *g, return create_drive_non_file (g, data); } +#endif /* DISABLED IN RHEL 8 */ static int nbd_port (void) @@ -294,6 +296,7 @@ create_drive_rbd (guestfs_h *g, return create_drive_non_file (g, data); } +#if 0 /* DISABLED IN RHEL 8 */ static struct drive * create_drive_sheepdog (guestfs_h *g, const struct drive_create_data *data) @@ -394,6 +397,7 @@ create_drive_iscsi (guestfs_h *g, return create_drive_non_file (g, data); } +#endif /* DISABLED IN RHEL 8 */ /** * Create the special F drive. @@ -856,6 +860,7 @@ guestfs_impl_add_drive_opts (guestfs_h *g, const char *filename, drv = create_drive_file (g, &data); } } +#if 0 /* DISABLED IN RHEL 8 */ else if (STREQ (protocol, "ftp")) { data.protocol = drive_protocol_ftp; drv = create_drive_curl (g, &data); @@ -880,6 +885,7 @@ guestfs_impl_add_drive_opts (guestfs_h *g, const char *filename, data.protocol = drive_protocol_iscsi; drv = create_drive_iscsi (g, &data); } +#endif /* DISABLED IN RHEL 8 */ else if (STREQ (protocol, "nbd")) { data.protocol = drive_protocol_nbd; drv = create_drive_nbd (g, &data); @@ -888,6 +894,7 @@ guestfs_impl_add_drive_opts (guestfs_h *g, const char *filename, data.protocol = drive_protocol_rbd; drv = create_drive_rbd (g, &data); } +#if 0 /* DISABLED IN RHEL 8 */ else if (STREQ (protocol, "sheepdog")) { data.protocol = drive_protocol_sheepdog; drv = create_drive_sheepdog (g, &data); @@ -900,6 +907,7 @@ guestfs_impl_add_drive_opts (guestfs_h *g, const char *filename, data.protocol = drive_protocol_tftp; drv = create_drive_curl (g, &data); } +#endif /* DISABLED IN RHEL 8 */ else { error (g, _("unknown protocol ‘%s’"), protocol); drv = NULL; /*FALLTHROUGH*/ diff --git a/lib/guestfs.pod b/lib/guestfs.pod index ff58aa0bb..1af00f1bb 100644 --- a/lib/guestfs.pod +++ b/lib/guestfs.pod @@ -715,70 +715,6 @@ servers. The server string is documented in L. The C and C parameters are also optional, and if not given, then no authentication will be used. -=head3 FTP, HTTP AND TFTP - -Libguestfs can access remote disks over FTP, FTPS, HTTP, HTTPS -or TFTP protocols. - -To do this, set the optional C and C parameters of -L like this: - - char **servers = { "www.example.org", NULL }; - guestfs_add_drive_opts (g, "/disk.img", - GUESTFS_ADD_DRIVE_OPTS_FORMAT, "raw", - GUESTFS_ADD_DRIVE_OPTS_PROTOCOL, "http", - GUESTFS_ADD_DRIVE_OPTS_SERVER, servers, - -1); - -The C can be one of C<"ftp">, C<"ftps">, C<"http">, -C<"https"> or C<"tftp">. - -C (the C parameter) is a list which must have a -single element. The single element is a string defining the web, -FTP or TFTP server. The format of this string is documented in -L. - -=head3 GLUSTER - -Libguestfs can access Gluster disks. - -To do this, set the optional C and C parameters of -L like this: - - char **servers = { "gluster.example.org:24007", NULL }; - guestfs_add_drive_opts (g, "volname/image", - GUESTFS_ADD_DRIVE_OPTS_FORMAT, "raw", - GUESTFS_ADD_DRIVE_OPTS_PROTOCOL, "gluster", - GUESTFS_ADD_DRIVE_OPTS_SERVER, servers, - -1); - -C (the C parameter) is a list which must have a -single element. The single element is a string defining the Gluster -server. The format of this string is documented in -L. - -Note that gluster usually requires the client process (ie. libguestfs) -to run as B and will give unfathomable errors if it is not -(eg. "No data available"). - -=head3 ISCSI - -Libguestfs can access iSCSI disks remotely. - -To do this, set the optional C and C parameters like -this: - - char **server = { "iscsi.example.org:3000", NULL }; - guestfs_add_drive_opts (g, "target-iqn-name/lun", - GUESTFS_ADD_DRIVE_OPTS_FORMAT, "raw", - GUESTFS_ADD_DRIVE_OPTS_PROTOCOL, "iscsi", - GUESTFS_ADD_DRIVE_OPTS_SERVER, server, - -1); - -The C parameter is a list which must have a single element. -The single element is a string defining the iSCSI server. The format -of this string is documented in L. - =head3 NETWORK BLOCK DEVICE Libguestfs can access Network Block Device (NBD) disks remotely. @@ -841,42 +777,6 @@ L =back -=head3 SHEEPDOG - -Libguestfs can access Sheepdog disks. - -To do this, set the optional C and C parameters of -L like this: - - char **servers = { /* optional servers ... */ NULL }; - guestfs_add_drive_opts (g, "volume", - GUESTFS_ADD_DRIVE_OPTS_FORMAT, "raw", - GUESTFS_ADD_DRIVE_OPTS_PROTOCOL, "sheepdog", - GUESTFS_ADD_DRIVE_OPTS_SERVER, servers, - -1); - -The optional list of C may be zero or more server addresses -(C<"hostname:port">). The format of the server strings is documented -in L. - -=head3 SSH - -Libguestfs can access disks over a Secure Shell (SSH) connection. - -To do this, set the C and C and (optionally) -C parameters of L like this: - - char **server = { "remote.example.com", NULL }; - guestfs_add_drive_opts (g, "/path/to/disk.img", - GUESTFS_ADD_DRIVE_OPTS_FORMAT, "raw", - GUESTFS_ADD_DRIVE_OPTS_PROTOCOL, "ssh", - GUESTFS_ADD_DRIVE_OPTS_SERVER, server, - GUESTFS_ADD_DRIVE_OPTS_USERNAME, "remoteuser", - -1); - -The format of the server string is documented in -L. - =head2 INSPECTION Libguestfs has APIs for inspecting an unknown disk image to find out diff --git a/tests/disks/test-qemu-drive-libvirt.sh b/tests/disks/test-qemu-drive-libvirt.sh index 595a95a5e..b49534c94 100755 --- a/tests/disks/test-qemu-drive-libvirt.sh +++ b/tests/disks/test-qemu-drive-libvirt.sh @@ -65,34 +65,6 @@ check_output grep -sq -- '-drive file=rbd:abc-def/ghi-jkl:auth_supported=none,' "$DEBUG_QEMU_FILE" || fail ceph2 rm "$DEBUG_QEMU_FILE" -# Gluster. - -$guestfish -d gluster run ||: -check_output -grep -sq -- '-drive file=gluster://1.2.3.4:1234/volname/image,' "$DEBUG_QEMU_FILE" || fail gluster -rm "$DEBUG_QEMU_FILE" - -# iSCSI. - -$guestfish -d iscsi run ||: -check_output -grep -sq -- '-drive file=iscsi://1.2.3.4:1234/iqn.2003-01.org.linux-iscsi.fedora' "$DEBUG_QEMU_FILE" || fail iscsi -rm "$DEBUG_QEMU_FILE" - -# NBD. - -$guestfish -d nbd run ||: -check_output -grep -sq -- '-drive file=nbd:1.2.3.4:1234,' "$DEBUG_QEMU_FILE" || fail nbd -rm "$DEBUG_QEMU_FILE" - -# Sheepdog. - -$guestfish -d sheepdog run ||: -check_output -grep -sq -- '-drive file=sheepdog:volume,' "$DEBUG_QEMU_FILE" || fail sheepdog -rm "$DEBUG_QEMU_FILE" - # Local, stored in a pool. $guestfish -d pool1 run ||: diff --git a/tests/disks/test-qemu-drive.sh b/tests/disks/test-qemu-drive.sh index 12937fb30..b3e4f9903 100755 --- a/tests/disks/test-qemu-drive.sh +++ b/tests/disks/test-qemu-drive.sh @@ -62,45 +62,6 @@ check_output grep -sq -- '-drive file=rbd:abc-def/ghi-jkl:auth_supported=none,' "$DEBUG_QEMU_FILE" || fail rm "$DEBUG_QEMU_FILE" -# HTTP. - -guestfish <