mirror of
https://github.com/safedep/pmg.git
synced 2026-08-03 07:24:09 +02:00
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.
This commit is contained in:
@@ -60,7 +60,7 @@ in doubt, keep the cache disabled (the default) or use a short `ttl`.
|
||||
|
||||
## Requirements
|
||||
|
||||
The analysis cache applies to [proxy mode](proxy-mode.md). It is independent of
|
||||
The analysis cache is independent of
|
||||
[dependency cooldown](dependency-cooldown.md): cooldown decides which *versions*
|
||||
are eligible to install, while the analysis cache remembers malware verdicts for
|
||||
versions that were already screened.
|
||||
|
||||
+5
-5
@@ -29,7 +29,7 @@ To set a config value:
|
||||
|
||||
```bash
|
||||
pmg config set paranoid true
|
||||
pmg config set transitive_depth 10
|
||||
pmg config set dependency_cooldown.days 10
|
||||
pmg config set cloud.enabled true
|
||||
```
|
||||
See [config template](../config/config.template.yml) for the configuration schema.
|
||||
@@ -43,9 +43,7 @@ file. This is useful for CI/CD pipelines or temporary overrides.
|
||||
|
||||
| Config key | Environment variable |
|
||||
|---|---|
|
||||
| `transitive` | `PMG_TRANSITIVE` |
|
||||
| `paranoid` | `PMG_PARANOID` |
|
||||
| `proxy.enabled` | `PMG_PROXY_ENABLED` |
|
||||
| `proxy.install_only` | `PMG_PROXY_INSTALL_ONLY` |
|
||||
| `verbosity` | `PMG_VERBOSITY` |
|
||||
| `skip_event_logging` | `PMG_SKIP_EVENT_LOGGING` |
|
||||
@@ -53,7 +51,9 @@ file. This is useful for CI/CD pipelines or temporary overrides.
|
||||
| `dependency_cooldown.enabled` | `PMG_DEPENDENCY_COOLDOWN_ENABLED` |
|
||||
| `cloud.enabled` | `PMG_CLOUD_ENABLED` |
|
||||
|
||||
Legacy environment variables `PMG_PROXY_MODE` and `PMG_PROXY_INSTALL_ONLY` (for the old flat keys) are still supported when the `proxy:` section does not exist in the config file.
|
||||
The legacy flat key `proxy_install_only` is still supported when the `proxy:` section does not exist in the config file.
|
||||
|
||||
Proxy interception can no longer be disabled: PMG fails with an error when the config or environment still contains `proxy.enabled: false`, `proxy_mode: false`, `PMG_PROXY_ENABLED=false` or `PMG_PROXY_MODE=false`. See [proxy mode](proxy-mode.md).
|
||||
|
||||
**Example:**
|
||||
|
||||
@@ -128,7 +128,7 @@ global_lockdown: true
|
||||
|
||||
When lockdown is on:
|
||||
|
||||
- **CLI flags that would change a managed value fail fast.** For example, `pmg --sandbox=false ...` or `pmg --paranoid ...` errors out instead of overriding policy. Governed flags: `--transitive`, `--transitive-depth`, `--include-dev-dependencies`, `--paranoid`, `--skip-event-log`, `--proxy-mode`, `--sandbox`, `--sandbox-enforce`, `--sandbox-profile`, `--sandbox-allow`, `--skip-dependency-cooldown`. Operational flags such as `--dry-run` keep working.
|
||||
- **CLI flags that would change a managed value fail fast.** For example, `pmg --sandbox=false ...` or `pmg --paranoid ...` errors out instead of overriding policy. Governed flags: `--paranoid`, `--skip-event-log`, `--sandbox`, `--sandbox-enforce`, `--sandbox-profile`, `--sandbox-allow`, `--skip-dependency-cooldown`. Operational flags such as `--dry-run` keep working.
|
||||
- **`PMG_*` variables cannot change the config**, including `PMG_INSECURE_INSTALLATION` (which otherwise bypasses malicious-package blocking).
|
||||
|
||||
PMG reads `global_lockdown` straight from the global file, so a user cannot flip it through env or CLI. If the global file exists but cannot be read or parsed, PMG fails closed and treats it as locked. `PMG_CONFIG_DIR` and `PMG_CACHE_DIR` still relocate per-user state directories (logs, cache) in any mode, but leave the managed config alone.
|
||||
|
||||
@@ -76,7 +76,7 @@ pmg --skip-dependency-cooldown npm install express
|
||||
|
||||
## Requirements
|
||||
|
||||
Dependency cooldown requires [proxy mode](proxy-mode.md) to be enabled. It is supported for npm and PyPI packages.
|
||||
Dependency cooldown is supported for npm and PyPI packages.
|
||||
|
||||
## Limitations
|
||||
|
||||
|
||||
@@ -50,7 +50,7 @@ explicitly to override.
|
||||
| `paranoid` | `PMG_PARANOID` | `false` |
|
||||
| `cooldown-enabled` | `PMG_DEPENDENCY_COOLDOWN_ENABLED` | `true` |
|
||||
| `cooldown-days` | `PMG_DEPENDENCY_COOLDOWN_DAYS` | `5` |
|
||||
| `proxy-mode` | `PMG_PROXY_ENABLED`. Set `false` for guard-based analysis | `true` |
|
||||
| `proxy-mode` | REMOVED. Proxy interception can no longer be disabled; `"false"` fails the action, other values warn and are ignored | unset |
|
||||
| `sandbox` | `PMG_SANDBOX_ENABLED`. Also relaxes AppArmor user-ns restrictions on the runner | `false` |
|
||||
| `sandbox-driver` | `PMG_SANDBOX_DRIVER` — `landlock` or `bubblewrap` | `landlock` when sandbox is enabled |
|
||||
| `verbosity` | `PMG_VERBOSITY` — `silent`, `normal`, or `verbose` | `normal` |
|
||||
@@ -144,7 +144,7 @@ action input. Set it on the job or the install step:
|
||||
- uses: safedep/pmg@v1
|
||||
- run: npm ci
|
||||
env:
|
||||
PMG_TRANSITIVE_DEPTH: 10
|
||||
PMG_DEPENDENCY_COOLDOWN_DAYS: 10
|
||||
```
|
||||
|
||||
See [docs/config.md](./config.md) for the full mapping.
|
||||
|
||||
+6
-11
@@ -22,29 +22,24 @@ Use this checklist to add a new package manager ecosystem (e.g., npm or PyPI). K
|
||||
- Multiple dependencies
|
||||
- Edge cases (e.g., missing fields, malformed entries)
|
||||
|
||||
5. Create an extractor
|
||||
- In `extractor/`, add an extractor for the new ecosystem under `extractor/npm` or `extractor/pypi`.
|
||||
- Update the `NewExtractorManager` to include the newly introduced `PackageManagerExtractor`.
|
||||
- Update `getExtractorForFile` to recognize and support the ecosystem’s manifests/lockfiles.
|
||||
|
||||
6. Register alias
|
||||
5. Register alias
|
||||
- In `internal/alias/alias.go`, add the new package manager’s alias to `DefaultConfig.packageManagers`.
|
||||
- Verify default alias and invocation match conventions.
|
||||
|
||||
7. Add analytics
|
||||
6. Add analytics
|
||||
- Define a new analytics event similar to existing ones.
|
||||
- Implement a `Track` function for the event.
|
||||
- Invoke tracking in the new package manager cmd.
|
||||
|
||||
8. Update documentation
|
||||
7. Update documentation
|
||||
- Update the README to list the new supported package manager.
|
||||
- Add usage examples consistent with existing examples.
|
||||
|
||||
9. Add e2e workflow
|
||||
8. Add e2e workflow
|
||||
- In `.github/workflows/pmg-e2e.yml`, add an e2e job for the new manager.
|
||||
- Mirror structure and steps used by other ecosystems.
|
||||
|
||||
10. Verify end-to-end behavior
|
||||
9. Verify end-to-end behavior
|
||||
- Test the CLI locally for:
|
||||
- Single package installation
|
||||
- Multiple package installation
|
||||
@@ -53,6 +48,6 @@ Use this checklist to add a new package manager ecosystem (e.g., npm or PyPI). K
|
||||
- Manifests/lockfiles installation flow
|
||||
- `pmg setup install` to verify alias is set and works
|
||||
|
||||
11. Consistency pass
|
||||
10. Consistency pass
|
||||
- Confirm naming, errors, logs, and UX align with existing ecosystems.
|
||||
- Ensure code follows project patterns and is covered by tests.
|
||||
|
||||
+9
-9
@@ -1,6 +1,6 @@
|
||||
# Proxy Mode
|
||||
|
||||
PMG supports proxy based interception as an alternative to the current optimistic dependency resolution. When enabled:
|
||||
PMG protects package installations through proxy based interception:
|
||||
|
||||
- PMG starts a micro-proxy server on a random localhost port
|
||||
- Runs `npm` and other supported package managers configured to use the proxy
|
||||
@@ -19,12 +19,11 @@ Proxy behavior is configured under the `proxy:` section in `config.yml`:
|
||||
|
||||
```yaml
|
||||
proxy:
|
||||
enabled: true
|
||||
install_only: false
|
||||
```
|
||||
|
||||
| Key | Default | Description |
|
||||
|---|---|---|
|
||||
| `enabled` | `true` | Enable proxy-based interception. When `false`, PMG falls back to guard-based analysis. |
|
||||
| `install_only` | `false` | When `true`, only install commands are proxied. Other commands (e.g., `npm ls`, `pip list`) bypass the proxy and execute directly. |
|
||||
| `skip_commands` | `{}` | Per-package-manager commands to bypass the proxy. Only applies when `install_only` is `true`. |
|
||||
|
||||
@@ -42,18 +41,19 @@ proxy:
|
||||
|
||||
Commands in `skip_commands` are matched against the first non-flag argument. For example, `npm dev` would match `dev`, but `npm install dev` would not since `install` is the first non-flag argument.
|
||||
|
||||
### CLI flags
|
||||
|
||||
Use `--proxy-mode` to override `proxy.enabled` at runtime.
|
||||
|
||||
### Environment variables
|
||||
|
||||
| Variable | Description |
|
||||
|---|---|
|
||||
| `PMG_PROXY_ENABLED` | Override `proxy.enabled` |
|
||||
| `PMG_PROXY_INSTALL_ONLY` | Override `proxy.install_only` |
|
||||
|
||||
Legacy variables `PMG_PROXY_MODE` and `PMG_PROXY_INSTALL_ONLY` (for the old flat config keys) are still supported when the `proxy:` section does not exist in the config file.
|
||||
The legacy flat config key `proxy_install_only` is still supported when the `proxy:` section does not exist in the config file.
|
||||
|
||||
### Removed: disabling proxy interception
|
||||
|
||||
Guard mode (the non-proxy analysis flow) has been removed and proxy interception can no longer be disabled. PMG fails with an error when it detects a leftover opt-out — `proxy.enabled: false` or `proxy_mode: false` in the config file, `PMG_PROXY_ENABLED=false` or `PMG_PROXY_MODE=false` in the environment — instead of silently switching to proxy interception. Remove the setting to proceed. The `--proxy-mode` flag is removed and fails as an unknown flag.
|
||||
|
||||
Note one trade-off versus the removed guard mode: the proxy analyzes packages as they are downloaded, so installs fully served from a local package manager cache (e.g. npm cache, pnpm store, pip cache, `--offline` installs) do not trigger analysis. Guard mode analyzed manifest-listed packages via registry metadata regardless of downloads. Packages are analyzed when first fetched through the proxy, which is when they enter those caches.
|
||||
|
||||
## Supported Package Managers
|
||||
|
||||
|
||||
@@ -133,8 +133,8 @@ constant tax that maps to most of the decisions above:
|
||||
|
||||
- **Unprivileged user namespaces required.** On distros that disable them, `clone()`
|
||||
returns EPERM. We don't yet probe and fall back to bubblewrap (TODO).
|
||||
- **Network filtering not enforced.** Landlock V4 does TCP ports, not hostnames. Use
|
||||
proxy-mode.
|
||||
- **Network filtering not enforced.** Landlock V4 does TCP ports, not hostnames. PMG's
|
||||
proxy interception provides network control.
|
||||
- **PID/IPC namespace isolation is best-effort.** Retried without on EPERM.
|
||||
- **Audit events are dropped.** Wired but consumed by `io.Discard`.
|
||||
- **TOCTOU between path read and deny response.** Microseconds. Adequate for benign
|
||||
|
||||
+1
-1
@@ -436,7 +436,7 @@ on Debian/Ubuntu; default on most modern distros). If disabled, the helper fails
|
||||
EPERM on `clone()` and the sandbox falls back to Bubblewrap.
|
||||
|
||||
**Network filtering**: Not enforced. Landlock supports TCP port filtering only (V4+, no hostname).
|
||||
Use `--proxy-mode` for network control.
|
||||
PMG's proxy interception provides network control.
|
||||
|
||||
**PID/IPC namespace isolation**: Applied best-effort via `CLONE_NEWPID|CLONE_NEWIPC|CLONE_NEWNS`.
|
||||
If unavailable, a warning is printed and the command continues. Set `PMG_SANDBOX_DRIVER=bubblewrap`
|
||||
|
||||
Reference in New Issue
Block a user