Changeset 70086 in vbox

Timestamp:

Dec 12, 2017 5:36:51 PM (7 years ago)

Author:

vboxsync

Message:

Guest properties: Added a length check for GuestPropWriteFlags() and got rid of strcpy(), as this now also is marked as being deprecated on macOS.

Location:

trunk

Files:

• include/VBox/HostServices/GuestPropertySvc.h (modified) (3 diffs)
• src/VBox/HostServices/GuestProperties/service.cpp (modified) (5 diffs)
• src/VBox/HostServices/GuestProperties/testcase/tstGuestPropSvc.cpp (modified) (3 diffs)
• src/VBox/Main/src-client/ConsoleImpl2.cpp (modified) (1 diff)
• src/VBox/Main/src-server/MachineImpl.cpp (modified) (4 diffs)

trunk/include/VBox/HostServices/GuestPropertySvc.h

@@ -164 +164 @@
 /**
  * Write out flags to a string.
+ *
  * @returns  IPRT status code
- * @param    fFlags    the flags to write out
- * @param    pszFlags  where to write the flags string.  This must point to
- *                     a buffer of size (at least) MAX_FLAGS_LEN.
- */
-DECLINLINE(int) GuestPropWriteFlags(uint32_t fFlags, char *pszFlags)
+ * @param    fFlags    The flags to write out.
+ * @param    pszFlags  Where to write the flags string.
+ * @param    cbFlags   The size of the destination buffer (in bytes).
+ */
+DECLINLINE(int) GuestPropWriteFlags(uint32_t fFlags, char* pszFlags, size_t cbFlags)
 {
     /* Putting READONLY before the other RDONLY flags keeps the result short. */
@@ -181 +182 @@
     if ((fFlags & ~GUEST_PROP_F_ALLFLAGS) == GUEST_PROP_F_NILFLAG)
     {
-        char *pszNext;
-        unsigned i;
-
         /* TRANSRESET implies TRANSIENT.  For compatability with old clients we
            always set TRANSIENT when TRANSRESET appears. */
@@ -189 +187 @@
             fFlags |= GUEST_PROP_F_TRANSIENT;
 
-        pszNext = pszFlags;
-        for (i = 0; i < RT_ELEMENTS(s_aFlagList); ++i)
+        char *pszTemp = NULL;
+
+        for (unsigned i = 0; i < RT_ELEMENTS(s_aFlagList); ++i)
         {
             if (s_aFlagList[i] == (fFlags & s_aFlagList[i]))
             {
-                strcpy(pszNext, GuestPropFlagName(s_aFlagList[i]));
-                pszNext += GuestPropFlagNameLen(s_aFlagList[i]);
+                RTStrAAppend(&pszTemp, GuestPropFlagName(s_aFlagList[i]));
                 fFlags &= ~s_aFlagList[i];
                 if (fFlags != GUEST_PROP_F_NILFLAG)
-                {
-                    strcpy(pszNext, ", ");
-                    pszNext += 2;
-                }
+                    RTStrAAppend(&pszTemp, ", ");
             }
         }
-        *pszNext = '\0';
+
+        if (   RT_SUCCESS(rc)
+            && pszTemp)
+            rc = RTStrCopy(pszFlags, cbFlags, pszTemp);
+
+        if (pszTemp)
+            RTStrFree(pszTemp);
 
         Assert(fFlags == GUEST_PROP_F_NILFLAG); /* bad s_aFlagList */

trunk/src/VBox/HostServices/GuestProperties/service.cpp

@@ -619 +619 @@
     {
         char szFlags[GUEST_PROP_MAX_FLAGS_LEN];
-        rc = GuestPropWriteFlags(pProp->mFlags, szFlags);
+        rc = GuestPropWriteFlags(pProp->mFlags, szFlags, sizeof(szFlags));
         if (RT_SUCCESS(rc))
         {
@@ -857 +857 @@
 
     char            szFlags[GUEST_PROP_MAX_FLAGS_LEN];
-    int rc = GuestPropWriteFlags(pProp->mFlags, szFlags);
+    int rc = GuestPropWriteFlags(pProp->mFlags, szFlags, sizeof(szFlags));
     if (RT_FAILURE(rc))
         return rc;
@@ -1016 +1016 @@
     {
         char szFlags[GUEST_PROP_MAX_FLAGS_LEN];
-        rc = GuestPropWriteFlags(prop.mFlags, szFlags);
+        rc = GuestPropWriteFlags(prop.mFlags, szFlags, sizeof(szFlags));
         if (RT_SUCCESS(rc))
         {
@@ -1215 +1215 @@
             /* Send out a host notification */
             const char *pszValue = prop.mValue.c_str();
-            rc = GuestPropWriteFlags(prop.mFlags, szFlags);
+            rc = GuestPropWriteFlags(prop.mFlags, szFlags, sizeof(szFlags));
             if (RT_SUCCESS(rc))
                 rc = notifyHost(pszProperty, pszValue, u64Timestamp, szFlags);
@@ -1406 +1406 @@
 
     char szFlags[GUEST_PROP_MAX_FLAGS_LEN];
-    int rc = GuestPropWriteFlags(pProp->mFlags, szFlags);
+    int rc = GuestPropWriteFlags(pProp->mFlags, szFlags, sizeof(szFlags));
     if (RT_FAILURE(rc))
         RTStrPrintf(szFlags, sizeof(szFlags), "???");

trunk/src/VBox/HostServices/GuestProperties/testcase/tstGuestPropSvc.cpp

@@ -120 +120 @@
         if (RT_SUCCESS(rc))
         {
-            rc = GuestPropWriteFlags(fFlags, pszFlagBuffer);
+            rc = GuestPropWriteFlags(fFlags, pszFlagBuffer, GUEST_PROP_MAX_FLAGS_LEN);
             if (RT_FAILURE(rc))
                 RTTestIFailed("Failed to convert flag string '%s' back to a string.",
@@ -159 +159 @@
         RTTestISub("Rejection of an invalid flags field");
         /* This is required to fail. */
-        if (RT_SUCCESS(GuestPropWriteFlags(u32BadFlags, pszFlagBuffer)))
+        if (RT_SUCCESS(GuestPropWriteFlags(u32BadFlags, pszFlagBuffer, GUEST_PROP_MAX_FLAGS_LEN)))
         {
             RTTestIFailed("Flags 0x%x were incorrectly written out as '%.*s'\n",
@@ -828 +828 @@
     {
         char szFlags[GUEST_PROP_MAX_FLAGS_LEN];
-        if (RT_FAILURE(GuestPropWriteFlags(fFlags, szFlags)))
+        if (RT_FAILURE(GuestPropWriteFlags(fFlags, szFlags, sizeof(szFlags))))
             RTTestIFailed("Failed to set the global flags.");
         else

trunk/src/VBox/Main/src-client/ConsoleImpl2.cpp

@@ -5974 +5974 @@
     {
         char szFlags[GUEST_PROP_MAX_FLAGS_LEN];
-        if (RT_FAILURE(GuestPropWriteFlags(fFlags, szFlags)))
+        if (RT_FAILURE(GuestPropWriteFlags(fFlags, szFlags, sizeof(szFlags))))
             Log(("Failed to set the global flags.\n"));
         else

trunk/src/VBox/Main/src-server/MachineImpl.cpp

@@ -5655 +5655 @@
         aValue = it->second.strValue;
         *aTimestamp = it->second.mTimestamp;
-        GuestPropWriteFlags(it->second.mFlags, szFlags);
+        GuestPropWriteFlags(it->second.mFlags, szFlags, sizeof(szFlags));
         aFlags = Utf8Str(szFlags);
     }
@@ -5937 +5937 @@
         aValues[i] = it->second.strValue;
         aTimestamps[i] = it->second.mTimestamp;
-        GuestPropWriteFlags(it->second.mFlags, szFlags);
+        GuestPropWriteFlags(it->second.mFlags, szFlags, sizeof(szFlags));
         aFlags[i] = Utf8Str(szFlags);
     }
@@ -10452 +10452 @@
             prop.timestamp = property.mTimestamp;
             char szFlags[GUEST_PROP_MAX_FLAGS_LEN + 1];
-            GuestPropWriteFlags(property.mFlags, szFlags);
+            GuestPropWriteFlags(property.mFlags, szFlags, sizeof(szFlags));
             prop.strFlags = szFlags;
 
@@ -13537 +13537 @@
         if (it->second.mFlags)
         {
-            GuestPropWriteFlags(it->second.mFlags, szFlags);
+            GuestPropWriteFlags(it->second.mFlags, szFlags, sizeof(szFlags));
             aFlags[i] = szFlags;
         }