CLI: Allow relative symlinks in zip archives when installing plugins (#50537) (#50877)

Earlier we only allowed symlinks in plugins starting with grafana- in zip archives when installing plugins using the grafana-cli. This changes so that symlinks in zip archives containing relative links to files in the zip archive are always allowed when installing plugins. The reasoning behind this is that Grafana per default doesn't load a plugin that has an invalid plugin signature meaning that any symlink must be included in the plugin signature manifest. Co-authored-by: Will Browne <will.browne@grafana.com> Co-authored-by: Will Browne <wbrowne@users.noreply.github.com> (cherry picked from commit b47ec36d0d)
2022-06-15 17:06:08 +02:00
parent dd29063198
commit e0d1f9aedc
18 changed files with 397 additions and 889 deletions
@@ -92,17 +92,8 @@ func New(skipTLSVerify bool, grafanaVersion string, logger Logger) plugins.Insta
 // Install downloads the plugin code as a zip file from specified URL
 // and then extracts the zip into the provided plugins directory.
 func (i *Installer) Install(ctx context.Context, pluginID, version, pluginsDir, pluginZipURL, pluginRepoURL string) error {
-	isInternal := false
-
 	var checksum string
 	if pluginZipURL == "" {
-		if strings.HasPrefix(pluginID, "grafana-") {
-			// At this point the plugin download is going through grafana.com API and thus the name is validated.
-			// Checking for grafana prefix is how it is done there so no 3rd party plugin should have that prefix.
-			// You can supply custom plugin name and then set custom download url to 3rd party plugin but then that
-			// is up to the user to know what she is doing.
-			isInternal = true
-		}
 		plugin, err := i.getPluginMetadataFromPluginRepo(pluginID, pluginRepoURL)
 		if err != nil {
 			return err
@@ -157,7 +148,7 @@ func (i *Installer) Install(ctx context.Context, pluginID, version, pluginsDir,
 		return errutil.Wrap("failed to close tmp file", err)
 	}

-	err = i.extractFiles(tmpFile.Name(), pluginID, pluginsDir, isInternal)
+	err = i.extractFiles(tmpFile.Name(), pluginID, pluginsDir)
 	if err != nil {
 		return errutil.Wrap("failed to extract plugin archive", err)
 	}
@@ -509,7 +500,7 @@ func latestSupportedVersion(plugin *Plugin) *Version {
 	return nil
 }

-func (i *Installer) extractFiles(archiveFile string, pluginID string, dest string, allowSymlinks bool) error {
+func (i *Installer) extractFiles(archiveFile string, pluginID string, dest string) error {
 	var err error
 	dest, err = filepath.Abs(dest)
 	if err != nil {
@@ -575,11 +566,7 @@ func (i *Installer) extractFiles(archiveFile string, pluginID string, dest strin
 		}

 		if isSymlink(zf) {
-			if !allowSymlinks {
-				i.log.Warnf("%v: plugin archive contains a symlink, which is not allowed. Skipping", zf.Name)
-				continue
-			}
-			if err := extractSymlink(zf, dstPath); err != nil {
+			if err := extractSymlink(existingInstallDir, zf, dstPath); err != nil {
 				i.log.Warn("failed to extract symlink", "err", err)
 				continue
 			}
@@ -598,7 +585,7 @@ func isSymlink(file *zip.File) bool {
 	return file.Mode()&os.ModeSymlink == os.ModeSymlink
 }

-func extractSymlink(file *zip.File, filePath string) error {
+func extractSymlink(basePath string, file *zip.File, filePath string) error {
 	// symlink target is the contents of the file
 	src, err := file.Open()
 	if err != nil {
@@ -608,12 +595,39 @@ func extractSymlink(file *zip.File, filePath string) error {
 	if _, err := io.Copy(buf, src); err != nil {
 		return errutil.Wrap("failed to copy symlink contents", err)
 	}
-	if err := os.Symlink(strings.TrimSpace(buf.String()), filePath); err != nil {
+
+	symlinkPath := strings.TrimSpace(buf.String())
+	if !isSymlinkRelativeTo(basePath, symlinkPath, filePath) {
+		return errutil.Wrapf(err, "symlink %q pointing outside plugin directory is not allowed", filePath)
+	}
+
+	if err := os.Symlink(symlinkPath, filePath); err != nil {
 		return errutil.Wrapf(err, "failed to make symbolic link for %v", filePath)
 	}
 	return nil
 }

+// isSymlinkRelativeTo checks whether symlinkDestPath is relative to basePath.
+// symlinkOrigPath is the path to file holding the symbolic link.
+func isSymlinkRelativeTo(basePath string, symlinkDestPath string, symlinkOrigPath string) bool {
+	if filepath.IsAbs(symlinkDestPath) {
+		return false
+	} else {
+		fileDir := filepath.Dir(symlinkOrigPath)
+		cleanPath := filepath.Clean(filepath.Join(fileDir, "/", symlinkDestPath))
+		p, err := filepath.Rel(basePath, cleanPath)
+		if err != nil {
+			return false
+		}
+
+		if strings.HasPrefix(p, ".."+string(filepath.Separator)) {
+			return false
+		}
+	}
+
+	return true
+}
+
 func extractFile(file *zip.File, filePath string) (err error) {
 	fileMode := file.Mode()
 	// This is entry point for backend plugins so we want to make them executable
@@ -0,0 +1,358 @@
+package installer
+
+import (
+	"context"
+	"fmt"
+	"io/ioutil"
+	"os"
+	"path/filepath"
+	"runtime"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestInstall(t *testing.T) {
+	testDir := "./testdata/tmpInstallPluginDir"
+	err := os.Mkdir(testDir, os.ModePerm)
+	require.NoError(t, err)
+
+	t.Cleanup(func() {
+		err = os.RemoveAll(testDir)
+		require.NoError(t, err)
+	})
+
+	pluginID := "test-app"
+
+	i := &Installer{log: &fakeLogger{}}
+	err = i.Install(context.Background(), pluginID, "", testDir, "./testdata/plugin-with-symlinks.zip", "")
+	require.NoError(t, err)
+
+	// verify extracted contents
+	files, err := ioutil.ReadDir(filepath.Join(testDir, pluginID))
+	require.NoError(t, err)
+	require.Len(t, files, 6)
+	require.Equal(t, files[0].Name(), "MANIFEST.txt")
+	require.Equal(t, files[1].Name(), "dashboards")
+	require.Equal(t, files[2].Name(), "extra")
+	require.Equal(t, os.ModeSymlink, files[2].Mode()&os.ModeSymlink)
+	require.Equal(t, files[3].Name(), "plugin.json")
+	require.Equal(t, files[4].Name(), "symlink_to_txt")
+	require.Equal(t, os.ModeSymlink, files[4].Mode()&os.ModeSymlink)
+	require.Equal(t, files[5].Name(), "text.txt")
+}
+
+func TestUninstall(t *testing.T) {
+	i := &Installer{log: &fakeLogger{}}
+
+	pluginDir := t.TempDir()
+	pluginJSON := filepath.Join(pluginDir, "plugin.json")
+	_, err := os.Create(pluginJSON)
+	require.NoError(t, err)
+
+	err = i.Uninstall(context.Background(), pluginDir)
+	require.NoError(t, err)
+
+	_, err = os.Stat(pluginDir)
+	require.True(t, os.IsNotExist(err))
+
+	t.Run("Uninstall will search in nested dir folder for plugin.json", func(t *testing.T) {
+		pluginDistDir := filepath.Join(t.TempDir(), "dist")
+		err = os.Mkdir(pluginDistDir, os.ModePerm)
+		require.NoError(t, err)
+		pluginJSON = filepath.Join(pluginDistDir, "plugin.json")
+		_, err = os.Create(pluginJSON)
+		require.NoError(t, err)
+
+		pluginDir = filepath.Dir(pluginDistDir)
+
+		err = i.Uninstall(context.Background(), pluginDir)
+		require.NoError(t, err)
+
+		_, err = os.Stat(pluginDir)
+		require.True(t, os.IsNotExist(err))
+	})
+
+	t.Run("Uninstall will not delete folder if cannot recognize plugin structure", func(t *testing.T) {
+		pluginDir = t.TempDir()
+		err = i.Uninstall(context.Background(), pluginDir)
+		require.EqualError(t, err, fmt.Sprintf("tried to remove %s, but it doesn't seem to be a plugin", pluginDir))
+
+		_, err = os.Stat(pluginDir)
+		require.False(t, os.IsNotExist(err))
+	})
+}
+
+func TestExtractFiles(t *testing.T) {
+	i := &Installer{log: &fakeLogger{}}
+	pluginsDir := setupFakePluginsDir(t)
+
+	t.Run("Should preserve file permissions for plugin backend binaries for linux and darwin", func(t *testing.T) {
+		skipWindows(t)
+
+		archive := filepath.Join("testdata", "grafana-simple-json-datasource-ec18fa4da8096a952608a7e4c7782b4260b41bcf.zip")
+		err := i.extractFiles(archive, "grafana-simple-json-datasource", pluginsDir)
+		require.NoError(t, err)
+
+		// File in zip has permissions 755
+		fileInfo, err := os.Stat(filepath.Join(pluginsDir, "grafana-simple-json-datasource", "simple-plugin_darwin_amd64"))
+		require.NoError(t, err)
+		require.Equal(t, "-rwxr-xr-x", fileInfo.Mode().String())
+
+		// File in zip has permission 755
+		fileInfo, err = os.Stat(pluginsDir + "/grafana-simple-json-datasource/simple-plugin_linux_amd64")
+		require.NoError(t, err)
+		require.Equal(t, "-rwxr-xr-x", fileInfo.Mode().String())
+
+		// File in zip has permission 644
+		fileInfo, err = os.Stat(pluginsDir + "/grafana-simple-json-datasource/simple-plugin_windows_amd64.exe")
+		require.NoError(t, err)
+		require.Equal(t, "-rw-r--r--", fileInfo.Mode().String())
+
+		// File in zip has permission 755
+		fileInfo, err = os.Stat(pluginsDir + "/grafana-simple-json-datasource/non-plugin-binary")
+		require.NoError(t, err)
+		require.Equal(t, "-rwxr-xr-x", fileInfo.Mode().String())
+	})
+
+	t.Run("Should extract file with relative symlink", func(t *testing.T) {
+		skipWindows(t)
+
+		err := i.extractFiles("testdata/plugin-with-symlink.zip", "plugin-with-symlink", pluginsDir)
+		require.NoError(t, err)
+
+		_, err = os.Stat(pluginsDir + "/plugin-with-symlink/symlink_to_txt")
+		require.NoError(t, err)
+
+		target, err := filepath.EvalSymlinks(pluginsDir + "/plugin-with-symlink/symlink_to_txt")
+		require.NoError(t, err)
+		require.Equal(t, pluginsDir+"/plugin-with-symlink/text.txt", target)
+	})
+
+	t.Run("Should extract directory with relative symlink", func(t *testing.T) {
+		skipWindows(t)
+
+		err := i.extractFiles("testdata/plugin-with-symlink-dir.zip", "plugin-with-symlink-dir", pluginsDir)
+		require.NoError(t, err)
+
+		_, err = os.Stat(pluginsDir + "/plugin-with-symlink-dir/symlink_to_dir")
+		require.NoError(t, err)
+
+		target, err := filepath.EvalSymlinks(pluginsDir + "/plugin-with-symlink-dir/symlink_to_dir")
+		require.NoError(t, err)
+		require.Equal(t, pluginsDir+"/plugin-with-symlink-dir/dir", target)
+	})
+
+	t.Run("Should not extract file with absolute symlink", func(t *testing.T) {
+		skipWindows(t)
+
+		err := i.extractFiles("testdata/plugin-with-absolute-symlink.zip", "plugin-with-absolute-symlink", pluginsDir)
+		require.NoError(t, err)
+
+		_, err = os.Stat(pluginsDir + "/plugin-with-absolute-symlink/test.txt")
+		require.True(t, os.IsNotExist(err))
+	})
+
+	t.Run("Should not extract directory with absolute symlink", func(t *testing.T) {
+		skipWindows(t)
+
+		err := i.extractFiles("testdata/plugin-with-absolute-symlink-dir.zip", "plugin-with-absolute-symlink-dir", pluginsDir)
+		require.NoError(t, err)
+
+		_, err = os.Stat(pluginsDir + "/plugin-with-absolute-symlink-dir/target")
+		require.True(t, os.IsNotExist(err))
+	})
+
+	t.Run("Should detect if archive members point outside of the destination directory", func(t *testing.T) {
+		err := i.extractFiles("testdata/plugin-with-parent-member.zip", "plugin-with-parent-member", pluginsDir)
+		require.EqualError(t, err, fmt.Sprintf(
+			`archive member "../member.txt" tries to write outside of plugin directory: %q, this can be a security risk`,
+			pluginsDir,
+		))
+	})
+
+	t.Run("Should detect if archive members are absolute", func(t *testing.T) {
+		err := i.extractFiles("testdata/plugin-with-absolute-member.zip", "plugin-with-absolute-member", pluginsDir)
+		require.EqualError(t, err, fmt.Sprintf(
+			`archive member "/member.txt" tries to write outside of plugin directory: %q, this can be a security risk`,
+			pluginsDir,
+		))
+	})
+}
+
+func TestSelectVersion(t *testing.T) {
+	i := &Installer{log: &fakeLogger{}}
+
+	t.Run("Should return error when requested version does not exist", func(t *testing.T) {
+		_, err := i.selectVersion(createPlugin(versionArg{version: "version"}), "1.1.1")
+		require.Error(t, err)
+	})
+
+	t.Run("Should return error when no version supports current arch", func(t *testing.T) {
+		_, err := i.selectVersion(createPlugin(versionArg{version: "version", arch: []string{"non-existent"}}), "")
+		require.Error(t, err)
+	})
+
+	t.Run("Should return error when requested version does not support current arch", func(t *testing.T) {
+		_, err := i.selectVersion(createPlugin(
+			versionArg{version: "2.0.0"},
+			versionArg{version: "1.1.1", arch: []string{"non-existent"}},
+		), "1.1.1")
+		require.Error(t, err)
+	})
+
+	t.Run("Should return latest available for arch when no version specified", func(t *testing.T) {
+		ver, err := i.selectVersion(createPlugin(
+			versionArg{version: "2.0.0", arch: []string{"non-existent"}},
+			versionArg{version: "1.0.0"},
+		), "")
+		require.NoError(t, err)
+		require.Equal(t, "1.0.0", ver.Version)
+	})
+
+	t.Run("Should return latest version when no version specified", func(t *testing.T) {
+		ver, err := i.selectVersion(createPlugin(versionArg{version: "2.0.0"}, versionArg{version: "1.0.0"}), "")
+		require.NoError(t, err)
+		require.Equal(t, "2.0.0", ver.Version)
+	})
+
+	t.Run("Should return requested version", func(t *testing.T) {
+		ver, err := i.selectVersion(createPlugin(versionArg{version: "2.0.0"}, versionArg{version: "1.0.0"}), "1.0.0")
+		require.NoError(t, err)
+		require.Equal(t, "1.0.0", ver.Version)
+	})
+}
+
+func TestRemoveGitBuildFromName(t *testing.T) {
+	// The root directory should get renamed to the plugin name
+	paths := map[string]string{
+		"datasource-plugin-kairosdb-cc4a3965ef5d3eb1ae0ee4f93e9e78ec7db69e64/":                     "datasource-kairosdb/",
+		"datasource-plugin-kairosdb-cc4a3965ef5d3eb1ae0ee4f93e9e78ec7db69e64/README.md":            "datasource-kairosdb/README.md",
+		"datasource-plugin-kairosdb-cc4a3965ef5d3eb1ae0ee4f93e9e78ec7db69e64/partials/":            "datasource-kairosdb/partials/",
+		"datasource-plugin-kairosdb-cc4a3965ef5d3eb1ae0ee4f93e9e78ec7db69e64/partials/config.html": "datasource-kairosdb/partials/config.html",
+	}
+	for p, exp := range paths {
+		name := removeGitBuildFromName(p, "datasource-kairosdb")
+		require.Equal(t, exp, name)
+	}
+}
+
+func TestIsSymlinkRelativeTo(t *testing.T) {
+	tcs := []struct {
+		desc            string
+		basePath        string
+		symlinkDestPath string
+		symlinkOrigPath string
+		expected        bool
+	}{
+		{
+			desc:            "Symbolic link pointing to relative file within basePath should return true",
+			basePath:        "/dir",
+			symlinkDestPath: "test.txt",
+			symlinkOrigPath: "/dir/sub-dir/test1.txt",
+			expected:        true,
+		},
+		{
+			desc:            "Symbolic link pointing to relative file within basePath should return true",
+			basePath:        "/dir",
+			symlinkDestPath: "test.txt",
+			symlinkOrigPath: "/dir/test1.txt",
+			expected:        true,
+		},
+		{
+			desc:            "Symbolic link pointing to relative file within basePath should return true",
+			basePath:        "/dir",
+			symlinkDestPath: "../etc/test.txt",
+			symlinkOrigPath: "/dir/sub-dir/test1.txt",
+			expected:        true,
+		},
+		{
+			desc:            "Symbolic link pointing to absolute directory outside basePath should return false",
+			basePath:        "/dir",
+			symlinkDestPath: "/etc/test.txt",
+			symlinkOrigPath: "/dir/sub-dir/test1.txt",
+			expected:        false,
+		},
+		{
+			desc:            "Symbolic link pointing to relative file outside basePath should return false",
+			basePath:        "/dir",
+			symlinkDestPath: "../../etc/test.txt",
+			symlinkOrigPath: "/dir/sub-dir/test1.txt",
+			expected:        false,
+		},
+	}
+
+	for _, tc := range tcs {
+		t.Run(tc.desc, func(t *testing.T) {
+			actual := isSymlinkRelativeTo(tc.basePath, tc.symlinkDestPath, tc.symlinkOrigPath)
+			require.Equal(t, tc.expected, actual)
+		})
+	}
+}
+
+func setupFakePluginsDir(t *testing.T) string {
+	dir := "testdata/fake-plugins-dir"
+	err := os.RemoveAll(dir)
+	require.NoError(t, err)
+
+	err = os.MkdirAll(dir, 0750)
+	require.NoError(t, err)
+	t.Cleanup(func() {
+		err = os.RemoveAll(dir)
+		require.NoError(t, err)
+	})
+
+	dir, err = filepath.Abs(dir)
+	require.NoError(t, err)
+
+	return dir
+}
+
+func skipWindows(t *testing.T) {
+	if runtime.GOOS == "windows" {
+		t.Skip("Skipping test on Windows")
+	}
+}
+
+type versionArg struct {
+	version string
+	arch    []string
+}
+
+func createPlugin(versions ...versionArg) *Plugin {
+	p := &Plugin{
+		Versions: []Version{},
+	}
+
+	for _, version := range versions {
+		ver := Version{
+			Version: version.version,
+			Commit:  fmt.Sprintf("commit_%s", version.version),
+			URL:     fmt.Sprintf("url_%s", version.version),
+		}
+		if version.arch != nil {
+			ver.Arch = map[string]ArchMeta{}
+			for _, arch := range version.arch {
+				ver.Arch[arch] = ArchMeta{
+					SHA256: fmt.Sprintf("sha256_%s", arch),
+				}
+			}
+		}
+		p.Versions = append(p.Versions, ver)
+	}
+
+	return p
+}
+
+type fakeLogger struct{}
+
+func (f *fakeLogger) Successf(_ string, _ ...interface{}) {}
+func (f *fakeLogger) Failuref(_ string, _ ...interface{}) {}
+func (f *fakeLogger) Info(_ ...interface{})               {}
+func (f *fakeLogger) Infof(_ string, _ ...interface{})    {}
+func (f *fakeLogger) Debug(_ ...interface{})              {}
+func (f *fakeLogger) Debugf(_ string, _ ...interface{})   {}
+func (f *fakeLogger) Warn(_ ...interface{})               {}
+func (f *fakeLogger) Warnf(_ string, _ ...interface{})    {}
+func (f *fakeLogger) Error(_ ...interface{})              {}
+func (f *fakeLogger) Errorf(_ string, _ ...interface{})   {}