mirror of
https://github.com/safedep/pmg.git
synced 2026-08-03 07:24:09 +02:00
feat: Add proxy_install_only config to restrict proxy to download commands
Introduces proxy_install_only (default: false) which, when enabled, skips the proxy for package manager commands that do not download packages (e.g. npm ls, pip list), avoiding unnecessary MITM overhead. - Add ProxyInstallOnly to Config and config template - Add IsKnownDownloadCommand / MayDownloadPackages to ParsedCommand - Add DownloadCommands to npm and pypi PM configs covering update, ci, audit, dlx, exec, x, download, run and equivalents per PM - Extract shared runner.Execute used by both proxy flow and guard - Proxy flow short-circuits to runner.Execute for non-download commands when proxy_install_only=true
This commit is contained in:
@@ -70,6 +70,11 @@ type Config struct {
|
||||
// we initially introduced it as an experimental feature.
|
||||
ExperimentalProxyMode bool `mapstructure:"experimental_proxy_mode"`
|
||||
|
||||
// ProxyInstallOnly restricts proxy interception to install commands only.
|
||||
// When false (default), proxy runs for all package manager commands.
|
||||
// When true, non-install commands (e.g., npm ls, pip list) bypass the proxy and execute directly.
|
||||
ProxyInstallOnly bool `mapstructure:"proxy_install_only"`
|
||||
|
||||
// Verbosity controls the UI verbosity level. Valid values: "silent", "normal", "verbose".
|
||||
Verbosity string `mapstructure:"verbosity"`
|
||||
|
||||
|
||||
@@ -36,6 +36,12 @@ event_log_retention_days: 7
|
||||
# and can be disabled to fall back to the guard-based analysis.
|
||||
proxy_mode: true
|
||||
|
||||
# Restrict proxy to install commands only. Default is false.
|
||||
# When false, the proxy intercepts all package manager commands (e.g., npm install, npm ls).
|
||||
# When true, non-install commands bypass the proxy and execute directly, which can improve
|
||||
# performance for commands that don't download packages (e.g., npm ls, pip list, npm outdated).
|
||||
proxy_install_only: false
|
||||
|
||||
# Trusted packages are packages that are trusted by the user and will be ignored by the security guardrails.
|
||||
# This is useful for packages that are known to be safe and are used in the application.
|
||||
# Example:
|
||||
|
||||
@@ -27,6 +27,7 @@ func TestConfigHasDefaultValues(t *testing.T) {
|
||||
assert.Equal(t, []TrustedPackage{}, config.Config.TrustedPackages)
|
||||
assert.Equal(t, "/tmp/pmg-test/random-does-not-exist", config.configDir)
|
||||
assert.Equal(t, "/tmp/pmg-test/random-does-not-exist/config.yml", config.configFilePath)
|
||||
assert.Equal(t, false, config.Config.ProxyInstallOnly)
|
||||
})
|
||||
|
||||
t.Run("when no config directory is set", func(t *testing.T) {
|
||||
@@ -103,6 +104,26 @@ func TestPartialConfigWithNestedOverride(t *testing.T) {
|
||||
assert.Equal(t, defaults.ProxyMode, config.Config.ProxyMode)
|
||||
}
|
||||
|
||||
func TestProxyInstallOnlyConfig(t *testing.T) {
|
||||
t.Run("defaults to false", func(t *testing.T) {
|
||||
t.Setenv("PMG_CONFIG_DIR", "/tmp/pmg-test/random-does-not-exist")
|
||||
initConfig()
|
||||
assert.Equal(t, false, Get().Config.ProxyInstallOnly)
|
||||
})
|
||||
|
||||
t.Run("can be set to true via config file", func(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
t.Setenv("PMG_CONFIG_DIR", tmpDir)
|
||||
|
||||
configPath := filepath.Join(tmpDir, "config.yml")
|
||||
err := os.WriteFile(configPath, []byte("proxy_install_only: true\n"), 0o644)
|
||||
require.NoError(t, err)
|
||||
|
||||
initConfig()
|
||||
assert.Equal(t, true, Get().Config.ProxyInstallOnly)
|
||||
})
|
||||
}
|
||||
|
||||
func TestWriteTemplateConfigMergesExistingConfig(t *testing.T) {
|
||||
tmpDir := t.TempDir()
|
||||
t.Setenv("PMG_CONFIG_DIR", tmpDir)
|
||||
|
||||
Reference in New Issue
Block a user