Files
pmg/internal/shim/system_test.go
T
Sahilb315 4b2a25a378 fix: gate SUDO_USER trust and root path diversion; add doctor binary check
Address review findings on the system-install PR:

- cloud_sink: honor SUDO_USER for audit attribution only when euid==0.
  Without the gate any user could set SUDO_USER and spoof cloud-audit
  attribution to another account. Matches the guard in cmd/setup/cert.go.

- config: divert per-user paths to root's passwd home only on an actual
  sudo elevation (euid==0 && SUDO_USER set), not for every root euid.
  The blanket root diversion ignored HOME/XDG_CONFIG_HOME and silently
  stopped reading genuine root users' config (golden Docker images),
  regressing two tests that only fail when the suite runs as root.
  Genuine root honors the environment as before; su without - leaves no
  marker and stays a documented, loud-failing residual.

- doctor: add a system-only check re-validating that the binary the
  installed shims exec is still root-owned and non-writable, catching
  permission/ownership drift after install.

- shim: fold the duplicated shim-scan loop into firstShimContent.
2026-07-14 13:07:27 +05:30

213 lines
6.3 KiB
Go

package shim
import (
"os"
"path/filepath"
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func useSystemPaths(t *testing.T, dir string) {
t.Helper()
systemBinDirOverride = filepath.Join(dir, "bin")
systemProfilePathOverride = filepath.Join(dir, "profile.d", "pmg.sh")
systemExecutableOwnershipCheck = false
// The go-build test binary is group-writable under a 002 umask, which the
// executable validation rightly rejects. Point resolution at a crafted
// 0755 binary so the manager validates a realistic path, not the harness.
exe := filepath.Join(dir, "pmg")
require.NoError(t, os.WriteFile(exe, []byte("#!/bin/sh\n"), 0o755))
resolveExecutable = func() (string, error) { return exe, nil }
t.Cleanup(func() {
systemBinDirOverride = ""
systemProfilePathOverride = ""
systemExecutableOwnershipCheck = true
resolveExecutable = currentExecutable
})
}
func TestSystemShimManagerInstallAndRemove(t *testing.T) {
root := t.TempDir()
useSystemPaths(t, root)
mgr, err := NewSystemShimManager()
require.NoError(t, err)
assert.True(t, mgr.config.SkipShellRc)
assert.True(t, mgr.config.ManageProfile)
assert.Equal(t, SystemBinDir(), mgr.GetBinDir())
require.NoError(t, mgr.Install())
assert.True(t, SystemShimsInstalled())
assert.True(t, SystemProfileInstalled())
npmShim := filepath.Join(SystemBinDir(), "npm")
content, err := os.ReadFile(npmShim)
require.NoError(t, err)
assert.Contains(t, string(content), "export PMG_SHIM_PATH")
assert.Contains(t, string(content), "pmg setup install")
assert.Contains(t, string(content), "pmg setup remove")
profile, err := os.ReadFile(SystemProfilePath())
require.NoError(t, err)
assert.Contains(t, string(profile), mgr.GetBinDir())
assert.Contains(t, string(profile), systemProfileMarker)
require.NoError(t, mgr.Install())
profile2, err := os.ReadFile(SystemProfilePath())
require.NoError(t, err)
assert.Equal(t, string(profile), string(profile2))
require.NoError(t, mgr.Remove())
assert.False(t, SystemShimsInstalled())
assert.False(t, SystemProfileInstalled())
require.NoError(t, mgr.Remove())
}
func TestSystemShimManagerDoesNotTouchUserRc(t *testing.T) {
root := t.TempDir()
useSystemPaths(t, root)
home := t.TempDir()
bashrc := filepath.Join(home, ".bashrc")
require.NoError(t, os.WriteFile(bashrc, []byte("# user bashrc\n"), 0o644))
mgr, err := NewSystemShimManager()
require.NoError(t, err)
mgr.config.HomeDir = home
require.NoError(t, mgr.Install())
content, err := os.ReadFile(bashrc)
require.NoError(t, err)
assert.Equal(t, "# user bashrc\n", string(content))
}
func TestSystemShimsInstalledIgnoresUnmanagedFiles(t *testing.T) {
root := t.TempDir()
useSystemPaths(t, root)
require.NoError(t, os.MkdirAll(SystemBinDir(), 0o755))
require.NoError(t, os.WriteFile(filepath.Join(SystemBinDir(), "README"), []byte("not a shim"), 0o644))
assert.False(t, SystemShimsInstalled())
require.NoError(t, os.WriteFile(
filepath.Join(SystemBinDir(), "npm"),
[]byte("#!/bin/sh\n# PMG shim - do not edit, managed by pmg setup\n"),
0o755,
))
assert.True(t, SystemShimsInstalled())
}
func TestWriteSystemProfileRepairsStalePath(t *testing.T) {
root := t.TempDir()
useSystemPaths(t, root)
require.NoError(t, os.MkdirAll(filepath.Dir(SystemProfilePath()), 0o755))
require.NoError(t, os.WriteFile(
SystemProfilePath(),
[]byte("# PMG system shims\nexport PATH=\"/stale/path:$PATH\"\n"),
0o644,
))
binDir := filepath.Join(root, "custom-bin")
require.NoError(t, writeSystemProfile(binDir))
content, err := os.ReadFile(SystemProfilePath())
require.NoError(t, err)
assert.Contains(t, string(content), binDir)
assert.NotContains(t, string(content), "/stale/path")
assert.NotContains(t, string(content), SystemBinDir())
}
func TestValidateSystemExecutableRejectsPrivateBinary(t *testing.T) {
systemExecutableOwnershipCheck = false
t.Cleanup(func() { systemExecutableOwnershipCheck = true })
privateDir := t.TempDir()
privateExecutable := filepath.Join(privateDir, "pmg")
require.NoError(t, os.WriteFile(privateExecutable, []byte("binary"), 0o700))
err := validateSystemExecutable(privateExecutable)
require.Error(t, err)
assert.Contains(t, err.Error(), "not executable by all users")
}
func TestValidateSystemExecutableRejectsGroupWritable(t *testing.T) {
systemExecutableOwnershipCheck = false
t.Cleanup(func() { systemExecutableOwnershipCheck = true })
dir := t.TempDir()
path := filepath.Join(dir, "pmg")
require.NoError(t, os.WriteFile(path, []byte("binary"), 0o755))
require.NoError(t, os.Chmod(path, 0o775))
err := validateSystemExecutable(path)
require.Error(t, err)
assert.Contains(t, err.Error(), "writable by group or others")
}
func TestValidateSystemExecutableRejectsNonRootOwner(t *testing.T) {
if os.Geteuid() == 0 {
t.Skip("running as root: temp file is root-owned, so the owner check passes")
}
dir := t.TempDir()
path := filepath.Join(dir, "pmg")
require.NoError(t, os.WriteFile(path, []byte("binary"), 0o755))
err := validateSystemExecutable(path)
require.Error(t, err)
assert.Contains(t, err.Error(), "must be owned by root")
}
func TestSystemShimBinaryResolvesInstalledPath(t *testing.T) {
root := t.TempDir()
useSystemPaths(t, root)
exe := filepath.Join(root, "pmg")
require.NoError(t, os.WriteFile(exe, []byte("#!/bin/sh\n"), 0o755))
resolveExecutable = func() (string, error) { return exe, nil }
mgr, err := NewSystemShimManager()
require.NoError(t, err)
require.NoError(t, mgr.Install())
got, ok := SystemShimBinary()
require.True(t, ok)
assert.Equal(t, exe, got)
}
func TestSystemShimBinaryFalseWhenNoShims(t *testing.T) {
root := t.TempDir()
useSystemPaths(t, root)
require.NoError(t, os.MkdirAll(SystemBinDir(), 0o755))
_, ok := SystemShimBinary()
assert.False(t, ok)
}
func TestParseShimPMGBinRoundTripsShellQuote(t *testing.T) {
for _, path := range []string{"/usr/local/bin/pmg", "/opt/pmg dir/pmg", "/weird/o'brien/pmg"} {
content := "#!/bin/sh\n" + shimScriptMarker + "\nPMG_BIN=" + shellQuote(path) + "\n"
got, ok := parseShimPMGBin(content)
require.True(t, ok, path)
assert.Equal(t, path, got)
}
}
func TestNewSystemShimManagerForRemoveSkipsValidation(t *testing.T) {
root := t.TempDir()
useSystemPaths(t, root)
systemExecutableOwnershipCheck = true
mgr, err := NewSystemShimManagerForRemove()
require.NoError(t, err)
require.NoError(t, mgr.Install())
require.NoError(t, mgr.Remove())
}