Changeset 105087 in vbox for trunk/src/VBox/Main/xml

Timestamp:

Jul 1, 2024 11:27:59 PM (7 months ago)

Author:

vboxsync

Message:

doc/manual,include/VBox,Frontends/VBoxManage,HostServices/SharedFolders,
Main/{include,SharedFolder,Console,Machine,VirtualBox.xidl}: Add a
new attribute to ISharedFolder for specifying a symbolic link creation
policy to restrict the source pathname when creating symbolic links
within a guest. The symbolic link policies are represented by a new
enumeration of type SymlinkPolicy_T which includes values for no
restrictions ('any'), symlink sources only within the subtree of the
share ('subtree'), symlink sources as any relative path ('relative'),
and no symlinks allowed ('forbidden'). The symlink policy can only be
applied to permanent shared folders at this stage. bugref:10619

Location:

trunk/src/VBox/Main/xml

Files:

• Settings.cpp (modified) (5 diffs)
• VirtualBox-settings.xsd (modified) (2 diffs)

trunk/src/VBox/Main/xml/Settings.cpp

@@ -3793 +3793 @@
 SharedFolder::SharedFolder() :
     fWritable(false),
-    fAutoMount(false)
+    fAutoMount(false),
+    enmSymlinkPolicy(SymlinkPolicy_None)
 {
 }
@@ -3809 +3810 @@
             && fWritable         == g.fWritable
             && fAutoMount        == g.fAutoMount
-            && strAutoMountPoint == g.strAutoMountPoint);
+            && strAutoMountPoint == g.strAutoMountPoint
+            && enmSymlinkPolicy  == g.enmSymlinkPolicy);
 }
 
@@ -5992 +5994 @@
                 pelmFolder->getAttributeValue("autoMount", sf.fAutoMount);
                 pelmFolder->getAttributeValue("autoMountPoint", sf.strAutoMountPoint);
+
+                Utf8Str strTemp;
+                if (pelmFolder->getAttributeValue("symlinkPolicy", strTemp))
+                {
+                    if (strTemp == "forbidden")
+                        sf.enmSymlinkPolicy = SymlinkPolicy_Forbidden;
+                    else if (strTemp == "subtree")
+                        sf.enmSymlinkPolicy = SymlinkPolicy_AllowedInShareSubtree;
+                    else if (strTemp == "relative")
+                        sf.enmSymlinkPolicy = SymlinkPolicy_AllowedToRelativeTargets;
+                    else if (strTemp == "any")
+                        sf.enmSymlinkPolicy = SymlinkPolicy_AllowedToAnyTarget;
+                    else
+                        throw ConfigFileError(this,
+                                              pelmHwChild,
+                                              N_("Invalid value '%s' in SharedFolder/@symlinkPolicy attribute"),
+                                              strTemp.c_str());
+                }
                 hw.llSharedFolders.push_back(sf);
             }
@@ -8309 +8329 @@
             if (sf.strAutoMountPoint.isNotEmpty())
                 pelmThis->setAttribute("autoMountPoint", sf.strAutoMountPoint);
+            const char *pcszSymlinkPolicy;
+            if (sf.enmSymlinkPolicy != SymlinkPolicy_None)
+            {
+                switch (sf.enmSymlinkPolicy)
+                {
+                    default: /*case SymlinkPolicy_Forbidden:*/    pcszSymlinkPolicy = "forbidden";  break;
+                    case SymlinkPolicy_AllowedInShareSubtree:     pcszSymlinkPolicy = "subtree";    break;
+                    case SymlinkPolicy_AllowedToRelativeTargets:  pcszSymlinkPolicy = "relative";   break;
+                    case SymlinkPolicy_AllowedToAnyTarget:        pcszSymlinkPolicy = "any";        break;
+                }
+                pelmThis->setAttribute("symlinkPolicy", pcszSymlinkPolicy);
+            }
         }
     }
@@ -9531 +9563 @@
             return;
         }
+
+        // VirtualBox 7.1 (settings v1.20) adds support for customizable control over Shared Folders symlink creation.
+        if (hardwareMachine.llSharedFolders.size())
+        {
+            for (SharedFoldersList::const_iterator it = hardwareMachine.llSharedFolders.begin();
+                 it != hardwareMachine.llSharedFolders.end();
+                 ++it)
+            {
+                if (it->enmSymlinkPolicy != SymlinkPolicy_None)
+                {
+                    m->sv = SettingsVersion_v1_20;
+                    return;
+                }
+            }
+        }
     }
 

trunk/src/VBox/Main/xml/VirtualBox-settings.xsd

@@ -301 +301 @@
     <xsd:enumeration value="VBoxSVGA"/>
     <xsd:enumeration value="QemuRamFB"/>
+  </xsd:restriction>
+</xsd:simpleType>
+
+<xsd:simpleType name="TSymlinkPolicy"> <!-- new since v1.20. -->
+  <xsd:restriction base="xsd:token">
+    <xsd:enumeration value="forbidden"/>
+    <xsd:enumeration value="subtree"/>
+    <xsd:enumeration value="relative"/>
+    <xsd:enumeration value="any"/>
   </xsd:restriction>
 </xsd:simpleType>
@@ -1305 +1314 @@
   <xsd:attribute name="autoMount" type="xsd:boolean" default="false"/>
   <xsd:attribute name="autoMountPoint" type="xsd:string"/>
+  <xsd:attribute name="symlinkPolicy" type="TSymlinkPolicy" default="forbidden"/> <!-- new since v1.20. -->
 </xsd:complexType>