Skip to contentSkip to conversation

vhost-user-blk-test and vdagent Coverity fixes

PATCH Superseded Stefan Hajnoczi 3 participants 9 messages May 26, 2021 – Jun 1, 2021

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

cover vhost-user-blk-test and vdagent Coverity fixes

This patch series addresses recent Coverity reports. Please see the individual patches for details.

Stefan Hajnoczi (3):
vhost-user-blk-test: fix Coverity open(2) false positives
vhost-user-blk-test: fix Coverity mkstemp(2) umask warning ui/vdagent: fix clipboard info memory leak in error path

 tests/qtest/vhost-user-blk-test.c | 18 ++++++++++++++++--
 ui/vdagent.c                      |  2 +-
 2 files changed, 17 insertions(+), 3 deletions(-)
Signature · 1 line
2.31.1
#1 lore raw

PATCH 1/3 vhost-user-blk-test: fix Coverity open(2) false positives

Coverity checks that the file descriptor return value of open(2) is checked and used. Normally this is helpful in identifying real bugs but vhost-user-blk-test opens /dev/null as stdin and stdout after fork.

In this case we don't need to look at the return value because these open(2) calls cannot fail in any reasonable environment. We already know their return values ahead of time since we closed stdin and stdout previously. open(2) is guaranteed to pick the lowest available fd number.

Silence Coverity by introducing code that checks what we already know to be true.

** CID 1453270: Resource leaks (RESOURCE_LEAK) /qemu/tests/qtest/vhost-user-blk-test.c: 920 in start_vhost_user_blk()

________________________________________________________________________________________________________
*** CID 1453270: Resource leaks (RESOURCE_LEAK) /qemu/tests/qtest/vhost-user-blk-test.c: 920 in start_vhost_user_blk()

914              * Close standard file descriptors so tap-driver.pl pipe detects when
915              * our parent terminates.
916              */
917             close(0);
918             close(1);
919             open("/dev/null", O_RDONLY);
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 1453270: Resource leaks (RESOURCE_LEAK) Ignoring handle opened by "open("/dev/null", 1)" leaks it.

920 open("/dev/null", O_WRONLY);
921
922 execlp("/bin/sh", "sh", "-c", storage_daemon_command->str, NULL);
923 exit(1);
924 }
925 g_string_free(storage_daemon_command, true);

** CID 1453269: Error handling issues (NEGATIVE_RETURNS) /qemu/tests/qtest/vhost-user-blk-test.c: 829 in create_listen_socket()

________________________________________________________________________________________________________
*** CID 1453269: Error handling issues (NEGATIVE_RETURNS) /qemu/tests/qtest/vhost-user-blk-test.c: 829 in create_listen_socket()
823 char *path;
824

825         /* No race because our pid makes the path unique */
826         path = g_strdup_printf("/tmp/qtest-%d-sock.XXXXXX", getpid());
827         tmp_fd = mkstemp(path);
828         g_assert_cmpint(tmp_fd, >=, 0);
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 1453269: Error handling issues (NEGATIVE_RETURNS) "tmp_fd" is passed to a parameter that cannot be negative.

829 close(tmp_fd);
830 unlink(path);
831

832         *fd = qtest_socket_server(path);
833         g_test_queue_destroy(destroy_file, path);
834         return path;

** CID 1453268: (CHECKED_RETURN)
/qemu/tests/qtest/vhost-user-blk-test.c: 920 in start_vhost_user_blk() /qemu/tests/qtest/vhost-user-blk-test.c: 919 in start_vhost_user_blk()

________________________________________________________________________________________________________
*** CID 1453268: (CHECKED_RETURN)
/qemu/tests/qtest/vhost-user-blk-test.c: 920 in start_vhost_user_blk()

914              * Close standard file descriptors so tap-driver.pl pipe detects when
915              * our parent terminates.
916              */
917             close(0);
918             close(1);
919             open("/dev/null", O_RDONLY);
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 1453268: (CHECKED_RETURN)
Calling "open("/dev/null", 1)" without checking return value. This library function may fail and return an error code. [Note: The source code implementation of the function has been overridden by a builtin model.]

920 open("/dev/null", O_WRONLY);
921
922 execlp("/bin/sh", "sh", "-c", storage_daemon_command->str, NULL);
923 exit(1);
924 }
925 g_string_free(storage_daemon_command, true);
/qemu/tests/qtest/vhost-user-blk-test.c: 919 in start_vhost_user_blk()
913 /*

914              * Close standard file descriptors so tap-driver.pl pipe detects when
915              * our parent terminates.
916              */

917 close(0);
918 close(1);

Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 1453268: (CHECKED_RETURN)
Calling "open("/dev/null", 0)" without checking return value. This library function may fail and return an error code. [Note: The source code implementation of the function has been overridden by a builtin model.]

919 open("/dev/null", O_RDONLY);
920 open("/dev/null", O_WRONLY);
921
922 execlp("/bin/sh", "sh", "-c", storage_daemon_command->str, NULL);
923 exit(1);
924 }

---
 tests/qtest/vhost-user-blk-test.c | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)
tests/qtest/vhost-user-blk-test.c +6 -2
index 8796c74ca4..581e283a03 100644
@@ -910,14 +910,18 @@ static void start_vhost_user_blk(GString *cmd_line, int vus_instances,
                    storage_daemon_command->str);
     pid_t pid = fork();
     if (pid == 0) {
+        int fd;
+
         /*
          * Close standard file descriptors so tap-driver.pl pipe detects when
          * our parent terminates.
          */
         close(0);
+        fd = open("/dev/null", O_RDONLY);
+        g_assert_cmpint(fd, ==, 0);
         close(1);
-        open("/dev/null", O_RDONLY);
-        open("/dev/null", O_WRONLY);
+        fd = open("/dev/null", O_WRONLY);
+        assert(fd == 1);
 
         execlp("/bin/sh", "sh", "-c", storage_daemon_command->str, NULL);
         exit(1);
Signature · 1 line
2.31.1
#2 lore raw

Re: [PATCH 1/3] vhost-user-blk-test: fix Coverity open(2) false positives

Quoted 26 lines · Stefan Hajnoczi

Coverity checks that the file descriptor return value of open(2) is checked and used. Normally this is helpful in identifying real bugs but vhost-user-blk-test opens /dev/null as stdin and stdout after fork.

In this case we don't need to look at the return value because these open(2) calls cannot fail in any reasonable environment. We already know their return values ahead of time since we closed stdin and stdout previously. open(2) is guaranteed to pick the lowest available fd number.

Silence Coverity by introducing code that checks what we already know to be true.

tests/qtest/vhost-user-blk-test.c +2 -0
index 8796c74ca4..581e283a03 100644
@@ -910,14 +910,18 @@ static void start_vhost_user_blk(GString *cmd_line, int vus_instances,
                    storage_daemon_command->str);
     pid_t pid = fork();
     if (pid == 0) {
+        int fd;
+
         /*
          * Close standard file descriptors so tap-driver.pl pipe detects when

tests/qtest/vhost-user-blk-test.c static void start_vhost_user_blk(GString *cmd_line, int vus_instances, · line 924

Quoted 10 lines
tests/qtest/vhost-user-blk-test.c +4 -2
          * our parent terminates.
          */
         close(0);
+        fd = open("/dev/null", O_RDONLY);
+        g_assert_cmpint(fd, ==, 0);
         close(1);
-        open("/dev/null", O_RDONLY);
-        open("/dev/null", O_WRONLY);
+        fd = open("/dev/null", O_WRONLY);
+        assert(fd == 1);

Why use a different assert type for the two asserts?

thanks
-- PMM

#3 lore raw

Re: [PATCH 1/3] vhost-user-blk-test: fix Coverity open(2) false positives

Quoted 32 lines · Peter Maydell
Quoted 31 lines · Stefan Hajnoczi

Coverity checks that the file descriptor return value of open(2) is checked and used. Normally this is helpful in identifying real bugs but vhost-user-blk-test opens /dev/null as stdin and stdout after fork.

In this case we don't need to look at the return value because these open(2) calls cannot fail in any reasonable environment. We already know their return values ahead of time since we closed stdin and stdout previously. open(2) is guaranteed to pick the lowest available fd number.

Silence Coverity by introducing code that checks what we already know to be true.

tests/qtest/vhost-user-blk-test.c +4 -0
index 8796c74ca4..581e283a03 100644
@@ -910,14 +910,18 @@ static void start_vhost_user_blk(GString *cmd_line, int vus_instances,
                    storage_daemon_command->str);
     pid_t pid = fork();
     if (pid == 0) {
+        int fd;
+
         /*
          * Close standard file descriptors so tap-driver.pl pipe detects when
          * our parent terminates.
          */
         close(0);
+        fd = open("/dev/null", O_RDONLY);
+        g_assert_cmpint(fd, ==, 0);
Quoted 8 lines

tests/qtest/vhost-user-blk-test.c static void start_vhost_user_blk(GString *cmd_line, int vus_instances, · line 924

Quoted 5 lines
tests/qtest/vhost-user-blk-test.c +2 -2
         close(1);
-        open("/dev/null", O_RDONLY);
-        open("/dev/null", O_WRONLY);
+        fd = open("/dev/null", O_WRONLY);
+        assert(fd == 1);

Why use a different assert type for the two asserts?

Thanks for pointing this out. I will send a v2 that consistently uses g_assert_cmpint().

Stefan

#4 lore raw

PATCH 2/3 vhost-user-blk-test: fix Coverity mkstemp(2) umask warning

In reply to Stefan Hajnoczi

The Linux man page for mkstemp(3) states:

In glibc versions 2.06 and earlier, the file is created with permissions 0666, that is, read and write for all users. This old behavior may be a security risk, especially since other UNIX flavors use 0600, and somebody might overlook this detail when porting programs. POSIX.1-2008 adds a requirement that the file be created with mode 0600.

More generally, the POSIX specification of mkstemp() does not say anything about file modes, so the application should make sure its file mode creation mask (see umask(2)) is set appropriately before calling mkstemp() (and mkostemp()).

glibc 2.0.6 was released in 1997 and POSIX caught up in 2008. macOS and FreeBSD also use POSIX-compliant 0600 permissions.

At this point the Coverity warning seems archaic and no longer useful, but go ahead and silence it.

*** CID 1453267: Security best practices violations (SECURE_TEMP) /qemu/tests/qtest/vhost-user-blk-test.c: 827 in create_listen_socket()
821 {
822 int tmp_fd;
823 char *path;
824
825 /* No race because our pid makes the path unique */
826 path = g_strdup_printf("/tmp/qtest-%d-sock.XXXXXX", getpid());

Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 1453267: Security best practices violations (SECURE_TEMP) Calling "mkstemp" without securely setting umask first.

827         tmp_fd = mkstemp(path);
828         g_assert_cmpint(tmp_fd, >=, 0);
829         close(tmp_fd);
830         unlink(path);

831
832 *fd = qtest_socket_server(path);

---
 tests/qtest/vhost-user-blk-test.c | 10 ++++++++++
 1 file changed, 10 insertions(+)
tests/qtest/vhost-user-blk-test.c +10 -0
index 581e283a03..412e010db8 100644
@@ -803,11 +803,16 @@ static void destroy_file(void *path)
 static char *drive_create(void)
 {
     int fd, ret;
+    mode_t old_umask;
     /** vhost-user-blk won't recognize drive located in /tmp */
     char *t_path = g_strdup("qtest.XXXXXX");
 
     /** Create a temporary raw image */
+    old_umask = umask(S_IXUSR |
+                      S_IRGRP | S_IWGRP | S_IXGRP |
+                      S_IROTH | S_IWOTH | S_IXOTH);
     fd = mkstemp(t_path);
+    umask(old_umask);
     g_assert_cmpint(fd, >=, 0);
     ret = ftruncate(fd, TEST_IMAGE_SIZE);
     g_assert_cmpint(ret, ==, 0);
@@ -821,10 +826,15 @@ static char *create_listen_socket(int *fd)
 {
     int tmp_fd;
     char *path;
+    mode_t old_umask;
 
     /* No race because our pid makes the path unique */
     path = g_strdup_printf("/tmp/qtest-%d-sock.XXXXXX", getpid());
+    old_umask = umask(S_IXUSR |
+                      S_IRGRP | S_IWGRP | S_IXGRP |
+                      S_IROTH | S_IWOTH | S_IXOTH);
     tmp_fd = mkstemp(path);
+    umask(old_umask);
     g_assert_cmpint(tmp_fd, >=, 0);
     close(tmp_fd);
     unlink(path);
Signature · 1 line
2.31.1
#5 lore raw

Re: [PATCH 2/3] vhost-user-blk-test: fix Coverity mkstemp(2) umask warning

Quoted 15 lines · Stefan Hajnoczi

The Linux man page for mkstemp(3) states:

In glibc versions 2.06 and earlier, the file is created with permissions 0666, that is, read and write for all users. This old behavior may be a security risk, especially since other UNIX flavors use 0600, and somebody might overlook this detail when porting programs. POSIX.1-2008 adds a requirement that the file be created with mode 0600.

More generally, the POSIX specification of mkstemp() does not say anything about file modes, so the application should make sure its file mode creation mask (see umask(2)) is set appropriately before calling mkstemp() (and mkostemp()).

Quoted 5 lines

glibc 2.0.6 was released in 1997 and POSIX caught up in 2008. macOS and FreeBSD also use POSIX-compliant 0600 permissions.

At this point the Coverity warning seems archaic and no longer useful, but go ahead and silence it.

We had a lot of these on other uses of mkstemp() in tests/ -- I have been simply marking them as false-positive on the same grounds that you cite above. I would suggest we do the same here rather than having this one test do something different with mkstemp().

(If we really wanted to handle ancient glibc, we should do that by having a qemu_mkstemp() or something. But it doesn't seem worthwhile...)

thanks
-- PMM

#6 lore raw

Re: [PATCH 2/3] vhost-user-blk-test: fix Coverity mkstemp(2) umask warning

Quoted 22 lines · Peter Maydell
Quoted 15 lines · Stefan Hajnoczi

The Linux man page for mkstemp(3) states:

In glibc versions 2.06 and earlier, the file is created with permissions 0666, that is, read and write for all users. This old behavior may be a security risk, especially since other UNIX flavors use 0600, and somebody might overlook this detail when porting programs. POSIX.1-2008 adds a requirement that the file be created with mode 0600.

More generally, the POSIX specification of mkstemp() does not say anything about file modes, so the application should make sure its file mode creation mask (see umask(2)) is set appropriately before calling mkstemp() (and mkostemp()).

Quoted 5 lines

glibc 2.0.6 was released in 1997 and POSIX caught up in 2008. macOS and FreeBSD also use POSIX-compliant 0600 permissions.

At this point the Coverity warning seems archaic and no longer useful, but go ahead and silence it.

Quoted 8 lines

We had a lot of these on other uses of mkstemp() in tests/ -- I have been simply marking them as false-positive on the same grounds that you cite above. I would suggest we do the same here rather than having this one test do something different with mkstemp().

(If we really wanted to handle ancient glibc, we should do that by having a qemu_mkstemp() or something. But it doesn't seem worthwhile...)

Sounds good. I have updated Coverity.

Stefan

#7 lore raw

PATCH 3/3 ui/vdagent: fix clipboard info memory leak in error path

In reply to Stefan Hajnoczi

If the size of a VD_AGENT_CLIPBOARD_GRAB message is invalid we leak info when returning early.

Thanks to Coverity for spotting this:

*** CID 1453266: Resource leaks (RESOURCE_LEAK) /qemu/ui/vdagent.c: 465 in vdagent_chr_recv_clipboard()
459 info = qemu_clipboard_info_new(&vd->cbpeer, s);
460 if (size > sizeof(uint32_t) * 10) {
461 /*

462                  * spice has 6 types as of 2021. Limiting to 10 entries
463                  * so we we have some wiggle room.
464                  */
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 1453266: Resource leaks (RESOURCE_LEAK)
Variable "info" going out of scope leaks the storage it points to.

465 return;
466 }
467 while (size >= sizeof(uint32_t)) {

468                 trace_vdagent_cb_grab_type(GET_NAME(type_name, *(uint32_t *)data));
469                 switch (*(uint32_t *)data) {
470                 case VD_AGENT_CLIPBOARD_UTF8_TEXT:
Fixes f0349f4d8947ad32d0fa4678cbf5dbb356fcbda1 ("ui/vdagent: add clipboard support")
Cc Gerd Hoffmann <[email protected]>
---
 ui/vdagent.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
ui/vdagent.c +1 -1
index a253a8fe63..8fc54d330e 100644
@@ -456,7 +456,6 @@ static void vdagent_chr_recv_clipboard(VDAgentChardev *vd, VDAgentMessage *msg)
     switch (msg->type) {
     case VD_AGENT_CLIPBOARD_GRAB:
         trace_vdagent_cb_grab_selection(GET_NAME(sel_name, s));
-        info = qemu_clipboard_info_new(&vd->cbpeer, s);
         if (size > sizeof(uint32_t) * 10) {
             /*
              * spice has 6 types as of 2021. Limiting to 10 entries
@@ -464,6 +463,7 @@ static void vdagent_chr_recv_clipboard(VDAgentChardev *vd, VDAgentMessage *msg)
              */
             return;
         }
+        info = qemu_clipboard_info_new(&vd->cbpeer, s);
         while (size >= sizeof(uint32_t)) {
             trace_vdagent_cb_grab_type(GET_NAME(type_name, *(uint32_t *)data));
             switch (*(uint32_t *)data) {
Signature · 1 line
2.31.1
Reviewed-by on v1 3/3
#8 lore raw

Re: [PATCH 3/3] ui/vdagent: fix clipboard info memory leak in error path

Quoted 18 lines · Stefan Hajnoczi

If the size of a VD_AGENT_CLIPBOARD_GRAB message is invalid we leak info when returning early.

Thanks to Coverity for spotting this:

*** CID 1453266: Resource leaks (RESOURCE_LEAK) /qemu/ui/vdagent.c: 465 in vdagent_chr_recv_clipboard()
459 info = qemu_clipboard_info_new(&vd->cbpeer, s);
460 if (size > sizeof(uint32_t) * 10) {
461 /*

462                  * spice has 6 types as of 2021. Limiting to 10 entries
463                  * so we we have some wiggle room.
464                  */
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

CID 1453266: Resource leaks (RESOURCE_LEAK)
Variable "info" going out of scope leaks the storage it points to.

465 return;
466 }
467 while (size >= sizeof(uint32_t)) {

Quoted 7 lines
468                 trace_vdagent_cb_grab_type(GET_NAME(type_name, *(uint32_t *)data));
469                 switch (*(uint32_t *)data) {
470                 case VD_AGENT_CLIPBOARD_UTF8_TEXT:
Fixes f0349f4d8947ad32d0fa4678cbf5dbb356fcbda1 ("ui/vdagent: add clipboard support")
Cc Gerd Hoffmann <[email protected]>