Changeset 105087 in vbox for trunk/src/VBox/Main/src-all

Timestamp:

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

Author:

vboxsync

svn:sync-xref-src-repo-rev:

163708

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/src-all

Files:

• ConsoleSharedFolderImpl.cpp (modified) (4 diffs)
• SharedFolderImpl.cpp (modified) (10 diffs)

trunk/src/VBox/Main/src-all/ConsoleSharedFolderImpl.cpp

@@ -44 +44 @@
     Data()
     : fWritable(false),
-      fAutoMount(false)
+      fAutoMount(false),
+      enmSymlinkPolicy(SymlinkPolicy_None)
     { }
 
@@ -53 +54 @@
     const Utf8Str   strAutoMountPoint;
     Utf8Str         strLastAccessError;
+    SymlinkPolicy_T enmSymlinkPolicy;
 };
 
@@ -305 +307 @@
 }
 
+HRESULT ConsoleSharedFolder::getSymlinkPolicy(SymlinkPolicy_T *aSymlinkPolicy)
+{
+    AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
+    *aSymlinkPolicy = m->enmSymlinkPolicy;
+    return S_OK;
+}
+
+HRESULT ConsoleSharedFolder::setSymlinkPolicy(SymlinkPolicy_T aSymlinkPolicy)
+{
+    RT_NOREF(aSymlinkPolicy);
+    return E_NOTIMPL;
+}
 
 const Utf8Str& ConsoleSharedFolder::i_getName() const
@@ -331 +345 @@
 }
 
+const SymlinkPolicy_T ConsoleSharedFolder::i_getSymlinkPolicy() const
+{
+    return m->enmSymlinkPolicy;
+}
+
 /* vi: set tabstop=4 shiftwidth=4 expandtab: */

trunk/src/VBox/Main/src-all/SharedFolderImpl.cpp

@@ -46 +46 @@
     Data()
     : fWritable(false),
-      fAutoMount(false)
+      fAutoMount(false),
+      enmSymlinkPolicy(SymlinkPolicy_None)
     { }
 
@@ -55 +56 @@
     const Utf8Str   strAutoMountPoint;
     Utf8Str         strLastAccessError;
+    SymlinkPolicy_T enmSymlinkPolicy;
 };
 
@@ -100 +102 @@
  *  @param aAutoMountPoint Where the guest should try auto mount it.
  *  @param fFailOnError Whether to fail with an error if the shared folder path is bad.
+ *  @param enmSymlinkPolicy The symbolic link creation policy to apply.
  *
  *  @return          COM result indicator
@@ -109 +112 @@
                            bool aAutoMount,
                            const Utf8Str &aAutoMountPoint,
-                           bool fFailOnError)
+                           bool fFailOnError,
+                           SymlinkPolicy_T enmSymlinkPolicy)
 {
     /* Enclose the state transition NotReady->InInit->Ready */
@@ -117 +121 @@
     unconst(mMachine) = aMachine;
 
-    HRESULT hrc = i_protectedInit(aMachine, aName, aHostPath, aWritable, aAutoMount, aAutoMountPoint, fFailOnError);
+    HRESULT hrc = i_protectedInit(aMachine, aName, aHostPath, aWritable, aAutoMount, aAutoMountPoint, fFailOnError,
+                                  enmSymlinkPolicy);
 
     /* Confirm a successful initialization when it's the case */
@@ -152 +157 @@
                                   aThat->m->fAutoMount,
                                   aThat->m->strAutoMountPoint,
-                                  false /* fFailOnError */ );
+                                  false /* fFailOnError */,
+                                  aThat->m->enmSymlinkPolicy);
 
     /* Confirm a successful initialization when it's the case */
@@ -214 +220 @@
                                       bool aAutoMount,
                                       const Utf8Str &aAutoMountPoint,
-                                      bool fFailOnError)
-{
-    LogFlowThisFunc(("aName={%s}, aHostPath={%s}, aWritable={%d}, aAutoMount={%d}\n",
-                      aName.c_str(), aHostPath.c_str(), aWritable, aAutoMount));
+                                      bool fFailOnError,
+                                      SymlinkPolicy_T enmSymlinkPolicy)
+{
+    LogFlowThisFunc(("aName={%s}, aHostPath={%s}, aWritable={%d}, aAutoMount={%d} enmSymlinkPolicy={%d}\n",
+                      aName.c_str(), aHostPath.c_str(), aWritable, aAutoMount, enmSymlinkPolicy));
 
     ComAssertRet(aParent && aName.isNotEmpty() && aHostPath.isNotEmpty(), E_INVALIDARG);
@@ -271 +278 @@
     m->fAutoMount = aAutoMount;
     unconst(m->strAutoMountPoint) = aAutoMountPoint;
+    m->enmSymlinkPolicy = enmSymlinkPolicy;
 
     return S_OK;
@@ -385 +393 @@
 }
 
+HRESULT SharedFolder::getSymlinkPolicy(SymlinkPolicy_T *aSymlinkPolicy)
+{
+    AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
+    *aSymlinkPolicy = m->enmSymlinkPolicy;
+    return S_OK;
+}
+
+HRESULT SharedFolder::setSymlinkPolicy(SymlinkPolicy_T aSymlinkPolicy)
+{
+    switch (aSymlinkPolicy)
+    {
+        case SymlinkPolicy_AllowedToAnyTarget:
+        case SymlinkPolicy_AllowedInShareSubtree:
+        case SymlinkPolicy_AllowedToRelativeTargets:
+        case SymlinkPolicy_Forbidden:
+            break;
+        default:
+            return setError(E_INVALIDARG, tr("The symbolic link policy specified (%d) is invalid."), aSymlinkPolicy);
+    }
+
+    AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
+    m->enmSymlinkPolicy = aSymlinkPolicy;
+    return S_OK;
+}
 
 const Utf8Str& SharedFolder::i_getName() const
@@ -411 +443 @@
 }
 
+const SymlinkPolicy_T SharedFolder::i_getSymlinkPolicy() const
+{
+    return m->enmSymlinkPolicy;
+}
+
 /* vi: set tabstop=4 shiftwidth=4 expandtab: */