mirror of
https://github.com/safedep/pmg.git
synced 2026-08-03 07:24:09 +02:00
* 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.
135 lines
4.3 KiB
Go
135 lines
4.3 KiB
Go
package config
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"strings"
|
|
|
|
"github.com/safedep/dry/log"
|
|
"github.com/spf13/viper"
|
|
"gopkg.in/yaml.v3"
|
|
)
|
|
|
|
// loadViperConfig loads the configuration using Viper.
|
|
// Precedence (highest to lowest): cobra flags > env vars > config file > defaults.
|
|
// When a globally managed config is active, env overrides are disabled and
|
|
// managed flags are rejected, so the managed file is authoritative.
|
|
// Cobra flags write directly to the config struct after this function runs.
|
|
func loadViperConfig() error {
|
|
// Use the active config path resolved by initConfig (globally managed file
|
|
// when present, otherwise the per-user file).
|
|
configPath := globalConfig.configFilePath
|
|
|
|
v := viper.New()
|
|
v.SetConfigType("yaml")
|
|
|
|
// A locked global config must not be bypassable via PMG_* env vars, so
|
|
// AutomaticEnv is enabled unless lockdown is in force. An unlocked managed
|
|
// config stays an overridable baseline.
|
|
if !globalConfig.IsLocked() {
|
|
v.SetEnvPrefix("PMG")
|
|
v.AutomaticEnv()
|
|
v.SetEnvKeyReplacer(strings.NewReplacer("-", "_", ".", "_"))
|
|
}
|
|
|
|
// Load the embedded template as the base so Viper knows all keys and their
|
|
// defaults, and (when env overrides are enabled) can resolve PMG_* vars for
|
|
// keys that are absent from or newer than the user's config file.
|
|
if err := v.ReadConfig(strings.NewReader(templateConfig)); err != nil {
|
|
return fmt.Errorf("failed to load default config: %w", err)
|
|
}
|
|
|
|
// Merge user config on top if it exists.
|
|
if _, statErr := os.Stat(configPath); statErr == nil {
|
|
v.SetConfigFile(configPath)
|
|
if err := v.MergeInConfig(); err != nil {
|
|
return fmt.Errorf("failed to read config file %s: %w", configPath, err)
|
|
}
|
|
}
|
|
|
|
merged := globalConfig.Config
|
|
if err := v.Unmarshal(&merged); err != nil {
|
|
return fmt.Errorf("failed to unmarshal config: %w", err)
|
|
}
|
|
|
|
globalConfig.Config = merged
|
|
globalConfig.viper = v
|
|
|
|
// Resolve proxy config: new proxy section > legacy flat keys.
|
|
// Viper can't distinguish "value from template" vs "value from user config"
|
|
// (v.IsSet is always true for template keys), so we check the raw user file.
|
|
if !hasProxySectionInFile(configPath) {
|
|
applyProxyLegacyFallback(v)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// readConfigFileKeys reads path and returns its top-level YAML mapping.
|
|
func readConfigFileKeys(path string) (map[string]any, error) {
|
|
data, err := os.ReadFile(path)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
var raw map[string]any
|
|
if err := yaml.Unmarshal(data, &raw); err != nil {
|
|
return nil, fmt.Errorf("failed to parse %s: %w", path, err)
|
|
}
|
|
|
|
return raw, nil
|
|
}
|
|
|
|
// hasProxySectionInFile checks whether the config file at path contains a
|
|
// top-level "proxy" key. A missing or unparseable file reports false.
|
|
func hasProxySectionInFile(path string) bool {
|
|
raw, err := readConfigFileKeys(path)
|
|
if err != nil {
|
|
return false
|
|
}
|
|
|
|
_, ok := raw["proxy"]
|
|
return ok
|
|
}
|
|
|
|
// globalConfigEnablesLockdown reports whether the global config file at path
|
|
// enables lockdown. It is only called when a global config is present, so a read
|
|
// or parse failure means a managed file we cannot interpret: fail closed
|
|
// (locked) rather than silently dropping policy. global_lockdown is read directly
|
|
// from the file, so it cannot be flipped via env or CLI.
|
|
func globalConfigEnablesLockdown(path string) bool {
|
|
raw, err := readConfigFileKeys(path)
|
|
if err != nil {
|
|
log.Warnf("could not read global config %q to determine lockdown (%v); defaulting to locked", path, err)
|
|
return true
|
|
}
|
|
|
|
value, ok := raw["global_lockdown"]
|
|
if !ok {
|
|
return false
|
|
}
|
|
|
|
enabled, isBool := value.(bool)
|
|
if !isBool {
|
|
log.Warnf("config %q sets global_lockdown to a non-boolean value (%v); treating as disabled", path, value)
|
|
return false
|
|
}
|
|
|
|
return enabled
|
|
}
|
|
|
|
// applyProxyLegacyFallback populates the new Proxy struct from deprecated
|
|
// flat keys when the user's config file does not have a proxy: section.
|
|
// The new env var (PMG_PROXY_INSTALL_ONLY) takes precedence over legacy
|
|
// config file keys to respect the documented precedence order.
|
|
func applyProxyLegacyFallback(v *viper.Viper) {
|
|
// A locked config ignores env, so env must not suppress the legacy migration.
|
|
envIgnored := globalConfig.IsLocked()
|
|
|
|
if (envIgnored || os.Getenv("PMG_PROXY_INSTALL_ONLY") == "") && v.IsSet("proxy_install_only") {
|
|
val := v.GetBool("proxy_install_only")
|
|
globalConfig.Config.Proxy.InstallOnly = val
|
|
v.Set("proxy.install_only", val)
|
|
}
|
|
}
|