Changeset 240473 in webkit

Timestamp:

Jan 25, 2019 7:54:54 AM (5 years ago)

Author:

commit-queue@webkit.org

Message:

[GTK][WPE] Add API to add paths to sandbox
​https://bugs.webkit.org/show_bug.cgi?id=193571

This allows applications to add paths to the web process
if required by web extensions.

Patch by Patrick Griffis <Patrick Griffis> on 2019-01-25
Reviewed by Michael Catanzaro.

• UIProcess/API/glib/WebKitWebContext.cpp:

(webkit_web_context_add_path_to_sandbox):

• UIProcess/API/gtk/WebKitWebContext.h:
• UIProcess/API/gtk/docs/webkit2gtk-4.0-sections.txt:
• UIProcess/API/wpe/docs/wpe-0.1-sections.txt:
• UIProcess/Launcher/glib/BubblewrapLauncher.cpp:

(WebKit::bubblewrapSpawn):

• UIProcess/WebProcessPool.h:
• UIProcess/glib/WebProcessProxyGLib.cpp:

(WebKit::WebProcessProxy::platformGetLaunchOptions):

Location:

trunk/Source/WebKit

Files:

• ChangeLog (modified) (1 diff)
• UIProcess/API/glib/WebKitWebContext.cpp (modified) (2 diffs)
• UIProcess/API/gtk/WebKitWebContext.h (modified) (1 diff)
• UIProcess/API/gtk/docs/webkit2gtk-4.0-sections.txt (modified) (1 diff)
• UIProcess/API/wpe/WebKitWebContext.h (modified) (1 diff)
• UIProcess/API/wpe/docs/wpe-0.1-sections.txt (modified) (1 diff)
• UIProcess/Launcher/ProcessLauncher.h (modified) (2 diffs)
• UIProcess/Launcher/glib/BubblewrapLauncher.cpp (modified) (1 diff)
• UIProcess/WebProcessPool.h (modified) (2 diffs)
• UIProcess/glib/WebProcessProxyGLib.cpp (modified) (1 diff)

trunk/Source/WebKit/ChangeLog

@@ +1 @@
+2019-01-25  Patrick Griffis  <pgriffis@igalia.com>
+
+        [GTK][WPE] Add API to add paths to sandbox
+        https://bugs.webkit.org/show_bug.cgi?id=193571
+
+        This allows applications to add paths to the web process
+        if required by web extensions.
+
+        Reviewed by Michael Catanzaro.
+
+        * UIProcess/API/glib/WebKitWebContext.cpp:
+        (webkit_web_context_add_path_to_sandbox):
+        * UIProcess/API/gtk/WebKitWebContext.h:
+        * UIProcess/API/gtk/docs/webkit2gtk-4.0-sections.txt:
+        * UIProcess/API/wpe/docs/wpe-0.1-sections.txt:
+        * UIProcess/Launcher/glib/BubblewrapLauncher.cpp:
+        (WebKit::bubblewrapSpawn):
+        * UIProcess/WebProcessPool.h:
+        * UIProcess/glib/WebProcessProxyGLib.cpp:
+        (WebKit::WebProcessProxy::platformGetLaunchOptions):
+
 2019-01-24  Ryosuke Niwa  <rniwa@webkit.org>
 

trunk/Source/WebKit/UIProcess/API/glib/WebKitWebContext.cpp

@@ -1160 +1160 @@
  * This is only implemented on Linux and is a no-op otherwise.
  *
- * The web process is granted read-only access to the subdirectory matching g_get_prgname()
- * in `$XDG_CONFIG_HOME`, `$XDG_CACHE_HOME`, and `$XDG_DATA_HOME` if it exists before the
- * process is created. This behavior may change in the future.
- *
  * Since: 2.24
  */
@@ -1174 +1170 @@
 
     context->priv->processPool->setSandboxEnabled(enabled);
+}
+
+/**
+ * webkit_web_context_add_path_to_sandbox:
+ * @context: a #WebKitWebContext
+ * @path: (type filename): an absolute path to mount in the sandbox
+ * @read_only: if %TRUE the path will be read-only
+ *
+ * Adds a path to be mounted in the sandbox. @path must exist before any web process
+ * has been created otherwise it will be silently ignored. It is a fatal error to
+ * add paths after a web process has been spawned.
+ *
+ * See also webkit_web_context_set_sandbox_enabled()
+ *
+ * Since: 2.24
+ */
+void webkit_web_context_add_path_to_sandbox(WebKitWebContext* context, const char* path, gboolean readOnly)
+{
+    g_return_if_fail(WEBKIT_IS_WEB_CONTEXT(context));
+    g_return_if_fail(g_path_is_absolute(path));
+
+    if (context->priv->processPool->processes().size())
+        g_error("Sandbox paths cannot be changed after subprocesses were spawned.");
+
+    auto permission = readOnly ? SandboxPermission::ReadOnly : SandboxPermission::ReadWrite;
+    context->priv->processPool->addSandboxPath(path, permission);
 }
 

trunk/Source/WebKit/UIProcess/API/gtk/WebKitWebContext.h

@@ -255 +255 @@
 webkit_web_context_get_sandbox_enabled              (WebKitWebContext              *context);
 
+WEBKIT_API void
+webkit_web_context_add_path_to_sandbox              (WebKitWebContext              *context,
+                                                     const char                    *path,
+                                                     gboolean                       read_only);
+
 WEBKIT_API gboolean
 webkit_web_context_get_spell_checking_enabled       (WebKitWebContext              *context);

trunk/Source/WebKit/UIProcess/API/gtk/docs/webkit2gtk-4.0-sections.txt

@@ -54 +54 @@
 webkit_web_context_get_sandbox_enabled
 webkit_web_context_set_sandbox_enabled
+webkit_web_context_add_path_to_sandbox
 webkit_web_context_get_spell_checking_enabled
 webkit_web_context_set_spell_checking_enabled

trunk/Source/WebKit/UIProcess/API/wpe/WebKitWebContext.h

@@ -255 +255 @@
 webkit_web_context_get_sandbox_enabled              (WebKitWebContext              *context);
 
+WEBKIT_API void
+webkit_web_context_add_path_to_sandbox              (WebKitWebContext              *context,
+                                                     const char                    *path,
+                                                     gboolean                       read_only);
+
 WEBKIT_API gboolean
 webkit_web_context_get_spell_checking_enabled       (WebKitWebContext              *context);

trunk/Source/WebKit/UIProcess/API/wpe/docs/wpe-0.1-sections.txt

@@ -32 +32 @@
 webkit_web_context_get_sandbox_enabled
 webkit_web_context_set_sandbox_enabled
+webkit_web_context_add_path_to_sandbox
 webkit_web_context_get_spell_checking_enabled
 webkit_web_context_set_spell_checking_enabled

trunk/Source/WebKit/UIProcess/Launcher/ProcessLauncher.h

@@ -42 +42 @@
 namespace WebKit {
 
+#if PLATFORM(GTK) || PLATFORM(WPE)
+enum class SandboxPermission {
+    ReadOnly,
+    ReadWrite,
+};
+#endif
+
 class ProcessLauncher : public ThreadSafeRefCounted<ProcessLauncher>, public CanMakeWeakPtr<ProcessLauncher> {
 public:
@@ -69 +76 @@
         CString customWebContentServiceBundleIdentifier;
 
-#if ENABLE(DEVELOPER_MODE) && (PLATFORM(GTK) || PLATFORM(WPE))
+#if PLATFORM(GTK) || PLATFORM(WPE)
+        HashMap<CString, SandboxPermission> extraWebProcessSandboxPaths;
+#if ENABLE(DEVELOPER_MODE)
         String processCmdPrefix;
+#endif
 #endif
     };

trunk/Source/WebKit/UIProcess/Launcher/glib/BubblewrapLauncher.cpp

@@ -760 +760 @@
             bindX11(sandboxArgs);
 
-        // NOTE: This is not a great solution but we just assume that applications create this directory
-        // ahead of time if they require it.
-        GUniquePtr<char> configDir(g_build_filename(g_get_user_config_dir(), g_get_prgname(), nullptr));
-        GUniquePtr<char> cacheDir(g_build_filename(g_get_user_cache_dir(), g_get_prgname(), nullptr));
-        GUniquePtr<char> dataDir(g_build_filename(g_get_user_data_dir(), g_get_prgname(), nullptr));
-
-        sandboxArgs.appendVector(Vector<CString>({
-            "--ro-bind-try", cacheDir.get(), cacheDir.get(),
-            "--ro-bind-try", configDir.get(), configDir.get(),
-            "--ro-bind-try", dataDir.get(), dataDir.get(),
-        }));
+        for (const auto& pathAndPermission : launchOptions.extraWebProcessSandboxPaths) {
+            sandboxArgs.appendVector(Vector<CString>({
+                pathAndPermission.value == SandboxPermission::ReadOnly ? "--ro-bind-try": "--bind-try",
+                pathAndPermission.key, pathAndPermission.key
+            }));
+        }
 
         Vector<String> extraPaths = { "applicationCacheDirectory", "waylandSocket"};

trunk/Source/WebKit/UIProcess/WebProcessPool.h

@@ -470 +470 @@
 #if PLATFORM(GTK) || PLATFORM(WPE)
     void setSandboxEnabled(bool enabled) { m_sandboxEnabled = enabled; };
+    void addSandboxPath(const CString& path, SandboxPermission permission) { m_extraSandboxPaths.add(path, permission); };
+    const HashMap<CString, SandboxPermission>& sandboxPaths() const { return m_extraSandboxPaths; };
     bool sandboxEnabled() const { return m_sandboxEnabled; };
 #endif
@@ -729 +731 @@
 #if PLATFORM(GTK) || PLATFORM(WPE)
     bool m_sandboxEnabled { false };
+    HashMap<CString, SandboxPermission> m_extraSandboxPaths;
 #endif
 };

trunk/Source/WebKit/UIProcess/glib/WebProcessProxyGLib.cpp

@@ -45 +45 @@
     launchOptions.extraInitializationData.set("applicationCacheDirectory", websiteDataStore().resolvedApplicationCacheDirectory());
 
+    launchOptions.extraWebProcessSandboxPaths = m_processPool->sandboxPaths();
+
 #if PLATFORM(WAYLAND) && USE(EGL)
     if (PlatformDisplay::sharedDisplay().type() == PlatformDisplay::Type::Wayland) {