Files
pmg/config/proxy_optout.go
Sahil BansalandGitHub 94781d6bda Remove guard mode: proxy interception is now the only flow (#386)
* refactor: remove guard mode execution paths and guard-only packages

Guard (non-proxy) mode is removed; all package-manager commands now
always run the proxy flow. Removes the guard engine, the common flow,
the extractor package, the npm/pypi dependency resolvers and the
PackageResolver plumbing that only guard mode consumed.

The guard package retains only PackageManagerGuardInteraction, which
the proxy flow and confirmation interceptors reuse for user prompts.
Proxy behavior is unchanged.

* refactor: remove proxy opt-out surfaces, guard references in config, action and docs

Removes Config.ProxyMode, ProxyConfig.Enabled, IsProxyModeEnabled, the
proxy_mode legacy fallback, PMG_PROXY_ENABLED handling and the
--proxy-mode / --include-dev-dependencies flags. Proxy interception can
no longer be disabled.

Also removes the proxy-mode input from the GitHub Action, the
proxy-mode doctor check and setup info row, updates the E2E workflow to
stop passing --proxy-mode=false, and sweeps guard-mode wording from
docs and the config template.

The legacy proxy_install_only flat key and PMG_PROXY_INSTALL_ONLY env
var remain supported. audit.FlowTypeGuard is kept so previously
recorded audit events still translate for cloud sync.

* feat: fail loudly when a removed proxy opt-out is still configured

A leftover proxy.enabled: false / proxy_mode: false config key or
PMG_PROXY_ENABLED=false / PMG_PROXY_MODE=false env var previously meant
guard mode; silently ignoring it would switch those users to proxy
interception without notice. PMG now exits with an actionable error
naming the exact source. Precedence mirrors the old resolution order:
env (ignored under lockdown) > proxy.enabled > legacy proxy_mode.

The pmg config subtree is exempt so the config file can still be fixed
with pmg config edit/set. The GitHub Action's proxy-mode input is kept
as a tombstone that fails the action when set to false and warns
otherwise.

* refactor: extract flows.RunProxy and address review findings

Collapses the identical parse-then-run body duplicated across the 12
package manager commands into flows.RunProxy. Documents the cache-hit /
offline analysis trade-off versus the removed guard manifest path,
fixes a stale non-proxy label in the E2E workflow and a stale guard
reference in the uvx parser comment.

* fix(config): mirror old proxy opt-out precedence exactly

PMG_PROXY_MODE only ever took effect through the legacy fallback, which
was gated on the presence of a proxy: key in the config file (even a
null one). Promoting it to the top env tier caused two inversions: a
stale PMG_PROXY_MODE=false hard-failed configs that resolved to proxy
mode, and PMG_PROXY_MODE=true silently overrode an explicit
proxy.enabled: false file opt-out. The check now resolves in the old
order: PMG_PROXY_ENABLED > proxy: section (presence gates the legacy
tier) > PMG_PROXY_MODE > flat proxy_mode.

parseOptOutBool also accepts numeric values (0 = false) to match
viper's WeaklyTypedInput/cast.ToBool coercion, so proxy.enabled: 0 and
proxy_mode: 0 are detected as opt-outs.

* refactor: move package manager interaction out of guard

* refactor: trim package manager interaction

* fix(config): normalize config keys viper-style in proxy opt-out check

Viper resolved config file keys case-insensitively and expanded dotted
keys, so spellings like Proxy:, Enabled:, a literal proxy.enabled key or
Proxy_Mode selected guard mode before the removal. The opt-out check now
lowercases keys recursively and nests dotted keys before matching, so
those existing opt-outs fail loudly instead of being silently ignored.

* refactor: remove inert transitive controls, dead parser state and guard audit variant

transitive / transitive_depth lost their only consumers with the
dependency resolvers; remove the config fields, flags, template and doc
entries, and the report/audit plumbing that misreported transitive
analysis as enabled.

Remove write-only parser state (PackageInstallTarget.Extras,
ParsedCommand.ManifestFiles, ShouldExtractFromManifest); IsManifestInstall
stays as it feeds sandbox gating via IsInstallationCommand.

Remove audit.FlowTypeGuard and its cloud mapping; guard events recorded
by pre-removal versions in an unsynced WAL translate to UNSPECIFIED.

* fix: address review findings on the opt-out wiring and cleanups

Move the removed-opt-out rejection from the CLI PersistentPreRun into
proxyFlow.Run: the check now fires exactly for package-manager runs, so
non-install commands (pmg setup remove, doctor, config, version) stay
usable to fix or remove an opted-out installation, and future commands
inherit or avoid the check by construction instead of by exemption list.

Also: make the e2e malicious-package assertion actually fail the job
when an install is not blocked, route pmg go through flows.RunProxy,
and drop the dead extras return from pypiParsePackageInfo (extras are
still stripped from package names).

* fix(config): make the removed opt-out check faithful to the old resolution

The gate that silenced the legacy proxy_mode surfaces matched the raw
proxy key case-sensitively in the old code, while values resolved
viper-style (case-insensitive, dotted keys); applying each semantic
where the old code did fixes both divergences: a case-variant Proxy:
section no longer hides a flat proxy_mode: false opt-out, and a dotted
proxy.enabled: false overridden by proxy_mode: true no longer errors.

Replace the generic key-tree normalization with two targeted lookups
(the check only ever resolves proxy.enabled and proxy_mode), which also
makes colliding spellings resolve deterministically. Coerce legacy-tier
values cast.ToBool-style so PMG_PROXY_MODE=off style opt-outs are
detected, log the config read error instead of swallowing it, and
shorten the error to a one-line statement with the specific remedy in
the help text.

Add lockdown coverage (env inert both directions) and a repeated-run
determinism test.

* fix(config): fall back to defaults for unrecognized proxy opt-out values

The old loader swallowed viper errors and ran on defaults, so values
like proxy.enabled: yes or PMG_PROXY_ENABLED=banana silently discarded
the whole config and defaulted to proxy. Treat them the same way now:
unrecognized values mean the default (proxy on) instead of a hard
error, and the doc comment no longer claims the old loader failed
loudly. Only values that actually meant guard mode fail.

Also check the removed opt-out before the CA trust check in pmg go,
restoring the old error precedence: a config problem must not steer
the user into an unnecessary OS trust store change.

* fix(e2e): PMG_PROXY_MODE assertion must match the legacy gate semantics

The runner's setup step writes the template config, which has a proxy:
section — and with one present the legacy PMG_PROXY_MODE was always
inert, so expecting a loud failure there asserts pre-fidelity-fix
behavior. Assert both sides instead: inert (command succeeds) with the
standard config, loud failure against an empty config dir where the
legacy fallback actually applied.

* refactor(config): collapse parseOptOutBool to ParseBool over the string form

YAML hands us typed values (bool, int), so route them through
fmt.Sprintf %v and strconv.ParseBool instead of a per-type switch.
Identical behavior for every recognized value; numbers other than 0/1
now read as no opinion instead of cast.ToBool's nonzero-true, which no
real config relies on.
2026-07-22 15:19:19 +05:30

140 lines
4.9 KiB
Go

package config
import (
"fmt"
"os"
"strconv"
"strings"
"github.com/safedep/dry/log"
"github.com/safedep/dry/usefulerror"
"github.com/safedep/pmg/errcodes"
)
// RejectRemovedProxyOptOut fails loudly when a removed proxy opt-out is still
// in effect. Guard mode is removed and proxy interception can no longer be
// disabled, so a config or environment that explicitly disables it must not be
// silently ignored: the user opted out of proxy interception and switching
// them to it without notice would violate that expectation.
//
// This is a best-effort migration check covering the common opt-out spellings,
// not an exhaustive re-implementation of the old resolution; pathological
// configs are out of scope, and proxy interception runs regardless of its
// outcome.
//
// Resolution mirrors the old order:
// 1. PMG_PROXY_ENABLED (ignored under lockdown) wins over everything.
// Unrecognized values fall back to the default (proxy on), like the old
// loader which silently discarded bad config and ran on defaults.
// 2. The effective proxy.enabled file value, matched like viper resolved it
// (keys case-insensitive, literal dotted proxy.enabled key supported).
// Defaults to true.
// 3. The legacy fallback overrides it when the raw file has no exact "proxy"
// key (the old hasProxySectionInFile gate was case-sensitive):
// PMG_PROXY_MODE (ignored under lockdown) wins over the flat proxy_mode
// file key, both coerced cast.ToBool-style (unparseable = false).
func RejectRemovedProxyOptOut() error {
locked := globalConfig.IsLocked()
if !locked {
if raw := os.Getenv("PMG_PROXY_ENABLED"); raw != "" {
if enabled, ok := parseOptOutBool(raw); ok && !enabled {
return removedProxyOptOutError("Unset the PMG_PROXY_ENABLED environment variable")
}
return nil
}
}
rawKeys, err := readConfigFileKeys(globalConfig.configFilePath)
if err != nil {
if !os.IsNotExist(err) {
log.Warnf("skipping removed proxy opt-out check, could not read config file %s: %v", globalConfig.configFilePath, err)
}
rawKeys = nil
}
enabled, remedy := true, ""
if value, present := lookupProxyEnabled(rawKeys); present {
if parsed, ok := parseOptOutBool(value); ok {
enabled = parsed
remedy = fmt.Sprintf("Remove proxy.enabled from %s", globalConfig.configFilePath)
}
}
// The legacy fallback only ran when the raw file had no exact "proxy" key,
// and within it the env var won over the flat file key with cast.ToBool
// coercion (any unparseable value meant false).
if _, hasRawProxyKey := rawKeys["proxy"]; !hasRawProxyKey {
if envRaw := os.Getenv("PMG_PROXY_MODE"); !locked && envRaw != "" {
enabled = legacyBoolValue(envRaw)
remedy = "Unset the PMG_PROXY_MODE environment variable"
} else if value, present := lookupKeyFold(rawKeys, "proxy_mode"); present {
enabled = legacyBoolValue(value)
remedy = fmt.Sprintf("Remove proxy_mode from %s", globalConfig.configFilePath)
}
}
if !enabled {
return removedProxyOptOutError(remedy)
}
return nil
}
// lookupProxyEnabled returns the proxy.enabled value viper would have resolved
// from the raw file keys: an enabled key inside a proxy: section or a literal
// dotted proxy.enabled key, all matched case-insensitively like viper.
func lookupProxyEnabled(raw map[string]any) (any, bool) {
for key, value := range raw {
switch strings.ToLower(key) {
case "proxy":
if section, ok := value.(map[string]any); ok {
if v, present := lookupKeyFold(section, "enabled"); present {
return v, true
}
}
case "proxy.enabled":
return value, true
}
}
return nil, false
}
// lookupKeyFold returns the value for key, matching case-insensitively like
// viper's key resolution.
func lookupKeyFold(m map[string]any, key string) (any, bool) {
for k, v := range m {
if strings.ToLower(k) == key {
return v, true
}
}
return nil, false
}
// parseOptOutBool reads a boolean out of whatever the YAML parser or the
// environment produced (bool, 0/1 numbers, ParseBool-compatible strings) by
// coercing the value through its string form. Anything else reports no opinion.
func parseOptOutBool(v any) (bool, bool) {
b, err := strconv.ParseBool(fmt.Sprintf("%v", v))
return b, err == nil
}
// legacyBoolValue matches cast.ToBool, which the old fallback used via
// v.GetBool: unparseable values (including null) coerce to false instead of
// being ignored, so PMG_PROXY_MODE=off previously selected guard mode.
func legacyBoolValue(v any) bool {
enabled, ok := parseOptOutBool(v)
return ok && enabled
}
func removedProxyOptOutError(remedy string) error {
return usefulerror.NewUsefulError().
WithCode(errcodes.InvalidArgument).
WithHumanError("guard mode has been removed and proxy interception can no longer be disabled").
WithHelp(fmt.Sprintf("%s. If proxy interception does not work in your environment, report it at https://github.com/safedep/pmg/issues", remedy)).
WithMsg("removed proxy opt-out is still configured")
}