PMG GitHub Banner

Package Manager Guard (PMG)

Prevent supply chain attacks before they happen.

[![Docs](https://img.shields.io/badge/Docs-docs.safedep.io-2b9246?style=flat-square)](https://docs.safedep.io/pmg/quickstart) [![Website](https://img.shields.io/badge/Website-safedep.io-3b82f6?style=flat-square)](https://safedep.io) [![Discord](https://img.shields.io/discord/1090352019379851304?style=flat-square)](https://discord.gg/kAGEj25dCn) [![Go Report Card](https://goreportcard.com/badge/github.com/safedep/pmg)](https://goreportcard.com/report/github.com/safedep/pmg) ![License](https://img.shields.io/github/license/safedep/pmg) ![Release](https://img.shields.io/github/v/release/safedep/pmg) [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/safedep/pmg/badge)](https://api.securityscorecards.dev/projects/github.com/safedep/pmg) [![CodeQL](https://github.com/safedep/pmg/actions/workflows/codeql.yml/badge.svg?branch=main)](https://github.com/safedep/pmg/actions/workflows/codeql.yml)

pmg in action
## Why PMG? Modern software development relies heavily on open-source packages. However, standard package managers (`npm`, `pip`, etc.) prioritize convenience over security, executing arbitrary code (like `postinstall` scripts) on your machine without validation. This vector is frequently exploited by attackers to steal credentials or inject backdoors. **PMG acts as a security middleware layer.** It wraps your package manager to: 1. **Analyze** packages for malware before they are installed. 2. **Sandbox** the installation process to prevent system modification. 3. **Audit** every package installation event. ## Quick Start Get protected in seconds. ### 1. Install **MacOS / Linux (Homebrew)** ```bash brew install safedep/tap/pmg ``` **NPM** ```bash npm install -g @safedep/pmg ``` > See [Installation](#installation) for additional methods. ### 2. Setup Configure your shell to use PMG automatically. ```bash pmg setup install # Restart your terminal to apply changes ``` ### 3. Use Continue using your favorite package manager tools as usual. PMG works silently in the background. ```bash npm install express # or pip install requests ``` If a malicious package is detected, PMG blocks it immediately: ```text [PMG] Blocked malicious package: malicious-lib@1.0.0 [PMG] Reason: Known malware signature detected ``` ## Features | Feature | Description | | -------------------------------- | ---------------------------------------------------------------------------------------------------------------- | | **Malicious Package Protection** | Real-time protection against malicious packages using [SafeDep](https://docs.safedep.io/cloud/malware-analysis). | | **Sandboxing** | Enforces least privilege using OS native sandboxing to contain installation scripts. | | **Dependency Analysis** | Deep scans of direct and transitive dependencies before they hit your disk. | | **Event Logging** | Keeps a verifiable audit trail of all installed packages. | | **Zero Config** | Works out of the box with sensible security defaults. | | **Cross-Shell** | Seamlessly integrates with Zsh, Bash, Fish, and more. | ## Supported Package Managers PMG supports the tools you already use: | Ecosystem | Tools | Status | Command Example | | ----------- | -------- | ------ | ------------------- | | **Node.js** | `npm` | Yes | `npm install ` | | | `pnpm` | Yes | `pnpm add ` | | | `yarn` | Yes | `yarn add ` | | | `bun` | Yes | `bun add ` | | | `npx` | Yes | `npx ` | | | `pnpx` | Yes | `pnpx ` | | **Python** | `pip` | Yes | `pip install ` | | | `poetry` | Yes | `poetry add ` | | | `uv` | Yes | `uv add ` | ## Installation
Homebrew (MacOS/Linux) ```bash brew tap safedep/tap brew install safedep/tap/pmg ```
NPM (Cross-Platform) ```bash npm install -g @safedep/pmg ```
Go (Build from Source) ```bash # Ensure $(go env GOPATH)/bin is in your $PATH go install github.com/safedep/pmg@latest ```
Binary Download Download the latest binary for your platform from the [Releases Page](https://github.com/safedep/pmg/releases).
## Trust and Security Security is our first class requirement. PMG builds are reproducible and signed. * **Attestations**: GitHub and npm attestations are used to guarantee artifact integrity. * **Verification**: Users can cryptographically prove the binary matches the source code. * See [Trusting PMG](docs/trust.md) for verification steps. ## Usage Guide PMG runs transparently, but you can control it when needed. ### Paranoid Mode Treat all unverified or suspicious packages as malicious. ```bash pmg --paranoid npm install ``` ### Dry Run Simulate installation to check for malware without writing to disk. ```bash pmg --dry-run npm install ``` ### Debugging Enable verbose logs for troubleshooting. ```bash pmg --debug npm install ``` ### Emergency Bypass > ⚠️ **Warning**: Bypassing security checks exposes users to risk. ```bash export PMG_INSECURE_INSTALLATION=true npm install ``` ## Advanced Documentation * [Trusted Packages Configuration](docs/trusted-packages.md) * [Proxy Mode Architecture](docs/proxy-mode.md) * [Sandboxing Details](docs/sandbox.md) ## Contributing Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to build and test PMG locally. ## Telemetry PMG collects anonymous usage data to improve project stability and reliability. To disable: `export PMG_DISABLE_TELEMETRY=true`.