[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#977872: ITP: golang-github-cli-safeexec -- safer version of exec.LookPath on Windows



Package: wnpp
Severity: wishlist
Owner: Anthony Fok <foka@debian.org>

* Package name    : golang-github-cli-safeexec
  Version         : 1.0.0-1
  Upstream Author : Mislav Marohnić <mislav@github.com>, GitHub Inc.
* URL             : https://github.com/cli/safeexec
* License         : BSD-2-clause
  Programming Lang: Go
  Description     : safer version of exec.LookPath on Windows

 safeexec is a Go module that provides a safer alternative to exec.LookPath()
 on Windows.
 .
 The following, relatively common approach to running external commands
 has a subtle vulnerability on Windows:
 .
   import "os/exec"
 .
   func gitStatus() error {
       // On Windows, this will result in .\git.exe or .\git.bat being executed
       // if either were found in the current working directory.
       cmd := exec.Command("git", "status") return cmd.Run()
   }
 .
 Searching the current directory (surprising behavior) before searching
 folders listed in the PATH environment variable (expected behavior)
 seems to be intended in Go and unlikely to be changed:
 https://github.com/golang/go/issues/38736
 .
 Since Go does not provide a version of exec.LookPath() that only searches
 PATH and does not search the current working directory, this module provides
 a LookPath function that works consistently across platforms.
 .
 Example use:
 .
   import (
       "os/exec" "github.com/cli/safeexec"
   )
 .
   func gitStatus() error {
       gitBin, err := safeexec.LookPath("git")
       if err != nil {
           return err
       }
       cmd := exec.Command(gitBin, "status")
       return cmd.Run()
   }


Reason for packaging: Needed by hugo 0.79.1 and up


Reply to: