mirror of
https://github.com/safedep/pmg.git
synced 2026-08-03 07:24:09 +02:00
* feat(uvx): add uvx (uv tool run) package executor Adds support for `uvx`, implemented as a PyPI Executor alongside pipx. uvx is an alias for `uv tool run`: it installs a tool into an ephemeral environment and runs it, so it has no install/list subcommand and the first positional argument (or --from) is the package to audit. Parsing highlights: - --from overrides the positional command as the package to audit - --with packages are audited as additional environment dependencies - name@version shorthand (ruff@0.3.0, ruff@latest) is normalized - flag parsing stops at the tool name so the tool's own flags are not misread as uvx options; uvx's value/boolean flags are registered so none greedily consume the package positional - VCS/URL/local-path specs are skipped for registry auditing Wires up command registration, analytics, shell alias/shim, cloud audit mapping, a dedicated `uvx` sandbox profile (UV_*/PIP_* env, uv cache and tool dirs), config policy, docs, unit tests and an E2E workflow step. Closes #326 https://claude.ai/code/session_011hyLxq7oWJX5Dp4tCEfG19 * chore(uvx): align docs and base profile with uvx support Incorporates the low-risk, non-parser improvements from the community PR #345 (author non-responsive) into our implementation: - list uvx (and the previously-missing pipx) as PyPI managers in the pypi-restrictive base profile package_managers and its README, so the base profile applies directly when selected via --sandbox-profile - document uvx in docs/github-action.md and docs/proxy-mode.md - add version / IsExplicitVersion assertions to the uvx parser tests Our pflag-based parser is kept as-is: unlike #345 it audits --with packages and handles all uvx short flags (e.g. -w), both of which the community PR misses. * fix(uvx): skip interpreter requests; use require in tests Addresses review feedback on PR #357: - uvx interpreter requests (`uvx python`, `uvx python@3.12`, `uvx pypy`, ...) launch an isolated interpreter rather than installing a PyPI tool. Treating the positional as a package made the guard flow resolve/analyze pkg:pypi/python (and python==3.12), which could wrongly block or fail a valid invocation. Skip these for the positional; --with packages on the same command are still audited. - Use require.NoError / require.Len for fatal assertions in the uvx tests, matching the repo's testing convention, so a failure stops the subtest before a nil dereference instead of panicking. * docs(uvx): document fail-open and --with-requirements trade-offs Record the two deliberate parsing decisions raised in review as in-code trade-off comments (no behavior change): - unknown flags are tolerated (fail open), consistent with the other executors; the residual gap only affects non-proxy guard mode since the default proxy flow intercepts every registry download. - --with-requirements / --with-editable values are consumed but not expanded into audit targets; expanding them needs manifest-extractor and guard changes, tracked as follow-up. Proxy mode still covers them. * docs(uvx): drop --with-requirements limitation note Per maintainer review: guard mode is being deprecated and auditing the contents of an existing requirements file is a scanner's responsibility, not PMG's. Remove the "known limitation / follow-up" note; the flags stay registered only so their values are not mistaken for the tool positional. --------- Co-authored-by: Claude <noreply@anthropic.com>
241 lines
7.7 KiB
Go
241 lines
7.7 KiB
Go
package main
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"runtime"
|
|
"strings"
|
|
|
|
"github.com/safedep/dry/log"
|
|
"github.com/safedep/pmg/cmd/cloud"
|
|
configCmd "github.com/safedep/pmg/cmd/config"
|
|
"github.com/safedep/pmg/cmd/executors"
|
|
landlockCmd "github.com/safedep/pmg/cmd/landlock"
|
|
"github.com/safedep/pmg/cmd/npm"
|
|
proxyCmd "github.com/safedep/pmg/cmd/proxy"
|
|
"github.com/safedep/pmg/cmd/pypi"
|
|
sandboxCmd "github.com/safedep/pmg/cmd/sandbox"
|
|
"github.com/safedep/pmg/cmd/setup"
|
|
"github.com/safedep/pmg/cmd/version"
|
|
"github.com/safedep/pmg/config"
|
|
"github.com/safedep/pmg/internal/analytics"
|
|
"github.com/safedep/pmg/internal/audit"
|
|
"github.com/safedep/pmg/internal/eventlog"
|
|
"github.com/safedep/pmg/internal/ui"
|
|
appVersion "github.com/safedep/pmg/internal/version"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
var (
|
|
debug bool
|
|
silent bool
|
|
verbose bool
|
|
logFile string
|
|
)
|
|
|
|
func setLogEnv(key, value string) {
|
|
if err := os.Setenv(key, value); err != nil {
|
|
log.Warnf("failed to set %s: %v", key, err)
|
|
}
|
|
}
|
|
|
|
func main() {
|
|
cmd := &cobra.Command{
|
|
Use: "pmg",
|
|
TraverseChildren: true,
|
|
PersistentPreRun: func(cmd *cobra.Command, args []string) {
|
|
// Always set this first because we will override the log
|
|
// level if debug or verbose is set
|
|
if logFile != "" {
|
|
setLogEnv("APP_LOG_FILE", logFile)
|
|
setLogEnv("APP_LOG_LEVEL", "info")
|
|
}
|
|
|
|
// Set the log level when debug is enabled
|
|
if debug {
|
|
setLogEnv("APP_LOG_LEVEL", "debug")
|
|
}
|
|
|
|
// Skip stdout logging when debugging is not enabled
|
|
if !debug {
|
|
setLogEnv("APP_LOG_SKIP_STDOUT_LOGGER", "true")
|
|
}
|
|
|
|
// Apply config-based verbosity first
|
|
switch config.Get().Config.Verbosity {
|
|
case config.VerbositySilent:
|
|
ui.SetVerbosityLevel(ui.VerbosityLevelSilent)
|
|
case config.VerbosityVerbose:
|
|
ui.SetVerbosityLevel(ui.VerbosityLevelVerbose)
|
|
default:
|
|
ui.SetVerbosityLevel(ui.VerbosityLevelNormal)
|
|
}
|
|
|
|
// CLI flags override config
|
|
if silent && verbose {
|
|
ui.Fatalf("pmg: --silent and --verbose cannot be used together")
|
|
}
|
|
|
|
if silent {
|
|
ui.SetVerbosityLevel(ui.VerbosityLevelSilent)
|
|
} else if verbose {
|
|
ui.SetVerbosityLevel(ui.VerbosityLevelVerbose)
|
|
}
|
|
|
|
log.InitZapLogger("pmg", "cli")
|
|
|
|
// Refuse flags that would override a globally managed config before any
|
|
// config-dependent initialization (event logging, audit) runs, so a
|
|
// managed flag like --skip-event-log cannot take effect first.
|
|
if err := config.RejectManagedFlagOverrides(cmd); err != nil {
|
|
ui.ErrorExit(err)
|
|
}
|
|
|
|
// Initialize event logging
|
|
var eventlogErr error
|
|
if logFile != "" {
|
|
// If a custom log file is specified, use it for event logging too
|
|
eventlogErr = eventlog.InitializeWithFile(logFile)
|
|
} else {
|
|
// Otherwise use the default log directory
|
|
eventlogErr = eventlog.Initialize()
|
|
}
|
|
|
|
if eventlogErr != nil {
|
|
ui.Fatalf("failed to initialize event logging: %v", eventlogErr)
|
|
}
|
|
|
|
if err := audit.Initialize(config.Get()); err != nil {
|
|
ui.ErrorExit(err)
|
|
}
|
|
|
|
// The proxy daemon delivers events itself (periodic sync + shutdown
|
|
// flush), so suppress the detached background auto-sync for proxy
|
|
// commands. It would otherwise spawn a redundant child that contends
|
|
// for the sync lock and, from `pmg proxy stop`, routes through the
|
|
// now-stopped proxy. We suppress the spawn directly rather than
|
|
// flipping AutoSync.Enabled, because the daemon's periodic sync
|
|
// honors that flag.
|
|
if isProxyCommand(cmd) {
|
|
audit.SuppressBackgroundSync()
|
|
}
|
|
|
|
config.FinalizeDependencyCooldownOverride()
|
|
|
|
// Parse and validate --sandbox-allow flags after all flags are resolved
|
|
if err := config.FinalizeSandboxAllowOverrides(); err != nil {
|
|
ui.Fatalf("pmg: %v", err)
|
|
}
|
|
|
|
if debug {
|
|
logDebugContext()
|
|
}
|
|
},
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
if len(args) == 0 {
|
|
return cmd.Help()
|
|
}
|
|
|
|
return fmt.Errorf("pmg: %s is not a valid command", args[0])
|
|
},
|
|
}
|
|
|
|
cmd.PersistentFlags().StringVar(&logFile, "log", "", "Log file to write to")
|
|
cmd.PersistentFlags().BoolVar(&silent, "silent", false, "Silent mode for invisible experience")
|
|
cmd.PersistentFlags().BoolVar(&verbose, "verbose", false, "Verbose mode for more information")
|
|
cmd.PersistentFlags().BoolVar(&debug, "debug", false, "Enable debug logging (defaults to stdout)")
|
|
|
|
// Apply config flags to the command. This allows for overriding the configuration at runtime
|
|
// using the command line.
|
|
config.ApplyCobraFlags(cmd)
|
|
|
|
cmd.AddCommand(npm.NewNpmCommand())
|
|
cmd.AddCommand(npm.NewPnpmCommand())
|
|
cmd.AddCommand(npm.NewBunCommand())
|
|
cmd.AddCommand(npm.NewYarnCommand())
|
|
cmd.AddCommand(executors.NewNpxCommand())
|
|
cmd.AddCommand(executors.NewPnpxCommand())
|
|
cmd.AddCommand(pypi.NewPipCommand())
|
|
cmd.AddCommand(pypi.NewPip3Command())
|
|
cmd.AddCommand(pypi.NewUvCommand())
|
|
cmd.AddCommand(pypi.NewPoetryCommand())
|
|
cmd.AddCommand(executors.NewPipxCommand())
|
|
cmd.AddCommand(executors.NewUvxCommand())
|
|
cmd.AddCommand(proxyCmd.NewProxyCommand())
|
|
cmd.AddCommand(version.NewVersionCommand())
|
|
cmd.AddCommand(setup.NewSetupCommand())
|
|
cmd.AddCommand(setup.NewRemoveCommand())
|
|
cmd.AddCommand(sandboxCmd.NewCommand())
|
|
cmd.AddCommand(cloud.NewCloudCommand())
|
|
cmd.AddCommand(configCmd.NewConfigCommand())
|
|
|
|
if subcmd := landlockCmd.NewLandlockSandboxExecCommand(); subcmd != nil {
|
|
cmd.AddCommand(subcmd)
|
|
}
|
|
if subcmd := landlockCmd.NewLandlockShimCommand(); subcmd != nil {
|
|
cmd.AddCommand(subcmd)
|
|
}
|
|
|
|
// Print Banner on --help / -h
|
|
cmd.SetHelpFunc(func(command *cobra.Command, args []string) {
|
|
fmt.Print(ui.GeneratePMGBanner(appVersion.Version, appVersion.Commit))
|
|
fmt.Println(command.UsageString())
|
|
})
|
|
|
|
defer func() {
|
|
if err := eventlog.Close(); err != nil {
|
|
log.Warnf("failed to close eventlog: %v", err)
|
|
}
|
|
}()
|
|
// Defers run LIFO. The spawn must observe the parent's released SQLite
|
|
// handle, so we declare it BEFORE audit.Close's defer (it then runs AFTER
|
|
// audit.Close at exit time).
|
|
defer func() {
|
|
audit.MaybeSpawnBackgroundSync(config.Get())
|
|
}()
|
|
defer func() {
|
|
if err := audit.Close(); err != nil {
|
|
log.Warnf("failed to close audit system: %v", err)
|
|
}
|
|
}()
|
|
|
|
// Analytics are best-effort. Do not flush on exit because the PostHog
|
|
// client can block the CLI while draining its queue.
|
|
analytics.TrackCommandRun()
|
|
analytics.TrackCI()
|
|
|
|
if err := cmd.Execute(); err != nil {
|
|
type exitCoder interface{ ExitCode() int }
|
|
if ec, ok := err.(exitCoder); ok {
|
|
os.Exit(ec.ExitCode())
|
|
}
|
|
os.Exit(1)
|
|
}
|
|
}
|
|
|
|
func logDebugContext() {
|
|
cfg := config.Get()
|
|
|
|
log.Debugf("Command: pmg %s", strings.Join(os.Args[1:], " "))
|
|
log.Debugf("PMG %s (commit: %s) running on %s/%s with %s",
|
|
appVersion.Version, appVersion.Commit, runtime.GOOS, runtime.GOARCH, runtime.Version())
|
|
log.Debugf("Using config file: %s", cfg.ConfigFilePath())
|
|
log.Debugf("Proxy mode enabled: %t, install only: %t", cfg.IsProxyModeEnabled(), cfg.Config.Proxy.InstallOnly)
|
|
log.Debugf("Sandbox enabled: %t, enforce always: %t", cfg.Config.Sandbox.Enabled, cfg.Config.Sandbox.EnforceAlways)
|
|
log.Debugf("Transitive analysis enabled: %t (depth: %d), paranoid: %t", cfg.Config.Transitive, cfg.Config.TransitiveDepth, cfg.Config.Paranoid)
|
|
log.Debugf("Dependency cooldown enabled: %t (days: %d)", cfg.Config.DependencyCooldown.Enabled, cfg.Config.DependencyCooldown.Days)
|
|
log.Debugf("Cloud sync enabled: %t, telemetry disabled: %t", cfg.Config.Cloud.Enabled, cfg.Config.DisableTelemetry)
|
|
log.Debugf("Dry run: %t, insecure installation: %t, trusted packages: %d",
|
|
cfg.DryRun, cfg.InsecureInstallation, len(cfg.Config.TrustedPackages))
|
|
}
|
|
|
|
// isProxyCommand reports whether cmd is `pmg proxy` or one of its subcommands.
|
|
func isProxyCommand(cmd *cobra.Command) bool {
|
|
for c := cmd; c != nil; c = c.Parent() {
|
|
if c.Name() == "proxy" {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|