Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix plugin install errors #484

Merged
merged 2 commits into from
Mar 7, 2024
Merged

Fix plugin install errors #484

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
543099b
Return an error when an illegal path is used to prevent Zip and Tar slip
mostafa Mar 7, 2024
b60173d
Don't resolve file paths to absolute paths
mostafa Mar 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 55 additions & 30 deletions cmd/plugin_install.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,14 +59,15 @@ const (
)

var (
pluginOutputDir string
pullOnly bool
cleanup bool
update bool
backupConfig bool
noPrompt bool
pluginName string
overwriteConfig bool
pluginOutputDir string
pullOnly bool
cleanup bool
update bool
backupConfig bool
noPrompt bool
pluginName string
overwriteConfig bool
skipPathSlipVerification bool
)

// pluginInstallCmd represents the plugin install command.
Expand Down Expand Up @@ -228,12 +229,14 @@ func init() {
&pluginName, "name", "n", "", "Name of the plugin (only for installing from archive files)")
pluginInstallCmd.Flags().BoolVar(
&overwriteConfig, "overwrite-config", true, "Overwrite the existing plugins configuration file (overrides --update, only used for installing from the plugins configuration file)") //nolint:lll
pluginInstallCmd.Flags().BoolVar(
&skipPathSlipVerification, "skip-path-slip-verification", false, "Skip path slip verification when extracting the plugin archive from a TRUSTED source") //nolint:lll
pluginInstallCmd.Flags().BoolVar(
&enableSentry, "sentry", true, "Enable Sentry") // Already exists in run.go
}

// extractZip extracts the files from a zip archive.
func extractZip(filename, dest string) ([]string, error) {
func extractZip(filename, dest string) ([]string, *gerr.GatewayDError) {
// Open and extract the zip file.
zipRc, err := zip.OpenReader(filename)
if err != nil {
Expand Down Expand Up @@ -265,7 +268,8 @@ func extractZip(filename, dest string) ([]string, error) {
outFilename := filepath.Join(filepath.Clean(dest), filepath.Clean(fileOrDir.Name))

// Check for ZipSlip.
if strings.HasPrefix(outFilename, string(os.PathSeparator)) {
if !skipPathSlipVerification &&
strings.HasPrefix(outFilename, string(os.PathSeparator)) {
return nil, gerr.ErrExtractFailed.Wrap(
fmt.Errorf("illegal file path: %s", outFilename))
}
Expand Down Expand Up @@ -313,7 +317,7 @@ func extractZip(filename, dest string) ([]string, error) {
}

// extractTarGz extracts the files from a tar.gz archive.
func extractTarGz(filename, dest string) ([]string, error) {
func extractTarGz(filename, dest string) ([]string, *gerr.GatewayDError) {
// Open and extract the tar.gz file.
gzipStream, err := os.Open(filename)
if err != nil {
Expand Down Expand Up @@ -362,8 +366,10 @@ func extractTarGz(filename, dest string) ([]string, error) {
outFilename := path.Join(filepath.Clean(dest), filepath.Clean(header.Name))

// Check for TarSlip.
if strings.HasPrefix(outFilename, string(os.PathSeparator)) {
return nil, gerr.ErrExtractFailed.Wrap(err)
if !skipPathSlipVerification &&
strings.HasPrefix(outFilename, string(os.PathSeparator)) {
return nil, gerr.ErrExtractFailed.Wrap(
fmt.Errorf("illegal file path: %s", outFilename))
}

// Create the file.
Expand Down Expand Up @@ -417,8 +423,11 @@ func findAsset(release *github.RepositoryRelease, match func(string) bool) (stri

// downloadFile downloads the plugin from the given GitHub URL from the release assets.
func downloadFile(
client *github.Client, account, pluginName string, releaseID int64, filename string,
) (string, error) {
client *github.Client,
account, pluginName string,
releaseID int64,
filename, outputDir string,
) (string, *gerr.GatewayDError) {
// Download the plugin.
readCloser, redirectURL, err := client.Repositories.DownloadReleaseAsset(
context.Background(), account, pluginName, releaseID, http.DefaultClient)
Expand Down Expand Up @@ -452,11 +461,17 @@ func downloadFile(
}

// Create the output file in the current directory and write the downloaded content.
cwd, err := os.Getwd()
if err != nil {
return "", gerr.ErrDownloadFailed.Wrap(err)
var filePath string
if outputDir == "" || !filepath.IsAbs(outputDir) {
cwd, err := os.Getwd()
if err != nil {
return "", gerr.ErrDownloadFailed.Wrap(err)
}
filePath = path.Join([]string{cwd, filename}...)
} else {
filePath = path.Join([]string{outputDir, filename}...)
}
filePath := path.Join([]string{cwd, filename}...)

output, err := os.Create(filePath)
if err != nil {
return "", gerr.ErrDownloadFailed.Wrap(err)
Expand Down Expand Up @@ -618,24 +633,31 @@ func installPlugin(cmd *cobra.Command, pluginURL string) {
return
}

// Create the output directory if it doesn't exist.
if err := os.MkdirAll(pluginOutputDir, FolderPermissions); err != nil {
cmd.Println("There was an error creating the output directory: ", err)
return
}

// Find and download the plugin binary from the release assets.
pluginFilename, downloadURL, releaseID = findAsset(release, func(name string) bool {
return strings.Contains(name, runtime.GOOS) &&
strings.Contains(name, runtime.GOARCH) &&
strings.Contains(name, string(archiveExt))
})
var filePath string
if downloadURL != "" && releaseID != 0 {
cmd.Println("Downloading", downloadURL)
filePath, err = downloadFile(client, account, pluginName, releaseID, pluginFilename)
filePath, gErr := downloadFile(
client, account, pluginName, releaseID, pluginFilename, pluginOutputDir)
toBeDeleted = append(toBeDeleted, filePath)
if err != nil {
cmd.Println("Download failed: ", err)
if gErr != nil {
cmd.Println("Download failed: ", gErr)
if cleanup {
deleteFiles(toBeDeleted)
}
return
}
cmd.Println("File downloaded to", filePath)
cmd.Println("Download completed successfully")
} else {
cmd.Println("The plugin file could not be found in the release assets")
Expand All @@ -648,15 +670,17 @@ func installPlugin(cmd *cobra.Command, pluginURL string) {
})
if checksumsFilename != "" && downloadURL != "" && releaseID != 0 {
cmd.Println("Downloading", downloadURL)
filePath, err = downloadFile(client, account, pluginName, releaseID, checksumsFilename)
filePath, gErr := downloadFile(
client, account, pluginName, releaseID, checksumsFilename, pluginOutputDir)
toBeDeleted = append(toBeDeleted, filePath)
if err != nil {
cmd.Println("Download failed: ", err)
if gErr != nil {
cmd.Println("Download failed: ", gErr)
if cleanup {
deleteFiles(toBeDeleted)
}
return
}
cmd.Println("File downloaded to", filePath)
cmd.Println("Download completed successfully")
} else {
cmd.Println("The checksum file could not be found in the release assets")
Expand Down Expand Up @@ -779,18 +803,19 @@ func installPlugin(cmd *cobra.Command, pluginURL string) {

// Extract the archive.
var filenames []string
var gErr *gerr.GatewayDError
switch archiveExt {
case ExtensionZip:
filenames, err = extractZip(pluginFilename, pluginOutputDir)
filenames, gErr = extractZip(pluginFilename, pluginOutputDir)
case ExtensionTarGz:
filenames, err = extractTarGz(pluginFilename, pluginOutputDir)
filenames, gErr = extractTarGz(pluginFilename, pluginOutputDir)
default:
cmd.Println("Invalid archive extension")
return
}

if err != nil {
cmd.Println("There was an error extracting the plugin archive: ", err)
if gErr != nil {
cmd.Println("There was an error extracting the plugin archive:", gErr)
if cleanup {
deleteFiles(toBeDeleted)
}
Expand Down
1 change: 1 addition & 0 deletions errors/errors.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ const (
ErrCodeAsyncAction
ErrCodeEvalError
ErrCodeMsgEncodeError
ErrCodePathSlipError
)

var (
Expand Down