Implement experimental REST API endpoints for plugins (#7279)

* Implement experimental REST API endpoints for plugins

* Updates per feedback and rebase

* Update tests

* Further updates

* Update extraction of plugins

* Use OS temp dir for plugins instead of search path

* Fail extraction on paths that attempt to traverse upward

* Update pluginenv ActivePlugins()
This commit is contained in:
Joram Wilander
2017-09-01 09:00:27 -04:00
committed by GitHub
parent 74b5e52c4e
commit 899ab31fff
28 changed files with 965 additions and 76 deletions

83
utils/extract.go Normal file
View File

@@ -0,0 +1,83 @@
// Copyright (c) 2017-present Mattermost, Inc. All Rights Reserved.
// See License.txt for license information.
package utils
import (
"archive/tar"
"compress/gzip"
"fmt"
"io"
"os"
"path/filepath"
)
// ExtractTarGz takes in an io.Reader containing the bytes for a .tar.gz file and
// a destination string to extract to. A list of the file and directory names that
// were extracted is returned.
func ExtractTarGz(gzipStream io.Reader, dst string) ([]string, error) {
uncompressedStream, err := gzip.NewReader(gzipStream)
if err != nil {
return nil, fmt.Errorf("ExtractTarGz: NewReader failed: %s", err.Error())
}
defer uncompressedStream.Close()
tarReader := tar.NewReader(uncompressedStream)
filenames := []string{}
for true {
header, err := tarReader.Next()
if err == io.EOF {
break
}
if err != nil {
return nil, fmt.Errorf("ExtractTarGz: Next() failed: %s", err.Error())
}
switch header.Typeflag {
case tar.TypeDir:
if PathTraversesUpward(header.Name) {
return nil, fmt.Errorf("ExtractTarGz: path attempts to traverse upwards")
}
path := filepath.Join(dst, header.Name)
if err := os.Mkdir(path, 0744); err != nil && !os.IsExist(err) {
return nil, fmt.Errorf("ExtractTarGz: Mkdir() failed: %s", err.Error())
}
filenames = append(filenames, header.Name)
case tar.TypeReg:
if PathTraversesUpward(header.Name) {
return nil, fmt.Errorf("ExtractTarGz: path attempts to traverse upwards")
}
path := filepath.Join(dst, header.Name)
dir := filepath.Dir(path)
if err := os.MkdirAll(dir, 0744); err != nil {
return nil, fmt.Errorf("ExtractTarGz: MkdirAll() failed: %s", err.Error())
}
outFile, err := os.Create(path)
if err != nil {
return nil, fmt.Errorf("ExtractTarGz: Create() failed: %s", err.Error())
}
defer outFile.Close()
if _, err := io.Copy(outFile, tarReader); err != nil {
return nil, fmt.Errorf("ExtractTarGz: Copy() failed: %s", err.Error())
}
filenames = append(filenames, header.Name)
default:
return nil, fmt.Errorf(
"ExtractTarGz: unknown type: %v in %v",
header.Typeflag,
header.Name)
}
}
return filenames, nil
}

15
utils/path.go Normal file
View File

@@ -0,0 +1,15 @@
// Copyright (c) 2017-present Mattermost, Inc. All Rights Reserved.
// See License.txt for license information.
package utils
import (
"path/filepath"
"strings"
)
// PathTraversesUpward will return true if the path attempts to traverse upwards by using
// ".." in the path.
func PathTraversesUpward(path string) bool {
return strings.HasPrefix(filepath.Clean(path), "..")
}

31
utils/path_test.go Normal file
View File

@@ -0,0 +1,31 @@
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See License.txt for license information.
package utils
import (
"testing"
"github.com/stretchr/testify/assert"
)
func TestPathTraversesUpward(t *testing.T) {
cases := []struct {
input string
expected bool
}{
{"../test/path", true},
{"../../test/path", true},
{"../../test/../path", true},
{"test/../../path", true},
{"test/path/../../", false},
{"test", false},
{"test/path", false},
{"test/path/", false},
{"test/path/file.ext", false},
}
for _, c := range cases {
assert.Equal(t, c.expected, PathTraversesUpward(c.input), c.input)
}
}