diff --git a/.github/workflows/build-and-release.yml b/.github/workflows/build-and-release.yml index 4464c02..08f714a 100644 --- a/.github/workflows/build-and-release.yml +++ b/.github/workflows/build-and-release.yml @@ -4,6 +4,8 @@ on: push: tags: - "*" + release: + types: [published] permissions: id-token: write @@ -11,7 +13,9 @@ permissions: jobs: set-version: - runs-on: ubuntu-latest + name: Set version number + if: github.event_name == 'push' + runs-on: open-source-releaser outputs: version: ${{ steps.get_version.outputs.tag }} steps: @@ -22,13 +26,113 @@ jobs: echo "tag=$version" >> $GITHUB_OUTPUT create-binaries: + if: github.event_name == 'push' needs: set-version uses: ./.github/workflows/create-artifact.yml with: version: ${{ needs.set-version.outputs.version }} - build: + publish-binaries: + name: Publish to GitHub release + if: github.event_name == 'push' needs: [set-version, create-binaries] + runs-on: open-source-releaser + steps: + - name: Checkout code + uses: actions/checkout@v3 + + - name: Download all binary artifacts + uses: actions/download-artifact@v4 + with: + path: binaries/ + pattern: safe-chain-* + merge-multiple: false + + - name: Rename binaries to include platform and architecture + run: | + mkdir release-artifacts + mv binaries/safe-chain-macos-x64/safe-chain release-artifacts/safe-chain-macos-x64 + mv binaries/safe-chain-macos-arm64/safe-chain release-artifacts/safe-chain-macos-arm64 + mv binaries/safe-chain-linux-x64/safe-chain release-artifacts/safe-chain-linux-x64 + mv binaries/safe-chain-linux-arm64/safe-chain release-artifacts/safe-chain-linux-arm64 + mv binaries/safe-chain-linuxstatic-x64/safe-chain release-artifacts/safe-chain-linuxstatic-x64 + mv binaries/safe-chain-linuxstatic-arm64/safe-chain release-artifacts/safe-chain-linuxstatic-arm64 + mv binaries/safe-chain-win-x64/safe-chain.exe release-artifacts/safe-chain-win-x64.exe + mv binaries/safe-chain-win-arm64/safe-chain.exe release-artifacts/safe-chain-win-arm64.exe + + - name: Move install scripts and hard-code version and checksums + env: + VERSION: ${{ needs.set-version.outputs.version }} + run: | + SHA_MACOS_X64=$(sha256sum release-artifacts/safe-chain-macos-x64 | awk '{print $1}') + SHA_MACOS_ARM64=$(sha256sum release-artifacts/safe-chain-macos-arm64 | awk '{print $1}') + SHA_LINUX_X64=$(sha256sum release-artifacts/safe-chain-linux-x64 | awk '{print $1}') + SHA_LINUX_ARM64=$(sha256sum release-artifacts/safe-chain-linux-arm64 | awk '{print $1}') + SHA_LINUXSTATIC_X64=$(sha256sum release-artifacts/safe-chain-linuxstatic-x64 | awk '{print $1}') + SHA_LINUXSTATIC_ARM64=$(sha256sum release-artifacts/safe-chain-linuxstatic-arm64 | awk '{print $1}') + SHA_WIN_X64=$(sha256sum release-artifacts/safe-chain-win-x64.exe | awk '{print $1}') + SHA_WIN_ARM64=$(sha256sum release-artifacts/safe-chain-win-arm64.exe | awk '{print $1}') + + sed \ + -e "s/\$(fetch_latest_version)/${VERSION}/" \ + -e "s|^SHA256_MACOS_X64=\"\"|SHA256_MACOS_X64=\"${SHA_MACOS_X64}\"|" \ + -e "s|^SHA256_MACOS_ARM64=\"\"|SHA256_MACOS_ARM64=\"${SHA_MACOS_ARM64}\"|" \ + -e "s|^SHA256_LINUX_X64=\"\"|SHA256_LINUX_X64=\"${SHA_LINUX_X64}\"|" \ + -e "s|^SHA256_LINUX_ARM64=\"\"|SHA256_LINUX_ARM64=\"${SHA_LINUX_ARM64}\"|" \ + -e "s|^SHA256_LINUXSTATIC_X64=\"\"|SHA256_LINUXSTATIC_X64=\"${SHA_LINUXSTATIC_X64}\"|" \ + -e "s|^SHA256_LINUXSTATIC_ARM64=\"\"|SHA256_LINUXSTATIC_ARM64=\"${SHA_LINUXSTATIC_ARM64}\"|" \ + -e "s|^SHA256_WIN_X64=\"\"|SHA256_WIN_X64=\"${SHA_WIN_X64}\"|" \ + -e "s|^SHA256_WIN_ARM64=\"\"|SHA256_WIN_ARM64=\"${SHA_WIN_ARM64}\"|" \ + install-scripts/install-safe-chain.sh > release-artifacts/install-safe-chain.sh + + sed \ + -e "s/\$Version = Get-LatestVersion/\$Version = \"${VERSION}\"/" \ + -e "s|^\$SHA256_MACOS_X64 = \"\"|\$SHA256_MACOS_X64 = \"${SHA_MACOS_X64}\"|" \ + -e "s|^\$SHA256_MACOS_ARM64 = \"\"|\$SHA256_MACOS_ARM64 = \"${SHA_MACOS_ARM64}\"|" \ + -e "s|^\$SHA256_LINUX_X64 = \"\"|\$SHA256_LINUX_X64 = \"${SHA_LINUX_X64}\"|" \ + -e "s|^\$SHA256_LINUX_ARM64 = \"\"|\$SHA256_LINUX_ARM64 = \"${SHA_LINUX_ARM64}\"|" \ + -e "s|^\$SHA256_LINUXSTATIC_X64 = \"\"|\$SHA256_LINUXSTATIC_X64 = \"${SHA_LINUXSTATIC_X64}\"|" \ + -e "s|^\$SHA256_LINUXSTATIC_ARM64 = \"\"|\$SHA256_LINUXSTATIC_ARM64 = \"${SHA_LINUXSTATIC_ARM64}\"|" \ + -e "s|^\$SHA256_WIN_X64 = \"\"|\$SHA256_WIN_X64 = \"${SHA_WIN_X64}\"|" \ + -e "s|^\$SHA256_WIN_ARM64 = \"\"|\$SHA256_WIN_ARM64 = \"${SHA_WIN_ARM64}\"|" \ + install-scripts/install-safe-chain.ps1 > release-artifacts/install-safe-chain.ps1 + + cp install-scripts/uninstall-safe-chain.sh release-artifacts/uninstall-safe-chain.sh + cp install-scripts/uninstall-safe-chain.ps1 release-artifacts/uninstall-safe-chain.ps1 + cp install-scripts/install-endpoint-mac.sh release-artifacts/install-endpoint-mac.sh + cp install-scripts/install-endpoint-windows.ps1 release-artifacts/install-endpoint-windows.ps1 + cp install-scripts/uninstall-endpoint-mac.sh release-artifacts/uninstall-endpoint-mac.sh + cp install-scripts/uninstall-endpoint-windows.ps1 release-artifacts/uninstall-endpoint-windows.ps1 + + - name: Create draft release and upload assets + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + VERSION: ${{ needs.set-version.outputs.version }} + run: | + if ! gh release view "$VERSION" &>/dev/null; then + gh release create "$VERSION" --draft --title "$VERSION" --generate-notes + fi + gh release upload "$VERSION" --clobber \ + release-artifacts/safe-chain-macos-x64 \ + release-artifacts/safe-chain-macos-arm64 \ + release-artifacts/safe-chain-linux-x64 \ + release-artifacts/safe-chain-linux-arm64 \ + release-artifacts/safe-chain-linuxstatic-x64 \ + release-artifacts/safe-chain-linuxstatic-arm64 \ + release-artifacts/safe-chain-win-x64.exe \ + release-artifacts/safe-chain-win-arm64.exe \ + release-artifacts/install-safe-chain.sh \ + release-artifacts/install-safe-chain.ps1 \ + release-artifacts/uninstall-safe-chain.sh \ + release-artifacts/uninstall-safe-chain.ps1 \ + release-artifacts/install-endpoint-mac.sh \ + release-artifacts/install-endpoint-windows.ps1 \ + release-artifacts/uninstall-endpoint-mac.sh \ + release-artifacts/uninstall-endpoint-windows.ps1 + + publish-npm: + name: Publish to npm + if: github.event_name == 'release' runs-on: ubuntu-latest steps: @@ -40,16 +144,12 @@ jobs: with: node-version: "lts/*" registry-url: "https://registry.npmjs.org/" - env: - NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }} - name: Setup safe-chain - run: | - npm i -g @aikidosec/safe-chain - safe-chain setup-ci + run: curl -fsSL https://github.com/AikidoSec/safe-chain/releases/latest/download/install-safe-chain.sh | sh -s -- --ci - name: Set the version in safe-chain package - run: npm --no-git-tag-version version ${{ needs.set-version.outputs.version }} --workspace=packages/safe-chain + run: npm --no-git-tag-version version ${{ github.event.release.tag_name }} --workspace=packages/safe-chain - name: Install dependencies run: npm ci @@ -62,36 +162,15 @@ jobs: cp README.md packages/safe-chain/ cp LICENSE packages/safe-chain/ cp -r docs packages/safe-chain/ + cp npm-shrinkwrap.json packages/safe-chain/ - # - name: Publish to npm - # run: | - # echo "Publishing version ${{ steps.get_version.outputs.tag }} to NPM" - # npm publish --workspace=packages/safe-chain --access public --provenance - - - name: Download all binary artifacts - uses: actions/download-artifact@v4 - with: - path: binaries/ - pattern: safe-chain-* - merge-multiple: false - - - name: Rename binaries to include platform and architecture + - name: Publish to npm run: | - mv binaries/safe-chain-macos-x64/safe-chain binaries/safe-chain-macos-x64/safe-chain-macos-x64 - mv binaries/safe-chain-macos-arm64/safe-chain binaries/safe-chain-macos-arm64/safe-chain-macos-arm64 - mv binaries/safe-chain-linux-x64/safe-chain binaries/safe-chain-linux-x64/safe-chain-linux-x64 - mv binaries/safe-chain-linux-arm64/safe-chain binaries/safe-chain-linux-arm64/safe-chain-linux-arm64 - mv binaries/safe-chain-win-x64/safe-chain.exe binaries/safe-chain-win-x64/safe-chain-win-x64.exe - mv binaries/safe-chain-win-arm64/safe-chain.exe binaries/safe-chain-win-arm64/safe-chain-win-arm64.exe - - - name: Upload binaries to existing GitHub Release - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - run: | - gh release upload ${{ needs.set-version.outputs.version }} \ - binaries/safe-chain-macos-x64/* \ - binaries/safe-chain-macos-arm64/* \ - binaries/safe-chain-linux-x64/* \ - binaries/safe-chain-linux-arm64/* \ - binaries/safe-chain-win-x64/* \ - binaries/safe-chain-win-arm64/* + VERSION="${{ github.event.release.tag_name }}" + echo "Publishing version $VERSION to NPM" + if [[ "$VERSION" == *"-"* ]]; then + PRERELEASE_TAG=$(echo "$VERSION" | sed 's/.*-\([^-]*\)$/\1/') + npm publish --workspace=packages/safe-chain --access public --provenance --tag "$PRERELEASE_TAG" + else + npm publish --workspace=packages/safe-chain --access public --provenance + fi diff --git a/.github/workflows/bump-endpoint.yml b/.github/workflows/bump-endpoint.yml new file mode 100644 index 0000000..8c61826 --- /dev/null +++ b/.github/workflows/bump-endpoint.yml @@ -0,0 +1,82 @@ +name: Bump Device Protection Automatically + +on: + schedule: + - cron: '0 * * * *' # every hour + workflow_dispatch: + +permissions: + contents: write + pull-requests: write + +jobs: + bump-endpoint: + runs-on: open-source-releaser + steps: + - uses: actions/checkout@v4 + + - name: Get latest safechain-internals release + id: latest + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: | + VERSION=$(gh api repos/AikidoSec/safechain-internals/releases/latest --jq '.tag_name') + echo "version=$VERSION" >> $GITHUB_OUTPUT + + - name: Get current version from install script + id: current + run: | + CURRENT=$(grep -oP '(?<=releases/download/)[^/]+(?=/EndpointProtection\.pkg)' install-scripts/install-endpoint-mac.sh) + echo "version=$CURRENT" >> $GITHUB_OUTPUT + + - name: Download assets and compute checksums + if: steps.latest.outputs.version != steps.current.outputs.version + id: checksums + run: | + VERSION="${{ steps.latest.outputs.version }}" + BASE="https://github.com/AikidoSec/safechain-internals/releases/download/${VERSION}" + curl -fsSL "${BASE}/EndpointProtection.pkg" -o /tmp/EndpointProtection.pkg + curl -fsSL "${BASE}/EndpointProtection.msi" -o /tmp/EndpointProtection.msi + echo "mac=$(sha256sum /tmp/EndpointProtection.pkg | cut -d' ' -f1)" >> $GITHUB_OUTPUT + echo "win=$(sha256sum /tmp/EndpointProtection.msi | cut -d' ' -f1)" >> $GITHUB_OUTPUT + + - name: Update install scripts + if: steps.latest.outputs.version != steps.current.outputs.version + run: | + NEW="${{ steps.latest.outputs.version }}" + OLD="${{ steps.current.outputs.version }}" + MAC_SHA="${{ steps.checksums.outputs.mac }}" + WIN_SHA="${{ steps.checksums.outputs.win }}" + + sed -i "s|${OLD}/EndpointProtection.pkg|${NEW}/EndpointProtection.pkg|" install-scripts/install-endpoint-mac.sh + sed -i "s|^DOWNLOAD_SHA256=\"[^\"]*\"|DOWNLOAD_SHA256=\"${MAC_SHA}\"|" install-scripts/install-endpoint-mac.sh + + sed -i "s|${OLD}/EndpointProtection.msi|${NEW}/EndpointProtection.msi|" install-scripts/install-endpoint-windows.ps1 + sed -i 's|^\$DownloadSha256 = "[^"]*"|\$DownloadSha256 = "'"${WIN_SHA}"'"|' install-scripts/install-endpoint-windows.ps1 + + - name: Open PR + if: steps.latest.outputs.version != steps.current.outputs.version + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} + run: | + NEW="${{ steps.latest.outputs.version }}" + OLD="${{ steps.current.outputs.version }}" + BRANCH="bump/endpoint-${NEW}" + + if git ls-remote --exit-code --heads origin "$BRANCH" &>/dev/null; then + echo "Branch $BRANCH already exists, skipping." + exit 0 + fi + + git config user.name "github-actions[bot]" + git config user.email "github-actions[bot]@users.noreply.github.com" + git checkout -b "$BRANCH" + git add install-scripts/install-endpoint-mac.sh install-scripts/install-endpoint-windows.ps1 + git commit -m "Bump Endpoint to ${NEW}" + git push origin "$BRANCH" + PR_URL="https://github.com/${{ github.repository }}/compare/main...${BRANCH}?expand=1" + + curl -s -X POST "$SLACK_WEBHOOK_URL" \ + -H "Content-Type: application/json" \ + -d "{\"text\": \"update to ${NEW} - ${PR_URL}\"}" diff --git a/.github/workflows/create-artifact.yml b/.github/workflows/create-artifact.yml index ad43a9d..da2a1bd 100644 --- a/.github/workflows/create-artifact.yml +++ b/.github/workflows/create-artifact.yml @@ -5,7 +5,7 @@ on: workflow_call: inputs: version: - description: 'Version to set in package.json' + description: "Version to set in package.json" required: false type: string @@ -39,6 +39,16 @@ jobs: runner: ubuntu-24.04-arm target: node20-linux-arm64 extension: "" + - os: linuxstatic + arch: x64 + runner: ubuntu-latest + target: node20-linuxstatic-x64 + extension: "" + - os: linuxstatic + arch: arm64 + runner: ubuntu-24.04-arm + target: node20-linuxstatic-arm64 + extension: "" - os: win arch: x64 runner: windows-latest @@ -60,17 +70,19 @@ jobs: node-version: "20.x" - name: Setup safe-chain - run: | - npm i -g @aikidosec/safe-chain - safe-chain setup-ci - - - name: Set the version in safe-chain package - if: inputs.version != '' - run: npm --no-git-tag-version version ${{ inputs.version }} --workspace=packages/safe-chain + run: curl -fsSL https://github.com/AikidoSec/safe-chain/releases/latest/download/install-safe-chain.sh | sh -s -- --ci + shell: bash - name: Install dependencies run: npm ci --ignore-scripts + - name: Set the version in safe-chain package + if: inputs.version != '' + env: + VERSION: ${{ inputs.version }} + shell: bash + run: npm --no-git-tag-version version $VERSION --workspace=packages/safe-chain --ignore-scripts + - name: Create binary run: | node build.js ${{ matrix.target }} diff --git a/.github/workflows/test-on-pr.yml b/.github/workflows/test-on-pr.yml index f8087ef..744f52c 100644 --- a/.github/workflows/test-on-pr.yml +++ b/.github/workflows/test-on-pr.yml @@ -6,7 +6,12 @@ jobs: unit-test: name: Run unit tests and linting - runs-on: ubuntu-latest + runs-on: ${{ matrix.os }} + + strategy: + fail-fast: false + matrix: + os: [ubuntu-latest, windows-latest, macos-latest] steps: - name: Checkout code @@ -18,12 +23,11 @@ jobs: node-version: "lts/*" - name: Setup safe-chain - run: | - npm i -g @aikidosec/safe-chain - safe-chain setup-ci + run: curl -fsSL https://github.com/AikidoSec/safe-chain/releases/latest/download/install-safe-chain.sh | sh -s -- --ci + shell: bash - name: Install dependencies - run: npm ci + run: npm ci --ignore-scripts - name: Run unit tests run: npm test @@ -35,10 +39,12 @@ jobs: run: npm run typecheck --workspace=packages/safe-chain - name: Create package tarball + if: matrix.os == 'ubuntu-latest' run: npm pack --workspace=packages/safe-chain - name: Upload package tarball uses: actions/upload-artifact@v4 + if: matrix.os == 'ubuntu-latest' with: name: safe-chain-package path: aikidosec-safe-chain-*.tgz @@ -71,7 +77,7 @@ jobs: - node_version: "20" npm_version: "9.0.0" yarn_version: "latest" - pnpm_version: "latest" + pnpm_version: "10.0.0" # Version pinning scenario - node_version: "22" npm_version: "10.2.0" @@ -81,17 +87,12 @@ jobs: - node_version: "18" npm_version: "latest" yarn_version: "latest" - pnpm_version: "latest" + pnpm_version: "10.0.0" # Future compatibility (becomes LTS October 2025) - node_version: "24" npm_version: "latest" yarn_version: "latest" pnpm_version: "latest" - # EOL compatibility testing - Node 16 (EOL Sept 2023) - - node_version: "16" - npm_version: "8.0.0" - yarn_version: "1.22.0" - pnpm_version: "8.0.0" steps: - name: Checkout code @@ -103,9 +104,7 @@ jobs: node-version: "lts/*" - name: Setup safe-chain - run: | - npm i -g @aikidosec/safe-chain@1.0.24 - safe-chain setup-ci + run: curl -fsSL https://github.com/AikidoSec/safe-chain/releases/latest/download/install-safe-chain.sh | sh -s -- --ci - name: Install dependencies (root) run: npm ci diff --git a/.gitignore b/.gitignore index 7c44b34..920883f 100644 --- a/.gitignore +++ b/.gitignore @@ -148,3 +148,6 @@ Claude.md # Build files build/ dist/ + +# Jetbrains IDEs +.idea/** diff --git a/README.md b/README.md index 6e5470c..cb8f34b 100644 --- a/README.md +++ b/README.md @@ -1,68 +1,99 @@ -![Aikido Safe Chain](./docs/banner.svg) +![Aikido Safe Chain](https://raw.githubusercontent.com/AikidoSec/safe-chain/main/docs/banner.svg) # Aikido Safe Chain +[![NPM Version](https://img.shields.io/npm/v/%40aikidosec%2Fsafe-chain?style=flat-square)](https://www.npmjs.com/package/@aikidosec/safe-chain) +[![NPM Downloads](https://img.shields.io/npm/dw/%40aikidosec%2Fsafe-chain?style=flat-square)](https://www.npmjs.com/package/@aikidosec/safe-chain) + - ✅ **Block malware on developer laptops and CI/CD** - ✅ **Supports npm and PyPI** more package managers coming -- ✅ **Blocks packages newer than 24 hours** without breaking your build +- ✅ **Blocks packages newer than 48 hours** without breaking your build - ✅ **Tokenless, free, no build data shared** -Aikido Safe Chain works on Node.js version 16 and above and supports the following package managers: +## Need protection beyond npm & PyPI? + +[Aikido Endpoint](https://www.aikido.dev/protect/endpoint-protection?utm_source=github.com&utm_medium=referral&utm_campaign=safechain) builds on Safe Chain, extending package and extension security across more ecosystems: **npm**, **PyPI**, **Maven**, **NuGet**, **VS Code**, **Open VSX** - (Cursor, Windsurf, Kiro, Vs Codium, ...), **Chrome extensions**, **Skills.sh AI skills** and more. + +Get centralized policy management, request-and-approval workflows, and visibility across every developer workstation in your org. Powered by the same Aikido Intel feed. Deploy it manually or manage it through your MDM tool (Jamf, Fleet, or Iru). + +--- + +Aikido Safe Chain supports the following package managers: - 📦 **npm** - 📦 **npx** - 📦 **yarn** - 📦 **pnpm** - 📦 **pnpx** +- 📦 **rush** +- 📦 **rushx** - 📦 **bun** - 📦 **bunx** -- 📦 **pip** (beta) -- 📦 **pip3** (beta) -- 📦 **uv** (beta) +- 📦 **pip** +- 📦 **pip3** +- 📦 **uv** +- 📦 **poetry** +- 📦 **uvx** +- 📦 **pipx** +- 📦 **pdm** # Usage +![Aikido Safe Chain demo](https://raw.githubusercontent.com/AikidoSec/safe-chain/main/docs/safe-package-manager-demo.gif) + ## Installation Installing the Aikido Safe Chain is easy with our one-line installer. -> ⚠️ **Already installed via npm?** See the [migration guide](docs/npm-to-binary-migration.md) to switch to the binary version. - ### Unix/Linux/macOS -**Default installation (JavaScript packages only):** - ```shell -curl -fsSL https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.sh | sh -``` - -**Include Python support (pip/pip3/uv):** - -```shell -curl -fsSL https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.sh | sh -s -- --include-python +curl -fsSL https://github.com/AikidoSec/safe-chain/releases/latest/download/install-safe-chain.sh | sh ``` ### Windows (PowerShell) -**Default installation (JavaScript packages only):** - ```powershell -iex (iwr "https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.ps1" -UseBasicParsing) +iex (iwr "https://github.com/AikidoSec/safe-chain/releases/latest/download/install-safe-chain.ps1" -UseBasicParsing) ``` -**Include Python support (pip/pip3/uv):** +### Pinning to a specific version + +To install a specific version instead of the latest, replace `latest` with the version number in the URL (available from version 1.3.2 onwards): + +**Unix/Linux/macOS:** + +```shell +curl -fsSL https://github.com/AikidoSec/safe-chain/releases/download/x.x.x/install-safe-chain.sh | sh +``` + +**Windows (PowerShell):** ```powershell -iex "& { $(iwr 'https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.ps1' -UseBasicParsing) } -includepython" +iex (iwr "https://github.com/AikidoSec/safe-chain/releases/download/x.x.x/install-safe-chain.ps1" -UseBasicParsing) ``` +You can find all available versions on the [releases page](https://github.com/AikidoSec/safe-chain/releases). + ### Verify the installation 1. **❗Restart your terminal** to start using the Aikido Safe Chain. + - This step is crucial as it ensures that the shell aliases for npm, npx, yarn, pnpm, pnpx, rush, rushx, bun, bunx, pip, pip3, poetry, uv, uvx, pipx and pdm are loaded correctly. If you do not restart your terminal, the aliases will not be available. - - This step is crucial as it ensures that the shell aliases for npm, npx, yarn, pnpm, pnpx, bun, bunx, and pip/pip3 are loaded correctly. If you do not restart your terminal, the aliases will not be available. +2. **Verify the installation** by running the verification command: -2. **Verify the installation** by running one of the following commands: + ```shell + npm safe-chain-verify + pnpm safe-chain-verify + pip safe-chain-verify + uv safe-chain-verify + + # Any other supported package manager: {packagemanager} safe-chain-verify + ``` + + - The output should display "OK: Safe-chain works!" confirming that Aikido Safe Chain is properly installed and running. + +3. **(Optional) Test malware blocking** by attempting to install a test package: For JavaScript/Node.js: @@ -70,7 +101,7 @@ iex "& { $(iwr 'https://raw.githubusercontent.com/AikidoSec/safe-chain/main/inst npm install safe-chain-test ``` - For Python (if you enabled Python support): + For Python: ```shell pip3 install safe-chain-pi-test @@ -78,7 +109,7 @@ iex "& { $(iwr 'https://raw.githubusercontent.com/AikidoSec/safe-chain/main/inst - The output should show that Aikido Safe Chain is blocking the installation of these test packages as they are flagged as malware. -When running `npm`, `npx`, `yarn`, `pnpm`, `pnpx`, `bun`, `bunx`, `uv`, `pip`, or `pip3` commands, the Aikido Safe Chain will automatically check for malware in the packages you are trying to install. It also intercepts Python module invocations for pip when available (e.g., `python -m pip install ...`, `python3 -m pip download ...`). If any malware is detected, it will prompt you to exit the command. +When running `npm`, `npx`, `yarn`, `pnpm`, `pnpx`, `rush`, `rushx`, `bun`, `bunx`, `pip`, `pip3`, `uv`, `uvx`, `poetry`, `pipx` and `pdm` commands, the Aikido Safe Chain will automatically check for malware in the packages you are trying to install. It also intercepts Python module invocations for pip when available (e.g., `python -m pip install ...`, `python3 -m pip download ...`). If any malware is detected, it will prompt you to exit the command. You can check the installed version by running: @@ -90,17 +121,26 @@ safe-chain --version ### Malware Blocking -The Aikido Safe Chain works by running a lightweight proxy server that intercepts package downloads from the npm registry and PyPI. When you run npm, npx, yarn, pnpm, pnpx, bun, bunx, uv, `pip`, or `pip3` commands, all package downloads are routed through this local proxy, which verifies packages in real-time against **[Aikido Intel - Open Sources Threat Intelligence](https://intel.aikido.dev/?tab=malware)**. If malware is detected in any package (including deep dependencies), the proxy blocks the download before the malicious code reaches your machine. +The Aikido Safe Chain works by running a lightweight proxy server that intercepts package downloads from the npm registry and PyPI. When you run npm, npx, yarn, pnpm, pnpx, rush, rushx, bun, bunx, pip, pip3, uv, uvx, poetry, pipx or pdm commands, all package downloads are routed through this local proxy, which verifies packages in real-time against **[Aikido Intel - Open Sources Threat Intelligence](https://intel.aikido.dev/?tab=malware)**. If malware is detected in any package (including deep dependencies), the proxy blocks the download before the malicious code reaches your machine. -### Minimum package age (npm only) +### Minimum package age -For npm packages, Safe Chain temporarily suppresses packages published within the last 24 hours (by default) until they have been validated against malware. This provides an additional security layer during the critical period when newly published packages are most vulnerable to containing undetected threats. You can configure this threshold or bypass this protection entirely - see the [Minimum Package Age Configuration](#minimum-package-age) section below. +Safe Chain applies minimum package age checks to supported ecosystems. -⚠️ This feature **only applies to npm-based package managers** (npm, npx, yarn, pnpm, pnpx, bun, bunx) and does not apply to Python package managers (uv, pip, pip3). +Current enforcement differs by ecosystem: + +- npm-based package managers: + - during normal package resolution, Safe Chain suppresses versions that are newer than the configured minimum age from the package metadata returned by the registry + - for direct package download requests that bypass that metadata flow, Safe Chain can block the request itself using a cached list of newly released packages +- Python package managers: + - during package resolution, Safe Chain suppresses too-young files and releases from PyPI metadata responses + - for direct package download requests that bypass that metadata flow, Safe Chain can block the request itself using a cached list of newly released packages + +By default, the minimum package age is 48 hours. This provides an additional security layer during the critical period when newly published packages are most vulnerable to containing undetected threats. You can configure this threshold or bypass this protection entirely - see the [Minimum Package Age Configuration](#minimum-package-age) section below. ### Shell Integration -The Aikido Safe Chain integrates with your shell to provide a seamless experience when using npm, npx, yarn, pnpm, pnpx, bun, bunx, and Python package managers (uv, pip). It sets up aliases for these commands so that they are wrapped by the Aikido Safe Chain commands, which manage the proxy server before executing the original commands. We currently support: +The Aikido Safe Chain integrates with your shell to provide a seamless experience when using npm, npx, yarn, pnpm, pnpx, rush, rushx, bun, bunx, and Python package managers (pip, uv, uvx, poetry, pipx, pdm). It sets up aliases for these commands so that they are wrapped by the Aikido Safe Chain commands, which manage the proxy server before executing the original commands. We currently support: - ✅ **Bash** - ✅ **Zsh** @@ -108,47 +148,73 @@ The Aikido Safe Chain integrates with your shell to provide a seamless experienc - ✅ **PowerShell** - ✅ **PowerShell Core** -More information about the shell integration can be found in the [shell integration documentation](docs/shell-integration.md). +More information about the shell integration can be found in the [shell integration documentation](https://github.com/AikidoSec/safe-chain/blob/main/docs/shell-integration.md). ## Uninstallation -To uninstall the Aikido Safe Chain, you can run the following command: +To uninstall the Aikido Safe Chain, use our one-line uninstaller: -1. **Remove all aliases from your shell** by running: - ```shell - safe-chain teardown - ``` -2. **Uninstall the Aikido Safe Chain package** using npm: - ```shell - npm uninstall -g @aikidosec/safe-chain - ``` -3. **❗Restart your terminal** to remove the aliases. +### Unix/Linux/macOS + +```shell +curl -fsSL https://github.com/AikidoSec/safe-chain/releases/latest/download/uninstall-safe-chain.sh | sh +``` + +### Windows (PowerShell) + +```powershell +iex (iwr "https://github.com/AikidoSec/safe-chain/releases/latest/download/uninstall-safe-chain.ps1" -UseBasicParsing) +``` + +**❗Restart your terminal** after uninstalling to ensure all aliases are removed. # Configuration ## Logging -You can control the output from Aikido Safe Chain using the `--safe-chain-logging` flag: +You can control the output from Aikido Safe Chain using the `--safe-chain-logging` flag or the `SAFE_CHAIN_LOGGING` environment variable. -- `--safe-chain-logging=silent` - Suppresses all Aikido Safe Chain output except when malware is blocked. The package manager output is written to stdout as normal, and Safe Chain only writes a short message if it has blocked malware and causes the process to exit. +### Configuration Options - Example usage: +You can set the logging level through multiple sources (in order of priority): - ```shell - npm install express --safe-chain-logging=silent - ``` +1. **CLI Argument** (highest priority): + - `--safe-chain-logging=silent` - Suppresses all Aikido Safe Chain output except when malware is blocked. The package manager output is written to stdout as normal, and Safe Chain only writes a short message if it has blocked malware and causes the process to exit. -- `--safe-chain-logging=verbose` - Enables detailed diagnostic output from Aikido Safe Chain. Useful for troubleshooting issues or understanding what Safe Chain is doing behind the scenes. + ```shell + npm install express --safe-chain-logging=silent + ``` - Example usage: + - `--safe-chain-logging=verbose` - Enables detailed diagnostic output from Aikido Safe Chain. Useful for troubleshooting issues or understanding what Safe Chain is doing behind the scenes. - ```shell - npm install express --safe-chain-logging=verbose - ``` + ```shell + npm install express --safe-chain-logging=verbose + ``` + +2. **Environment Variable**: + + ```shell + export SAFE_CHAIN_LOGGING=verbose + npm install express + ``` + + Valid values: `silent`, `normal`, `verbose` + + This is useful for setting a default logging level for all package manager commands in your terminal session or CI/CD environment. ## Minimum Package Age -You can configure how long packages must exist before Safe Chain allows their installation. By default, packages must be at least 24 hours old before they can be installed through npm-based package managers. +You can configure how long packages must exist before Safe Chain allows their installation. By default, packages must be at least 48 hours old before they can be installed. + +For npm-based package managers, this check currently has two enforcement modes: + +- Safe Chain suppresses too-young versions from package metadata during normal dependency resolution. +- Safe Chain blocks direct package download requests when they are matched against the cached newly released packages list. + +For Python package managers, this check currently has two enforcement modes: + +- Safe Chain suppresses too-young files and releases from PyPI metadata during dependency resolution. +- Safe Chain blocks direct package download requests when they are matched against the cached newly released packages list. ### Configuration Options @@ -167,7 +233,7 @@ You can set the minimum package age through multiple sources (in order of priori npm install express ``` -3. **Config File** (`~/.aikido/config.json`): +3. **Config File** (`~/.safe-chain/config.json`): ```json { @@ -175,48 +241,145 @@ You can set the minimum package age through multiple sources (in order of priori } ``` +### Excluding Packages + +Exclude trusted packages from minimum age filtering via environment variable or config file (both are merged). Use `@scope/*` to trust all packages from an organization: + +```shell +export SAFE_CHAIN_MINIMUM_PACKAGE_AGE_EXCLUSIONS="@aikidosec/*" +``` + +```json +{ + "npm": { + "minimumPackageAgeExclusions": ["@aikidosec/*"] + }, + "pip": { + "minimumPackageAgeExclusions": ["requests"] + } +} +``` + +## Custom Registries + +Configure Safe Chain to scan packages from custom or private registries. + +Supported ecosystems: + +- Node.js +- Python + +### Configuration Options + +You can set custom registries through environment variable or config file. Both sources are merged together. + +1. **Environment Variable** (comma-separated): + + ```shell + export SAFE_CHAIN_NPM_CUSTOM_REGISTRIES="npm.company.com,registry.internal.net" + export SAFE_CHAIN_PIP_CUSTOM_REGISTRIES="pip.company.com,registry.internal.net" + ``` + +2. **Config File** (`~/.safe-chain/config.json`): + + ```json + { + "npm": { + "customRegistries": ["npm.company.com", "registry.internal.net"] + }, + "pip": { + "customRegistries": ["pip.company.com", "registry.internal.net"] + } + } + ``` + +## PYPI Configuration File + +If you rely on a `pip.conf` file for pip configuration you must point pip at it explicitly via the `PIP_CONFIG_FILE` environment variable so Safe Chain can merge it. + +Safe Chain runs pip behind its MITM proxy and writes a temporary pip configuration file to inject its certificate and proxy settings. When `PIP_CONFIG_FILE` is set, Safe Chain merges its settings into a copy of your file (your original file is never modified) so your `index-url`, credentials, and other options are preserved. When `PIP_CONFIG_FILE` is not set, pip's user-level config (e.g. `~/.config/pip/pip.conf`) might be overridden by Safe Chain's temporary file and your settings will not be picked up. + +## Malware List Base URL + +Configure Safe Chain to fetch malware databases and new packages lists from a custom mirror URL. This allows you to host your own copy of the Aikido malware database. + +### Configuration Options + +You can set the malware list base URL through multiple sources (in order of priority): + +1. **CLI Argument** (highest priority): + + ```shell + npm install express --safe-chain-malware-list-base-url=https://your-mirror.com + ``` + +2. **Environment Variable**: + + ```shell + export SAFE_CHAIN_MALWARE_LIST_BASE_URL=https://your-mirror.com + npm install express + ``` + +3. **Config File** (`~/.safe-chain/config.json`): + + ```json + { + "malwareListBaseUrl": "https://your-mirror.com" + } + ``` + +The base URL should point to a server that mirrors the structure of `https://malware-list.aikido.dev/`, including the following paths: +- `/malware_predictions.json` (JavaScript ecosystem malware database) +- `/malware_pypi.json` (Python ecosystem malware database) +- `/releases/npm.json` (JavaScript new packages list) +- `/releases/pypi.json` (Python new packages list) + +## Custom Install Directory + +By default, Safe Chain installs itself into `~/.safe-chain`. You can change this by passing an explicit install directory to the installer. This is useful for system-wide installations (e.g. inside a Docker image) or when you need to avoid conflicts with other tools. + +When set, all Safe Chain data (binary, shims, scripts, config) is placed under the custom directory instead of `~/.safe-chain`. + +### Unix/Linux/macOS + +```shell +curl -fsSL https://github.com/AikidoSec/safe-chain/releases/latest/download/install-safe-chain.sh | sh -s -- --install-dir /usr/local/.safe-chain +``` + +### Windows + +```powershell +iex "& { $(iwr 'https://github.com/AikidoSec/safe-chain/releases/latest/download/install-safe-chain.ps1' -UseBasicParsing) } -InstallDir 'C:\ProgramData\safe-chain'" +``` + # Usage in CI/CD You can protect your CI/CD pipelines from malicious packages by integrating Aikido Safe Chain into your build process. This ensures that any packages installed during your automated builds are checked for malware before installation. -For optimal protection in CI/CD environments, we recommend using **npm >= 10.4.0** as it provides full dependency tree scanning. Other package managers currently offer limited scanning of install command arguments only. - ## Installation for CI/CD Use the `--ci` flag to automatically configure Aikido Safe Chain for CI/CD environments. This sets up executable shims in the PATH instead of shell aliases. ### Unix/Linux/macOS (GitHub Actions, Azure Pipelines, etc.) -**JavaScript only:** - ```shell -curl -fsSL https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.sh | sh -s -- --ci -``` - -**With Python support:** - -```shell -curl -fsSL https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.sh | sh -s -- --ci --include-python +curl -fsSL https://github.com/AikidoSec/safe-chain/releases/latest/download/install-safe-chain.sh | sh -s -- --ci ``` ### Windows (Azure Pipelines, etc.) -**JavaScript only:** - ```powershell -iex "& { $(iwr 'https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.ps1' -UseBasicParsing) } -ci" -``` - -**With Python support:** - -```powershell -iex "& { $(iwr 'https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.ps1' -UseBasicParsing) } -ci -includepython" +iex "& { $(iwr 'https://github.com/AikidoSec/safe-chain/releases/latest/download/install-safe-chain.ps1' -UseBasicParsing) } -ci" ``` ## Supported Platforms - ✅ **GitHub Actions** - ✅ **Azure Pipelines** +- ✅ **CircleCI** +- ✅ **Jenkins** +- ✅ **Bitbucket Pipelines** +- ✅ **GitLab Pipelines** ## GitHub Actions Example @@ -228,14 +391,12 @@ iex "& { $(iwr 'https://raw.githubusercontent.com/AikidoSec/safe-chain/main/inst cache: "npm" - name: Install safe-chain - run: curl -fsSL https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.sh | sh -s -- --ci --include-python + run: curl -fsSL https://github.com/AikidoSec/safe-chain/releases/latest/download/install-safe-chain.sh | sh -s -- --ci - name: Install dependencies run: npm ci ``` -> **Note:** Remove `--include-python` if you don't need Python (pip/pip3/uv) support. - ## Azure DevOps Example ```yaml @@ -244,13 +405,162 @@ iex "& { $(iwr 'https://raw.githubusercontent.com/AikidoSec/safe-chain/main/inst versionSpec: "22.x" displayName: "Install Node.js" -- script: curl -fsSL https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.sh | sh -s -- --ci --include-python +- script: curl -fsSL https://github.com/AikidoSec/safe-chain/releases/latest/download/install-safe-chain.sh | sh -s -- --ci displayName: "Install safe-chain" - script: npm ci displayName: "Install dependencies" ``` -> **Note:** Remove `--include-python` if you don't need Python (pip/pip3/uv) support. +## CircleCI Example + +```yaml +version: 2.1 +jobs: + build: + docker: + - image: cimg/node:lts + steps: + - checkout + - run: | + curl -fsSL https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.sh | sh -s -- --ci + - run: npm ci +workflows: + build_and_test: + jobs: + - build +``` + +## Jenkins Example + +Note: This assumes Node.js and npm are installed on the Jenkins agent. + +```groovy +pipeline { + agent any + + environment { + // Jenkins does not automatically persist PATH updates from setup-ci, + // so add the shims + binary directory explicitly for all stages. + // If you installed into a custom directory, replace ~/.safe-chain with that path here. + PATH = "${env.HOME}/.safe-chain/shims:${env.HOME}/.safe-chain/bin:${env.PATH}" + } + + stages { + stage('Install safe-chain') { + steps { + sh ''' + set -euo pipefail + + # Install Safe Chain for CI + curl -fsSL https://github.com/AikidoSec/safe-chain/releases/latest/download/install-safe-chain.sh | sh -s -- --ci + ''' + } + } + + stage('Install project dependencies etc...') { + steps { + sh ''' + set -euo pipefail + npm ci + ''' + } + } + } +} +``` + +## Bitbucket Pipelines Example + +```yaml +image: node:22 + +steps: + - step: + name: Install + script: + - curl -fsSL https://github.com/AikidoSec/safe-chain/releases/latest/download/install-safe-chain.sh | sh -s -- --ci + - export PATH=~/.safe-chain/shims:~/.safe-chain/bin:$PATH + - npm ci +``` After setup, all subsequent package manager commands in your CI pipeline will automatically be protected by Aikido Safe Chain's malware detection. + +## GitLab Pipelines Example + +To add safe-chain in GitLab pipelines, you need to install it in the image running the pipeline. This can be done by: + +1. Define a dockerfile to run your build + + ```dockerfile + FROM node:lts + + # Install safe-chain + RUN curl -fsSL https://github.com/AikidoSec/safe-chain/releases/latest/download/install-safe-chain.sh | sh -s -- --ci + + # Add safe-chain to PATH (update paths if you used a custom install dir) + ENV PATH="/root/.safe-chain/shims:/root/.safe-chain/bin:${PATH}" + ``` + +2. Build the Docker image in your CI pipeline + + ```yaml + build-image: + stage: build-image + image: docker:latest + services: + - docker:dind + script: + - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY + - docker build -t $CI_REGISTRY_IMAGE:latest . + - docker push $CI_REGISTRY_IMAGE:latest + ``` + +3. Use the image in your pipeline: + ```yaml + npm-ci: + stage: install + image: $CI_REGISTRY_IMAGE:latest + script: + - npm ci + ``` + +The full pipeline for this example looks like this: + +```yaml +stages: + - build-image + - install + +build-image: + stage: build-image + image: docker:latest + services: + - docker:dind + script: + - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY + - docker build -t $CI_REGISTRY_IMAGE:latest . + - docker push $CI_REGISTRY_IMAGE:latest + +npm-ci: + stage: install + image: $CI_REGISTRY_IMAGE:latest + script: + - npm ci +``` + +# Troubleshooting + +Having issues? See the [Troubleshooting Guide](./docs/troubleshooting) for help with common problems. + +# Report Issues + +If you encounter problems: + +1. Visit [GitHub Issues](https://github.com/AikidoSec/safe-chain/issues) +2. Include: + * Operating system and version + * Shell type and version + * `safe-chain --version` output + * Output from verification commands + * Verbose logs of the failing command (add the `--safe-chain-logging=verbose` argument) diff --git a/build.js b/build.js index 24230cd..81619f4 100644 --- a/build.js +++ b/build.js @@ -1,6 +1,7 @@ import { build } from "esbuild"; -import { mkdir, cp, rm, readFile, writeFile } from "node:fs/promises"; +import { mkdir, cp, rm, readFile, writeFile, stat } from "node:fs/promises"; import { spawn } from "node:child_process"; +import { resolve } from "node:path"; const target = process.argv[2]; if (!target) { @@ -11,13 +12,33 @@ if (!target) { process.exit(1); } -(async function () { +(async function main() { + const startBuildTime = performance.now(); + await clearOutputFolder(); + console.log("- Cleared output folder ✅") + + // Esbuild creates a single safe-chain.cjs with all dependencies included await bundleSafeChain(); + console.log("- Bundled safe-chain into safe-chain.cjs (es-build) ✅") + + // Copy assets that need to be included in the binary + // - All shell scripts that are used to setup safe-chain + // - Certifi because it contains static root certs for Python + // - Package.json for its metadata (package name, version, ...) await copyShellScripts(); await copyCertifi(); await copyAndModifyPackageJson(); + console.log("- Copied auxiliary resources (shell, package.json,...) ✅") + + // Creates a single binary with safe-chain.cjs and the copied assets await buildSafeChainBinary(target); + console.log(`- Built safe-chain binary for ${target} (pkg) ✅`) + + + const totalBuildTime = (performance.now() - startBuildTime)/1000; + const totalSizeInMb = (await stat("./dist/safe-chain" + (process.platform === "win32" ? ".exe" : ""))).size / (1024*1024); + console.log(`🏁 Finished build in ${totalBuildTime.toFixed(2)}s, total build size: ${totalSizeInMb.toFixed(2)}MB`); })(); async function clearOutputFolder() { @@ -93,21 +114,25 @@ async function copyAndModifyPackageJson() { } function buildSafeChainBinary(target) { - return new Promise((resolve, reject) => { - const pkg = spawn( - "npx", - ["@yao-pkg/pkg", "./build/package.json", "-t", target], - { - stdio: "inherit", - shell: true, - } - ); + return new Promise((promiseResolve, reject) => { + // Use .cmd on Windows, resolve to absolute path for cross-platform compatibility + const pkgBin = process.platform === "win32" + ? resolve("node_modules/.bin/pkg.cmd") + : resolve("node_modules/.bin/pkg"); + + let pkgArgs = []; + + pkgArgs = pkgArgs.concat(["./build/package.json", "-t", target]); + const pkg = spawn(pkgBin, pkgArgs, { + stdio: "inherit", + shell: true, + }); pkg.on("close", (code) => { if (code !== 0) { reject(new Error(`pkg process exited with code ${code}`)); } else { - resolve(); + promiseResolve(); } }); }); diff --git a/docs/Release.md b/docs/Release.md new file mode 100644 index 0000000..ed116d2 --- /dev/null +++ b/docs/Release.md @@ -0,0 +1,25 @@ +# Release Guide + +## Steps + +### 1. Create and push a version tag + +```bash +git tag 1.0.0 +git push origin 1.0.0 +``` + +This triggers the build pipeline, which compiles binaries for all platforms and creates a draft GitHub release. + +### 2. Wait for artifacts to build + +Monitor the [Actions tab](https://github.com/AikidoSec/safe-chain/actions) until the `Create Release` workflow completes. + +### 3. Publish the GitHub release + +1. Go to the [Releases page](https://github.com/AikidoSec/safe-chain/releases) +2. Open the draft release created for your tag +3. Add release notes +4. Click **Publish release** + +Publishing the release automatically triggers an npm publish. Pre-release versions (e.g. `1.0.0-beta`) are published to npm under a tag matching the pre-release identifier (e.g. `beta`). Stable versions are published to the `latest` tag. diff --git a/docs/npm-to-binary-migration.md b/docs/npm-to-binary-migration.md deleted file mode 100644 index c0b8f9a..0000000 --- a/docs/npm-to-binary-migration.md +++ /dev/null @@ -1,89 +0,0 @@ -# Migrating from npm global tool to binary installation - -If you previously installed safe-chain as an npm global package, you need to migrate to the binary installation. - -Depending on the version manager you're using, the uninstall process differs: - -### Standard npm (no version manager) - -1. **Clean up shell aliases:** - - ```bash - safe-chain teardown - ``` - -2. **Restart your terminal** - -3. **Uninstall the npm package:** - - ```bash - npm uninstall -g @aikidosec/safe-chain - ``` - -4. **Install the binary version** (see [Installation](../README.md#installation)) - -### nvm (Node Version Manager) - -**Important:** nvm installs global packages separately for each Node version, so safe-chain must be uninstalled from each version where it was installed. - -1. **Clean up shell aliases:** - - ```bash - safe-chain teardown - ``` - -2. **Restart your terminal** - -3. **Uninstall from all Node versions:** - - **Option A** - Automated script (recommended): - - ```bash - for version in $(nvm list | grep -oE 'v[0-9]+\.[0-9]+\.[0-9]+'); do nvm use $version && npm uninstall -g @aikidosec/safe-chain; done - ``` - - **Option B** - Manual per version: - - ```bash - nvm use - npm uninstall -g @aikidosec/safe-chain - ``` - - Repeat for each Node version where safe-chain was installed. - -4. **Install the binary version** (see [Installation](../README.md#installation)) - -### Volta - -1. **Clean up shell aliases:** - - ```bash - safe-chain teardown - ``` - -2. **Restart your terminal** - -3. **Uninstall the Volta package:** - - ```bash - volta uninstall @aikidosec/safe-chain - ``` - -4. **Install the binary version** (see [Installation](../README.md#installation)) - -## Troubleshooting - -### Shell aliases still present after migration - -1. Run `safe-chain teardown` (if the binary is installed) -2. Manually remove any safe-chain entries from your shell config files: - - Bash: `~/.bashrc` - - Zsh: `~/.zshrc` - - Fish: `~/.config/fish/config.fish` - - PowerShell: `$PROFILE` -3. Restart your terminal -4. Re-run the install script - -### "command not found: safe-chain" after migration - -The binary installation directory (`~/.safe-chain/bin`) may not be in your PATH. Restart your terminal. If the problem persists: re-run the installation of safe-chain. diff --git a/docs/safe-package-manager-demo.gif b/docs/safe-package-manager-demo.gif index 9d22d8c..10cf972 100644 Binary files a/docs/safe-package-manager-demo.gif and b/docs/safe-package-manager-demo.gif differ diff --git a/docs/shell-integration.md b/docs/shell-integration.md index e7afbe5..d6cc0e0 100644 --- a/docs/shell-integration.md +++ b/docs/shell-integration.md @@ -2,7 +2,7 @@ ## Overview -The shell integration automatically wraps common package manager commands (`npm`, `npx`, `yarn`, `pnpm`, `pnpx`, `bun`, `bunx`, `pip`, `pip3`) with Aikido's security scanning functionality. It also intercepts Python module invocations for pip when available: `python -m pip`, `python -m pip3`, `python3 -m pip`, `python3 -m pip3`. This is achieved by sourcing startup scripts that define shell functions to wrap these commands with their Aikido-protected equivalents. +The shell integration automatically wraps common package manager commands (`npm`, `npx`, `yarn`, `pnpm`, `pnpx`, `rush`, `rushx`, `bun`, `bunx`, `pip`, `pip3`, `uv`, `uvx`, `poetry`, `pipx`) with Aikido's security scanning functionality. It also intercepts Python module invocations for pip when available: `python -m pip`, `python -m pip3`, `python3 -m pip`, `python3 -m pip3`. This is achieved by sourcing startup scripts that define shell functions to wrap these commands with their Aikido-protected equivalents. ## Supported Shells @@ -28,7 +28,7 @@ This command: - Copies necessary startup scripts to Safe Chain's installation directory (`~/.safe-chain/scripts`) - Detects all supported shells on your system -- Sources each shell's startup file to add Safe Chain functions for `npm`, `npx`, `yarn`, `pnpm`, `pnpx`, `bun`, `bunx`, `pip`, and `pip3` +- Sources each shell's startup file to add Safe Chain functions for `npm`, `npx`, `yarn`, `pnpm`, `pnpx`, `rush`, `rushx`, `bun`, `bunx`, `pip`, `pip3`, `uv`, `uvx`, `poetry` and `pipx` - Adds lightweight interceptors so `python -m pip[...]` and `python3 -m pip[...]` route through Safe Chain when invoked by name ❗ After running this command, **you must restart your terminal** for the changes to take effect. This ensures that the startup scripts are sourced correctly. @@ -78,7 +78,7 @@ The system modifies the following files to source Safe Chain startup scripts: This means the shell functions are working but the Aikido commands aren't installed or available in your PATH: - Make sure Aikido Safe Chain is properly installed on your system -- Verify the `aikido-npm`, `aikido-npx`, `aikido-yarn`, `aikido-pnpm`, `aikido-pnpx`, `aikido-bun`, `aikido-bunx`, `aikido-pip`, and `aikido-pip3` commands exist +- Verify the `aikido-npm`, `aikido-npx`, `aikido-yarn`, `aikido-pnpm`, `aikido-pnpx`, `aikido-rush`, `aikido-rushx`, `aikido-bun`, `aikido-bunx`, `aikido-pip`, `aikido-pip3`, `aikido-uv`, `aikido-uvx`, `aikido-poetry` and `aikido-pipx` commands exist - Check that these commands are in your system's PATH ### Manual Verification @@ -121,7 +121,7 @@ npm() { } ``` -Repeat this pattern for `npx`, `yarn`, `pnpm`, `pnpx`, `bun`, `bunx`, `pip`, and `pip3` using their respective `aikido-*` commands. After adding these functions, restart your terminal to apply the changes. +Repeat this pattern for `npx`, `yarn`, `pnpm`, `pnpx`, `rush`, `rushx`, `bun`, `bunx`, `pip`, `pip3`, `uv`, `uvx`, `poetry` and `pipx` using their respective `aikido-*` commands. After adding these functions, restart your terminal to apply the changes. To intercept Python module invocations for pip without altering Python itself, you can add small forwarding functions: diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md new file mode 100644 index 0000000..4672849 --- /dev/null +++ b/docs/troubleshooting.md @@ -0,0 +1,298 @@ +# Troubleshooting + +This guide helps you diagnose and resolve common issues with Aikido Safe Chain. + +## Verification & Diagnostics + +**Check Installation** + +```bash +# Check version +safe-chain --version +``` + +**Verify Shell Integration** + +Run the verification command for your package manager: + +```bash +npm safe-chain-verify +pnpm safe-chain-verify +``` + +``` +Expected output: `OK: Safe-chain works!` +``` + +**Test Malware Blocking** + +Verify that malware detection is working: +``` +npm install safe-chain-test +``` + +These test packages are flagged as malware and should be blocked by Safe Chain. + +**If the test package installs successfully instead of being blocked**, see Malware Not Being Blocked below. + +## Logging Options + +Use logging flags or environment variables to get more information: + +```bash +# Verbose mode - detailed diagnostic output for troubleshooting +npm install express --safe-chain-logging=verbose + +# Or set it globally for all commands in your session +export SAFE_CHAIN_LOGGING=verbose +npm install express + +# Silent mode - suppress all output except malware blocking +npm install express --safe-chain-logging=silent +``` + +## Common Issues + +### Malware Not Being Blocked + +**Symptom:** Test malware packages (like `safe-chain-test`) install successfully when they should be blocked + +**Most Common Cause:** The package is cached in your package manager's local store + +Safe-chain blocks malicious packages by intercepting network requests to package registries using its proxy. + +When a package is already cached locally, the package manager skips downloading it from the registry, which bypasses the proxy. + +**Resolution Steps** + +1) Clear your package manager's cache + +```bash +# For npm +npm cache clean --force + +# For pnpm +pnpm store prune + +# For yarn (classic) +yarn cache clean + +# For yarn (berry/v2+) +yarn cache clean --all + +# For bun +bun pm cache rm +``` + +2) Clean local installation artifacts: + +```bash +# Remove node_modules if you want a completely fresh install +rm -rf node_modules +``` + +3) Re-test malware blocking: + +```bash +npm install safe-chain-test # Should be blocked +``` + +### Shell Aliases Not Working After Installation + +**Symptom:** Running `npm` shows regular npm instead of safe-chain wrapped version + +**First step:** Restart your terminal (most common fix) + +**Verify it's working:** + +```bash +type npm +``` + +Should show: `npm is a function` + +**If still not working:** + +Check that your startup file sources safe-chain scripts from `~/.safe-chain/scripts/`: + +* Bash: `~/.bashrc` +* Zsh: `~/.zshrc` +* Fish: `~/.config/fish/config.fish` +* PowerShell: `$PROFILE` + +### "Command Not Found: safe-chain" + +**Symptom:** Binary not found in PATH + +**First step:** Restart your terminal + +**Check PATH:** + +```bash +echo $PATH +``` + +Should include `~/.safe-chain/bin` + +**If persists:** Re-run the installation script + +### PowerShell Execution Policy Blocks Scripts (Windows) + +**Symptom:** When opening PowerShell, you see an error like: + +``` +. : File C:\Users\\Documents\WindowsPowerShell\Microsoft.PowerShell_profile.ps1 cannot be loaded because +running scripts is disabled on this system. +CategoryInfo : SecurityError: (:) [], PSSecurityException +FullyQualifiedErrorId : UnauthorizedAccess +``` + +**Cause:** Windows PowerShell's default execution policy (`Restricted`) blocks all script execution, including safe-chain's initialization script that's sourced from your PowerShell profile. + +**Resolution** + +1) Set the execution policy to allow local scripts + +Open PowerShell as Administrator and run: + +```powershell +Set-ExecutionPolicy -ExecutionPolicy RemoteSigned +``` + +This allows: + +* Local scripts (like safe-chain's) to run without signing +* Downloaded scripts to run only if signed by a trusted publisher + +2) Restart PowerShell and verify the error is resolved. + +> [!IMPORTANT] +> `RemoteSigned` is Microsoft's recommended execution policy for client computers. It provides a good balance between security and usability. + +### Shell Aliases Persist After Uninstallation + +**Symptom:** safe-chain commands still active after running uninstall script + +**Steps** + +1. Run `safe-chain teardown` (if binary still exists) +2. Restart your terminal +3. If still present, manually edit shell config files: + * Bash: `~/.bashrc` + * Zsh: `~/.zshrc` + * Fish: `~/.config/fish/config.fish` + * PowerShell: `$PROFILE` +4. Remove lines that source scripts from `~/.safe-chain/scripts/` +5. Restart terminal again + +## Manual Verification Steps + +### Check Installation Status + +```bash +# Check installation location (helps identify if installed via npm or as standalone binary) +which safe-chain + +# Verify binary exists +ls ~/.safe-chain/bin/safe-chain + +# Check version +safe-chain --version + +# Test shell integration +type npm +type pip +``` + +**Expected `which` output:** + +* Standalone binary (correct): `~/.safe-chain/bin/safe-chain` or `/Users//.safe-chain/bin/safe-chain` +* npm global (outdated): path containing `node_modules` or nvm version paths + +If `which` shows an npm installation, see Check for Conflicting Installations. + +### Check Shell Integration + +```bash +# Which shell you're using +echo $SHELL + +# Check if startup file sources safe-chain +# For Bash: +grep safe-chain ~/.bashrc + +# For Zsh: +grep safe-chain ~/.zshrc + +# For Fish: +grep safe-chain ~/.config/fish/config.fish + +# Verify scripts exist +ls ~/.safe-chain/scripts/ +``` + +### Check for Conflicting Installations + +> **Note:** The install/uninstall scripts automatically detect and remove conflicting installations, but you can manually check: + +```bash +# Check npm global +npm list -g @aikidosec/safe-chain + +# Check Volta +volta list safe-chain + +# Check nvm (all versions) +for version in $(nvm list | grep -oE 'v[0-9]+\.[0-9]+\.[0-9]+'); do + nvm exec "$version" npm list -g @aikidosec/safe-chain 2>/dev/null && echo "Found in $version" +done +``` + +### Manual Cleanup + +> **Note:** The install and uninstall scripts automatically handle these cleanup steps. Use these manual commands only if automatic cleanup fails. + +#### Remove npm Global Installation + +```bash +npm uninstall -g @aikidosec/safe-chain +``` + +#### Remove Volta Installation + +```bash +volta uninstall @aikidosec/safe-chain +``` + +#### Remove nvm Installations (All Versions) + +```bash +# Automated approach +for version in $(nvm list | grep -oE 'v[0-9]+\.[0-9]+\.[0-9]+'); do + nvm exec "$version" npm uninstall -g @aikidosec/safe-chain +done + +# Or manual per version +nvm use +npm uninstall -g @aikidosec/safe-chain +``` + +#### Clean Shell Configuration Files + +Manually remove safe-chain entries from: + +* Bash: `~/.bashrc` +* Zsh: `~/.zshrc` +* Fish: `~/.config/fish/config.fish` +* PowerShell: `$PROFILE` + +Look for and remove: + +* Lines sourcing from `~/.safe-chain/scripts/` +* Any safe-chain related function definitions + +#### Remove Installation Directory + +```bash +rm -rf ~/.safe-chain +``` diff --git a/install-scripts/install-endpoint-mac.sh b/install-scripts/install-endpoint-mac.sh new file mode 100755 index 0000000..4cb9e9a --- /dev/null +++ b/install-scripts/install-endpoint-mac.sh @@ -0,0 +1,133 @@ +#!/bin/sh + +# Downloads and installs Aikido Endpoint Protection on macOS +# +# Usage: curl -fsSL | sudo sh -s -- --token + +set -e # Exit on error + +# Configuration +INSTALL_URL="https://github.com/AikidoSec/safechain-internals/releases/download/v1.5.4/EndpointProtection.pkg" +DOWNLOAD_SHA256="ad800f9e476b0a75bf32b1c079f060ecb98bc16972a4e8cca29cf165388ea9fe" +TOKEN_FILE="/tmp/aikido_endpoint_token.txt" + +# Colors for output +RED='\033[0;31m' +GREEN='\033[0;32m' +NC='\033[0m' # No Color + +# Helper functions +info() { + printf "${GREEN}[INFO]${NC} %s\n" "$1" +} + +error() { + printf "${RED}[ERROR]${NC} %s\n" "$1" >&2 + exit 1 +} + +# Download file +download() { + url="$1" + dest="$2" + + if command -v curl >/dev/null 2>&1; then + curl -fsSL "$url" -o "$dest" || error "Failed to download from $url" + elif command -v wget >/dev/null 2>&1; then + wget -q "$url" -O "$dest" || error "Failed to download from $url" + else + error "Neither curl nor wget found. Please install one of them." + fi +} + +# Verify SHA256 checksum +verify_checksum() { + file="$1" + expected="$2" + + actual=$(shasum -a 256 "$file" | awk '{ print $1 }') + + if [ "$actual" != "$expected" ]; then + error "Checksum verification failed. Expected: $expected, Got: $actual" + fi + + info "Checksum verified successfully." +} + +# Cleanup temporary files +cleanup() { + if [ -f "$PKG_FILE" ]; then + rm -f "$PKG_FILE" + fi + if [ -f "$TOKEN_FILE" ]; then + rm -f "$TOKEN_FILE" + fi +} + +# Parse command-line arguments +parse_arguments() { + TOKEN="" + + while [ $# -gt 0 ]; do + case "$1" in + --token) + if [ -z "${2:-}" ]; then + error "--token requires a value" + fi + TOKEN="$2" + shift 2 + ;; + *) + error "Unknown argument: $1" + ;; + esac + done +} + +# Main installation +main() { + parse_arguments "$@" + + # 1. Check if we're running on macOS + if [ "$(uname -s)" != "Darwin" ]; then + error "This script is only supported on macOS." + fi + + # Check if we're running as root + if [ "$(id -u)" -ne 0 ]; then + error "Root privileges required. Please re-run with sudo, e.g.: curl -fsSL | sudo sh -s -- --token " + fi + + # Check if token is provided via command argument + if [ -z "$TOKEN" ]; then + error "Token is required. Pass it with --token or enter it when prompted." + fi + + # Validate token to prevent injection + case "$TOKEN" in + *[\"\'\;\`\$\ ]*) + error "Invalid token format. Token must not contain quotes, semicolons, backticks, dollar signs, or whitespace." + ;; + esac + + # 2. Download and verify checksum + PKG_FILE=$(mktemp /tmp/AikidoEndpoint.XXXXXX.pkg) + trap cleanup EXIT + + info "Downloading Aikido Endpoint Protection..." + download "$INSTALL_URL" "$PKG_FILE" + + info "Verifying checksum..." + verify_checksum "$PKG_FILE" "$DOWNLOAD_SHA256" + + # 3. Write token to file for the installer + printf "%s" "$TOKEN" > "$TOKEN_FILE" + + # 4. Install the package + info "Installing Aikido Endpoint Protection..." + installer -pkg "$PKG_FILE" -target / + + info "Aikido Endpoint Protection installed successfully!" +} + +main "$@" diff --git a/install-scripts/install-endpoint-windows.ps1 b/install-scripts/install-endpoint-windows.ps1 new file mode 100644 index 0000000..05da8b4 --- /dev/null +++ b/install-scripts/install-endpoint-windows.ps1 @@ -0,0 +1,100 @@ +# Downloads and installs Aikido Endpoint Protection on Windows +# +# Usage: iex "& { $(iwr '' -UseBasicParsing) } -token " + +param( + [string]$token +) + +# Configuration +$InstallUrl = "https://github.com/AikidoSec/safechain-internals/releases/download/v1.5.4/EndpointProtection.msi" +$DownloadSha256 = "e2750c59124f53456a8f9cdb9e81fd9ce2f2491869f68f01602444ad519be5be" + +# Ensure TLS 1.2 is enabled for downloads +[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 + +# Helper functions +function Write-Info { + param([string]$Message) + Write-Host "[INFO] $Message" -ForegroundColor Green +} + +function Write-Error-Custom { + param([string]$Message) + Write-Host "[ERROR] $Message" -ForegroundColor Red + exit 1 +} + +# Check if running as Administrator +function Test-Administrator { + $identity = [Security.Principal.WindowsIdentity]::GetCurrent() + $principal = New-Object Security.Principal.WindowsPrincipal($identity) + return $principal.IsInRole([Security.Principal.WindowsBuiltInRole]::Administrator) +} + +# Main installation +function Install-Endpoint { + # 1. Check if we're running as Administrator + if (-not (Test-Administrator)) { + Write-Error-Custom "Administrator privileges required. Please run this script in an elevated terminal (Run as Administrator)." + } + + # Check if token is provided, prompt if not + if ([string]::IsNullOrWhiteSpace($token)) { + $token = Read-Host "Enter your Aikido endpoint token" + if ([string]::IsNullOrWhiteSpace($token)) { + Write-Error-Custom "Token is required. Pass it with -token or enter it when prompted." + } + } + + # Validate token to prevent command/property injection via msiexec + if ($token -match '[";`$\s]') { + Write-Error-Custom "Invalid token format. Token must not contain quotes, semicolons, backticks, dollar signs, or whitespace." + } + + # 2. Download the .msi + $msiFile = Join-Path $env:TEMP "AikidoEndpoint-$([System.Guid]::NewGuid().ToString('N')).msi" + + Write-Info "Downloading Aikido Endpoint Protection..." + try { + $ProgressPreference = 'SilentlyContinue' + Invoke-WebRequest -Uri $InstallUrl -OutFile $msiFile -UseBasicParsing + $ProgressPreference = 'Continue' + } + catch { + Write-Error-Custom "Failed to download from $InstallUrl : $_" + } + + try { + # Verify SHA256 checksum + Write-Info "Verifying checksum..." + $actualHash = (Get-FileHash -Path $msiFile -Algorithm SHA256).Hash.ToLower() + if ($actualHash -ne $DownloadSha256) { + Write-Error-Custom "Checksum verification failed. Expected: $DownloadSha256, Got: $actualHash" + } + Write-Info "Checksum verified successfully." + + # 3. Install the package with token passed as MSI property + Write-Info "Installing Aikido Endpoint Protection..." + $process = Start-Process -FilePath "msiexec" -ArgumentList "/i", "`"$msiFile`"", "/qn", "/norestart", "AIKIDO_TOKEN=$token" -Wait -PassThru + if ($process.ExitCode -ne 0) { + Write-Error-Custom "MSI installer failed (exit code: $($process.ExitCode))." + } + + Write-Info "Aikido Endpoint Protection installed successfully!" + } + finally { + # Cleanup + if (Test-Path $msiFile) { + Remove-Item -Path $msiFile -Force -ErrorAction SilentlyContinue + } + } +} + +# Run installation +try { + Install-Endpoint +} +catch { + Write-Error-Custom "Installation failed: $_" +} diff --git a/install-scripts/install-safe-chain.ps1 b/install-scripts/install-safe-chain.ps1 index dcffe8a..53ce15f 100644 --- a/install-scripts/install-safe-chain.ps1 +++ b/install-scripts/install-safe-chain.ps1 @@ -1,28 +1,71 @@ # Downloads and installs safe-chain for Windows # -# Usage examples: -# -# Default (JavaScript packages only): -# iex (iwr "https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.ps1" -UseBasicParsing) -# -# CI setup (JavaScript packages only): -# iex "& { $(iwr 'https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.ps1' -UseBasicParsing) } -ci" -# -# Include Python packages: -# iex "& { $(iwr 'https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.ps1' -UseBasicParsing) } -includepython" -# -# CI setup with Python packages: -# iex "& { $(iwr 'https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.ps1' -UseBasicParsing) } -ci -includepython" +# Usage with "iex (iwr {url} -UseBasicParsing)" --> See README.md param( [switch]$ci, - [switch]$includepython + [switch]$includepython, + [string]$InstallDir ) -$Version = "v0.0.5-binaries-beta" -$InstallDir = Join-Path $env:USERPROFILE ".safe-chain\bin" +# Validates and normalizes the requested install directory. +# Rejects non-absolute, root, PATH-like, and traversal-containing paths. +function Test-InstallDir { + param([string]$Dir) + + if ([string]::IsNullOrWhiteSpace($Dir)) { + return @{ Ok = $true; Normalized = $null } + } + + if (-not [System.IO.Path]::IsPathRooted($Dir)) { + return @{ Ok = $false; Reason = "-InstallDir must be an absolute path, got: $Dir" } + } + + if ($Dir.Contains([System.IO.Path]::PathSeparator)) { + return @{ Ok = $false; Reason = "-InstallDir must not contain the PATH separator ($([System.IO.Path]::PathSeparator))" } + } + + $inputSegments = $Dir.Split([char[]]@('\', '/'), [System.StringSplitOptions]::RemoveEmptyEntries) + if ($inputSegments -contains "..") { + return @{ Ok = $false; Reason = "-InstallDir must not contain path traversal segments" } + } + + $normalized = [System.IO.Path]::GetFullPath($Dir) + $root = [System.IO.Path]::GetPathRoot($normalized) + if ($normalized.TrimEnd('\', '/') -eq $root.TrimEnd('\', '/')) { + return @{ Ok = $false; Reason = "-InstallDir cannot be a root or drive-root directory" } + } + + return @{ Ok = $true; Normalized = $normalized } +} + +$Version = $env:SAFE_CHAIN_VERSION # Will be fetched from latest release if not set +$SafeChainBase = if ($InstallDir) { $InstallDir } else { Join-Path $HOME ".safe-chain" } + +$installDirValidation = Test-InstallDir -Dir $SafeChainBase +if (-not $installDirValidation.Ok) { + Write-Host "[ERROR] $($installDirValidation.Reason)" -ForegroundColor Red + exit 1 +} + +$SafeChainBase = $installDirValidation.Normalized +$InstallDir = Join-Path $SafeChainBase "bin" $RepoUrl = "https://github.com/AikidoSec/safe-chain" +# SHA256 checksums for release binaries. +# Empty in source; populated by the release pipeline. +# When empty (running from main), checksum verification is skipped. +# Non-Windows hashes are unused today (PS script is Windows-only) but baked in +# for future cross-platform support. +$SHA256_MACOS_X64 = "" +$SHA256_MACOS_ARM64 = "" +$SHA256_LINUX_X64 = "" +$SHA256_LINUX_ARM64 = "" +$SHA256_LINUXSTATIC_X64 = "" +$SHA256_LINUXSTATIC_ARM64 = "" +$SHA256_WIN_X64 = "" +$SHA256_WIN_ARM64 = "" + # Ensure TLS 1.2 is enabled for downloads [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 @@ -43,6 +86,63 @@ function Write-Error-Custom { exit 1 } +# Get currently installed version of safe-chain +function Get-InstalledVersion { + # Check if safe-chain command exists + if (-not (Get-Command safe-chain -ErrorAction SilentlyContinue)) { + return $null + } + + try { + # Execute safe-chain -v and capture output + $output = & safe-chain -v 2>&1 + + # Extract version from "Current safe-chain version: X.Y.Z" output + if ($output -match "Current safe-chain version:\s*(.+)") { + return $matches[1].Trim() + } + + return $null + } + catch { + return $null + } +} + +# Check if the requested version is already installed +function Test-VersionInstalled { + param([string]$RequestedVersion) + + $installedVersion = Get-InstalledVersion + + if ([string]::IsNullOrWhiteSpace($installedVersion)) { + return $false + } + + # Strip leading 'v' from versions if present for comparison + $requestedClean = $RequestedVersion -replace '^v', '' + $installedClean = $installedVersion -replace '^v', '' + + return $requestedClean -eq $installedClean +} + +# Fetch latest release version tag from GitHub +function Get-LatestVersion { + try { + $response = Invoke-RestMethod -Uri "https://api.github.com/repos/AikidoSec/safe-chain/releases/latest" -UseBasicParsing + $latestVersion = $response.tag_name + + if ([string]::IsNullOrWhiteSpace($latestVersion)) { + Write-Error-Custom "Failed to fetch latest version from GitHub API. Please set SAFE_CHAIN_VERSION environment variable." + } + + return $latestVersion + } + catch { + Write-Error-Custom "Failed to fetch latest version from GitHub API: $($_.Exception.Message). Please set SAFE_CHAIN_VERSION environment variable." + } +} + # Detect architecture function Get-Architecture { $arch = $env:PROCESSOR_ARCHITECTURE @@ -53,6 +153,91 @@ function Get-Architecture { } } +# Emits the deprecation warning for SAFE_CHAIN_VERSION and prints the version-pinned install command. +# Returns immediately when no version was provided through the environment. +function Write-VersionDeprecationWarning { + if ([string]::IsNullOrWhiteSpace($env:SAFE_CHAIN_VERSION)) { + return + } + + Write-Warn "SAFE_CHAIN_VERSION environment variable is deprecated." + Write-Warn "" + Write-Warn "Please use direct download URLs for version pinning instead:" + Write-Warn "" + if ($ci) { + Write-Warn " iex `"& { `$(iwr 'https://github.com/AikidoSec/safe-chain/releases/download/$env:SAFE_CHAIN_VERSION/install-safe-chain.ps1' -UseBasicParsing) } -ci`"" + } else { + Write-Warn " iex (iwr `"https://github.com/AikidoSec/safe-chain/releases/download/$env:SAFE_CHAIN_VERSION/install-safe-chain.ps1`" -UseBasicParsing)" + } + Write-Warn "" +} + +# Builds the Windows release binary filename for the detected architecture. +# Centralizes binary name generation for the download step. +function Get-BinaryName { + param([string]$Architecture) + + return "safe-chain-win-$Architecture.exe" +} + +# Returns the expected SHA256 for the given OS+arch, or empty if not baked in. +function Get-ExpectedSha256 { + param([string]$Os, [string]$Architecture) + switch ("$Os-$Architecture") { + "macos-x64" { return $SHA256_MACOS_X64 } + "macos-arm64" { return $SHA256_MACOS_ARM64 } + "linux-x64" { return $SHA256_LINUX_X64 } + "linux-arm64" { return $SHA256_LINUX_ARM64 } + "linuxstatic-x64" { return $SHA256_LINUXSTATIC_X64 } + "linuxstatic-arm64" { return $SHA256_LINUXSTATIC_ARM64 } + "win-x64" { return $SHA256_WIN_X64 } + "win-arm64" { return $SHA256_WIN_ARM64 } + default { return "" } + } +} + +function Test-Checksum { + param([string]$File, [string]$Expected) + + if ([string]::IsNullOrWhiteSpace($Expected)) { return } + + $actual = (Get-FileHash -Path $File -Algorithm SHA256).Hash.ToLowerInvariant() + $expectedLower = $Expected.ToLowerInvariant() + + if ($actual -ne $expectedLower) { + Remove-Item -Path $File -Force -ErrorAction SilentlyContinue + Write-Error-Custom "Checksum verification failed. Expected: $expectedLower, Got: $actual" + } + + Write-Info "Checksum verified." +} + +# Runs safe-chain setup or setup-ci after the binary is installed. +# Temporarily appends the install directory to PATH and downgrades setup failures to warnings. +function Invoke-SafeChainSetup { + param( + [string]$BinaryPath, + [string]$InstallDirectory + ) + + $setupCmd = if ($ci) { "setup-ci" } else { "setup" } + + Write-Info "Running safe-chain $setupCmd..." + try { + $env:Path = "$env:Path;$InstallDirectory" + & $BinaryPath $setupCmd + + if ($LASTEXITCODE -ne 0) { + Write-Warn "safe-chain was installed but setup encountered issues." + Write-Warn "You can run 'safe-chain $setupCmd' manually later." + } + } + catch { + Write-Warn "safe-chain was installed but setup encountered issues: $_" + Write-Warn "You can run 'safe-chain $setupCmd' manually later." + } +} + # Check and uninstall npm global package if present function Remove-NpmInstallation { # Check if npm is available @@ -104,17 +289,38 @@ function Remove-VoltaInstallation { # Main installation function Install-SafeChain { - Write-Info "Installing safe-chain $Version..." + Write-VersionDeprecationWarning - # Check for existing npm installation + # Fetch latest version if VERSION is not set + if ([string]::IsNullOrWhiteSpace($Version)) { + Write-Info "Fetching latest release version..." + $Version = Get-LatestVersion + } + + # Check if the requested version is already installed + if (Test-VersionInstalled -RequestedVersion $Version) { + Write-Info "safe-chain $Version is already installed" + return + } + + # Build installation message + $installMsg = "Installing safe-chain $Version" + if ($ci) { + $installMsg += " in ci" + } + if ($includepython) { + Write-Warn "-includepython is deprecated and ignored. Python ecosystem is now included by default." + } + + Write-Info $installMsg + + # Check for existing safe-chain installation through npm or volta Remove-NpmInstallation - - # Check for existing Volta installation Remove-VoltaInstallation # Detect platform $arch = Get-Architecture - $binaryName = "safe-chain-win-$arch.exe" + $binaryName = Get-BinaryName -Architecture $arch Write-Info "Detected architecture: $arch" @@ -132,7 +338,6 @@ function Install-SafeChain { # Download binary $downloadUrl = "$RepoUrl/releases/download/$Version/$binaryName" $tempFile = Join-Path $InstallDir $binaryName - $finalFile = Join-Path $InstallDir "safe-chain.exe" Write-Info "Downloading from: $downloadUrl" @@ -146,8 +351,16 @@ function Install-SafeChain { Write-Error-Custom "Failed to download from $downloadUrl : $_" } + $expectedSha = Get-ExpectedSha256 -Os "win" -Architecture $arch + Test-Checksum -File $tempFile -Expected $expectedSha + # Rename to final location + $finalFile = Join-Path $InstallDir "safe-chain.exe" try { + # Remove existing file if present (Move-Item -Force doesn't overwrite) + if (Test-Path $finalFile) { + Remove-Item -Path $finalFile -Force + } Move-Item -Path $tempFile -Destination $finalFile -Force } catch { @@ -156,34 +369,7 @@ function Install-SafeChain { Write-Info "Binary installed to: $finalFile" - # Build setup command based on parameters - $setupCmd = if ($ci) { "setup-ci" } else { "setup" } - $setupArgs = @() - if ($includepython) { - $setupArgs += "--include-python" - } - - # Execute safe-chain setup - Write-Info "Running safe-chain $setupCmd $(if ($setupArgs) { $setupArgs -join ' ' })..." - try { - $env:Path = "$env:Path;$InstallDir" - - if ($setupArgs) { - & $finalFile $setupCmd $setupArgs - } - else { - & $finalFile $setupCmd - } - - if ($LASTEXITCODE -ne 0) { - Write-Warn "safe-chain was installed but setup encountered issues." - Write-Warn "You can run 'safe-chain $setupCmd $(if ($setupArgs) { $setupArgs -join ' ' })' manually later." - } - } - catch { - Write-Warn "safe-chain was installed but setup encountered issues: $_" - Write-Warn "You can run 'safe-chain $setupCmd $(if ($setupArgs) { $setupArgs -join ' ' })' manually later." - } + Invoke-SafeChainSetup -BinaryPath $finalFile -InstallDirectory $InstallDir } # Run installation diff --git a/install-scripts/install-safe-chain.sh b/install-scripts/install-safe-chain.sh index fb7328d..5f73c53 100755 --- a/install-scripts/install-safe-chain.sh +++ b/install-scripts/install-safe-chain.sh @@ -2,31 +2,71 @@ # Downloads and installs safe-chain, depending on the operating system and architecture # -# Usage examples: -# -# Default (JavaScript packages only): -# curl -fsSL https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.sh | sh -# wget -qO- https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.sh | sh -# -# CI setup (JavaScript packages only): -# curl -fsSL https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.sh | sh -s -- --ci -# wget -qO- https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.sh | sh -s -- --ci -# -# Include Python packages: -# curl -fsSL https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.sh | sh -s -- --include-python -# wget -qO- https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.sh | sh -s -- --include-python -# -# CI setup with Python packages: -# curl -fsSL https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.sh | sh -s -- --ci --include-python -# wget -qO- https://raw.githubusercontent.com/AikidoSec/safe-chain/main/install-scripts/install-safe-chain.sh | sh -s -- --ci --include-python +# Usage with "curl -fsSL {url} | sh" --> See README.md set -e # Exit on error +# Validates a user-provided install dir and exits on unsafe values. +# Rejects relative paths, root paths, PATH separators, and traversal segments. +validate_install_dir() { + dir="$1" + + if [ -z "$dir" ]; then + return 0 + fi + + case "$dir" in + /*) ;; + *) + printf '[ERROR] --install-dir must be an absolute path, got: %s\n' "$dir" >&2 + exit 1 + ;; + esac + + case "$dir" in + *:*) + printf '[ERROR] --install-dir must not contain the PATH separator (:)\n' >&2 + exit 1 + ;; + esac + + if [ "$dir" = "/" ]; then + printf '[ERROR] --install-dir cannot be a root or drive-root directory\n' >&2 + exit 1 + fi + + old_ifs=$IFS + IFS='/' + set -- $dir + IFS=$old_ifs + + for segment in "$@"; do + if [ "$segment" = ".." ]; then + printf '[ERROR] --install-dir must not contain path traversal segments\n' >&2 + exit 1 + fi + done +} + # Configuration -VERSION="${SAFE_CHAIN_VERSION:-v0.0.5-binaries-beta}" -INSTALL_DIR="${HOME}/.safe-chain/bin" +VERSION="${SAFE_CHAIN_VERSION:-}" # Will be fetched from latest release if not set +SAFE_CHAIN_BASE="${HOME}/.safe-chain" + +INSTALL_DIR="${SAFE_CHAIN_BASE}/bin" REPO_URL="https://github.com/AikidoSec/safe-chain" +# SHA256 checksums for release binaries. +# Empty in source; populated by the release pipeline via sed. +# When empty (running from main), checksum verification is skipped. +SHA256_MACOS_X64="" +SHA256_MACOS_ARM64="" +SHA256_LINUX_X64="" +SHA256_LINUX_ARM64="" +SHA256_LINUXSTATIC_X64="" +SHA256_LINUXSTATIC_ARM64="" +SHA256_WIN_X64="" +SHA256_WIN_ARM64="" + # Colors for output RED='\033[0;31m' GREEN='\033[0;32m' @@ -48,11 +88,19 @@ error() { } # Detect OS +# For legacy versions (when SAFE_CHAIN_VERSION is set), use 'linux' instead of 'linuxstatic' detect_os() { case "$(uname -s)" in - Linux*) echo "linux" ;; - Darwin*) echo "macos" ;; - *) error "Unsupported operating system: $(uname -s)" ;; + Linux*) + if [ -n "$SAFE_CHAIN_VERSION" ]; then + echo "linux" + else + echo "linuxstatic" + fi + ;; + Darwin*) echo "macos" ;; + MINGW*|MSYS*|CYGWIN*) echo "win" ;; + *) error "Unsupported operating system: $(uname -s)" ;; esac } @@ -70,6 +118,107 @@ command_exists() { command -v "$1" >/dev/null 2>&1 } +# Get currently installed version of safe-chain +get_installed_version() { + if ! command_exists safe-chain; then + echo "" + return + fi + + # Extract version from "Current safe-chain version: X.Y.Z" output + installed_version=$(safe-chain -v 2>/dev/null | grep "Current safe-chain version:" | sed -E 's/.*: (.*)/\1/') + echo "$installed_version" +} + +# Check if the requested version is already installed +is_version_installed() { + requested_version="$1" + installed_version=$(get_installed_version) + + if [ -z "$installed_version" ]; then + return 1 # Not installed + fi + + # Strip leading 'v' from versions if present for comparison + requested_clean=$(echo "$requested_version" | sed 's/^v//') + installed_clean=$(echo "$installed_version" | sed 's/^v//') + + if [ "$requested_clean" = "$installed_clean" ]; then + return 0 # Same version installed + else + return 1 # Different version installed + fi +} + +# Fetch latest release version tag from GitHub +fetch_latest_version() { + # Try using GitHub API to get the latest release tag + if command_exists curl; then + latest_version=$(curl -fsSL "https://api.github.com/repos/AikidoSec/safe-chain/releases/latest" | grep '"tag_name"' | sed -E 's/.*"([^"]+)".*/\1/') + elif command_exists wget; then + latest_version=$(wget -qO- "https://api.github.com/repos/AikidoSec/safe-chain/releases/latest" | grep '"tag_name"' | sed -E 's/.*"([^"]+)".*/\1/') + else + error "Neither curl nor wget found. Please install one of them or set SAFE_CHAIN_VERSION environment variable." + fi + + if [ -z "$latest_version" ]; then + error "Failed to fetch latest version from GitHub API. Please set SAFE_CHAIN_VERSION environment variable." + fi + + echo "$latest_version" +} + +# Returns the expected SHA256 for the detected platform, or empty if the +# release pipeline has not baked one in (i.e. running the source from main). +get_expected_sha256() { + os="$1"; arch="$2" + case "${os}-${arch}" in + macos-x64) echo "$SHA256_MACOS_X64" ;; + macos-arm64) echo "$SHA256_MACOS_ARM64" ;; + linux-x64) echo "$SHA256_LINUX_X64" ;; + linux-arm64) echo "$SHA256_LINUX_ARM64" ;; + linuxstatic-x64) echo "$SHA256_LINUXSTATIC_X64" ;; + linuxstatic-arm64) echo "$SHA256_LINUXSTATIC_ARM64" ;; + win-x64) echo "$SHA256_WIN_X64" ;; + win-arm64) echo "$SHA256_WIN_ARM64" ;; + *) echo "" ;; + esac +} + +compute_sha256() { + file="$1" + if command_exists sha256sum; then + sha256sum "$file" | awk '{print $1}' + elif command_exists shasum; then + shasum -a 256 "$file" | awk '{print $1}' + else + echo "" + fi +} + +# Verifies the downloaded binary against the expected hash baked in by the release pipeline. +# No-op when no expected hash is set (running the script from main). +verify_checksum() { + file="$1"; expected="$2" + + if [ -z "$expected" ]; then + return + fi + + actual=$(compute_sha256 "$file") + if [ -z "$actual" ]; then + rm -f "$file" + error "Cannot verify checksum: neither sha256sum nor shasum is available. Install one and re-run." + fi + + if [ "$actual" != "$expected" ]; then + rm -f "$file" + error "Checksum verification failed. Expected: $expected, Got: $actual" + fi + + info "Checksum verified." +} + # Download file download() { url="$1" @@ -84,8 +233,77 @@ download() { fi } +# Prints the deprecation warning for SAFE_CHAIN_VERSION and the replacement install command. +# Returns immediately when no version was pinned through the environment. +warn_deprecated_version_env() { + if [ -z "$SAFE_CHAIN_VERSION" ]; then + return + fi + + warn "SAFE_CHAIN_VERSION environment variable is deprecated." + warn "" + warn "Please use direct download URLs for version pinning instead:" + warn "" + if [ "$USE_CI_SETUP" = "true" ]; then + warn " curl -fsSL https://github.com/AikidoSec/safe-chain/releases/download/${SAFE_CHAIN_VERSION}/install-safe-chain.sh | sh -s -- --ci" + else + warn " curl -fsSL https://github.com/AikidoSec/safe-chain/releases/download/${SAFE_CHAIN_VERSION}/install-safe-chain.sh | sh" + fi + warn "" +} + +# Ensures VERSION is populated before installation continues. +# Fetches the latest release only when no explicit version was provided. +ensure_version() { + if [ -n "$VERSION" ]; then + return + fi + + info "Fetching latest release version..." + VERSION=$(fetch_latest_version) +} + +# Constructs platform-specific binary filename to match GitHub release asset naming convention. +get_binary_name() { + os="$1" + arch="$2" + + if [ "$os" = "win" ]; then + printf 'safe-chain-%s-%s.exe\n' "$os" "$arch" + else + printf 'safe-chain-%s-%s\n' "$os" "$arch" + fi +} + +# Returns the final installation path for the downloaded safe-chain binary. +# Uses INSTALL_DIR and the platform-specific executable name. +get_final_binary_path() { + os="$1" + + if [ "$os" = "win" ]; then + printf '%s/safe-chain.exe\n' "$INSTALL_DIR" + else + printf '%s/safe-chain\n' "$INSTALL_DIR" + fi +} + +run_setup_command() { + final_file="$1" + + setup_cmd="setup" + if [ "$USE_CI_SETUP" = "true" ]; then + setup_cmd="setup-ci" + fi + + info "Running safe-chain $setup_cmd..." + if ! "$final_file" "$setup_cmd"; then + warn "safe-chain was installed but setup encountered issues." + warn "You can run 'safe-chain $setup_cmd' manually later." + fi +} + # Check and uninstall npm global package if present -check_npm_installation() { +remove_npm_installation() { if ! command_exists npm; then return fi @@ -105,7 +323,7 @@ check_npm_installation() { } # Check and uninstall Volta-managed package if present -check_volta_installation() { +remove_volta_installation() { if ! command_exists volta; then return fi @@ -125,44 +343,138 @@ check_volta_installation() { fi } +# Check and uninstall nvm-managed package if present across all Node versions +remove_nvm_installation() { + # This script is run in sh shell for greatest compatibility. + # Because nvm is usually setup in bash/zsh/fish startup scripts, we need to source it. + # Otherwise it won't be available in sh. + if [ -s "$HOME/.nvm/nvm.sh" ]; then + # Source nvm to make it available in this script + . "$HOME/.nvm/nvm.sh" >/dev/null 2>&1 + elif [ -s "$NVM_DIR/nvm.sh" ]; then + . "$NVM_DIR/nvm.sh" >/dev/null 2>&1 + fi + + # Check if nvm is now available + if ! command_exists nvm; then + return + fi + + nvm_versions=$(nvm list 2>/dev/null | grep -oE 'v[0-9]+\.[0-9]+\.[0-9]+' || echo "") + + if [ -z "$nvm_versions" ]; then + return + fi + + # Track if we found any installations + found_installation=false + uninstall_failed=false + current_version=$(nvm current 2>/dev/null || echo "") + + # Check each version for safe-chain installation + for version in $nvm_versions; do + # Check if this version has safe-chain installed + # Use nvm exec to run npm list in the context of that Node version + if nvm exec "$version" npm list -g @aikidosec/safe-chain >/dev/null 2>&1; then + if [ "$found_installation" = false ]; then + info "Detected nvm installation(s) of @aikidosec/safe-chain" + info "Uninstalling from all Node versions..." + found_installation=true + fi + + info " Removing from Node $version..." + if nvm exec "$version" npm uninstall -g @aikidosec/safe-chain >/dev/null 2>&1; then + info " Successfully uninstalled from Node $version" + else + warn " Failed to uninstall from Node $version" + uninstall_failed=true + fi + fi + done + + # Restore original Node version if it was set + if [ -n "$current_version" ] && [ "$current_version" != "none" ] && [ "$current_version" != "system" ]; then + nvm use "$current_version" >/dev/null 2>&1 || true + fi + + # If any uninstall failed, error out instead of continuing + if [ "$uninstall_failed" = true ]; then + error "Failed to uninstall @aikidosec/safe-chain from all nvm Node versions. Please uninstall manually and try again." + fi +} + # Parse command-line arguments parse_arguments() { - for arg in "$@"; do - case "$arg" in + while [ $# -gt 0 ]; do + case "$1" in --ci) USE_CI_SETUP=true ;; + --install-dir) + shift + if [ $# -eq 0 ]; then + error "Missing value for --install-dir" + fi + if [ -z "$1" ]; then + error "--install-dir must not be empty" + fi + SAFE_CHAIN_BASE="$1" + ;; + --install-dir=*) + SAFE_CHAIN_BASE="${1#--install-dir=}" + if [ -z "$SAFE_CHAIN_BASE" ]; then + error "--install-dir must not be empty" + fi + ;; --include-python) - INCLUDE_PYTHON=true + warn "--include-python is deprecated and ignored. Python ecosystem is now included by default." ;; *) - error "Unknown argument: $arg" + error "Unknown argument: $1" ;; esac + shift done + + validate_install_dir "${SAFE_CHAIN_BASE}" + INSTALL_DIR="${SAFE_CHAIN_BASE}/bin" } # Main installation main() { # Initialize argument flags USE_CI_SETUP=false - INCLUDE_PYTHON=false # Parse command-line arguments parse_arguments "$@" - info "Installing safe-chain ${VERSION}..." + warn_deprecated_version_env - # Check for existing npm installation - check_npm_installation + ensure_version - # Check for existing Volta installation - check_volta_installation + # Check if the requested version is already installed + if is_version_installed "$VERSION"; then + info "safe-chain ${VERSION} is already installed" + exit 0 + fi + + # Build installation message + INSTALL_MSG="Installing safe-chain ${VERSION}" + if [ "$USE_CI_SETUP" = "true" ]; then + INSTALL_MSG="${INSTALL_MSG} in ci" + fi + + info "$INSTALL_MSG" + + # Check for existing safe-chain installation through nvm, volta, or npm + remove_npm_installation + remove_volta_installation + remove_nvm_installation # Detect platform OS=$(detect_os) ARCH=$(detect_arch) - BINARY_NAME="safe-chain-${OS}-${ARCH}" + BINARY_NAME=$(get_binary_name "$OS" "$ARCH") info "Detected platform: ${OS}-${ARCH}" @@ -175,35 +487,23 @@ main() { # Download binary DOWNLOAD_URL="${REPO_URL}/releases/download/${VERSION}/${BINARY_NAME}" TEMP_FILE="${INSTALL_DIR}/${BINARY_NAME}" - FINAL_FILE="${INSTALL_DIR}/safe-chain" info "Downloading from: $DOWNLOAD_URL" download "$DOWNLOAD_URL" "$TEMP_FILE" + EXPECTED_SHA256=$(get_expected_sha256 "$OS" "$ARCH") + verify_checksum "$TEMP_FILE" "$EXPECTED_SHA256" + # Rename and make executable + FINAL_FILE=$(get_final_binary_path "$OS") mv "$TEMP_FILE" "$FINAL_FILE" || error "Failed to move binary to $FINAL_FILE" - chmod +x "$FINAL_FILE" || error "Failed to make binary executable" + if [ "$OS" != "win" ]; then + chmod +x "$FINAL_FILE" || error "Failed to make binary executable" + fi info "Binary installed to: $FINAL_FILE" - # Build setup command based on arguments - SETUP_CMD="setup" - SETUP_ARGS="" - - if [ "$USE_CI_SETUP" = "true" ]; then - SETUP_CMD="setup-ci" - fi - - if [ "$INCLUDE_PYTHON" = "true" ]; then - SETUP_ARGS="--include-python" - fi - - # Execute safe-chain setup - info "Running safe-chain $SETUP_CMD $SETUP_ARGS..." - if ! "$FINAL_FILE" $SETUP_CMD $SETUP_ARGS; then - warn "safe-chain was installed but setup encountered issues." - warn "You can run 'safe-chain $SETUP_CMD $SETUP_ARGS' manually later." - fi + run_setup_command "$FINAL_FILE" } main "$@" diff --git a/install-scripts/uninstall-endpoint-mac.sh b/install-scripts/uninstall-endpoint-mac.sh new file mode 100755 index 0000000..bd3b0e7 --- /dev/null +++ b/install-scripts/uninstall-endpoint-mac.sh @@ -0,0 +1,50 @@ +#!/bin/sh + +# Uninstalls Aikido Endpoint Protection on macOS +# +# Usage: curl -fsSL | sudo sh + +set -e # Exit on error + +# Configuration +UNINSTALL_SCRIPT="/Applications/Aikido Endpoint Protection.app/Contents/Resources/scripts/uninstall" + +# Colors for output +RED='\033[0;31m' +GREEN='\033[0;32m' +NC='\033[0m' # No Color + +# Helper functions +info() { + printf "${GREEN}[INFO]${NC} %s\n" "$1" +} + +error() { + printf "${RED}[ERROR]${NC} %s\n" "$1" >&2 + exit 1 +} + +# Main uninstallation +main() { + # Check if we're running on macOS + if [ "$(uname -s)" != "Darwin" ]; then + error "This script is only supported on macOS." + fi + + # Check if we're running as root + if [ "$(id -u)" -ne 0 ]; then + error "Root privileges required. Please re-run with sudo, e.g.: curl -fsSL | sudo sh" + fi + + # Check if the uninstall script exists + if [ ! -f "$UNINSTALL_SCRIPT" ]; then + error "Aikido Endpoint Protection does not appear to be installed (uninstall script not found)." + fi + + info "Uninstalling Aikido Endpoint Protection..." + "$UNINSTALL_SCRIPT" + + info "Aikido Endpoint Protection uninstalled successfully!" +} + +main "$@" diff --git a/install-scripts/uninstall-endpoint-windows.ps1 b/install-scripts/uninstall-endpoint-windows.ps1 new file mode 100644 index 0000000..90741c7 --- /dev/null +++ b/install-scripts/uninstall-endpoint-windows.ps1 @@ -0,0 +1,59 @@ +# Uninstalls Aikido Endpoint Protection endpoint on Windows +# +# Usage: iex (iwr '' -UseBasicParsing) + +# Configuration +$AppName = "Aikido Endpoint Protection" + +# Helper functions +function Write-Info { + param([string]$Message) + Write-Host "[INFO] $Message" -ForegroundColor Green +} + +function Write-Error-Custom { + param([string]$Message) + Write-Host "[ERROR] $Message" -ForegroundColor Red + exit 1 +} + +# Check if running as Administrator +function Test-Administrator { + $identity = [Security.Principal.WindowsIdentity]::GetCurrent() + $principal = New-Object Security.Principal.WindowsPrincipal($identity) + return $principal.IsInRole([Security.Principal.WindowsBuiltInRole]::Administrator) +} + +# Main uninstallation +function Uninstall-Endpoint { + # Check if we're running as Administrator + if (-not (Test-Administrator)) { + Write-Error-Custom "Administrator privileges required. Please run this script in an elevated terminal (Run as Administrator)." + } + + # Find the installed product + Write-Info "Looking for Aikido Endpoint Protection installation..." + $app = Get-WmiObject -Class Win32_Product -Filter "Name='$AppName'" + + if (-not $app) { + Write-Error-Custom "Aikido Endpoint Protection does not appear to be installed." + } + + $productCode = $app.IdentifyingNumber + + Write-Info "Uninstalling Aikido Endpoint Protection..." + $process = Start-Process -FilePath "msiexec" -ArgumentList "/x", $productCode, "/qn", "/norestart" -Wait -PassThru + if ($process.ExitCode -ne 0) { + Write-Error-Custom "Uninstall failed (exit code: $($process.ExitCode))." + } + + Write-Info "Aikido Endpoint Protection uninstalled successfully!" +} + +# Run uninstallation +try { + Uninstall-Endpoint +} +catch { + Write-Error-Custom "Uninstallation failed: $_" +} diff --git a/install-scripts/uninstall-safe-chain.ps1 b/install-scripts/uninstall-safe-chain.ps1 new file mode 100644 index 0000000..6e24d5d --- /dev/null +++ b/install-scripts/uninstall-safe-chain.ps1 @@ -0,0 +1,249 @@ +# Uninstalls safe-chain from Windows +# +# Usage with "iex (iwr {url} -UseBasicParsing)" --> See README.md + +# Use HOME on Unix, USERPROFILE on Windows (PowerShell Core is cross-platform) +$HomeDir = if ($env:HOME) { $env:HOME } else { $env:USERPROFILE } + +# Helper functions +function Write-Info { + param([string]$Message) + Write-Host "[INFO] $Message" -ForegroundColor Green +} + +function Write-Warn { + param([string]$Message) + Write-Host "[WARN] $Message" -ForegroundColor Yellow +} + +function Write-Error-Custom { + param([string]$Message) + Write-Host "[ERROR] $Message" -ForegroundColor Red + exit 1 +} + +# Derives the safe-chain base install directory from a resolved binary path. +# Rejects wrapper scripts and paths that do not match the packaged bin layout. +function Get-InstallDirFromBinaryPath { + param([string]$BinaryPath) + + if ([string]::IsNullOrWhiteSpace($BinaryPath)) { + return $null + } + + try { + $resolvedPath = (Resolve-Path -LiteralPath $BinaryPath -ErrorAction Stop).Path + } + catch { + $resolvedPath = [System.IO.Path]::GetFullPath($BinaryPath) + } + + $fileName = [System.IO.Path]::GetFileName($resolvedPath) + if (($fileName -ne "safe-chain") -and ($fileName -ne "safe-chain.exe")) { + return $null + } + + if ($resolvedPath -match '\.(js|cjs|mjs|cmd|ps1)$') { + return $null + } + + $binDir = Split-Path -Parent $resolvedPath + if ((Split-Path -Leaf $binDir) -ne "bin") { + return $null + } + + return (Split-Path -Parent $binDir) +} + +# Returns the first safe-chain command found on PATH, if any. +# Used as the starting point for install-dir discovery. +function Get-SafeChainCommand { + return Get-Command safe-chain -ErrorAction SilentlyContinue | Select-Object -First 1 +} + +# Returns the safe-chain command path only when it points to a valid packaged binary install. +# Prevents teardown from invoking arbitrary wrappers or scripts from PATH. +function Get-ValidatedSafeChainCommandPath { + $command = Get-SafeChainCommand + if (-not $command -or [string]::IsNullOrWhiteSpace($command.Path)) { + return $null + } + + $installDir = Get-InstallDirFromBinaryPath -BinaryPath $command.Path + if (-not $installDir) { + return $null + } + + return $command.Path +} + +# Invokes the validated safe-chain binary with get-install-dir and returns the reported base directory. +# Safely returns $null when the command is unavailable or the lookup fails. +function Get-ReportedInstallDir { + $safeChainPath = Get-ValidatedSafeChainCommandPath + if (-not $safeChainPath) { + return $null + } + + try { + $reportedInstallDir = & $safeChainPath get-install-dir 2>$null | Select-Object -First 1 + if ($reportedInstallDir) { + $reportedInstallDir = $reportedInstallDir.Trim() + } + if ($reportedInstallDir) { + return $reportedInstallDir + } + } + catch { + return $null + } + + return $null +} + +# Determines the safe-chain base install directory for uninstall. +# Prefers the binary-reported location, then derives it from PATH, then falls back to the default home-dir layout. +function Get-SafeChainInstallDir { + $reportedInstallDir = Get-ReportedInstallDir + if ($reportedInstallDir) { + return $reportedInstallDir + } + + $command = Get-SafeChainCommand + if ($command -and $command.Path) { + $discoveredInstallDir = Get-InstallDirFromBinaryPath -BinaryPath $command.Path + if ($discoveredInstallDir) { + return $discoveredInstallDir + } + } + + return (Join-Path $HomeDir ".safe-chain") +} + +# Finds the installed safe-chain binary inside the resolved install directory. +# Falls back to a validated safe-chain command when the expected file is missing. +function Find-SafeChainBinary { + param([string]$DotSafeChain) + + $safeChainExe = Join-Path $DotSafeChain "bin/safe-chain.exe" + $safeChainBin = Join-Path $DotSafeChain "bin/safe-chain" + + if (Test-Path $safeChainExe) { + return $safeChainExe + } + + if (Test-Path $safeChainBin) { + return $safeChainBin + } + + return Get-ValidatedSafeChainCommandPath +} + +# Runs safe-chain teardown before removing the installation directory. +# Converts teardown failures into warnings so uninstall can still complete. +function Invoke-SafeChainTeardown { + param([string]$SafeChainPath) + + if (-not $SafeChainPath) { + Write-Warn "safe-chain command not found. Proceeding with uninstallation." + return + } + + Write-Info "Running safe-chain teardown..." + try { + & $SafeChainPath teardown + if ($LASTEXITCODE -ne 0) { + Write-Warn "safe-chain teardown encountered issues, continuing with uninstallation..." + } + } + catch { + Write-Warn "safe-chain teardown encountered issues: $_" + Write-Warn "Continuing with uninstallation..." + } +} + +# Check and uninstall npm global package if present +function Remove-NpmInstallation { + # Check if npm is available + if (-not (Get-Command npm -ErrorAction SilentlyContinue)) { + return + } + + # Check if safe-chain is installed as an npm global package + npm list -g @aikidosec/safe-chain 2>&1 | Out-Null + if ($LASTEXITCODE -eq 0) { + Write-Info "Detected npm global installation of @aikidosec/safe-chain" + Write-Info "Uninstalling npm version before installing binary version..." + + npm uninstall -g @aikidosec/safe-chain 2>&1 | Out-Null + if ($LASTEXITCODE -eq 0) { + Write-Info "Successfully uninstalled npm version" + } + else { + Write-Warn "Failed to uninstall npm version automatically" + Write-Warn "Please run: npm uninstall -g @aikidosec/safe-chain" + } + } +} + +# Check and uninstall Volta-managed package if present +function Remove-VoltaInstallation { + # Check if Volta is available + if (-not (Get-Command volta -ErrorAction SilentlyContinue)) { + return + } + + # Volta manages global packages in its own directory + # Check if safe-chain is installed via Volta + volta list safe-chain 2>&1 | Out-Null + if ($LASTEXITCODE -eq 0) { + Write-Info "Detected Volta installation of @aikidosec/safe-chain" + Write-Info "Uninstalling Volta version before installing binary version..." + + volta uninstall @aikidosec/safe-chain 2>&1 | Out-Null + if ($LASTEXITCODE -eq 0) { + Write-Info "Successfully uninstalled Volta version" + } + else { + Write-Warn "Failed to uninstall Volta version automatically" + Write-Warn "Please run: volta uninstall @aikidosec/safe-chain" + } + } +} + +# Main uninstallation +function Uninstall-SafeChain { + Write-Info "Uninstalling safe-chain..." + $DotSafeChain = Get-SafeChainInstallDir + $safeChainPath = Find-SafeChainBinary -DotSafeChain $DotSafeChain + Invoke-SafeChainTeardown -SafeChainPath $safeChainPath + + # Remove npm and Volta installations + Remove-NpmInstallation + Remove-VoltaInstallation + + # Remove .safe-chain directory + if (Test-Path $DotSafeChain) { + Write-Info "Removing installation directory: $DotSafeChain" + try { + Remove-Item -Path $DotSafeChain -Recurse -Force + Write-Info "Successfully removed installation directory" + } + catch { + Write-Error-Custom "Failed to remove $DotSafeChain : $_" + } + } + else { + Write-Info "Installation directory $DotSafeChain does not exist. Nothing to remove." + } + + Write-Info "safe-chain has been uninstalled successfully!" +} + +# Run uninstallation +try { + Uninstall-SafeChain +} +catch { + Write-Error-Custom "Uninstallation failed: $_" +} diff --git a/install-scripts/uninstall-safe-chain.sh b/install-scripts/uninstall-safe-chain.sh new file mode 100755 index 0000000..d215405 --- /dev/null +++ b/install-scripts/uninstall-safe-chain.sh @@ -0,0 +1,312 @@ +#!/bin/sh + +# Downloads and installs safe-chain, depending on the operating system and architecture +# +# Usage with "curl -fsSL {url} | sh" --> See README.md + +set -e # Exit on error + +# Configuration + +# Colors for output +RED='\033[0;31m' +GREEN='\033[0;32m' +YELLOW='\033[1;33m' +NC='\033[0m' # No Color + +# Helper functions +info() { + printf "${GREEN}[INFO]${NC} %s\n" "$1" +} + +warn() { + printf "${YELLOW}[WARN]${NC} %s\n" "$1" +} + +error() { + printf "${RED}[ERROR]${NC} %s\n" "$1" >&2 + exit 1 +} + +# Check if command exists +command_exists() { + command -v "$1" >/dev/null 2>&1 +} + +# Resolves a path to its canonical filesystem location when possible. +# Follows symlinks so binary validation can inspect the real installed path. +resolve_path() { + target="$1" + + while [ -L "$target" ]; do + link_target=$(readlink "$target" 2>/dev/null || echo "") + if [ -z "$link_target" ]; then + break + fi + + case "$link_target" in + /*) target="$link_target" ;; + *) + target="$(dirname "$target")/$link_target" + ;; + esac + done + + target_dir=$(dirname "$target") + target_name=$(basename "$target") + + if cd "$target_dir" 2>/dev/null; then + printf '%s/%s\n' "$(pwd -P)" "$target_name" + else + printf '%s\n' "$target" + fi +} + +# Derives the safe-chain base install directory from a packaged binary path. +# Rejects wrapper scripts and paths that do not match the expected bin layout. +derive_install_dir_from_binary() { + binary_path="$1" + + if [ -z "$binary_path" ]; then + return 1 + fi + + resolved_path=$(resolve_path "$binary_path") + binary_name=$(basename "$resolved_path") + case "$binary_name" in + safe-chain|safe-chain.exe) ;; + *) return 1 ;; + esac + + case "$resolved_path" in + *.js|*.cjs|*.mjs|*.cmd|*.ps1) return 1 ;; + esac + + binary_dir=$(dirname "$resolved_path") + if [ "$(basename "$binary_dir")" != "bin" ]; then + return 1 + fi + + dirname "$binary_dir" +} + +# Determines the installed safe-chain base directory for uninstall. +# Prefers the binary-reported location, then infers it from PATH, then falls back to ~/.safe-chain. +get_install_dir() { + reported_install_dir=$(get_reported_install_dir || true) + if [ -n "$reported_install_dir" ]; then + printf '%s\n' "$reported_install_dir" + return 0 + fi + + command_path=$(get_safe_chain_command_path || true) + install_dir=$(derive_install_dir_from_binary "$command_path" || true) + if [ -n "$install_dir" ]; then + printf '%s\n' "$install_dir" + return 0 + fi + + printf '%s\n' "${HOME}/.safe-chain" +} + +# Returns the current safe-chain command path from PATH. +# Fails when safe-chain is not currently resolvable. +get_safe_chain_command_path() { + if ! command_exists safe-chain; then + return 1 + fi + + command -v safe-chain +} + +# Returns the safe-chain command path only when it resolves to a valid packaged binary install. +# Prevents the uninstaller from invoking arbitrary PATH entries. +get_validated_safe_chain_command_path() { + command_path=$(get_safe_chain_command_path || true) + if [ -z "$command_path" ]; then + return 1 + fi + + install_dir=$(derive_install_dir_from_binary "$command_path" || true) + if [ -z "$install_dir" ]; then + return 1 + fi + + printf '%s\n' "$command_path" +} + +# Asks the validated safe-chain binary for its install directory via get-install-dir. +# Returns nothing if the command is unavailable or the lookup fails. +get_reported_install_dir() { + safe_chain_path=$(get_validated_safe_chain_command_path || true) + if [ -z "$safe_chain_path" ]; then + return 1 + fi + + install_dir=$("$safe_chain_path" get-install-dir 2>/dev/null || true) + if [ -n "$install_dir" ]; then + printf '%s\n' "$install_dir" + return 0 + fi + + return 1 +} + +# Locates the installed safe-chain binary to use for teardown. +# Checks the discovered install dir first, then falls back to a validated PATH entry. +find_installed_safe_chain_binary() { + dot_safe_chain="$1" + + safe_chain_location="$dot_safe_chain/bin/safe-chain" + if [ -x "$safe_chain_location" ]; then + printf '%s\n' "$safe_chain_location" + return 0 + fi + + command_path=$(get_validated_safe_chain_command_path || true) + if [ -n "$command_path" ]; then + printf '%s\n' "$command_path" + return 0 + fi + + return 1 +} + +# Runs safe-chain teardown before removing files. +# Continues with uninstall even if teardown is unavailable or fails. +run_safe_chain_teardown() { + safe_chain_command="$1" + + if [ -z "$safe_chain_command" ]; then + warn "safe-chain command not found. Proceeding with uninstallation." + return + fi + + info "Running safe-chain teardown..." + "$safe_chain_command" teardown || warn "safe-chain teardown encountered issues, continuing with uninstallation..." +} + +# Check and uninstall npm global package if present +remove_npm_installation() { + if ! command_exists npm; then + return + fi + + # Check if safe-chain is installed as an npm global package + if npm list -g @aikidosec/safe-chain >/dev/null 2>&1; then + info "Detected npm global installation of @aikidosec/safe-chain" + info "Uninstalling npm version before installing binary version..." + + if npm uninstall -g @aikidosec/safe-chain >/dev/null 2>&1; then + info "Successfully uninstalled npm version" + else + warn "Failed to uninstall npm version automatically" + warn "Please run: npm uninstall -g @aikidosec/safe-chain" + fi + fi +} + +# Check and uninstall Volta-managed package if present +remove_volta_installation() { + if ! command_exists volta; then + return + fi + + # Volta manages global packages in its own directory + # Check if safe-chain is installed via Volta + if volta list safe-chain >/dev/null 2>&1; then + info "Detected Volta installation of @aikidosec/safe-chain" + info "Uninstalling Volta version before installing binary version..." + + if volta uninstall @aikidosec/safe-chain >/dev/null 2>&1; then + info "Successfully uninstalled Volta version" + else + warn "Failed to uninstall Volta version automatically" + warn "Please run: volta uninstall @aikidosec/safe-chain" + fi + fi +} + +# Check and uninstall nvm-managed package if present across all Node versions +remove_nvm_installation() { + # This script is run in sh shell for greatest compatibility. + # Because nvm is usually setup in bash/zsh/fish startup scripts, we need to source it. + # Otherwise it won't be available in sh. + if [ -s "$HOME/.nvm/nvm.sh" ]; then + # Source nvm to make it available in this script + . "$HOME/.nvm/nvm.sh" >/dev/null 2>&1 + elif [ -s "$NVM_DIR/nvm.sh" ]; then + . "$NVM_DIR/nvm.sh" >/dev/null 2>&1 + fi + + # Check if nvm is now available + if ! command_exists nvm; then + return + fi + + # Get list of installed Node versions + nvm_versions=$(nvm list 2>/dev/null | grep -oE 'v[0-9]+\.[0-9]+\.[0-9]+' || echo "") + + if [ -z "$nvm_versions" ]; then + return + fi + + # Track if we found any installations + found_installation=false + uninstall_failed=false + current_version=$(nvm current 2>/dev/null || echo "") + + # Check each version for safe-chain installation + for version in $nvm_versions; do + # Check if this version has safe-chain installed + # Use nvm exec to run npm list in the context of that Node version + if nvm exec "$version" npm list -g @aikidosec/safe-chain >/dev/null 2>&1; then + if [ "$found_installation" = false ]; then + info "Detected nvm installation(s) of @aikidosec/safe-chain" + info "Uninstalling from all Node versions..." + found_installation=true + fi + + info " Removing from Node $version..." + if nvm exec "$version" npm uninstall -g @aikidosec/safe-chain >/dev/null 2>&1; then + info " Successfully uninstalled from Node $version" + else + warn " Failed to uninstall from Node $version" + uninstall_failed=true + fi + fi + done + + # Restore original Node version if it was set + if [ -n "$current_version" ] && [ "$current_version" != "none" ] && [ "$current_version" != "system" ]; then + nvm use "$current_version" >/dev/null 2>&1 || true + fi + + # Show warning if any uninstall failed (but don't error out during uninstall) + if [ "$uninstall_failed" = true ]; then + warn "Failed to uninstall @aikidosec/safe-chain from some nvm Node versions" + warn "You may need to manually run: nvm exec npm uninstall -g @aikidosec/safe-chain" + fi +} + +# Main uninstallation +main() { + DOT_SAFE_CHAIN=$(get_install_dir) + SAFE_CHAIN_COMMAND=$(find_installed_safe_chain_binary "$DOT_SAFE_CHAIN" || true) + run_safe_chain_teardown "$SAFE_CHAIN_COMMAND" + + # Check for existing safe-chain installation through nvm, volta, or npm + remove_npm_installation + remove_volta_installation + remove_nvm_installation + + # Remove install dir recursively if it exists + if [ -d "$DOT_SAFE_CHAIN" ]; then + info "Removing installation directory $DOT_SAFE_CHAIN" + rm -rf "$DOT_SAFE_CHAIN" || error "Failed to remove $DOT_SAFE_CHAIN" + else + info "Installation directory $DOT_SAFE_CHAIN does not exist. Nothing to remove." + fi +} + +main "$@" diff --git a/package-lock.json b/npm-shrinkwrap.json similarity index 53% rename from package-lock.json rename to npm-shrinkwrap.json index 16f42c7..310e28f 100644 --- a/package-lock.json +++ b/npm-shrinkwrap.json @@ -12,6 +12,7 @@ "test/e2e" ], "devDependencies": { + "@yao-pkg/pkg": "6.10.1", "esbuild": "^0.27.0", "oxlint": "^1.22.0" } @@ -24,6 +25,73 @@ "resolved": "test/e2e", "link": true }, + "node_modules/@babel/generator": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.28.5.tgz", + "integrity": "sha512-3EwLFhZ38J4VyIP6WNtt2kUdW9dokXA9Cr4IVIFHuCpZ3H8/YFOl5JjZHisrn1fATPBmKKqXzDFvh9fUwHz6CQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/parser": "^7.28.5", + "@babel/types": "^7.28.5", + "@jridgewell/gen-mapping": "^0.3.12", + "@jridgewell/trace-mapping": "^0.3.28", + "jsesc": "^3.0.2" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-string-parser": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.27.1.tgz", + "integrity": "sha512-qMlSxKbpRlAridDExk92nSobyDdpPijUq2DW6oDnUqd0iOGxmQjyqhMIihI9+zv4LPyZdRje2cavWPbCbWm3eA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-validator-identifier": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.28.5.tgz", + "integrity": "sha512-qSs4ifwzKJSV39ucNjsvc6WVHs6b7S03sOh2OcHF9UHfVPqWWALUsNUVzhSBiItjRZoLHx7nIarVjqKVusUZ1Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/parser": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.28.5.tgz", + "integrity": "sha512-KKBU1VGYR7ORr3At5HAtUQ+TV3SzRCXmA/8OdDZiLDBIZxVyzXuztPjfLd3BV1PRAQGCMWWSHYhL0F8d5uHBDQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/types": "^7.28.5" + }, + "bin": { + "parser": "bin/babel-parser.js" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@babel/types": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.28.5.tgz", + "integrity": "sha512-qQ5m48eI/MFLQ5PxQj4PFaprjyCTLI37ElWMmNs0K8Lk3dVeOdNpB3ks8jc7yM5CDmVC73eMVk/trk3fgmrUpA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-string-parser": "^7.27.1", + "@babel/helper-validator-identifier": "^7.28.5" + }, + "engines": { + "node": ">=6.9.0" + } + }, "node_modules/@esbuild/aix-ppc64": { "version": "0.27.0", "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.27.0.tgz", @@ -487,6 +555,58 @@ "node": "20 || >=22" } }, + "node_modules/@isaacs/fs-minipass": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/@isaacs/fs-minipass/-/fs-minipass-4.0.1.tgz", + "integrity": "sha512-wgm9Ehl2jpeqP3zw/7mo3kRHFp5MEDhqAdwy1fTGkHAwnkGOVsgpvQhL8B5n1qlb01jV3n/bI0ZfZp5lWA1k4w==", + "dev": true, + "license": "ISC", + "dependencies": { + "minipass": "^7.0.4" + }, + "engines": { + "node": ">=18.0.0" + } + }, + "node_modules/@jridgewell/gen-mapping": { + "version": "0.3.13", + "resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.13.tgz", + "integrity": "sha512-2kkt/7niJ6MgEPxF0bYdQ6etZaA+fQvDcLKckhy1yIQOzaoKjBBjSj63/aLVjYE3qhRt5dvM+uUyfCg6UKCBbA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/sourcemap-codec": "^1.5.0", + "@jridgewell/trace-mapping": "^0.3.24" + } + }, + "node_modules/@jridgewell/resolve-uri": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz", + "integrity": "sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@jridgewell/sourcemap-codec": { + "version": "1.5.5", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.5.tgz", + "integrity": "sha512-cYQ9310grqxueWbl+WuIUIaiUaDcj7WOq5fVhEljNVgRfOUhY9fy2zTvfoqWsnebh8Sl70VScFbICvJnLKB0Og==", + "dev": true, + "license": "MIT" + }, + "node_modules/@jridgewell/trace-mapping": { + "version": "0.3.31", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.31.tgz", + "integrity": "sha512-zzNR+SdQSDJzc8joaeP8QQoCQr8NuYx2dIIytl1QeBEZHJ9uW6hebsrYgbz8hJwUQao3TWCMtmfV8Nu1twOLAw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/resolve-uri": "^3.1.0", + "@jridgewell/sourcemap-codec": "^1.4.14" + } + }, "node_modules/@npmcli/agent": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/@npmcli/agent/-/agent-4.0.0.tgz", @@ -723,6 +843,82 @@ "@types/node": "*" } }, + "node_modules/@yao-pkg/pkg": { + "version": "6.10.1", + "resolved": "https://registry.npmjs.org/@yao-pkg/pkg/-/pkg-6.10.1.tgz", + "integrity": "sha512-M/eqDg0Iir2nmyZ06Q9ospIPv1Yk7K1du5iLiaYrfMogQcI6bqf82A026MVYngyLH8jZsquZvjNAbvgbW4Uwkw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/generator": "^7.23.0", + "@babel/parser": "^7.23.0", + "@babel/types": "^7.23.0", + "@yao-pkg/pkg-fetch": "3.5.30", + "into-stream": "^6.0.0", + "minimist": "^1.2.6", + "multistream": "^4.1.0", + "picocolors": "^1.1.0", + "picomatch": "^4.0.2", + "prebuild-install": "^7.1.1", + "resolve": "^1.22.10", + "stream-meter": "^1.0.4", + "tar": "^7.4.3", + "tinyglobby": "^0.2.11", + "unzipper": "^0.12.3" + }, + "bin": { + "pkg": "lib-es5/bin.js" + }, + "engines": { + "node": ">=18.0.0" + } + }, + "node_modules/@yao-pkg/pkg-fetch": { + "version": "3.5.30", + "resolved": "https://registry.npmjs.org/@yao-pkg/pkg-fetch/-/pkg-fetch-3.5.30.tgz", + "integrity": "sha512-OrXQlsR3vE/IvwXSk8R5ETYbcxAFtUPmLkeepbG+ArN82TvlIwcUJ65tEWxLG3Tl89VRbmOupuhkXfmuaO05+Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "https-proxy-agent": "^5.0.0", + "node-fetch": "^2.6.6", + "picocolors": "^1.1.0", + "progress": "^2.0.3", + "semver": "^7.3.5", + "tar-fs": "^3.1.1", + "yargs": "^16.2.0" + }, + "bin": { + "pkg-fetch": "lib-es5/bin.js" + } + }, + "node_modules/@yao-pkg/pkg-fetch/node_modules/agent-base": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-6.0.2.tgz", + "integrity": "sha512-RZNwNclF7+MS/8bDg70amg32dyeZGZxiDuQmZxKLAlQjr3jGyLx+4Kkk58UO7D2QdgFIQCovuSuZESne6RG6XQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "debug": "4" + }, + "engines": { + "node": ">= 6.0.0" + } + }, + "node_modules/@yao-pkg/pkg-fetch/node_modules/https-proxy-agent": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-5.0.1.tgz", + "integrity": "sha512-dFcAjpTQFgoLMzC2VwU+C/CbS7uRL0lWmxDITmqm7C+7F0Odmj6s9l6alZc6AELXhrnggM2CeWSXHGOdX2YtwA==", + "dev": true, + "license": "MIT", + "dependencies": { + "agent-base": "6", + "debug": "4" + }, + "engines": { + "node": ">= 6" + } + }, "node_modules/agent-base": { "version": "7.1.3", "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-7.1.3.tgz", @@ -732,12 +928,230 @@ "node": ">= 14" } }, + "node_modules/ansi-regex": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", + "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "license": "MIT", + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, "node_modules/asynckit": { "version": "0.4.0", "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", "integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==", "dev": true }, + "node_modules/b4a": { + "version": "1.7.3", + "resolved": "https://registry.npmjs.org/b4a/-/b4a-1.7.3.tgz", + "integrity": "sha512-5Q2mfq2WfGuFp3uS//0s6baOJLMoVduPYVeNmDYxu5OUA1/cBfvr2RIS7vi62LdNj/urk1hfmj867I3qt6uZ7Q==", + "dev": true, + "license": "Apache-2.0", + "peerDependencies": { + "react-native-b4a": "*" + }, + "peerDependenciesMeta": { + "react-native-b4a": { + "optional": true + } + } + }, + "node_modules/bare-events": { + "version": "2.8.2", + "resolved": "https://registry.npmjs.org/bare-events/-/bare-events-2.8.2.tgz", + "integrity": "sha512-riJjyv1/mHLIPX4RwiK+oW9/4c3TEUeORHKefKAKnZ5kyslbN+HXowtbaVEqt4IMUB7OXlfixcs6gsFeo/jhiQ==", + "dev": true, + "license": "Apache-2.0", + "peerDependencies": { + "bare-abort-controller": "*" + }, + "peerDependenciesMeta": { + "bare-abort-controller": { + "optional": true + } + } + }, + "node_modules/bare-fs": { + "version": "4.5.2", + "resolved": "https://registry.npmjs.org/bare-fs/-/bare-fs-4.5.2.tgz", + "integrity": "sha512-veTnRzkb6aPHOvSKIOy60KzURfBdUflr5VReI+NSaPL6xf+XLdONQgZgpYvUuZLVQ8dCqxpBAudaOM1+KpAUxw==", + "dev": true, + "license": "Apache-2.0", + "optional": true, + "dependencies": { + "bare-events": "^2.5.4", + "bare-path": "^3.0.0", + "bare-stream": "^2.6.4", + "bare-url": "^2.2.2", + "fast-fifo": "^1.3.2" + }, + "engines": { + "bare": ">=1.16.0" + }, + "peerDependencies": { + "bare-buffer": "*" + }, + "peerDependenciesMeta": { + "bare-buffer": { + "optional": true + } + } + }, + "node_modules/bare-os": { + "version": "3.6.2", + "resolved": "https://registry.npmjs.org/bare-os/-/bare-os-3.6.2.tgz", + "integrity": "sha512-T+V1+1srU2qYNBmJCXZkUY5vQ0B4FSlL3QDROnKQYOqeiQR8UbjNHlPa+TIbM4cuidiN9GaTaOZgSEgsvPbh5A==", + "dev": true, + "license": "Apache-2.0", + "optional": true, + "engines": { + "bare": ">=1.14.0" + } + }, + "node_modules/bare-path": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/bare-path/-/bare-path-3.0.0.tgz", + "integrity": "sha512-tyfW2cQcB5NN8Saijrhqn0Zh7AnFNsnczRcuWODH0eYAXBsJ5gVxAUuNr7tsHSC6IZ77cA0SitzT+s47kot8Mw==", + "dev": true, + "license": "Apache-2.0", + "optional": true, + "dependencies": { + "bare-os": "^3.0.1" + } + }, + "node_modules/bare-stream": { + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/bare-stream/-/bare-stream-2.7.0.tgz", + "integrity": "sha512-oyXQNicV1y8nc2aKffH+BUHFRXmx6VrPzlnaEvMhram0nPBrKcEdcyBg5r08D0i8VxngHFAiVyn1QKXpSG0B8A==", + "dev": true, + "license": "Apache-2.0", + "optional": true, + "dependencies": { + "streamx": "^2.21.0" + }, + "peerDependencies": { + "bare-buffer": "*", + "bare-events": "*" + }, + "peerDependenciesMeta": { + "bare-buffer": { + "optional": true + }, + "bare-events": { + "optional": true + } + } + }, + "node_modules/bare-url": { + "version": "2.3.2", + "resolved": "https://registry.npmjs.org/bare-url/-/bare-url-2.3.2.tgz", + "integrity": "sha512-ZMq4gd9ngV5aTMa5p9+UfY0b3skwhHELaDkhEHetMdX0LRkW9kzaym4oo/Eh+Ghm0CCDuMTsRIGM/ytUc1ZYmw==", + "dev": true, + "license": "Apache-2.0", + "optional": true, + "dependencies": { + "bare-path": "^3.0.0" + } + }, + "node_modules/base64-js": { + "version": "1.5.1", + "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz", + "integrity": "sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT" + }, + "node_modules/bl": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/bl/-/bl-4.1.0.tgz", + "integrity": "sha512-1W07cM9gS6DcLperZfFSj+bWLtaPGSOHWhPiGzXmvVJbRLdG82sH/Kn8EtW1VqWVA54AKf2h5k5BbnIbwF3h6w==", + "dev": true, + "license": "MIT", + "dependencies": { + "buffer": "^5.5.0", + "inherits": "^2.0.4", + "readable-stream": "^3.4.0" + } + }, + "node_modules/bl/node_modules/readable-stream": { + "version": "3.6.2", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz", + "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==", + "dev": true, + "license": "MIT", + "dependencies": { + "inherits": "^2.0.3", + "string_decoder": "^1.1.1", + "util-deprecate": "^1.0.1" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/bluebird": { + "version": "3.7.2", + "resolved": "https://registry.npmjs.org/bluebird/-/bluebird-3.7.2.tgz", + "integrity": "sha512-XpNj6GDQzdfW+r2Wnn7xiSAd7TM3jzkxGXBGTtWKuSXv1xUV+azxAm8jdWZN06QTQk+2N2XB9jRDkvbmQmcRtg==", + "dev": true, + "license": "MIT" + }, + "node_modules/buffer": { + "version": "5.7.1", + "resolved": "https://registry.npmjs.org/buffer/-/buffer-5.7.1.tgz", + "integrity": "sha512-EHcyIPBQ4BSGlvjB16k5KgAJ27CIsHY/2JBmCRReo48y9rQ3MaUzWX3KVlBa4U7MyX02HdVj0K7C3WaB3ju7FQ==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT", + "dependencies": { + "base64-js": "^1.3.1", + "ieee754": "^1.1.13" + } + }, "node_modules/cacache": { "version": "20.0.3", "resolved": "https://registry.npmjs.org/cacache/-/cacache-20.0.3.tgz", @@ -793,6 +1207,48 @@ "url": "https://github.com/chalk/chalk?sponsor=1" } }, + "node_modules/chownr": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/chownr/-/chownr-3.0.0.tgz", + "integrity": "sha512-+IxzY9BZOQd/XuYPRmrvEVjF/nqj5kgT4kEq7VofrDoM1MxoRjEWkrCC3EtLi59TVawxTAn+orJwFQcrqEN1+g==", + "dev": true, + "license": "BlueOak-1.0.0", + "engines": { + "node": ">=18" + } + }, + "node_modules/cliui": { + "version": "7.0.4", + "resolved": "https://registry.npmjs.org/cliui/-/cliui-7.0.4.tgz", + "integrity": "sha512-OcRE68cOsVMXp1Yvonl/fzkQOyjLSu/8bhPDfQt0e0/Eb283TKP20Fs2MqoPsr9SwA595rRCA+QMzYc9nBP+JQ==", + "dev": true, + "license": "ISC", + "dependencies": { + "string-width": "^4.2.0", + "strip-ansi": "^6.0.0", + "wrap-ansi": "^7.0.0" + } + }, + "node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true, + "license": "MIT" + }, "node_modules/combined-stream": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", @@ -805,6 +1261,13 @@ "node": ">= 0.8" } }, + "node_modules/core-util-is": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.3.tgz", + "integrity": "sha512-ZQBvi1DcpJ4GDqanjucZ2Hj3wEO5pZDS89BWbkcrvdxksJorwUDDZamX9ldFkp9aw2lmBDLgkObEA4DWNJ9FYQ==", + "dev": true, + "license": "MIT" + }, "node_modules/debug": { "version": "4.4.0", "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.0.tgz", @@ -822,6 +1285,32 @@ } } }, + "node_modules/decompress-response": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/decompress-response/-/decompress-response-6.0.0.tgz", + "integrity": "sha512-aW35yZM6Bb/4oJlZncMH2LCoZtJXTRxES17vE3hoRiowU2kWHaJKFkSBDnDR+cm9J+9QhXmREyIfv0pji9ejCQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "mimic-response": "^3.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/deep-extend": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz", + "integrity": "sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4.0.0" + } + }, "node_modules/delayed-stream": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", @@ -831,6 +1320,16 @@ "node": ">=0.4.0" } }, + "node_modules/detect-libc": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/detect-libc/-/detect-libc-2.1.2.tgz", + "integrity": "sha512-Btj2BOOO83o3WyH59e8MgXsxEQVcarkUOpEYrubB0urwnN10yQ364rsiByU11nZlqWYZm05i/of7io4mzihBtQ==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": ">=8" + } + }, "node_modules/dunder-proto": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/dunder-proto/-/dunder-proto-1.0.1.tgz", @@ -845,6 +1344,23 @@ "node": ">= 0.4" } }, + "node_modules/duplexer2": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/duplexer2/-/duplexer2-0.1.4.tgz", + "integrity": "sha512-asLFVfWWtJ90ZyOUHMqk7/S2w2guQKxUI2itj3d92ADHhxUSbCMGi1f1cBcJ7xM1To+pE/Khbwo1yuNbMEPKeA==", + "dev": true, + "license": "BSD-3-Clause", + "dependencies": { + "readable-stream": "^2.0.2" + } + }, + "node_modules/emoji-regex": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "dev": true, + "license": "MIT" + }, "node_modules/encoding": { "version": "0.1.13", "resolved": "https://registry.npmjs.org/encoding/-/encoding-0.1.13.tgz", @@ -855,6 +1371,16 @@ "iconv-lite": "^0.6.2" } }, + "node_modules/end-of-stream": { + "version": "1.4.5", + "resolved": "https://registry.npmjs.org/end-of-stream/-/end-of-stream-1.4.5.tgz", + "integrity": "sha512-ooEGc6HP26xXq/N+GCGOT0JKCLDGrq2bQUZrQ7gyrJiZANJ/8YDTxTpQBXGMn+WbIQXNVpyWymm7KYVICQnyOg==", + "dev": true, + "license": "MIT", + "dependencies": { + "once": "^1.4.0" + } + }, "node_modules/err-code": { "version": "2.0.3", "resolved": "https://registry.npmjs.org/err-code/-/err-code-2.0.3.tgz", @@ -948,6 +1474,61 @@ "@esbuild/win32-x64": "0.27.0" } }, + "node_modules/escalade": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.2.0.tgz", + "integrity": "sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/events-universal": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/events-universal/-/events-universal-1.0.1.tgz", + "integrity": "sha512-LUd5euvbMLpwOF8m6ivPCbhQeSiYVNb8Vs0fQ8QjXo0JTkEHpz8pxdQf0gStltaPpw0Cca8b39KxvK9cfKRiAw==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "bare-events": "^2.7.0" + } + }, + "node_modules/expand-template": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/expand-template/-/expand-template-2.0.3.tgz", + "integrity": "sha512-XYfuKMvj4O35f/pOXLObndIRvyQ+/+6AhODh+OKWj9S9498pHHn/IMszH+gt0fBCRWMNfk1ZSp5x3AifmnI2vg==", + "dev": true, + "license": "(MIT OR WTFPL)", + "engines": { + "node": ">=6" + } + }, + "node_modules/fast-fifo": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/fast-fifo/-/fast-fifo-1.3.2.tgz", + "integrity": "sha512-/d9sfos4yxzpwkDkuN7k2SqFKtYNmCTzgfEpz82x34IM9/zc8KGxQoXg1liNC/izpRM/MBdt44Nmx41ZWqk+FQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/fdir": { + "version": "6.5.0", + "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.5.0.tgz", + "integrity": "sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12.0.0" + }, + "peerDependencies": { + "picomatch": "^3 || ^4" + }, + "peerDependenciesMeta": { + "picomatch": { + "optional": true + } + } + }, "node_modules/form-data": { "version": "4.0.4", "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.4.tgz", @@ -964,6 +1545,39 @@ "node": ">= 6" } }, + "node_modules/from2": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/from2/-/from2-2.3.0.tgz", + "integrity": "sha512-OMcX/4IC/uqEPVgGeyfN22LJk6AZrMkRZHxcHBMBvHScDGgwTm2GT2Wkgtocyd3JfZffjj2kYUDXXII0Fk9W0g==", + "dev": true, + "license": "MIT", + "dependencies": { + "inherits": "^2.0.1", + "readable-stream": "^2.0.0" + } + }, + "node_modules/fs-constants": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/fs-constants/-/fs-constants-1.0.0.tgz", + "integrity": "sha512-y6OAwoSIf7FyjMIv94u+b5rdheZEjzR63GTyZJm5qh4Bi+2YgwLCcI/fPFZkL5PSixOt6ZNKm+w+Hfp/Bciwow==", + "dev": true, + "license": "MIT" + }, + "node_modules/fs-extra": { + "version": "11.3.2", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.3.2.tgz", + "integrity": "sha512-Xr9F6z6up6Ws+NjzMCZc6WXg2YFRlrLP9NQDO3VQrWrfiojdhS56TzueT88ze0uBdCTwEIhQ3ptnmKeWGFAe0A==", + "dev": true, + "license": "MIT", + "dependencies": { + "graceful-fs": "^4.2.0", + "jsonfile": "^6.0.1", + "universalify": "^2.0.0" + }, + "engines": { + "node": ">=14.14" + } + }, "node_modules/fs-minipass": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/fs-minipass/-/fs-minipass-3.0.3.tgz", @@ -985,6 +1599,16 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/get-caller-file": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz", + "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==", + "dev": true, + "license": "ISC", + "engines": { + "node": "6.* || 8.* || >= 10.*" + } + }, "node_modules/get-intrinsic": { "version": "1.3.0", "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.3.0.tgz", @@ -1022,6 +1646,13 @@ "node": ">= 0.4" } }, + "node_modules/github-from-package": { + "version": "0.0.0", + "resolved": "https://registry.npmjs.org/github-from-package/-/github-from-package-0.0.0.tgz", + "integrity": "sha512-SyHy3T1v2NUXn29OsWdxmK6RwHD+vkj3v8en8AOBZ1wBQ/hCAQ5bAQTD02kW4W9tUp/3Qh6J8r9EvntiyCmOOw==", + "dev": true, + "license": "MIT" + }, "node_modules/glob": { "version": "13.0.0", "resolved": "https://registry.npmjs.org/glob/-/glob-13.0.0.tgz", @@ -1051,6 +1682,13 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/graceful-fs": { + "version": "4.2.11", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz", + "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==", + "dev": true, + "license": "ISC" + }, "node_modules/has-symbols": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.1.0.tgz", @@ -1147,6 +1785,27 @@ "node": ">=0.10.0" } }, + "node_modules/ieee754": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/ieee754/-/ieee754-1.2.1.tgz", + "integrity": "sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "BSD-3-Clause" + }, "node_modules/imurmurhash": { "version": "0.1.4", "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", @@ -1156,6 +1815,13 @@ "node": ">=0.8.19" } }, + "node_modules/inherits": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", + "dev": true, + "license": "ISC" + }, "node_modules/ini": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/ini/-/ini-6.0.0.tgz", @@ -1165,6 +1831,23 @@ "node": "^20.17.0 || >=22.9.0" } }, + "node_modules/into-stream": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/into-stream/-/into-stream-6.0.0.tgz", + "integrity": "sha512-XHbaOAvP+uFKUFsOgoNPRjLkwB+I22JFPFe5OjTkQ0nwgj6+pSjb4NmB6VMxaPshLiOf+zcpOCBQuLwC1KHhZA==", + "dev": true, + "license": "MIT", + "dependencies": { + "from2": "^2.3.0", + "p-is-promise": "^3.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/ip-address": { "version": "10.1.0", "resolved": "https://registry.npmjs.org/ip-address/-/ip-address-10.1.0.tgz", @@ -1174,6 +1857,65 @@ "node": ">= 12" } }, + "node_modules/is-core-module": { + "version": "2.16.1", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.16.1.tgz", + "integrity": "sha512-UfoeMA6fIJ8wTYFEUjelnaGI67v6+N7qXJEvQuIGa99l4xsCruSYOVSQ0uPANn4dAzm8lkYPaKLrrijLq7x23w==", + "dev": true, + "license": "MIT", + "dependencies": { + "hasown": "^2.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/is-fullwidth-code-point": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", + "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/isarray": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", + "integrity": "sha512-VLghIWNM6ELQzo7zwmcg0NmTVyWKYjvIeM83yjp0wRDTmUnrM678fQbcKBo6n2CJEF0szoG//ytg+TKla89ALQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/jsesc": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-3.1.0.tgz", + "integrity": "sha512-/sM3dO2FOzXjKQhJuo0Q173wf2KOo8t4I8vHy6lF9poUp7bKT0/NHE8fPX23PwfhnykfqnC2xRxOnVw5XuGIaA==", + "dev": true, + "license": "MIT", + "bin": { + "jsesc": "bin/jsesc" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/jsonfile": { + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.2.0.tgz", + "integrity": "sha512-FGuPw30AdOIUTRMC2OMRtQV+jkVj2cfPqSeWXv1NEAJ1qZ5zb1X6z1mFhbfOB/iy3ssJCD+3KuZ8r8C3uVFlAg==", + "dev": true, + "license": "MIT", + "dependencies": { + "universalify": "^2.0.0" + }, + "optionalDependencies": { + "graceful-fs": "^4.1.6" + } + }, "node_modules/jsonparse": { "version": "1.3.1", "resolved": "https://registry.npmjs.org/jsonparse/-/jsonparse-1.3.1.tgz", @@ -1244,6 +1986,19 @@ "node": ">= 0.6" } }, + "node_modules/mimic-response": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/mimic-response/-/mimic-response-3.1.0.tgz", + "integrity": "sha512-z0yWI+4FDrrweS8Zmt4Ej5HdJmky15+L2e6Wgn3+iK5fWzb6T3fhNFq2+MeTRb064c6Wr4N/wv0DzQTjNzHNGQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/minimatch": { "version": "10.1.1", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-10.1.1.tgz", @@ -1259,6 +2014,16 @@ "url": "https://github.com/sponsors/isaacs" } }, + "node_modules/minimist": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz", + "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==", + "dev": true, + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/minipass": { "version": "7.1.2", "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.1.2.tgz", @@ -1381,18 +2146,72 @@ "node": ">= 18" } }, + "node_modules/mkdirp-classic": { + "version": "0.5.3", + "resolved": "https://registry.npmjs.org/mkdirp-classic/-/mkdirp-classic-0.5.3.tgz", + "integrity": "sha512-gKLcREMhtuZRwRAfqP3RFW+TK4JqApVBtOIftVgjuABpAtpxhPGaDcfvbhNvD0B8iD1oUr/txX35NjcaY6Ns/A==", + "dev": true, + "license": "MIT" + }, "node_modules/ms": { "version": "2.1.3", "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", "license": "MIT" }, + "node_modules/multistream": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/multistream/-/multistream-4.1.0.tgz", + "integrity": "sha512-J1XDiAmmNpRCBfIWJv+n0ymC4ABcf/Pl+5YvC5B/D2f/2+8PtHvCNxMPKiQcZyi922Hq69J2YOpb1pTywfifyw==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT", + "dependencies": { + "once": "^1.4.0", + "readable-stream": "^3.6.0" + } + }, + "node_modules/multistream/node_modules/readable-stream": { + "version": "3.6.2", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz", + "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==", + "dev": true, + "license": "MIT", + "dependencies": { + "inherits": "^2.0.3", + "string_decoder": "^1.1.1", + "util-deprecate": "^1.0.1" + }, + "engines": { + "node": ">= 6" + } + }, "node_modules/nan": { "version": "2.23.0", "resolved": "https://registry.npmjs.org/nan/-/nan-2.23.0.tgz", "integrity": "sha512-1UxuyYGdoQHcGg87Lkqm3FzefucTa0NAiOcuRsDmysep3c1LVCRK2krrUDafMWtjSG04htvAmvg96+SDknOmgQ==", "license": "MIT" }, + "node_modules/napi-build-utils": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/napi-build-utils/-/napi-build-utils-2.0.0.tgz", + "integrity": "sha512-GEbrYkbfF7MoNaoh2iGG84Mnf/WZfB0GdGEsM8wz7Expx/LlWf5U8t9nvJKXSp3qr5IsEbK04cBGhol/KwOsWA==", + "dev": true, + "license": "MIT" + }, "node_modules/negotiator": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-1.0.0.tgz", @@ -1402,6 +2221,40 @@ "node": ">= 0.6" } }, + "node_modules/node-abi": { + "version": "3.85.0", + "resolved": "https://registry.npmjs.org/node-abi/-/node-abi-3.85.0.tgz", + "integrity": "sha512-zsFhmbkAzwhTft6nd3VxcG0cvJsT70rL+BIGHWVq5fi6MwGrHwzqKaxXE+Hl2GmnGItnDKPPkO5/LQqjVkIdFg==", + "dev": true, + "license": "MIT", + "dependencies": { + "semver": "^7.3.5" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/node-fetch": { + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", + "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", + "dev": true, + "license": "MIT", + "dependencies": { + "whatwg-url": "^5.0.0" + }, + "engines": { + "node": "4.x || >=6.0.0" + }, + "peerDependencies": { + "encoding": "^0.1.0" + }, + "peerDependenciesMeta": { + "encoding": { + "optional": true + } + } + }, "node_modules/node-forge": { "version": "1.3.2", "resolved": "https://registry.npmjs.org/node-forge/-/node-forge-1.3.2.tgz", @@ -1411,6 +2264,13 @@ "node": ">= 6.13.0" } }, + "node_modules/node-int64": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/node-int64/-/node-int64-0.4.0.tgz", + "integrity": "sha512-O5lz91xSOeoXP6DulyHfllpq+Eg00MWitZIbtPfoSEvqIHdl5gfcY6hYzDWnj0qD5tz52PI08u9qUvSVeUBeHw==", + "dev": true, + "license": "MIT" + }, "node_modules/node-pty": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/node-pty/-/node-pty-1.0.0.tgz", @@ -1455,6 +2315,16 @@ "node": "^20.17.0 || >=22.9.0" } }, + "node_modules/once": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", + "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==", + "dev": true, + "license": "ISC", + "dependencies": { + "wrappy": "1" + } + }, "node_modules/oxlint": { "version": "1.22.0", "resolved": "https://registry.npmjs.org/oxlint/-/oxlint-1.22.0.tgz", @@ -1489,6 +2359,16 @@ } } }, + "node_modules/p-is-promise": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/p-is-promise/-/p-is-promise-3.0.0.tgz", + "integrity": "sha512-Wo8VsW4IRQSKVXsJCn7TomUaVtyfjVDn3nUP7kE967BQk0CwFpdbZs0X0uk5sW9mkBa9eNM7hCMaG93WUAwxYQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, "node_modules/p-map": { "version": "7.0.4", "resolved": "https://registry.npmjs.org/p-map/-/p-map-7.0.4.tgz", @@ -1501,6 +2381,13 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/path-parse": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz", + "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", + "dev": true, + "license": "MIT" + }, "node_modules/path-scurry": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-2.0.1.tgz", @@ -1517,6 +2404,105 @@ "url": "https://github.com/sponsors/isaacs" } }, + "node_modules/picocolors": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", + "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", + "dev": true, + "license": "ISC" + }, + "node_modules/picomatch": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", + "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/prebuild-install": { + "version": "7.1.3", + "resolved": "https://registry.npmjs.org/prebuild-install/-/prebuild-install-7.1.3.tgz", + "integrity": "sha512-8Mf2cbV7x1cXPUILADGI3wuhfqWvtiLA1iclTDbFRZkgRQS0NqsPZphna9V+HyTEadheuPmjaJMsbzKQFOzLug==", + "dev": true, + "license": "MIT", + "dependencies": { + "detect-libc": "^2.0.0", + "expand-template": "^2.0.3", + "github-from-package": "0.0.0", + "minimist": "^1.2.3", + "mkdirp-classic": "^0.5.3", + "napi-build-utils": "^2.0.0", + "node-abi": "^3.3.0", + "pump": "^3.0.0", + "rc": "^1.2.7", + "simple-get": "^4.0.0", + "tar-fs": "^2.0.0", + "tunnel-agent": "^0.6.0" + }, + "bin": { + "prebuild-install": "bin.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/prebuild-install/node_modules/chownr": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/chownr/-/chownr-1.1.4.tgz", + "integrity": "sha512-jJ0bqzaylmJtVnNgzTeSOs8DPavpbYgEr/b0YL8/2GO3xJEhInFmhKMUnEJQjZumK7KXGFhUy89PrsJWlakBVg==", + "dev": true, + "license": "ISC" + }, + "node_modules/prebuild-install/node_modules/readable-stream": { + "version": "3.6.2", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz", + "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==", + "dev": true, + "license": "MIT", + "dependencies": { + "inherits": "^2.0.3", + "string_decoder": "^1.1.1", + "util-deprecate": "^1.0.1" + }, + "engines": { + "node": ">= 6" + } + }, + "node_modules/prebuild-install/node_modules/tar-fs": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/tar-fs/-/tar-fs-2.1.4.tgz", + "integrity": "sha512-mDAjwmZdh7LTT6pNleZ05Yt65HC3E+NiQzl672vQG38jIrehtJk/J3mNwIg+vShQPcLF/LV7CMnDW6vjj6sfYQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "chownr": "^1.1.1", + "mkdirp-classic": "^0.5.2", + "pump": "^3.0.0", + "tar-stream": "^2.1.4" + } + }, + "node_modules/prebuild-install/node_modules/tar-stream": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/tar-stream/-/tar-stream-2.2.0.tgz", + "integrity": "sha512-ujeqbceABgwMZxEJnk2HDY2DlnUZ+9oEcb1KzTVfYHio0UE6dG71n60d8D2I4qNvleWrrXpmjpt7vZeF1LnMZQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "bl": "^4.0.3", + "end-of-stream": "^1.4.1", + "fs-constants": "^1.0.0", + "inherits": "^2.0.3", + "readable-stream": "^3.1.1" + }, + "engines": { + "node": ">=6" + } + }, "node_modules/proc-log": { "version": "6.1.0", "resolved": "https://registry.npmjs.org/proc-log/-/proc-log-6.1.0.tgz", @@ -1526,6 +2512,23 @@ "node": "^20.17.0 || >=22.9.0" } }, + "node_modules/process-nextick-args": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.1.tgz", + "integrity": "sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag==", + "dev": true, + "license": "MIT" + }, + "node_modules/progress": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/progress/-/progress-2.0.3.tgz", + "integrity": "sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.4.0" + } + }, "node_modules/promise-retry": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/promise-retry/-/promise-retry-2.0.1.tgz", @@ -1539,6 +2542,87 @@ "node": ">=10" } }, + "node_modules/pump": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/pump/-/pump-3.0.3.tgz", + "integrity": "sha512-todwxLMY7/heScKmntwQG8CXVkWUOdYxIvY2s0VWAAMh/nd8SoYiRaKjlr7+iCs984f2P8zvrfWcDDYVb73NfA==", + "dev": true, + "license": "MIT", + "dependencies": { + "end-of-stream": "^1.1.0", + "once": "^1.3.1" + } + }, + "node_modules/rc": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/rc/-/rc-1.2.8.tgz", + "integrity": "sha512-y3bGgqKj3QBdxLbLkomlohkvsA8gdAiUQlSBJnBhfn+BPxg4bc62d8TcBW15wavDfgexCgccckhcZvywyQYPOw==", + "dev": true, + "license": "(BSD-2-Clause OR MIT OR Apache-2.0)", + "dependencies": { + "deep-extend": "^0.6.0", + "ini": "~1.3.0", + "minimist": "^1.2.0", + "strip-json-comments": "~2.0.1" + }, + "bin": { + "rc": "cli.js" + } + }, + "node_modules/rc/node_modules/ini": { + "version": "1.3.8", + "resolved": "https://registry.npmjs.org/ini/-/ini-1.3.8.tgz", + "integrity": "sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew==", + "dev": true, + "license": "ISC" + }, + "node_modules/readable-stream": { + "version": "2.3.8", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.8.tgz", + "integrity": "sha512-8p0AUk4XODgIewSi0l8Epjs+EVnWiK7NoDIEGU0HhE7+ZyY8D1IMY7odu5lRrFXGg71L15KG8QrPmum45RTtdA==", + "dev": true, + "license": "MIT", + "dependencies": { + "core-util-is": "~1.0.0", + "inherits": "~2.0.3", + "isarray": "~1.0.0", + "process-nextick-args": "~2.0.0", + "safe-buffer": "~5.1.1", + "string_decoder": "~1.1.1", + "util-deprecate": "~1.0.1" + } + }, + "node_modules/require-directory": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", + "integrity": "sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/resolve": { + "version": "1.22.11", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.11.tgz", + "integrity": "sha512-RfqAvLnMl313r7c9oclB1HhUEAezcpLjz95wFH4LVuhk9JF/r22qmVP9AMmOU4vMX7Q8pN8jwNg/CSpdFnMjTQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "is-core-module": "^2.16.1", + "path-parse": "^1.0.7", + "supports-preserve-symlinks-flag": "^1.0.0" + }, + "bin": { + "resolve": "bin/resolve" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/retry": { "version": "0.12.0", "resolved": "https://registry.npmjs.org/retry/-/retry-0.12.0.tgz", @@ -1548,6 +2632,13 @@ "node": ">= 4" } }, + "node_modules/safe-buffer": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz", + "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==", + "dev": true, + "license": "MIT" + }, "node_modules/safer-buffer": { "version": "2.1.2", "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", @@ -1567,6 +2658,53 @@ "node": ">=10" } }, + "node_modules/simple-concat": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/simple-concat/-/simple-concat-1.0.1.tgz", + "integrity": "sha512-cSFtAPtRhljv69IK0hTVZQ+OfE9nePi/rtJmw5UjHeVyVroEqJXP1sFztKUy1qU+xvz3u/sfYJLa947b7nAN2Q==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT" + }, + "node_modules/simple-get": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/simple-get/-/simple-get-4.0.1.tgz", + "integrity": "sha512-brv7p5WgH0jmQJr1ZDDfKDOSeWWg+OVypG99A/5vYGPqJ6pxiaHLy8nxtFjBA7oMa01ebA9gfh1uMCFqOuXxvA==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT", + "dependencies": { + "decompress-response": "^6.0.0", + "once": "^1.3.1", + "simple-concat": "^1.0.0" + } + }, "node_modules/smart-buffer": { "version": "4.2.0", "resolved": "https://registry.npmjs.org/smart-buffer/-/smart-buffer-4.2.0.tgz", @@ -1617,6 +2755,190 @@ "node": "^20.17.0 || >=22.9.0" } }, + "node_modules/stream-meter": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/stream-meter/-/stream-meter-1.0.4.tgz", + "integrity": "sha512-4sOEtrbgFotXwnEuzzsQBYEV1elAeFSO8rSGeTwabuX1RRn/kEq9JVH7I0MRBhKVRR0sJkr0M0QCH7yOLf9fhQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "readable-stream": "^2.1.4" + } + }, + "node_modules/streamx": { + "version": "2.23.0", + "resolved": "https://registry.npmjs.org/streamx/-/streamx-2.23.0.tgz", + "integrity": "sha512-kn+e44esVfn2Fa/O0CPFcex27fjIL6MkVae0Mm6q+E6f0hWv578YCERbv+4m02cjxvDsPKLnmxral/rR6lBMAg==", + "dev": true, + "license": "MIT", + "dependencies": { + "events-universal": "^1.0.0", + "fast-fifo": "^1.3.2", + "text-decoder": "^1.1.0" + } + }, + "node_modules/string_decoder": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", + "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", + "dev": true, + "license": "MIT", + "dependencies": { + "safe-buffer": "~5.1.0" + } + }, + "node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "dev": true, + "license": "MIT", + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/strip-json-comments": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz", + "integrity": "sha512-4gB8na07fecVVkOI6Rs4e7T6NOTki5EmL7TUduTs6bu3EdnSycntVJ4re8kgZA+wx9IueI2Y11bfbgwtzuE0KQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/supports-preserve-symlinks-flag": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz", + "integrity": "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/tar": { + "version": "7.5.2", + "resolved": "https://registry.npmjs.org/tar/-/tar-7.5.2.tgz", + "integrity": "sha512-7NyxrTE4Anh8km8iEy7o0QYPs+0JKBTj5ZaqHg6B39erLg0qYXN3BijtShwbsNSvQ+LN75+KV+C4QR/f6Gwnpg==", + "dev": true, + "license": "BlueOak-1.0.0", + "dependencies": { + "@isaacs/fs-minipass": "^4.0.0", + "chownr": "^3.0.0", + "minipass": "^7.1.2", + "minizlib": "^3.1.0", + "yallist": "^5.0.0" + }, + "engines": { + "node": ">=18" + } + }, + "node_modules/tar-fs": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/tar-fs/-/tar-fs-3.1.1.tgz", + "integrity": "sha512-LZA0oaPOc2fVo82Txf3gw+AkEd38szODlptMYejQUhndHMLQ9M059uXR+AfS7DNo0NpINvSqDsvyaCrBVkptWg==", + "dev": true, + "license": "MIT", + "dependencies": { + "pump": "^3.0.0", + "tar-stream": "^3.1.5" + }, + "optionalDependencies": { + "bare-fs": "^4.0.1", + "bare-path": "^3.0.0" + } + }, + "node_modules/tar-stream": { + "version": "3.1.7", + "resolved": "https://registry.npmjs.org/tar-stream/-/tar-stream-3.1.7.tgz", + "integrity": "sha512-qJj60CXt7IU1Ffyc3NJMjh6EkuCFej46zUqJ4J7pqYlThyd9bO0XBTmcOIhSzZJVWfsLks0+nle/j538YAW9RQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "b4a": "^1.6.4", + "fast-fifo": "^1.2.0", + "streamx": "^2.15.0" + } + }, + "node_modules/tar/node_modules/yallist": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-5.0.0.tgz", + "integrity": "sha512-YgvUTfwqyc7UXVMrB+SImsVYSmTS8X/tSrtdNZMImM+n7+QTriRXyXim0mBrTXNeqzVF0KWGgHPeiyViFFrNDw==", + "dev": true, + "license": "BlueOak-1.0.0", + "engines": { + "node": ">=18" + } + }, + "node_modules/text-decoder": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/text-decoder/-/text-decoder-1.2.3.tgz", + "integrity": "sha512-3/o9z3X0X0fTupwsYvR03pJ/DjWuqqrfwBgTQzdWDiQSm9KitAyz/9WqsT2JQW7KV2m+bC2ol/zqpW37NHxLaA==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "b4a": "^1.6.4" + } + }, + "node_modules/tinyglobby": { + "version": "0.2.15", + "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.15.tgz", + "integrity": "sha512-j2Zq4NyQYG5XMST4cbs02Ak8iJUdxRM0XI5QyxXuZOzKOINmWurp3smXu3y5wDcJrptwpSjgXHzIQxR0omXljQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "fdir": "^6.5.0", + "picomatch": "^4.0.3" + }, + "engines": { + "node": ">=12.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/SuperchupuDev" + } + }, + "node_modules/tr46": { + "version": "0.0.3", + "resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz", + "integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==", + "dev": true, + "license": "MIT" + }, + "node_modules/tunnel-agent": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/tunnel-agent/-/tunnel-agent-0.6.0.tgz", + "integrity": "sha512-McnNiV1l8RYeY8tBgEpuodCC1mLUdbSN+CYBL7kJsJNInOP8UjDDEwdk6Mw60vdLLrr5NHKZhMAOSrR2NZuQ+w==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "safe-buffer": "^5.0.1" + }, + "engines": { + "node": "*" + } + }, "node_modules/typescript": { "version": "5.9.3", "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.3.tgz", @@ -1660,6 +2982,37 @@ "node": "^20.17.0 || >=22.9.0" } }, + "node_modules/universalify": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz", + "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 10.0.0" + } + }, + "node_modules/unzipper": { + "version": "0.12.3", + "resolved": "https://registry.npmjs.org/unzipper/-/unzipper-0.12.3.tgz", + "integrity": "sha512-PZ8hTS+AqcGxsaQntl3IRBw65QrBI6lxzqDEL7IAo/XCEqRTKGfOX56Vea5TH9SZczRVxuzk1re04z/YjuYCJA==", + "dev": true, + "license": "MIT", + "dependencies": { + "bluebird": "~3.7.2", + "duplexer2": "~0.1.4", + "fs-extra": "^11.2.0", + "graceful-fs": "^4.2.2", + "node-int64": "^0.4.0" + } + }, + "node_modules/util-deprecate": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", + "integrity": "sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==", + "dev": true, + "license": "MIT" + }, "node_modules/validate-npm-package-name": { "version": "7.0.0", "resolved": "https://registry.npmjs.org/validate-npm-package-name/-/validate-npm-package-name-7.0.0.tgz", @@ -1669,12 +3022,94 @@ "node": "^20.17.0 || >=22.9.0" } }, + "node_modules/webidl-conversions": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz", + "integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==", + "dev": true, + "license": "BSD-2-Clause" + }, + "node_modules/whatwg-url": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz", + "integrity": "sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw==", + "dev": true, + "license": "MIT", + "dependencies": { + "tr46": "~0.0.3", + "webidl-conversions": "^3.0.0" + } + }, + "node_modules/wrap-ansi": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", + "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-styles": "^4.0.0", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/wrap-ansi?sponsor=1" + } + }, + "node_modules/wrappy": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", + "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==", + "dev": true, + "license": "ISC" + }, + "node_modules/y18n": { + "version": "5.0.8", + "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz", + "integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==", + "dev": true, + "license": "ISC", + "engines": { + "node": ">=10" + } + }, "node_modules/yallist": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", "license": "ISC" }, + "node_modules/yargs": { + "version": "16.2.0", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-16.2.0.tgz", + "integrity": "sha512-D1mvvtDG0L5ft/jGWkLpG1+m0eQxOfaBvTNELraWj22wSVUMWxZUvYgJYcKh6jGGIkJFhH4IZPQhR4TKpc8mBw==", + "dev": true, + "license": "MIT", + "dependencies": { + "cliui": "^7.0.2", + "escalade": "^3.1.1", + "get-caller-file": "^2.0.5", + "require-directory": "^2.1.1", + "string-width": "^4.2.0", + "y18n": "^5.0.5", + "yargs-parser": "^20.2.2" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/yargs-parser": { + "version": "20.2.9", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-20.2.9.tgz", + "integrity": "sha512-y11nGElTIV+CT3Zv9t7VKl+Q3hTQoT9a1Qzezhhl6Rp21gJ/IVTW7Z3y9EWXhuUBC2Shnf+DX0antecpAwSP8w==", + "dev": true, + "license": "ISC", + "engines": { + "node": ">=10" + } + }, "packages/safe-chain": { "name": "@aikidosec/safe-chain", "version": "1.0.0", @@ -1694,13 +3129,19 @@ "aikido-bunx": "bin/aikido-bunx.js", "aikido-npm": "bin/aikido-npm.js", "aikido-npx": "bin/aikido-npx.js", + "aikido-pdm": "bin/aikido-pdm.js", "aikido-pip": "bin/aikido-pip.js", "aikido-pip3": "bin/aikido-pip3.js", + "aikido-pipx": "bin/aikido-pipx.js", "aikido-pnpm": "bin/aikido-pnpm.js", "aikido-pnpx": "bin/aikido-pnpx.js", + "aikido-poetry": "bin/aikido-poetry.js", "aikido-python": "bin/aikido-python.js", "aikido-python3": "bin/aikido-python3.js", + "aikido-rush": "bin/aikido-rush.js", + "aikido-rushx": "bin/aikido-rushx.js", "aikido-uv": "bin/aikido-uv.js", + "aikido-uvx": "bin/aikido-uvx.js", "aikido-yarn": "bin/aikido-yarn.js", "safe-chain": "bin/safe-chain.js" }, diff --git a/package.json b/package.json index 8428fe4..2793f9c 100644 --- a/package.json +++ b/package.json @@ -20,6 +20,7 @@ "license": "AGPL-3.0-or-later", "devDependencies": { "oxlint": "^1.22.0", - "esbuild": "^0.27.0" + "esbuild": "^0.27.0", + "@yao-pkg/pkg": "6.10.1" } } diff --git a/packages/safe-chain/bin/aikido-pdm.js b/packages/safe-chain/bin/aikido-pdm.js new file mode 100755 index 0000000..9c6cf94 --- /dev/null +++ b/packages/safe-chain/bin/aikido-pdm.js @@ -0,0 +1,13 @@ +#!/usr/bin/env node + +import { main } from "../src/main.js"; +import { initializePackageManager } from "../src/packagemanager/currentPackageManager.js"; +import { setEcoSystem, ECOSYSTEM_PY } from "../src/config/settings.js"; + +setEcoSystem(ECOSYSTEM_PY); +initializePackageManager("pdm"); + +(async () => { + var exitCode = await main(process.argv.slice(2)); + process.exit(exitCode); +})(); diff --git a/packages/safe-chain/bin/aikido-pip.js b/packages/safe-chain/bin/aikido-pip.js index 006e661..6eb3e4e 100755 --- a/packages/safe-chain/bin/aikido-pip.js +++ b/packages/safe-chain/bin/aikido-pip.js @@ -3,15 +3,12 @@ import { main } from "../src/main.js"; import { initializePackageManager } from "../src/packagemanager/currentPackageManager.js"; import { setEcoSystem, ECOSYSTEM_PY } from "../src/config/settings.js"; -import { setCurrentPipInvocation, PIP_INVOCATIONS, PIP_PACKAGE_MANAGER } from "../src/packagemanager/pip/pipSettings.js"; +import { PIP_PACKAGE_MANAGER, PIP_COMMAND } from "../src/packagemanager/pip/pipSettings.js"; // Set eco system setEcoSystem(ECOSYSTEM_PY); -// Set current invocation -setCurrentPipInvocation(PIP_INVOCATIONS.PIP); - -initializePackageManager(PIP_PACKAGE_MANAGER); +initializePackageManager(PIP_PACKAGE_MANAGER, { tool: PIP_COMMAND, args: process.argv.slice(2) }); (async () => { // Pass through only user-supplied pip args diff --git a/packages/safe-chain/bin/aikido-pip3.js b/packages/safe-chain/bin/aikido-pip3.js index e831afe..510b688 100755 --- a/packages/safe-chain/bin/aikido-pip3.js +++ b/packages/safe-chain/bin/aikido-pip3.js @@ -3,16 +3,12 @@ import { main } from "../src/main.js"; import { initializePackageManager } from "../src/packagemanager/currentPackageManager.js"; import { setEcoSystem, ECOSYSTEM_PY } from "../src/config/settings.js"; -import { setCurrentPipInvocation, PIP_INVOCATIONS, PIP_PACKAGE_MANAGER } from "../src/packagemanager/pip/pipSettings.js"; +import { PIP_PACKAGE_MANAGER, PIP3_COMMAND } from "../src/packagemanager/pip/pipSettings.js"; // Set eco system setEcoSystem(ECOSYSTEM_PY); -// Set current invocation -setCurrentPipInvocation(PIP_INVOCATIONS.PIP3); - -// Create package manager -initializePackageManager(PIP_PACKAGE_MANAGER); +initializePackageManager(PIP_PACKAGE_MANAGER, { tool: PIP3_COMMAND, args: process.argv.slice(2) }); (async () => { // Pass through only user-supplied pip args diff --git a/packages/safe-chain/bin/aikido-pipx.js b/packages/safe-chain/bin/aikido-pipx.js new file mode 100755 index 0000000..13e78f0 --- /dev/null +++ b/packages/safe-chain/bin/aikido-pipx.js @@ -0,0 +1,16 @@ +#!/usr/bin/env node + +import { main } from "../src/main.js"; +import { initializePackageManager } from "../src/packagemanager/currentPackageManager.js"; +import { setEcoSystem, ECOSYSTEM_PY } from "../src/config/settings.js"; + +// Set eco system +setEcoSystem(ECOSYSTEM_PY); + +initializePackageManager("pipx"); + +(async () => { + // Pass through only user-supplied pipx args + var exitCode = await main(process.argv.slice(2)); + process.exit(exitCode); +})(); diff --git a/packages/safe-chain/bin/aikido-poetry.js b/packages/safe-chain/bin/aikido-poetry.js new file mode 100755 index 0000000..63169be --- /dev/null +++ b/packages/safe-chain/bin/aikido-poetry.js @@ -0,0 +1,13 @@ +#!/usr/bin/env node + +import { main } from "../src/main.js"; +import { initializePackageManager } from "../src/packagemanager/currentPackageManager.js"; +import { setEcoSystem, ECOSYSTEM_PY } from "../src/config/settings.js"; + +setEcoSystem(ECOSYSTEM_PY); +initializePackageManager("poetry"); + +(async () => { + var exitCode = await main(process.argv.slice(2)); + process.exit(exitCode); +})(); diff --git a/packages/safe-chain/bin/aikido-python.js b/packages/safe-chain/bin/aikido-python.js index 29c38e6..b769b4a 100755 --- a/packages/safe-chain/bin/aikido-python.js +++ b/packages/safe-chain/bin/aikido-python.js @@ -1,7 +1,7 @@ #!/usr/bin/env node import { initializePackageManager } from "../src/packagemanager/currentPackageManager.js"; -import { setCurrentPipInvocation, PIP_INVOCATIONS, PIP_PACKAGE_MANAGER } from "../src/packagemanager/pip/pipSettings.js"; +import { PIP_PACKAGE_MANAGER, PYTHON_COMMAND } from "../src/packagemanager/pip/pipSettings.js"; import { setEcoSystem, ECOSYSTEM_PY } from "../src/config/settings.js"; import { main } from "../src/main.js"; @@ -11,20 +11,9 @@ setEcoSystem(ECOSYSTEM_PY); // Strip nodejs and wrapper script from args let argv = process.argv.slice(2); +initializePackageManager(PIP_PACKAGE_MANAGER, { tool: PYTHON_COMMAND, args: argv }); + (async () => { - if (argv[0] === '-m' && (argv[1] === 'pip' || argv[1] === 'pip3')) { - setEcoSystem(ECOSYSTEM_PY); - setCurrentPipInvocation(argv[1] === 'pip3' ? PIP_INVOCATIONS.PY_PIP3 : PIP_INVOCATIONS.PY_PIP); - initializePackageManager(PIP_PACKAGE_MANAGER); - - // Strip off the '-m pip' or '-m pip3' from the args - argv = argv.slice(2); - - var exitCode = await main(argv); - process.exit(exitCode); - } else { - // Forward to real python binary for non-pip flows - const { spawn } = await import('child_process'); - spawn('python', argv, { stdio: 'inherit' }); - } + var exitCode = await main(argv); + process.exit(exitCode); })(); diff --git a/packages/safe-chain/bin/aikido-python3.js b/packages/safe-chain/bin/aikido-python3.js index 997a88d..c572a7b 100755 --- a/packages/safe-chain/bin/aikido-python3.js +++ b/packages/safe-chain/bin/aikido-python3.js @@ -1,7 +1,7 @@ #!/usr/bin/env node import { initializePackageManager } from "../src/packagemanager/currentPackageManager.js"; -import { setCurrentPipInvocation, PIP_INVOCATIONS, PIP_PACKAGE_MANAGER } from "../src/packagemanager/pip/pipSettings.js"; +import { PIP_PACKAGE_MANAGER, PYTHON3_COMMAND } from "../src/packagemanager/pip/pipSettings.js"; import { setEcoSystem, ECOSYSTEM_PY } from "../src/config/settings.js"; import { main } from "../src/main.js"; @@ -11,20 +11,9 @@ setEcoSystem(ECOSYSTEM_PY); // Strip nodejs and wrapper script from args let argv = process.argv.slice(2); +initializePackageManager(PIP_PACKAGE_MANAGER, { tool: PYTHON3_COMMAND, args: argv }); + (async () => { - if (argv[0] === '-m' && (argv[1] === 'pip' || argv[1] === 'pip3')) { - setEcoSystem(ECOSYSTEM_PY); - setCurrentPipInvocation(argv[1] === 'pip3' ? PIP_INVOCATIONS.PY3_PIP3 : PIP_INVOCATIONS.PY3_PIP); - initializePackageManager(PIP_PACKAGE_MANAGER); - - // Strip off the '-m pip' or '-m pip3' from the args - argv = argv.slice(2); - - var exitCode = await main(argv); - process.exit(exitCode); - } else { - // Forward to real python3 binary for non-pip flows - const { spawn } = await import('child_process'); - spawn('python3', argv, { stdio: 'inherit' }); - } + var exitCode = await main(argv); + process.exit(exitCode); })(); diff --git a/packages/safe-chain/bin/aikido-rush.js b/packages/safe-chain/bin/aikido-rush.js new file mode 100755 index 0000000..b5d8094 --- /dev/null +++ b/packages/safe-chain/bin/aikido-rush.js @@ -0,0 +1,14 @@ +#!/usr/bin/env node + +import { main } from "../src/main.js"; +import { initializePackageManager } from "../src/packagemanager/currentPackageManager.js"; +import { setEcoSystem, ECOSYSTEM_JS } from "../src/config/settings.js"; + +setEcoSystem(ECOSYSTEM_JS); +const packageManagerName = "rush"; +initializePackageManager(packageManagerName); + +(async () => { + var exitCode = await main(process.argv.slice(2)); + process.exit(exitCode); +})(); diff --git a/packages/safe-chain/bin/aikido-rushx.js b/packages/safe-chain/bin/aikido-rushx.js new file mode 100755 index 0000000..dfa168c --- /dev/null +++ b/packages/safe-chain/bin/aikido-rushx.js @@ -0,0 +1,14 @@ +#!/usr/bin/env node + +import { main } from "../src/main.js"; +import { initializePackageManager } from "../src/packagemanager/currentPackageManager.js"; +import { setEcoSystem, ECOSYSTEM_JS } from "../src/config/settings.js"; + +setEcoSystem(ECOSYSTEM_JS); +const packageManagerName = "rushx"; +initializePackageManager(packageManagerName); + +(async () => { + var exitCode = await main(process.argv.slice(2)); + process.exit(exitCode); +})(); diff --git a/packages/safe-chain/bin/aikido-uvx.js b/packages/safe-chain/bin/aikido-uvx.js new file mode 100755 index 0000000..10bb9f3 --- /dev/null +++ b/packages/safe-chain/bin/aikido-uvx.js @@ -0,0 +1,16 @@ +#!/usr/bin/env node + +import { main } from "../src/main.js"; +import { initializePackageManager } from "../src/packagemanager/currentPackageManager.js"; +import { setEcoSystem, ECOSYSTEM_PY } from "../src/config/settings.js"; + +// Set eco system +setEcoSystem(ECOSYSTEM_PY); + +initializePackageManager("uvx"); + +(async () => { + // Pass through only user-supplied uvx args + var exitCode = await main(process.argv.slice(2)); + process.exit(exitCode); +})(); diff --git a/packages/safe-chain/bin/safe-chain.js b/packages/safe-chain/bin/safe-chain.js index 0a73f0e..6ff33a0 100755 --- a/packages/safe-chain/bin/safe-chain.js +++ b/packages/safe-chain/bin/safe-chain.js @@ -1,9 +1,18 @@ #!/usr/bin/env node +// Strip PKG_EXECPATH from the environment so any child process safe-chain +// spawns (npm, uv, pip, …) doesn't inherit it. If it leaks into a subsequent +// safe-chain invocation (e.g. via a shim) the yao-pkg bootstrap would treat +// argv[1] as a script path and fail with MODULE_NOT_FOUND. +delete process.env.PKG_EXECPATH; + import chalk from "chalk"; import { ui } from "../src/environment/userInteraction.js"; import { setup } from "../src/shell-integration/setup.js"; -import { teardown } from "../src/shell-integration/teardown.js"; +import { + teardown, + teardownDirectories, +} from "../src/shell-integration/teardown.js"; import { setupCi } from "../src/shell-integration/setup-ci.js"; import { initializeCliArguments } from "../src/config/cliArguments.js"; import { setEcoSystem } from "../src/config/settings.js"; @@ -12,16 +21,16 @@ import { main } from "../src/main.js"; import path from "path"; import { fileURLToPath } from "url"; import fs from "fs"; -import { knownAikidoTools } from "../src/shell-integration/helpers.js"; -import { - PIP_INVOCATIONS, - PIP_PACKAGE_MANAGER, - setCurrentPipInvocation, -} from "../src/packagemanager/pip/pipSettings.js"; +import { knownAikidoTools, getPackageManagerList } from "../src/shell-integration/helpers.js"; +import { getInstalledSafeChainDir } from "../src/installLocation.js"; /** @type {string} */ +// This checks the current file's dirname in a way that's compatible with: +// - Modulejs (import.meta.url) +// - ES modules (__dirname) +// This is needed because safe-chain's npm package is built using ES modules, +// but building the binaries requires commonjs. let dirname; - if (import.meta.url) { const filename = fileURLToPath(import.meta.url); dirname = path.dirname(filename); @@ -42,15 +51,14 @@ const command = process.argv[2]; const tool = knownAikidoTools.find((tool) => tool.tool === command); -if (tool && tool.internalPackageManagerName === PIP_PACKAGE_MANAGER) { - (async function () { - await executePip(tool); - })(); -} else if (tool) { +if (tool) { const args = process.argv.slice(3); setEcoSystem(tool.ecoSystem); - initializePackageManager(tool.internalPackageManagerName); + + // Provide tool context to PM (pip uses this; others ignore) + const toolContext = { tool: tool.tool, args }; + initializePackageManager(tool.internalPackageManagerName, toolContext); (async () => { var exitCode = await main(args); @@ -63,8 +71,20 @@ if (tool && tool.internalPackageManagerName === PIP_PACKAGE_MANAGER) { setup(); } else if (command === "teardown") { teardown(); + teardownDirectories(); } else if (command === "setup-ci") { setupCi(); +} else if (command === "get-install-dir") { + const installDir = getInstalledSafeChainDir(); + if (!installDir) { + ui.writeError( + "Install directory is only available for packaged safe-chain binaries.", + ); + process.exit(1); + } + + ui.writeInformation(installDir); + process.exit(0); } else if (command === "--version" || command === "-v" || command === "-v") { (async () => { ui.writeInformation(`Current safe-chain version: ${await getVersion()}`); @@ -80,46 +100,41 @@ if (tool && tool.internalPackageManagerName === PIP_PACKAGE_MANAGER) { function writeHelp() { ui.writeInformation( - chalk.bold("Usage: ") + chalk.cyan("safe-chain ") + chalk.bold("Usage: ") + chalk.cyan("safe-chain "), ); ui.emptyLine(); ui.writeInformation( `Available commands: ${chalk.cyan("setup")}, ${chalk.cyan( - "teardown" - )}, ${chalk.cyan("setup-ci")}, ${chalk.cyan("help")}, ${chalk.cyan( - "--version" - )}` + "teardown", + )}, ${chalk.cyan("setup-ci")}, ${chalk.cyan("get-install-dir")}, ${chalk.cyan("help")}, ${chalk.cyan( + "--version", + )}`, ); ui.emptyLine(); ui.writeInformation( `- ${chalk.cyan( - "safe-chain setup" - )}: This will setup your shell to wrap safe-chain around npm, npx, yarn, pnpm, pnpx, bun, bunx, pip and pip3.` - ); - ui.writeInformation( - ` ${chalk.yellow( - "--include-python" - )}: Experimental: include Python package managers (pip, pip3) in the setup.` + "safe-chain setup", + )}: This will setup your shell to wrap safe-chain around ${getPackageManagerList()}.`, ); ui.writeInformation( `- ${chalk.cyan( - "safe-chain teardown" - )}: This will remove safe-chain aliases from your shell configuration.` + "safe-chain teardown", + )}: This will remove safe-chain aliases from your shell configuration.`, ); ui.writeInformation( `- ${chalk.cyan( - "safe-chain setup-ci" - )}: This will setup safe-chain for CI environments by creating shims and modifying the PATH.` + "safe-chain setup-ci", + )}: This will setup safe-chain for CI environments by creating shims and modifying the PATH.`, ); ui.writeInformation( - ` ${chalk.yellow( - "--include-python" - )}: Experimental: include Python package managers (pip, pip3) in the setup.` + `- ${chalk.cyan( + "safe-chain get-install-dir", + )}: Print the install directory for packaged safe-chain binaries.`, ); ui.writeInformation( `- ${chalk.cyan("safe-chain --version")} (or ${chalk.cyan( - "-v" - )}): Display the current version of safe-chain.` + "-v", + )}): Display the current version of safe-chain.`, ); ui.emptyLine(); } @@ -134,47 +149,5 @@ async function getVersion() { return json.version; } - return "1.0.0"; -} - -/** - * @param {import("../src/shell-integration/helpers.js").AikidoTool} tool - */ -async function executePip(tool) { - let args = process.argv.slice(3); - setEcoSystem(tool.ecoSystem); - initializePackageManager(PIP_PACKAGE_MANAGER); - - let shouldSkip = false; - if (tool.tool === "pip") { - setCurrentPipInvocation(PIP_INVOCATIONS.PIP); - } else if (tool.tool === "pip3") { - setCurrentPipInvocation(PIP_INVOCATIONS.PIP3); - } else if (tool.tool === "python") { - if (args[0] === "-m" && (args[1] === "pip" || args[1] === "pip3")) { - setCurrentPipInvocation( - args[1] === "pip3" ? PIP_INVOCATIONS.PY_PIP3 : PIP_INVOCATIONS.PY_PIP - ); - args = args.slice(2); - } else { - shouldSkip = true; - } - } else if (tool.tool === "python3") { - if (args[0] === "-m" && (args[1] === "pip" || args[1] === "pip3")) { - setCurrentPipInvocation( - args[1] === "pip3" ? PIP_INVOCATIONS.PY3_PIP3 : PIP_INVOCATIONS.PY3_PIP - ); - args = args.slice(2); - } else { - shouldSkip = true; - } - } - - if (shouldSkip) { - const { spawn } = await import("child_process"); - spawn(tool.tool, args, { stdio: "inherit" }); - } else { - var exitCode = await main(args); - process.exit(exitCode); - } + return "0.0.0"; } diff --git a/packages/safe-chain/package.json b/packages/safe-chain/package.json index 5353635..72f9bac 100644 --- a/packages/safe-chain/package.json +++ b/packages/safe-chain/package.json @@ -13,13 +13,19 @@ "aikido-yarn": "bin/aikido-yarn.js", "aikido-pnpm": "bin/aikido-pnpm.js", "aikido-pnpx": "bin/aikido-pnpx.js", + "aikido-rush": "bin/aikido-rush.js", + "aikido-rushx": "bin/aikido-rushx.js", "aikido-bun": "bin/aikido-bun.js", "aikido-bunx": "bin/aikido-bunx.js", "aikido-uv": "bin/aikido-uv.js", + "aikido-uvx": "bin/aikido-uvx.js", "aikido-pip": "bin/aikido-pip.js", "aikido-pip3": "bin/aikido-pip3.js", "aikido-python": "bin/aikido-python.js", "aikido-python3": "bin/aikido-python3.js", + "aikido-poetry": "bin/aikido-poetry.js", + "aikido-pipx": "bin/aikido-pipx.js", + "aikido-pdm": "bin/aikido-pdm.js", "safe-chain": "bin/safe-chain.js" }, "type": "module", @@ -34,7 +40,7 @@ "keywords": [], "author": "Aikido Security", "license": "AGPL-3.0-or-later", - "description": "The Aikido Safe Chain wraps around the [npm cli](https://github.com/npm/cli), [npx](https://github.com/npm/cli/blob/latest/docs/content/commands/npx.md), [yarn](https://yarnpkg.com/), [pnpm](https://pnpm.io/), [pnpx](https://pnpm.io/cli/dlx), [bun](https://bun.sh/), [bunx](https://bun.sh/docs/cli/bunx), [uv](https://docs.astral.sh/uv/) (Python), and [pip](https://pip.pypa.io/) to provide extra checks before installing new packages. This tool will detect when a package contains malware and prompt you to exit, preventing npm, npx, yarn, pnpm, pnpx, bun, bunx, uv, or pip/pip3 from downloading or running the malware.", + "description": "The Aikido Safe Chain wraps around the [npm cli](https://github.com/npm/cli), [npx](https://github.com/npm/cli/blob/latest/docs/content/commands/npx.md), [yarn](https://yarnpkg.com/), [pnpm](https://pnpm.io/), [pnpx](https://pnpm.io/cli/dlx), [rush](https://rushjs.io/), [rushx](https://rushjs.io/pages/commands/rushx/), [bun](https://bun.sh/), [bunx](https://bun.sh/docs/cli/bunx), [uv](https://docs.astral.sh/uv/) (Python), [pip](https://pip.pypa.io/), and [pdm](https://pdm-project.org/) to provide extra checks before installing new packages. This tool will detect when a package contains malware and prompt you to exit, preventing npm, npx, yarn, pnpm, pnpx, rush, rushx, bun, bunx, uv, uvx, pip/pip3, or pdm from downloading or running the malware.", "dependencies": { "certifi": "14.5.15", "chalk": "5.4.1", diff --git a/packages/safe-chain/src/api/aikido.js b/packages/safe-chain/src/api/aikido.js index 5c04360..25babb9 100644 --- a/packages/safe-chain/src/api/aikido.js +++ b/packages/safe-chain/src/api/aikido.js @@ -1,11 +1,24 @@ import fetch from "make-fetch-happen"; -import { getEcoSystem, ECOSYSTEM_JS, ECOSYSTEM_PY } from "../config/settings.js"; +import { + getEcoSystem, + ECOSYSTEM_JS, + ECOSYSTEM_PY, + getMalwareListBaseUrl, +} from "../config/settings.js"; +import { ui } from "../environment/userInteraction.js"; -const malwareDatabaseUrls = { - [ECOSYSTEM_JS]: "https://malware-list.aikido.dev/malware_predictions.json", - [ECOSYSTEM_PY]: "https://malware-list.aikido.dev/malware_pypi.json", +const malwareDatabasePaths = { + [ECOSYSTEM_JS]: "malware_predictions.json", + [ECOSYSTEM_PY]: "malware_pypi.json", }; +const newPackagesListPaths = { + [ECOSYSTEM_JS]: "releases/npm.json", + [ECOSYSTEM_PY]: "releases/pypi.json", +}; + +const DEFAULT_FETCH_RETRY_ATTEMPTS = 4; + /** * @typedef {Object} MalwarePackage * @property {string} package_name @@ -13,42 +26,162 @@ const malwareDatabaseUrls = { * @property {string} reason */ +/** + * @typedef {Object} NewPackageEntry + * @property {string} [source] + * @property {string} package_name + * @property {string} version + * @property {number} released_on - Unix timestamp (seconds) + * @property {number} scraped_on - Unix timestamp (seconds) + */ + /** * @returns {Promise<{malwareDatabase: MalwarePackage[], version: string | undefined}>} */ export async function fetchMalwareDatabase() { - const ecosystem = getEcoSystem(); - const malwareDatabaseUrl = malwareDatabaseUrls[/** @type {keyof typeof malwareDatabaseUrls} */ (ecosystem)]; - const response = await fetch(malwareDatabaseUrl); - if (!response.ok) { - throw new Error(`Error fetching ${ecosystem} malware database: ${response.statusText}`); - } + return retry(async () => { + const ecosystem = getEcoSystem(); + const baseUrl = getMalwareListBaseUrl(); + const path = malwareDatabasePaths[ + /** @type {keyof typeof malwareDatabasePaths} */ (ecosystem) + ]; + const malwareDatabaseUrl = `${baseUrl}/${path}`; + const response = await fetch(malwareDatabaseUrl); + if (!response.ok) { + throw new Error( + `Error fetching ${ecosystem} malware database: ${response.statusText}` + ); + } - try { - let malwareDatabase = await response.json(); - return { - malwareDatabase: malwareDatabase, - version: response.headers.get("etag") || undefined, - }; - } catch (/** @type {any} */ error) { - throw new Error(`Error parsing malware database: ${error.message}`); - } + try { + let malwareDatabase = await response.json(); + return { + malwareDatabase: malwareDatabase, + version: response.headers.get("etag") || undefined, + }; + } catch (/** @type {any} */ error) { + throw new Error(`Error parsing malware database: ${error.message}`); + } + }, DEFAULT_FETCH_RETRY_ATTEMPTS); } /** * @returns {Promise} */ export async function fetchMalwareDatabaseVersion() { - const ecosystem = getEcoSystem(); - const malwareDatabaseUrl = malwareDatabaseUrls[/** @type {keyof typeof malwareDatabaseUrls} */ (ecosystem)]; - const response = await fetch(malwareDatabaseUrl, { - method: "HEAD", - }); + return retry(async () => { + const ecosystem = getEcoSystem(); + const baseUrl = getMalwareListBaseUrl(); + const path = malwareDatabasePaths[ + /** @type {keyof typeof malwareDatabasePaths} */ (ecosystem) + ]; + const malwareDatabaseUrl = `${baseUrl}/${path}`; + const response = await fetch(malwareDatabaseUrl, { + method: "HEAD", + }); - if (!response.ok) { - throw new Error( - `Error fetching ${ecosystem} malware database version: ${response.statusText}` - ); - } - return response.headers.get("etag") || undefined; + if (!response.ok) { + throw new Error( + `Error fetching ${ecosystem} malware database version: ${response.statusText}` + ); + } + return response.headers.get("etag") || undefined; + }, DEFAULT_FETCH_RETRY_ATTEMPTS); +} + +/** + * @returns {Promise<{newPackagesList: NewPackageEntry[], version: string | undefined}>} + */ +export async function fetchNewPackagesList() { + return retry(async () => { + const ecosystem = getEcoSystem(); + const baseUrl = getMalwareListBaseUrl(); + const path = newPackagesListPaths[/** @type {keyof typeof newPackagesListPaths} */ (ecosystem)]; + + if (!path) { + return { newPackagesList: [], version: undefined }; + } + + const url = `${baseUrl}/${path}`; + + const response = await fetch(url); + if (!response.ok) { + throw new Error( + `Error fetching ${ecosystem} new packages list: ${response.statusText}` + ); + } + + try { + const newPackagesList = await response.json(); + return { + newPackagesList, + version: response.headers.get("etag") || undefined, + }; + } catch (/** @type {any} */ error) { + throw new Error(`Error parsing new packages list: ${error.message}`); + } + }, DEFAULT_FETCH_RETRY_ATTEMPTS); +} + +/** + * @returns {Promise} + */ +export async function fetchNewPackagesListVersion() { + return retry(async () => { + const ecosystem = getEcoSystem(); + const baseUrl = getMalwareListBaseUrl(); + const path = newPackagesListPaths[/** @type {keyof typeof newPackagesListPaths} */ (ecosystem)]; + + if (!path) { + return undefined; + } + + const url = `${baseUrl}/${path}`; + + const response = await fetch(url, { method: "HEAD" }); + if (!response.ok) { + throw new Error( + `Error fetching ${ecosystem} new packages list version: ${response.statusText}` + ); + } + + return response.headers.get("etag") || undefined; + }, DEFAULT_FETCH_RETRY_ATTEMPTS); +} + +/** + * Retries an asynchronous function multiple times until it succeeds or exhausts all attempts. + * + * @template T + * @param {() => Promise} func - The asynchronous function to retry + * @param {number} attempts - The number of attempts + * @returns {Promise} The return value of the function if successful + * @throws {Error} The last error encountered if all retry attempts fail + */ +async function retry(func, attempts) { + let lastError; + + for (let i = 0; i < attempts; i++) { + try { + return await func(); + } catch (error) { + ui.writeVerbose( + "An error occurred while trying to download Aikido data", + error + ); + lastError = error; + } + + if (i < attempts - 1) { + // When this is not the last try, back-off exponentially: + // 1st attempt - 500ms delay + // 2nd attempt - 1000ms delay + // 3rd attempt - 2000ms delay + // 4th attempt - 4000ms delay + // ... + await new Promise((resolve) => setTimeout(resolve, Math.pow(2, i) * 500)); + } + } + + throw lastError; } diff --git a/packages/safe-chain/src/api/aikido.spec.js b/packages/safe-chain/src/api/aikido.spec.js new file mode 100644 index 0000000..f41b9d2 --- /dev/null +++ b/packages/safe-chain/src/api/aikido.spec.js @@ -0,0 +1,231 @@ +import { describe, it, mock, beforeEach } from "node:test"; +import assert from "node:assert"; + +describe("aikido API", async () => { + const mockFetch = mock.fn(); + let ecosystem = "js"; + + mock.module("make-fetch-happen", { + defaultExport: mockFetch, + }); + + mock.module("../environment/userInteraction.js", { + namedExports: { + ui: { + writeVerbose: () => {}, + }, + }, + }); + + mock.module("../config/settings.js", { + namedExports: { + getEcoSystem: () => ecosystem, + ECOSYSTEM_JS: "js", + ECOSYSTEM_PY: "py", + getMalwareListBaseUrl: () => "https://malware-list.aikido.dev", + }, + }); + + const { + fetchMalwareDatabase, + fetchMalwareDatabaseVersion, + fetchNewPackagesList, + fetchNewPackagesListVersion, + } = await import("./aikido.js"); + + beforeEach(() => { + mockFetch.mock.resetCalls(); + ecosystem = "js"; + }); + + describe("fetchMalwareDatabase", () => { + it("should succeed immediately when fetch succeeds on first try", async () => { + const malwareData = [ + { package_name: "malicious-pkg", version: "1.0.0", reason: "test" }, + ]; + mockFetch.mock.mockImplementationOnce(() => ({ + ok: true, + json: async () => malwareData, + headers: { get: () => '"etag-123"' }, + })); + + const result = await fetchMalwareDatabase(); + + assert.strictEqual(mockFetch.mock.calls.length, 1); + assert.deepStrictEqual(result.malwareDatabase, malwareData); + assert.strictEqual(result.version, '"etag-123"'); + }); + + it("should throw error after exhausting all retries", async () => { + mockFetch.mock.mockImplementation(() => { + throw new Error("Network error"); + }); + + await assert.rejects(() => fetchMalwareDatabase(), { + message: "Network error", + }); + + assert.strictEqual(mockFetch.mock.calls.length, 4); + }); + + it("should succeed after failing 3 times and succeeding on 4th attempt", async () => { + const malwareData = [ + { package_name: "bad-pkg", version: "2.0.0", reason: "malware" }, + ]; + let callCount = 0; + mockFetch.mock.mockImplementation(() => { + callCount++; + if (callCount < 4) { + throw new Error("Network error"); + } + return { + ok: true, + json: async () => malwareData, + headers: { get: () => '"etag-456"' }, + }; + }); + + const result = await fetchMalwareDatabase(); + + assert.strictEqual(mockFetch.mock.calls.length, 4); + assert.deepStrictEqual(result.malwareDatabase, malwareData); + assert.strictEqual(result.version, '"etag-456"'); + }); + }); + + describe("fetchMalwareDatabaseVersion", () => { + it("should succeed immediately when fetch succeeds on first try", async () => { + mockFetch.mock.mockImplementationOnce(() => ({ + ok: true, + headers: { get: () => '"version-etag"' }, + })); + + const result = await fetchMalwareDatabaseVersion(); + + assert.strictEqual(mockFetch.mock.calls.length, 1); + assert.strictEqual(result, '"version-etag"'); + }); + + it("should throw error after exhausting all retries", async () => { + mockFetch.mock.mockImplementation(() => { + throw new Error("Connection refused"); + }); + + await assert.rejects(() => fetchMalwareDatabaseVersion(), { + message: "Connection refused", + }); + + assert.strictEqual(mockFetch.mock.calls.length, 4); + }); + + it("should succeed after failing 3 times and succeeding on 4th attempt", async () => { + let callCount = 0; + mockFetch.mock.mockImplementation(() => { + callCount++; + if (callCount < 4) { + throw new Error("Timeout"); + } + return { + ok: true, + headers: { get: () => '"final-etag"' }, + }; + }); + + const result = await fetchMalwareDatabaseVersion(); + + assert.strictEqual(mockFetch.mock.calls.length, 4); + assert.strictEqual(result, '"final-etag"'); + }); + }); + + describe("fetchNewPackagesList", () => { + it("should succeed immediately when fetch succeeds on first try", async () => { + const releases = [ + { + package_name: "fresh-pkg", + version: "1.0.0", + released_on: 123, + }, + ]; + mockFetch.mock.mockImplementationOnce(() => ({ + ok: true, + json: async () => releases, + headers: { get: () => '"etag-new-packages"' }, + })); + + const result = await fetchNewPackagesList(); + + assert.strictEqual(mockFetch.mock.calls.length, 1); + assert.strictEqual( + mockFetch.mock.calls[0].arguments[0], + "https://malware-list.aikido.dev/releases/npm.json" + ); + assert.deepStrictEqual(result.newPackagesList, releases); + assert.strictEqual(result.version, '"etag-new-packages"'); + }); + + it("should throw error after exhausting all retries", async () => { + mockFetch.mock.mockImplementation(() => { + throw new Error("Network error"); + }); + + await assert.rejects(() => fetchNewPackagesList(), { + message: "Network error", + }); + + assert.strictEqual(mockFetch.mock.calls.length, 4); + }); + + it("should return an empty list without fetching for unsupported ecosystems", async () => { + ecosystem = "ruby"; + + const result = await fetchNewPackagesList(); + + assert.strictEqual(mockFetch.mock.calls.length, 0); + assert.deepStrictEqual(result.newPackagesList, []); + assert.strictEqual(result.version, undefined); + }); + + it("should return undefined version without fetching for unsupported ecosystems", async () => { + ecosystem = "ruby"; + + const result = await fetchNewPackagesListVersion(); + + assert.strictEqual(mockFetch.mock.calls.length, 0); + assert.strictEqual(result, undefined); + }); + }); + + describe("fetchNewPackagesListVersion", () => { + it("should succeed immediately when fetch succeeds on first try", async () => { + mockFetch.mock.mockImplementationOnce(() => ({ + ok: true, + headers: { get: () => '"new-packages-etag"' }, + })); + + const result = await fetchNewPackagesListVersion(); + + assert.strictEqual(mockFetch.mock.calls.length, 1); + assert.strictEqual( + mockFetch.mock.calls[0].arguments[0], + "https://malware-list.aikido.dev/releases/npm.json" + ); + assert.deepStrictEqual(mockFetch.mock.calls[0].arguments[1], { + method: "HEAD", + }); + assert.strictEqual(result, '"new-packages-etag"'); + }); + + it("should throw error after exhausting all retries", async () => { + mockFetch.mock.mockImplementation(() => { + throw new Error("Connection refused"); + }); + + await assert.rejects(() => fetchNewPackagesListVersion(), { + message: "Connection refused", + }); + + assert.strictEqual(mockFetch.mock.calls.length, 4); + }); + }); +}); diff --git a/packages/safe-chain/src/config/cliArguments.js b/packages/safe-chain/src/config/cliArguments.js index ddcd8b9..918761c 100644 --- a/packages/safe-chain/src/config/cliArguments.js +++ b/packages/safe-chain/src/config/cliArguments.js @@ -1,11 +1,13 @@ +import { ui } from "../environment/userInteraction.js"; + /** - * @type {{loggingLevel: string | undefined, skipMinimumPackageAge: boolean | undefined, minimumPackageAgeHours: string | undefined, includePython: boolean}} + * @type {{loggingLevel: string | undefined, skipMinimumPackageAge: boolean | undefined, minimumPackageAgeHours: string | undefined, malwareListBaseUrl: string | undefined}} */ const state = { loggingLevel: undefined, skipMinimumPackageAge: undefined, minimumPackageAgeHours: undefined, - includePython: false, + malwareListBaseUrl: undefined, }; const SAFE_CHAIN_ARG_PREFIX = "--safe-chain-"; @@ -19,6 +21,7 @@ export function initializeCliArguments(args) { state.loggingLevel = undefined; state.skipMinimumPackageAge = undefined; state.minimumPackageAgeHours = undefined; + state.malwareListBaseUrl = undefined; const safeChainArgs = []; const remainingArgs = []; @@ -34,8 +37,8 @@ export function initializeCliArguments(args) { setLoggingLevel(safeChainArgs); setSkipMinimumPackageAge(safeChainArgs); setMinimumPackageAgeHours(safeChainArgs); - setIncludePython(args); - + setMalwareListBaseUrl(safeChainArgs); + checkDeprecatedPythonFlag(args); return remainingArgs; } @@ -111,16 +114,22 @@ export function getMinimumPackageAgeHours() { /** * @param {string[]} args + * @returns {void} */ -function setIncludePython(args) { - // This flag doesn't have the --safe-chain- prefix because - // it is only used for the safe-chain command itself and - // not when wrapped around package manager commands. - state.includePython = hasFlagArg(args, "--include-python"); +function setMalwareListBaseUrl(args) { + const argName = SAFE_CHAIN_ARG_PREFIX + "malware-list-base-url="; + + const value = getLastArgEqualsValue(args, argName); + if (value) { + state.malwareListBaseUrl = value; + } } -export function includePython() { - return state.includePython; +/** + * @returns {string | undefined} + */ +export function getMalwareListBaseUrl() { + return state.malwareListBaseUrl; } /** @@ -136,3 +145,17 @@ function hasFlagArg(args, flagName) { } return false; } + +/** + * Emits a deprecation warning for legacy --include-python flag + * + * @param {string[]} args + * @returns {void} + */ +export function checkDeprecatedPythonFlag(args) { + if (hasFlagArg(args, "--include-python")) { + ui.writeWarning( + "--include-python is deprecated and ignored. Python tooling is included by default." + ); + } +} diff --git a/packages/safe-chain/src/config/cliArguments.spec.js b/packages/safe-chain/src/config/cliArguments.spec.js index bbd5121..8b505be 100644 --- a/packages/safe-chain/src/config/cliArguments.spec.js +++ b/packages/safe-chain/src/config/cliArguments.spec.js @@ -6,6 +6,7 @@ import { getSkipMinimumPackageAge, getMinimumPackageAgeHours, } from "./cliArguments.js"; +import { ui } from "../environment/userInteraction.js"; describe("initializeCliArguments", () => { it("should return all args when no safe-chain args are present", () => { @@ -271,4 +272,40 @@ describe("initializeCliArguments", () => { assert.strictEqual(getMinimumPackageAgeHours(), "-24"); }); + + it("should warn on deprecated --include-python for setup", () => { + const warnings = []; + const originalWriteWarning = ui.writeWarning; + ui.writeWarning = (msg, ..._rest) => { + warnings.push(String(msg)); + }; + try { + const argv = ["node", "safe-chain", "setup", "--include-python"]; + initializeCliArguments(argv); + assert.ok( + warnings.some((m) => m.includes("--include-python is deprecated")), + "Expected a deprecation warning for --include-python in setup" + ); + } finally { + ui.writeWarning = originalWriteWarning; + } + }); + + it("should warn on deprecated --include-python for setup-ci", () => { + const warnings = []; + const originalWriteWarning = ui.writeWarning; + ui.writeWarning = (msg, ..._rest) => { + warnings.push(String(msg)); + }; + try { + const argv = ["node", "safe-chain", "setup-ci", "--include-python"]; + initializeCliArguments(argv); + assert.ok( + warnings.some((m) => m.includes("--include-python is deprecated")), + "Expected a deprecation warning for --include-python in setup-ci" + ); + } finally { + ui.writeWarning = originalWriteWarning; + } + }); }); diff --git a/packages/safe-chain/src/config/configFile.js b/packages/safe-chain/src/config/configFile.js index ae25a1d..d340130 100644 --- a/packages/safe-chain/src/config/configFile.js +++ b/packages/safe-chain/src/config/configFile.js @@ -3,14 +3,22 @@ import path from "path"; import os from "os"; import { ui } from "../environment/userInteraction.js"; import { getEcoSystem } from "./settings.js"; +import { getSafeChainBaseDir } from "./safeChainDir.js"; /** * @typedef {Object} SafeChainConfig * - * This should be a number, but can be anything because it is user-input. + * We cannot trust the input and should add the necessary validations + * @property {unknown | Number} scanTimeout + * @property {unknown | Number} minimumPackageAgeHours + * @property {unknown | string} malwareListBaseUrl + * @property {unknown | SafeChainRegistryConfiguration} npm + * @property {unknown | SafeChainRegistryConfiguration} pip + * + * @typedef {Object} SafeChainRegistryConfiguration * We cannot trust the input and should add the necessary validations. - * @property {unknown} scanTimeout - * @property {unknown} minimumPackageAgeHours + * @property {unknown | string[]} customRegistries + * @property {unknown | string[]} minimumPackageAgeExclusions */ /** @@ -67,7 +75,7 @@ function validateMinimumPackageAgeHours(value) { */ export function getMinimumPackageAgeHours() { const config = readConfigFile(); - if (config.minimumPackageAgeHours) { + if (config.minimumPackageAgeHours !== undefined) { const validated = validateMinimumPackageAgeHours( config.minimumPackageAgeHours ); @@ -78,6 +86,86 @@ export function getMinimumPackageAgeHours() { return undefined; } +/** + * Gets the malware list base URL from config file only + * @returns {string | undefined} + */ +export function getMalwareListBaseUrl() { + const config = readConfigFile(); + if (config.malwareListBaseUrl && typeof config.malwareListBaseUrl === "string") { + return config.malwareListBaseUrl; + } + return undefined; +} + +/** + * Gets the custom npm registries from the config file (format parsing only, no validation) + * @returns {string[]} + */ +export function getNpmCustomRegistries() { + const config = readConfigFile(); + + if (!config || !config.npm) { + return []; + } + + // TypeScript needs help understanding that config.npm exists and has customRegistries + const npmConfig = /** @type {SafeChainRegistryConfiguration} */ (config.npm); + const customRegistries = npmConfig.customRegistries; + + if (!Array.isArray(customRegistries)) { + return []; + } + + return customRegistries.filter((item) => typeof item === "string"); +} + +/** + * Gets the custom npm registries from the config file (format parsing only, no validation) + * @returns {string[]} + */ +export function getPipCustomRegistries() { + const config = readConfigFile(); + + if (!config || !config.pip) { + return []; + } + + // TypeScript needs help understanding that config.pip exists and has customRegistries + const pipConfig = /** @type {SafeChainRegistryConfiguration} */ (config.pip); + const customRegistries = pipConfig.customRegistries; + + if (!Array.isArray(customRegistries)) { + return []; + } + + return customRegistries.filter((item) => typeof item === "string"); +} + +/** + * Gets the minimum package age exclusions from the config file for the current ecosystem + * @returns {string[]} + */ +export function getMinimumPackageAgeExclusions() { + const config = readConfigFile(); + const ecosystem = getEcoSystem(); + const registryConfig = ecosystem === "py" ? config.pip : config.npm; + + if (!config || !registryConfig) { + return []; + } + + const typedRegistryConfig = + /** @type {SafeChainRegistryConfiguration} */ (registryConfig); + const exclusions = typedRegistryConfig.minimumPackageAgeExclusions; + + if (!Array.isArray(exclusions)) { + return []; + } + + return exclusions.filter((item) => typeof item === "string"); +} + /** * @param {import("../api/aikido.js").MalwarePackage[]} data * @param {string | number} version @@ -136,23 +224,30 @@ export function readDatabaseFromLocalCache() { * @returns {SafeChainConfig} */ function readConfigFile() { + /** @type {SafeChainConfig} */ + const emptyConfig = { + scanTimeout: undefined, + minimumPackageAgeHours: undefined, + malwareListBaseUrl: undefined, + npm: { + customRegistries: undefined, + }, + pip: { + customRegistries: undefined, + }, + }; + const configFilePath = getConfigFilePath(); if (!fs.existsSync(configFilePath)) { - return { - scanTimeout: undefined, - minimumPackageAgeHours: undefined, - }; + return emptyConfig; } try { const data = fs.readFileSync(configFilePath, "utf8"); return JSON.parse(data); } catch { - return { - scanTimeout: undefined, - minimumPackageAgeHours: undefined, - }; + return emptyConfig; } } @@ -171,11 +266,51 @@ function getDatabaseVersionPath() { return path.join(aikidoDir, `version_${ecosystem}.txt`); } +/** + * @returns {string} + */ +export function getNewPackagesListPath() { + const safeChainDir = getSafeChainDirectory(); + const ecosystem = getEcoSystem(); + return path.join(safeChainDir, `newPackagesList_${ecosystem}.json`); +} + +/** + * @returns {string} + */ +export function getNewPackagesListVersionPath() { + const safeChainDir = getSafeChainDirectory(); + const ecosystem = getEcoSystem(); + return path.join(safeChainDir, `newPackagesList_version_${ecosystem}.txt`); +} + /** * @returns {string} */ function getConfigFilePath() { - return path.join(getAikidoDirectory(), "config.json"); + const primaryPath = path.join(getSafeChainDirectory(), "config.json"); + if (fs.existsSync(primaryPath)) { + return primaryPath; + } + + const legacyPath = path.join(getAikidoDirectory(), "config.json"); + if (fs.existsSync(legacyPath)) { + return legacyPath; + } + + return primaryPath; +} + +/** + * @returns {string} + */ +export function getSafeChainDirectory() { + const safeChainDir = getSafeChainBaseDir(); + + if (!fs.existsSync(safeChainDir)) { + fs.mkdirSync(safeChainDir, { recursive: true }); + } + return safeChainDir; } /** diff --git a/packages/safe-chain/src/config/configFile.spec.js b/packages/safe-chain/src/config/configFile.spec.js index 18415bc..8b36ff2 100644 --- a/packages/safe-chain/src/config/configFile.spec.js +++ b/packages/safe-chain/src/config/configFile.spec.js @@ -1,32 +1,43 @@ import { describe, it, beforeEach, afterEach, mock } from "node:test"; import assert from "node:assert"; +import os from "os"; +import path from "path"; -describe("getScanTimeout", () => { +const safeChainConfigPath = path.join(os.homedir(), ".safe-chain", "config.json"); +const aikidoConfigPath = path.join(os.homedir(), ".aikido", "config.json"); + +/** @type {Map} */ +let mockFiles = new Map(); +mock.module("fs", { + namedExports: { + existsSync: (filePath) => mockFiles.has(filePath), + readFileSync: (filePath) => { + if (!mockFiles.has(filePath)) { + throw new Error(`ENOENT: no such file: ${filePath}`); + } + return mockFiles.get(filePath); + }, + writeFileSync: (filePath, content) => mockFiles.set(filePath, content), + mkdirSync: () => {}, + }, +}); + +/** + * Helper to set config content at the primary (~/.safe-chain/) location. + * @param {string} content + */ +function setConfigContent(content) { + mockFiles.set(safeChainConfigPath, content); +} + +describe("getScanTimeout", async () => { let originalEnv; - let fsMock; - let getScanTimeout; + + const { getScanTimeout } = await import("./configFile.js"); beforeEach(async () => { // Save original environment originalEnv = process.env.AIKIDO_SCAN_TIMEOUT_MS; - - // Mock fs module - fsMock = { - existsSync: mock.fn(() => false), - readFileSync: mock.fn(() => "{}"), - writeFileSync: mock.fn(), - mkdirSync: mock.fn(), - }; - - mock.module("fs", { - namedExports: fsMock, - }); - - // Re-import the module to get the mocked version - const configFileModule = await import( - `./configFile.js?update=${Date.now()}` - ); - getScanTimeout = configFileModule.getScanTimeout; }); afterEach(() => { @@ -37,14 +48,11 @@ describe("getScanTimeout", () => { delete process.env.AIKIDO_SCAN_TIMEOUT_MS; } - // Reset all mocks - mock.restoreAll(); + mockFiles.clear(); }); it("should return default timeout of 10000ms when no config or env var is set", () => { delete process.env.AIKIDO_SCAN_TIMEOUT_MS; - // Mock: config file doesn't exist - fsMock.existsSync.mock.mockImplementation(() => false); const timeout = getScanTimeout(); @@ -53,11 +61,7 @@ describe("getScanTimeout", () => { it("should return timeout from config file when set", () => { delete process.env.AIKIDO_SCAN_TIMEOUT_MS; - // Mock: config file exists with scanTimeout: 5000 - fsMock.existsSync.mock.mockImplementation(() => true); - fsMock.readFileSync.mock.mockImplementation(() => - JSON.stringify({ scanTimeout: 5000 }) - ); + setConfigContent(JSON.stringify({ scanTimeout: 5000 })); const timeout = getScanTimeout(); @@ -66,11 +70,7 @@ describe("getScanTimeout", () => { it("should prioritize environment variable over config file", () => { process.env.AIKIDO_SCAN_TIMEOUT_MS = "20000"; - // Mock: config file exists with scanTimeout: 5000 - fsMock.existsSync.mock.mockImplementation(() => true); - fsMock.readFileSync.mock.mockImplementation(() => - JSON.stringify({ scanTimeout: 5000 }) - ); + setConfigContent(JSON.stringify({ scanTimeout: 5000 })); const timeout = getScanTimeout(); @@ -79,11 +79,7 @@ describe("getScanTimeout", () => { it("should handle invalid environment variable and fall back to config", () => { process.env.AIKIDO_SCAN_TIMEOUT_MS = "invalid"; - // Mock: config file exists with scanTimeout: 7000 - fsMock.existsSync.mock.mockImplementation(() => true); - fsMock.readFileSync.mock.mockImplementation(() => - JSON.stringify({ scanTimeout: 7000 }) - ); + setConfigContent(JSON.stringify({ scanTimeout: 7000 })); const timeout = getScanTimeout(); @@ -91,9 +87,6 @@ describe("getScanTimeout", () => { }); it("should ignore zero and negative values and fall back to default", () => { - // Mock: config file doesn't exist - fsMock.existsSync.mock.mockImplementation(() => false); - process.env.AIKIDO_SCAN_TIMEOUT_MS = "0"; let timeout = getScanTimeout(); @@ -107,11 +100,7 @@ describe("getScanTimeout", () => { it("should ignore textual non-numeric values in environment variable and fall back to config", () => { process.env.AIKIDO_SCAN_TIMEOUT_MS = "fast"; - // Mock: config file exists with scanTimeout: 8000 - fsMock.existsSync.mock.mockImplementation(() => true); - fsMock.readFileSync.mock.mockImplementation(() => - JSON.stringify({ scanTimeout: 8000 }) - ); + setConfigContent(JSON.stringify({ scanTimeout: 8000 })); const timeout = getScanTimeout(); @@ -120,11 +109,7 @@ describe("getScanTimeout", () => { it("should ignore textual non-numeric values in config file and fall back to default", () => { delete process.env.AIKIDO_SCAN_TIMEOUT_MS; - // Mock: config file exists with scanTimeout: "slow" - fsMock.existsSync.mock.mockImplementation(() => true); - fsMock.readFileSync.mock.mockImplementation(() => - JSON.stringify({ scanTimeout: "slow" }) - ); + setConfigContent(JSON.stringify({ scanTimeout: "slow" })); const timeout = getScanTimeout(); @@ -133,11 +118,7 @@ describe("getScanTimeout", () => { it("should ignore textual non-numeric values in both env and config, fall back to default", () => { process.env.AIKIDO_SCAN_TIMEOUT_MS = "quick"; - // Mock: config file exists with scanTimeout: "medium" - fsMock.existsSync.mock.mockImplementation(() => true); - fsMock.readFileSync.mock.mockImplementation(() => - JSON.stringify({ scanTimeout: "medium" }) - ); + setConfigContent(JSON.stringify({ scanTimeout: "medium" })); const timeout = getScanTimeout(); @@ -146,11 +127,7 @@ describe("getScanTimeout", () => { it("should ignore mixed alphanumeric strings in environment variable", () => { process.env.AIKIDO_SCAN_TIMEOUT_MS = "5000ms"; - // Mock: config file exists with scanTimeout: 6000 - fsMock.existsSync.mock.mockImplementation(() => true); - fsMock.readFileSync.mock.mockImplementation(() => - JSON.stringify({ scanTimeout: 6000 }) - ); + setConfigContent(JSON.stringify({ scanTimeout: 6000 })); const timeout = getScanTimeout(); @@ -159,11 +136,7 @@ describe("getScanTimeout", () => { it("should ignore mixed alphanumeric strings in config file", () => { delete process.env.AIKIDO_SCAN_TIMEOUT_MS; - // Mock: config file exists with scanTimeout: "3000ms" - fsMock.existsSync.mock.mockImplementation(() => true); - fsMock.readFileSync.mock.mockImplementation(() => - JSON.stringify({ scanTimeout: "3000ms" }) - ); + setConfigContent(JSON.stringify({ scanTimeout: "3000ms" })); const timeout = getScanTimeout(); @@ -171,48 +144,21 @@ describe("getScanTimeout", () => { }); }); -describe("getMinimumPackageAgeHours", () => { - let fsMock; - let getMinimumPackageAgeHours; - - beforeEach(async () => { - // Mock fs module - fsMock = { - existsSync: mock.fn(() => false), - readFileSync: mock.fn(() => "{}"), - writeFileSync: mock.fn(), - mkdirSync: mock.fn(), - }; - - mock.module("fs", { - namedExports: fsMock, - }); - - // Re-import the module to get the mocked version - const configFileModule = await import( - `./configFile.js?update=${Date.now()}` - ); - getMinimumPackageAgeHours = configFileModule.getMinimumPackageAgeHours; - }); +describe("getMinimumPackageAgeHours", async () => { + const { getMinimumPackageAgeHours } = await import("./configFile.js"); afterEach(() => { - // Reset all mocks - mock.restoreAll(); + mockFiles.clear(); }); it("should return null when config file doesn't exist", () => { - fsMock.existsSync.mock.mockImplementation(() => false); - const hours = getMinimumPackageAgeHours(); assert.strictEqual(hours, undefined); }); it("should return null when config file exists but minimumPackageAgeHours is not set", () => { - fsMock.existsSync.mock.mockImplementation(() => true); - fsMock.readFileSync.mock.mockImplementation(() => - JSON.stringify({ scanTimeout: 5000 }) - ); + setConfigContent(JSON.stringify({ scanTimeout: 5000 })); const hours = getMinimumPackageAgeHours(); @@ -220,10 +166,7 @@ describe("getMinimumPackageAgeHours", () => { }); it("should return value from config file when set to valid number", () => { - fsMock.existsSync.mock.mockImplementation(() => true); - fsMock.readFileSync.mock.mockImplementation(() => - JSON.stringify({ minimumPackageAgeHours: 48 }) - ); + setConfigContent(JSON.stringify({ minimumPackageAgeHours: 48 })); const hours = getMinimumPackageAgeHours(); @@ -231,10 +174,7 @@ describe("getMinimumPackageAgeHours", () => { }); it("should handle string numbers in config file", () => { - fsMock.existsSync.mock.mockImplementation(() => true); - fsMock.readFileSync.mock.mockImplementation(() => - JSON.stringify({ minimumPackageAgeHours: "72" }) - ); + setConfigContent(JSON.stringify({ minimumPackageAgeHours: "72" })); const hours = getMinimumPackageAgeHours(); @@ -242,10 +182,7 @@ describe("getMinimumPackageAgeHours", () => { }); it("should handle decimal values", () => { - fsMock.existsSync.mock.mockImplementation(() => true); - fsMock.readFileSync.mock.mockImplementation(() => - JSON.stringify({ minimumPackageAgeHours: 1.5 }) - ); + setConfigContent(JSON.stringify({ minimumPackageAgeHours: 1.5 })); const hours = getMinimumPackageAgeHours(); @@ -253,21 +190,15 @@ describe("getMinimumPackageAgeHours", () => { }); it("should return null for non-numeric strings", () => { - fsMock.existsSync.mock.mockImplementation(() => true); - fsMock.readFileSync.mock.mockImplementation(() => - JSON.stringify({ minimumPackageAgeHours: "invalid" }) - ); + setConfigContent(JSON.stringify({ minimumPackageAgeHours: "invalid" })); const hours = getMinimumPackageAgeHours(); assert.strictEqual(hours, undefined); }); - it("should return null for values with units suffix", () => { - fsMock.existsSync.mock.mockImplementation(() => true); - fsMock.readFileSync.mock.mockImplementation(() => - JSON.stringify({ minimumPackageAgeHours: "48h" }) - ); + it("should return undefined for values with units suffix", () => { + setConfigContent(JSON.stringify({ minimumPackageAgeHours: "48h" })); const hours = getMinimumPackageAgeHours(); @@ -275,11 +206,175 @@ describe("getMinimumPackageAgeHours", () => { }); it("should handle malformed JSON and return null", () => { - fsMock.existsSync.mock.mockImplementation(() => true); - fsMock.readFileSync.mock.mockImplementation(() => "{ invalid json"); + setConfigContent("{ invalid json"); const hours = getMinimumPackageAgeHours(); assert.strictEqual(hours, undefined); }); + + it("should return 0 when minimumPackageAgeHours is set to 0", () => { + setConfigContent(JSON.stringify({ minimumPackageAgeHours: 0 })); + + const hours = getMinimumPackageAgeHours(); + + assert.strictEqual(hours, 0); + }); + + it("should return 0 when minimumPackageAgeHours is set to string '0'", () => { + setConfigContent(JSON.stringify({ minimumPackageAgeHours: "0" })); + + const hours = getMinimumPackageAgeHours(); + + assert.strictEqual(hours, 0); + }); + + it("should handle negative numeric values", () => { + setConfigContent(JSON.stringify({ minimumPackageAgeHours: -24 })); + + const hours = getMinimumPackageAgeHours(); + + assert.strictEqual(hours, -24); + }); + + it("should handle negative string values", () => { + setConfigContent(JSON.stringify({ minimumPackageAgeHours: "-48" })); + + const hours = getMinimumPackageAgeHours(); + + assert.strictEqual(hours, -48); + }); +}); + +const { getNpmCustomRegistries, getPipCustomRegistries } = await import( + "./configFile.js" +); + +for (const { packageManager, getCustomRegistries } of [ + { + packageManager: "npm", + getCustomRegistries: getNpmCustomRegistries, + }, + { + packageManager: "pip", + getCustomRegistries: getPipCustomRegistries, + }, +]) +{ + describe(getCustomRegistries.name, async () => { + afterEach(() => { + mockFiles.clear(); + }); + + it("should return empty array when config file doesn't exist", () => { + const registries = getCustomRegistries(); + + assert.deepStrictEqual(registries, []); + }); + + it(`should return empty array when ${packageManager} config is not set`, () => { + setConfigContent(JSON.stringify({ scanTimeout: 5000 })); + + const registries = getCustomRegistries(); + + assert.deepStrictEqual(registries, []); + }); + + it("should return empty array when customRegistries is not an array", () => { + setConfigContent(JSON.stringify({ + [packageManager]: { customRegistries: "not-an-array" }, + })); + + const registries = getCustomRegistries(); + + assert.deepStrictEqual(registries, []); + }); + + it("should return array of custom registries when set", () => { + setConfigContent(JSON.stringify({ + [packageManager]: { + customRegistries: [`${packageManager}.company.com`, "registry.internal.net"], + }, + })); + + const registries = getCustomRegistries(); + + assert.deepStrictEqual(registries, [ + `${packageManager}.company.com`, + "registry.internal.net", + ]); + }); + + it("should filter out non-string values", () => { + setConfigContent(JSON.stringify({ + [packageManager]: { + customRegistries: [ + `${packageManager}.company.com`, + 123, + null, + "registry.internal.net", + undefined, + {}, + ], + }, + })); + + const registries = getCustomRegistries(); + + assert.deepStrictEqual(registries, [ + `${packageManager}.company.com`, + "registry.internal.net", + ]); + }); + + it("should return empty array for empty customRegistries array", () => { + setConfigContent(JSON.stringify({ + [packageManager]: { customRegistries: [] }, + })); + + const registries = getCustomRegistries(); + + assert.deepStrictEqual(registries, []); + }); + + it("should handle malformed JSON and return empty array", () => { + setConfigContent("{ invalid json"); + + const registries = getCustomRegistries(); + + assert.deepStrictEqual(registries, []); + }); + }); +} + +describe("config file location fallback", async () => { + const { getScanTimeout } = await import("./configFile.js"); + + afterEach(() => { + mockFiles.clear(); + delete process.env.AIKIDO_SCAN_TIMEOUT_MS; + }); + + it("should read config from ~/.safe-chain/config.json when it exists", () => { + mockFiles.set(safeChainConfigPath, JSON.stringify({ scanTimeout: 3000 })); + + assert.strictEqual(getScanTimeout(), 3000); + }); + + it("should fall back to ~/.aikido/config.json when primary does not exist", () => { + mockFiles.set(aikidoConfigPath, JSON.stringify({ scanTimeout: 4000 })); + + assert.strictEqual(getScanTimeout(), 4000); + }); + + it("should prefer ~/.safe-chain/config.json when both exist", () => { + mockFiles.set(safeChainConfigPath, JSON.stringify({ scanTimeout: 3000 })); + mockFiles.set(aikidoConfigPath, JSON.stringify({ scanTimeout: 4000 })); + + assert.strictEqual(getScanTimeout(), 3000); + }); + + it("should return default when neither config file exists", () => { + assert.strictEqual(getScanTimeout(), 10000); + }); }); diff --git a/packages/safe-chain/src/config/environmentVariables.js b/packages/safe-chain/src/config/environmentVariables.js index 5c6056a..932eff7 100644 --- a/packages/safe-chain/src/config/environmentVariables.js +++ b/packages/safe-chain/src/config/environmentVariables.js @@ -5,3 +5,53 @@ export function getMinimumPackageAgeHours() { return process.env.SAFE_CHAIN_MINIMUM_PACKAGE_AGE_HOURS; } + +/** + * Gets the custom npm registries from environment variable + * Expected format: comma-separated list of registry domains + * Example: "npm.company.com,registry.internal.net" + * @returns {string | undefined} + */ +export function getNpmCustomRegistries() { + return process.env.SAFE_CHAIN_NPM_CUSTOM_REGISTRIES; +} + +/** + * Gets the custom pip registries from environment variable + * Expected format: comma-separated list of registry domains + * Example: "pip.company.com,registry.internal.net" + * @returns {string | undefined} + */ +export function getPipCustomRegistries() { + return process.env.SAFE_CHAIN_PIP_CUSTOM_REGISTRIES; +} + +/** + * Gets the logging level from environment variable + * Valid values: "silent", "normal", "verbose" + * @returns {string | undefined} + */ +export function getLoggingLevel() { + return process.env.SAFE_CHAIN_LOGGING; +} + +/** + * Gets the minimum package age exclusions from environment variable + * Expected format: comma-separated list of package names + * Example: "react,@aikidosec/safe-chain,lodash" + * @returns {string | undefined} + */ +export function getMinimumPackageAgeExclusions() { + return process.env.SAFE_CHAIN_MINIMUM_PACKAGE_AGE_EXCLUSIONS || + process.env.SAFE_CHAIN_NPM_MINIMUM_PACKAGE_AGE_EXCLUSIONS; +} + +/** + * Gets the malware list base URL from environment variable + * Expected format: full URL without trailing slash + * Example: "https://malware-list.aikido.dev" + * @returns {string | undefined} + */ +export function getMalwareListBaseUrl() { + return process.env.SAFE_CHAIN_MALWARE_LIST_BASE_URL; +} diff --git a/packages/safe-chain/src/config/safeChainDir.js b/packages/safe-chain/src/config/safeChainDir.js new file mode 100644 index 0000000..4d4f013 --- /dev/null +++ b/packages/safe-chain/src/config/safeChainDir.js @@ -0,0 +1,71 @@ +import os from "os"; +import path from "path"; +import { fileURLToPath } from "url"; +import { getInstalledSafeChainDir } from "../installLocation.js"; + +/** + * @returns {string} + */ +export function getSafeChainBaseDir() { + return getInstalledSafeChainDir() ?? path.join(os.homedir(), ".safe-chain"); +} + +/** + * @returns {string} + */ +export function getBinDir() { + return path.join(getSafeChainBaseDir(), "bin"); +} + +/** + * @returns {string} + */ +export function getShimsDir() { + return path.join(getSafeChainBaseDir(), "shims"); +} + +/** + * @returns {string} + */ +export function getScriptsDir() { + return path.join(getSafeChainBaseDir(), "scripts"); +} + +/** + * @returns {string} + */ +export function getCertsDir() { + return path.join(getSafeChainBaseDir(), "certs"); +} + +/** + * Resolves the directory of the calling module. + * Falls back to __dirname when import.meta.url is unavailable (pkg CJS binary). + * @param {string | undefined} moduleUrl + * @returns {string} + */ +function resolveModuleDir(moduleUrl) { + if (moduleUrl) { + return path.dirname(fileURLToPath(moduleUrl)); + } + // eslint-disable-next-line no-undef + return __dirname; +} + +/** + * @param {string | undefined} moduleUrl + * @param {string} fileName + * @returns {string} + */ +export function getStartupScriptSourcePath(moduleUrl, fileName) { + return path.join(resolveModuleDir(moduleUrl), "startup-scripts", fileName); +} + +/** + * @param {string | undefined} moduleUrl + * @param {string} fileName + * @returns {string} + */ +export function getPathWrapperTemplatePath(moduleUrl, fileName) { + return path.join(resolveModuleDir(moduleUrl), "path-wrappers", "templates", fileName); +} diff --git a/packages/safe-chain/src/config/settings.js b/packages/safe-chain/src/config/settings.js index 7c20358..d04411e 100644 --- a/packages/safe-chain/src/config/settings.js +++ b/packages/safe-chain/src/config/settings.js @@ -1,20 +1,27 @@ import * as cliArguments from "./cliArguments.js"; import * as configFile from "./configFile.js"; import * as environmentVariables from "./environmentVariables.js"; +import { ui } from "../environment/userInteraction.js"; export const LOGGING_SILENT = "silent"; export const LOGGING_NORMAL = "normal"; export const LOGGING_VERBOSE = "verbose"; export function getLoggingLevel() { - const level = cliArguments.getLoggingLevel(); - - if (level === LOGGING_SILENT) { - return LOGGING_SILENT; + // Priority 1: CLI argument + const cliLevel = cliArguments.getLoggingLevel(); + if (cliLevel === LOGGING_SILENT || cliLevel === LOGGING_VERBOSE) { + return cliLevel; + } + if (cliLevel) { + // CLI arg was set but invalid, default to normal for backwards compatibility. + return LOGGING_NORMAL; } - if (level === LOGGING_VERBOSE) { - return LOGGING_VERBOSE; + // Priority 2: Environment variable + const envLevel = environmentVariables.getLoggingLevel()?.toLowerCase(); + if (envLevel === LOGGING_SILENT || envLevel === LOGGING_VERBOSE) { + return envLevel; } return LOGGING_NORMAL; @@ -39,7 +46,7 @@ export function setEcoSystem(setting) { ecosystemSettings.ecoSystem = setting; } -const defaultMinimumPackageAge = 24; +const defaultMinimumPackageAge = 48; /** @returns {number} */ export function getMinimumPackageAgeHours() { // Priority 1: CLI argument @@ -81,7 +88,7 @@ function validateMinimumPackageAgeHours(value) { return undefined; } - if (numericValue > 0) { + if (numericValue >= 0) { return numericValue; } @@ -98,3 +105,143 @@ export function skipMinimumPackageAge() { return defaultSkipMinimumPackageAge; } + +/** + * Normalizes a registry URL by removing protocol if present + * @param {string} registry + * @returns {string} + */ +function normalizeRegistry(registry) { + // Remove protocol (http://, https://) if present + return registry.replace(/^https?:\/\//, ""); +} + +/** + * Parses comma-separated registries from environment variable + * @param {string | undefined} envValue + * @returns {string[]} + */ +function parseRegistriesFromEnv(envValue) { + if (!envValue || typeof envValue !== "string") { + return []; + } + + // Split by comma and trim whitespace + return envValue + .split(",") + .map((registry) => registry.trim()) + .filter((registry) => registry.length > 0); +} + +/** + * Gets the custom npm registries from both environment variable and config file (merged) + * @returns {string[]} + */ +export function getNpmCustomRegistries() { + const envRegistries = parseRegistriesFromEnv( + environmentVariables.getNpmCustomRegistries() + ); + const configRegistries = configFile.getNpmCustomRegistries(); + + // Merge both sources and remove duplicates + const allRegistries = [...envRegistries, ...configRegistries]; + const uniqueRegistries = [...new Set(allRegistries)]; + + // Normalize each registry (remove protocol if any) + return uniqueRegistries.map(normalizeRegistry); +} + +/** + * Gets the custom npm registries from both environment variable and config file (merged) + * @returns {string[]} + */ +export function getPipCustomRegistries() { + const envRegistries = parseRegistriesFromEnv( + environmentVariables.getPipCustomRegistries() + ); + const configRegistries = configFile.getPipCustomRegistries(); + + // Merge both sources and remove duplicates + const allRegistries = [...envRegistries, ...configRegistries]; + const uniqueRegistries = [...new Set(allRegistries)]; + + // Normalize each registry (remove protocol if any) + return uniqueRegistries.map(normalizeRegistry); +} + +/** + * Parses comma-separated exclusions from environment variable + * @param {string | undefined} envValue + * @returns {string[]} + */ +function parseExclusionsFromEnv(envValue) { + if (!envValue || typeof envValue !== "string") { + return []; + } + + return envValue + .split(",") + .map((exclusion) => exclusion.trim()) + .filter((exclusion) => exclusion.length > 0); +} + +/** + * Gets the minimum package age exclusions from both environment variable and config file (merged) + * @returns {string[]} + */ +export function getMinimumPackageAgeExclusions() { + const envExclusions = parseExclusionsFromEnv( + environmentVariables.getMinimumPackageAgeExclusions() + ); + const configExclusions = configFile.getMinimumPackageAgeExclusions(); + + // Merge both sources and remove duplicates + const allExclusions = [...envExclusions, ...configExclusions]; + return [...new Set(allExclusions)]; +} + +/** + * Gets the malware list base URL with priority: CLI argument > environment variable > config file > default + * @returns {string} + */ +export function getMalwareListBaseUrl() { + // Priority 1: CLI argument + const cliValue = cliArguments.getMalwareListBaseUrl(); + if (cliValue) { + const url = removeTrailingSlashes(cliValue); + ui.writeVerbose(`Fetching malware lists from ${url} as defined by CLI argument --safe-chain-malware-list-base-url`); + return url; + } + + // Priority 2: Environment variable + const envValue = environmentVariables.getMalwareListBaseUrl(); + if (envValue) { + const url = removeTrailingSlashes(envValue); + ui.writeVerbose(`Fetching malware lists from ${url} as defined by environment variable SAFE_CHAIN_MALWARE_LIST_BASE_URL`); + return url; + } + + // Priority 3: Config file + const configValue = configFile.getMalwareListBaseUrl(); + if (configValue) { + const url = removeTrailingSlashes(configValue); + ui.writeVerbose(`Fetching malware lists from ${url} as defined by config file (malwareListBaseUrl)`); + return url; + } + + // Default + return removeTrailingSlashes("https://malware-list.aikido.dev"); +} + +/** + * Removes trailing slashes from a URL-like string. + * @param {string} value + * @returns {string} + */ +function removeTrailingSlashes(value) { + if (!value || typeof value !== "string") { + return value; + } + + return value.replace(/\/+$/, ""); +} diff --git a/packages/safe-chain/src/config/settings.spec.js b/packages/safe-chain/src/config/settings.spec.js new file mode 100644 index 0000000..48108c4 --- /dev/null +++ b/packages/safe-chain/src/config/settings.spec.js @@ -0,0 +1,647 @@ +import { describe, it, beforeEach, afterEach, mock } from "node:test"; +import assert from "node:assert"; + +let configFileContent = undefined; +mock.module("fs", { + namedExports: { + existsSync: () => configFileContent !== undefined, + readFileSync: () => configFileContent, + writeFileSync: (content) => (configFileContent = content), + mkdirSync: () => {}, + }, +}); + +const { + getNpmCustomRegistries, + getPipCustomRegistries, + getMinimumPackageAgeExclusions, + getMalwareListBaseUrl, + setEcoSystem, + ECOSYSTEM_JS, + ECOSYSTEM_PY, + getLoggingLevel, + LOGGING_SILENT, + LOGGING_NORMAL, + LOGGING_VERBOSE, +} = await import("./settings.js"); +const { initializeCliArguments } = await import("./cliArguments.js"); + +for (const { packageManager, getCustomRegistries, envVarName } of [ + { + packageManager: "npm", + getCustomRegistries: getNpmCustomRegistries, + envVarName: "SAFE_CHAIN_NPM_CUSTOM_REGISTRIES", + }, + { + packageManager: "pip", + getCustomRegistries: getPipCustomRegistries, + envVarName: "SAFE_CHAIN_PIP_CUSTOM_REGISTRIES", + }, +]) { + describe(getCustomRegistries.name, async () => { + let originalEnv; + + beforeEach(() => { + originalEnv = process.env[envVarName]; + }); + + afterEach(() => { + if (originalEnv !== undefined) { + process.env[envVarName] = originalEnv; + } else { + delete process.env[envVarName]; + } + configFileContent = undefined; + }); + + it("should return empty array when no registries configured", () => { + configFileContent = undefined; + + const registries = getCustomRegistries(); + + assert.deepStrictEqual(registries, []); + }); + + it("should return registries without protocol", () => { + configFileContent = JSON.stringify({ + [packageManager]: { + customRegistries: [ + `${packageManager}.company.com`, + "registry.internal.net", + ], + }, + }); + + const registries = getCustomRegistries(); + + assert.deepStrictEqual(registries, [ + `${packageManager}.company.com`, + "registry.internal.net", + ]); + }); + + it("should strip https:// protocol from registries", () => { + configFileContent = JSON.stringify({ + [packageManager]: { + customRegistries: [ + `https://${packageManager}.company.com`, + "https://registry.internal.net", + ], + }, + }); + + const registries = getCustomRegistries(); + + assert.deepStrictEqual(registries, [ + `${packageManager}.company.com`, + "registry.internal.net", + ]); + }); + + it("should strip http:// protocol from registries", () => { + configFileContent = JSON.stringify({ + [packageManager]: { + customRegistries: [ + `http://${packageManager}.company.com`, + "http://registry.internal.net", + ], + }, + }); + + const registries = getCustomRegistries(); + + assert.deepStrictEqual(registries, [ + `${packageManager}.company.com`, + "registry.internal.net", + ]); + }); + + it("should handle mixed protocols and no protocol", () => { + configFileContent = JSON.stringify({ + [packageManager]: { + customRegistries: [ + `https://${packageManager}.company.com`, + "registry.internal.net", + "http://private.registry.io", + ], + }, + }); + + const registries = getCustomRegistries(); + + assert.deepStrictEqual(registries, [ + `${packageManager}.company.com`, + "registry.internal.net", + "private.registry.io", + ]); + }); + + it("should preserve registry path after stripping protocol", () => { + configFileContent = JSON.stringify({ + [packageManager]: { + customRegistries: [ + `https://${packageManager}.company.com/custom/path`, + `registry.internal.net/${packageManager}`, + ], + }, + }); + + const registries = getCustomRegistries(); + + assert.deepStrictEqual(registries, [ + `${packageManager}.company.com/custom/path`, + `registry.internal.net/${packageManager}`, + ]); + }); + + it("should parse comma-separated registries from environment variable", () => { + delete process.env[envVarName]; + process.env[envVarName] = "env1.registry.com,env2.registry.net"; + configFileContent = undefined; + + const registries = getCustomRegistries(); + + assert.deepStrictEqual(registries, [ + "env1.registry.com", + "env2.registry.net", + ]); + }); + + it("should trim whitespace from environment variable registries", () => { + delete process.env[envVarName]; + process.env[envVarName] = " env1.registry.com , env2.registry.net "; + configFileContent = undefined; + + const registries = getCustomRegistries(); + + assert.deepStrictEqual(registries, [ + "env1.registry.com", + "env2.registry.net", + ]); + }); + + it("should merge environment variable and config file registries", () => { + delete process.env[envVarName]; + process.env[envVarName] = "env1.registry.com"; + configFileContent = JSON.stringify({ + [packageManager]: { + customRegistries: ["config1.registry.net"], + }, + }); + + const registries = getCustomRegistries(); + + assert.deepStrictEqual(registries, [ + "env1.registry.com", + "config1.registry.net", + ]); + }); + + it("should remove duplicate registries when merging env and config", () => { + delete process.env[envVarName]; + process.env[ + envVarName + ] = `${packageManager}.company.com,env.registry.com`; + configFileContent = JSON.stringify({ + [packageManager]: { + customRegistries: [ + `${packageManager}.company.com`, + "config.registry.net", + ], + }, + }); + + const registries = getCustomRegistries(); + + assert.deepStrictEqual(registries, [ + `${packageManager}.company.com`, + "env.registry.com", + "config.registry.net", + ]); + }); + + it("should normalize protocols from environment variable registries", () => { + delete process.env[envVarName]; + process.env[envVarName] = + "https://env1.registry.com,http://env2.registry.net"; + configFileContent = undefined; + + const registries = getCustomRegistries(); + + assert.deepStrictEqual(registries, [ + "env1.registry.com", + "env2.registry.net", + ]); + }); + + it("should handle empty strings in comma-separated list", () => { + delete process.env[envVarName]; + process.env[envVarName] = "env1.registry.com,,env2.registry.net,"; + configFileContent = undefined; + + const registries = getCustomRegistries(); + + assert.deepStrictEqual(registries, [ + "env1.registry.com", + "env2.registry.net", + ]); + }); + + it("should handle single registry in environment variable", () => { + delete process.env[envVarName]; + process.env[envVarName] = "single.registry.com"; + configFileContent = undefined; + + const registries = getCustomRegistries(); + + assert.deepStrictEqual(registries, ["single.registry.com"]); + }); + + it("should return empty array for empty environment variable", () => { + delete process.env[envVarName]; + process.env[envVarName] = ""; + configFileContent = undefined; + + const registries = getCustomRegistries(); + + assert.deepStrictEqual(registries, []); + }); + + it("should return empty array for whitespace-only environment variable", () => { + delete process.env[envVarName]; + process.env[envVarName] = " , , "; + configFileContent = undefined; + + const registries = getCustomRegistries(); + + assert.deepStrictEqual(registries, []); + }); + }); +} + +describe("getLoggingLevel", () => { + let originalEnv; + + beforeEach(() => { + originalEnv = process.env.SAFE_CHAIN_LOGGING; + delete process.env.SAFE_CHAIN_LOGGING; + // Reset CLI arguments state + initializeCliArguments([]); + }); + + afterEach(() => { + if (originalEnv !== undefined) { + process.env.SAFE_CHAIN_LOGGING = originalEnv; + } else { + delete process.env.SAFE_CHAIN_LOGGING; + } + }); + + it("should return normal by default when nothing is configured", () => { + const level = getLoggingLevel(); + + assert.strictEqual(level, LOGGING_NORMAL); + }); + + it("should return silent from environment variable", () => { + process.env.SAFE_CHAIN_LOGGING = "silent"; + + const level = getLoggingLevel(); + + assert.strictEqual(level, LOGGING_SILENT); + }); + + it("should return verbose from environment variable", () => { + process.env.SAFE_CHAIN_LOGGING = "verbose"; + + const level = getLoggingLevel(); + + assert.strictEqual(level, LOGGING_VERBOSE); + }); + + it("should handle uppercase environment variable values", () => { + process.env.SAFE_CHAIN_LOGGING = "VERBOSE"; + + const level = getLoggingLevel(); + + assert.strictEqual(level, LOGGING_VERBOSE); + }); + + it("should handle mixed case environment variable values", () => { + process.env.SAFE_CHAIN_LOGGING = "Silent"; + + const level = getLoggingLevel(); + + assert.strictEqual(level, LOGGING_SILENT); + }); + + it("should return normal for invalid environment variable values", () => { + process.env.SAFE_CHAIN_LOGGING = "invalid"; + + const level = getLoggingLevel(); + + assert.strictEqual(level, LOGGING_NORMAL); + }); + + it("should prioritize CLI argument over environment variable", () => { + process.env.SAFE_CHAIN_LOGGING = "verbose"; + initializeCliArguments(["--safe-chain-logging=silent"]); + + const level = getLoggingLevel(); + + assert.strictEqual(level, LOGGING_SILENT); + }); + + it("should use environment variable when CLI argument is not set", () => { + process.env.SAFE_CHAIN_LOGGING = "silent"; + initializeCliArguments(["install", "express"]); + + const level = getLoggingLevel(); + + assert.strictEqual(level, LOGGING_SILENT); + }); + + it("should return normal when CLI argument is invalid (even if env var is valid)", () => { + process.env.SAFE_CHAIN_LOGGING = "verbose"; + initializeCliArguments(["--safe-chain-logging=invalid"]); + + const level = getLoggingLevel(); + + assert.strictEqual(level, LOGGING_NORMAL); + }); +}); + +describe("getMinimumPackageAgeExclusions", () => { + let originalEnv; + let originalLegacyEnv; + const envVarName = "SAFE_CHAIN_MINIMUM_PACKAGE_AGE_EXCLUSIONS"; + const legacyEnvVarName = "SAFE_CHAIN_NPM_MINIMUM_PACKAGE_AGE_EXCLUSIONS"; + + beforeEach(() => { + originalEnv = process.env[envVarName]; + originalLegacyEnv = process.env[legacyEnvVarName]; + delete process.env[envVarName]; + delete process.env[legacyEnvVarName]; + setEcoSystem(ECOSYSTEM_JS); + }); + + afterEach(() => { + if (originalEnv !== undefined) { + process.env[envVarName] = originalEnv; + } else { + delete process.env[envVarName]; + } + if (originalLegacyEnv !== undefined) { + process.env[legacyEnvVarName] = originalLegacyEnv; + } else { + delete process.env[legacyEnvVarName]; + } + configFileContent = undefined; + }); + + it("should return empty array when no exclusions configured", () => { + configFileContent = undefined; + + const exclusions = getMinimumPackageAgeExclusions(); + + assert.deepStrictEqual(exclusions, []); + }); + + it("should return exclusions from config file", () => { + configFileContent = JSON.stringify({ + npm: { + minimumPackageAgeExclusions: ["react", "@aikidosec/safe-chain"], + }, + }); + + const exclusions = getMinimumPackageAgeExclusions(); + + assert.deepStrictEqual(exclusions, ["react", "@aikidosec/safe-chain"]); + }); + + it("should parse comma-separated exclusions from environment variable", () => { + process.env[envVarName] = "lodash,express,@types/node"; + configFileContent = undefined; + + const exclusions = getMinimumPackageAgeExclusions(); + + assert.deepStrictEqual(exclusions, ["lodash", "express", "@types/node"]); + }); + + it("should merge environment variable and config file exclusions", () => { + process.env[envVarName] = "lodash"; + configFileContent = JSON.stringify({ + npm: { + minimumPackageAgeExclusions: ["react"], + }, + }); + + const exclusions = getMinimumPackageAgeExclusions(); + + assert.deepStrictEqual(exclusions, ["lodash", "react"]); + }); + + it("should remove duplicate exclusions when merging", () => { + process.env[envVarName] = "lodash,react"; + configFileContent = JSON.stringify({ + npm: { + minimumPackageAgeExclusions: ["react", "express"], + }, + }); + + const exclusions = getMinimumPackageAgeExclusions(); + + assert.deepStrictEqual(exclusions, ["lodash", "react", "express"]); + }); + + it("should trim whitespace from environment variable exclusions", () => { + process.env[envVarName] = " lodash , react "; + configFileContent = undefined; + + const exclusions = getMinimumPackageAgeExclusions(); + + assert.deepStrictEqual(exclusions, ["lodash", "react"]); + }); + + it("should handle scoped packages", () => { + configFileContent = JSON.stringify({ + npm: { + minimumPackageAgeExclusions: ["@babel/core", "@types/react"], + }, + }); + + const exclusions = getMinimumPackageAgeExclusions(); + + assert.deepStrictEqual(exclusions, ["@babel/core", "@types/react"]); + }); + + it("should handle empty strings in comma-separated list", () => { + process.env[envVarName] = "lodash,,react,"; + configFileContent = undefined; + + const exclusions = getMinimumPackageAgeExclusions(); + + assert.deepStrictEqual(exclusions, ["lodash", "react"]); + }); + + it("should return empty array for empty environment variable", () => { + process.env[envVarName] = ""; + configFileContent = undefined; + + const exclusions = getMinimumPackageAgeExclusions(); + + assert.deepStrictEqual(exclusions, []); + }); + + it("should return empty array for whitespace-only environment variable", () => { + process.env[envVarName] = " , , "; + configFileContent = undefined; + + const exclusions = getMinimumPackageAgeExclusions(); + + assert.deepStrictEqual(exclusions, []); + }); + + it("should filter non-string values from config file", () => { + configFileContent = JSON.stringify({ + npm: { + minimumPackageAgeExclusions: ["react", 123, null, "lodash", undefined], + }, + }); + + const exclusions = getMinimumPackageAgeExclusions(); + + assert.deepStrictEqual(exclusions, ["react", "lodash"]); + }); + + it("should fall back to the legacy npm environment variable", () => { + process.env[legacyEnvVarName] = "lodash,react"; + + const exclusions = getMinimumPackageAgeExclusions(); + + assert.deepStrictEqual(exclusions, ["lodash", "react"]); + }); + + it("should read exclusions from the python config when the current ecosystem is py", () => { + setEcoSystem(ECOSYSTEM_PY); + configFileContent = JSON.stringify({ + pip: { + minimumPackageAgeExclusions: ["requests", "urllib3"], + }, + }); + + const exclusions = getMinimumPackageAgeExclusions(); + + assert.deepStrictEqual(exclusions, ["requests", "urllib3"]); + }); +}); + +describe("getMalwareListBaseUrl", () => { + let originalEnv; + const envVarName = "SAFE_CHAIN_MALWARE_LIST_BASE_URL"; + + beforeEach(() => { + originalEnv = process.env[envVarName]; + delete process.env[envVarName]; + // Reset CLI arguments state + initializeCliArguments([]); + }); + + afterEach(() => { + if (originalEnv !== undefined) { + process.env[envVarName] = originalEnv; + } else { + delete process.env[envVarName]; + } + configFileContent = undefined; + }); + + it("should return default URL when nothing is configured", () => { + const url = getMalwareListBaseUrl(); + + assert.strictEqual(url, "https://malware-list.aikido.dev"); + }); + + it("should trim trailing slash from CLI argument", () => { + initializeCliArguments(["--safe-chain-malware-list-base-url=https://cli-mirror.com/"]); + + const url = getMalwareListBaseUrl(); + + assert.strictEqual(url, "https://cli-mirror.com"); + }); + + it("should trim trailing slash from environment variable", () => { + process.env[envVarName] = "https://env-mirror.com/"; + + const url = getMalwareListBaseUrl(); + + assert.strictEqual(url, "https://env-mirror.com"); + }); + + it("should trim trailing slash from config file value", () => { + configFileContent = JSON.stringify({ + malwareListBaseUrl: "https://config-mirror.com/", + }); + + const url = getMalwareListBaseUrl(); + + assert.strictEqual(url, "https://config-mirror.com"); + }); + + it("should return CLI argument value with highest priority", () => { + initializeCliArguments(["--safe-chain-malware-list-base-url=https://cli-mirror.com"]); + + const url = getMalwareListBaseUrl(); + + assert.strictEqual(url, "https://cli-mirror.com"); + }); + + it("should return environment variable value when no CLI argument", () => { + process.env[envVarName] = "https://env-mirror.com"; + + const url = getMalwareListBaseUrl(); + + assert.strictEqual(url, "https://env-mirror.com"); + }); + + it("should return config file value when no CLI or env", () => { + configFileContent = JSON.stringify({ + malwareListBaseUrl: "https://config-mirror.com", + }); + + const url = getMalwareListBaseUrl(); + + assert.strictEqual(url, "https://config-mirror.com"); + }); + + it("should prioritize CLI over environment variable", () => { + process.env[envVarName] = "https://env-mirror.com"; + initializeCliArguments(["--safe-chain-malware-list-base-url=https://cli-mirror.com"]); + + const url = getMalwareListBaseUrl(); + + assert.strictEqual(url, "https://cli-mirror.com"); + }); + + it("should prioritize environment variable over config file", () => { + process.env[envVarName] = "https://env-mirror.com"; + configFileContent = JSON.stringify({ + malwareListBaseUrl: "https://config-mirror.com", + }); + + const url = getMalwareListBaseUrl(); + + assert.strictEqual(url, "https://env-mirror.com"); + }); + + it("should prioritize CLI over config file", () => { + initializeCliArguments(["--safe-chain-malware-list-base-url=https://cli-mirror.com"]); + configFileContent = JSON.stringify({ + malwareListBaseUrl: "https://config-mirror.com", + }); + + const url = getMalwareListBaseUrl(); + + assert.strictEqual(url, "https://cli-mirror.com"); + }); +}); diff --git a/packages/safe-chain/src/installLocation.js b/packages/safe-chain/src/installLocation.js new file mode 100644 index 0000000..52125be --- /dev/null +++ b/packages/safe-chain/src/installLocation.js @@ -0,0 +1,42 @@ +import path from "path"; + +/** @type {NodeJS.Process & { pkg?: unknown }} */ +const processWithPkg = process; + +/** + * @param {string} executablePath + * @returns {string | undefined} + */ +export function deriveInstallDirFromExecutablePath(executablePath) { + if (!executablePath) { + return undefined; + } + + const pathLibrary = executablePath.includes("\\") ? path.win32 : path.posix; + const executableDir = pathLibrary.dirname(executablePath); + if (pathLibrary.basename(executableDir) !== "bin") { + return undefined; + } + + return pathLibrary.dirname(executableDir); +} + +/** + * Returns the install directory for a packaged safe-chain binary. + * Custom installation directories only apply to packaged binary installs. + * For npm/global/dev-script executions this intentionally returns undefined, + * which causes callers to fall back to the default ~/.safe-chain layout. + * + * @param {{ isPackaged?: boolean, executablePath?: string }} [options] + * @returns {string | undefined} + */ +export function getInstalledSafeChainDir(options = {}) { + const isPackaged = options.isPackaged ?? Boolean(processWithPkg.pkg); + if (!isPackaged) { + return undefined; + } + + return deriveInstallDirFromExecutablePath( + options.executablePath ?? process.execPath, + ); +} diff --git a/packages/safe-chain/src/installLocation.spec.js b/packages/safe-chain/src/installLocation.spec.js new file mode 100644 index 0000000..558a05f --- /dev/null +++ b/packages/safe-chain/src/installLocation.spec.js @@ -0,0 +1,51 @@ +import { describe, it } from "node:test"; +import assert from "node:assert"; +import { + deriveInstallDirFromExecutablePath, + getInstalledSafeChainDir, +} from "./installLocation.js"; + +describe("deriveInstallDirFromExecutablePath", () => { + it("derives the install dir from a Unix binary path", () => { + assert.strictEqual( + deriveInstallDirFromExecutablePath("/usr/local/.safe-chain/bin/safe-chain"), + "/usr/local/.safe-chain", + ); + }); + + it("derives the install dir from a Windows binary path", () => { + assert.strictEqual( + deriveInstallDirFromExecutablePath("C:\\ProgramData\\safe-chain\\bin\\safe-chain.exe"), + "C:\\ProgramData\\safe-chain", + ); + }); + + it("returns undefined when the executable is not inside a bin directory", () => { + assert.strictEqual( + deriveInstallDirFromExecutablePath("/usr/local/.safe-chain/safe-chain"), + undefined, + ); + }); +}); + +describe("getInstalledSafeChainDir", () => { + it("returns undefined for non-packaged executions", () => { + assert.strictEqual( + getInstalledSafeChainDir({ + isPackaged: false, + executablePath: "/usr/local/.safe-chain/bin/safe-chain", + }), + undefined, + ); + }); + + it("returns the install dir for packaged executions", () => { + assert.strictEqual( + getInstalledSafeChainDir({ + isPackaged: true, + executablePath: "/usr/local/.safe-chain/bin/safe-chain", + }), + "/usr/local/.safe-chain", + ); + }); +}); diff --git a/packages/safe-chain/src/main.js b/packages/safe-chain/src/main.js index c46fc61..74f8a25 100644 --- a/packages/safe-chain/src/main.js +++ b/packages/safe-chain/src/main.js @@ -13,6 +13,10 @@ import { getAuditStats } from "./scanning/audit/index.js"; * @returns {Promise} */ export async function main(args) { + if (isSafeChainVerify(args)) { + return 0; + } + process.on("SIGINT", handleProcessTermination); process.on("SIGTERM", handleProcessTermination); @@ -23,6 +27,7 @@ export async function main(args) { process.on("uncaughtException", (error) => { ui.writeError(`Safe-chain: Uncaught exception: ${error.message}`); ui.writeVerbose(`Stack trace: ${error.stack}`); + ui.writeBufferedLogsAndStopBuffering(); process.exit(1); }); @@ -31,6 +36,7 @@ export async function main(args) { if (reason instanceof Error) { ui.writeVerbose(`Stack trace: ${reason.stack}`); } + ui.writeBufferedLogsAndStopBuffering(); process.exit(1); }); @@ -58,30 +64,33 @@ export async function main(args) { // Write all buffered logs ui.writeBufferedLogsAndStopBuffering(); - if (!proxy.verifyNoMaliciousPackages()) { + if (proxy.hasBlockedMaliciousPackages()) { + return 1; + } + + if (proxy.hasBlockedMinimumAgeRequests()) { return 1; } const auditStats = getAuditStats(); if (auditStats.totalPackages > 0) { - ui.emptyLine(); - ui.writeInformation( + ui.writeVerbose( `${chalk.green("✔")} Safe-chain: Scanned ${ auditStats.totalPackages - } packages, no malware found.` + } packages, no malware found.`, ); } if (proxy.hasSuppressedVersions()) { ui.writeInformation( `${chalk.yellow( - "ℹ" - )} Safe-chain: Some package versions were suppressed due to minimum age requirement.` + "ℹ", + )} Safe-chain: Some package versions were suppressed during package metadata resolution due to minimum package age.`, ); ui.writeInformation( ` To disable this check, use: ${chalk.cyan( - "--safe-chain-skip-minimum-package-age" - )}` + "--safe-chain-skip-minimum-package-age", + )}`, ); } @@ -90,6 +99,7 @@ export async function main(args) { return packageManagerResult.status; } catch (/** @type any */ error) { ui.writeError("Failed to check for malicious packages:", error.message); + ui.writeBufferedLogsAndStopBuffering(); // Returning the exit code back to the caller allows the promise // to be awaited in the bin files and return the correct exit code @@ -102,3 +112,12 @@ export async function main(args) { function handleProcessTermination() { ui.writeBufferedLogsAndStopBuffering(); } + +/** @param {string[]} args */ +function isSafeChainVerify(args) { + const safeChainCheckCommand = "safe-chain-verify"; + if (args.length > 0 && args[0] === safeChainCheckCommand) { + ui.writeInformation("OK: Safe-chain works!"); + return true; + } +} diff --git a/packages/safe-chain/src/packagemanager/_shared/commandErrors.js b/packages/safe-chain/src/packagemanager/_shared/commandErrors.js new file mode 100644 index 0000000..bee68e4 --- /dev/null +++ b/packages/safe-chain/src/packagemanager/_shared/commandErrors.js @@ -0,0 +1,17 @@ +import { ui } from "../../environment/userInteraction.js"; + +/** + * Centralized logging for package-manager command launch failures. + * + * @param {any} error - Error thrown by safeSpawn while preparing/running the command. + * @param {string} command - Command name that failed to execute. + * @returns {{status: number}} + */ +export function reportCommandExecutionFailure(error, command) { + const message = typeof error?.message === "string" ? error.message : "Unknown error"; + ui.writeError(`Error executing command: ${message}`); + + ui.writeError(`Is '${command}' installed and available on your system?`); + + return { status: typeof error?.status === "number" ? error.status : 1 }; +} diff --git a/packages/safe-chain/src/packagemanager/_shared/commandErrors.spec.js b/packages/safe-chain/src/packagemanager/_shared/commandErrors.spec.js new file mode 100644 index 0000000..350228a --- /dev/null +++ b/packages/safe-chain/src/packagemanager/_shared/commandErrors.spec.js @@ -0,0 +1,59 @@ +import { describe, it, beforeEach, afterEach, mock } from "node:test"; +import assert from "node:assert"; + +describe("reportCommandExecutionFailure", () => { + let errorLines; + + beforeEach(async () => { + errorLines = []; + + mock.module("../../environment/userInteraction.js", { + namedExports: { + ui: { + writeError: (...args) => { + errorLines.push(args.join(" ")); + }, + }, + }, + }); + }); + + afterEach(() => { + mock.reset(); + }); + + it("reports command errors while preserving exit status", async () => { + const { reportCommandExecutionFailure } = await import("./commandErrors.js"); + + const result = reportCommandExecutionFailure( + { + status: 127, + message: "Command failed: command -v bun", + }, + "bun", + ); + + assert.deepStrictEqual(result, { status: 127 }); + assert.deepStrictEqual(errorLines, [ + "Error executing command: Command failed: command -v bun", + "Is 'bun' installed and available on your system?", + ]); + }); + + it("falls back to exit code 1 when status is missing", async () => { + const { reportCommandExecutionFailure } = await import("./commandErrors.js"); + + const result = reportCommandExecutionFailure( + { + message: "Network error", + }, + "npm", + ); + + assert.deepStrictEqual(result, { status: 1 }); + assert.deepStrictEqual(errorLines, [ + "Error executing command: Network error", + "Is 'npm' installed and available on your system?", + ]); + }); +}); diff --git a/packages/safe-chain/src/packagemanager/bun/createBunPackageManager.js b/packages/safe-chain/src/packagemanager/bun/createBunPackageManager.js index 037a512..a9279b9 100644 --- a/packages/safe-chain/src/packagemanager/bun/createBunPackageManager.js +++ b/packages/safe-chain/src/packagemanager/bun/createBunPackageManager.js @@ -1,6 +1,6 @@ -import { ui } from "../../environment/userInteraction.js"; import { safeSpawn } from "../../utils/safeSpawn.js"; import { mergeSafeChainProxyEnvironmentVariables } from "../../registryProxy/registryProxy.js"; +import { reportCommandExecutionFailure } from "../_shared/commandErrors.js"; /** * @returns {import("../currentPackageManager.js").PackageManager} @@ -43,11 +43,6 @@ async function runBunCommand(command, args) { }); return { status: result.status }; } catch (/** @type any */ error) { - if (error.status) { - return { status: error.status }; - } else { - ui.writeError("Error executing command:", error.message); - return { status: 1 }; - } + return reportCommandExecutionFailure(error, command); } } diff --git a/packages/safe-chain/src/packagemanager/currentPackageManager.js b/packages/safe-chain/src/packagemanager/currentPackageManager.js index c6f4484..bf91d88 100644 --- a/packages/safe-chain/src/packagemanager/currentPackageManager.js +++ b/packages/safe-chain/src/packagemanager/currentPackageManager.js @@ -11,6 +11,12 @@ import { import { createYarnPackageManager } from "./yarn/createPackageManager.js"; import { createPipPackageManager } from "./pip/createPackageManager.js"; import { createUvPackageManager } from "./uv/createUvPackageManager.js"; +import { createPoetryPackageManager } from "./poetry/createPoetryPackageManager.js"; +import { createPipXPackageManager } from "./pipx/createPipXPackageManager.js"; +import { createPdmPackageManager } from "./pdm/createPdmPackageManager.js"; +import { createRushPackageManager } from "./rush/createRushPackageManager.js"; +import { createRushxPackageManager } from "./rushx/createRushxPackageManager.js"; +import { createUvxPackageManager } from "./uvx/createUvxPackageManager.js"; /** * @type {{packageManagerName: PackageManager | null}} @@ -35,10 +41,11 @@ const state = { /** * @param {string} packageManagerName + * @param {{ tool: string, args: string[] }} [context] - Optional tool context for package managers like pip * * @return {PackageManager} */ -export function initializePackageManager(packageManagerName) { +export function initializePackageManager(packageManagerName, context) { if (packageManagerName === "npm") { state.packageManagerName = createNpmPackageManager(); } else if (packageManagerName === "npx") { @@ -54,9 +61,21 @@ export function initializePackageManager(packageManagerName) { } else if (packageManagerName === "bunx") { state.packageManagerName = createBunxPackageManager(); } else if (packageManagerName === "pip") { - state.packageManagerName = createPipPackageManager(); + state.packageManagerName = createPipPackageManager(context); } else if (packageManagerName === "uv") { state.packageManagerName = createUvPackageManager(); + } else if (packageManagerName === "uvx") { + state.packageManagerName = createUvxPackageManager(); + } else if (packageManagerName === "poetry") { + state.packageManagerName = createPoetryPackageManager(); + } else if (packageManagerName === "pipx") { + state.packageManagerName = createPipXPackageManager(); + } else if (packageManagerName === "pdm") { + state.packageManagerName = createPdmPackageManager(); + } else if (packageManagerName === "rush") { + state.packageManagerName = createRushPackageManager(); + } else if (packageManagerName === "rushx") { + state.packageManagerName = createRushxPackageManager(); } else { throw new Error("Unsupported package manager: " + packageManagerName); } diff --git a/packages/safe-chain/src/packagemanager/npm/runNpmCommand.js b/packages/safe-chain/src/packagemanager/npm/runNpmCommand.js index af57fad..2622afc 100644 --- a/packages/safe-chain/src/packagemanager/npm/runNpmCommand.js +++ b/packages/safe-chain/src/packagemanager/npm/runNpmCommand.js @@ -1,6 +1,6 @@ -import { ui } from "../../environment/userInteraction.js"; import { safeSpawn } from "../../utils/safeSpawn.js"; import { mergeSafeChainProxyEnvironmentVariables } from "../../registryProxy/registryProxy.js"; +import { reportCommandExecutionFailure } from "../_shared/commandErrors.js"; /** * @param {string[]} args @@ -15,11 +15,6 @@ export async function runNpm(args) { }); return { status: result.status }; } catch (/** @type any */ error) { - if (error.status) { - return { status: error.status }; - } else { - ui.writeError("Error executing command:", error.message); - return { status: 1 }; - } + return reportCommandExecutionFailure(error, "npm"); } } diff --git a/packages/safe-chain/src/packagemanager/npx/runNpxCommand.js b/packages/safe-chain/src/packagemanager/npx/runNpxCommand.js index 2501b79..7edbfd3 100644 --- a/packages/safe-chain/src/packagemanager/npx/runNpxCommand.js +++ b/packages/safe-chain/src/packagemanager/npx/runNpxCommand.js @@ -1,6 +1,6 @@ -import { ui } from "../../environment/userInteraction.js"; import { safeSpawn } from "../../utils/safeSpawn.js"; import { mergeSafeChainProxyEnvironmentVariables } from "../../registryProxy/registryProxy.js"; +import { reportCommandExecutionFailure } from "../_shared/commandErrors.js"; /** * @param {string[]} args @@ -15,11 +15,6 @@ export async function runNpx(args) { }); return { status: result.status }; } catch (/** @type any */ error) { - if (error.status) { - return { status: error.status }; - } else { - ui.writeError("Error executing command:", error.message); - return { status: 1 }; - } + return reportCommandExecutionFailure(error, "npx"); } } diff --git a/packages/safe-chain/src/packagemanager/pdm/createPdmPackageManager.js b/packages/safe-chain/src/packagemanager/pdm/createPdmPackageManager.js new file mode 100644 index 0000000..1649a89 --- /dev/null +++ b/packages/safe-chain/src/packagemanager/pdm/createPdmPackageManager.js @@ -0,0 +1,72 @@ +import { ui } from "../../environment/userInteraction.js"; +import { safeSpawn } from "../../utils/safeSpawn.js"; +import { mergeSafeChainProxyEnvironmentVariables } from "../../registryProxy/registryProxy.js"; +import { getCombinedCaBundlePath } from "../../registryProxy/certBundle.js"; +import { reportCommandExecutionFailure } from "../_shared/commandErrors.js"; + +/** + * @returns {import("../currentPackageManager.js").PackageManager} + */ +export function createPdmPackageManager() { + return { + runCommand: (args) => runPdmCommand(args), + + // MITM only approach for PDM + isSupportedCommand: () => false, + getDependencyUpdatesForCommand: () => [], + }; +} + +/** + * Sets CA bundle environment variables used by PDM and Python libraries. + * PDM uses httpx (via unearth) which respects SSL_CERT_FILE through Python's ssl module. + * + * @param {NodeJS.ProcessEnv} env - Environment object to modify + * @param {string} combinedCaPath - Path to the combined CA bundle + */ +function setPdmCaBundleEnvironmentVariables(env, combinedCaPath) { + // SSL_CERT_FILE: Used by Python SSL libraries and httpx (which PDM uses) + if (env.SSL_CERT_FILE) { + ui.writeWarning("Safe-chain: User defined SSL_CERT_FILE found in environment. It will be overwritten."); + } + env.SSL_CERT_FILE = combinedCaPath; + + // REQUESTS_CA_BUNDLE: Used by the requests library (PDM plugins may use it) + if (env.REQUESTS_CA_BUNDLE) { + ui.writeWarning("Safe-chain: User defined REQUESTS_CA_BUNDLE found in environment. It will be overwritten."); + } + env.REQUESTS_CA_BUNDLE = combinedCaPath; + + // PIP_CERT: PDM may use pip internally + if (env.PIP_CERT) { + ui.writeWarning("Safe-chain: User defined PIP_CERT found in environment. It will be overwritten."); + } + env.PIP_CERT = combinedCaPath; +} + +/** + * Runs a pdm command with safe-chain's certificate bundle and proxy configuration. + * + * PDM respects standard HTTP_PROXY/HTTPS_PROXY environment variables through + * httpx which it uses for package downloads. + * + * @param {string[]} args - Command line arguments to pass to pdm + * @returns {Promise<{status: number}>} Exit status of the pdm command + */ +async function runPdmCommand(args) { + try { + const env = mergeSafeChainProxyEnvironmentVariables(process.env); + + const combinedCaPath = getCombinedCaBundlePath(); + setPdmCaBundleEnvironmentVariables(env, combinedCaPath); + + const result = await safeSpawn("pdm", args, { + stdio: "inherit", + env, + }); + + return { status: result.status }; + } catch (/** @type any */ error) { + return reportCommandExecutionFailure(error, "pdm"); + } +} diff --git a/packages/safe-chain/src/packagemanager/pdm/createPdmPackageManager.spec.js b/packages/safe-chain/src/packagemanager/pdm/createPdmPackageManager.spec.js new file mode 100644 index 0000000..2b2266b --- /dev/null +++ b/packages/safe-chain/src/packagemanager/pdm/createPdmPackageManager.spec.js @@ -0,0 +1,14 @@ +import { test } from "node:test"; +import assert from "node:assert"; +import { createPdmPackageManager } from "./createPdmPackageManager.js"; + +test("createPdmPackageManager", async (t) => { + await t.test("should create package manager with required interface", () => { + const pm = createPdmPackageManager(); + + assert.ok(pm); + assert.strictEqual(typeof pm.runCommand, "function"); + assert.strictEqual(typeof pm.isSupportedCommand, "function"); + assert.strictEqual(typeof pm.getDependencyUpdatesForCommand, "function"); + }); +}); diff --git a/packages/safe-chain/src/packagemanager/pip/createPackageManager.js b/packages/safe-chain/src/packagemanager/pip/createPackageManager.js index 6ec5d1a..bd78605 100644 --- a/packages/safe-chain/src/packagemanager/pip/createPackageManager.js +++ b/packages/safe-chain/src/packagemanager/pip/createPackageManager.js @@ -1,17 +1,21 @@ import { runPip } from "./runPipCommand.js"; -import { getCurrentPipInvocation } from "./pipSettings.js"; +import { PIP_COMMAND } from "./pipSettings.js"; + /** + * @param {{ tool: string, args: string[] }} [context] - Optional context with tool name and args * @returns {import("../currentPackageManager.js").PackageManager} */ -export function createPipPackageManager() { +export function createPipPackageManager(context) { + const tool = context?.tool || PIP_COMMAND; + return { /** * @param {string[]} args */ runCommand: (args) => { - const invocation = getCurrentPipInvocation(); - const fullArgs = [...invocation.args, ...args]; - return runPip(invocation.command, fullArgs); + // Args from main.js are already stripped of --safe-chain-* flags + // We just pass the tool (e.g. "python3") and the args (e.g. ["-m", "pip", "install", ...]) + return runPip(tool, args); }, // For pip, rely solely on MITM proxy to detect/deny downloads from known registries. isSupportedCommand: () => false, diff --git a/packages/safe-chain/src/packagemanager/pip/pipSettings.js b/packages/safe-chain/src/packagemanager/pip/pipSettings.js index 0316b77..1ef6720 100644 --- a/packages/safe-chain/src/packagemanager/pip/pipSettings.js +++ b/packages/safe-chain/src/packagemanager/pip/pipSettings.js @@ -1,30 +1,6 @@ export const PIP_PACKAGE_MANAGER = "pip"; -// All supported python/pip invocations for Safe Chain interception -export const PIP_INVOCATIONS = { - PIP: { command: "pip", args: [] }, - PIP3: { command: "pip3", args: [] }, - PY_PIP: { command: "python", args: ["-m", "pip"] }, - PY3_PIP: { command: "python3", args: ["-m", "pip"] }, - PY_PIP3: { command: "python", args: ["-m", "pip3"] }, - PY3_PIP3: { command: "python3", args: ["-m", "pip3"] } -}; - -/** - * @type {{ command: string, args: string[] }} - */ -let currentInvocation = PIP_INVOCATIONS.PY3_PIP; // Default to python3 -m pip - -/** - * @param {{ command: string, args: string[] }} invocation - */ -export function setCurrentPipInvocation(invocation) { - currentInvocation = invocation; -} - -/** - * @returns {{ command: string, args: string[] }} - */ -export function getCurrentPipInvocation() { - return currentInvocation; -} +export const PIP_COMMAND = "pip"; +export const PIP3_COMMAND = "pip3"; +export const PYTHON_COMMAND = "python"; +export const PYTHON3_COMMAND = "python3"; diff --git a/packages/safe-chain/src/packagemanager/pip/runPipCommand.js b/packages/safe-chain/src/packagemanager/pip/runPipCommand.js index 23485ff..4f4e401 100644 --- a/packages/safe-chain/src/packagemanager/pip/runPipCommand.js +++ b/packages/safe-chain/src/packagemanager/pip/runPipCommand.js @@ -2,11 +2,32 @@ import { ui } from "../../environment/userInteraction.js"; import { safeSpawn } from "../../utils/safeSpawn.js"; import { mergeSafeChainProxyEnvironmentVariables } from "../../registryProxy/registryProxy.js"; import { getCombinedCaBundlePath } from "../../registryProxy/certBundle.js"; +import { PIP_COMMAND, PIP3_COMMAND, PYTHON_COMMAND, PYTHON3_COMMAND } from "./pipSettings.js"; import fs from "node:fs/promises"; import fsSync from "node:fs"; import os from "node:os"; import path from "node:path"; import ini from "ini"; +import { spawn } from "child_process"; +import { reportCommandExecutionFailure } from "../_shared/commandErrors.js"; + +/** + * Checks if this pip invocation should bypass safe-chain and spawn directly. + * Returns true if the tool is python/python3 but NOT being run with -m pip/pip3. + * @param {string} command - The command executable + * @param {string[]} args - The arguments + * @returns {boolean} + */ +export function shouldBypassSafeChain(command, args) { + if (command === PYTHON_COMMAND || command === PYTHON3_COMMAND) { + // Check if args start with -m pip + if (args.length >= 2 && args[0] === "-m" && (args[1] === PIP_COMMAND || args[1] === PIP3_COMMAND)) { + return false; + } + return true; + } + return false; +} /** * Sets fallback CA bundle environment variables used by Python libraries. @@ -46,19 +67,47 @@ function setFallbackCaBundleEnvironmentVariables(env, combinedCaPath) { * If the user has an existing PIP_CONFIG_FILE, a new temporary config is created that merges * their settings with safe-chain's, leaving the original file unchanged. * - * @param {string} command - The pip command to execute (e.g., 'pip3') + * Special handling for commands that modify config/cache/state: PIP_CONFIG_FILE is NOT overridden to allow + * users to read/write persistent config. Only CA environment variables are set for these commands. + * + * @param {string} command - The pip command executable (e.g., 'pip3' or 'python3') * @param {string[]} args - Command line arguments to pass to pip * @returns {Promise<{status: number}>} Exit status of the pip command */ export async function runPip(command, args) { + // Check if we should bypass safe-chain (python/python3 without -m pip) + if (shouldBypassSafeChain(command, args)) { + ui.writeVerbose(`Safe-chain: Bypassing safe-chain for non-pip invocation: ${command} ${args.join(" ")}`); + // Spawn the ORIGINAL command with ORIGINAL args + return new Promise((_resolve) => { + const proc = spawn(command, args, { stdio: "inherit" }); + proc.on("exit", (/** @type {number | null} */ code) => { + ui.writeVerbose(`${command} ${args.join(" ")} exited with status ${code}`); + ui.writeBufferedLogsAndStopBuffering(); + process.exit(code ?? 0); + }); + proc.on("error", (/** @type {Error} */ err) => { + ui.writeError(`Error executing command: ${err.message}`); + ui.writeBufferedLogsAndStopBuffering(); + process.exit(1); + }); + }); + } + try { const env = mergeSafeChainProxyEnvironmentVariables(process.env); - // Always provide Python with a complete CA bundle (Safe Chain CA + Mozilla + Node built-in roots) + // Always provide Python with a complete CA bundle (Safe Chain CA + Mozilla + Node built-in roots + user certs) // so that any network request made by pip, including those outside explicit CLI args, // validates correctly under both MITM'd and tunneled HTTPS. const combinedCaPath = getCombinedCaBundlePath(); + // Commands that need access to persistent config/cache/state files + // These should not have PIP_CONFIG_FILE overridden as it would prevent them from + // reading/writing to the user's actual pip configuration and cache directories + const configRelatedCommands = ['config', 'cache', 'debug', 'completion']; + const isConfigRelatedCommand = args.length > 0 && configRelatedCommands.includes(args[0]); + // https://pip.pypa.io/en/stable/topics/https-certificates/ explains that the 'cert' param (which we're providing via INI file) // will tell pip to use the provided CA bundle for HTTPS verification. @@ -70,6 +119,22 @@ export async function runPip(command, args) { const pipConfigPath = path.join(tmpDir, `safe-chain-pip-${Date.now()}.ini`); let cleanupConfigPath = null; // Track temp file for cleanup + if (isConfigRelatedCommand) { + ui.writeVerbose(`Safe-chain: Skipping PIP_CONFIG_FILE override for 'pip ${args[0]}' command to allow persistent config/cache access.`); + + // Still set the fallback CA bundle environment variables to avoid edge cases where a + // plugin or extension triggers a network call during config introspection + // This can do no harm + setFallbackCaBundleEnvironmentVariables(env, combinedCaPath); + + const result = await safeSpawn(command, args, { + stdio: "inherit", + env, + }); + + return { status: result.status }; + } + // Note: Setting PIP_CONFIG_FILE overrides all pip config levels (Global/User/Site) per pip's loading order if (!env.PIP_CONFIG_FILE) { /** @type {{ global: { cert: string, proxy?: string } }} */ @@ -139,12 +204,6 @@ export async function runPip(command, args) { return { status: result.status }; } catch (/** @type any */ error) { - if (error.status) { - return { status: error.status }; - } else { - ui.writeError(`Error executing command: ${error.message}`); - ui.writeError(`Is '${command}' installed and available on your system?`); - return { status: 1 }; - } + return reportCommandExecutionFailure(error, command); } } diff --git a/packages/safe-chain/src/packagemanager/pip/runPipCommand.spec.js b/packages/safe-chain/src/packagemanager/pip/runPipCommand.spec.js index d0df961..0707333 100644 --- a/packages/safe-chain/src/packagemanager/pip/runPipCommand.spec.js +++ b/packages/safe-chain/src/packagemanager/pip/runPipCommand.spec.js @@ -7,6 +7,7 @@ import ini from "ini"; describe("runPipCommand environment variable handling", () => { let runPip; + let shouldBypassSafeChain; let capturedArgs = null; let customEnv = null; let capturedConfigContent = null; // Capture config file content before cleanup @@ -56,12 +57,110 @@ describe("runPipCommand environment variable handling", () => { const mod = await import("./runPipCommand.js"); runPip = mod.runPip; + shouldBypassSafeChain = mod.shouldBypassSafeChain; }); afterEach(() => { mock.reset(); }); + it("should NOT set PIP_CONFIG_FILE for 'pip config' commands to allow persistent config access", async () => { + const res = await runPip("pip3", ["config", "set", "global.index-url", "https://test.pypi.org/simple"]); + assert.strictEqual(res.status, 0); + assert.ok(capturedArgs, "safeSpawn should have been called"); + + // PIP_CONFIG_FILE should NOT be set for config commands + assert.strictEqual( + capturedArgs.options.env.PIP_CONFIG_FILE, + undefined, + "PIP_CONFIG_FILE should NOT be set for pip config commands" + ); + + // But CA environment variables should still be set + assert.strictEqual( + capturedArgs.options.env.REQUESTS_CA_BUNDLE, + "/tmp/test-combined-ca.pem", + "REQUESTS_CA_BUNDLE should still be set" + ); + assert.strictEqual( + capturedArgs.options.env.SSL_CERT_FILE, + "/tmp/test-combined-ca.pem", + "SSL_CERT_FILE should still be set" + ); + assert.strictEqual( + capturedArgs.options.env.PIP_CERT, + "/tmp/test-combined-ca.pem", + "PIP_CERT should still be set" + ); + }); + + it("should NOT set PIP_CONFIG_FILE for 'pip config get' commands", async () => { + const res = await runPip("pip3", ["config", "get", "global.index-url"]); + assert.strictEqual(res.status, 0); + assert.ok(capturedArgs, "safeSpawn should have been called"); + + assert.strictEqual( + capturedArgs.options.env.PIP_CONFIG_FILE, + undefined, + "PIP_CONFIG_FILE should NOT be set for pip config get" + ); + }); + + it("should NOT set PIP_CONFIG_FILE for 'pip config list' commands", async () => { + const res = await runPip("pip3", ["config", "list"]); + assert.strictEqual(res.status, 0); + assert.ok(capturedArgs, "safeSpawn should have been called"); + + assert.strictEqual( + capturedArgs.options.env.PIP_CONFIG_FILE, + undefined, + "PIP_CONFIG_FILE should NOT be set for pip config list" + ); + }); + + it("should NOT set PIP_CONFIG_FILE for 'pip cache' commands", async () => { + const res = await runPip("pip3", ["cache", "dir"]); + assert.strictEqual(res.status, 0); + assert.ok(capturedArgs, "safeSpawn should have been called"); + + assert.strictEqual( + capturedArgs.options.env.PIP_CONFIG_FILE, + undefined, + "PIP_CONFIG_FILE should NOT be set for pip cache commands" + ); + + // CA env vars should still be set + assert.strictEqual( + capturedArgs.options.env.SSL_CERT_FILE, + "/tmp/test-combined-ca.pem", + "SSL_CERT_FILE should still be set" + ); + }); + + it("should NOT set PIP_CONFIG_FILE for 'pip debug' commands", async () => { + const res = await runPip("pip3", ["debug"]); + assert.strictEqual(res.status, 0); + assert.ok(capturedArgs, "safeSpawn should have been called"); + + assert.strictEqual( + capturedArgs.options.env.PIP_CONFIG_FILE, + undefined, + "PIP_CONFIG_FILE should NOT be set for pip debug" + ); + }); + + it("should NOT set PIP_CONFIG_FILE for 'pip completion' commands", async () => { + const res = await runPip("pip3", ["completion", "--bash"]); + assert.strictEqual(res.status, 0); + assert.ok(capturedArgs, "safeSpawn should have been called"); + + assert.strictEqual( + capturedArgs.options.env.PIP_CONFIG_FILE, + undefined, + "PIP_CONFIG_FILE should NOT be set for pip completion" + ); + }); + it("should set PIP_CERT env var and create config file", async () => { const res = await runPip("pip3", ["install", "requests"]); assert.strictEqual(res.status, 0); @@ -84,7 +183,7 @@ describe("runPipCommand environment variable handling", () => { assert.strictEqual(res.status, 0); assert.ok(capturedArgs, "safeSpawn should have been called"); - + // Check environment variables are set assert.strictEqual( capturedArgs.options.env.REQUESTS_CA_BUNDLE, @@ -121,7 +220,7 @@ describe("runPipCommand environment variable handling", () => { // For default PyPI, we still set env vars; pip CLI --cert takes precedence const res = await runPip("pip3", ["install", "requests"]); assert.strictEqual(res.status, 0); - + // Environment variables still set (pip CLI --cert takes precedence) assert.strictEqual( capturedArgs.options.env.REQUESTS_CA_BUNDLE, @@ -136,7 +235,7 @@ describe("runPipCommand environment variable handling", () => { it("should preserve HTTPS_PROXY from proxy merge", async () => { const res = await runPip("pip3", ["install", "requests"]); assert.strictEqual(res.status, 0); - + assert.strictEqual( capturedArgs.options.env.HTTPS_PROXY, "http://localhost:8080", @@ -283,7 +382,7 @@ describe("runPipCommand environment variable handling", () => { await fs.writeFile(cfgPath, initialIni, "utf-8"); customEnv = { PIP_CONFIG_FILE: cfgPath }; - + // Capture stdout/stderr let output = ""; const originalWrite = process.stdout.write; @@ -300,4 +399,21 @@ describe("runPipCommand environment variable handling", () => { assert.ok(output.includes("proxy found in PIP_CONFIG_FILE"), "Should warn about proxy overwrite in output"); customEnv = null; }); + + it("should bypass safe-chain for python correctly", async () => { + assert.strictEqual(shouldBypassSafeChain("python", []), true); + assert.strictEqual(shouldBypassSafeChain("python3", []), true); + + assert.strictEqual(shouldBypassSafeChain("python", ["--version"]), true); + assert.strictEqual(shouldBypassSafeChain("python3", ["--version"]), true); + + assert.strictEqual(shouldBypassSafeChain("python", ["-m", "http.server"]), true); + assert.strictEqual(shouldBypassSafeChain("python3", ["-m", "http.server"]), true); + + assert.strictEqual(shouldBypassSafeChain("python", ["-m", "pip"]), false); + assert.strictEqual(shouldBypassSafeChain("python3", ["-m", "pip"]), false); + assert.strictEqual(shouldBypassSafeChain("python", ["-m", "pip3"]), false); + assert.strictEqual(shouldBypassSafeChain("python3", ["-m", "pip3"]), false); + }); + }); diff --git a/packages/safe-chain/src/packagemanager/pipx/createPipXPackageManager.js b/packages/safe-chain/src/packagemanager/pipx/createPipXPackageManager.js new file mode 100644 index 0000000..cc536f8 --- /dev/null +++ b/packages/safe-chain/src/packagemanager/pipx/createPipXPackageManager.js @@ -0,0 +1,18 @@ +import { runPipX } from "./runPipXCommand.js"; + +/** + * @returns {import("../currentPackageManager.js").PackageManager} + */ +export function createPipXPackageManager() { + return { + /** + * @param {string[]} args + */ + runCommand: (args) => { + return runPipX("pipx", args); + }, + // MITM only + isSupportedCommand: () => false, + getDependencyUpdatesForCommand: () => [], + }; +} diff --git a/packages/safe-chain/src/packagemanager/pipx/createPipXPackageManager.spec.js b/packages/safe-chain/src/packagemanager/pipx/createPipXPackageManager.spec.js new file mode 100644 index 0000000..1932384 --- /dev/null +++ b/packages/safe-chain/src/packagemanager/pipx/createPipXPackageManager.spec.js @@ -0,0 +1,14 @@ +import { test } from "node:test"; +import assert from "node:assert"; +import { createPipXPackageManager } from "./createPipXPackageManager.js"; + +test("createPipXPackageManager", async (t) => { + await t.test("should create package manager with required interface", () => { + const pm = createPipXPackageManager(); + + assert.ok(pm); + assert.strictEqual(typeof pm.runCommand, "function"); + assert.strictEqual(typeof pm.isSupportedCommand, "function"); + assert.strictEqual(typeof pm.getDependencyUpdatesForCommand, "function"); + }); +}); diff --git a/packages/safe-chain/src/packagemanager/pipx/runPipXCommand.js b/packages/safe-chain/src/packagemanager/pipx/runPipXCommand.js new file mode 100644 index 0000000..c374e2a --- /dev/null +++ b/packages/safe-chain/src/packagemanager/pipx/runPipXCommand.js @@ -0,0 +1,60 @@ +import { ui } from "../../environment/userInteraction.js"; +import { safeSpawn } from "../../utils/safeSpawn.js"; +import { mergeSafeChainProxyEnvironmentVariables } from "../../registryProxy/registryProxy.js"; +import { getCombinedCaBundlePath } from "../../registryProxy/certBundle.js"; +import { reportCommandExecutionFailure } from "../_shared/commandErrors.js"; + +/** + * Sets CA bundle environment variables used by Python libraries and pipx. + * + * @param {NodeJS.ProcessEnv} env - Env object + * @param {string} combinedCaPath - Path to the combined CA bundle + * @return {NodeJS.ProcessEnv} Modified environment object + */ +function getPipXCaBundleEnvironmentVariables(env, combinedCaPath) { + let retVal = { ...env }; + + if (env.SSL_CERT_FILE) { + ui.writeWarning("Safe-chain: User defined SSL_CERT_FILE found in environment. It will be overwritten."); + } + retVal.SSL_CERT_FILE = combinedCaPath; + + if (env.REQUESTS_CA_BUNDLE) { + ui.writeWarning("Safe-chain: User defined REQUESTS_CA_BUNDLE found in environment. It will be overwritten."); + } + retVal.REQUESTS_CA_BUNDLE = combinedCaPath; + + if (env.PIP_CERT) { + ui.writeWarning("Safe-chain: User defined PIP_CERT found in environment. It will be overwritten."); + } + retVal.PIP_CERT = combinedCaPath; + return retVal; +} + +/** + * Runs a pipx command with safe-chain's certificate bundle and proxy configuration. + * + * @param {string} command - The command to execute + * @param {string[]} args - Command line arguments + * @returns {Promise<{status: number}>} Exit status of the command + */ +export async function runPipX(command, args) { + try { + const env = mergeSafeChainProxyEnvironmentVariables(process.env); + + const combinedCaPath = getCombinedCaBundlePath(); + const modifiedEnv = getPipXCaBundleEnvironmentVariables(env, combinedCaPath); + + // Note: pipx uses HTTPS_PROXY and HTTP_PROXY environment variables for proxy configuration + // These are already set by mergeSafeChainProxyEnvironmentVariables + + const result = await safeSpawn(command, args, { + stdio: "inherit", + env: modifiedEnv, + }); + + return { status: result.status }; + } catch (/** @type any */ error) { + return reportCommandExecutionFailure(error, command); + } +} diff --git a/packages/safe-chain/src/packagemanager/pipx/runPipXCommand.spec.js b/packages/safe-chain/src/packagemanager/pipx/runPipXCommand.spec.js new file mode 100644 index 0000000..dd04dc2 --- /dev/null +++ b/packages/safe-chain/src/packagemanager/pipx/runPipXCommand.spec.js @@ -0,0 +1,80 @@ +import { describe, it, beforeEach, afterEach, mock } from "node:test"; +import assert from "node:assert"; + +describe("runPipXCommand", () => { + let runPipX; + let safeSpawnMock; + let warnMock; + let errorMock; + let mergeCalls; + let mergedEnvReturn; + + beforeEach(async () => { + mergeCalls = []; + mergedEnvReturn = { + HTTPS_PROXY: "http://localhost:8080", + HTTP_PROXY: "", + }; + + safeSpawnMock = mock.fn(async () => ({ status: 0 })); + warnMock = mock.fn(); + errorMock = mock.fn(); + + mock.module("../../environment/userInteraction.js", { + namedExports: { + ui: { + writeWarning: warnMock, + writeError: errorMock, + writeInfo: () => {}, + writeVerbose: () => {}, + writeSuccess: () => {}, + }, + }, + }); + + mock.module("../../registryProxy/registryProxy.js", { + namedExports: { + mergeSafeChainProxyEnvironmentVariables: (env) => { + mergeCalls.push(env); + return { ...env, ...mergedEnvReturn }; + }, + }, + }); + + mock.module("../../registryProxy/certBundle.js", { + namedExports: { + getCombinedCaBundlePath: () => "/tmp/test-combined-ca.pem", + }, + }); + + mock.module("../../utils/safeSpawn.js", { + namedExports: { + safeSpawn: safeSpawnMock, + }, + }); + + const mod = await import("./runPipXCommand.js"); + runPipX = mod.runPipX; + }); + + afterEach(() => { + mock.reset(); + }); + + it("sets CA env vars and proxies before spawning", async () => { + const res = await runPipX("pipx", ["install", "ruff"]); + + assert.strictEqual(res.status, 0); + assert.strictEqual(safeSpawnMock.mock.calls.length, 1, "safeSpawn should be called once"); + + const [, , options] = safeSpawnMock.mock.calls[0].arguments; + const env = options.env; + + assert.strictEqual(env.SSL_CERT_FILE, "/tmp/test-combined-ca.pem"); + assert.strictEqual(env.REQUESTS_CA_BUNDLE, "/tmp/test-combined-ca.pem"); + assert.strictEqual(env.PIP_CERT, "/tmp/test-combined-ca.pem"); + assert.strictEqual(env.HTTPS_PROXY, "http://localhost:8080"); + assert.strictEqual(env.HTTP_PROXY, ""); + assert.ok(mergeCalls.length >= 1, "proxy merge should be invoked"); + }); +}); diff --git a/packages/safe-chain/src/packagemanager/pnpm/runPnpmCommand.js b/packages/safe-chain/src/packagemanager/pnpm/runPnpmCommand.js index d958fb8..3b90422 100644 --- a/packages/safe-chain/src/packagemanager/pnpm/runPnpmCommand.js +++ b/packages/safe-chain/src/packagemanager/pnpm/runPnpmCommand.js @@ -1,6 +1,6 @@ -import { ui } from "../../environment/userInteraction.js"; import { mergeSafeChainProxyEnvironmentVariables } from "../../registryProxy/registryProxy.js"; import { safeSpawn } from "../../utils/safeSpawn.js"; +import { reportCommandExecutionFailure } from "../_shared/commandErrors.js"; /** * @param {string[]} args @@ -26,11 +26,7 @@ export async function runPnpmCommand(args, toolName = "pnpm") { return { status: result.status }; } catch (/** @type any */ error) { - if (error.status) { - return { status: error.status }; - } else { - ui.writeError("Error executing command:", error.message); - return { status: 1 }; - } + const target = toolName === "pnpm" ? "pnpm" : "pnpx"; + return reportCommandExecutionFailure(error, target); } } diff --git a/packages/safe-chain/src/packagemanager/poetry/createPoetryPackageManager.js b/packages/safe-chain/src/packagemanager/poetry/createPoetryPackageManager.js new file mode 100644 index 0000000..567fb43 --- /dev/null +++ b/packages/safe-chain/src/packagemanager/poetry/createPoetryPackageManager.js @@ -0,0 +1,72 @@ +import { ui } from "../../environment/userInteraction.js"; +import { safeSpawn } from "../../utils/safeSpawn.js"; +import { mergeSafeChainProxyEnvironmentVariables } from "../../registryProxy/registryProxy.js"; +import { getCombinedCaBundlePath } from "../../registryProxy/certBundle.js"; +import { reportCommandExecutionFailure } from "../_shared/commandErrors.js"; + +/** + * @returns {import("../currentPackageManager.js").PackageManager} + */ +export function createPoetryPackageManager() { + return { + runCommand: (args) => runPoetryCommand(args), + + // MITM only approach for Poetry + isSupportedCommand: () => false, + getDependencyUpdatesForCommand: () => [], + }; +} + +/** + * Sets CA bundle environment variables used by Poetry and Python libraries. + * Poetry uses the Python requests library which respects these environment variables. + * + * @param {NodeJS.ProcessEnv} env - Environment object to modify + * @param {string} combinedCaPath - Path to the combined CA bundle + */ +function setPoetryCaBundleEnvironmentVariables(env, combinedCaPath) { + // SSL_CERT_FILE: Used by Python SSL libraries and requests + if (env.SSL_CERT_FILE) { + ui.writeWarning("Safe-chain: User defined SSL_CERT_FILE found in environment. It will be overwritten."); + } + env.SSL_CERT_FILE = combinedCaPath; + + // REQUESTS_CA_BUNDLE: Used by the requests library (which Poetry uses) + if (env.REQUESTS_CA_BUNDLE) { + ui.writeWarning("Safe-chain: User defined REQUESTS_CA_BUNDLE found in environment. It will be overwritten."); + } + env.REQUESTS_CA_BUNDLE = combinedCaPath; + + // PIP_CERT: Poetry may use pip internally + if (env.PIP_CERT) { + ui.writeWarning("Safe-chain: User defined PIP_CERT found in environment. It will be overwritten."); + } + env.PIP_CERT = combinedCaPath; +} + +/** + * Runs a poetry command with safe-chain's certificate bundle and proxy configuration. + * + * Poetry respects standard HTTP_PROXY/HTTPS_PROXY environment variables through + * the Python requests library. + * + * @param {string[]} args - Command line arguments to pass to poetry + * @returns {Promise<{status: number}>} Exit status of the poetry command + */ +async function runPoetryCommand(args) { + try { + const env = mergeSafeChainProxyEnvironmentVariables(process.env); + + const combinedCaPath = getCombinedCaBundlePath(); + setPoetryCaBundleEnvironmentVariables(env, combinedCaPath); + + const result = await safeSpawn("poetry", args, { + stdio: "inherit", + env, + }); + + return { status: result.status }; + } catch (/** @type any */ error) { + return reportCommandExecutionFailure(error, "poetry"); + } +} diff --git a/packages/safe-chain/src/packagemanager/poetry/createPoetryPackageManager.spec.js b/packages/safe-chain/src/packagemanager/poetry/createPoetryPackageManager.spec.js new file mode 100644 index 0000000..a49cd27 --- /dev/null +++ b/packages/safe-chain/src/packagemanager/poetry/createPoetryPackageManager.spec.js @@ -0,0 +1,14 @@ +import { test } from "node:test"; +import assert from "node:assert"; +import { createPoetryPackageManager } from "./createPoetryPackageManager.js"; + +test("createPoetryPackageManager", async (t) => { + await t.test("should create package manager with required interface", () => { + const pm = createPoetryPackageManager(); + + assert.ok(pm); + assert.strictEqual(typeof pm.runCommand, "function"); + assert.strictEqual(typeof pm.isSupportedCommand, "function"); + assert.strictEqual(typeof pm.getDependencyUpdatesForCommand, "function"); + }); +}); diff --git a/packages/safe-chain/src/packagemanager/rush/createRushPackageManager.js b/packages/safe-chain/src/packagemanager/rush/createRushPackageManager.js new file mode 100644 index 0000000..85ec4d5 --- /dev/null +++ b/packages/safe-chain/src/packagemanager/rush/createRushPackageManager.js @@ -0,0 +1,64 @@ +import { runRushCommand } from "./runRushCommand.js"; +import { resolvePackageVersion } from "../../api/npmApi.js"; +import { parsePackagesFromRushAddArgs } from "./parsing/parsePackagesFromRushAddArgs.js"; + +/** + * @returns {import("../currentPackageManager.js").PackageManager} + */ +export function createRushPackageManager() { + return { + runCommand: (args) => runRushCommand("rush", args), + // We pre-scan rush add commands and rely on MITM for install/update flows. + isSupportedCommand: (args) => getRushCommand(args) === "add", + getDependencyUpdatesForCommand: scanRushAddCommand, + }; +} + +/** + * @param {string[]} args + * @returns {Promise} + */ +async function scanRushAddCommand(args) { + if (getRushCommand(args) !== "add") { + return []; + } + + const parsedSpecs = parsePackagesFromRushAddArgs(args.slice(1)); + + const resolvedVersions = await Promise.all( + parsedSpecs.map(async (parsed) => { + const exactVersion = await resolvePackageVersion(parsed.name, parsed.version); + return { + parsed, + exactVersion, + }; + }), + ); + + const changes = []; + for (const resolved of resolvedVersions) { + if (!resolved.exactVersion) { + continue; + } + + changes.push({ + name: resolved.parsed.name, + version: resolved.exactVersion, + type: "add", + }); + } + + return changes; +} + +/** + * @param {string[]} args + * @returns {string | undefined} + */ +function getRushCommand(args) { + if (!args || args.length === 0) { + return undefined; + } + + return args[0]?.toLowerCase(); +} diff --git a/packages/safe-chain/src/packagemanager/rush/createRushPackageManager.spec.js b/packages/safe-chain/src/packagemanager/rush/createRushPackageManager.spec.js new file mode 100644 index 0000000..5c02f52 --- /dev/null +++ b/packages/safe-chain/src/packagemanager/rush/createRushPackageManager.spec.js @@ -0,0 +1,66 @@ +import { test, mock } from "node:test"; +import assert from "node:assert"; + +test("createRushPackageManager", async (t) => { + mock.module("../../api/npmApi.js", { + namedExports: { + resolvePackageVersion: async (name, version) => { + if (name === "safe-chain-test") { + return "0.0.1-security"; + } + + if (name === "@scope/tool") { + return version || "2.0.0"; + } + + return null; + }, + }, + }); + + try { + const { createRushPackageManager } = await import("./createRushPackageManager.js"); + + await t.test("should create package manager with required interface", () => { + const pm = createRushPackageManager(); + + assert.ok(pm); + assert.strictEqual(typeof pm.runCommand, "function"); + assert.strictEqual(typeof pm.isSupportedCommand, "function"); + assert.strictEqual(typeof pm.getDependencyUpdatesForCommand, "function"); + }); + + await t.test("should scan rush add commands", () => { + const pm = createRushPackageManager(); + + assert.strictEqual(pm.isSupportedCommand(["add", "--package", "safe-chain-test"]), true); + assert.strictEqual(pm.isSupportedCommand(["install"]), false); + }); + + await t.test("should parse rush add package specs and resolve versions", async () => { + const pm = createRushPackageManager(); + + const changes = await pm.getDependencyUpdatesForCommand([ + "add", + "--package", + "safe-chain-test", + "--package=@scope/tool@1.2.3", + ]); + + assert.deepStrictEqual(changes, [ + { name: "safe-chain-test", version: "0.0.1-security", type: "add" }, + { name: "@scope/tool", version: "1.2.3", type: "add" }, + ]); + }); + + await t.test("should return no changes for non-add commands", async () => { + const pm = createRushPackageManager(); + + const changes = await pm.getDependencyUpdatesForCommand(["install"]); + + assert.deepStrictEqual(changes, []); + }); + } finally { + mock.reset(); + } +}); diff --git a/packages/safe-chain/src/packagemanager/rush/parsing/parsePackagesFromRushAddArgs.js b/packages/safe-chain/src/packagemanager/rush/parsing/parsePackagesFromRushAddArgs.js new file mode 100644 index 0000000..3e82085 --- /dev/null +++ b/packages/safe-chain/src/packagemanager/rush/parsing/parsePackagesFromRushAddArgs.js @@ -0,0 +1,71 @@ +/** + * @param {string[]} args + * @returns {{name: string, version: string | null}[]} + */ +export function parsePackagesFromRushAddArgs(args) { + const packageSpecs = []; + + for (let i = 0; i < args.length; i++) { + const arg = args[i]; + if (!arg) { + continue; + } + + if (arg === "--package" || arg === "-p") { + const next = args[i + 1]; + if (next && !next.startsWith("-")) { + packageSpecs.push(next); + i += 1; + } + continue; + } + + if (arg.startsWith("--package=")) { + const value = arg.slice("--package=".length); + if (value) { + packageSpecs.push(value); + } + } + } + + return packageSpecs + .map((spec) => parsePackageSpec(spec)) + .filter((spec) => spec !== null); +} + +/** + * @param {string} spec + * @returns {{name: string, version: string | null} | null} + */ +function parsePackageSpec(spec) { + const value = removeAlias(spec.trim()); + if (!value) { + return null; + } + + const lastAtIndex = value.lastIndexOf("@"); + if (lastAtIndex > 0) { + return { + name: value.slice(0, lastAtIndex), + version: value.slice(lastAtIndex + 1), + }; + } + + return { + name: value, + version: null, + }; +} + +/** + * @param {string} spec + * @returns {string} + */ +function removeAlias(spec) { + const aliasIndex = spec.indexOf("@npm:"); + if (aliasIndex !== -1) { + return spec.slice(aliasIndex + 5); + } + + return spec; +} diff --git a/packages/safe-chain/src/packagemanager/rush/parsing/parsePackagesFromRushAddArgs.spec.js b/packages/safe-chain/src/packagemanager/rush/parsing/parsePackagesFromRushAddArgs.spec.js new file mode 100644 index 0000000..0607c82 --- /dev/null +++ b/packages/safe-chain/src/packagemanager/rush/parsing/parsePackagesFromRushAddArgs.spec.js @@ -0,0 +1,49 @@ +import { describe, it } from "node:test"; +import assert from "node:assert"; +import { parsePackagesFromRushAddArgs } from "./parsePackagesFromRushAddArgs.js"; + +describe("parsePackagesFromRushAddArgs", () => { + it("returns an empty array when no packages are provided", () => { + const result = parsePackagesFromRushAddArgs([]); + + assert.deepEqual(result, []); + }); + + it("parses packages from --package arguments", () => { + const result = parsePackagesFromRushAddArgs([ + "--package", + "axios@1.9.0", + "--package", + "@scope/tool@2.0.0", + ]); + + assert.deepEqual(result, [ + { name: "axios", version: "1.9.0" }, + { name: "@scope/tool", version: "2.0.0" }, + ]); + }); + + it("parses packages from -p arguments", () => { + const result = parsePackagesFromRushAddArgs(["-p", "axios"]); + + assert.deepEqual(result, [{ name: "axios", version: null }]); + }); + + it("parses packages from --package=value arguments", () => { + const result = parsePackagesFromRushAddArgs(["--package=axios@^1.9.0"]); + + assert.deepEqual(result, [{ name: "axios", version: "^1.9.0" }]); + }); + + it("ignores positional packages because rush add requires --package", () => { + const result = parsePackagesFromRushAddArgs(["axios", "--dev"]); + + assert.deepEqual(result, []); + }); + + it("parses aliases", () => { + const result = parsePackagesFromRushAddArgs(["--package", "server@npm:axios@1.9.0"]); + + assert.deepEqual(result, [{ name: "axios", version: "1.9.0" }]); + }); +}); diff --git a/packages/safe-chain/src/packagemanager/rush/runRushCommand.js b/packages/safe-chain/src/packagemanager/rush/runRushCommand.js new file mode 100644 index 0000000..340e3f6 --- /dev/null +++ b/packages/safe-chain/src/packagemanager/rush/runRushCommand.js @@ -0,0 +1,21 @@ +import { mergeSafeChainProxyEnvironmentVariables } from "../../registryProxy/registryProxy.js"; +import { safeSpawn } from "../../utils/safeSpawn.js"; +import { reportCommandExecutionFailure } from "../_shared/commandErrors.js"; + +/** + * @param {"rush" | "rushx"} executableName + * @param {string[]} args + * @returns {Promise<{status: number}>} + */ +export async function runRushCommand(executableName, args) { + try { + const result = await safeSpawn(executableName, args, { + stdio: "inherit", + env: mergeSafeChainProxyEnvironmentVariables(process.env), + }); + + return { status: result.status }; + } catch (/** @type any */ error) { + return reportCommandExecutionFailure(error, executableName); + } +} diff --git a/packages/safe-chain/src/packagemanager/rush/runRushCommand.spec.js b/packages/safe-chain/src/packagemanager/rush/runRushCommand.spec.js new file mode 100644 index 0000000..fa2c35a --- /dev/null +++ b/packages/safe-chain/src/packagemanager/rush/runRushCommand.spec.js @@ -0,0 +1,109 @@ +import { describe, it, beforeEach, afterEach, mock } from "node:test"; +import assert from "node:assert"; + +describe("runRushCommand", () => { + let runRushCommand; + let safeSpawnMock; + let mergeCalls; + let mergeResultEnv; + let nextSpawnStatus; + let nextSpawnError; + + beforeEach(async () => { + mergeCalls = []; + mergeResultEnv = null; + nextSpawnStatus = 0; + nextSpawnError = null; + safeSpawnMock = mock.fn(async () => { + if (nextSpawnError) { + const error = nextSpawnError; + nextSpawnError = null; + throw error; + } + + return { status: nextSpawnStatus }; + }); + + mock.module("../../utils/safeSpawn.js", { + namedExports: { + safeSpawn: safeSpawnMock, + }, + }); + + mock.module("../../registryProxy/registryProxy.js", { + namedExports: { + mergeSafeChainProxyEnvironmentVariables: (env) => { + mergeCalls.push(env); + if (mergeResultEnv) { + return mergeResultEnv; + } + + return { + ...env, + HTTPS_PROXY: "http://localhost:8080", + }; + }, + }, + }); + + // commandErrors reports through ui on failures, so provide a no-op mock + mock.module("../../environment/userInteraction.js", { + namedExports: { + ui: { + writeError: () => {}, + }, + }, + }); + + const mod = await import("./runRushCommand.js"); + runRushCommand = mod.runRushCommand; + }); + + afterEach(() => { + mock.reset(); + }); + + it("spawns rush with merged proxy env", async () => { + const res = await runRushCommand("rush", ["install"]); + + assert.strictEqual(res.status, 0); + assert.strictEqual(safeSpawnMock.mock.calls.length, 1); + + const [command, args, options] = safeSpawnMock.mock.calls[0].arguments; + assert.strictEqual(command, "rush"); + assert.deepStrictEqual(args, ["install"]); + assert.strictEqual(options.stdio, "inherit"); + assert.strictEqual(options.env.HTTPS_PROXY, "http://localhost:8080"); + assert.ok(mergeCalls.length >= 1, "proxy env merge should be called"); + }); + + it("returns spawn result status", async () => { + nextSpawnStatus = 7; + + const res = await runRushCommand("rush", ["update"]); + + assert.strictEqual(res.status, 7); + }); + + it("reports failures with rush target", async () => { + nextSpawnError = Object.assign(new Error("spawn failed"), { + code: "ENOENT", + }); + + const res = await runRushCommand("rush", ["install"]); + + assert.strictEqual(res.status, 1); + }); + + it("does not mutate merged env object", async () => { + mergeResultEnv = { + HTTPS_PROXY: "http://localhost:8080", + }; + + await runRushCommand("rush", ["install"]); + + assert.deepStrictEqual(mergeResultEnv, { + HTTPS_PROXY: "http://localhost:8080", + }); + }); +}); diff --git a/packages/safe-chain/src/packagemanager/rushx/createRushxPackageManager.js b/packages/safe-chain/src/packagemanager/rushx/createRushxPackageManager.js new file mode 100644 index 0000000..af89d21 --- /dev/null +++ b/packages/safe-chain/src/packagemanager/rushx/createRushxPackageManager.js @@ -0,0 +1,18 @@ +import { runRushCommand } from "../rush/runRushCommand.js"; + +/** + * @returns {import("../currentPackageManager.js").PackageManager} + */ +export function createRushxPackageManager() { + return { + /** + * @param {string[]} args + */ + runCommand: (args) => { + return runRushCommand("rushx", args); + }, + // For rushx, rely solely on MITM. + isSupportedCommand: () => false, + getDependencyUpdatesForCommand: () => [], + }; +} diff --git a/packages/safe-chain/src/packagemanager/rushx/createRushxPackageManager.spec.js b/packages/safe-chain/src/packagemanager/rushx/createRushxPackageManager.spec.js new file mode 100644 index 0000000..20b4a32 --- /dev/null +++ b/packages/safe-chain/src/packagemanager/rushx/createRushxPackageManager.spec.js @@ -0,0 +1,14 @@ +import { test } from "node:test"; +import assert from "node:assert"; +import { createRushxPackageManager } from "./createRushxPackageManager.js"; + +test("createRushxPackageManager returns valid package manager interface", () => { + const pm = createRushxPackageManager(); + + assert.ok(pm); + assert.strictEqual(typeof pm.runCommand, "function"); + assert.strictEqual(typeof pm.isSupportedCommand, "function"); + assert.strictEqual(typeof pm.getDependencyUpdatesForCommand, "function"); + assert.strictEqual(pm.isSupportedCommand(), false); + assert.deepStrictEqual(pm.getDependencyUpdatesForCommand(), []); +}); diff --git a/packages/safe-chain/src/packagemanager/uv/runUvCommand.js b/packages/safe-chain/src/packagemanager/uv/runUvCommand.js index ed02fe3..7c22518 100644 --- a/packages/safe-chain/src/packagemanager/uv/runUvCommand.js +++ b/packages/safe-chain/src/packagemanager/uv/runUvCommand.js @@ -2,6 +2,7 @@ import { ui } from "../../environment/userInteraction.js"; import { safeSpawn } from "../../utils/safeSpawn.js"; import { mergeSafeChainProxyEnvironmentVariables } from "../../registryProxy/registryProxy.js"; import { getCombinedCaBundlePath } from "../../registryProxy/certBundle.js"; +import { reportCommandExecutionFailure } from "../_shared/commandErrors.js"; /** * Sets CA bundle environment variables used by Python libraries and uv. @@ -60,12 +61,6 @@ export async function runUv(command, args) { return { status: result.status }; } catch (/** @type any */ error) { - if (error.status) { - return { status: error.status }; - } else { - ui.writeError(`Error executing command: ${error.message}`); - ui.writeError(`Is '${command}' installed and available on your system?`); - return { status: 1 }; - } + return reportCommandExecutionFailure(error, command); } } diff --git a/packages/safe-chain/src/packagemanager/uvx/createUvxPackageManager.js b/packages/safe-chain/src/packagemanager/uvx/createUvxPackageManager.js new file mode 100644 index 0000000..18a7089 --- /dev/null +++ b/packages/safe-chain/src/packagemanager/uvx/createUvxPackageManager.js @@ -0,0 +1,18 @@ +import { runUv } from "../uv/runUvCommand.js"; + +/** + * @returns {import("../currentPackageManager.js").PackageManager} + */ +export function createUvxPackageManager() { + return { + /** + * @param {string[]} args + */ + runCommand: (args) => { + return runUv("uvx", args); + }, + // For uvx, rely solely on MITM + isSupportedCommand: () => false, + getDependencyUpdatesForCommand: () => [], + }; +} diff --git a/packages/safe-chain/src/packagemanager/uvx/createUvxPackageManager.spec.js b/packages/safe-chain/src/packagemanager/uvx/createUvxPackageManager.spec.js new file mode 100644 index 0000000..6eb87a0 --- /dev/null +++ b/packages/safe-chain/src/packagemanager/uvx/createUvxPackageManager.spec.js @@ -0,0 +1,14 @@ +import { test } from "node:test"; +import assert from "node:assert"; +import { createUvxPackageManager } from "./createUvxPackageManager.js"; + +test("createUvxPackageManager returns valid package manager interface", () => { + const pm = createUvxPackageManager(); + + assert.ok(pm); + assert.strictEqual(typeof pm.runCommand, "function"); + assert.strictEqual(typeof pm.isSupportedCommand, "function"); + assert.strictEqual(typeof pm.getDependencyUpdatesForCommand, "function"); + assert.strictEqual(pm.isSupportedCommand(), false); + assert.deepStrictEqual(pm.getDependencyUpdatesForCommand(), []); +}); diff --git a/packages/safe-chain/src/packagemanager/yarn/runYarnCommand.js b/packages/safe-chain/src/packagemanager/yarn/runYarnCommand.js index 2089551..fdf601a 100644 --- a/packages/safe-chain/src/packagemanager/yarn/runYarnCommand.js +++ b/packages/safe-chain/src/packagemanager/yarn/runYarnCommand.js @@ -1,6 +1,6 @@ -import { ui } from "../../environment/userInteraction.js"; import { safeSpawn } from "../../utils/safeSpawn.js"; import { mergeSafeChainProxyEnvironmentVariables } from "../../registryProxy/registryProxy.js"; +import { reportCommandExecutionFailure } from "../_shared/commandErrors.js"; /** * @param {string[]} args @@ -18,12 +18,7 @@ export async function runYarnCommand(args) { }); return { status: result.status }; } catch (/** @type any */ error) { - if (error.status) { - return { status: error.status }; - } else { - ui.writeError("Error executing command:", error.message); - return { status: 1 }; - } + return reportCommandExecutionFailure(error, "yarn"); } } diff --git a/packages/safe-chain/src/registryProxy/certBundle.js b/packages/safe-chain/src/registryProxy/certBundle.js index 956279d..19dc800 100644 --- a/packages/safe-chain/src/registryProxy/certBundle.js +++ b/packages/safe-chain/src/registryProxy/certBundle.js @@ -6,6 +6,10 @@ import certifi from "certifi"; import tls from "node:tls"; import { X509Certificate } from "node:crypto"; import { getCaCertPath } from "./certUtils.js"; +import { ui } from "../environment/userInteraction.js"; + +/** @type {string | null} */ +let bundlePath = null; /** * Check if a PEM string contains only parsable cert blocks. @@ -14,6 +18,7 @@ import { getCaCertPath } from "./certUtils.js"; */ function isParsable(pem) { if (!pem || typeof pem !== "string") return false; + pem = normalizeLineEndings(pem); const begin = "-----BEGIN CERTIFICATE-----"; const end = "-----END CERTIFICATE-----"; const blocks = []; @@ -41,20 +46,22 @@ function isParsable(pem) { } } -/** @type {string | null} */ -let cachedPath = null; - /** - * Build a combined CA bundle for Python and Node HTTPS flows. - * - Includes Safe Chain CA (for MITM of known registries) - * - Includes Mozilla roots via npm `certifi` (public HTTPS) - * - Includes Node's built-in root certificates as a portable fallback + * Build a combined CA bundle. + * Automatically includes: + * - Safe Chain CA (for MITM of known registries) + * - Mozilla roots via certifi (for public HTTPS) + * - Node's built-in root certificates (fallback) + * - User's custom certificates (if NODE_EXTRA_CA_CERTS environment variable is set) + * * @returns {string} Path to the combined CA bundle PEM file */ export function getCombinedCaBundlePath() { - if (cachedPath && fs.existsSync(cachedPath)) return cachedPath; + if (bundlePath) + { + return bundlePath; + } - // Concatenate PEM files const parts = []; // 1) Safe Chain CA (for MITM'd registries) @@ -87,9 +94,110 @@ export function getCombinedCaBundlePath() { // Ignore if unavailable } + // 4) User's NODE_EXTRA_CA_CERTS (if set) + const userCertPath = process.env.NODE_EXTRA_CA_CERTS; + if (userCertPath) { + const userPem = readUserCertificateFile(userCertPath); + if (userPem) { + parts.push(userPem.trim()); + ui.writeVerbose(`Safe-chain: Merging user's NODE_EXTRA_CA_CERTS from ${userCertPath}`); + } else { + ui.writeWarning(`Safe-chain: Could not read or parse user's NODE_EXTRA_CA_CERTS from ${userCertPath}`); + } + } + const combined = parts.filter(Boolean).join("\n"); - const target = path.join(os.tmpdir(), "safe-chain-ca-bundle.pem"); - fs.writeFileSync(target, combined, { encoding: "utf8" }); - cachedPath = target; - return cachedPath; + bundlePath = path.join(os.tmpdir(), `safe-chain-ca-bundle-${Date.now()}.pem`); + fs.writeFileSync(bundlePath, combined, { encoding: "utf8" }); + return bundlePath; } + +/** + * Remove the generated CA bundle file from disk. + */ +export function cleanupCertBundle() { + if (bundlePath) { + try { + fs.unlinkSync(bundlePath); + } catch (err) { + ui.writeVerbose(`Failed to cleanup the create bundle at ${bundlePath}`, err) + } + bundlePath = null; + } +} + +/** + * Normalize path + * @param {string} p - Path to normalize + * @returns {string} + */ +function normalizePathF(p) { + return p.replace(/\\/g, "/"); +} + +/** + * Normalize line endings to LF + * @param {string} text - Text with mixed line endings + * @returns {string} + */ +function normalizeLineEndings(text) { + return text.replace(/\r\n/g, "\n").replace(/\r/g, "\n"); +} + +/** + * Read and validate user certificate file + * @param {string} certPath - Path to certificate file + * @returns {string | null} Certificate PEM content or null if invalid/unreadable + */ +function readUserCertificateFile(certPath) { + try { + // 1) Basic validation + if (typeof certPath !== "string" || certPath.trim().length === 0) { + return null; + } + + // 2) Reject path traversal attempts (normalize backslashes first for Windows paths) + const normalizedPath = normalizePathF(certPath); + if (normalizedPath.includes("..")) { + return null; + } + + // 3) Check if file exists and is not a directory or symlink + let stats; + try { + stats = fs.lstatSync(certPath); + } catch { + // File doesn't exist or can't be accessed + return null; + } + + if (!stats.isFile()) { + // Reject directories and symlinks + return null; + } + + // 4) Read file content + let content; + try { + content = fs.readFileSync(certPath, "utf8"); + } catch { + return null; + } + + if (!content || typeof content !== "string") { + return null; + } + + // 5) Validate PEM format + if (!isParsable(content)) { + return null; + } + + return content; + } catch { + // Silently fail on any errors + return null; + } +} + + diff --git a/packages/safe-chain/src/registryProxy/certBundle.spec.js b/packages/safe-chain/src/registryProxy/certBundle.spec.js index 2f26d51..e3b58fb 100644 --- a/packages/safe-chain/src/registryProxy/certBundle.spec.js +++ b/packages/safe-chain/src/registryProxy/certBundle.spec.js @@ -15,6 +15,13 @@ function removeBundleIfExists() { } } +// Utility to get a valid PEM certificate for testing +function getValidCert() { + const cert = typeof tls.rootCertificates?.[0] === "string" ? tls.rootCertificates[0] : ""; + assert.ok(cert.includes("BEGIN CERTIFICATE"), "Environment lacks Node root certificates for test"); + return cert; +} + describe("certBundle.getCombinedCaBundlePath", () => { beforeEach(() => { mock.restoreAll(); @@ -69,3 +76,304 @@ describe("certBundle.getCombinedCaBundlePath", () => { assert.ok(!contents.includes(invalidMarker), "Bundle should not include invalid Safe Chain content"); }); }); + +describe("certBundle.getCombinedCaBundlePath with user certs", () => { + beforeEach(() => { + mock.restoreAll(); + delete process.env.NODE_EXTRA_CA_CERTS; + }); + + it("returns a path with full CA bundle (Safe Chain + Mozilla + Node roots) when no user cert in env", async () => { + // Mock getCaCertPath to return valid cert + const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "certtest-")); + const safeChainPath = path.join(tmpDir, "safechain.pem"); + fs.writeFileSync(safeChainPath, getValidCert(), "utf8"); + + mock.module("./certUtils.js", { + namedExports: { + getCaCertPath: () => safeChainPath, + }, + }); + + const { getCombinedCaBundlePath } = await import("./certBundle.js"); + const bundlePath = getCombinedCaBundlePath(); + + assert.ok(fs.existsSync(bundlePath), "Bundle path should exist"); + const contents = fs.readFileSync(bundlePath, "utf8"); + assert.match(contents, /-----BEGIN CERTIFICATE-----/, "Should contain certificate blocks"); + // Should include base bundle (Safe Chain + Mozilla/Node roots) + assert.ok(contents.length > 1000, "Bundle should be substantial with Mozilla/Node roots included"); + }); + + it("merges user cert with full base bundle (Safe Chain CA + Mozilla + Node roots)", async () => { + const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "certtest-")); + + // Create Safe Chain CA + const safeChainPath = path.join(tmpDir, "safechain.pem"); + const safeChainCert = getValidCert(); + fs.writeFileSync(safeChainPath, safeChainCert, "utf8"); + + // Create user cert file + const userCertPath = path.join(tmpDir, "user-cert.pem"); + const userCert = getValidCert(); + fs.writeFileSync(userCertPath, userCert, "utf8"); + process.env.NODE_EXTRA_CA_CERTS = userCertPath; + + mock.module("./certUtils.js", { + namedExports: { + getCaCertPath: () => safeChainPath, + }, + }); + + const { getCombinedCaBundlePath } = await import("./certBundle.js"); + const bundlePath = getCombinedCaBundlePath(); + + assert.ok(fs.existsSync(bundlePath), "Bundle path should exist"); + const contents = fs.readFileSync(bundlePath, "utf8"); + + // Both certs should be in the bundle + const certCount = (contents.match(/-----BEGIN CERTIFICATE-----/g) || []).length; + assert.ok(certCount >= 2, "Bundle should contain both Safe Chain and user certificates"); + }); + + it("ignores non-existent user cert path", async () => { + const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "certtest-")); + const safeChainPath = path.join(tmpDir, "safechain.pem"); + fs.writeFileSync(safeChainPath, getValidCert(), "utf8"); + process.env.NODE_EXTRA_CA_CERTS = "/nonexistent/path.pem"; + + mock.module("./certUtils.js", { + namedExports: { + getCaCertPath: () => safeChainPath, + }, + }); + + const { getCombinedCaBundlePath } = await import("./certBundle.js"); + const bundlePath = getCombinedCaBundlePath(); + + assert.ok(fs.existsSync(bundlePath), "Bundle path should exist"); + const contents = fs.readFileSync(bundlePath, "utf8"); + // Should still have Safe Chain CA + assert.match(contents, /-----BEGIN CERTIFICATE-----/, "Should contain Safe Chain CA"); + }); + + it("ignores invalid PEM user cert", async () => { + const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "certtest-")); + + const safeChainPath = path.join(tmpDir, "safechain.pem"); + fs.writeFileSync(safeChainPath, getValidCert(), "utf8"); + + const userCertPath = path.join(tmpDir, "invalid.pem"); + fs.writeFileSync(userCertPath, "NOT A VALID PEM", "utf8"); + process.env.NODE_EXTRA_CA_CERTS = userCertPath; + + mock.module("./certUtils.js", { + namedExports: { + getCaCertPath: () => safeChainPath, + }, + }); + + const { getCombinedCaBundlePath } = await import("./certBundle.js"); + const bundlePath = getCombinedCaBundlePath(); + + assert.ok(fs.existsSync(bundlePath), "Bundle path should exist"); + const contents = fs.readFileSync(bundlePath, "utf8"); + // Should still have Safe Chain CA only + assert.match(contents, /-----BEGIN CERTIFICATE-----/, "Should contain Safe Chain CA"); + assert.ok(!contents.includes("NOT A VALID"), "Should not include invalid cert"); + }); + + it("rejects user cert with path traversal attempts", async () => { + const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "certtest-")); + const safeChainPath = path.join(tmpDir, "safechain.pem"); + fs.writeFileSync(safeChainPath, getValidCert(), "utf8"); + + mock.module("./certUtils.js", { + namedExports: { + getCaCertPath: () => safeChainPath, + }, + }); + + const { getCombinedCaBundlePath } = await import("./certBundle.js"); + process.env.NODE_EXTRA_CA_CERTS = "../../../etc/passwd"; + const bundlePath = getCombinedCaBundlePath(); + + assert.ok(fs.existsSync(bundlePath), "Bundle path should exist"); + const contents = fs.readFileSync(bundlePath, "utf8"); + // Should only have Safe Chain CA, rejected the traversal path + assert.match(contents, /-----BEGIN CERTIFICATE-----/, "Should contain Safe Chain CA"); + }); + + it("rejects user cert with symlink", async () => { + const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "certtest-")); + + const safeChainPath = path.join(tmpDir, "safechain.pem"); + fs.writeFileSync(safeChainPath, getValidCert(), "utf8"); + + // Create a target file and a symlink to it + const targetCert = path.join(tmpDir, "target.pem"); + fs.writeFileSync(targetCert, getValidCert(), "utf8"); + + const symlinkPath = path.join(tmpDir, "symlink.pem"); + try { + fs.symlinkSync(targetCert, symlinkPath); + } catch { + // Skip test if symlinks are not supported (e.g., on Windows without admin) + return; + } + + mock.module("./certUtils.js", { + namedExports: { + getCaCertPath: () => safeChainPath, + }, + }); + + const { getCombinedCaBundlePath } = await import("./certBundle.js"); + process.env.NODE_EXTRA_CA_CERTS = symlinkPath; + const bundlePath = getCombinedCaBundlePath(); + + assert.ok(fs.existsSync(bundlePath), "Bundle path should exist"); + const contents = fs.readFileSync(bundlePath, "utf8"); + // Should only have Safe Chain CA, symlinks are rejected + assert.match(contents, /-----BEGIN CERTIFICATE-----/, "Should contain Safe Chain CA"); + }); + + it("rejects user cert that is a directory", async () => { + const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "certtest-")); + + const safeChainPath = path.join(tmpDir, "safechain.pem"); + fs.writeFileSync(safeChainPath, getValidCert(), "utf8"); + + const certDir = path.join(tmpDir, "certs"); + fs.mkdirSync(certDir); + + mock.module("./certUtils.js", { + namedExports: { + getCaCertPath: () => safeChainPath, + }, + }); + + const { getCombinedCaBundlePath } = await import("./certBundle.js"); + process.env.NODE_EXTRA_CA_CERTS = certDir; + const bundlePath = getCombinedCaBundlePath(); + + assert.ok(fs.existsSync(bundlePath), "Bundle path should exist"); + const contents = fs.readFileSync(bundlePath, "utf8"); + // Should only have Safe Chain CA + assert.match(contents, /-----BEGIN CERTIFICATE-----/, "Should contain Safe Chain CA"); + }); + + it("handles empty string user cert path", async () => { + const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "certtest-")); + const safeChainPath = path.join(tmpDir, "safechain.pem"); + fs.writeFileSync(safeChainPath, getValidCert(), "utf8"); + + mock.module("./certUtils.js", { + namedExports: { + getCaCertPath: () => safeChainPath, + }, + }); + + const { getCombinedCaBundlePath } = await import("./certBundle.js"); + process.env.NODE_EXTRA_CA_CERTS = " "; + const bundlePath = getCombinedCaBundlePath(); + + assert.ok(fs.existsSync(bundlePath), "Bundle path should exist"); + const contents = fs.readFileSync(bundlePath, "utf8"); + assert.match(contents, /-----BEGIN CERTIFICATE-----/, "Should contain Safe Chain CA"); + }); + + it("accepts files with CRLF line endings (Windows-style)", async () => { + const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "certtest-")); + const safeChainPath = path.join(tmpDir, "safechain.pem"); + fs.writeFileSync(safeChainPath, getValidCert(), "utf8"); + + // Create a real file with CRLF content to test Windows line ending support + const userCertPath = path.join(tmpDir, "user-cert-crlf.pem"); + const userCert = getValidCert(); + const certWithCRLF = userCert.replace(/\n/g, "\r\n"); + fs.writeFileSync(userCertPath, certWithCRLF, "utf8"); + process.env.NODE_EXTRA_CA_CERTS = userCertPath; + + mock.module("./certUtils.js", { + namedExports: { + getCaCertPath: () => safeChainPath, + }, + }); + + const { getCombinedCaBundlePath } = await import("./certBundle.js"); + const bundlePath = getCombinedCaBundlePath(); + assert.ok(fs.existsSync(bundlePath), "Bundle path should exist"); + const contents = fs.readFileSync(bundlePath, "utf8"); + const certCount = (contents.match(/-----BEGIN CERTIFICATE-----/g) || []).length; + assert.ok(certCount >= 2, "Bundle should contain Safe Chain and user certificates with CRLF"); + }); + + it("detects and handles Windows-style path syntax (drive letters and UNC)", async () => { + const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "certtest-")); + const safeChainPath = path.join(tmpDir, "safechain.pem"); + fs.writeFileSync(safeChainPath, getValidCert(), "utf8"); + + mock.module("./certUtils.js", { + namedExports: { + getCaCertPath: () => safeChainPath, + }, + }); + + const { getCombinedCaBundlePath } = await import("./certBundle.js"); + + // Test that Windows path syntax is recognized (even if files don't exist on macOS/Linux) + // These should gracefully fail (return Safe Chain CA only) rather than crash + const winPaths = [ + "C:\\temp\\cert.pem", + "D:\\Users\\name\\certs\\ca.pem", + "\\\\server\\share\\cert.pem" + ]; + + for (const winPath of winPaths) { + process.env.NODE_EXTRA_CA_CERTS = winPath; + const bundlePath = getCombinedCaBundlePath(); + assert.ok(fs.existsSync(bundlePath), `Bundle should exist for ${winPath}`); + const contents = fs.readFileSync(bundlePath, "utf8"); + assert.match(contents, /-----BEGIN CERTIFICATE-----/, "Should contain Safe Chain CA"); + } + }); + + it("rejects path traversal with Windows-style paths (C:\\temp\\..\\etc\\passwd)", async () => { + const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "certtest-")); + const safeChainPath = path.join(tmpDir, "safechain.pem"); + fs.writeFileSync(safeChainPath, getValidCert(), "utf8"); + + mock.module("./certUtils.js", { + namedExports: { + getCaCertPath: () => safeChainPath, + }, + }); + + const { getCombinedCaBundlePath } = await import("./certBundle.js"); + + // Test various Windows-style traversal attempts + const traversalPaths = [ + "C:\\temp\\..\\etc\\passwd", + "D:\\Users\\..\\..\\Windows\\System32", + "\\\\server\\share\\..\\admin", + "../../../etc/passwd", // Unix-style for comparison + ]; + + // First, get baseline bundle without user certs to know expected cert count + delete process.env.NODE_EXTRA_CA_CERTS; + const baselineBundlePath = getCombinedCaBundlePath(); + const baselineContents = fs.readFileSync(baselineBundlePath, "utf8"); + const baselineCertCount = (baselineContents.match(/-----BEGIN CERTIFICATE-----/g) || []).length; + + for (const badPath of traversalPaths) { + process.env.NODE_EXTRA_CA_CERTS = badPath; + const bundlePath = getCombinedCaBundlePath(); + assert.ok(fs.existsSync(bundlePath), "Bundle path should exist"); + const contents = fs.readFileSync(bundlePath, "utf8"); + // Should contain base bundle (Safe Chain + Mozilla + Node roots) but NOT user cert + const certCount = (contents.match(/-----BEGIN CERTIFICATE-----/g) || []).length; + assert.strictEqual(certCount, baselineCertCount, `Traversal path ${badPath} should be rejected; base bundle only (no user cert added)`); + } + }); +}); diff --git a/packages/safe-chain/src/registryProxy/certUtils.js b/packages/safe-chain/src/registryProxy/certUtils.js index 6b326c8..3918177 100644 --- a/packages/safe-chain/src/registryProxy/certUtils.js +++ b/packages/safe-chain/src/registryProxy/certUtils.js @@ -1,15 +1,25 @@ import forge from "node-forge"; import path from "path"; import fs from "fs"; -import os from "os"; +import { getCertsDir } from "../config/safeChainDir.js"; -const certFolder = path.join(os.homedir(), ".safe-chain", "certs"); const ca = loadCa(); const certCache = new Map(); +/** + * @param {forge.pki.PublicKey} publicKey + * @returns {string} + */ +function createKeyIdentifier(publicKey) { + return forge.pki.getPublicKeyFingerprint(publicKey, { + encoding: "binary", + md: forge.md.sha1.create(), + }); +} + export function getCaCertPath() { - return path.join(certFolder, "ca-cert.pem"); + return path.join(getCertsDir(), "ca-cert.pem"); } /** @@ -33,6 +43,7 @@ export function generateCertForHost(hostname) { const attrs = [{ name: "commonName", value: hostname }]; cert.setSubject(attrs); cert.setIssuer(ca.certificate.subject.attributes); + const authorityKeyIdentifier = createKeyIdentifier(ca.certificate.publicKey); cert.setExtensions([ { name: "subjectAltName", @@ -50,14 +61,42 @@ export function generateCertForHost(hostname) { }, { /* - extKeyUsage serverAuth is required for TLS server authentication. - This is especially important for Python venv environments, which use their own - certificate validation logic and will reject certificates lacking the serverAuth EKU. - Adding serverAuth does not impact other usages + Extended Key Usage (EKU) serverAuth extension + + Needed for TLS server authentication. This extension indicates the certificate's + public key may be used for TLS WWW server authentication. + Python virtualenv environments (like pipx-installed Poetry) enforce this strictly + https://www.rfc-editor.org/rfc/rfc5280#section-4.2.1.12 */ name: "extKeyUsage", serverAuth: true, }, + { + /* + Subject Key Identifier (SKI) + + Needed for Python virtualenv SSL validation and certificate chain building. + This extension provides a means of identifying certificates containing a particular public key. + Python virtualenv environments require this for proper certificate chain validation. + System Python installations may be more lenient. + https://www.rfc-editor.org/rfc/rfc5280#section-4.2.1.2 + */ + name: "subjectKeyIdentifier", + subjectKeyIdentifier: createKeyIdentifier(cert.publicKey), + }, + { + /* + Authority Key Identifier (AKI) + + Needed for Python virtualenv SSL validation and certificate path validation. + This extension identifies the public key corresponding to the private key used to sign + this certificate. It links this certificate to its issuing CA certificate. + Without this, Python virtualenv certificate validation might fail (for instance for Poetry) + https://www.rfc-editor.org/rfc/rfc5280#section-4.2.1.1 + */ + name: "authorityKeyIdentifier", + keyIdentifier: authorityKeyIdentifier, + }, ]); cert.sign(ca.privateKey, forge.md.sha256.create()); @@ -72,6 +111,7 @@ export function generateCertForHost(hostname) { } function loadCa() { + const certFolder = getCertsDir(); const keyPath = path.join(certFolder, "ca-key.pem"); const certPath = path.join(certFolder, "ca-cert.pem"); @@ -106,11 +146,13 @@ function generateCa() { const attrs = [{ name: "commonName", value: "safe-chain proxy" }]; cert.setSubject(attrs); - cert.setIssuer(attrs); + cert.setIssuer(attrs); // Self-signed: issuer === subject + const keyIdentifier = createKeyIdentifier(cert.publicKey); cert.setExtensions([ { name: "basicConstraints", cA: true, + critical: true, // Marking basicConstraints as critical is required for CA certificates so clients must process it to trust the cert as a CA }, { name: "keyUsage", @@ -118,6 +160,14 @@ function generateCa() { digitalSignature: true, keyEncipherment: true, }, + { + name: "subjectKeyIdentifier", + subjectKeyIdentifier: keyIdentifier, + }, + { + name: "authorityKeyIdentifier", + keyIdentifier, + }, ]); cert.sign(keys.privateKey, forge.md.sha256.create()); diff --git a/packages/safe-chain/src/registryProxy/certUtils.spec.js b/packages/safe-chain/src/registryProxy/certUtils.spec.js new file mode 100644 index 0000000..4bf8c95 --- /dev/null +++ b/packages/safe-chain/src/registryProxy/certUtils.spec.js @@ -0,0 +1,71 @@ +import { describe, it, beforeEach, afterEach, mock } from "node:test"; +import assert from "node:assert"; + +describe("certUtils", () => { + let installedSafeChainDir; + + beforeEach(() => { + installedSafeChainDir = undefined; + mock.module("../config/safeChainDir.js", { + namedExports: { + getSafeChainBaseDir: () => installedSafeChainDir ?? "/home/test/.safe-chain", + getCertsDir: () => `${installedSafeChainDir ?? "/home/test/.safe-chain"}/certs`, + }, + }); + }); + + afterEach(() => { + mock.reset(); + }); + + it("stores CA certificates in the packaged install dir when available", async () => { + installedSafeChainDir = "/custom/safe-chain"; + + mock.module("fs", { + defaultExport: { + existsSync: () => false, + mkdirSync: () => {}, + writeFileSync: () => {}, + }, + }); + + mock.module("node-forge", { + defaultExport: { + pki: { + getPublicKeyFingerprint: () => "fingerprint", + rsa: { + generateKeyPair: () => ({ + publicKey: "public-key", + privateKey: "private-key", + }), + }, + createCertificate: () => ({ + publicKey: null, + serialNumber: "", + validity: { + notBefore: new Date(), + notAfter: new Date(), + }, + setSubject: () => {}, + setIssuer: () => {}, + setExtensions: () => {}, + sign: () => {}, + }), + privateKeyToPem: () => "private-key-pem", + certificateToPem: () => "certificate-pem", + }, + md: { + sha1: { create: () => "sha1" }, + sha256: { create: () => "sha256" }, + }, + }, + }); + + const { getCaCertPath } = await import("./certUtils.js"); + + assert.strictEqual( + getCaCertPath(), + "/custom/safe-chain/certs/ca-cert.pem", + ); + }); +}); diff --git a/packages/safe-chain/src/registryProxy/getConnectTimeout.js b/packages/safe-chain/src/registryProxy/getConnectTimeout.js new file mode 100644 index 0000000..2945be4 --- /dev/null +++ b/packages/safe-chain/src/registryProxy/getConnectTimeout.js @@ -0,0 +1,13 @@ +import { isImdsEndpoint } from "./isImdsEndpoint.js"; + +/** + * Returns appropriate connection timeout for a host. + * - IMDS endpoints: 3s (fail fast when outside cloud, reduce 5min delay to ~20s) + * - Other endpoints: 30s (allow for slow networks while preventing indefinite hangs) + */ +export function getConnectTimeout(/** @type {string} */ host) { + if (isImdsEndpoint(host)) { + return 3000; + } + return 30000; +} diff --git a/packages/safe-chain/src/registryProxy/http-utils.js b/packages/safe-chain/src/registryProxy/http-utils.js index e14a977..8e2f8e2 100644 --- a/packages/safe-chain/src/registryProxy/http-utils.js +++ b/packages/safe-chain/src/registryProxy/http-utils.js @@ -15,3 +15,66 @@ export function getHeaderValueAsString(headers, headerName) { return header; } + +/** + * Returns a copy of headers without the provided header names, matched + * either exactly or case-insensitively. + * + * @param {NodeJS.Dict | undefined} headers + * @param {string[]} headerNames + * @param {{ caseInsensitive?: boolean }} [options] + * @returns {NodeJS.Dict | undefined} + */ +export function omitHeaders(headers, headerNames, options = {}) { + if (!headers) { + return headers; + } + + const omittedHeaderNames = new Set( + options.caseInsensitive + ? headerNames.map((name) => name.toLowerCase()) + : headerNames + ); + /** @type {NodeJS.Dict} */ + const filteredHeaders = {}; + + for (const [headerName, value] of Object.entries(headers)) { + const comparableHeaderName = options.caseInsensitive + ? headerName.toLowerCase() + : headerName; + if (!omittedHeaderNames.has(comparableHeaderName)) { + filteredHeaders[headerName] = value; + } + } + + return filteredHeaders; +} + +/** + * Remove headers that become stale when the response body is modified. + * + * @param {NodeJS.Dict | undefined} headers + * @returns {void} + */ +export function clearCachingHeaders(headers) { + if (!headers) { + return; + } + + const filteredHeaders = omitHeaders(headers, [ + "etag", + "last-modified", + "cache-control", + "content-length", + ]); + + if (!filteredHeaders) { + return; + } + + for (const key of Object.keys(headers)) { + delete headers[key]; + } + + Object.assign(headers, filteredHeaders); +} diff --git a/packages/safe-chain/src/registryProxy/interceptors/createInterceptorForEcoSystem.js b/packages/safe-chain/src/registryProxy/interceptors/createInterceptorForEcoSystem.js index 79b5200..869af81 100644 --- a/packages/safe-chain/src/registryProxy/interceptors/createInterceptorForEcoSystem.js +++ b/packages/safe-chain/src/registryProxy/interceptors/createInterceptorForEcoSystem.js @@ -4,7 +4,7 @@ import { getEcoSystem, } from "../../config/settings.js"; import { npmInterceptorForUrl } from "./npm/npmInterceptor.js"; -import { pipInterceptorForUrl } from "./pipInterceptor.js"; +import { pipInterceptorForUrl } from "./pip/pipInterceptor.js"; /** * @param {string} url diff --git a/packages/safe-chain/src/registryProxy/interceptors/interceptorBuilder.js b/packages/safe-chain/src/registryProxy/interceptors/interceptorBuilder.js index e25e641..fbfc131 100644 --- a/packages/safe-chain/src/registryProxy/interceptors/interceptorBuilder.js +++ b/packages/safe-chain/src/registryProxy/interceptors/interceptorBuilder.js @@ -10,6 +10,7 @@ import { EventEmitter } from "events"; * @typedef {Object} RequestInterceptionContext * @property {string} targetUrl * @property {(packageName: string | undefined, version: string | undefined) => void} blockMalware + * @property {(packageName: string, version: string, message: string) => void} blockMinimumAgeRequest * @property {(modificationFunc: (headers: NodeJS.Dict) => NodeJS.Dict) => void} modifyRequestHeaders * @property {(modificationFunc: (body: Buffer, headers: NodeJS.Dict | undefined) => Buffer) => void} modifyBody * @property {() => RequestInterceptionHandler} build @@ -20,6 +21,18 @@ import { EventEmitter } from "events"; * @property {(headers: NodeJS.Dict | undefined) => NodeJS.Dict | undefined} modifyRequestHeaders * @property {() => boolean} modifiesResponse * @property {(body: Buffer, headers: NodeJS.Dict | undefined) => Buffer} modifyBody + * + * @typedef {Object} MalwareBlockedEvent + * @property {string} packageName + * @property {string} version + * @property {string} targetUrl + * @property {number} timestamp + * + * @typedef {Object} MinimumAgeRequestBlockedEvent + * @property {string} packageName + * @property {string} version + * @property {string} targetUrl + * @property {number} timestamp */ /** @@ -75,10 +88,7 @@ function createRequestContext(targetUrl, eventEmitter) { * @param {string | undefined} version */ function blockMalwareSetup(packageName, version) { - blockResponse = { - statusCode: 403, - message: "Forbidden - blocked by safe-chain", - }; + blockResponse = createBlockResponse("Forbidden - blocked by safe-chain"); // Emit the malwareBlocked event eventEmitter.emit("malwareBlocked", { @@ -89,6 +99,34 @@ function createRequestContext(targetUrl, eventEmitter) { }); } + /** + * @param {string} message + */ + function blockMinimumAgeRequestSetup( + /** @type {string} */ packageName, + /** @type {string} */ version, + /** @type {string} */ message + ) { + blockResponse = createBlockResponse(message); + eventEmitter.emit("minimumAgeRequestBlocked", { + packageName, + version, + targetUrl, + timestamp: Date.now(), + }); + } + + /** + * @param {string} message + * @returns {{statusCode: number, message: string}} + */ + function createBlockResponse(message) { + return { + statusCode: 403, + message, + }; + } + /** @returns {RequestInterceptionHandler} */ function build() { /** @@ -133,6 +171,7 @@ function createRequestContext(targetUrl, eventEmitter) { return { targetUrl, blockMalware: blockMalwareSetup, + blockMinimumAgeRequest: blockMinimumAgeRequestSetup, modifyRequestHeaders: (func) => reqheaderModificationFuncs.push(func), modifyBody: (func) => modifyBodyFuncs.push(func), build, diff --git a/packages/safe-chain/src/registryProxy/interceptors/minimumPackageAgeExclusions.js b/packages/safe-chain/src/registryProxy/interceptors/minimumPackageAgeExclusions.js new file mode 100644 index 0000000..05a86ea --- /dev/null +++ b/packages/safe-chain/src/registryProxy/interceptors/minimumPackageAgeExclusions.js @@ -0,0 +1,33 @@ +import { getMinimumPackageAgeExclusions, getEcoSystem } from "../../config/settings.js"; +import { getEquivalentPackageNames } from "../../scanning/packageNameVariants.js"; + +/** + * Checks if a package name matches an exclusion pattern. + * Supports trailing wildcard (*) for prefix matching. + * @param {string} packageName + * @param {string} pattern + * @returns {boolean} + */ +export function matchesExclusionPattern(packageName, pattern) { + if (pattern.endsWith("/*")) { + return packageName.startsWith(pattern.slice(0, -1)); + } + return packageName === pattern; +} + +/** + * @param {string | undefined} packageName + * @returns {boolean} + */ +export function isExcludedFromMinimumPackageAge(packageName) { + if (!packageName) { + return false; + } + + const exclusions = getMinimumPackageAgeExclusions(); + const candidateNames = getEquivalentPackageNames(packageName, getEcoSystem()); + + return exclusions.some((pattern) => + candidateNames.some((name) => matchesExclusionPattern(name, pattern)) + ); +} diff --git a/packages/safe-chain/src/registryProxy/interceptors/npm/modifyNpmInfo.js b/packages/safe-chain/src/registryProxy/interceptors/npm/modifyNpmInfo.js index 2ee4eb8..26b3b70 100644 --- a/packages/safe-chain/src/registryProxy/interceptors/npm/modifyNpmInfo.js +++ b/packages/safe-chain/src/registryProxy/interceptors/npm/modifyNpmInfo.js @@ -1,10 +1,7 @@ import { getMinimumPackageAgeHours } from "../../../config/settings.js"; import { ui } from "../../../environment/userInteraction.js"; -import { getHeaderValueAsString } from "../../http-utils.js"; - -const state = { - hasSuppressedVersions: false, -}; +import { clearCachingHeaders, getHeaderValueAsString } from "../../http-utils.js"; +import { recordSuppressedVersion } from "../suppressedVersionsState.js"; /** * @param {NodeJS.Dict} headers @@ -82,15 +79,7 @@ export function modifyNpmInfoResponse(body, headers) { const timestampValue = new Date(timestamp); if (timestampValue > cutOff) { deleteVersionFromJson(bodyJson, version); - if (headers) { - // When modifying the response, the etag and last-modified headers - // no longer match the content so they needs to be removed before sending the response. - delete headers["etag"]; - delete headers["last-modified"]; - // Removing the cache-control header will prevent the package manager from caching - // the modified response. - delete headers["cache-control"]; - } + clearCachingHeaders(headers); } } @@ -114,10 +103,12 @@ export function modifyNpmInfoResponse(body, headers) { * @param {string} version */ function deleteVersionFromJson(json, version) { - state.hasSuppressedVersions = true; + recordSuppressedVersion(); + + const packageName = typeof json?.name === "string" ? json.name : "(unknown)"; ui.writeVerbose( - `Safe-chain: ${version} is newer than ${getMinimumPackageAgeHours()} hours and was removed (minimumPackageAgeInHours setting).` + `Safe-chain: ${packageName}@${version} is newer than ${getMinimumPackageAgeHours()} hours and was removed (minimumPackageAgeInHours setting).` ); delete json.time[version]; @@ -170,8 +161,20 @@ function getMostRecentTag(tagList) { } /** - * @returns {boolean} + * @param {Buffer} body + * @param {NodeJS.Dict | undefined} headers + * @returns {string | undefined} */ -export function getHasSuppressedVersions() { - return state.hasSuppressedVersions; +export function getPackageNameFromMetadataResponse(body, headers) { + try { + const contentType = getHeaderValueAsString(headers, "content-type"); + if (!contentType?.toLowerCase().includes("application/json")) { + return undefined; + } + + const bodyJson = JSON.parse(body.toString("utf8")); + return typeof bodyJson.name === "string" ? bodyJson.name : undefined; + } catch { + return undefined; + } } diff --git a/packages/safe-chain/src/registryProxy/interceptors/npm/npmInterceptor.js b/packages/safe-chain/src/registryProxy/interceptors/npm/npmInterceptor.js index eaf50db..8caae84 100644 --- a/packages/safe-chain/src/registryProxy/interceptors/npm/npmInterceptor.js +++ b/packages/safe-chain/src/registryProxy/interceptors/npm/npmInterceptor.js @@ -1,21 +1,35 @@ -import { skipMinimumPackageAge } from "../../../config/settings.js"; +import { + getNpmCustomRegistries, + skipMinimumPackageAge, +} from "../../../config/settings.js"; import { isMalwarePackage } from "../../../scanning/audit/index.js"; import { interceptRequests } from "../interceptorBuilder.js"; import { + getPackageNameFromMetadataResponse, isPackageInfoUrl, modifyNpmInfoRequestHeaders, modifyNpmInfoResponse, } from "./modifyNpmInfo.js"; import { parseNpmPackageUrl } from "./parseNpmPackageUrl.js"; +import { openNewPackagesDatabase } from "../../../scanning/newPackagesListCache.js"; +import { + isExcludedFromMinimumPackageAge, +} from "../minimumPackageAgeExclusions.js"; -const knownJsRegistries = ["registry.npmjs.org", "registry.yarnpkg.com"]; +const knownJsRegistries = [ + "registry.npmjs.org", + "registry.yarnpkg.com", + "registry.npmjs.com", +]; /** * @param {string} url * @returns {import("../interceptorBuilder.js").Interceptor | undefined} */ export function npmInterceptorForUrl(url) { - const registry = knownJsRegistries.find((reg) => url.includes(reg)); + const registry = [...knownJsRegistries, ...getNpmCustomRegistries()].find( + (reg) => url.includes(reg) + ); if (registry) { return buildNpmInterceptor(registry); @@ -34,14 +48,54 @@ function buildNpmInterceptor(registry) { reqContext.targetUrl, registry ); + const minimumAgeChecksEnabled = !skipMinimumPackageAge(); if (await isMalwarePackage(packageName, version)) { reqContext.blockMalware(packageName, version); + return; } - if (!skipMinimumPackageAge() && isPackageInfoUrl(reqContext.targetUrl)) { + if (minimumAgeChecksEnabled && isPackageInfoUrl(reqContext.targetUrl)) { reqContext.modifyRequestHeaders(modifyNpmInfoRequestHeaders); - reqContext.modifyBody(modifyNpmInfoResponse); + reqContext.modifyBody(modifyNpmInfoResponseUnlessExcluded); + return; + } + + // For tarball requests the metadata check above is skipped, so we check the + // new packages list as a fallback (covers e.g. frozen-lockfile installs). + if ( + minimumAgeChecksEnabled && + packageName && + version && + !isExcludedFromMinimumPackageAge(packageName) + ) { + const newPackagesDatabase = await openNewPackagesDatabase(); + + if (newPackagesDatabase.isNewlyReleasedPackage(packageName, version)) { + reqContext.blockMinimumAgeRequest( + packageName, + version, + `Forbidden - blocked by safe-chain direct download minimum package age (${packageName}@${version})` + ); + } } }); } + +/** + * @param {Buffer} body + * @param {NodeJS.Dict | undefined} headers + * @returns {Buffer} + */ +function modifyNpmInfoResponseUnlessExcluded(body, headers) { + const metadataPackageName = getPackageNameFromMetadataResponse(body, headers); + + if ( + metadataPackageName && + isExcludedFromMinimumPackageAge(metadataPackageName) + ) { + return body; + } + + return modifyNpmInfoResponse(body, headers); +} diff --git a/packages/safe-chain/src/registryProxy/interceptors/npm/npmInterceptor.minPackageAge.spec.js b/packages/safe-chain/src/registryProxy/interceptors/npm/npmInterceptor.minPackageAge.spec.js index 999e64a..cdd38ef 100644 --- a/packages/safe-chain/src/registryProxy/interceptors/npm/npmInterceptor.minPackageAge.spec.js +++ b/packages/safe-chain/src/registryProxy/interceptors/npm/npmInterceptor.minPackageAge.spec.js @@ -4,11 +4,26 @@ import assert from "node:assert"; describe("npmInterceptor minimum package age", async () => { let minimumPackageAgeSettings = 48; let skipMinimumPackageAgeSetting = false; + let minimumPackageAgeExclusionsSetting = []; + let newlyReleasedPackages = new Set(); mock.module("../../../config/settings.js", { namedExports: { + ECOSYSTEM_JS: "js", + ECOSYSTEM_PY: "py", getMinimumPackageAgeHours: () => minimumPackageAgeSettings, skipMinimumPackageAge: () => skipMinimumPackageAgeSetting, + getNpmCustomRegistries: () => [], + getMinimumPackageAgeExclusions: () => minimumPackageAgeExclusionsSetting, + getEcoSystem: () => "js", + }, + }); + mock.module("../../../scanning/newPackagesListCache.js", { + namedExports: { + openNewPackagesDatabase: async () => ({ + isNewlyReleasedPackage: (name, version) => + newlyReleasedPackages.has(`${name}@${version}`), + }), }, }); @@ -356,6 +371,274 @@ describe("npmInterceptor minimum package age", async () => { assert.equal(modifiedJson["dist-tags"]["latest"], "2.0.0"); }); + it("Should suppress too-young versions on metadata requests without directly blocking the request", async () => { + minimumPackageAgeSettings = 5; + skipMinimumPackageAgeSetting = false; + const packageUrl = "https://registry.npmjs.org/lodash"; + + const interceptor = npmInterceptorForUrl(packageUrl); + const requestHandler = await interceptor.handleRequest(packageUrl); + + assert.equal(requestHandler.blockResponse, undefined); + assert.equal(requestHandler.modifiesResponse(), true); + }); + + it("Should directly block tarball requests when the new packages list marks them as too young", async () => { + minimumPackageAgeSettings = 5; + skipMinimumPackageAgeSetting = false; + newlyReleasedPackages = new Set(["lodash@4.17.21"]); + const packageUrl = + "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz?integrity=sha512-abc123"; + + const interceptor = npmInterceptorForUrl(packageUrl); + const requestHandler = await interceptor.handleRequest(packageUrl); + + assert.ok(requestHandler.blockResponse); + assert.equal(requestHandler.modifiesResponse(), false); + assert.equal(requestHandler.blockResponse.statusCode, 403); + assert.equal( + requestHandler.blockResponse.message, + "Forbidden - blocked by safe-chain direct download minimum package age (lodash@4.17.21)" + ); + }); + + it("Should not block tarball requests when skipMinimumPackageAge is enabled", async () => { + minimumPackageAgeSettings = 5; + skipMinimumPackageAgeSetting = true; + minimumPackageAgeExclusionsSetting = []; + newlyReleasedPackages = new Set(["lodash@4.17.21"]); + const packageUrl = + "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz"; + + const interceptor = npmInterceptorForUrl(packageUrl); + const requestHandler = await interceptor.handleRequest(packageUrl); + + assert.equal(requestHandler.blockResponse, undefined); + assert.equal(requestHandler.modifiesResponse(), false); + }); + + it("Should not block tarball requests when the package is excluded from minimum age", async () => { + minimumPackageAgeSettings = 5; + skipMinimumPackageAgeSetting = false; + minimumPackageAgeExclusionsSetting = ["lodash"]; + newlyReleasedPackages = new Set(["lodash@4.17.21"]); + const packageUrl = + "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz"; + + const interceptor = npmInterceptorForUrl(packageUrl); + const requestHandler = await interceptor.handleRequest(packageUrl); + + assert.equal(requestHandler.blockResponse, undefined); + assert.equal(requestHandler.modifiesResponse(), false); + }); + + it("Should not filter packages when package is in exclusion list", async () => { + minimumPackageAgeSettings = 5; + skipMinimumPackageAgeSetting = false; + minimumPackageAgeExclusionsSetting = ["lodash"]; + + const packageUrl = "https://registry.npmjs.org/lodash"; + + const originalBody = JSON.stringify({ + name: "lodash", + ["dist-tags"]: { + latest: "3.0.0", + }, + versions: { + ["1.0.0"]: {}, + ["2.0.0"]: {}, + ["3.0.0"]: {}, + }, + time: { + created: getDate(-365 * 24), + modified: getDate(-3), + ["1.0.0"]: getDate(-7), + // cutoff-date here + ["2.0.0"]: getDate(-4), + ["3.0.0"]: getDate(-3), // Would normally be filtered + }, + }); + + const modifiedBody = await runModifyNpmInfoRequest(packageUrl, originalBody); + const modifiedJson = JSON.parse(modifiedBody); + + // All versions should remain unchanged since lodash is excluded + assert.equal(Object.keys(modifiedJson.versions).length, 3); + assert.ok(Object.keys(modifiedJson.versions).includes("1.0.0")); + assert.ok(Object.keys(modifiedJson.versions).includes("2.0.0")); + assert.ok(Object.keys(modifiedJson.versions).includes("3.0.0")); + assert.equal(modifiedJson["dist-tags"]["latest"], "3.0.0"); + }); + + it("Should filter packages when package is NOT in exclusion list", async () => { + minimumPackageAgeSettings = 5; + skipMinimumPackageAgeSetting = false; + minimumPackageAgeExclusionsSetting = ["react"]; // Different package + + const packageUrl = "https://registry.npmjs.org/lodash"; + + const modifiedBody = await runModifyNpmInfoRequest( + packageUrl, + JSON.stringify({ + name: "lodash", + ["dist-tags"]: { latest: "3.0.0" }, + versions: { ["1.0.0"]: {}, ["3.0.0"]: {} }, + time: { + created: getDate(-365 * 24), + modified: getDate(-3), + ["1.0.0"]: getDate(-7), + ["3.0.0"]: getDate(-3), + }, + }) + ); + + const modifiedJson = JSON.parse(modifiedBody); + + // lodash should still be filtered since it's not in exclusions + assert.equal(Object.keys(modifiedJson.versions).length, 1); + assert.ok(Object.keys(modifiedJson.versions).includes("1.0.0")); + assert.ok(!Object.keys(modifiedJson.versions).includes("3.0.0")); + }); + + it("Should handle scoped packages in exclusion list", async () => { + minimumPackageAgeSettings = 5; + skipMinimumPackageAgeSetting = false; + minimumPackageAgeExclusionsSetting = ["@babel/core"]; + + const packageUrl = "https://registry.npmjs.org/@babel/core"; + + const originalBody = JSON.stringify({ + name: "@babel/core", + ["dist-tags"]: { latest: "7.0.0" }, + versions: { ["6.0.0"]: {}, ["7.0.0"]: {} }, + time: { + created: getDate(-365 * 24), + modified: getDate(-1), + ["6.0.0"]: getDate(-100), + ["7.0.0"]: getDate(-1), // Would normally be filtered + }, + }); + + const modifiedBody = await runModifyNpmInfoRequest(packageUrl, originalBody); + const modifiedJson = JSON.parse(modifiedBody); + + // All versions should remain for excluded scoped package + assert.equal(Object.keys(modifiedJson.versions).length, 2); + assert.ok(Object.keys(modifiedJson.versions).includes("6.0.0")); + assert.ok(Object.keys(modifiedJson.versions).includes("7.0.0")); + }); + + it("Should handle multiple packages in exclusion list", async () => { + minimumPackageAgeSettings = 5; + skipMinimumPackageAgeSetting = false; + minimumPackageAgeExclusionsSetting = ["react", "lodash", "@types/node"]; + + const packageUrl = "https://registry.npmjs.org/lodash"; + + const originalBody = JSON.stringify({ + name: "lodash", + ["dist-tags"]: { latest: "2.0.0" }, + versions: { ["1.0.0"]: {}, ["2.0.0"]: {} }, + time: { + created: getDate(-365 * 24), + modified: getDate(-1), + ["1.0.0"]: getDate(-100), + ["2.0.0"]: getDate(-1), + }, + }); + + const modifiedBody = await runModifyNpmInfoRequest(packageUrl, originalBody); + const modifiedJson = JSON.parse(modifiedBody); + + // All versions should remain since lodash is in the exclusion list + assert.equal(Object.keys(modifiedJson.versions).length, 2); + }); + + it("Should exclude packages matching wildcard pattern @scope/*", async () => { + minimumPackageAgeSettings = 5; + skipMinimumPackageAgeSetting = false; + minimumPackageAgeExclusionsSetting = ["@aikidosec/*"]; + + const packageUrl = "https://registry.npmjs.org/@aikidosec/safe-chain"; + + const originalBody = JSON.stringify({ + name: "@aikidosec/safe-chain", + ["dist-tags"]: { latest: "2.0.0" }, + versions: { ["1.0.0"]: {}, ["2.0.0"]: {} }, + time: { + created: getDate(-365 * 24), + modified: getDate(-1), + ["1.0.0"]: getDate(-100), + ["2.0.0"]: getDate(-1), // Would normally be filtered + }, + }); + + const modifiedBody = await runModifyNpmInfoRequest(packageUrl, originalBody); + const modifiedJson = JSON.parse(modifiedBody); + + // All versions should remain since @aikidosec/* matches @aikidosec/safe-chain + assert.equal(Object.keys(modifiedJson.versions).length, 2); + assert.ok(Object.keys(modifiedJson.versions).includes("1.0.0")); + assert.ok(Object.keys(modifiedJson.versions).includes("2.0.0")); + }); + + it("Should NOT exclude packages that don't match wildcard pattern", async () => { + minimumPackageAgeSettings = 5; + skipMinimumPackageAgeSetting = false; + minimumPackageAgeExclusionsSetting = ["@aikidosec/*"]; + + const packageUrl = "https://registry.npmjs.org/@other/package"; + + const originalBody = JSON.stringify({ + name: "@other/package", + ["dist-tags"]: { latest: "2.0.0" }, + versions: { ["1.0.0"]: {}, ["2.0.0"]: {} }, + time: { + created: getDate(-365 * 24), + modified: getDate(-1), + ["1.0.0"]: getDate(-100), + ["2.0.0"]: getDate(-1), + }, + }); + + const modifiedBody = await runModifyNpmInfoRequest(packageUrl, originalBody); + const modifiedJson = JSON.parse(modifiedBody); + + // Version 2.0.0 should be filtered since @other/package doesn't match @aikidosec/* + assert.equal(Object.keys(modifiedJson.versions).length, 1); + assert.ok(Object.keys(modifiedJson.versions).includes("1.0.0")); + }); + + it("Should reset exclusions between tests", async () => { + minimumPackageAgeSettings = 5; + skipMinimumPackageAgeSetting = false; + minimumPackageAgeExclusionsSetting = []; // Reset to empty + newlyReleasedPackages = new Set(); + + const packageUrl = "https://registry.npmjs.org/lodash"; + + const modifiedBody = await runModifyNpmInfoRequest( + packageUrl, + JSON.stringify({ + name: "lodash", + ["dist-tags"]: { latest: "2.0.0" }, + versions: { ["1.0.0"]: {}, ["2.0.0"]: {} }, + time: { + created: getDate(-365 * 24), + modified: getDate(-1), + ["1.0.0"]: getDate(-100), + ["2.0.0"]: getDate(-1), + }, + }) + ); + + const modifiedJson = JSON.parse(modifiedBody); + + // Version 2.0.0 should be filtered since exclusions are empty + assert.equal(Object.keys(modifiedJson.versions).length, 1); + assert.ok(Object.keys(modifiedJson.versions).includes("1.0.0")); + }); + function getDate(plusHours) { const date = new Date(); date.setHours(date.getHours() + plusHours); diff --git a/packages/safe-chain/src/registryProxy/interceptors/npm/npmInterceptor.packageDownload.spec.js b/packages/safe-chain/src/registryProxy/interceptors/npm/npmInterceptor.packageDownload.spec.js index a90432e..769b6e1 100644 --- a/packages/safe-chain/src/registryProxy/interceptors/npm/npmInterceptor.packageDownload.spec.js +++ b/packages/safe-chain/src/registryProxy/interceptors/npm/npmInterceptor.packageDownload.spec.js @@ -1,21 +1,57 @@ -import { describe, it, mock } from "node:test"; +import { describe, it, mock, beforeEach } from "node:test"; import assert from "node:assert"; -describe("npmInterceptor", async () => { - let lastPackage; - let malwareResponse = false; +let lastPackage; +let malwareResponse = false; +let customRegistries = []; +let newlyReleasedPackages = new Set(); +let skipMinimumPackageAgeSetting = false; - mock.module("../../../scanning/audit/index.js", { - namedExports: { - isMalwarePackage: async (packageName, version) => { - lastPackage = { packageName, version }; - return malwareResponse; - }, +mock.module("../../../scanning/audit/index.js", { + namedExports: { + isMalwarePackage: async (packageName, version) => { + lastPackage = { packageName, version }; + return malwareResponse; }, - }); + }, +}); +mock.module("../../../config/settings.js", { + namedExports: { + LOGGING_SILENT: "silent", + LOGGING_NORMAL: "normal", + LOGGING_VERBOSE: "verbose", + ECOSYSTEM_JS: "js", + ECOSYSTEM_PY: "py", + getLoggingLevel: () => "normal", + getEcoSystem: () => "js", + setEcoSystem: () => {}, + getMinimumPackageAgeHours: () => 24, + getNpmCustomRegistries: () => customRegistries, + getMinimumPackageAgeExclusions: () => [], + skipMinimumPackageAge: () => skipMinimumPackageAgeSetting, + }, +}); +mock.module("../../../scanning/newPackagesListCache.js", { + namedExports: { + openNewPackagesDatabase: async () => ({ + isNewlyReleasedPackage: (name, version) => + newlyReleasedPackages.has(`${name}@${version}`), + }), + }, +}); + +describe("npmInterceptor", async () => { const { npmInterceptorForUrl } = await import("./npmInterceptor.js"); + beforeEach(() => { + lastPackage = undefined; + malwareResponse = false; + customRegistries = []; + newlyReleasedPackages = new Set(); + skipMinimumPackageAgeSetting = false; + }); + const parserCases = [ // Regular packages { @@ -91,6 +127,10 @@ describe("npmInterceptor", async () => { url: "https://registry.yarnpkg.com/@babel/core/-/core-7.21.4.tgz", expected: { packageName: "@babel/core", version: "7.21.4" }, }, + { + url: "https://registry.yarnpkg.com/@music-i18n%2fverovio/-/verovio-1.4.1.tgz", + expected: { packageName: "@music-i18n/verovio", version: "1.4.1" }, + }, // URL to get package info, not tarball { url: "https://registry.npmjs.org/lodash", @@ -160,4 +200,121 @@ describe("npmInterceptor", async () => { "Block response should have correct status message" ); }); + + it("should block direct tarball downloads for newly released packages", async () => { + const url = + "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz?integrity=sha512-abc123"; + malwareResponse = false; + skipMinimumPackageAgeSetting = false; + newlyReleasedPackages = new Set(["lodash@4.17.21"]); + + const interceptor = npmInterceptorForUrl(url); + const result = await interceptor.handleRequest(url); + + assert.ok(result.blockResponse); + assert.equal(result.blockResponse.statusCode, 403); + assert.equal( + result.blockResponse.message, + "Forbidden - blocked by safe-chain direct download minimum package age (lodash@4.17.21)" + ); + }); + + it("should not block direct tarball downloads when minimum age checks are skipped", async () => { + const url = "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz"; + malwareResponse = false; + skipMinimumPackageAgeSetting = true; + newlyReleasedPackages = new Set(["lodash@4.17.21"]); + + const interceptor = npmInterceptorForUrl(url); + const result = await interceptor.handleRequest(url); + + assert.equal(result.blockResponse, undefined); + }); +}); + +describe("npmInterceptor with custom registries", async () => { + const { npmInterceptorForUrl } = await import("./npmInterceptor.js"); + + it("should create interceptor for custom registry", async () => { + // Set custom registries for this test + customRegistries = ["npm.company.com", "registry.internal.net"]; + const url = "https://npm.company.com/lodash/-/lodash-4.17.21.tgz"; + + const interceptor = npmInterceptorForUrl(url); + + assert.ok(interceptor, "Interceptor should be created for custom registry"); + + await interceptor.handleRequest(url); + + assert.deepEqual(lastPackage, { + packageName: "lodash", + version: "4.17.21", + }); + }); + + it("should create interceptor for custom registry with scoped packages", async () => { + // Set custom registries for this test + customRegistries = ["npm.company.com", "registry.internal.net"]; + malwareResponse = false; + + const url = + "https://registry.internal.net/@company/package/-/package-1.0.0.tgz"; + + const interceptor = npmInterceptorForUrl(url); + + assert.ok( + interceptor, + "Interceptor should be created for custom registry with scoped package" + ); + + await interceptor.handleRequest(url); + + assert.deepEqual(lastPackage, { + packageName: "@company/package", + version: "1.0.0", + }); + }); + + it("should handle multiple custom registries", async () => { + // Set custom registries for this test + customRegistries = ["npm.company.com", "registry.internal.net"]; + malwareResponse = false; + + const url1 = "https://npm.company.com/lodash/-/lodash-4.17.21.tgz"; + const url2 = "https://registry.internal.net/express/-/express-4.18.2.tgz"; + + const interceptor1 = npmInterceptorForUrl(url1); + const interceptor2 = npmInterceptorForUrl(url2); + + assert.ok(interceptor1, "Should create interceptor for first registry"); + assert.ok(interceptor2, "Should create interceptor for second registry"); + + await interceptor1.handleRequest(url1); + assert.deepEqual(lastPackage, { + packageName: "lodash", + version: "4.17.21", + }); + + await interceptor2.handleRequest(url2); + assert.deepEqual(lastPackage, { + packageName: "express", + version: "4.18.2", + }); + }); + + it("should not create interceptor for non-custom registry", () => { + // Set custom registries for this test + customRegistries = ["npm.company.com", "registry.internal.net"]; + malwareResponse = false; + + const url = "https://unknown.registry.com/package/-/package-1.0.0.tgz"; + + const interceptor = npmInterceptorForUrl(url); + + assert.equal( + interceptor, + undefined, + "Should not create interceptor for unknown registry" + ); + }); }); diff --git a/packages/safe-chain/src/registryProxy/interceptors/npm/parseNpmPackageUrl.js b/packages/safe-chain/src/registryProxy/interceptors/npm/parseNpmPackageUrl.js index fa256d4..13cb99a 100644 --- a/packages/safe-chain/src/registryProxy/interceptors/npm/parseNpmPackageUrl.js +++ b/packages/safe-chain/src/registryProxy/interceptors/npm/parseNpmPackageUrl.js @@ -5,12 +5,29 @@ */ export function parseNpmPackageUrl(url, registry) { let packageName, version; - if (!registry || !url.endsWith(".tgz")) { + let parsedUrl; + + try { + parsedUrl = new URL(url); + } catch { return { packageName, version }; } - const registryIndex = url.indexOf(registry); - const afterRegistry = url.substring(registryIndex + registry.length + 1); // +1 to skip the slash + const pathname = parsedUrl.pathname; + + if (!registry || !pathname.endsWith(".tgz")) { + return { packageName, version }; + } + + const registryPrefix = `${registry}/`; + const urlAfterProtocol = `${parsedUrl.host}${pathname}`; + if (!urlAfterProtocol.startsWith(registryPrefix)) { + return { packageName, version }; + } + + const afterRegistry = decodeURIComponent( + urlAfterProtocol.substring(registryPrefix.length) + ); const separatorIndex = afterRegistry.indexOf("/-/"); if (separatorIndex === -1) { diff --git a/packages/safe-chain/src/registryProxy/interceptors/pip/modifyPipInfo.js b/packages/safe-chain/src/registryProxy/interceptors/pip/modifyPipInfo.js new file mode 100644 index 0000000..ef0ab18 --- /dev/null +++ b/packages/safe-chain/src/registryProxy/interceptors/pip/modifyPipInfo.js @@ -0,0 +1,184 @@ +import { ui } from "../../../environment/userInteraction.js"; +import { clearCachingHeaders } from "../../http-utils.js"; +import { normalizePipPackageName } from "../../../scanning/packageNameVariants.js"; +import { parsePipPackageFromUrl } from "./parsePipPackageUrl.js"; +export { parsePipMetadataUrl, isPipPackageInfoUrl } from "./parsePipPackageUrl.js"; +import { getPipMetadataContentType, logSuppressedVersion } from "./pipMetadataResponseUtils.js"; +import { modifyPipJsonResponse } from "./modifyPipJsonResponse.js"; + +/** + * Strip conditional GET headers so PyPI always returns a full 200 response + * with a body we can rewrite. Without this, pip sends If-None-Match / + * If-Modified-Since, PyPI responds 304 Not Modified (empty body), and + * safe-chain cannot rewrite it — leaving pip with a cached index that still + * lists too-young versions. Those versions are then blocked at direct-download + * time with a hard 403, preventing dependency resolution from completing. + * + * @param {NodeJS.Dict} headers + * @returns {NodeJS.Dict} + */ +export function modifyPipInfoRequestHeaders(headers) { + delete headers["if-none-match"]; + delete headers["if-modified-since"]; + return headers; +} + +// Match simple-index anchor tags and capture their href so we can suppress +// individual distribution links from PyPI HTML metadata responses. +const HTML_ANCHOR_HREF_RE = + /]*href\s*=\s*(["'])([^"']+)\1[^>]*>[\s\S]*?<\/a>/gi; + +/** + * @param {Buffer} body + * @param {NodeJS.Dict | undefined} headers + * @param {string} metadataUrl + * @param {(packageName: string | undefined, version: string | undefined) => boolean} isNewlyReleasedPackage + * @param {string} packageName + * @returns {Buffer} + */ +export function modifyPipInfoResponse( + body, + headers, + metadataUrl, + isNewlyReleasedPackage, + packageName +) { + try { + const contentType = getPipMetadataContentType(headers); + + if (!contentType || body.byteLength === 0) { + return body; + } + + if ( + contentType.includes("html") || + contentType.includes("application/vnd.pypi.simple.v1+html") + ) { + return modifyHtmlSimpleResponse( + body, + headers, + metadataUrl, + isNewlyReleasedPackage, + packageName + ); + } + + if ( + contentType.includes("json") || + contentType.includes("application/vnd.pypi.simple.v1+json") + ) { + return modifyJsonResponse( + body, + headers, + metadataUrl, + isNewlyReleasedPackage, + packageName + ); + } + + return body; + } catch (/** @type {any} */ err) { + ui.writeVerbose( + `Safe-chain: PyPI package metadata not in expected format - bypassing modification. Error: ${err.message}` + ); + return body; + } +} + +/** + * @param {Buffer} body + * @param {NodeJS.Dict | undefined} headers + * @param {string} metadataUrl + * @param {(packageName: string | undefined, version: string | undefined) => boolean} isNewlyReleasedPackage + * @param {string} packageName + * @returns {Buffer} + */ +function modifyHtmlSimpleResponse( + body, + headers, + metadataUrl, + isNewlyReleasedPackage, + packageName +) { + const html = body.toString("utf8"); + let modified = false; + const rewriteHtmlAnchor = createHtmlAnchorRewriter( + metadataUrl, + isNewlyReleasedPackage, + packageName, + () => { + modified = true; + } + ); + const updatedHtml = html.replace(HTML_ANCHOR_HREF_RE, rewriteHtmlAnchor); + + if (!modified) return body; + const modifiedBuffer = Buffer.from(updatedHtml); + clearCachingHeaders(headers); + return modifiedBuffer; +} + +/** + * @param {string} metadataUrl + * @param {(packageName: string | undefined, version: string | undefined) => boolean} isNewlyReleasedPackage + * @param {string} packageName + * @param {() => void} onModified + * @returns {(anchor: string, quote: string, href: string) => string} + */ +function createHtmlAnchorRewriter( + metadataUrl, + isNewlyReleasedPackage, + packageName, + onModified +) { + return (anchor, _quote, href) => { + const resolvedHref = new URL(href, metadataUrl).toString(); + const { packageName: hrefPackageName, version } = parsePipPackageFromUrl( + resolvedHref, + new URL(resolvedHref).host + ); + + if ( + hrefPackageName && + normalizePipPackageName(hrefPackageName) === + normalizePipPackageName(packageName) && + version && + isNewlyReleasedPackage(packageName, version) + ) { + onModified(); + logSuppressedVersion(packageName, version); + return ""; + } + + return anchor; + }; +} + +/** + * @param {Buffer} body + * @param {NodeJS.Dict | undefined} headers + * @param {string} metadataUrl + * @param {(packageName: string | undefined, version: string | undefined) => boolean} isNewlyReleasedPackage + * @param {string} packageName + * @returns {Buffer} + */ +function modifyJsonResponse( + body, + headers, + metadataUrl, + isNewlyReleasedPackage, + packageName +) { + const json = JSON.parse(body.toString("utf8")); + const modified = modifyPipJsonResponse( + json, + metadataUrl, + isNewlyReleasedPackage, + packageName + ); + + if (!modified) return body; + const modifiedBuffer = Buffer.from(JSON.stringify(json)); + clearCachingHeaders(headers); + return modifiedBuffer; +} diff --git a/packages/safe-chain/src/registryProxy/interceptors/pip/modifyPipInfo.spec.js b/packages/safe-chain/src/registryProxy/interceptors/pip/modifyPipInfo.spec.js new file mode 100644 index 0000000..900941d --- /dev/null +++ b/packages/safe-chain/src/registryProxy/interceptors/pip/modifyPipInfo.spec.js @@ -0,0 +1,302 @@ +import { describe, it, mock } from "node:test"; +import assert from "node:assert"; + +describe("modifyPipInfo", async () => { + mock.module("../../../config/settings.js", { + namedExports: { + getMinimumPackageAgeHours: () => 48, + ECOSYSTEM_PY: "py", + }, + }); + + mock.module("../../../environment/userInteraction.js", { + namedExports: { + ui: { + writeVerbose: () => {}, + }, + }, + }); + + const { + modifyPipInfoResponse, + } = await import("./modifyPipInfo.js"); + + it("removes too-young files from simple HTML metadata", () => { + const headers = { + "content-type": "application/vnd.pypi.simple.v1+html", + etag: "abc", + "cache-control": "public", + "content-length": "999", + "transfer-encoding": "chunked", + }; + + const body = Buffer.from(` + + + + requests-1.0.0.tar.gz + requests-2.0.0.tar.gz + + + `); + + const modified = modifyPipInfoResponse( + body, + headers, + "https://pypi.org/simple/requests/", + (_packageName, version) => version === "2.0.0", + "requests" + ).toString("utf8"); + + assert.ok(modified.includes("requests-1.0.0.tar.gz")); + assert.ok(!modified.includes("requests-2.0.0.tar.gz")); + assert.equal(headers.etag, undefined); + assert.equal(headers["cache-control"], undefined); + assert.equal(headers["content-length"], undefined); + assert.equal(headers["transfer-encoding"], "chunked"); + }); + + it("leaves mixed-case transport headers untouched for MITM layer to normalize", () => { + const headers = { + "content-type": "application/json", + ETag: "abc", + "Content-Length": "999", + "Last-Modified": "yesterday", + "Cache-Control": "public, max-age=60", + "Transfer-Encoding": "chunked", + }; + + const body = Buffer.from( + JSON.stringify({ + info: { version: "2.0.0" }, + releases: { + "1.0.0": [{ filename: "requests-1.0.0.tar.gz" }], + "2.0.0": [{ filename: "requests-2.0.0.tar.gz" }], + }, + }) + ); + + modifyPipInfoResponse( + body, + headers, + "https://pypi.org/pypi/requests/json", + (_packageName, version) => version === "2.0.0", + "requests" + ); + + assert.equal(headers.ETag, "abc"); + assert.equal(headers["Last-Modified"], "yesterday"); + assert.equal(headers["Cache-Control"], "public, max-age=60"); + assert.equal(headers["Transfer-Encoding"], "chunked"); + assert.equal(headers["Content-Length"], "999"); + assert.equal(headers["content-length"], undefined); + }); + + it("returns body unchanged when no HTML versions are suppressed", () => { + const headers = { + "content-type": "application/vnd.pypi.simple.v1+html", + etag: "abc", + }; + + const body = Buffer.from( + `requests-1.0.0.tar.gz` + ); + + const result = modifyPipInfoResponse( + body, + headers, + "https://pypi.org/simple/requests/", + () => false, + "requests" + ); + + assert.equal(result, body); // same Buffer reference — no copy made + assert.equal(headers.etag, "abc"); // headers untouched + }); + + it("matches HTML anchor hrefs using normalised package name (underscore vs hyphen)", () => { + const headers = { "content-type": "application/vnd.pypi.simple.v1+html" }; + + const body = Buffer.from( + `foo_bar-2.0.0.tar.gz` + + `foo_bar-1.0.0.tar.gz` + ); + + const modified = modifyPipInfoResponse( + body, + headers, + "https://pypi.org/simple/foo-bar/", + (_packageName, version) => version === "2.0.0", + "foo-bar" // hyphenated name, hrefs use underscore + ).toString("utf8"); + + assert.ok(!modified.includes("foo_bar-2.0.0.tar.gz")); + assert.ok(modified.includes("foo_bar-1.0.0.tar.gz")); + }); + + it("matches anchor href regex with single quotes and extra attributes", () => { + const headers = { "content-type": "application/vnd.pypi.simple.v1+html" }; + + const body = Buffer.from(` + + foo_bar-2.0.0.tar.gz + + foo_bar-1.0.0.tar.gz + `); + + const modified = modifyPipInfoResponse( + body, + headers, + "https://pypi.org/simple/foo-bar/", + (_packageName, version) => version === "2.0.0", + "foo-bar" + ).toString("utf8"); + + assert.ok(!modified.includes("foo_bar-2.0.0.tar.gz")); + assert.ok(modified.includes("foo_bar-1.0.0.tar.gz")); + }); + + it("removes too-young files from simple JSON metadata", () => { + const headers = { + "content-type": "application/vnd.pypi.simple.v1+json", + }; + + const body = Buffer.from( + JSON.stringify({ + name: "requests", + files: [ + { + filename: "requests-1.0.0.tar.gz", + url: "https://files.pythonhosted.org/packages/source/r/requests/requests-1.0.0.tar.gz", + }, + { + filename: "requests-2.0.0.tar.gz", + url: "https://files.pythonhosted.org/packages/source/r/requests/requests-2.0.0.tar.gz", + }, + ], + }) + ); + + const modified = JSON.parse( + modifyPipInfoResponse( + body, + headers, + "https://pypi.org/simple/requests/", + (_packageName, version) => version === "2.0.0", + "requests" + ).toString("utf8") + ); + + assert.equal(modified.files.length, 1); + assert.equal(modified.files[0].filename, "requests-1.0.0.tar.gz"); + }); + + it("filters simple JSON metadata entries that have only filename (no url)", () => { + const headers = { "content-type": "application/vnd.pypi.simple.v1+json" }; + + const body = Buffer.from( + JSON.stringify({ + name: "requests", + files: [ + { filename: "requests-1.0.0.tar.gz" }, + { filename: "requests-2.0.0.tar.gz" }, + ], + }) + ); + + const modified = JSON.parse( + modifyPipInfoResponse( + body, + headers, + "https://pypi.org/simple/requests/", + (_packageName, version) => version === "2.0.0", + "requests" + ).toString("utf8") + ); + + assert.equal(modified.files.length, 1); + assert.equal(modified.files[0].filename, "requests-1.0.0.tar.gz"); + }); + + it("recalculates JSON API info.version after removing too-young releases", () => { + const headers = { + "content-type": "application/json", + }; + + const body = Buffer.from( + JSON.stringify({ + info: { version: "2.0.0" }, + releases: { + "1.0.0": [ + { + filename: "requests-1.0.0.tar.gz", + upload_time_iso_8601: "2024-01-01T00:00:00.000Z", + }, + ], + "2.0.0": [ + { + filename: "requests-2.0.0.tar.gz", + upload_time_iso_8601: "2024-01-02T00:00:00.000Z", + }, + ], + "3.0.0rc1": [ + { + filename: "requests-3.0.0rc1.tar.gz", + upload_time_iso_8601: "2024-01-03T00:00:00.000Z", + }, + ], + }, + urls: [ + { filename: "requests-2.0.0.tar.gz" }, + ], + }) + ); + + const modified = JSON.parse( + modifyPipInfoResponse( + body, + headers, + "https://pypi.org/pypi/requests/json", + (_packageName, version) => + version === "2.0.0" || version === "3.0.0rc1", + "requests" + ).toString("utf8") + ); + + assert.deepEqual(Object.keys(modified.releases), ["1.0.0"]); + assert.equal(modified.info.version, "1.0.0"); + assert.equal(modified.urls.length, 0); + }); + + it("falls back to latest pre-release when all stable versions are removed", () => { + const headers = { "content-type": "application/json" }; + + const body = Buffer.from( + JSON.stringify({ + info: { version: "2.0.0rc2" }, + releases: { + "1.0.0rc1": [{ filename: "requests-1.0.0rc1.tar.gz" }], + "2.0.0rc2": [{ filename: "requests-2.0.0rc2.tar.gz" }], + }, + urls: [], + }) + ); + + const modified = JSON.parse( + modifyPipInfoResponse( + body, + headers, + "https://pypi.org/pypi/requests/json", + (_packageName, version) => version === "2.0.0rc2", + "requests" + ).toString("utf8") + ); + + assert.deepEqual(Object.keys(modified.releases), ["1.0.0rc1"]); + assert.equal(modified.info.version, "1.0.0rc1"); + }); +}); diff --git a/packages/safe-chain/src/registryProxy/interceptors/pip/modifyPipJsonResponse.js b/packages/safe-chain/src/registryProxy/interceptors/pip/modifyPipJsonResponse.js new file mode 100644 index 0000000..e005237 --- /dev/null +++ b/packages/safe-chain/src/registryProxy/interceptors/pip/modifyPipJsonResponse.js @@ -0,0 +1,176 @@ +import { + calculateLatestVersion, + getAvailableVersionsFromJson, + getPackageVersionFromMetadataFile, +} from "./pipMetadataVersionUtils.js"; +import { logSuppressedVersion } from "./pipMetadataResponseUtils.js"; + +/** + * @param {any} json + * @param {string} metadataUrl + * @param {(packageName: string | undefined, version: string | undefined) => boolean} isNewlyReleasedPackage + * @param {string} packageName + * @returns {boolean} + */ +export function modifyPipJsonResponse( + json, + metadataUrl, + isNewlyReleasedPackage, + packageName +) { + const filesModified = filterJsonMetadataFiles( + json, + metadataUrl, + isNewlyReleasedPackage, + packageName + ); + const releasesModified = removeJsonMetadataReleases( + json, + isNewlyReleasedPackage, + packageName + ); + const urlsModified = filterJsonMetadataUrls( + json, + metadataUrl, + isNewlyReleasedPackage, + packageName + ); + const versionModified = updateJsonInfoVersion(json, metadataUrl); + + return filesModified || releasesModified || urlsModified || versionModified; +} + +/** + * @param {any} json + * @param {string} metadataUrl + * @param {(packageName: string | undefined, version: string | undefined) => boolean} isNewlyReleasedPackage + * @param {string} packageName + * @returns {boolean} + */ +function filterJsonMetadataFiles( + json, + metadataUrl, + isNewlyReleasedPackage, + packageName +) { + if (!Array.isArray(json.files)) { + return false; + } + + let modified = false; + const loggedVersions = new Set(); + json.files = json.files.filter((/** @type {any} */ file) => { + const version = getPackageVersionFromMetadataFile(file, metadataUrl); + + if (version && isNewlyReleasedPackage(packageName, version)) { + modified = true; + if (!loggedVersions.has(version)) { + logSuppressedVersion(packageName, version); + loggedVersions.add(version); + } + return false; + } + + return true; + }); + + return modified; +} + +/** + * @param {any} json + * @param {(packageName: string | undefined, version: string | undefined) => boolean} isNewlyReleasedPackage + * @param {string} packageName + * @returns {boolean} + */ +function removeJsonMetadataReleases(json, isNewlyReleasedPackage, packageName) { + if (!json.releases || typeof json.releases !== "object") { + return false; + } + + let modified = false; + + for (const [version, files] of Object.entries(json.releases)) { + if ( + Array.isArray(/** @type {unknown[]} */ (files)) && + isNewlyReleasedPackage(packageName, version) + ) { + delete json.releases[version]; + modified = true; + logSuppressedVersion(packageName, version); + } + } + + return modified; +} + +/** + * @param {any} json + * @param {string} metadataUrl + * @param {(packageName: string | undefined, version: string | undefined) => boolean} isNewlyReleasedPackage + * @param {string} packageName + * @returns {boolean} + */ +function filterJsonMetadataUrls( + json, + metadataUrl, + isNewlyReleasedPackage, + packageName +) { + if (!Array.isArray(json.urls)) { + return false; + } + + let modified = false; + const loggedVersions = new Set(); + json.urls = json.urls.filter((/** @type {any} */ file) => { + const version = getPackageVersionFromMetadataFile(file, metadataUrl); + + if (version && isNewlyReleasedPackage(packageName, version)) { + modified = true; + if (!loggedVersions.has(version)) { + logSuppressedVersion(packageName, version); + loggedVersions.add(version); + } + return false; + } + + return true; + }); + + return modified; +} + +/** + * @param {any} json + * @param {string} metadataUrl + * @returns {boolean} + */ +function updateJsonInfoVersion(json, metadataUrl) { + if (!json.info || typeof json.info !== "object") { + return false; + } + + const replacementVersion = computeReplacementVersion(json, metadataUrl); + + if ( + typeof json.info.version !== "string" || + !replacementVersion || + json.info.version === replacementVersion + ) { + return false; + } + + json.info.version = replacementVersion; + return true; +} + +/** + * @param {any} json + * @param {string} metadataUrl + * @returns {string | undefined} + */ +function computeReplacementVersion(json, metadataUrl) { + const candidateVersions = getAvailableVersionsFromJson(json, metadataUrl); + return calculateLatestVersion(candidateVersions); +} diff --git a/packages/safe-chain/src/registryProxy/interceptors/pip/parsePipPackageUrl.js b/packages/safe-chain/src/registryProxy/interceptors/pip/parsePipPackageUrl.js new file mode 100644 index 0000000..da3d29f --- /dev/null +++ b/packages/safe-chain/src/registryProxy/interceptors/pip/parsePipPackageUrl.js @@ -0,0 +1,162 @@ +/** + * Parses a PyPI metadata URL and returns the package name and API type. + * + * @example + * parsePipMetadataUrl("https://pypi.org/simple/requests/") + * // => { packageName: "requests", type: "simple" } + * + * parsePipMetadataUrl("https://pypi.org/pypi/requests/json") + * // => { packageName: "requests", type: "json" } + * + * parsePipMetadataUrl("https://pypi.org/pypi/requests/2.28.1/json") + * // => { packageName: "requests", type: "json" } + * + * parsePipMetadataUrl("https://files.pythonhosted.org/packages/requests-2.28.1.tar.gz") + * // => { packageName: undefined, type: undefined } + * + * @param {string} url + * @returns {{ packageName: string | undefined, type: "simple" | "json" | undefined }} + */ +export function parsePipMetadataUrl(url) { + if (typeof url !== "string") { + return { packageName: undefined, type: undefined }; + } + + let urlObj; + try { + urlObj = new URL(url); + } catch { + return { packageName: undefined, type: undefined }; + } + + const pathSegments = urlObj.pathname.split("/").filter(Boolean); + if (pathSegments[0] === "simple" && pathSegments[1]) { + return { + packageName: decodeURIComponent(pathSegments[1]), + type: "simple", + }; + } + + if ( + pathSegments[0] === "pypi" && + pathSegments[pathSegments.length - 1] === "json" && + pathSegments[1] + ) { + return { + packageName: decodeURIComponent(pathSegments[1]), + type: "json", + }; + } + + return { packageName: undefined, type: undefined }; +} + +/** + * @param {string} url + * @returns {boolean} + */ +export function isPipPackageInfoUrl(url) { + return !!parsePipMetadataUrl(url).packageName; +} + +/** + * Parse Python package artifact URLs from PyPI-style registries. + * Examples: + * - Wheel: https://files.pythonhosted.org/packages/.../requests-2.28.1-py3-none-any.whl + * - Wheel metadata: https://files.pythonhosted.org/packages/.../requests-2.28.1-py3-none-any.whl.metadata + * - Sdist: https://files.pythonhosted.org/packages/.../requests-2.28.1.tar.gz + * + * @param {string} url + * @param {string} registry + * @returns {{packageName: string | undefined, version: string | undefined}} + */ +export function parsePipPackageFromUrl(url, registry) { + if (!registry || typeof url !== "string") { + return { packageName: undefined, version: undefined }; + } + + let urlObj; + try { + urlObj = new URL(url); + } catch { + return { packageName: undefined, version: undefined }; + } + + const lastSegment = urlObj.pathname.split("/").filter(Boolean).pop(); + if (!lastSegment) { + return { packageName: undefined, version: undefined }; + } + + const filename = decodeURIComponent(lastSegment); + + const wheelExtRe = /\.whl(?:\.metadata)?$/; + if (wheelExtRe.test(filename)) { + return parseWheelFilename(filename, wheelExtRe); + } + + const sdistExtWithMetadataRe = /\.(tar\.gz|zip|tar\.bz2|tar\.xz)(\.metadata)?$/i; + if (!sdistExtWithMetadataRe.test(filename)) { + return { packageName: undefined, version: undefined }; + } + + return parseSdistFilename(filename, sdistExtWithMetadataRe); +} + +/** + * Parse wheel filenames and Poetry preflight metadata. + * Examples: + * - foo_bar-2.0.0-py3-none-any.whl + * - foo_bar-2.0.0-py3-none-any.whl.metadata + * + * @param {string} filename + * @param {RegExp} wheelExtRe + * @returns {{packageName: string | undefined, version: string | undefined}} + */ +function parseWheelFilename(filename, wheelExtRe) { + const base = filename.replace(wheelExtRe, ""); + const firstDash = base.indexOf("-"); + if (firstDash <= 0) { + return { packageName: undefined, version: undefined }; + } + + const packageName = base.slice(0, firstDash); + const rest = base.slice(firstDash + 1); + const secondDash = rest.indexOf("-"); + const version = secondDash >= 0 ? rest.slice(0, secondDash) : rest; + + // "latest" is a resolver-style token, not an actual published artifact version. + if (version === "latest" || !packageName || !version) { + return { packageName: undefined, version: undefined }; + } + + return { packageName, version }; +} + +/** + * Parse source distribution filenames, with optional metadata suffix. + * Examples: + * - requests-2.28.1.tar.gz + * - requests-2.28.1.zip + * - requests-2.28.1.tar.gz.metadata + * + * @param {string} filename + * @param {RegExp} sdistExtWithMetadataRe + * @returns {{packageName: string | undefined, version: string | undefined}} + */ +function parseSdistFilename(filename, sdistExtWithMetadataRe) { + const base = filename.replace(sdistExtWithMetadataRe, ""); + const lastDash = base.lastIndexOf("-"); + if (lastDash <= 0 || lastDash >= base.length - 1) { + return { packageName: undefined, version: undefined }; + } + + const packageName = base.slice(0, lastDash); + const version = base.slice(lastDash + 1); + + // "latest" is a resolver-style token, not an actual published artifact version. + if (version === "latest" || !packageName || !version) { + return { packageName: undefined, version: undefined }; + } + + return { packageName, version }; +} diff --git a/packages/safe-chain/src/registryProxy/interceptors/pip/parsePipPackageUrl.spec.js b/packages/safe-chain/src/registryProxy/interceptors/pip/parsePipPackageUrl.spec.js new file mode 100644 index 0000000..1345dd4 --- /dev/null +++ b/packages/safe-chain/src/registryProxy/interceptors/pip/parsePipPackageUrl.spec.js @@ -0,0 +1,100 @@ +import { describe, it } from "node:test"; +import assert from "node:assert"; +import { + isPipPackageInfoUrl, + parsePipMetadataUrl, + parsePipPackageFromUrl, +} from "./parsePipPackageUrl.js"; + +describe("parsePipPackageUrl", () => { + it("parses simple metadata URLs", () => { + assert.deepEqual(parsePipMetadataUrl("https://pypi.org/simple/requests/"), { + packageName: "requests", + type: "simple", + }); + }); + + it("parses json metadata URLs", () => { + assert.deepEqual(parsePipMetadataUrl("https://pypi.org/pypi/requests/json"), { + packageName: "requests", + type: "json", + }); + }); + + it("parses per-version json metadata URLs", () => { + assert.deepEqual( + parsePipMetadataUrl("https://pypi.org/pypi/requests/2.28.1/json"), + { packageName: "requests", type: "json" } + ); + }); + + it("decodes encoded metadata package names", () => { + assert.deepEqual( + parsePipMetadataUrl("https://pypi.org/simple/foo-bar%5Fbaz/"), + { + packageName: "foo-bar_baz", + type: "simple", + } + ); + }); + + it("returns undefined for unrecognized metadata paths", () => { + assert.deepEqual( + parsePipMetadataUrl("https://pypi.org/unknown/requests/"), + { + packageName: undefined, + type: undefined, + } + ); + }); + + it("returns undefined for invalid metadata URLs", () => { + assert.deepEqual(parsePipMetadataUrl("not a url"), { + packageName: undefined, + type: undefined, + }); + }); + + it("recognizes package info URLs", () => { + assert.equal( + isPipPackageInfoUrl("https://pypi.org/simple/requests/"), + true + ); + }); + + it("does not treat artifact URLs as package info URLs", () => { + assert.equal( + isPipPackageInfoUrl( + "https://files.pythonhosted.org/packages/source/r/requests/requests-2.28.1.tar.gz" + ), + false + ); + }); + + it("parses wheel artifact URLs", () => { + assert.deepEqual( + parsePipPackageFromUrl( + "https://files.pythonhosted.org/packages/xx/yy/foo_bar-2.0.0-py3-none-any.whl", + "files.pythonhosted.org" + ), + { packageName: "foo_bar", version: "2.0.0" } + ); + }); + + it("parses sdist artifact URLs", () => { + assert.deepEqual( + parsePipPackageFromUrl( + "https://files.pythonhosted.org/packages/source/r/requests/requests-2.28.1.tar.gz", + "files.pythonhosted.org" + ), + { packageName: "requests", version: "2.28.1" } + ); + }); + + it("returns undefined for non-artifact URLs", () => { + assert.deepEqual( + parsePipPackageFromUrl("https://pypi.org/simple/requests/", "pypi.org"), + { packageName: undefined, version: undefined } + ); + }); +}); diff --git a/packages/safe-chain/src/registryProxy/interceptors/pip/pipInterceptor.customRegistries.spec.js b/packages/safe-chain/src/registryProxy/interceptors/pip/pipInterceptor.customRegistries.spec.js new file mode 100644 index 0000000..5904f05 --- /dev/null +++ b/packages/safe-chain/src/registryProxy/interceptors/pip/pipInterceptor.customRegistries.spec.js @@ -0,0 +1,205 @@ +import { describe, it, mock } from "node:test"; +import assert from "node:assert"; + +describe("pipInterceptor custom registries", async () => { + let scannedPackages; + let malwareResponse = false; + let customRegistries = []; + + mock.module("../../../config/settings.js", { + namedExports: { + ECOSYSTEM_PY: "py", + getEcoSystem: () => "py", + getLoggingLevel: () => "silent", + getMinimumPackageAgeHours: () => 48, + getMinimumPackageAgeExclusions: () => [], + getPipCustomRegistries: () => customRegistries, + LOGGING_SILENT: "silent", + LOGGING_VERBOSE: "verbose", + skipMinimumPackageAge: () => false, + }, + }); + + mock.module("../../../scanning/newPackagesListCache.js", { + namedExports: { + openNewPackagesDatabase: async () => ({ + isNewlyReleasedPackage: () => false, + }), + }, + }); + + mock.module("../../../scanning/audit/index.js", { + namedExports: { + isMalwarePackage: async (packageName, version) => { + scannedPackages.push({ packageName, version }); + return malwareResponse; + }, + }, + }); + + const { pipInterceptorForUrl } = await import("./pipInterceptor.js"); + + it("should create interceptor for custom registry", () => { + customRegistries = ["my-custom-registry.example.com"]; + const url = + "https://my-custom-registry.example.com/packages/xx/yy/foobar-1.2.3.tar.gz"; + + const interceptor = pipInterceptorForUrl(url); + + assert.ok(interceptor); + }); + + it("should parse package from custom registry URL", async () => { + scannedPackages = []; + customRegistries = ["my-custom-registry.example.com"]; + const url = + "https://my-custom-registry.example.com/packages/xx/yy/foobar-1.2.3.tar.gz"; + + const interceptor = pipInterceptorForUrl(url); + assert.ok(interceptor); + + await interceptor.handleRequest(url); + + assert.ok( + scannedPackages.some( + ({ packageName, version }) => + packageName === "foobar" && version === "1.2.3" + ) + ); + }); + + it("should parse wheel package from custom registry URL", async () => { + scannedPackages = []; + customRegistries = ["private-pypi.internal.com"]; + const url = + "https://private-pypi.internal.com/packages/foo_bar-2.0.0-py3-none-any.whl"; + + const interceptor = pipInterceptorForUrl(url); + assert.ok(interceptor); + + await interceptor.handleRequest(url); + + assert.ok( + scannedPackages.some( + ({ packageName, version }) => + packageName === "foo-bar" && version === "2.0.0" + ) + ); + }); + + it("should handle multiple custom registries", async () => { + customRegistries = [ + "registry-one.example.com", + "registry-two.example.com", + ]; + + const url1 = + "https://registry-one.example.com/packages/package1-1.0.0.tar.gz"; + const url2 = + "https://registry-two.example.com/packages/package2-2.0.0.tar.gz"; + + const interceptor1 = pipInterceptorForUrl(url1); + const interceptor2 = pipInterceptorForUrl(url2); + + assert.ok(interceptor1); + assert.ok(interceptor2); + }); + + it("should block malicious package from custom registry", async () => { + scannedPackages = []; + customRegistries = ["my-custom-registry.example.com"]; + malwareResponse = true; + + const url = + "https://my-custom-registry.example.com/packages/malicious_package-1.0.0.tar.gz"; + + const interceptor = pipInterceptorForUrl(url); + assert.ok(interceptor); + + const result = await interceptor.handleRequest(url); + + assert.ok(result.blockResponse); + assert.equal(result.blockResponse.statusCode, 403); + assert.equal(result.blockResponse.message, "Forbidden - blocked by safe-chain"); + + malwareResponse = false; + }); + + it("should still work with known registries when custom registries are set", async () => { + scannedPackages = []; + customRegistries = ["my-custom-registry.example.com"]; + + const url = + "https://files.pythonhosted.org/packages/xx/yy/foobar-1.2.3.tar.gz"; + + const interceptor = pipInterceptorForUrl(url); + + assert.ok(interceptor); + + await interceptor.handleRequest(url); + + assert.ok( + scannedPackages.some( + ({ packageName, version }) => + packageName === "foobar" && version === "1.2.3" + ) + ); + }); + + it("should not create interceptor for unknown registry when custom registries are set", () => { + customRegistries = ["my-custom-registry.example.com"]; + const url = "https://unknown-registry.example.com/packages/foobar-1.0.0.tar.gz"; + + const interceptor = pipInterceptorForUrl(url); + + assert.equal(interceptor, undefined); + }); + + it("should handle empty custom registries array", () => { + customRegistries = []; + const url = + "https://my-custom-registry.example.com/packages/foobar-1.0.0.tar.gz"; + + const interceptor = pipInterceptorForUrl(url); + + assert.equal(interceptor, undefined); + }); + + it("should parse .whl.metadata from custom registry", async () => { + scannedPackages = []; + customRegistries = ["private-pypi.internal.com"]; + const url = + "https://private-pypi.internal.com/packages/foo_bar-2.0.0-py3-none-any.whl.metadata"; + + const interceptor = pipInterceptorForUrl(url); + assert.ok(interceptor); + + await interceptor.handleRequest(url); + + assert.ok( + scannedPackages.some( + ({ packageName, version }) => + packageName === "foo-bar" && version === "2.0.0" + ) + ); + }); + + it("should parse .tar.gz.metadata from custom registry", async () => { + scannedPackages = []; + customRegistries = ["private-pypi.internal.com"]; + const url = + "https://private-pypi.internal.com/packages/foo_bar-2.0.0.tar.gz.metadata"; + + const interceptor = pipInterceptorForUrl(url); + assert.ok(interceptor); + + await interceptor.handleRequest(url); + + assert.ok( + scannedPackages.some( + ({ packageName, version }) => + packageName === "foo-bar" && version === "2.0.0" + ) + ); + }); +}); diff --git a/packages/safe-chain/src/registryProxy/interceptors/pip/pipInterceptor.js b/packages/safe-chain/src/registryProxy/interceptors/pip/pipInterceptor.js new file mode 100644 index 0000000..86d84eb --- /dev/null +++ b/packages/safe-chain/src/registryProxy/interceptors/pip/pipInterceptor.js @@ -0,0 +1,124 @@ +import { + ECOSYSTEM_PY, + getPipCustomRegistries, + skipMinimumPackageAge, +} from "../../../config/settings.js"; +import { isMalwarePackage } from "../../../scanning/audit/index.js"; +import { getEquivalentPackageNames } from "../../../scanning/packageNameVariants.js"; +import { openNewPackagesDatabase } from "../../../scanning/newPackagesListCache.js"; +import { interceptRequests } from "../interceptorBuilder.js"; +import { isExcludedFromMinimumPackageAge } from "../minimumPackageAgeExclusions.js"; +import { + modifyPipInfoRequestHeaders, + modifyPipInfoResponse, + parsePipMetadataUrl, +} from "./modifyPipInfo.js"; +import { parsePipPackageFromUrl } from "./parsePipPackageUrl.js"; + +const knownPipRegistries = [ + "files.pythonhosted.org", + "pypi.org", + "pypi.python.org", + "pythonhosted.org", +]; + +/** + * @param {string} url + * @returns {import("../interceptorBuilder.js").Interceptor | undefined} + */ +export function pipInterceptorForUrl(url) { + const customRegistries = getPipCustomRegistries(); + const registries = [...knownPipRegistries, ...customRegistries]; + const registry = registries.find((reg) => url.includes(reg)); + + if (registry) { + return buildPipInterceptor(registry); + } + + return undefined; +} + +/** + * @param {string} registry + * @returns {import("../interceptorBuilder.js").Interceptor | undefined} + */ +function buildPipInterceptor(registry) { + return interceptRequests(createPipRequestHandler(registry)); +} + +/** + * @param {string} registry + * @returns {(reqContext: import("../interceptorBuilder.js").RequestInterceptionContext) => Promise} + */ +function createPipRequestHandler(registry) { + return async (reqContext) => { + const minimumAgeChecksEnabled = !skipMinimumPackageAge(); + const metadataInfo = parsePipMetadataUrl(reqContext.targetUrl); + const metadataPackageName = metadataInfo.packageName; + + if ( + minimumAgeChecksEnabled && + metadataPackageName && + !isExcludedFromMinimumPackageAge(metadataPackageName) + ) { + const newPackagesDatabase = await openNewPackagesDatabase(); + reqContext.modifyRequestHeaders(modifyPipInfoRequestHeaders); + reqContext.modifyBody((body, headers) => + modifyPipInfoResponse( + body, + headers, + reqContext.targetUrl, + newPackagesDatabase.isNewlyReleasedPackage, + metadataPackageName + ) + ); + return; + } + + const { packageName, version } = parsePipPackageFromUrl( + reqContext.targetUrl, + registry + ); + + if (!packageName) { + return; + } + + const equivalentPackageNames = getEquivalentPackageNames( + packageName, + ECOSYSTEM_PY + ); + let isMalicious = false; + for (const equivalentPackageName of equivalentPackageNames) { + if (await isMalwarePackage(equivalentPackageName, version)) { + isMalicious = true; + break; + } + } + + if (isMalicious) { + reqContext.blockMalware(packageName, version); + return; + } + + if ( + version && + minimumAgeChecksEnabled && + !isExcludedFromMinimumPackageAge(packageName) + ) { + const newPackagesDatabase = await openNewPackagesDatabase(); + const isNewlyReleased = newPackagesDatabase.isNewlyReleasedPackage( + packageName, + version + ); + + if (isNewlyReleased) { + reqContext.blockMinimumAgeRequest( + packageName, + version, + `Forbidden - blocked by safe-chain direct download minimum package age (${packageName}@${version})` + ); + } + } + }; +} diff --git a/packages/safe-chain/src/registryProxy/interceptors/pip/pipInterceptor.minPackageAge.spec.js b/packages/safe-chain/src/registryProxy/interceptors/pip/pipInterceptor.minPackageAge.spec.js new file mode 100644 index 0000000..f311df7 --- /dev/null +++ b/packages/safe-chain/src/registryProxy/interceptors/pip/pipInterceptor.minPackageAge.spec.js @@ -0,0 +1,168 @@ +import { describe, it, mock } from "node:test"; +import assert from "node:assert"; + +describe("pipInterceptor minimum package age", async () => { + let skipMinimumPackageAgeSetting = false; + let newlyReleasedPackageResponse = false; + let minimumPackageAgeExclusionsSetting = []; + + mock.module("../../../scanning/audit/index.js", { + namedExports: { + isMalwarePackage: async () => false, + }, + }); + + mock.module("../../../scanning/newPackagesListCache.js", { + namedExports: { + openNewPackagesDatabase: async () => ({ + isNewlyReleasedPackage: (packageName, version) => { + return newlyReleasedPackageResponse && + (packageName === "foo-bar" || + packageName === "foo_bar" || + packageName === "foo.bar") && + version === "2.0.0"; + }, + }), + }, + }); + + mock.module("../../../config/settings.js", { + namedExports: { + ECOSYSTEM_PY: "py", + getEcoSystem: () => "py", + getLoggingLevel: () => "silent", + getMinimumPackageAgeHours: () => 48, + getMinimumPackageAgeExclusions: () => minimumPackageAgeExclusionsSetting, + getPipCustomRegistries: () => [], + LOGGING_SILENT: "silent", + LOGGING_VERBOSE: "verbose", + skipMinimumPackageAge: () => skipMinimumPackageAgeSetting, + }, + }); + + const { pipInterceptorForUrl } = await import("./pipInterceptor.js"); + + it("should block newly released package downloads", async () => { + const url = + "https://files.pythonhosted.org/packages/xx/yy/foo_bar-2.0.0-py3-none-any.whl"; + newlyReleasedPackageResponse = true; + + const interceptor = pipInterceptorForUrl(url); + const result = await interceptor.handleRequest(url); + + assert.ok(result.blockResponse); + assert.equal(result.blockResponse.statusCode, 403); + assert.equal( + result.blockResponse.message, + "Forbidden - blocked by safe-chain direct download minimum package age (foo_bar@2.0.0)" + ); + + newlyReleasedPackageResponse = false; + }); + + it("should modify simple metadata responses to suppress too-young versions", async () => { + const url = "https://pypi.org/simple/foo-bar/"; + newlyReleasedPackageResponse = true; + + const interceptor = pipInterceptorForUrl(url); + const result = await interceptor.handleRequest(url); + + assert.equal(result.modifiesResponse(), true); + + const modifiedBody = result.modifyBody( + Buffer.from(` + foo_bar-1.0.0.tar.gz + foo_bar-2.0.0.tar.gz + `), + { + "content-type": "application/vnd.pypi.simple.v1+html", + } + ).toString("utf8"); + + assert.ok(modifiedBody.includes("foo_bar-1.0.0.tar.gz")); + assert.ok(!modifiedBody.includes("foo_bar-2.0.0.tar.gz")); + + newlyReleasedPackageResponse = false; + }); + + it("should not block newly released package downloads when skipMinimumPackageAge is enabled", async () => { + const url = + "https://files.pythonhosted.org/packages/xx/yy/foo_bar-2.0.0-py3-none-any.whl"; + newlyReleasedPackageResponse = true; + skipMinimumPackageAgeSetting = true; + + const interceptor = pipInterceptorForUrl(url); + const result = await interceptor.handleRequest(url); + + assert.equal(result.blockResponse, undefined); + + skipMinimumPackageAgeSetting = false; + newlyReleasedPackageResponse = false; + }); + + it("should not block newly released package downloads when the package is excluded", async () => { + const url = + "https://files.pythonhosted.org/packages/xx/yy/foo_bar-2.0.0-py3-none-any.whl"; + newlyReleasedPackageResponse = true; + minimumPackageAgeExclusionsSetting = ["foo-bar"]; + + const interceptor = pipInterceptorForUrl(url); + const result = await interceptor.handleRequest(url); + + assert.equal(result.blockResponse, undefined); + + minimumPackageAgeExclusionsSetting = []; + newlyReleasedPackageResponse = false; + }); + + it("should not modify metadata responses when the package is excluded", async () => { + const url = "https://pypi.org/simple/foo-bar/"; + newlyReleasedPackageResponse = true; + minimumPackageAgeExclusionsSetting = ["foo-bar"]; + + const interceptor = pipInterceptorForUrl(url); + const result = await interceptor.handleRequest(url); + + assert.equal(result.modifiesResponse(), false); + + minimumPackageAgeExclusionsSetting = []; + newlyReleasedPackageResponse = false; + }); + + it("strips If-None-Match and If-Modified-Since from metadata requests to prevent 304 cache bypass", async () => { + const url = "https://pypi.org/simple/foo-bar/"; + newlyReleasedPackageResponse = true; + + const interceptor = pipInterceptorForUrl(url); + const result = await interceptor.handleRequest(url); + + const headers = { + "if-none-match": '"some-etag"', + "if-modified-since": "Thu, 01 Jan 2026 00:00:00 GMT", + accept: "*/*", + }; + + result.modifyRequestHeaders(headers); + + assert.equal(headers["if-none-match"], undefined, "If-None-Match must be stripped"); + assert.equal(headers["if-modified-since"], undefined, "If-Modified-Since must be stripped"); + assert.equal(headers.accept, "*/*", "unrelated headers must be preserved"); + + newlyReleasedPackageResponse = false; + }); + + it("should not block newly released package downloads when a dot-name package matches a hyphen exclusion", async () => { + const url = + "https://files.pythonhosted.org/packages/xx/yy/foo.bar-2.0.0.tar.gz"; + newlyReleasedPackageResponse = true; + minimumPackageAgeExclusionsSetting = ["foo-bar"]; + + const interceptor = pipInterceptorForUrl(url); + const result = await interceptor.handleRequest(url); + + assert.equal(result.blockResponse, undefined); + + minimumPackageAgeExclusionsSetting = []; + newlyReleasedPackageResponse = false; + }); +}); diff --git a/packages/safe-chain/src/registryProxy/interceptors/pipInterceptor.spec.js b/packages/safe-chain/src/registryProxy/interceptors/pip/pipInterceptor.packageDownload.spec.js similarity index 58% rename from packages/safe-chain/src/registryProxy/interceptors/pipInterceptor.spec.js rename to packages/safe-chain/src/registryProxy/interceptors/pip/pipInterceptor.packageDownload.spec.js index 8b60b9b..f4a54a4 100644 --- a/packages/safe-chain/src/registryProxy/interceptors/pipInterceptor.spec.js +++ b/packages/safe-chain/src/registryProxy/interceptors/pip/pipInterceptor.packageDownload.spec.js @@ -2,22 +2,43 @@ import { describe, it, mock } from "node:test"; import assert from "node:assert"; describe("pipInterceptor", async () => { - let lastPackage; + let scannedPackages; let malwareResponse = false; - mock.module("../../scanning/audit/index.js", { + mock.module("../../../scanning/audit/index.js", { namedExports: { isMalwarePackage: async (packageName, version) => { - lastPackage = { packageName, version }; + scannedPackages.push({ packageName, version }); return malwareResponse; }, }, }); + mock.module("../../../scanning/newPackagesListCache.js", { + namedExports: { + openNewPackagesDatabase: async () => ({ + isNewlyReleasedPackage: () => false, + }), + }, + }); + + mock.module("../../../config/settings.js", { + namedExports: { + ECOSYSTEM_PY: "py", + getEcoSystem: () => "py", + getLoggingLevel: () => "silent", + getMinimumPackageAgeHours: () => 48, + getMinimumPackageAgeExclusions: () => [], + getPipCustomRegistries: () => [], + LOGGING_SILENT: "silent", + LOGGING_VERBOSE: "verbose", + skipMinimumPackageAge: () => false, + }, + }); + const { pipInterceptorForUrl } = await import("./pipInterceptor.js"); const parserCases = [ - // Valid pip URLs { url: "https://files.pythonhosted.org/packages/xx/yy/foobar-1.2.3.tar.gz", expected: { packageName: "foobar", version: "1.2.3" }, @@ -32,11 +53,15 @@ describe("pipInterceptor", async () => { }, { url: "https://pypi.org/packages/source/f/foo_bar/foo_bar-2.0.0-py3-none-any.whl", - expected: { packageName: "foo_bar", version: "2.0.0" }, + expected: { packageName: "foo-bar", version: "2.0.0" }, + }, + { + url: "https://files.pythonhosted.org/packages/xx/yy/foo_bar-2.0.0-py3-none-any.whl.metadata", + expected: { packageName: "foo-bar", version: "2.0.0" }, }, { url: "https://files.pythonhosted.org/packages/xx/yy/foo_bar-2.0.0-py3-none-any.whl", - expected: { packageName: "foo_bar", version: "2.0.0" }, + expected: { packageName: "foo-bar", version: "2.0.0" }, }, { url: "https://pypi.org/packages/source/f/foo.bar/foo.bar-1.0.0.tar.gz", @@ -44,29 +69,32 @@ describe("pipInterceptor", async () => { }, { url: "https://pypi.org/packages/source/f/foo_bar/foo_bar-2.0.0b1.tar.gz", - expected: { packageName: "foo_bar", version: "2.0.0b1" }, + expected: { packageName: "foo-bar", version: "2.0.0b1" }, + }, + { + url: "https://files.pythonhosted.org/packages/xx/yy/foo_bar-2.0.0.tar.gz.metadata", + expected: { packageName: "foo-bar", version: "2.0.0" }, }, { url: "https://pypi.org/packages/source/f/foo_bar/foo_bar-2.0.0rc1.tar.gz", - expected: { packageName: "foo_bar", version: "2.0.0rc1" }, + expected: { packageName: "foo-bar", version: "2.0.0rc1" }, }, { url: "https://pypi.org/packages/source/f/foo_bar/foo_bar-2.0.0.post1.tar.gz", - expected: { packageName: "foo_bar", version: "2.0.0.post1" }, + expected: { packageName: "foo-bar", version: "2.0.0.post1" }, }, { url: "https://pypi.org/packages/source/f/foo_bar/foo_bar-2.0.0.dev1.tar.gz", - expected: { packageName: "foo_bar", version: "2.0.0.dev1" }, + expected: { packageName: "foo-bar", version: "2.0.0.dev1" }, }, { url: "https://pypi.org/packages/source/f/foo_bar/foo_bar-2.0.0a1.tar.gz", - expected: { packageName: "foo_bar", version: "2.0.0a1" }, + expected: { packageName: "foo-bar", version: "2.0.0a1" }, }, { url: "https://pypi.org/packages/source/f/foo_bar/foo_bar-2.0.0-cp38-cp38-manylinux1_x86_64.whl", - expected: { packageName: "foo_bar", version: "2.0.0" }, + expected: { packageName: "foo-bar", version: "2.0.0" }, }, - // Invalid pip URLs { url: "https://pypi.org/simple/", expected: { packageName: undefined, version: undefined }, @@ -87,49 +115,49 @@ describe("pipInterceptor", async () => { parserCases.forEach(({ url, expected }, index) => { it(`should parse URL ${index + 1}: ${url}`, async () => { + scannedPackages = []; const interceptor = pipInterceptorForUrl(url); - assert.ok( - interceptor, - "Interceptor should be created for known npm registry" - ); + assert.ok(interceptor, "Interceptor should be created for known pip registry"); await interceptor.handleRequest(url); - assert.deepEqual(lastPackage, expected); + if (expected.packageName === undefined) { + assert.deepEqual(scannedPackages, []); + return; + } + + assert.ok( + scannedPackages.some( + ({ packageName, version }) => + packageName === expected.packageName && + version === expected.version + ) + ); }); }); it("should not create interceptor for unknown registry", () => { const url = "https://example.com/packages/xx/yy/foobar-1.2.3.tar.gz"; - const interceptor = pipInterceptorForUrl(url); - - assert.equal( - interceptor, - undefined, - "Interceptor should be undefined for unknown registry" - ); + assert.equal(interceptor, undefined); }); it("should block malicious package", async () => { + scannedPackages = []; const url = "https://files.pythonhosted.org/packages/xx/yy/malicious_package-1.0.0.tar.gz"; malwareResponse = true; const interceptor = pipInterceptorForUrl(url); - const result = await interceptor.handleRequest(url); - assert.ok(result.blockResponse, "Should contain a blockResponse"); - assert.equal( - result.blockResponse.statusCode, - 403, - "Block response should have status code 403" - ); + assert.ok(result.blockResponse); + assert.equal(result.blockResponse.statusCode, 403); assert.equal( result.blockResponse.message, - "Forbidden - blocked by safe-chain", - "Block response should have correct status message" + "Forbidden - blocked by safe-chain" ); + + malwareResponse = false; }); }); diff --git a/packages/safe-chain/src/registryProxy/interceptors/pip/pipMetadataResponseUtils.js b/packages/safe-chain/src/registryProxy/interceptors/pip/pipMetadataResponseUtils.js new file mode 100644 index 0000000..e394810 --- /dev/null +++ b/packages/safe-chain/src/registryProxy/interceptors/pip/pipMetadataResponseUtils.js @@ -0,0 +1,27 @@ +import { getMinimumPackageAgeHours } from "../../../config/settings.js"; +import { ui } from "../../../environment/userInteraction.js"; +import { getHeaderValueAsString } from "../../http-utils.js"; +import { recordSuppressedVersion } from "../suppressedVersionsState.js"; + +/** + * @param {NodeJS.Dict | undefined} headers + * @returns {string | undefined} + */ +export function getPipMetadataContentType(headers) { + return getHeaderValueAsString(headers, "content-type") + ?.toLowerCase() + .split(";")[0] + .trim(); +} + +/** + * @param {string} packageName + * @param {string} version + * @returns {void} + */ +export function logSuppressedVersion(packageName, version) { + recordSuppressedVersion(); + ui.writeVerbose( + `Safe-chain: ${packageName}@${version} is newer than ${getMinimumPackageAgeHours()} hours and was removed (minimumPackageAgeInHours setting).` + ); +} diff --git a/packages/safe-chain/src/registryProxy/interceptors/pip/pipMetadataVersionUtils.js b/packages/safe-chain/src/registryProxy/interceptors/pip/pipMetadataVersionUtils.js new file mode 100644 index 0000000..4ccb953 --- /dev/null +++ b/packages/safe-chain/src/registryProxy/interceptors/pip/pipMetadataVersionUtils.js @@ -0,0 +1,131 @@ +import { parsePipPackageFromUrl } from "./parsePipPackageUrl.js"; + +/** + * @param {any} file + * @param {string} metadataUrl + * @returns {string | undefined} + */ +export function getPackageVersionFromMetadataFile(file, metadataUrl) { + const href = typeof file?.url === "string" ? file.url : undefined; + const filename = typeof file?.filename === "string" ? file.filename : undefined; + + if (href) { + const resolvedHref = new URL(href, metadataUrl).toString(); + return parsePipPackageFromUrl( + resolvedHref, + new URL(resolvedHref).host + ).version; + } + + if (filename) { + return parsePipPackageFromUrl( + new URL(filename, metadataUrl).toString(), + new URL(metadataUrl).host + ).version; + } + + return undefined; +} + +/** + * @param {any} json + * @param {string} metadataUrl + * @returns {string[]} + */ +export function getAvailableVersionsFromJson(json, metadataUrl) { + if (json.releases && typeof json.releases === "object") { + return Object.keys(json.releases); + } + + if (!Array.isArray(json.files)) { + return []; + } + + return [ + ...new Set( + json.files + .map((/** @type {any} */ file) => + getPackageVersionFromMetadataFile(file, metadataUrl) + ) + .filter(isDefinedString) + ), + ]; +} + +/** + * @param {string | undefined} value + * @returns {value is string} + */ +function isDefinedString(value) { + return typeof value === "string"; +} + +/** + * @param {string[]} versions + * @returns {string | undefined} + */ +export function calculateLatestVersion(versions) { + const stableVersions = versions.filter((version) => !isPrerelease(version)); + if (stableVersions.length > 0) { + return stableVersions.sort(comparePep440ishVersions).at(-1); + } + + return versions.sort(comparePep440ishVersions).at(-1); +} + +/** + * @param {string} left + * @param {string} right + * @returns {number} + */ +function comparePep440ishVersions(left, right) { + const leftParts = tokenizeVersion(left); + const rightParts = tokenizeVersion(right); + const maxLength = Math.max(leftParts.length, rightParts.length); + + for (let index = 0; index < maxLength; index += 1) { + const leftPart = leftParts[index]; + const rightPart = rightParts[index]; + + if (leftPart === undefined) return -1; + if (rightPart === undefined) return 1; + + if (leftPart === rightPart) { + continue; + } + + const leftNumeric = typeof leftPart === "number"; + const rightNumeric = typeof rightPart === "number"; + + if (leftNumeric && rightNumeric) { + return leftPart - rightPart; + } + + if (leftNumeric) return 1; + if (rightNumeric) return -1; + + return String(leftPart).localeCompare(String(rightPart)); + } + + return 0; +} + +/** + * @param {string} version + * @returns {(string | number)[]} + */ +function tokenizeVersion(version) { + return version + .toLowerCase() + .split(/[^a-z0-9]+/) + .flatMap((part) => part.match(/[a-z]+|\d+/g) || []) + .map((part) => (/^\d+$/.test(part) ? Number(part) : part)); +} + +/** + * @param {string} version + * @returns {boolean} + */ +function isPrerelease(version) { + return /(a|b|rc|dev)\d+/i.test(version); +} diff --git a/packages/safe-chain/src/registryProxy/interceptors/pipInterceptor.js b/packages/safe-chain/src/registryProxy/interceptors/pipInterceptor.js deleted file mode 100644 index 212c830..0000000 --- a/packages/safe-chain/src/registryProxy/interceptors/pipInterceptor.js +++ /dev/null @@ -1,115 +0,0 @@ -import { isMalwarePackage } from "../../scanning/audit/index.js"; -import { interceptRequests } from "./interceptorBuilder.js"; - -const knownPipRegistries = [ - "files.pythonhosted.org", - "pypi.org", - "pypi.python.org", - "pythonhosted.org", -]; - -/** - * @param {string} url - * @returns {import("./interceptorBuilder.js").Interceptor | undefined} - */ -export function pipInterceptorForUrl(url) { - const registry = knownPipRegistries.find((reg) => url.includes(reg)); - - if (registry) { - return buildPipInterceptor(registry); - } - - return undefined; -} - -/** - * @param {string} registry - * @returns {import("./interceptorBuilder.js").Interceptor | undefined} - */ -function buildPipInterceptor(registry) { - return interceptRequests(async (reqContext) => { - const { packageName, version } = parsePipPackageFromUrl( - reqContext.targetUrl, - registry - ); - if (await isMalwarePackage(packageName, version)) { - reqContext.blockMalware(packageName, version); - } - }); -} - -/** - * @param {string} url - * @param {string} registry - * @returns {{packageName: string | undefined, version: string | undefined}} - */ -function parsePipPackageFromUrl(url, registry) { - let packageName, version; - - // Basic validation - if (!registry || typeof url !== "string") { - return { packageName, version }; - } - - // Quick sanity check on the URL + parse - let urlObj; - try { - urlObj = new URL(url); - } catch { - return { packageName, version }; - } - - // Get the last path segment (filename) and decode it (strip query & fragment automatically) - const lastSegment = urlObj.pathname.split("/").filter(Boolean).pop(); - if (!lastSegment) { - return { packageName, version }; - } - - const filename = decodeURIComponent(lastSegment); - - // Parse Python package downloads from PyPI/pythonhosted.org - // Example wheel: https://files.pythonhosted.org/packages/xx/yy/requests-2.28.1-py3-none-any.whl - // Example sdist: https://files.pythonhosted.org/packages/xx/yy/requests-2.28.1.tar.gz - - // Wheel (.whl) - if (filename.endsWith(".whl")) { - const base = filename.slice(0, -4); // remove ".whl" - const firstDash = base.indexOf("-"); - if (firstDash > 0) { - const dist = base.slice(0, firstDash); // may contain underscores - const rest = base.slice(firstDash + 1); // version + the rest of tags - const secondDash = rest.indexOf("-"); - const rawVersion = secondDash >= 0 ? rest.slice(0, secondDash) : rest; - packageName = dist; // preserve underscores - version = rawVersion; - // Reject "latest" as it's a placeholder, not a real version - // When version is "latest", this signals the URL doesn't contain actual version info - // Returning undefined allows the request (see registryProxy.js isAllowedUrl) - if (version === "latest" || !packageName || !version) { - return { packageName: undefined, version: undefined }; - } - return { packageName, version }; - } - } - - // Source dist (sdist) - const sdistExtMatch = filename.match(/\.(tar\.gz|zip|tar\.bz2|tar\.xz)$/i); - if (sdistExtMatch) { - const base = filename.slice(0, -sdistExtMatch[0].length); - const lastDash = base.lastIndexOf("-"); - if (lastDash > 0 && lastDash < base.length - 1) { - packageName = base.slice(0, lastDash); - version = base.slice(lastDash + 1); - // Reject "latest" as it's a placeholder, not a real version - // When version is "latest", this signals the URL doesn't contain actual version info - // Returning undefined allows the request (see registryProxy.js isAllowedUrl) - if (version === "latest" || !packageName || !version) { - return { packageName: undefined, version: undefined }; - } - return { packageName, version }; - } - } - - // Unknown file type or invalid - return { packageName: undefined, version: undefined }; -} diff --git a/packages/safe-chain/src/registryProxy/interceptors/suppressedVersionsState.js b/packages/safe-chain/src/registryProxy/interceptors/suppressedVersionsState.js new file mode 100644 index 0000000..26c0559 --- /dev/null +++ b/packages/safe-chain/src/registryProxy/interceptors/suppressedVersionsState.js @@ -0,0 +1,21 @@ +const state = { + hasSuppressedVersions: false, +}; + +/** + * Tracks whether any rewritten metadata response suppressed versions during the + * current process lifetime. This is intentional shared state used only for the + * end-of-run summary message exposed through the proxy API. + * + * @returns {void} + */ +export function recordSuppressedVersion() { + state.hasSuppressedVersions = true; +} + +/** + * @returns {boolean} + */ +export function getHasSuppressedVersions() { + return state.hasSuppressedVersions; +} diff --git a/packages/safe-chain/src/registryProxy/isImdsEndpoint.js b/packages/safe-chain/src/registryProxy/isImdsEndpoint.js new file mode 100644 index 0000000..deccf10 --- /dev/null +++ b/packages/safe-chain/src/registryProxy/isImdsEndpoint.js @@ -0,0 +1,13 @@ +// Instance Metadata Service (IMDS) endpoints used by cloud providers. +// Cloud SDK tools probe these to detect environment and retrieve credentials. +// When outside cloud environments, connections timeout - we reduce timeout (3s vs 30s) +// and suppress error logging since this is expected behavior. +const imdsEndpoints = [ + "metadata.google.internal", + "metadata.goog", + "169.254.169.254", // AWS, Azure, Oracle Cloud, GCP +]; + +export function isImdsEndpoint(/** @type {string} */ host) { + return imdsEndpoints.includes(host); +} diff --git a/packages/safe-chain/src/registryProxy/mitmRequestHandler.js b/packages/safe-chain/src/registryProxy/mitmRequestHandler.js index bfc6c3e..4c4e9ec 100644 --- a/packages/safe-chain/src/registryProxy/mitmRequestHandler.js +++ b/packages/safe-chain/src/registryProxy/mitmRequestHandler.js @@ -2,7 +2,8 @@ import https from "https"; import { generateCertForHost } from "./certUtils.js"; import { HttpsProxyAgent } from "https-proxy-agent"; import { ui } from "../environment/userInteraction.js"; -import { gunzipSync, gzipSync } from "zlib"; +import { gunzipSync } from "zlib"; +import { omitHeaders } from "./http-utils.js"; /** * @typedef {import("./interceptors/interceptorBuilder.js").Interceptor} Interceptor @@ -15,7 +16,7 @@ import { gunzipSync, gzipSync } from "zlib"; */ export function mitmConnect(req, clientSocket, interceptor) { ui.writeVerbose(`Safe-chain: Set up MITM tunnel for ${req.url}`); - const { hostname } = new URL(`http://${req.url}`); + const { hostname, port } = new URL(`http://${req.url}`); clientSocket.on("error", (err) => { ui.writeVerbose( @@ -26,7 +27,7 @@ export function mitmConnect(req, clientSocket, interceptor) { // Not subscribing to 'close' event will cause node to throw and crash. }); - const server = createHttpsServer(hostname, interceptor); + const server = createHttpsServer(hostname, port, interceptor); server.on("error", (err) => { ui.writeError(`Safe-chain: HTTPS server error: ${err.message}`); @@ -46,10 +47,11 @@ export function mitmConnect(req, clientSocket, interceptor) { /** * @param {string} hostname + * @param {string} port * @param {Interceptor} interceptor * @returns {import("https").Server} */ -function createHttpsServer(hostname, interceptor) { +function createHttpsServer(hostname, port, interceptor) { const cert = generateCertForHost(hostname); /** @@ -80,7 +82,7 @@ function createHttpsServer(hostname, interceptor) { } // Collect request body - forwardRequest(req, hostname, res, requestInterceptor); + forwardRequest(req, hostname, port, res, requestInterceptor); } const server = https.createServer( @@ -109,22 +111,25 @@ function getRequestPathAndQuery(url) { /** * @param {import("http").IncomingMessage} req * @param {string} hostname + * @param {string} port * @param {import("http").ServerResponse} res * @param {import("./interceptors/interceptorBuilder.js").RequestInterceptionHandler} requestHandler */ -function forwardRequest(req, hostname, res, requestHandler) { - const proxyReq = createProxyRequest(hostname, req, res, requestHandler); +function forwardRequest(req, hostname, port, res, requestHandler) { + const proxyReq = createProxyRequest(hostname, port, req, res, requestHandler); proxyReq.on("error", (err) => { ui.writeVerbose( - `Safe-chain: Error occurred while proxying request: ${err.message}` + `Safe-chain: Error occurred while proxying request to ${req.url} for ${hostname}: ${err.message}` ); res.writeHead(502); res.end("Bad Gateway"); }); req.on("error", (err) => { - ui.writeError(`Safe-chain: Error reading client request: ${err.message}`); + ui.writeError( + `Safe-chain: Error reading client request to ${req.url} for ${hostname}: ${err.message}` + ); proxyReq.destroy(); }); @@ -142,13 +147,14 @@ function forwardRequest(req, hostname, res, requestHandler) { /** * @param {string} hostname + * @param {string} port * @param {import("http").IncomingMessage} req * @param {import("http").ServerResponse} res * @param {import("./interceptors/interceptorBuilder.js").RequestInterceptionHandler} requestHandler * * @returns {import("http").ClientRequest} */ -function createProxyRequest(hostname, req, res, requestHandler) { +function createProxyRequest(hostname, port, req, res, requestHandler) { /** @type {NodeJS.Dict | undefined} */ let headers = { ...req.headers }; // Remove the host header from the incoming request before forwarding. @@ -161,7 +167,7 @@ function createProxyRequest(hostname, req, res, requestHandler) { /** @type {import("http").RequestOptions} */ const options = { hostname: hostname, - port: 443, + port: port || 443, path: req.url, method: req.method, headers: { ...headers }, @@ -175,7 +181,7 @@ function createProxyRequest(hostname, req, res, requestHandler) { const proxyReq = https.request(options, (proxyRes) => { proxyRes.on("error", (err) => { ui.writeError( - `Safe-chain: Error reading upstream response: ${err.message}` + `Safe-chain: Error reading upstream response to ${req.url} for ${hostname}: ${err.message}` ); if (!res.headersSent) { res.writeHead(502); @@ -184,7 +190,9 @@ function createProxyRequest(hostname, req, res, requestHandler) { }); if (!proxyRes.statusCode) { - ui.writeError("Safe-chain: Proxy response missing status code"); + ui.writeError( + `Safe-chain: Proxy response missing status code to ${req.url} for ${hostname}` + ); res.writeHead(500); res.end("Internal Server Error"); return; @@ -208,11 +216,16 @@ function createProxyRequest(hostname, req, res, requestHandler) { buffer = requestHandler.modifyBody(buffer, headers); - if (proxyRes.headers["content-encoding"] === "gzip") { - buffer = gzipSync(buffer); - } - - res.writeHead(statusCode, headers); + // For rewritten responses, send the final body uncompressed. + // This avoids mismatches between upstream compression metadata and the + // rewritten payload on the wire. + const rewrittenHeaders = omitHeaders( + headers, + ["content-length", "transfer-encoding", "content-encoding"], + { caseInsensitive: true } + ) || {}; + rewrittenHeaders["content-length"] = String(buffer.byteLength); + res.writeHead(statusCode, rewrittenHeaders); res.end(buffer); }); } else { diff --git a/packages/safe-chain/src/registryProxy/mitmRequestHandler.spec.js b/packages/safe-chain/src/registryProxy/mitmRequestHandler.spec.js new file mode 100644 index 0000000..de01e2c --- /dev/null +++ b/packages/safe-chain/src/registryProxy/mitmRequestHandler.spec.js @@ -0,0 +1,138 @@ +import { describe, it, mock } from "node:test"; +import assert from "node:assert"; +import zlib from "node:zlib"; + +describe("mitmRequestHandler", async () => { + let capturedHandler; + let capturedOptions; + + mock.module("https", { + defaultExport: { + createServer: (_options, handler) => { + capturedHandler = handler; + return { + on: () => {}, + emit: () => {}, + }; + }, + request: (options, callback) => { + capturedOptions = options; + + const listeners = {}; + const proxyRes = { + statusCode: 200, + headers: { + "content-encoding": "gzip", + "content-length": "999", + "transfer-encoding": "chunked", + }, + on: (event, handler) => { + listeners[event] = handler; + }, + }; + + callback(proxyRes); + + return { + on: () => {}, + write: () => {}, + end: () => { + const payload = Buffer.from("rewritten body"); + listeners["data"]?.(zlib.gzipSync(payload)); + listeners["end"]?.(); + }, + destroy: () => {}, + }; + }, + }, + }); + + mock.module("./certUtils.js", { + namedExports: { + generateCertForHost: () => ({ + privateKey: "key", + certificate: "cert", + }), + }, + }); + + mock.module("https-proxy-agent", { + namedExports: { + HttpsProxyAgent: class {}, + }, + }); + + mock.module("../environment/userInteraction.js", { + namedExports: { + ui: { + writeVerbose: () => {}, + writeError: () => {}, + }, + }, + }); + + const { mitmConnect } = await import("./mitmRequestHandler.js"); + + it("sets content-length from the final compressed payload after body rewrite", async () => { + const interceptor = { + handleRequest: async () => ({ + blockResponse: undefined, + modifyRequestHeaders: (headers) => headers, + modifiesResponse: () => true, + modifyBody: () => Buffer.from("rewritten body"), + }), + }; + + const req = { + url: "pypi.org:443", + }; + + const clientSocket = { + on: () => {}, + write: () => {}, + headersSent: false, + writable: true, + end: () => {}, + }; + + mitmConnect(req, clientSocket, interceptor); + + const resState = { + statusCode: undefined, + headers: undefined, + body: undefined, + }; + + const res = { + headersSent: false, + writeHead: (statusCode, headers) => { + resState.statusCode = statusCode; + resState.headers = headers; + }, + end: (body) => { + resState.body = body; + }, + }; + + const request = { + url: "/simple/example/", + headers: {}, + method: "GET", + on: (event, handler) => { + if (event === "end") { + handler(); + } + }, + }; + + await capturedHandler(request, res); + + assert.equal(capturedOptions.hostname, "pypi.org"); + assert.equal(resState.statusCode, 200); + assert.equal(resState.headers["transfer-encoding"], undefined); + assert.equal( + resState.headers["content-length"], + String(resState.body.byteLength) + ); + }); +}); diff --git a/packages/safe-chain/src/registryProxy/registryProxy.connect-tunnel.spec.js b/packages/safe-chain/src/registryProxy/registryProxy.connect-tunnel.spec.js index 45fd96a..ace84ee 100644 --- a/packages/safe-chain/src/registryProxy/registryProxy.connect-tunnel.spec.js +++ b/packages/safe-chain/src/registryProxy/registryProxy.connect-tunnel.spec.js @@ -1,11 +1,39 @@ -import { before, after, describe, it } from "node:test"; +import { before, after, describe, it, mock } from "node:test"; import assert from "node:assert"; import net from "net"; import tls from "tls"; -import { - createSafeChainProxy, - mergeSafeChainProxyEnvironmentVariables, -} from "./registryProxy.js"; + +// Mock isImdsEndpoint BEFORE any other imports that might use it +// This allows us to use TEST-NET-1 (192.0.2.1) as a test IMDS endpoint +const mockIsImdsEndpoint = (host) => { + if (host === "192.0.2.1") return true; + return [ + "metadata.google.internal", + "metadata.goog", + "169.254.169.254", + ].includes(host); +}; + +mock.module("./isImdsEndpoint.js", { + namedExports: { + isImdsEndpoint: mockIsImdsEndpoint, + }, +}); + +// Mock getConnectTimeout to speed up tests +mock.module("./getConnectTimeout.js", { + namedExports: { + getConnectTimeout: (host) => { + // IMDS endpoints: 100ms (real: 3s) + // Other endpoints: 500ms (real: 30s) + return mockIsImdsEndpoint(host) ? 100 : 500; + }, + }, +}); + +// Use dynamic import AFTER mocking to ensure mock is applied +const { createSafeChainProxy, mergeSafeChainProxyEnvironmentVariables } = + await import("./registryProxy.js"); describe("registryProxy.connectTunnel", () => { let proxy, proxyHost, proxyPort; @@ -62,15 +90,21 @@ describe("registryProxy.connectTunnel", () => { // Verify the certificate is NOT issued by our safe-chain CA // Our self-signed CA would have issuer: "Safe-Chain Proxy CA" - assert.ok(certInfo.issuer !== undefined, "Certificate should have an issuer"); + assert.ok( + certInfo.issuer !== undefined, + "Certificate should have an issuer" + ); assert.ok( !certInfo.issuer.includes("Safe-Chain"), `Tunnel should use destination's real certificate, not safe-chain CA. Issuer: ${certInfo.issuer}` ); // Verify it's a real certificate with proper hostname - assert.strictEqual(certInfo.subject.includes("postman-echo.com"), true, - `Certificate subject should include postman-echo.com, got: ${certInfo.subject}`); + assert.strictEqual( + certInfo.subject.includes("postman-echo.com"), + true, + `Certificate subject should include postman-echo.com, got: ${certInfo.subject}` + ); socket.destroy(); }); @@ -105,7 +139,6 @@ describe("registryProxy.connectTunnel", () => { assert.ok(true); }); - it("should handle socket errors without crashing", async () => { const socket = await connectToProxy(proxyHost, proxyPort); @@ -125,7 +158,146 @@ describe("registryProxy.connectTunnel", () => { // Test passes if no unhandled error crashes the process assert.ok(true); }); + }); + describe("Connection Timeout", () => { + it("should timeout quickly when connecting to IMDS endpoint", async () => { + // We need to make sure we're not running behind an existing safe-chain installation to allow this test to work + const https_proxy = process.env.HTTPS_PROXY; + delete process.env.HTTPS_PROXY; + const socket = await connectToProxy(proxyHost, proxyPort); + const startTime = Date.now(); + + // 192.0.2.1 is TEST-NET-1 (RFC 5737), guaranteed to never route + const connectRequest = `CONNECT 192.0.2.1:443 HTTP/1.1\r\nHost: 192.0.2.1:443\r\n\r\n`; + socket.write(connectRequest); + + let responseData = ""; + await new Promise((resolve) => { + socket.once("data", (data) => { + responseData += data.toString(); + resolve(); + }); + }); + + const duration = Date.now() - startTime; + + // Should return 504 Gateway Timeout (not 502 - 504 is for actual timeouts) + assert.ok( + responseData.includes("HTTP/1.1 504 Gateway Timeout"), + "Should return 504 for timeout" + ); + + // Should timeout around 100ms for IMDS endpoints (allow some margin) + assert.ok( + duration >= 80 && duration < 200, + `IMDS timeout should be ~80-200ms, got ${duration}ms` + ); + + socket.destroy(); + if (https_proxy) { + process.env.HTTPS_PROXY = https_proxy; + } + }); + + it("should cache timed-out IMDS endpoints and fail immediately on retry", async () => { + // We need to make sure we're not running behind an existing safe-chain installation to allow this test to work + const https_proxy = process.env.HTTPS_PROXY; + delete process.env.HTTPS_PROXY; + // First connection - will timeout (192.0.2.1 is mocked as IMDS endpoint) + const socket1 = await connectToProxy(proxyHost, proxyPort); + const connectRequest = `CONNECT 192.0.2.1:80 HTTP/1.1\r\nHost: 192.0.2.1:80\r\n\r\n`; + socket1.write(connectRequest); + + await new Promise((resolve) => { + socket1.once("data", () => resolve()); + }); + socket1.destroy(); + + // Second connection - should fail immediately (cached) + const socket2 = await connectToProxy(proxyHost, proxyPort); + const startTime = Date.now(); + socket2.write(connectRequest); + + let responseData = ""; + await new Promise((resolve) => { + socket2.once("data", (data) => { + responseData += data.toString(); + resolve(); + }); + }); + + const duration = Date.now() - startTime; + + // Should return 502 immediately (cached timeout) + assert.ok( + responseData.includes("HTTP/1.1 502 Bad Gateway"), + "Should return 502 for cached timeout" + ); + + // Should be nearly instant (< 50ms) since it's cached + assert.ok( + duration < 50, + `Cached IMDS timeout should be instant, got ${duration}ms` + ); + + socket2.destroy(); + if (https_proxy) { + process.env.HTTPS_PROXY = https_proxy; + } + }); + + it("should NOT cache timed-out non-IMDS endpoints", async () => { + // We need to make sure we're not running behind an existing safe-chain installation to allow this test to work + const https_proxy = process.env.HTTPS_PROXY; + delete process.env.HTTPS_PROXY; + + // 192.0.2.2 is in TEST-NET-1 (RFC 5737) but NOT mocked as IMDS + // It will timeout but should NOT be cached + const connectRequest = `CONNECT 192.0.2.2:443 HTTP/1.1\r\nHost: 192.0.2.2:443\r\n\r\n`; + + // First connection - will timeout + const socket1 = await connectToProxy(proxyHost, proxyPort); + socket1.write(connectRequest); + + await new Promise((resolve) => { + socket1.once("data", () => resolve()); + }); + socket1.destroy(); + + // Second connection - should NOT fail immediately because non-IMDS endpoints are not cached + const socket2 = await connectToProxy(proxyHost, proxyPort); + const startTime = Date.now(); + socket2.write(connectRequest); + + let responseData = ""; + await new Promise((resolve) => { + socket2.once("data", (data) => { + responseData += data.toString(); + resolve(); + }); + }); + + const duration = Date.now() - startTime; + + // Should return 504 Gateway Timeout (not 502 - 504 is for actual timeouts) + assert.ok( + responseData.includes("HTTP/1.1 504 Gateway Timeout"), + "Should return 504 for timeout" + ); + + // Should NOT be instant - it should retry the connection (taking ~500ms due to mock timeout) + // If it was cached, it would return in < 50ms + assert.ok( + duration >= 400, + `Non-IMDS timeout should NOT be cached, but got instant response in ${duration}ms` + ); + + socket2.destroy(); + if (https_proxy) { + process.env.HTTPS_PROXY = https_proxy; + } + }); }); }); @@ -167,7 +339,12 @@ function establishHttpsTunnel(socket, targetHost, targetPort) { }); } -function sendHttpsRequestThroughTunnel(socket, verb, url, rejectUnauthorized = false) { +function sendHttpsRequestThroughTunnel( + socket, + verb, + url, + rejectUnauthorized = false +) { return new Promise((resolve, reject) => { const tlsSocket = tls.connect( { @@ -214,12 +391,16 @@ function getTlsCertificateInfo(socket, url) { const cert = tlsSocket.getPeerCertificate(); // Extract issuer and subject information - const issuer = cert.issuer ? - Object.entries(cert.issuer).map(([k, v]) => `${k}=${v}`).join(", ") : - "unknown"; - const subject = cert.subject ? - Object.entries(cert.subject).map(([k, v]) => `${k}=${v}`).join(", ") : - "unknown"; + const issuer = cert.issuer + ? Object.entries(cert.issuer) + .map(([k, v]) => `${k}=${v}`) + .join(", ") + : "unknown"; + const subject = cert.subject + ? Object.entries(cert.subject) + .map(([k, v]) => `${k}=${v}`) + .join(", ") + : "unknown"; tlsSocket.end(); resolve({ issuer, subject }); diff --git a/packages/safe-chain/src/registryProxy/registryProxy.js b/packages/safe-chain/src/registryProxy/registryProxy.js index 8169086..694c72c 100644 --- a/packages/safe-chain/src/registryProxy/registryProxy.js +++ b/packages/safe-chain/src/registryProxy/registryProxy.js @@ -2,19 +2,24 @@ import * as http from "http"; import { tunnelRequest } from "./tunnelRequestHandler.js"; import { mitmConnect } from "./mitmRequestHandler.js"; import { handleHttpProxyRequest } from "./plainHttpProxy.js"; -import { getCaCertPath } from "./certUtils.js"; +import { getCombinedCaBundlePath, cleanupCertBundle } from "./certBundle.js"; import { ui } from "../environment/userInteraction.js"; import chalk from "chalk"; import { createInterceptorForUrl } from "./interceptors/createInterceptorForEcoSystem.js"; -import { getHasSuppressedVersions } from "./interceptors/npm/modifyNpmInfo.js"; +import { getHasSuppressedVersions } from "./interceptors/suppressedVersionsState.js"; const SERVER_STOP_TIMEOUT_MS = 1000; /** - * @type {{port: number | null, blockedRequests: {packageName: string, version: string, url: string}[]}} + * @type {{ + * port: number | null, + * blockedRequests: {packageName: string, version: string, url: string}[], + * blockedMinimumAgeRequests: {packageName: string, version: string, url: string}[] + * }} */ const state = { port: null, blockedRequests: [], + blockedMinimumAgeRequests: [], }; export function createSafeChainProxy() { @@ -23,7 +28,8 @@ export function createSafeChainProxy() { return { startServer: () => startServer(server), stopServer: () => stopServer(server), - verifyNoMaliciousPackages, + hasBlockedMaliciousPackages, + hasBlockedMinimumAgeRequests, hasSuppressedVersions: getHasSuppressedVersions, }; } @@ -36,10 +42,13 @@ function getSafeChainProxyEnvironmentVariables() { return {}; } + const proxyUrl = `http://127.0.0.1:${state.port}`; + const caCertPath = getCombinedCaBundlePath(); + return { - HTTPS_PROXY: `http://localhost:${state.port}`, - GLOBAL_AGENT_HTTP_PROXY: `http://localhost:${state.port}`, - NODE_EXTRA_CA_CERTS: getCaCertPath(), + HTTPS_PROXY: proxyUrl, + GLOBAL_AGENT_HTTP_PROXY: proxyUrl, + NODE_EXTRA_CA_CERTS: caCertPath, }; } @@ -86,8 +95,11 @@ function createProxyServer() { */ function startServer(server) { return new Promise((resolve, reject) => { - // Passing port 0 makes the OS assign an available port - server.listen(0, () => { + // Bind to loopback only. Without an explicit host, Node listens on every + // interface, turning the proxy into an unauthenticated forward proxy that + // anyone reachable on the network can use to hit the victim's localhost, + // intranet, or cloud metadata endpoints. Port 0 lets the OS pick a port. + server.listen(0, "127.0.0.1", () => { const address = server.address(); if (address && typeof address === "object") { state.port = address.port; @@ -112,12 +124,16 @@ function stopServer(server) { return new Promise((resolve) => { try { server.close(() => { + cleanupCertBundle(); resolve(); }); } catch { resolve(); } - setTimeout(() => resolve(), SERVER_STOP_TIMEOUT_MS); + setTimeout(() => { + cleanupCertBundle(); + resolve(); + }, SERVER_STOP_TIMEOUT_MS); }); } @@ -136,9 +152,26 @@ function handleConnect(req, clientSocket, head) { if (interceptor) { // Subscribe to malware blocked events - interceptor.on("malwareBlocked", (event) => { - onMalwareBlocked(event.packageName, event.version, event.url); - }); + interceptor.on( + "malwareBlocked", + ( + /** @type {import("./interceptors/interceptorBuilder.js").MalwareBlockedEvent} */ event + ) => { + onMalwareBlocked(event.packageName, event.version, event.targetUrl); + } + ); + interceptor.on( + "minimumAgeRequestBlocked", + ( + /** @type {import("./interceptors/interceptorBuilder.js").MinimumAgeRequestBlockedEvent} */ event + ) => { + onMinimumAgeRequestBlocked( + event.packageName, + event.version, + event.targetUrl + ); + } + ); mitmConnect(req, clientSocket, interceptor); } else { @@ -158,10 +191,19 @@ function onMalwareBlocked(packageName, version, url) { state.blockedRequests.push({ packageName, version, url }); } -function verifyNoMaliciousPackages() { +/** + * + * @param {string} packageName + * @param {string} version + * @param {string} url + */ +function onMinimumAgeRequestBlocked(packageName, version, url) { + state.blockedMinimumAgeRequests.push({ packageName, version, url }); +} + +function hasBlockedMaliciousPackages() { if (state.blockedRequests.length === 0) { - // No malicious packages were blocked, so nothing to block - return true; + return false; } ui.emptyLine(); @@ -180,5 +222,37 @@ function verifyNoMaliciousPackages() { ui.writeExitWithoutInstallingMaliciousPackages(); ui.emptyLine(); - return false; + return true; +} + +function hasBlockedMinimumAgeRequests() { + if (state.blockedMinimumAgeRequests.length === 0) { + return false; + } + + ui.emptyLine(); + + ui.writeInformation( + `Safe-chain: ${chalk.bold( + `blocked ${state.blockedMinimumAgeRequests.length} direct package download request(s) due to minimum package age` + )}:` + ); + + for (const req of state.blockedMinimumAgeRequests) { + ui.writeInformation(` - ${req.packageName}@${req.version} (${req.url})`); + } + + ui.writeInformation( + ` To disable this check, use: ${chalk.cyan( + "--safe-chain-skip-minimum-package-age" + )}` + ); + + ui.emptyLine(); + ui.writeError( + "Safe-chain: Exiting without installing packages blocked by the direct download minimum package age check." + ); + ui.emptyLine(); + + return true; } diff --git a/packages/safe-chain/src/registryProxy/registryProxy.loopback.spec.js b/packages/safe-chain/src/registryProxy/registryProxy.loopback.spec.js new file mode 100644 index 0000000..64bb862 --- /dev/null +++ b/packages/safe-chain/src/registryProxy/registryProxy.loopback.spec.js @@ -0,0 +1,67 @@ +import { before, after, describe, it } from "node:test"; +import assert from "node:assert"; +import net from "node:net"; +import os from "node:os"; +import { + createSafeChainProxy, + mergeSafeChainProxyEnvironmentVariables, +} from "./registryProxy.js"; + +describe("registryProxy loopback binding", () => { + let proxy, proxyPort; + + before(async () => { + proxy = createSafeChainProxy(); + await proxy.startServer(); + const envVars = mergeSafeChainProxyEnvironmentVariables([]); + proxyPort = parseInt(new URL(envVars.HTTPS_PROXY).port, 10); + }); + + after(async () => { + await proxy.stopServer(); + }); + + it("advertises a loopback HTTPS_PROXY URL", () => { + const envVars = mergeSafeChainProxyEnvironmentVariables([]); + const hostname = new URL(envVars.HTTPS_PROXY).hostname; + assert.ok( + hostname === "127.0.0.1" || hostname === "::1" || hostname === "localhost", + `expected loopback hostname, got ${hostname}` + ); + }); + + it("refuses connections on non-loopback interfaces", async () => { + const externalAddrs = Object.values(os.networkInterfaces()) + .flat() + .filter((iface) => iface && iface.family === "IPv4" && !iface.internal) + .map((iface) => iface.address); + + if (externalAddrs.length === 0) { + // No non-loopback interface available (e.g. locked-down CI) - skip. + return; + } + + for (const addr of externalAddrs) { + await new Promise((resolve, reject) => { + const sock = net.createConnection({ host: addr, port: proxyPort }); + const timer = setTimeout(() => { + sock.destroy(); + resolve(); // Filtered / dropped is also fine - we just don't want success. + }, 500); + sock.once("connect", () => { + clearTimeout(timer); + sock.destroy(); + reject( + new Error( + `proxy accepted a connection on non-loopback ${addr}:${proxyPort}` + ) + ); + }); + sock.once("error", () => { + clearTimeout(timer); + resolve(); + }); + }); + } + }); +}); diff --git a/packages/safe-chain/src/registryProxy/registryProxy.mitm.spec.js b/packages/safe-chain/src/registryProxy/registryProxy.mitm.spec.js index df4332e..407aa3c 100644 --- a/packages/safe-chain/src/registryProxy/registryProxy.mitm.spec.js +++ b/packages/safe-chain/src/registryProxy/registryProxy.mitm.spec.js @@ -2,12 +2,17 @@ import { before, after, describe, it } from "node:test"; import assert from "node:assert"; import net from "net"; import tls from "tls"; +import { gunzipSync } from "zlib"; import { createSafeChainProxy, mergeSafeChainProxyEnvironmentVariables, } from "./registryProxy.js"; import { getCaCertPath } from "./certUtils.js"; -import { setEcoSystem, ECOSYSTEM_JS, ECOSYSTEM_PY } from "../config/settings.js"; +import { + setEcoSystem, + ECOSYSTEM_JS, + ECOSYSTEM_PY, +} from "../config/settings.js"; import fs from "fs"; describe("registryProxy.mitm", () => { @@ -33,7 +38,7 @@ describe("registryProxy.mitm", () => { proxyHost, proxyPort, "registry.npmjs.org", - "/lodash" + "/lodash", ); assert.strictEqual(response.statusCode, 200); @@ -45,7 +50,7 @@ describe("registryProxy.mitm", () => { proxyHost, proxyPort, "registry.npmjs.org", - "/lodash/-/lodash-4.17.21.tgz" + "/lodash/-/lodash-4.17.21.tgz", ); // Should get a response (200 or redirect, but not 403 blocked) @@ -57,7 +62,7 @@ describe("registryProxy.mitm", () => { proxyHost, proxyPort, "registry.npmjs.org", - "/this-package-definitely-does-not-exist-12345" + "/this-package-definitely-does-not-exist-12345", ); assert.strictEqual(response.statusCode, 404); @@ -68,7 +73,7 @@ describe("registryProxy.mitm", () => { proxyHost, proxyPort, "registry.npmjs.org", - "/lodash?write=true" + "/lodash?write=true", ); assert.strictEqual(response.statusCode, 200); @@ -79,7 +84,7 @@ describe("registryProxy.mitm", () => { proxyHost, proxyPort, "registry.yarnpkg.com", - "/lodash" + "/lodash", ); assert.strictEqual(response.statusCode, 200); @@ -90,7 +95,7 @@ describe("registryProxy.mitm", () => { proxyHost, proxyPort, "registry.npmjs.org", - "/lodash" + "/lodash", ); // Check certificate common name matches the target hostname @@ -109,14 +114,14 @@ describe("registryProxy.mitm", () => { proxyHost, proxyPort, "registry.npmjs.org", - "/lodash" + "/lodash", ); const { cert: cert2 } = await makeRegistryRequestAndGetCert( proxyHost, proxyPort, "registry.yarnpkg.com", - "/lodash" + "/lodash", ); // Different hostnames should have different certificates @@ -130,14 +135,14 @@ describe("registryProxy.mitm", () => { proxyHost, proxyPort, "registry.npmjs.org", - "/lodash" + "/lodash", ); const { cert: cert2 } = await makeRegistryRequestAndGetCert( proxyHost, proxyPort, "registry.npmjs.org", - "/package/lodash" + "/package/lodash", ); // Same hostname should get the same certificate (fingerprint) @@ -159,7 +164,7 @@ describe("registryProxy.mitm", () => { proxyHost, proxyPort, "pypi.org", - "/packages/source/f/foo_bar/foo_bar-2.0.0.tar.gz" + "/packages/source/f/foo_bar/foo_bar-2.0.0.tar.gz", ); assert.notStrictEqual(response.statusCode, 403); assert.ok(typeof response.body === "string"); @@ -172,7 +177,7 @@ describe("registryProxy.mitm", () => { proxyHost, proxyPort, "files.pythonhosted.org", - "/packages/xx/yy/foo_bar-2.0.0-py3-none-any.whl" + "/packages/xx/yy/foo_bar-2.0.0-py3-none-any.whl", ); assert.notStrictEqual(response.statusCode, 403); assert.ok(typeof response.body === "string"); @@ -185,7 +190,7 @@ describe("registryProxy.mitm", () => { proxyHost, proxyPort, "pypi.org", - "/packages/source/f/foo_bar/foo_bar-2.0.0a1.tar.gz" + "/packages/source/f/foo_bar/foo_bar-2.0.0a1.tar.gz", ); assert.notStrictEqual(response.statusCode, 403); assert.ok(typeof response.body === "string"); @@ -198,7 +203,7 @@ describe("registryProxy.mitm", () => { proxyHost, proxyPort, "pypi.org", - "/packages/source/f/foo_bar/foo_bar-latest.tar.gz" + "/packages/source/f/foo_bar/foo_bar-latest.tar.gz", ); assert.notStrictEqual(response.statusCode, 403); assert.ok(typeof response.body === "string"); @@ -234,34 +239,73 @@ async function makeRegistryRequest(proxyHost, proxyPort, targetHost, path) { }); // Step 4: Send HTTP request over TLS - const httpRequest = `GET ${path} HTTP/1.1\r\nHost: ${targetHost}\r\nConnection: close\r\n\r\n`; + const httpRequest = `GET ${path} HTTP/1.1\r\nHost: ${targetHost}\r\nConnection: close\r\nAccept-encoding: gzip\r\n\r\n`; tlsSocket.write(httpRequest); - // Step 5: Read response + // Step 5: Read response as binary chunks return new Promise((resolve, reject) => { - let data = ""; + const chunks = []; tlsSocket.on("data", (chunk) => { - data += chunk.toString(); + chunks.push(chunk); }); tlsSocket.on("end", () => { - const lines = data.split("\r\n"); - const statusLine = lines[0]; + const buffer = Buffer.concat(chunks); + + // Find the header/body separator (\r\n\r\n) in binary + const separator = Buffer.from("\r\n\r\n"); + let separatorIndex = buffer.indexOf(separator); + if (separatorIndex === -1) { + return reject( + new Error("Invalid HTTP response: no header/body separator"), + ); + } + + // Extract headers as text + const headersText = buffer.subarray(0, separatorIndex).toString("utf8"); + const headerLines = headersText.split("\r\n"); + const statusLine = headerLines[0]; const statusCode = parseInt(statusLine.split(" ")[1]); - // Find body after empty line - const emptyLineIndex = lines.findIndex(line => line === ""); - const body = lines.slice(emptyLineIndex + 1).join("\r\n"); + // Parse headers into object + const headers = {}; + for (let i = 1; i < headerLines.length; i++) { + const colonIndex = headerLines[i].indexOf(":"); + if (colonIndex > 0) { + const key = headerLines[i].substring(0, colonIndex).toLowerCase(); + const value = headerLines[i].substring(colonIndex + 1).trim(); + headers[key] = value; + } + } - resolve({ statusCode, body }); + // Extract body as binary + let bodyBuffer = buffer.subarray(separatorIndex + separator.length); + + // Decode chunked transfer encoding if present + if (headers["transfer-encoding"] === "chunked") { + bodyBuffer = decodeChunked(bodyBuffer); + } + + // Decompress if gzip encoded + if (headers["content-encoding"] === "gzip" && bodyBuffer.length > 0) { + bodyBuffer = gunzipSync(bodyBuffer); + } + + const body = bodyBuffer.toString("utf8"); + resolve({ statusCode, body, headers }); }); tlsSocket.on("error", reject); }); } -async function makeRegistryRequestAndGetCert(proxyHost, proxyPort, targetHost, path) { +async function makeRegistryRequestAndGetCert( + proxyHost, + proxyPort, + targetHost, + path, +) { // Step 1: Connect to proxy const socket = await new Promise((resolve, reject) => { const sock = net.connect({ host: proxyHost, port: proxyPort }, () => { @@ -311,7 +355,7 @@ async function makeRegistryRequestAndGetCert(proxyHost, proxyPort, targetHost, p const statusCode = parseInt(statusLine.split(" ")[1]); // Find body after empty line - const emptyLineIndex = lines.findIndex(line => line === ""); + const emptyLineIndex = lines.findIndex((line) => line === ""); const body = lines.slice(emptyLineIndex + 1).join("\r\n"); resolve({ statusCode, body }); @@ -322,3 +366,37 @@ async function makeRegistryRequestAndGetCert(proxyHost, proxyPort, targetHost, p return { cert: peerCert, response }; } + +/** + * Decode HTTP chunked transfer encoding + * Format: \r\n\r\n ... 0\r\n\r\n + * @param {Buffer} buffer + * @returns {Buffer} + */ +function decodeChunked(buffer) { + const chunks = []; + let offset = 0; + + while (offset < buffer.length) { + // Find the end of the chunk size line + const lineEnd = buffer.indexOf(Buffer.from("\r\n"), offset); + if (lineEnd === -1) break; + + // Parse chunk size (hex) + const sizeHex = buffer.subarray(offset, lineEnd).toString("utf8"); + const chunkSize = parseInt(sizeHex, 16); + + // End of chunks + if (chunkSize === 0) break; + + // Extract chunk data + const dataStart = lineEnd + 2; + const dataEnd = dataStart + chunkSize; + chunks.push(buffer.subarray(dataStart, dataEnd)); + + // Move past chunk data and trailing \r\n + offset = dataEnd + 2; + } + + return Buffer.concat(chunks); +} diff --git a/packages/safe-chain/src/registryProxy/tunnelRequestHandler.js b/packages/safe-chain/src/registryProxy/tunnelRequestHandler.js index 4b756d7..5eac381 100644 --- a/packages/safe-chain/src/registryProxy/tunnelRequestHandler.js +++ b/packages/safe-chain/src/registryProxy/tunnelRequestHandler.js @@ -1,5 +1,10 @@ import * as net from "net"; import { ui } from "../environment/userInteraction.js"; +import { isImdsEndpoint } from "./isImdsEndpoint.js"; +import { getConnectTimeout } from "./getConnectTimeout.js"; + +/** @type {string[]} */ +let timedoutImdsEndpoints = []; /** * @param {import("http").IncomingMessage} req @@ -37,34 +42,94 @@ export function tunnelRequest(req, clientSocket, head) { */ function tunnelRequestToDestination(req, clientSocket, head) { const { port, hostname } = new URL(`http://${req.url}`); + const isImds = isImdsEndpoint(hostname); + const targetPort = Number.parseInt(port) || 443; - const serverSocket = net.connect( - Number.parseInt(port) || 443, - hostname, - () => { - clientSocket.write("HTTP/1.1 200 Connection Established\r\n\r\n"); - serverSocket.write(head); - serverSocket.pipe(clientSocket); - clientSocket.pipe(serverSocket); + if (timedoutImdsEndpoints.includes(hostname)) { + clientSocket.end("HTTP/1.1 502 Bad Gateway\r\n\r\n"); + if (isImds) { + ui.writeVerbose( + `Safe-chain: Closing connection because previously timedout connect to ${hostname}` + ); + } else { + ui.writeError( + `Safe-chain: Closing connection because previously timedout connect to ${hostname}` + ); } - ); + return; + } + + const connectTimeout = getConnectTimeout(hostname); + + // Use JS setTimeout for true connection timeout (not idle timeout). + // socket.setTimeout() measures inactivity, not time since connection attempt. + const connectTimer = setTimeout(() => { + if (isImds) { + timedoutImdsEndpoints.push(hostname); + ui.writeVerbose( + `Safe-chain: connect to ${hostname}:${targetPort} timed out after ${connectTimeout}ms` + ); + } else { + ui.writeError( + `Safe-chain: connect to ${hostname}:${targetPort} timed out after ${connectTimeout}ms` + ); + } + serverSocket.destroy(); + if (clientSocket.writable) { + clientSocket.end("HTTP/1.1 504 Gateway Timeout\r\n\r\n"); + } + }, connectTimeout); + + const serverSocket = net.connect(targetPort, hostname, () => { + // Clear timer to prevent false timeout errors after successful connection + clearTimeout(connectTimer); + + clientSocket.write("HTTP/1.1 200 Connection Established\r\n\r\n"); + serverSocket.write(head); + serverSocket.pipe(clientSocket); + clientSocket.pipe(serverSocket); + }); clientSocket.on("error", () => { // This can happen if the client TCP socket sends RST instead of FIN. // Not subscribing to 'error' event will cause node to throw and crash. + clearTimeout(connectTimer); + if (serverSocket.writable) { + serverSocket.end(); + } + }); + + clientSocket.on("close", () => { + // Client closed connection - clean up server socket + clearTimeout(connectTimer); if (serverSocket.writable) { serverSocket.end(); } }); serverSocket.on("error", (err) => { - ui.writeError( - `Safe-chain: error connecting to ${hostname}:${port} - ${err.message}` - ); + clearTimeout(connectTimer); + if (isImds) { + ui.writeVerbose( + `Safe-chain: error connecting to ${hostname}:${targetPort} - ${err.message}` + ); + } else { + ui.writeError( + `Safe-chain: error connecting to ${hostname}:${targetPort} - ${err.message}` + ); + } if (clientSocket.writable) { clientSocket.end("HTTP/1.1 502 Bad Gateway\r\n\r\n"); } }); + + serverSocket.on("close", () => { + // Server closed connection - clean up client socket + clearTimeout(connectTimer); + if (clientSocket.writable) { + clientSocket.end(); + } + }); } /** @@ -145,3 +210,4 @@ function tunnelRequestViaProxy(req, clientSocket, head, proxyUrl) { } }); } + diff --git a/packages/safe-chain/src/scanning/malwareDatabase.js b/packages/safe-chain/src/scanning/malwareDatabase.js index 4aba43c..0eccc88 100644 --- a/packages/safe-chain/src/scanning/malwareDatabase.js +++ b/packages/safe-chain/src/scanning/malwareDatabase.js @@ -15,8 +15,12 @@ import { getEcoSystem, ECOSYSTEM_PY } from "../config/settings.js"; * @property {function(string, string): boolean} isMalware */ -/** @type {MalwareDatabase | null} */ -let cachedMalwareDatabase = null; +// Caching the Promise (rather than the resolved database) prevents duplicate fetches. If we cached the resolved +// value, multiple callers could pass the null-check before the first fetch completes (because each `await` yields +// control back to the event loop, allowing other callers to run). Since the Promise assignment is synchronous, all +// concurrent callers see it immediately and share a single fetch. +/** @type {Promise | null} */ +let cachedMalwareDatabasePromise = null; /** * Normalize package name for comparison. @@ -34,45 +38,44 @@ function normalizePackageName(name) { return name; } -export async function openMalwareDatabase() { - if (cachedMalwareDatabase) { - return cachedMalwareDatabase; - } +export function openMalwareDatabase() { + if (!cachedMalwareDatabasePromise) { + cachedMalwareDatabasePromise = getMalwareDatabase().then((malwareDatabase) => { + /** + * @param {string} name + * @param {string} version + * @returns {string} + */ + function getPackageStatus(name, version) { + const normalizedName = normalizePackageName(name); + const packageData = malwareDatabase.find( + (pkg) => { + const normalizedPkgName = normalizePackageName(pkg.package_name); + return normalizedPkgName === normalizedName && + (pkg.version === version || pkg.version === "*"); + } + ); - const malwareDatabase = await getMalwareDatabase(); + if (!packageData) { + return MALWARE_STATUS_OK; + } - /** - * @param {string} name - * @param {string} version - * @returns {string} - */ - function getPackageStatus(name, version) { - const normalizedName = normalizePackageName(name); - const packageData = malwareDatabase.find( - (pkg) => { - const normalizedPkgName = normalizePackageName(pkg.package_name); - return normalizedPkgName === normalizedName && - (pkg.version === version || pkg.version === "*"); + return packageData.reason; } - ); - if (!packageData) { - return MALWARE_STATUS_OK; - } - - return packageData.reason; + return { + getPackageStatus, + isMalware: (/** @type {string} */ name, /** @type {string} */ version) => { + const status = getPackageStatus(name, version); + return isMalwareStatus(status); + }, + }; + }).catch((error) => { + cachedMalwareDatabasePromise = null; + throw error; + }); } - - // This implicitly caches the malware database - // that's closed over by the getPackageStatus function - cachedMalwareDatabase = { - getPackageStatus, - isMalware: (name, version) => { - const status = getPackageStatus(name, version); - return isMalwareStatus(status); - }, - }; - return cachedMalwareDatabase; + return cachedMalwareDatabasePromise; } /** diff --git a/packages/safe-chain/src/scanning/newPackagesDatabase.spec.js b/packages/safe-chain/src/scanning/newPackagesDatabase.spec.js new file mode 100644 index 0000000..32de737 --- /dev/null +++ b/packages/safe-chain/src/scanning/newPackagesDatabase.spec.js @@ -0,0 +1,267 @@ +import { describe, it, mock, beforeEach } from "node:test"; +import assert from "node:assert"; +import fs from "fs"; +import path from "path"; +import os from "os"; + +// --- shared mutable state for mocks --- +let fetchedList = []; +let fetchedVersion = "etag-1"; +let fetchVersionResult = "etag-1"; +let minimumPackageAgeHours = 24; +let ecosystem = "js"; +let writeWarningCalls = []; +let fetchListError = null; +let fetchVersionError = null; +let importCounter = 0; +let testHomeDir = ""; + +mock.module("../api/aikido.js", { + namedExports: { + fetchNewPackagesList: async () => { + if (fetchListError) { + throw fetchListError; + } + + return { + newPackagesList: fetchedList, + version: fetchedVersion, + }; + }, + fetchNewPackagesListVersion: async () => { + if (fetchVersionError) { + throw fetchVersionError; + } + + return fetchVersionResult; + }, + }, +}); + +mock.module("../environment/userInteraction.js", { + namedExports: { + ui: { + writeWarning: (msg) => writeWarningCalls.push(msg), + writeVerbose: () => {}, + }, + }, +}); + +mock.module("../config/settings.js", { + namedExports: { + getMinimumPackageAgeHours: () => minimumPackageAgeHours, + getEcoSystem: () => ecosystem, + getMalwareListBaseUrl: () => "https://malware-list.aikido.dev", + ECOSYSTEM_JS: "js", + ECOSYSTEM_PY: "py", + }, +}); + +// Import the warnings module so we can reset its state between tests. +const { resetWarningState } = await import("./newPackagesDatabaseWarnings.js"); + +describe("newPackagesDatabase", async () => { + beforeEach(() => { + fetchedList = []; + fetchedVersion = "etag-1"; + fetchVersionResult = "etag-1"; + minimumPackageAgeHours = 24; + ecosystem = "js"; + writeWarningCalls = []; + fetchListError = null; + fetchVersionError = null; + resetWarningState(); + testHomeDir = path.join( + os.tmpdir(), + `safe-chain-new-packages-db-${process.pid}-${importCounter}` + ); + fs.rmSync(testHomeDir, { recursive: true, force: true }); + fs.mkdirSync(testHomeDir, { recursive: true }); + process.env.HOME = testHomeDir; + }); + + async function openNewPackagesDatabase() { + const module = await import( + `./newPackagesListCache.js?test_case=${importCounter++}` + ); + return module.openNewPackagesDatabase(); + } + + async function loadNewPackagesDatabaseModule() { + return import(`./newPackagesListCache.js?test_case=${importCounter++}`); + } + + function hoursAgo(hours) { + return Math.floor((Date.now() - hours * 3600 * 1000) / 1000); + } + + function writeCachedList(list, version) { + const safeChainDir = path.join(testHomeDir, ".safe-chain"); + fs.mkdirSync(safeChainDir, { recursive: true }); + fs.writeFileSync( + path.join(safeChainDir, `newPackagesList_${ecosystem}.json`), + JSON.stringify(list) + ); + fs.writeFileSync( + path.join(safeChainDir, `newPackagesList_version_${ecosystem}.txt`), + version + ); + } + + describe("isNewlyReleasedPackage", () => { + it("returns true for a package released within the age threshold", async () => { + fetchedList = [ + { package_name: "foo", version: "1.0.0", released_on: hoursAgo(1) }, + ]; + + const db = await openNewPackagesDatabase(); + assert.strictEqual(db.isNewlyReleasedPackage("foo", "1.0.0"), true); + }); + + it("returns false for a package released outside the age threshold", async () => { + fetchedList = [ + { package_name: "foo", version: "1.0.0", released_on: hoursAgo(48) }, + ]; + + const db = await openNewPackagesDatabase(); + assert.strictEqual(db.isNewlyReleasedPackage("foo", "1.0.0"), false); + }); + + it("returns false for a package not in the list", async () => { + fetchedList = []; + + const db = await openNewPackagesDatabase(); + assert.strictEqual(db.isNewlyReleasedPackage("not-there", "1.0.0"), false); + }); + + it("returns false for a known package but different version", async () => { + fetchedList = [ + { package_name: "foo", version: "2.0.0", released_on: hoursAgo(1) }, + ]; + + const db = await openNewPackagesDatabase(); + assert.strictEqual(db.isNewlyReleasedPackage("foo", "1.0.0"), false); + }); + + it("matches the current feed ecosystem when source metadata is present", async () => { + fetchedList = [ + { + source: "pypi", + package_name: "foo", + version: "1.0.0", + released_on: hoursAgo(1), + }, + { + source: "npm", + package_name: "bar", + version: "1.0.0", + released_on: hoursAgo(1), + }, + ]; + + const db = await openNewPackagesDatabase(); + + assert.strictEqual(db.isNewlyReleasedPackage("foo", "1.0.0"), false); + assert.strictEqual(db.isNewlyReleasedPackage("bar", "1.0.0"), true); + }); + + it("respects a custom minimumPackageAgeHours threshold", async () => { + minimumPackageAgeHours = 168; // 7 days + fetchedList = [ + { package_name: "foo", version: "1.0.0", released_on: hoursAgo(100) }, + ]; + + const db = await openNewPackagesDatabase(); + assert.strictEqual(db.isNewlyReleasedPackage("foo", "1.0.0"), true); + }); + + it("supports package checks for the python ecosystem", async () => { + ecosystem = "py"; + fetchedList = [ + { + source: "pypi", + package_name: "foo", + version: "1.0.0", + released_on: hoursAgo(1), + }, + ]; + const db = await openNewPackagesDatabase(); + assert.strictEqual(db.isNewlyReleasedPackage("foo", "1.0.0"), true); + }); + }); + + describe("caching behaviour", () => { + it("uses local cache when etag matches", async () => { + writeCachedList([ + { package_name: "cached-pkg", version: "1.0.0", released_on: hoursAgo(1) }, + ], "etag-1"); + fetchVersionResult = "etag-1"; + // fetchedList is empty — if we used the remote list, the lookup would return false + fetchedList = []; + + const db = await openNewPackagesDatabase(); + assert.strictEqual(db.isNewlyReleasedPackage("cached-pkg", "1.0.0"), true); + }); + + it("fetches fresh list when etag does not match", async () => { + writeCachedList([ + { package_name: "stale-pkg", version: "1.0.0", released_on: hoursAgo(1) }, + ], "etag-old"); + fetchVersionResult = "etag-new"; + fetchedList = [ + { package_name: "fresh-pkg", version: "2.0.0", released_on: hoursAgo(1) }, + ]; + + const db = await openNewPackagesDatabase(); + assert.strictEqual(db.isNewlyReleasedPackage("stale-pkg", "1.0.0"), false); + assert.strictEqual(db.isNewlyReleasedPackage("fresh-pkg", "2.0.0"), true); + }); + + it("falls back to local cache when fetch fails", async () => { + writeCachedList([ + { + package_name: "cached-pkg", + version: "1.0.0", + released_on: hoursAgo(1), + }, + ], "etag-old"); + fetchVersionResult = "etag-new"; + fetchListError = new Error("Network error"); + + const db = await openNewPackagesDatabase(); + + assert.strictEqual(db.isNewlyReleasedPackage("cached-pkg", "1.0.0"), true); + assert.strictEqual(writeWarningCalls.length, 1); + assert.ok(writeWarningCalls[0].includes("Using cached version")); + }); + + it("emits a warning when list has no version (cannot be cached)", async () => { + fetchedList = [ + { package_name: "foo", version: "1.0.0", released_on: hoursAgo(1) }, + ]; + fetchedVersion = undefined; + + const db = await openNewPackagesDatabase(); + assert.strictEqual(db.isNewlyReleasedPackage("foo", "1.0.0"), true); + assert.strictEqual(writeWarningCalls.length, 1); + assert.ok(writeWarningCalls[0].includes("could not be cached")); + }); + + it("fails open and only warns once when the new packages list cannot be loaded", async () => { + fetchListError = new Error("feed unavailable"); + + const module = await loadNewPackagesDatabaseModule(); + const db1 = await module.openNewPackagesDatabase(); + const db2 = await module.openNewPackagesDatabase(); + + assert.strictEqual(db1.isNewlyReleasedPackage("foo", "1.0.0"), false); + assert.strictEqual(db2.isNewlyReleasedPackage("foo", "1.0.0"), false); + assert.strictEqual(writeWarningCalls.length, 1); + assert.ok( + writeWarningCalls[0].includes( + "Continuing with metadata-based minimum age checks only" + ) + ); + }); + }); +}); diff --git a/packages/safe-chain/src/scanning/newPackagesDatabaseBuilder.js b/packages/safe-chain/src/scanning/newPackagesDatabaseBuilder.js new file mode 100644 index 0000000..d09f42c --- /dev/null +++ b/packages/safe-chain/src/scanning/newPackagesDatabaseBuilder.js @@ -0,0 +1,71 @@ +import { + getMinimumPackageAgeHours, + getEcoSystem, + ECOSYSTEM_JS, + ECOSYSTEM_PY, +} from "../config/settings.js"; +import { getEquivalentPackageNames } from "./packageNameVariants.js"; + +/** + * @typedef {Object} NewPackagesDatabase + * @property {function(string | undefined, string | undefined): boolean} isNewlyReleasedPackage + */ + +/** + * Returns the ecosystem identifier expected in upstream/core release feeds. + * @returns {string} + */ +function getCurrentFeedSource() { + const ecosystem = getEcoSystem(); + + if (ecosystem === ECOSYSTEM_JS) { + return "npm"; + } + + if (ecosystem === ECOSYSTEM_PY) { + return "pypi"; + } + + return ecosystem; +} + +/** + * @param {import("../api/aikido.js").NewPackageEntry[]} newPackagesList + * @returns {NewPackagesDatabase} + */ +export function buildNewPackagesDatabase(newPackagesList) { + const ecosystem = getEcoSystem(); + + /** + * @param {string | undefined} name + * @param {string | undefined} version + * @returns {boolean} + */ + function isNewlyReleasedPackage(name, version) { + if (!name || !version) { + return false; + } + + const cutOff = new Date( + new Date().getTime() - getMinimumPackageAgeHours() * 3600 * 1000 + ); + const expectedSource = getCurrentFeedSource(); + const candidateNames = getEquivalentPackageNames(name, ecosystem); + + const entry = newPackagesList.find( + (pkg) => + (!pkg.source || pkg.source.toLowerCase() === expectedSource) && + candidateNames.includes(pkg.package_name) && + pkg.version === version + ); + + if (!entry) { + return false; + } + + const releasedOn = new Date(entry.released_on * 1000); + return releasedOn > cutOff; + } + + return { isNewlyReleasedPackage }; +} diff --git a/packages/safe-chain/src/scanning/newPackagesDatabaseBuilder.spec.js b/packages/safe-chain/src/scanning/newPackagesDatabaseBuilder.spec.js new file mode 100644 index 0000000..1424a20 --- /dev/null +++ b/packages/safe-chain/src/scanning/newPackagesDatabaseBuilder.spec.js @@ -0,0 +1,159 @@ +import { describe, it, mock } from "node:test"; +import assert from "node:assert"; + +let minimumPackageAgeHours = 24; +let ecosystem = "js"; + +mock.module("../config/settings.js", { + namedExports: { + getMinimumPackageAgeHours: () => minimumPackageAgeHours, + getEcoSystem: () => ecosystem, + getMalwareListBaseUrl: () => "https://malware-list.aikido.dev", + ECOSYSTEM_JS: "js", + ECOSYSTEM_PY: "py", + }, +}); + +const { buildNewPackagesDatabase } = await import( + "./newPackagesDatabaseBuilder.js" +); + +function hoursAgo(hours) { + return Math.floor((Date.now() - hours * 3600 * 1000) / 1000); +} + +describe("buildNewPackagesDatabase", () => { + it("returns an object with isNewlyReleasedPackage", () => { + const db = buildNewPackagesDatabase([]); + assert.strictEqual(typeof db.isNewlyReleasedPackage, "function"); + }); + + describe("isNewlyReleasedPackage", () => { + it("returns true for a package released within the age threshold", () => { + const db = buildNewPackagesDatabase([ + { package_name: "foo", version: "1.0.0", released_on: hoursAgo(1) }, + ]); + + assert.strictEqual(db.isNewlyReleasedPackage("foo", "1.0.0"), true); + }); + + it("returns false for a package released outside the age threshold", () => { + const db = buildNewPackagesDatabase([ + { package_name: "foo", version: "1.0.0", released_on: hoursAgo(48) }, + ]); + + assert.strictEqual(db.isNewlyReleasedPackage("foo", "1.0.0"), false); + }); + + it("returns false for a package not in the list", () => { + const db = buildNewPackagesDatabase([]); + + assert.strictEqual(db.isNewlyReleasedPackage("not-there", "1.0.0"), false); + }); + + it("returns false when name or version is undefined", () => { + const db = buildNewPackagesDatabase([ + { package_name: "foo", version: "1.0.0", released_on: hoursAgo(1) }, + ]); + + assert.strictEqual(db.isNewlyReleasedPackage(undefined, "1.0.0"), false); + assert.strictEqual(db.isNewlyReleasedPackage("foo", undefined), false); + }); + + it("returns false for a known package but different version", () => { + const db = buildNewPackagesDatabase([ + { package_name: "foo", version: "2.0.0", released_on: hoursAgo(1) }, + ]); + + assert.strictEqual(db.isNewlyReleasedPackage("foo", "1.0.0"), false); + }); + + it("filters by source when source metadata is present", () => { + const db = buildNewPackagesDatabase([ + { source: "pypi", package_name: "foo", version: "1.0.0", released_on: hoursAgo(1) }, + { source: "npm", package_name: "bar", version: "1.0.0", released_on: hoursAgo(1) }, + ]); + + // ecosystem is "js" → feed source is "npm" + assert.strictEqual(db.isNewlyReleasedPackage("foo", "1.0.0"), false); + assert.strictEqual(db.isNewlyReleasedPackage("bar", "1.0.0"), true); + }); + + it("matches regardless of source case", () => { + const db = buildNewPackagesDatabase([ + { source: "NPM", package_name: "foo", version: "1.0.0", released_on: hoursAgo(1) }, + ]); + + assert.strictEqual(db.isNewlyReleasedPackage("foo", "1.0.0"), true); + }); + + it("matches entries with no source field", () => { + const db = buildNewPackagesDatabase([ + { package_name: "foo", version: "1.0.0", released_on: hoursAgo(1) }, + ]); + + assert.strictEqual(db.isNewlyReleasedPackage("foo", "1.0.0"), true); + }); + + it("respects a custom minimumPackageAgeHours threshold", () => { + minimumPackageAgeHours = 168; // 7 days + + const db = buildNewPackagesDatabase([ + { package_name: "foo", version: "1.0.0", released_on: hoursAgo(100) }, + ]); + + assert.strictEqual(db.isNewlyReleasedPackage("foo", "1.0.0"), true); + + minimumPackageAgeHours = 24; // reset + }); + + it("matches underscore request names against hyphen feed names for python", () => { + ecosystem = "py"; + + const db = buildNewPackagesDatabase([ + { source: "pypi", package_name: "foo-bar", version: "1.0.0", released_on: hoursAgo(1) }, + ]); + + assert.strictEqual(db.isNewlyReleasedPackage("foo_bar", "1.0.0"), true); + + ecosystem = "js"; + }); + + it("matches hyphen request names against underscore feed names for python", () => { + ecosystem = "py"; + + const db = buildNewPackagesDatabase([ + { source: "pypi", package_name: "foo_bar", version: "1.0.0", released_on: hoursAgo(1) }, + ]); + + assert.strictEqual(db.isNewlyReleasedPackage("foo-bar", "1.0.0"), true); + + ecosystem = "js"; + }); + + it("matches dot request names against hyphen feed names for python", () => { + ecosystem = "py"; + + const db = buildNewPackagesDatabase([ + { source: "pypi", package_name: "foo-bar", version: "1.0.0", released_on: hoursAgo(1) }, + ]); + + assert.strictEqual(db.isNewlyReleasedPackage("foo.bar", "1.0.0"), true); + + ecosystem = "js"; + }); + + it("matches underscore request names against dot feed names for python", () => { + ecosystem = "py"; + + const db = buildNewPackagesDatabase([ + { source: "pypi", package_name: "foo.bar", version: "1.0.0", released_on: hoursAgo(1) }, + ]); + + assert.strictEqual(db.isNewlyReleasedPackage("foo_bar", "1.0.0"), true); + + ecosystem = "js"; + }); + + }); +}); diff --git a/packages/safe-chain/src/scanning/newPackagesDatabaseWarnings.js b/packages/safe-chain/src/scanning/newPackagesDatabaseWarnings.js new file mode 100644 index 0000000..fd742bb --- /dev/null +++ b/packages/safe-chain/src/scanning/newPackagesDatabaseWarnings.js @@ -0,0 +1,17 @@ +import { ui } from "../environment/userInteraction.js"; + +let hasWarnedAboutUnavailableNewPackagesDatabase = false; + +/** @param {Error} error */ +export function warnOnceAboutUnavailableDatabase(error) { + if (!hasWarnedAboutUnavailableNewPackagesDatabase) { + ui.writeWarning( + `Failed to load the new packages list used for direct package download request blocking. Continuing with metadata-based minimum age checks only. ${error.message}` + ); + hasWarnedAboutUnavailableNewPackagesDatabase = true; + } +} + +export function resetWarningState() { + hasWarnedAboutUnavailableNewPackagesDatabase = false; +} diff --git a/packages/safe-chain/src/scanning/newPackagesDatabaseWarnings.spec.js b/packages/safe-chain/src/scanning/newPackagesDatabaseWarnings.spec.js new file mode 100644 index 0000000..d36d5df --- /dev/null +++ b/packages/safe-chain/src/scanning/newPackagesDatabaseWarnings.spec.js @@ -0,0 +1,63 @@ +import { describe, it, mock, beforeEach } from "node:test"; +import assert from "node:assert"; + +let writeWarningCalls = []; + +mock.module("../environment/userInteraction.js", { + namedExports: { + ui: { + writeWarning: (msg) => writeWarningCalls.push(msg), + }, + }, +}); + +const { warnOnceAboutUnavailableDatabase, resetWarningState } = await import( + "./newPackagesDatabaseWarnings.js" +); + +describe("newPackagesDatabaseWarnings", () => { + beforeEach(() => { + writeWarningCalls = []; + resetWarningState(); + }); + + describe("warnOnceAboutUnavailableDatabase", () => { + it("emits a warning containing the error message", () => { + warnOnceAboutUnavailableDatabase(new Error("feed unavailable")); + + assert.strictEqual(writeWarningCalls.length, 1); + assert.ok(writeWarningCalls[0].includes("feed unavailable")); + }); + + it("mentions fallback to metadata-based checks in the warning", () => { + warnOnceAboutUnavailableDatabase(new Error("timeout")); + + assert.ok( + writeWarningCalls[0].includes( + "Continuing with metadata-based minimum age checks only" + ) + ); + }); + + it("only emits once even when called multiple times", () => { + warnOnceAboutUnavailableDatabase(new Error("first")); + warnOnceAboutUnavailableDatabase(new Error("second")); + warnOnceAboutUnavailableDatabase(new Error("third")); + + assert.strictEqual(writeWarningCalls.length, 1); + }); + }); + + describe("resetWarningState", () => { + it("allows the warning to fire again after reset", () => { + warnOnceAboutUnavailableDatabase(new Error("first")); + assert.strictEqual(writeWarningCalls.length, 1); + + resetWarningState(); + writeWarningCalls = []; + + warnOnceAboutUnavailableDatabase(new Error("second")); + assert.strictEqual(writeWarningCalls.length, 1); + }); + }); +}); diff --git a/packages/safe-chain/src/scanning/newPackagesListCache.js b/packages/safe-chain/src/scanning/newPackagesListCache.js new file mode 100644 index 0000000..418dbdd --- /dev/null +++ b/packages/safe-chain/src/scanning/newPackagesListCache.js @@ -0,0 +1,123 @@ +import fs from "fs"; +import { + fetchNewPackagesList, + fetchNewPackagesListVersion, +} from "../api/aikido.js"; +import { + getNewPackagesListPath, + getNewPackagesListVersionPath, +} from "../config/configFile.js"; +import { ui } from "../environment/userInteraction.js"; +import { buildNewPackagesDatabase } from "./newPackagesDatabaseBuilder.js"; +import { warnOnceAboutUnavailableDatabase } from "./newPackagesDatabaseWarnings.js"; + +/** + * @typedef {import("./newPackagesDatabaseBuilder.js").NewPackagesDatabase} NewPackagesDatabase + */ + +// Shared per-process cache to avoid rebuilding the same feed-backed database on each request. +// Caching the Promise (rather than the resolved database) prevents duplicate fetches. If we cached the resolved +// value, multiple callers could pass the null-check before the first fetch completes (because each `await` yields +// control back to the event loop, allowing other callers to run). Since the Promise assignment is synchronous, all +// concurrent callers see it immediately and share a single fetch. +/** @type {Promise | null} */ +let cachedNewPackagesDatabasePromise = null; + +/** + * @returns {Promise} + */ +export function openNewPackagesDatabase() { + if (!cachedNewPackagesDatabasePromise) { + cachedNewPackagesDatabasePromise = getNewPackagesList() + .then((newPackagesList) => buildNewPackagesDatabase(newPackagesList)) + .catch((/** @type {any} */ error) => { + warnOnceAboutUnavailableDatabase(error); + cachedNewPackagesDatabasePromise = null; + return { isNewlyReleasedPackage: () => false }; + }); + } + return cachedNewPackagesDatabasePromise; +} + +/** + * @returns {Promise} + */ +async function getNewPackagesList() { + const { newPackagesList: cachedList, version: cachedVersion } = + readNewPackagesListFromLocalCache(); + + try { + if (cachedList) { + const currentVersion = await fetchNewPackagesListVersion(); + if (cachedVersion === currentVersion) { + return cachedList; + } + } + + const { newPackagesList, version } = await fetchNewPackagesList(); + + if (version) { + writeNewPackagesListToLocalCache(newPackagesList, version); + return newPackagesList; + } else { + ui.writeWarning( + "The new packages list for direct package download request blocking was downloaded, but could not be cached due to a missing version." + ); + return newPackagesList; + } + } catch (/** @type {any} */ error) { + if (cachedList) { + ui.writeWarning( + "Failed to fetch the latest new packages list for direct package download request blocking. Using cached version." + ); + return cachedList; + } + throw error; + } +} + +/** + * @param {import("../api/aikido.js").NewPackageEntry[]} data + * @param {string | number} version + * + * @returns {void} + */ +export function writeNewPackagesListToLocalCache(data, version) { + try { + const listPath = getNewPackagesListPath(); + const versionPath = getNewPackagesListVersionPath(); + + fs.writeFileSync(listPath, JSON.stringify(data)); + fs.writeFileSync(versionPath, version.toString()); + } catch { + ui.writeWarning( + "Failed to write new packages list to local cache, next time the list will be fetched from the server again." + ); + } +} + +/** + * @returns {{newPackagesList: import("../api/aikido.js").NewPackageEntry[] | null, version: string | null}} + */ +export function readNewPackagesListFromLocalCache() { + try { + const listPath = getNewPackagesListPath(); + if (!fs.existsSync(listPath)) { + return { newPackagesList: null, version: null }; + } + + const data = fs.readFileSync(listPath, "utf8"); + const newPackagesList = JSON.parse(data); + const versionPath = getNewPackagesListVersionPath(); + let version = null; + if (fs.existsSync(versionPath)) { + version = fs.readFileSync(versionPath, "utf8").trim(); + } + return { newPackagesList, version }; + } catch { + ui.writeWarning( + "Failed to read new packages list from local cache. Continuing without local cache." + ); + return { newPackagesList: null, version: null }; + } +} diff --git a/packages/safe-chain/src/scanning/newPackagesListCache.spec.js b/packages/safe-chain/src/scanning/newPackagesListCache.spec.js new file mode 100644 index 0000000..503a0cc --- /dev/null +++ b/packages/safe-chain/src/scanning/newPackagesListCache.spec.js @@ -0,0 +1,178 @@ +import { describe, it, mock, beforeEach } from "node:test"; +import assert from "node:assert"; +import fs from "fs"; +import path from "path"; +import os from "os"; + +let writeWarningCalls = []; +let ecosystem = "js"; +let testHomeDir = ""; + +mock.module("../environment/userInteraction.js", { + namedExports: { + ui: { + writeWarning: (msg) => writeWarningCalls.push(msg), + }, + }, +}); + +mock.module("../config/settings.js", { + namedExports: { + getEcoSystem: () => ecosystem, + getMinimumPackageAgeHours: () => 24, + getMalwareListBaseUrl: () => "https://malware-list.aikido.dev", + ECOSYSTEM_JS: "js", + ECOSYSTEM_PY: "py", + }, +}); + +const { readNewPackagesListFromLocalCache, writeNewPackagesListToLocalCache } = + await import("./newPackagesListCache.js"); + +describe("newPackagesListCache", () => { + beforeEach(() => { + writeWarningCalls = []; + ecosystem = "js"; + testHomeDir = path.join( + os.tmpdir(), + `safe-chain-list-cache-${process.pid}-${Date.now()}` + ); + fs.rmSync(testHomeDir, { recursive: true, force: true }); + fs.mkdirSync(testHomeDir, { recursive: true }); + process.env.HOME = testHomeDir; + }); + + describe("readNewPackagesListFromLocalCache", () => { + it("returns null for both fields when no cache file exists", () => { + const result = readNewPackagesListFromLocalCache(); + + assert.deepStrictEqual(result, { newPackagesList: null, version: null }); + }); + + it("returns the list and version when both files exist", () => { + const list = [{ package_name: "foo", version: "1.0.0" }]; + const safeChainDir = path.join(testHomeDir, ".safe-chain"); + fs.mkdirSync(safeChainDir, { recursive: true }); + fs.writeFileSync( + path.join(safeChainDir, "newPackagesList_js.json"), + JSON.stringify(list) + ); + fs.writeFileSync( + path.join(safeChainDir, "newPackagesList_version_js.txt"), + "etag-42" + ); + + const result = readNewPackagesListFromLocalCache(); + + assert.deepStrictEqual(result.newPackagesList, list); + assert.strictEqual(result.version, "etag-42"); + }); + + it("returns null version when version file is missing", () => { + const list = [{ package_name: "foo", version: "1.0.0" }]; + const safeChainDir = path.join(testHomeDir, ".safe-chain"); + fs.mkdirSync(safeChainDir, { recursive: true }); + fs.writeFileSync( + path.join(safeChainDir, "newPackagesList_js.json"), + JSON.stringify(list) + ); + + const result = readNewPackagesListFromLocalCache(); + + assert.deepStrictEqual(result.newPackagesList, list); + assert.strictEqual(result.version, null); + }); + + it("trims whitespace from the version string", () => { + const safeChainDir = path.join(testHomeDir, ".safe-chain"); + fs.mkdirSync(safeChainDir, { recursive: true }); + fs.writeFileSync( + path.join(safeChainDir, "newPackagesList_js.json"), + JSON.stringify([]) + ); + fs.writeFileSync( + path.join(safeChainDir, "newPackagesList_version_js.txt"), + " etag-trimmed \n" + ); + + const { version } = readNewPackagesListFromLocalCache(); + + assert.strictEqual(version, "etag-trimmed"); + }); + + it("uses the ecosystem name in the file path", () => { + ecosystem = "py"; + const safeChainDir = path.join(testHomeDir, ".safe-chain"); + fs.mkdirSync(safeChainDir, { recursive: true }); + fs.writeFileSync( + path.join(safeChainDir, "newPackagesList_py.json"), + JSON.stringify([{ package_name: "requests", version: "2.0.0" }]) + ); + + const result = readNewPackagesListFromLocalCache(); + + assert.ok(result.newPackagesList !== null); + }); + + it("warns and returns nulls when the list file contains invalid JSON", () => { + const safeChainDir = path.join(testHomeDir, ".safe-chain"); + fs.mkdirSync(safeChainDir, { recursive: true }); + fs.writeFileSync( + path.join(safeChainDir, "newPackagesList_js.json"), + "not-valid-json" + ); + + const result = readNewPackagesListFromLocalCache(); + + assert.deepStrictEqual(result, { newPackagesList: null, version: null }); + assert.strictEqual(writeWarningCalls.length, 1); + assert.ok(writeWarningCalls[0].includes("local cache")); + }); + }); + + describe("writeNewPackagesListToLocalCache", () => { + it("writes the list and version to disk", () => { + const safeChainDir = path.join(testHomeDir, ".safe-chain"); + fs.mkdirSync(safeChainDir, { recursive: true }); + + const list = [{ package_name: "foo", version: "1.0.0" }]; + writeNewPackagesListToLocalCache(list, "etag-99"); + + const writtenList = JSON.parse( + fs.readFileSync(path.join(safeChainDir, "newPackagesList_js.json"), "utf8") + ); + const writtenVersion = fs.readFileSync( + path.join(safeChainDir, "newPackagesList_version_js.txt"), + "utf8" + ); + + assert.deepStrictEqual(writtenList, list); + assert.strictEqual(writtenVersion, "etag-99"); + }); + + it("converts a numeric version to a string", () => { + const safeChainDir = path.join(testHomeDir, ".safe-chain"); + fs.mkdirSync(safeChainDir, { recursive: true }); + + writeNewPackagesListToLocalCache([], 42); + + const written = fs.readFileSync( + path.join(safeChainDir, "newPackagesList_version_js.txt"), + "utf8" + ); + assert.strictEqual(written, "42"); + }); + + it("warns when writing fails", () => { + // Place a regular file at the .safe-chain path so getSafeChainDirectory + // returns it as-is (existsSync is true) but writing a child path fails. + const safeChainPath = path.join(testHomeDir, ".safe-chain"); + fs.writeFileSync(safeChainPath, "not-a-directory"); + + writeNewPackagesListToLocalCache([], "etag-fail"); + + assert.strictEqual(writeWarningCalls.length, 1); + assert.ok(writeWarningCalls[0].includes("local cache")); + }); + }); +}); diff --git a/packages/safe-chain/src/scanning/packageNameVariants.js b/packages/safe-chain/src/scanning/packageNameVariants.js new file mode 100644 index 0000000..64075f2 --- /dev/null +++ b/packages/safe-chain/src/scanning/packageNameVariants.js @@ -0,0 +1,29 @@ +import { ECOSYSTEM_PY } from "../config/settings.js"; + +/** + * Normalises a Python package name per PEP 503: lowercase and collapse any + * run of `.`, `_`, or `-` into a single hyphen. + * @param {string} packageName + * @returns {string} + */ +export function normalizePipPackageName(packageName) { + return packageName.toLowerCase().replace(/[._-]+/g, "-"); +} + +/** + * @param {string} packageName + * @param {string} ecosystem + * @returns {string[]} + */ +export function getEquivalentPackageNames(packageName, ecosystem) { + if (ecosystem !== ECOSYSTEM_PY) { + return [packageName]; + } + + const pythonSeparatorPattern = /[._-]/g; + const hyphenName = packageName.replaceAll(pythonSeparatorPattern, "-"); + const underscoreName = packageName.replaceAll(pythonSeparatorPattern, "_"); + const dotName = packageName.replaceAll(pythonSeparatorPattern, "."); + + return [...new Set([packageName, hyphenName, underscoreName, dotName])]; +} diff --git a/packages/safe-chain/src/shell-integration/helpers.js b/packages/safe-chain/src/shell-integration/helpers.js index 1d32e82..bc4ef6c 100644 --- a/packages/safe-chain/src/shell-integration/helpers.js +++ b/packages/safe-chain/src/shell-integration/helpers.js @@ -3,6 +3,8 @@ import * as os from "os"; import fs from "fs"; import path from "path"; import { ECOSYSTEM_JS, ECOSYSTEM_PY } from "../config/settings.js"; +import { safeSpawn } from "../utils/safeSpawn.js"; +import { ui } from "../environment/userInteraction.js"; /** * @typedef {Object} AikidoTool @@ -46,6 +48,18 @@ export const knownAikidoTools = [ ecoSystem: ECOSYSTEM_JS, internalPackageManagerName: "pnpx", }, + { + tool: "rush", + aikidoCommand: "aikido-rush", + ecoSystem: ECOSYSTEM_JS, + internalPackageManagerName: "rush", + }, + { + tool: "rushx", + aikidoCommand: "aikido-rushx", + ecoSystem: ECOSYSTEM_JS, + internalPackageManagerName: "rushx", + }, { tool: "bun", aikidoCommand: "aikido-bun", @@ -64,6 +78,12 @@ export const knownAikidoTools = [ ecoSystem: ECOSYSTEM_PY, internalPackageManagerName: "uv", }, + { + tool: "uvx", + aikidoCommand: "aikido-uvx", + ecoSystem: ECOSYSTEM_PY, + internalPackageManagerName: "uvx", + }, { tool: "pip", aikidoCommand: "aikido-pip", @@ -76,6 +96,12 @@ export const knownAikidoTools = [ ecoSystem: ECOSYSTEM_PY, internalPackageManagerName: "pip", }, + { + tool: "poetry", + aikidoCommand: "aikido-poetry", + ecoSystem: ECOSYSTEM_PY, + internalPackageManagerName: "poetry", + }, { tool: "python", aikidoCommand: "aikido-python", @@ -88,6 +114,18 @@ export const knownAikidoTools = [ ecoSystem: ECOSYSTEM_PY, internalPackageManagerName: "pip", }, + { + tool: "pipx", + aikidoCommand: "aikido-pipx", + ecoSystem: ECOSYSTEM_PY, + internalPackageManagerName: "pipx", + }, + { + tool: "pdm", + aikidoCommand: "aikido-pdm", + ecoSystem: ECOSYSTEM_PY, + internalPackageManagerName: "pdm", + }, // When adding a new tool here, also update the documentation for the new tool in the README.md ]; @@ -190,7 +228,13 @@ export function addLineToFile(filePath, line, eol) { eol = eol || os.EOL; const fileContent = fs.readFileSync(filePath, "utf-8"); - const updatedContent = fileContent + eol + line + eol; + let updatedContent = fileContent; + + if (!fileContent.endsWith(eol)) { + updatedContent += eol; + } + + updatedContent += line + eol; fs.writeFileSync(filePath, updatedContent, "utf-8"); } @@ -211,3 +255,60 @@ function createFileIfNotExists(filePath) { fs.writeFileSync(filePath, "", "utf-8"); } + +/** + * Checks if PowerShell execution policy allows script execution + * @param {string} shellExecutableName - The name of the PowerShell executable ("pwsh" or "powershell") + * @returns {Promise<{isValid: boolean, policy: string}>} validation result + */ +export async function validatePowerShellExecutionPolicy(shellExecutableName) { + // Security: Only allow known shell executables + const validShells = ["pwsh", "powershell"]; + if (!validShells.includes(shellExecutableName)) { + return { isValid: false, policy: "Unknown" }; + } + + try { + // For Windows PowerShell (5.1), clean PSModulePath to avoid conflicts with PowerShell 7 modules + // When safe-chain is invoked from PowerShell 7, it sets its module paths to PSModulePath, causing + // Windows PowerShell to try loading incompatible PowerShell 7 modules. + // Setting the environment to Windows PowerShell's modules fixes this. + let spawnOptions; + if (shellExecutableName === "powershell") { + const userProfile = process.env.USERPROFILE || ""; + const cleanPSModulePath = [ + path.join(userProfile, "Documents", "WindowsPowerShell", "Modules"), + "C:\\Program Files\\WindowsPowerShell\\Modules", + "C:\\WINDOWS\\system32\\WindowsPowerShell\\v1.0\\Modules", + ].join(";"); + + spawnOptions = { + env: { + ...process.env, + PSModulePath: cleanPSModulePath, + }, + }; + } else { + spawnOptions = {}; + } + + const commandResult = await safeSpawn( + shellExecutableName, + ["-Command", "Get-ExecutionPolicy"], + spawnOptions, + ); + + const policy = commandResult.stdout.trim(); + + const acceptablePolicies = ["RemoteSigned", "Unrestricted", "Bypass"]; + return { + isValid: acceptablePolicies.includes(policy), + policy: policy, + }; + } catch (err) { + ui.writeWarning( + `An error happened while trying to find the current executionpolicy in powershell: ${err}`, + ); + return { isValid: false, policy: "Unknown" }; + } +} diff --git a/packages/safe-chain/src/shell-integration/helpers.spec.js b/packages/safe-chain/src/shell-integration/helpers.spec.js index 4f18c36..e93a690 100644 --- a/packages/safe-chain/src/shell-integration/helpers.spec.js +++ b/packages/safe-chain/src/shell-integration/helpers.spec.js @@ -1,6 +1,6 @@ import { describe, it, beforeEach, afterEach, mock } from "node:test"; import assert from "node:assert"; -import { tmpdir } from "node:os"; +import { tmpdir, homedir } from "node:os"; import fs from "node:fs"; import path from "path"; @@ -15,6 +15,7 @@ describe("removeLinesMatchingPatternTests", () => { mock.module("node:os", { namedExports: { EOL: "\r\n", // Simulate Windows line endings + homedir, tmpdir: tmpdir, platform: () => "linux", }, @@ -182,3 +183,30 @@ describe("removeLinesMatchingPatternTests", () => { assert.strictEqual(resultLines.length, 5, "Should have exactly 5 lines"); }); }); + +describe("getSafeChainBaseDir / getBinDir / getShimsDir / getScriptsDir", () => { + it("defaults base dir to ~/.safe-chain when no packaged install dir is available", async () => { + const { getSafeChainBaseDir } = await import("../config/safeChainDir.js"); + assert.strictEqual(getSafeChainBaseDir(), path.join(homedir(), ".safe-chain")); + }); + + it("getBinDir returns ~/.safe-chain/bin by default", async () => { + const { getBinDir } = await import("../config/safeChainDir.js"); + assert.strictEqual(getBinDir(), path.join(homedir(), ".safe-chain", "bin")); + }); + + it("getShimsDir returns ~/.safe-chain/shims by default", async () => { + const { getShimsDir } = await import("../config/safeChainDir.js"); + assert.strictEqual(getShimsDir(), path.join(homedir(), ".safe-chain", "shims")); + }); + + it("getScriptsDir returns ~/.safe-chain/scripts by default", async () => { + const { getScriptsDir } = await import("../config/safeChainDir.js"); + assert.strictEqual(getScriptsDir(), path.join(homedir(), ".safe-chain", "scripts")); + }); + + it("getCertsDir returns ~/.safe-chain/certs by default", async () => { + const { getCertsDir } = await import("../config/safeChainDir.js"); + assert.strictEqual(getCertsDir(), path.join(homedir(), ".safe-chain", "certs")); + }); +}); diff --git a/packages/safe-chain/src/shell-integration/path-wrappers/templates/unix-wrapper.template.sh b/packages/safe-chain/src/shell-integration/path-wrappers/templates/unix-wrapper.template.sh index d6c9efd..30ab833 100644 --- a/packages/safe-chain/src/shell-integration/path-wrappers/templates/unix-wrapper.template.sh +++ b/packages/safe-chain/src/shell-integration/path-wrappers/templates/unix-wrapper.template.sh @@ -4,13 +4,31 @@ # Function to remove shim from PATH (POSIX-compliant) remove_shim_from_path() { - echo "$PATH" | sed "s|$HOME/.safe-chain/shims:||g" + _safe_chain_phys=$(CDPATH= cd -- "$(dirname -- "$0")" 2>/dev/null && pwd -P) + if [ -z "$_safe_chain_phys" ]; then + echo "$PATH" + return + fi + _path=$(echo "$PATH" | sed "s|${_safe_chain_phys}:||g") + # Also remove via dirname of $0 directly — on macOS /tmp is a symlink to /private/tmp, + # so pwd -P resolves to /private/tmp/… but PATH may still contain /tmp/…. + _dir=$(dirname -- "$0") + case "$_dir" in + /*) [ "$_dir" != "$_safe_chain_phys" ] && _path=$(echo "$_path" | sed "s|${_dir}:||g") ;; + esac + echo "$_path" } if command -v safe-chain >/dev/null 2>&1; then - # Remove shim directory from PATH when calling {{AIKIDO_COMMAND}} to prevent infinite loops + # Remove shim directory from PATH when calling {{AIKIDO_COMMAND}} to prevent infinite loops. + # Unset PKG_EXECPATH so the yao-pkg bootstrap inside the safe-chain binary doesn't + # mistake argv[1] for a script path and try to resolve "{{PACKAGE_MANAGER}}" against cwd. + unset PKG_EXECPATH PATH=$(remove_shim_from_path) exec safe-chain {{PACKAGE_MANAGER}} "$@" else + # safe-chain is not reachable — warn the user so they know protection is inactive + printf "\033[43;30mWarning:\033[0m safe-chain is not available to protect you from installing malware. {{PACKAGE_MANAGER}} will run without it.\n" >&2 + # Dynamically find original {{PACKAGE_MANAGER}} (excluding this shim directory) original_cmd=$(PATH=$(remove_shim_from_path) command -v {{PACKAGE_MANAGER}}) if [ -n "$original_cmd" ]; then diff --git a/packages/safe-chain/src/shell-integration/path-wrappers/templates/windows-wrapper.template.cmd b/packages/safe-chain/src/shell-integration/path-wrappers/templates/windows-wrapper.template.cmd index d941a56..b41fcfb 100644 --- a/packages/safe-chain/src/shell-integration/path-wrappers/templates/windows-wrapper.template.cmd +++ b/packages/safe-chain/src/shell-integration/path-wrappers/templates/windows-wrapper.template.cmd @@ -3,11 +3,12 @@ REM Generated wrapper for {{PACKAGE_MANAGER}} by safe-chain REM This wrapper intercepts {{PACKAGE_MANAGER}} calls for non-interactive environments REM Remove shim directory from PATH to prevent infinite loops -set "SHIM_DIR=%USERPROFILE%\.safe-chain\shims" +set "SHIM_DIR=%~dp0" +if "%SHIM_DIR:~-1%"=="\" set "SHIM_DIR=%SHIM_DIR:~0,-1%" call set "CLEAN_PATH=%%PATH:%SHIM_DIR%;=%%" REM Check if aikido command is available with clean PATH -set "PATH=%CLEAN_PATH%" & where {{AIKIDO_COMMAND}} >nul 2>&1 +set "PATH=%CLEAN_PATH%" & where safe-chain >nul 2>&1 if %errorlevel%==0 ( REM Call aikido command with clean PATH set "PATH=%CLEAN_PATH%" & safe-chain {{PACKAGE_MANAGER}} %* @@ -21,4 +22,4 @@ if %errorlevel%==0 ( REM If we get here, original command was not found echo Error: Could not find original {{PACKAGE_MANAGER}} >&2 exit /b 1 -) \ No newline at end of file +) diff --git a/packages/safe-chain/src/shell-integration/pkg-execpath-cleanup.spec.js b/packages/safe-chain/src/shell-integration/pkg-execpath-cleanup.spec.js new file mode 100644 index 0000000..4057224 --- /dev/null +++ b/packages/safe-chain/src/shell-integration/pkg-execpath-cleanup.spec.js @@ -0,0 +1,60 @@ +import { describe, it } from "node:test"; +import assert from "node:assert"; +import fs from "node:fs"; +import path from "node:path"; +import { fileURLToPath } from "node:url"; + +const __dirname = path.dirname(fileURLToPath(import.meta.url)); +const repoRoot = path.resolve(__dirname, "..", ".."); + +describe("PKG_EXECPATH cleanup", () => { + it("unix shim template unsets PKG_EXECPATH before invoking safe-chain", () => { + const file = path.join( + repoRoot, + "src/shell-integration/path-wrappers/templates/unix-wrapper.template.sh", + ); + const content = fs.readFileSync(file, "utf-8"); + assert.match( + content, + /unset PKG_EXECPATH[\s\S]*exec safe-chain/, + "unix-wrapper.template.sh must `unset PKG_EXECPATH` before `exec safe-chain`", + ); + }); + + it("posix shell function unsets PKG_EXECPATH before invoking safe-chain", () => { + const file = path.join( + repoRoot, + "src/shell-integration/startup-scripts/init-posix.sh", + ); + const content = fs.readFileSync(file, "utf-8"); + // Scoped subshell so we don't mutate the user's interactive env. + assert.match( + content, + /\(unset PKG_EXECPATH;\s*safe-chain "\$@"\)/, + "init-posix.sh must invoke safe-chain in a subshell that unsets PKG_EXECPATH", + ); + }); + + it("fish shell function unsets PKG_EXECPATH before invoking safe-chain", () => { + const file = path.join( + repoRoot, + "src/shell-integration/startup-scripts/init-fish.fish", + ); + const content = fs.readFileSync(file, "utf-8"); + assert.match( + content, + /env -u PKG_EXECPATH safe-chain/, + "init-fish.fish must invoke safe-chain via `env -u PKG_EXECPATH`", + ); + }); + + it("safe-chain entry point deletes PKG_EXECPATH from process.env", () => { + const file = path.join(repoRoot, "bin/safe-chain.js"); + const content = fs.readFileSync(file, "utf-8"); + assert.match( + content, + /delete process\.env\.PKG_EXECPATH/, + "bin/safe-chain.js must delete process.env.PKG_EXECPATH so spawned children don't inherit it", + ); + }); +}); diff --git a/packages/safe-chain/src/shell-integration/setup-ci.js b/packages/safe-chain/src/shell-integration/setup-ci.js index 28109fb..f9e6767 100644 --- a/packages/safe-chain/src/shell-integration/setup-ci.js +++ b/packages/safe-chain/src/shell-integration/setup-ci.js @@ -1,22 +1,14 @@ import chalk from "chalk"; import { ui } from "../environment/userInteraction.js"; import { getPackageManagerList, knownAikidoTools } from "./helpers.js"; +import { + getShimsDir, + getBinDir, + getPathWrapperTemplatePath, +} from "../config/safeChainDir.js"; import fs from "fs"; import os from "os"; import path from "path"; -import { fileURLToPath } from "url"; -import { includePython } from "../config/cliArguments.js"; -import { ECOSYSTEM_PY } from "../config/settings.js"; - -/** @type {string} */ -let dirname; - -if (import.meta.url) { - const filename = fileURLToPath(import.meta.url); - dirname = path.dirname(filename); -} else { - dirname = __dirname; -} /** * Loops over the detected shells and calls the setup function for each. @@ -28,8 +20,8 @@ export async function setupCi() { ); ui.emptyLine(); - const shimsDir = path.join(os.homedir(), ".safe-chain", "shims"); - const binDir = path.join(os.homedir(), ".safe-chain", "shims"); + const shimsDir = getShimsDir(); + const binDir = getBinDir(); // Create the shims directory if it doesn't exist if (!fs.existsSync(shimsDir)) { fs.mkdirSync(shimsDir, { recursive: true }); @@ -48,12 +40,7 @@ export async function setupCi() { */ function createUnixShims(shimsDir) { // Read the template file - const templatePath = path.resolve( - dirname, - "path-wrappers", - "templates", - "unix-wrapper.template.sh" - ); + const templatePath = getPathWrapperTemplatePath(import.meta.url, "unix-wrapper.template.sh"); if (!fs.existsSync(templatePath)) { ui.writeError(`Template file not found: ${templatePath}`); @@ -87,12 +74,7 @@ function createUnixShims(shimsDir) { */ function createWindowsShims(shimsDir) { // Read the template file - const templatePath = path.resolve( - dirname, - "path-wrappers", - "templates", - "windows-wrapper.template.cmd" - ); + const templatePath = getPathWrapperTemplatePath(import.meta.url, "windows-wrapper.template.cmd"); if (!fs.existsSync(templatePath)) { ui.writeError(`Windows template file not found: ${templatePath}`); @@ -155,12 +137,16 @@ function modifyPathForCi(shimsDir, binDir) { ui.writeInformation("##vso[task.prependpath]" + shimsDir); ui.writeInformation("##vso[task.prependpath]" + binDir); } + + if (process.env.BASH_ENV) { + // In CircleCI, persisting PATH across steps is done by appending shell exports + // to the file referenced by BASH_ENV. CircleCI sources this file for 'run' each step. + const exportLine = `export PATH="${shimsDir}:${binDir}:$PATH"` + os.EOL; + fs.appendFileSync(process.env.BASH_ENV, exportLine, "utf-8"); + ui.writeInformation(`Added shims directory to BASH_ENV for CircleCI.`); + } } function getToolsToSetup() { - if (includePython()) { - return knownAikidoTools; - } else { - return knownAikidoTools.filter((tool) => tool.ecoSystem !== ECOSYSTEM_PY); - } + return knownAikidoTools; } diff --git a/packages/safe-chain/src/shell-integration/setup-ci.spec.js b/packages/safe-chain/src/shell-integration/setup-ci.spec.js index 92ef82e..7af41d6 100644 --- a/packages/safe-chain/src/shell-integration/setup-ci.spec.js +++ b/packages/safe-chain/src/shell-integration/setup-ci.spec.js @@ -22,12 +22,12 @@ describe("Setup CI shell integration", () => { fs.mkdirSync(path.join(mockTemplateDir, "path-wrappers", "templates"), { recursive: true }); fs.writeFileSync( path.join(mockTemplateDir, "path-wrappers", "templates", "unix-wrapper.template.sh"), - "#!/bin/bash\n# Template for {{PACKAGE_MANAGER}}\nexec {{AIKIDO_COMMAND}} \"$@\"\n", + "#!/bin/bash\n# Template for {{PACKAGE_MANAGER}}\n_safe_chain_shims=$(CDPATH= cd -- \"$(dirname -- \"$0\")\" 2>/dev/null && pwd -P)\nexec {{AIKIDO_COMMAND}} \"$@\"\n", "utf-8" ); fs.writeFileSync( path.join(mockTemplateDir, "path-wrappers", "templates", "windows-wrapper.template.cmd"), - "@echo off\nREM Template for {{PACKAGE_MANAGER}}\n{{AIKIDO_COMMAND}} %*\n", + "@echo off\nset \"SHIM_DIR=%~dp0\"\n{{AIKIDO_COMMAND}} %*\n", "utf-8" ); @@ -53,6 +53,15 @@ describe("Setup CI shell integration", () => { }, }); + mock.module("../config/safeChainDir.js", { + namedExports: { + getShimsDir: () => mockShimsDir, + getBinDir: () => path.join(mockHomeDir, ".safe-chain", "bin"), + getPathWrapperTemplatePath: (_moduleUrl, fileName) => + path.join(mockTemplateDir, "path-wrappers", "templates", fileName), + }, + }); + // Mock os module mock.module("os", { namedExports: { @@ -62,22 +71,6 @@ describe("Setup CI shell integration", () => { }, }); - // Mock path module to resolve templates correctly - mock.module("path", { - namedExports: { - join: path.join, - dirname: () => mockTemplateDir, - resolve: (...args) => path.resolve(mockTemplateDir, ...args.slice(1)), - }, - }); - - // Mock fileURLToPath - mock.module("url", { - namedExports: { - fileURLToPath: () => path.join(mockTemplateDir, "setup-ci.js"), - }, - }); - // Import setupCi module after mocking setupCi = (await import("./setup-ci.js")).setupCi; }); @@ -118,6 +111,10 @@ describe("Setup CI shell integration", () => { const npmShimContent = fs.readFileSync(npmShimPath, "utf-8"); assert.ok(npmShimContent.includes("aikido-npm"), "npm shim should contain aikido-npm"); assert.ok(npmShimContent.includes("#!/bin/bash"), "npm shim should have bash shebang"); + assert.ok( + npmShimContent.includes("_safe_chain_shims=$(CDPATH= cd -- \"$(dirname -- \"$0\")\" 2>/dev/null && pwd -P)"), + "npm shim should derive the shims directory from its own location", + ); }); it("should create Windows .cmd shims on win32 platform", async () => { @@ -141,6 +138,10 @@ describe("Setup CI shell integration", () => { assert.ok(npmShimContent.includes("aikido-npm"), "npm.cmd should contain aikido-npm"); assert.ok(npmShimContent.includes("@echo off"), "npm.cmd should have Windows batch header"); assert.ok(npmShimContent.includes("%*"), "npm.cmd should use Windows argument passing"); + assert.ok( + npmShimContent.includes('set "SHIM_DIR=%~dp0"'), + "npm.cmd should derive the shims directory from its own location", + ); // Verify Unix shims were NOT created const unixNpmShim = path.join(mockShimsDir, "npm"); diff --git a/packages/safe-chain/src/shell-integration/setup.js b/packages/safe-chain/src/shell-integration/setup.js index 45a1fb8..04534df 100644 --- a/packages/safe-chain/src/shell-integration/setup.js +++ b/packages/safe-chain/src/shell-integration/setup.js @@ -2,21 +2,9 @@ import chalk from "chalk"; import { ui } from "../environment/userInteraction.js"; import { detectShells } from "./shellDetection.js"; import { knownAikidoTools, getPackageManagerList } from "./helpers.js"; +import { getScriptsDir, getStartupScriptSourcePath } from "../config/safeChainDir.js"; import fs from "fs"; -import os from "os"; import path from "path"; -import { includePython } from "../config/cliArguments.js"; -import { fileURLToPath } from "url"; - -/** @type {string} */ -let dirname; - -if (import.meta.url) { - const filename = fileURLToPath(import.meta.url); - dirname = path.dirname(filename); -} else { - dirname = __dirname; -} /** * Loops over the detected shells and calls the setup function for each. @@ -24,7 +12,7 @@ if (import.meta.url) { export async function setup() { ui.writeInformation( chalk.bold("Setting up shell aliases.") + - ` This will wrap safe-chain around ${getPackageManagerList()}.` + ` This will wrap safe-chain around ${getPackageManagerList()}.`, ); ui.emptyLine(); @@ -40,12 +28,12 @@ export async function setup() { ui.writeInformation( `Detected ${shells.length} supported shell(s): ${shells .map((shell) => chalk.bold(shell.name)) - .join(", ")}.` + .join(", ")}.`, ); let updatedCount = 0; for (const shell of shells) { - if (setupShell(shell)) { + if (await setupShell(shell)) { updatedCount++; } } @@ -56,7 +44,7 @@ export async function setup() { } } catch (/** @type {any} */ error) { ui.writeError( - `Failed to set up shell aliases: ${error.message}. Please check your shell configuration.` + `Failed to set up shell aliases: ${error.message}. Please check your shell configuration.`, ); return; } @@ -66,12 +54,12 @@ export async function setup() { * Calls the setup function for the given shell and reports the result. * @param {import("./shellDetection.js").Shell} shell */ -function setupShell(shell) { +async function setupShell(shell) { let success = false; let error; try { shell.teardown(knownAikidoTools); // First, tear down to prevent duplicate aliases - success = shell.setup(knownAikidoTools); + success = await shell.setup(knownAikidoTools); } catch (/** @type {any} */ err) { success = false; error = err; @@ -80,14 +68,12 @@ function setupShell(shell) { if (success) { ui.writeInformation( `${chalk.bold("- " + shell.name + ":")} ${chalk.green( - "Setup successful" - )}` + "Setup successful", + )}`, ); } else { ui.writeError( - `${chalk.bold("- " + shell.name + ":")} ${chalk.red( - "Setup failed" - )}. Please check your ${shell.name} configuration.` + `${chalk.bold("- " + shell.name + ":")} ${chalk.red("Setup failed")}`, ); if (error) { let message = ` Error: ${error.message}`; @@ -96,6 +82,12 @@ function setupShell(shell) { } ui.writeError(message); } + ui.emptyLine(); + ui.writeInformation(` ${chalk.bold("To set up manually:")}`); + for (const instruction of shell.getManualSetupInstructions()) { + ui.writeInformation(` ${instruction}`); + } + ui.emptyLine(); } return success; @@ -103,21 +95,16 @@ function setupShell(shell) { function copyStartupFiles() { const startupFiles = ["init-posix.sh", "init-pwsh.ps1", "init-fish.fish"]; + const targetDir = getScriptsDir(); for (const file of startupFiles) { - const targetDir = path.join(os.homedir(), ".safe-chain", "scripts"); - const targetPath = path.join(os.homedir(), ".safe-chain", "scripts", file); + const targetPath = path.join(targetDir, file); if (!fs.existsSync(targetDir)) { fs.mkdirSync(targetDir, { recursive: true }); } - // Use absolute path for source - const sourcePath = path.join( - dirname, - includePython() ? "startup-scripts/include-python" : "startup-scripts", - file - ); + const sourcePath = getStartupScriptSourcePath(import.meta.url, file); fs.copyFileSync(sourcePath, targetPath); } } diff --git a/packages/safe-chain/src/shell-integration/shellDetection.js b/packages/safe-chain/src/shell-integration/shellDetection.js index 9e0f110..c471244 100644 --- a/packages/safe-chain/src/shell-integration/shellDetection.js +++ b/packages/safe-chain/src/shell-integration/shellDetection.js @@ -9,8 +9,10 @@ import { ui } from "../environment/userInteraction.js"; * @typedef {Object} Shell * @property {string} name * @property {() => boolean} isInstalled - * @property {(tools: import("./helpers.js").AikidoTool[]) => boolean} setup + * @property {(tools: import("./helpers.js").AikidoTool[]) => boolean|Promise} setup * @property {(tools: import("./helpers.js").AikidoTool[]) => boolean} teardown + * @property {() => string[]} getManualSetupInstructions + * @property {() => string[]} getManualTeardownInstructions */ /** @@ -28,7 +30,7 @@ export function detectShells() { } } catch (/** @type {any} */ error) { ui.writeError( - `We were not able to detect which shells are installed on your system. Please check your shell configuration. Error: ${error.message}` + `We were not able to detect which shells are installed on your system. Please check your shell configuration. Error: ${error.message}`, ); return []; } diff --git a/packages/safe-chain/src/shell-integration/startup-scripts/include-python/init-fish.fish b/packages/safe-chain/src/shell-integration/startup-scripts/include-python/init-fish.fish deleted file mode 100644 index 81e28ef..0000000 --- a/packages/safe-chain/src/shell-integration/startup-scripts/include-python/init-fish.fish +++ /dev/null @@ -1,94 +0,0 @@ -set -gx PATH $PATH $HOME/.safe-chain/bin - -function printSafeChainWarning - set original_cmd $argv[1] - - # Fish equivalent of ANSI color codes: yellow background, black text for "Warning:" - set_color -b yellow black - printf "Warning:" - set_color normal - printf " safe-chain is not available to protect you from installing malware. %s will run without it.\n" $original_cmd - - # Cyan text for the install command - printf "Install safe-chain by using " - set_color cyan - printf "npm install -g @aikidosec/safe-chain" - set_color normal - printf ".\n" -end - -function wrapSafeChainCommand - set original_cmd $argv[1] - set cmd_args $argv[2..-1] - - if type -q safe-chain - # If the safe-chain command is available, just run it with the provided arguments - safe-chain $original_cmd $cmd_args - else - # If the safe-chain command is not available, print a warning and run the original command - printSafeChainWarning $original_cmd - command $original_cmd $cmd_args - end -end - -function npx - wrapSafeChainCommand "npx" $argv -end - -function yarn - wrapSafeChainCommand "yarn" $argv -end - -function pnpm - wrapSafeChainCommand "pnpm" $argv -end - -function pnpx - wrapSafeChainCommand "pnpx" $argv -end - -function bun - wrapSafeChainCommand "bun" $argv -end - -function bunx - wrapSafeChainCommand "bunx" $argv -end - -function npm - # If args is just -v or --version and nothing else, just run the `npm -v` command - # This is because nvm uses this to check the version of npm - set argc (count $argv) - if test $argc -eq 1 - switch $argv[1] - case "-v" "--version" - command npm $argv - return - end - end - - wrapSafeChainCommand "npm" $argv -end - - -function pip - wrapSafeChainCommand "pip" $argv -end - -function pip3 - wrapSafeChainCommand "pip3" $argv -end - -function uv - wrapSafeChainCommand "uv" $argv -end - -# `python -m pip`, `python -m pip3`. -function python - wrapSafeChainCommand "python" $argv -end - -# `python3 -m pip`, `python3 -m pip3'. -function python3 - wrapSafeChainCommand "python3" $argv -end diff --git a/packages/safe-chain/src/shell-integration/startup-scripts/include-python/init-posix.sh b/packages/safe-chain/src/shell-integration/startup-scripts/include-python/init-posix.sh deleted file mode 100644 index fd844fc..0000000 --- a/packages/safe-chain/src/shell-integration/startup-scripts/include-python/init-posix.sh +++ /dev/null @@ -1,81 +0,0 @@ -export PATH="$PATH:$HOME/.safe-chain/bin" - -function printSafeChainWarning() { - # \033[43;30m is used to set the background color to yellow and text color to black - # \033[0m is used to reset the text formatting - printf "\033[43;30mWarning:\033[0m safe-chain is not available to protect you from installing malware. %s will run without it.\n" "$1" - # \033[36m is used to set the text color to cyan - printf "Install safe-chain by using \033[36mnpm install -g @aikidosec/safe-chain\033[0m.\n" -} - -function wrapSafeChainCommand() { - local original_cmd="$1" - - if command -v safe-chain > /dev/null 2>&1; then - # If the aikido command is available, just run it with the provided arguments - safe-chain "$@" - else - # If the aikido command is not available, print a warning and run the original command - printSafeChainWarning "$original_cmd" - - command "$original_cmd" "$@" - fi -} - -function npx() { - wrapSafeChainCommand "npx" "$@" -} - -function yarn() { - wrapSafeChainCommand "yarn" "$@" -} - -function pnpm() { - wrapSafeChainCommand "pnpm" "$@" -} - -function pnpx() { - wrapSafeChainCommand "pnpx" "$@" -} - -function bun() { - wrapSafeChainCommand "bun" "$@" -} - -function bunx() { - wrapSafeChainCommand "bunx" "$@" -} - -function npm() { - if [[ "$1" == "-v" || "$1" == "--version" ]] && [[ $# -eq 1 ]]; then - # If args is just -v or --version and nothing else, just run the npm version command - # This is because nvm uses this to check the version of npm - command npm "$@" - return - fi - - wrapSafeChainCommand "npm" "$@" -} - - -function pip() { - wrapSafeChainCommand "pip" "$@" -} - -function pip3() { - wrapSafeChainCommand "pip3" "$@" -} - -function uv() { - wrapSafeChainCommand "uv" "$@" -} - -# `python -m pip`, `python -m pip3`. -function python() { - wrapSafeChainCommand "python" "$@" -} - -# `python3 -m pip`, `python3 -m pip3'. -function python3() { - wrapSafeChainCommand "python3" "$@" -} diff --git a/packages/safe-chain/src/shell-integration/startup-scripts/include-python/init-pwsh.ps1 b/packages/safe-chain/src/shell-integration/startup-scripts/include-python/init-pwsh.ps1 deleted file mode 100644 index 50a6d0b..0000000 --- a/packages/safe-chain/src/shell-integration/startup-scripts/include-python/init-pwsh.ps1 +++ /dev/null @@ -1,115 +0,0 @@ -# Use cross-platform path separator (: on Unix, ; on Windows) -$pathSeparator = if ($IsWindows) { ';' } else { ':' } -$safeChainBin = Join-Path $HOME '.safe-chain' 'bin' -$env:PATH = "$env:PATH$pathSeparator$safeChainBin" - -function Write-SafeChainWarning { - param([string]$Command) - - # PowerShell equivalent of ANSI color codes: yellow background, black text for "Warning:" - Write-Host "Warning:" -BackgroundColor Yellow -ForegroundColor Black -NoNewline - Write-Host " safe-chain is not available to protect you from installing malware. $Command will run without it." - - # Cyan text for the install command - Write-Host "Install safe-chain by using " -NoNewline - Write-Host "npm install -g @aikidosec/safe-chain" -ForegroundColor Cyan -NoNewline - Write-Host "." -} - -function Test-CommandAvailable { - param([string]$Command) - - try { - Get-Command $Command -ErrorAction Stop | Out-Null - return $true - } - catch { - return $false - } -} - -function Invoke-RealCommand { - param( - [string]$Command, - [string[]]$Arguments - ) - - # Find the real executable to avoid calling our wrapped functions - $realCommand = Get-Command -Name $Command -CommandType Application | Select-Object -First 1 - if ($realCommand) { - & $realCommand.Source @Arguments - } -} - -function Invoke-WrappedCommand { - param( - [string]$OriginalCmd, - [string[]]$Arguments - ) - - if (Test-CommandAvailable "safe-chain") { - & safe-chain $OriginalCmd @Arguments - } - else { - Write-SafeChainWarning $OriginalCmd - Invoke-RealCommand $OriginalCmd $Arguments - } -} - -function npx { - Invoke-WrappedCommand "npx" $args -} - -function yarn { - Invoke-WrappedCommand "yarn" $args -} - -function pnpm { - Invoke-WrappedCommand "pnpm" $args -} - -function pnpx { - Invoke-WrappedCommand "pnpx" $args -} - -function bun { - Invoke-WrappedCommand "bun" $args -} - -function bunx { - Invoke-WrappedCommand "bunx" $args -} - -function npm { - # If args is just -v or --version and nothing else, just run the npm version command - # This is because nvm uses this to check the version of npm - if (($args.Length -eq 1) -and (($args[0] -eq "-v") -or ($args[0] -eq "--version"))) { - Invoke-RealCommand "npm" $args - return - } - - Invoke-WrappedCommand "npm" $args -} - -function pip { - Invoke-WrappedCommand "pip" $args -} - -function pip3 { - Invoke-WrappedCommand "pip3" $args -} - -function uv { - Invoke-WrappedCommand "uv" $args -} - -# `python -m pip`, `python -m pip3`. -function python { - Invoke-WrappedCommand 'python' $args -} - -# `python3 -m pip`, `python3 -m pip3'. -function python3 { - Invoke-WrappedCommand 'python3' $args -} - diff --git a/packages/safe-chain/src/shell-integration/startup-scripts/init-fish.fish b/packages/safe-chain/src/shell-integration/startup-scripts/init-fish.fish index f697da2..697cc80 100644 --- a/packages/safe-chain/src/shell-integration/startup-scripts/init-fish.fish +++ b/packages/safe-chain/src/shell-integration/startup-scripts/init-fish.fish @@ -1,35 +1,7 @@ -set -gx PATH $PATH $HOME/.safe-chain/bin - -function printSafeChainWarning - set original_cmd $argv[1] - - # Fish equivalent of ANSI color codes: yellow background, black text for "Warning:" - set_color -b yellow black - printf "Warning:" - set_color normal - printf " safe-chain is not available to protect you from installing malware. %s will run without it.\n" $original_cmd - - # Cyan text for the install command - printf "Install safe-chain by using " - set_color cyan - printf "npm install -g @aikidosec/safe-chain" - set_color normal - printf ".\n" -end - -function wrapSafeChainCommand - set original_cmd $argv[1] - set cmd_args $argv[2..-1] - - if type -q safe-chain - # If the safe-chain command is available, just run it with the provided arguments - safe-chain $original_cmd $cmd_args - else - # If the safe-chain command is not available, print a warning and run the original command - printSafeChainWarning $original_cmd - command $original_cmd $cmd_args - end -end +set -l safe_chain_script (status filename) +set -l safe_chain_scripts_dir (dirname $safe_chain_script) +set -l safe_chain_base (dirname $safe_chain_scripts_dir) +set -gx PATH $PATH $safe_chain_base/bin function npx wrapSafeChainCommand "npx" $argv @@ -47,6 +19,14 @@ function pnpx wrapSafeChainCommand "pnpx" $argv end +function rush + wrapSafeChainCommand "rush" $argv +end + +function rushx + wrapSafeChainCommand "rushx" $argv +end + function bun wrapSafeChainCommand "bun" $argv end @@ -69,3 +49,88 @@ function npm wrapSafeChainCommand "npm" $argv end + +function pip + wrapSafeChainCommand "pip" $argv +end + +function pip3 + wrapSafeChainCommand "pip3" $argv +end + +function uv + wrapSafeChainCommand "uv" $argv +end + +function uvx + wrapSafeChainCommand "uvx" $argv +end + +function poetry + wrapSafeChainCommand "poetry" $argv +end + +# `python -m pip`, `python -m pip3`. +function python + wrapSafeChainCommand "python" $argv +end + +# `python3 -m pip`, `python3 -m pip3'. +function python3 + wrapSafeChainCommand "python3" $argv +end + +function pipx + wrapSafeChainCommand "pipx" $argv +end + +function pdm + wrapSafeChainCommand "pdm" $argv +end + +function printSafeChainWarning + set original_cmd $argv[1] + + # Fish equivalent of ANSI color codes: yellow background, black text for "Warning:" + set_color -b yellow black + printf "Warning:" + set_color normal + printf " safe-chain is not available to protect you from installing malware. %s will run without it.\n" $original_cmd + + # Cyan text for the install command + printf "Install safe-chain by using " + set_color cyan + printf "npm install -g @aikidosec/safe-chain" + set_color normal + printf ".\n" +end + +function wrapSafeChainCommand + set original_cmd $argv[1] + set cmd_args $argv[2..-1] + + if not type -fq $original_cmd + # If the original command is not available, don't try to wrap it: invoke + # it transparently, so the shell can report errors as if this wrapper + # didn't exist. fish always adds extra debug information when executing + # missing commands from within a function, so after the "command not + # found" handler, there will be information about how the + # wrapSafeChainCommand function errored out. To avoid users assuming this + # is a safe-chain bug, display an explicit error message afterwards. + command $original_cmd $cmd_args + set oldstatus $status + echo "safe-chain tried to run $original_cmd but it doesn't seem to be installed in your \$PATH." >&2 + return $oldstatus + end + + if type -q safe-chain + # If the safe-chain command is available, just run it with the provided arguments. + # Unset PKG_EXECPATH for this invocation so the yao-pkg bootstrap inside the + # safe-chain binary doesn't mistake argv[1] for a script path to resolve against cwd. + env -u PKG_EXECPATH safe-chain $original_cmd $cmd_args + else + # If the safe-chain command is not available, print a warning and run the original command + printSafeChainWarning $original_cmd + command $original_cmd $cmd_args + end +end diff --git a/packages/safe-chain/src/shell-integration/startup-scripts/init-posix.sh b/packages/safe-chain/src/shell-integration/startup-scripts/init-posix.sh index 6d426c5..df5623d 100644 --- a/packages/safe-chain/src/shell-integration/startup-scripts/init-posix.sh +++ b/packages/safe-chain/src/shell-integration/startup-scripts/init-posix.sh @@ -1,26 +1,16 @@ -export PATH="$PATH:$HOME/.safe-chain/bin" - -function printSafeChainWarning() { - # \033[43;30m is used to set the background color to yellow and text color to black - # \033[0m is used to reset the text formatting - printf "\033[43;30mWarning:\033[0m safe-chain is not available to protect you from installing malware. %s will run without it.\n" "$1" - # \033[36m is used to set the text color to cyan - printf "Install safe-chain by using \033[36mnpm install -g @aikidosec/safe-chain\033[0m.\n" -} - -function wrapSafeChainCommand() { - local original_cmd="$1" - - if command -v safe-chain > /dev/null 2>&1; then - # If the aikido command is available, just run it with the provided arguments - safe-chain "$@" - else - # If the aikido command is not available, print a warning and run the original command - printSafeChainWarning "$original_cmd" - - command "$original_cmd" "$@" - fi -} +if [ -n "${BASH_SOURCE[0]:-}" ]; then + _sc_script_path="${BASH_SOURCE[0]}" +elif [ -n "${ZSH_VERSION:-}" ]; then + # ${(%):-%x} uses Zsh prompt expansion to get the sourced file's path. + # eval is required so other shells don't try to parse the Zsh-specific syntax. + eval '_sc_script_path="${(%):-%x}"' +else + _sc_script_path="$0" +fi +_sc_scripts_dir=$(CDPATH= cd -- "$(dirname -- "$_sc_script_path")" 2>/dev/null && pwd -P) +_sc_base=$(dirname -- "$_sc_scripts_dir") +export PATH="$PATH:${_sc_base}/bin" +unset _sc_base _sc_script_path _sc_scripts_dir function npx() { wrapSafeChainCommand "npx" "$@" @@ -38,6 +28,14 @@ function pnpx() { wrapSafeChainCommand "pnpx" "$@" } +function rush() { + wrapSafeChainCommand "rush" "$@" +} + +function rushx() { + wrapSafeChainCommand "rushx" "$@" +} + function bun() { wrapSafeChainCommand "bun" "$@" } @@ -56,3 +54,73 @@ function npm() { wrapSafeChainCommand "npm" "$@" } + +function pip() { + wrapSafeChainCommand "pip" "$@" +} + +function pip3() { + wrapSafeChainCommand "pip3" "$@" +} + +function uv() { + wrapSafeChainCommand "uv" "$@" +} + +function uvx() { + wrapSafeChainCommand "uvx" "$@" +} + +function poetry() { + wrapSafeChainCommand "poetry" "$@" +} + +# `python -m pip`, `python -m pip3`. +function python() { + wrapSafeChainCommand "python" "$@" +} + +# `python3 -m pip`, `python3 -m pip3'. +function python3() { + wrapSafeChainCommand "python3" "$@" +} + +function pipx() { + wrapSafeChainCommand "pipx" "$@" +} + +function pdm() { + wrapSafeChainCommand "pdm" "$@" +} + +function printSafeChainWarning() { + # \033[43;30m is used to set the background color to yellow and text color to black + # \033[0m is used to reset the text formatting + printf "\033[43;30mWarning:\033[0m safe-chain is not available to protect you from installing malware. %s will run without it.\n" "$1" + # \033[36m is used to set the text color to cyan + printf "Install safe-chain by using \033[36mnpm install -g @aikidosec/safe-chain\033[0m.\n" +} + +function wrapSafeChainCommand() { + local original_cmd="$1" + + if ! type -f "${original_cmd}" > /dev/null 2>&1; then + # If the original command is not available, don't try to wrap it: invoke it + # transparently, so the shell can report errors as if this wrapper didn't + # exist. + command "$@" + return $? + fi + + if command -v safe-chain > /dev/null 2>&1; then + # If the aikido command is available, just run it with the provided arguments. + # Unset PKG_EXECPATH so the yao-pkg bootstrap inside the safe-chain binary doesn't + # mistake argv[1] for a script path and try to resolve it against cwd. + (unset PKG_EXECPATH; safe-chain "$@") + else + # If the aikido command is not available, print a warning and run the original command + printSafeChainWarning "$original_cmd" + + command "$@" + fi +} diff --git a/packages/safe-chain/src/shell-integration/startup-scripts/init-pwsh.ps1 b/packages/safe-chain/src/shell-integration/startup-scripts/init-pwsh.ps1 index ddf5aee..fb63ce8 100644 --- a/packages/safe-chain/src/shell-integration/startup-scripts/init-pwsh.ps1 +++ b/packages/safe-chain/src/shell-integration/startup-scripts/init-pwsh.ps1 @@ -1,8 +1,92 @@ # Use cross-platform path separator (: on Unix, ; on Windows) -$pathSeparator = if ($IsWindows) { ';' } else { ':' } -$safeChainBin = Join-Path $HOME '.safe-chain' 'bin' +# $IsWindows is only available in PowerShell Core 6.0+. If it doesn't exist, assume Windows PowerShell +$isWindowsPlatform = if (Test-Path variable:IsWindows) { $IsWindows } else { $true } +$pathSeparator = if ($isWindowsPlatform) { ';' } else { ':' } +$safeChainBase = Split-Path -Parent $PSScriptRoot +$safeChainBin = Join-Path $safeChainBase 'bin' $env:PATH = "$env:PATH$pathSeparator$safeChainBin" +function npx { + Invoke-WrappedCommand "npx" $args $MyInvocation.Line $MyInvocation.OffsetInLine +} + +function yarn { + Invoke-WrappedCommand "yarn" $args $MyInvocation.Line $MyInvocation.OffsetInLine +} + +function pnpm { + Invoke-WrappedCommand "pnpm" $args $MyInvocation.Line $MyInvocation.OffsetInLine +} + +function pnpx { + Invoke-WrappedCommand "pnpx" $args $MyInvocation.Line $MyInvocation.OffsetInLine +} + +function rush { + Invoke-WrappedCommand "rush" $args $MyInvocation.Line $MyInvocation.OffsetInLine +} + +function rushx { + Invoke-WrappedCommand "rushx" $args $MyInvocation.Line $MyInvocation.OffsetInLine +} + +function bun { + Invoke-WrappedCommand "bun" $args $MyInvocation.Line $MyInvocation.OffsetInLine +} + +function bunx { + Invoke-WrappedCommand "bunx" $args $MyInvocation.Line $MyInvocation.OffsetInLine +} + +function npm { + # If args is just -v or --version and nothing else, just run the npm version command + # This is because nvm uses this to check the version of npm + if (($args.Length -eq 1) -and (($args[0] -eq "-v") -or ($args[0] -eq "--version"))) { + Invoke-RealCommand "npm" $args + return + } + + Invoke-WrappedCommand "npm" $args $MyInvocation.Line $MyInvocation.OffsetInLine +} + +function pip { + Invoke-WrappedCommand "pip" $args $MyInvocation.Line $MyInvocation.OffsetInLine +} + +function pip3 { + Invoke-WrappedCommand "pip3" $args $MyInvocation.Line $MyInvocation.OffsetInLine +} + +function uv { + Invoke-WrappedCommand "uv" $args $MyInvocation.Line $MyInvocation.OffsetInLine +} + +function uvx { + Invoke-WrappedCommand "uvx" $args $MyInvocation.Line $MyInvocation.OffsetInLine +} + +function poetry { + Invoke-WrappedCommand "poetry" $args $MyInvocation.Line $MyInvocation.OffsetInLine +} + +# `python -m pip`, `python -m pip3`. +function python { + Invoke-WrappedCommand 'python' $args $MyInvocation.Line $MyInvocation.OffsetInLine +} + +# `python3 -m pip`, `python3 -m pip3'. +function python3 { + Invoke-WrappedCommand 'python3' $args $MyInvocation.Line $MyInvocation.OffsetInLine +} + +function pipx { + Invoke-WrappedCommand "pipx" $args $MyInvocation.Line $MyInvocation.OffsetInLine +} + +function pdm { + Invoke-WrappedCommand "pdm" $args $MyInvocation.Line $MyInvocation.OffsetInLine +} + function Write-SafeChainWarning { param([string]$Command) @@ -41,13 +125,60 @@ function Invoke-RealCommand { } } +function Get-ReconstructedArguments { + param( + [string]$RawLine, + [int]$RawOffset + ) + + if (-not $RawLine) { return $null } + + $tokens = [System.Management.Automation.PSParser]::Tokenize($RawLine, [ref]$null) + $newArgs = @() + $foundCommand = $false + + foreach ($t in $tokens) { + if (-not $foundCommand) { + if ($t.Start -eq ($RawOffset - 1)) { $foundCommand = $true } + continue + } + + if ($t.Type -eq 'Operator' -and $t.Content -match '[|;&]') { break } + + # Stop if complex variable expansion is used + if ($t.Type -eq 'Variable' -or $t.Type -eq 'Group' -or $t.Type -eq 'SubExpression') { + return $null + } + + $newArgs += $t.Content + } + + if ($foundCommand) { + return ,$newArgs + } + return $null +} + function Invoke-WrappedCommand { param( [string]$OriginalCmd, - [string[]]$Arguments + [string[]]$Arguments, + [string]$RawLine = $null, + [int]$RawOffset = 0 ) - if (Test-CommandAvailable "safe-chain") { + # Use raw line parsing to recover arguments like '--' that PowerShell consumes + if ($RawLine) { + $reconstructedArgs = Get-ReconstructedArguments $RawLine $RawOffset + if ($null -ne $reconstructedArgs) { + $Arguments = $reconstructedArgs + } + } + + if ($isWindowsPlatform -and (Test-CommandAvailable "safe-chain.cmd")) { + & safe-chain.cmd $OriginalCmd @Arguments + } + elseif (Test-CommandAvailable "safe-chain") { & safe-chain $OriginalCmd @Arguments } else { @@ -55,38 +186,3 @@ function Invoke-WrappedCommand { Invoke-RealCommand $OriginalCmd $Arguments } } - -function npx { - Invoke-WrappedCommand "npx" $args -} - -function yarn { - Invoke-WrappedCommand "yarn" $args -} - -function pnpm { - Invoke-WrappedCommand "pnpm" $args -} - -function pnpx { - Invoke-WrappedCommand "pnpx" $args -} - -function bun { - Invoke-WrappedCommand "bun" $args -} - -function bunx { - Invoke-WrappedCommand "bunx" $args -} - -function npm { - # If args is just -v or --version and nothing else, just run the npm version command - # This is because nvm uses this to check the version of npm - if (($args.Length -eq 1) -and (($args[0] -eq "-v") -or ($args[0] -eq "--version"))) { - Invoke-RealCommand "npm" $args - return - } - - Invoke-WrappedCommand "npm" $args -} \ No newline at end of file diff --git a/packages/safe-chain/src/shell-integration/supported-shells/bash.js b/packages/safe-chain/src/shell-integration/supported-shells/bash.js index a2a3739..956429d 100644 --- a/packages/safe-chain/src/shell-integration/supported-shells/bash.js +++ b/packages/safe-chain/src/shell-integration/supported-shells/bash.js @@ -3,8 +3,10 @@ import { doesExecutableExistOnSystem, removeLinesMatchingPattern, } from "../helpers.js"; +import { getScriptsDir } from "../../config/safeChainDir.js"; import { execSync, spawnSync } from "child_process"; import * as os from "os"; +import path from "path"; const shellName = "Bash"; const executableName = "bash"; @@ -32,10 +34,10 @@ function teardown(tools) { ); } - // Removes the line that sources the safe-chain bash initialization script (~/.aikido/scripts/init-posix.sh) + // Remove sourcing line to disable safe-chain shell integration removeLinesMatchingPattern( startupFile, - /^source\s+~\/\.safe-chain\/scripts\/init-posix\.sh/, + /^source\s+.*init-posix\.sh.*#\s*Safe-chain/, eol ); @@ -44,10 +46,11 @@ function teardown(tools) { function setup() { const startupFile = getStartupFile(); + const scriptsDir = getShellScriptsDir(); addLineToFile( startupFile, - `source ~/.safe-chain/scripts/init-posix.sh # Safe-chain bash initialization script`, + `source ${path.posix.join(scriptsDir, "init-posix.sh")} # Safe-chain bash initialization script`, eol ); @@ -94,6 +97,51 @@ function windowsFixPath(path) { } } +function getShellScriptsDir() { + return toBashPath(getScriptsDir()); +} + +/** + * @param {string} path + * + * @returns {string} + */ +function toBashPath(path) { + try { + if (os.platform() !== "win32") { + return path.replace(/\\/g, "/"); + } + + const directWindowsPath = windowsPathToBashPath(path); + if (directWindowsPath) { + return directWindowsPath; + } + + if (hasCygpath()) { + return convertCygwinPathToUnix(path); + } + + return path.replace(/\\/g, "/"); + } catch { + return path.replace(/\\/g, "/"); + } +} + +/** + * @param {string} path + * + * @returns {string | undefined} + */ +function windowsPathToBashPath(path) { + const match = /^([A-Za-z]):[\\/](.*)$/.exec(path); + if (!match) { + return undefined; + } + + const [, driveLetter, rest] = match; + return `/${driveLetter.toLowerCase()}/${rest.replace(/\\/g, "/")}`; +} + function hasCygpath() { try { var result = spawnSync("where", ["cygpath"], { shell: executableName }); @@ -123,6 +171,44 @@ function cygpathw(path) { } } +/** + * @param {string} path + * + * @returns {string} + */ +function convertCygwinPathToUnix(path) { + try { + var result = spawnSync("cygpath", ["-u", path], { + encoding: "utf8", + shell: executableName, + }); + if (result.status === 0) { + return result.stdout.trim(); + } + return path.replace(/\\/g, "/"); + } catch { + return path.replace(/\\/g, "/"); + } +} + +function getManualTeardownInstructions() { + const scriptsDir = getShellScriptsDir(); + return [ + `Remove the following line from your ~/.bashrc file:`, + ` source ${path.posix.join(scriptsDir, "init-posix.sh")}`, + `Then restart your terminal or run: source ~/.bashrc`, + ]; +} + +function getManualSetupInstructions() { + const scriptsDir = getShellScriptsDir(); + return [ + `Add the following line to your ~/.bashrc file:`, + ` source ${path.posix.join(scriptsDir, "init-posix.sh")}`, + `Then restart your terminal or run: source ~/.bashrc`, + ]; +} + /** * @type {import("../shellDetection.js").Shell} */ @@ -131,4 +217,6 @@ export default { isInstalled, setup, teardown, + getManualSetupInstructions, + getManualTeardownInstructions, }; diff --git a/packages/safe-chain/src/shell-integration/supported-shells/bash.spec.js b/packages/safe-chain/src/shell-integration/supported-shells/bash.spec.js index aa7159f..ac80d1f 100644 --- a/packages/safe-chain/src/shell-integration/supported-shells/bash.spec.js +++ b/packages/safe-chain/src/shell-integration/supported-shells/bash.spec.js @@ -9,6 +9,7 @@ describe("Bash shell integration", () => { let mockStartupFile; let bash; let windowsCygwinPath = ""; + let mockScriptsDir = "/test-home/.safe-chain/scripts"; let platform = "linux"; beforeEach(async () => { @@ -35,6 +36,12 @@ describe("Bash shell integration", () => { }, }); + mock.module("../../config/safeChainDir.js", { + namedExports: { + getScriptsDir: () => mockScriptsDir, + }, + }); + // Mock child_process execSync mock.module("child_process", { namedExports: { @@ -61,6 +68,17 @@ describe("Bash shell integration", () => { stdout: windowsCygwinPath + "\n", }; } + + if ( + command === "cygpath" && + args[0] === "-u" && + args[1] === mockScriptsDir + ) { + return { + status: 0, + stdout: "/c/test-home/.safe-chain/scripts\n", + }; + } }, }, }); @@ -87,6 +105,7 @@ describe("Bash shell integration", () => { // Reset mocks mock.reset(); + mockScriptsDir = "/test-home/.safe-chain/scripts"; platform = "linux"; }); @@ -109,7 +128,7 @@ describe("Bash shell integration", () => { const content = fs.readFileSync(mockStartupFile, "utf-8"); assert.ok( content.includes( - "source ~/.safe-chain/scripts/init-posix.sh # Safe-chain bash initialization script" + "source /test-home/.safe-chain/scripts/init-posix.sh # Safe-chain bash initialization script" ) ); }); @@ -129,7 +148,24 @@ describe("Bash shell integration", () => { const content = fs.readFileSync(windowsCygwinPath, "utf-8"); assert.ok( content.includes( - "source ~/.safe-chain/scripts/init-posix.sh # Safe-chain bash initialization script" + "source /c/test-home/.safe-chain/scripts/init-posix.sh # Safe-chain bash initialization script" + ) + ); + }); + + it("should write a bash-compatible scripts path on Windows", () => { + platform = "win32"; + windowsCygwinPath = mockStartupFile; + mockScriptsDir = "C:\\test-home\\.safe-chain\\scripts"; + mockStartupFile = "DUMMY"; + + const result = bash.setup(); + assert.strictEqual(result, true); + + const content = fs.readFileSync(windowsCygwinPath, "utf-8"); + assert.ok( + content.includes( + "source /c/test-home/.safe-chain/scripts/init-posix.sh # Safe-chain bash initialization script" ) ); }); @@ -209,13 +245,13 @@ describe("Bash shell integration", () => { // Setup bash.setup(tools); let content = fs.readFileSync(mockStartupFile, "utf-8"); - assert.ok(content.includes("source ~/.safe-chain/scripts/init-posix.sh")); + assert.ok(content.includes("source /test-home/.safe-chain/scripts/init-posix.sh")); // Teardown bash.teardown(tools); content = fs.readFileSync(mockStartupFile, "utf-8"); assert.ok( - !content.includes("source ~/.safe-chain/scripts/init-posix.sh") + !content.includes("source /test-home/.safe-chain/scripts/init-posix.sh") ); }); @@ -236,7 +272,7 @@ describe("Bash shell integration", () => { const initialContent = [ "#!/bin/bash", "alias npm='old-npm'", - "source ~/.safe-chain/scripts/init-posix.sh", + "source /test-home/.safe-chain/scripts/init-posix.sh # Safe-chain bash initialization script", "alias ls='ls --color=auto'", ].join("\n"); @@ -247,7 +283,7 @@ describe("Bash shell integration", () => { const content = fs.readFileSync(mockStartupFile, "utf-8"); assert.ok(!content.includes("alias npm=")); assert.ok( - !content.includes("source ~/.safe-chain/scripts/init-posix.sh") + !content.includes("source /test-home/.safe-chain/scripts/init-posix.sh # Safe-chain bash initialization script") ); assert.ok(content.includes("alias ls=")); }); diff --git a/packages/safe-chain/src/shell-integration/supported-shells/fish.js b/packages/safe-chain/src/shell-integration/supported-shells/fish.js index 0af6ae3..95c867b 100644 --- a/packages/safe-chain/src/shell-integration/supported-shells/fish.js +++ b/packages/safe-chain/src/shell-integration/supported-shells/fish.js @@ -3,7 +3,9 @@ import { doesExecutableExistOnSystem, removeLinesMatchingPattern, } from "../helpers.js"; +import { getScriptsDir } from "../../config/safeChainDir.js"; import { execSync } from "child_process"; +import path from "path"; const shellName = "Fish"; const executableName = "fish"; @@ -31,10 +33,10 @@ function teardown(tools) { ); } - // Removes the line that sources the safe-chain fish initialization script (~/.safe-chain/scripts/init-fish.fish) + // Remove sourcing line to prevent safe-chain initialization in future shell sessions removeLinesMatchingPattern( startupFile, - /^source\s+~\/\.safe-chain\/scripts\/init-fish\.fish/, + /^source\s+.*init-fish\.fish.*#\s*Safe-chain/, eol ); @@ -46,7 +48,7 @@ function setup() { addLineToFile( startupFile, - `source ~/.safe-chain/scripts/init-fish.fish # Safe-chain Fish initialization script`, + `source ${path.join(getScriptsDir(), "init-fish.fish")} # Safe-chain Fish initialization script`, eol ); @@ -66,6 +68,22 @@ function getStartupFile() { } } +function getManualTeardownInstructions() { + return [ + `Remove the following line from your ~/.config/fish/config.fish file:`, + ` source ${path.join(getScriptsDir(), "init-fish.fish")}`, + `Then restart your terminal or run: source ~/.config/fish/config.fish`, + ]; +} + +function getManualSetupInstructions() { + return [ + `Add the following line to your ~/.config/fish/config.fish file:`, + ` source ${path.join(getScriptsDir(), "init-fish.fish")}`, + `Then restart your terminal or run: source ~/.config/fish/config.fish`, + ]; +} + /** * @type {import("../shellDetection.js").Shell} */ @@ -74,4 +92,6 @@ export default { isInstalled, setup, teardown, + getManualSetupInstructions, + getManualTeardownInstructions, }; diff --git a/packages/safe-chain/src/shell-integration/supported-shells/fish.spec.js b/packages/safe-chain/src/shell-integration/supported-shells/fish.spec.js index e138957..c1c5715 100644 --- a/packages/safe-chain/src/shell-integration/supported-shells/fish.spec.js +++ b/packages/safe-chain/src/shell-integration/supported-shells/fish.spec.js @@ -33,6 +33,12 @@ describe("Fish shell integration", () => { }, }); + mock.module("../../config/safeChainDir.js", { + namedExports: { + getScriptsDir: () => "/test-home/.safe-chain/scripts", + }, + }); + // Mock child_process execSync mock.module("child_process", { namedExports: { @@ -72,7 +78,7 @@ describe("Fish shell integration", () => { const content = fs.readFileSync(mockStartupFile, "utf-8"); assert.ok( - content.includes('source ~/.safe-chain/scripts/init-fish.fish # Safe-chain Fish initialization script') + content.includes('source /test-home/.safe-chain/scripts/init-fish.fish # Safe-chain Fish initialization script') ); }); @@ -81,7 +87,7 @@ describe("Fish shell integration", () => { fish.setup(); const content = fs.readFileSync(mockStartupFile, "utf-8"); - const sourceMatches = (content.match(/source ~\/\.safe-chain\/scripts\/init-fish\.fish/g) || []).length; + const sourceMatches = (content.match(/source \/test-home\/\.safe-chain\/scripts\/init-fish\.fish/g) || []).length; assert.strictEqual(sourceMatches, 2, "Should allow multiple source lines (helper doesn't dedupe)"); }); }); @@ -93,7 +99,7 @@ describe("Fish shell integration", () => { "alias npm 'aikido-npm'", "alias npx 'aikido-npx'", "alias yarn 'aikido-yarn'", - "source ~/.safe-chain/scripts/init-fish.fish # Safe-chain Fish initialization script", + "source /test-home/.safe-chain/scripts/init-fish.fish # Safe-chain Fish initialization script", "alias ls 'ls --color=auto'", "alias grep 'grep --color=auto'", ].join("\n"); @@ -107,7 +113,7 @@ describe("Fish shell integration", () => { assert.ok(!content.includes("alias npm ")); assert.ok(!content.includes("alias npx ")); assert.ok(!content.includes("alias yarn ")); - assert.ok(!content.includes("source ~/.safe-chain/scripts/init-fish.fish")); + assert.ok(!content.includes("source /test-home/.safe-chain/scripts/init-fish.fish")); assert.ok(content.includes("alias ls ")); assert.ok(content.includes("alias grep ")); }); @@ -162,12 +168,12 @@ describe("Fish shell integration", () => { // Setup fish.setup(); let content = fs.readFileSync(mockStartupFile, "utf-8"); - assert.ok(content.includes('source ~/.safe-chain/scripts/init-fish.fish')); + assert.ok(content.includes('source /test-home/.safe-chain/scripts/init-fish.fish')); // Teardown fish.teardown(tools); content = fs.readFileSync(mockStartupFile, "utf-8"); - assert.ok(!content.includes("source ~/.safe-chain/scripts/init-fish.fish")); + assert.ok(!content.includes("source /test-home/.safe-chain/scripts/init-fish.fish")); }); it("should handle multiple setup calls", () => { @@ -176,7 +182,7 @@ describe("Fish shell integration", () => { fish.setup(); const content = fs.readFileSync(mockStartupFile, "utf-8"); - const sourceMatches = (content.match(/source ~\/\.safe-chain\/scripts\/init-fish\.fish/g) || []).length; + const sourceMatches = (content.match(/source \/test-home\/\.safe-chain\/scripts\/init-fish\.fish/g) || []).length; assert.strictEqual(sourceMatches, 1, "Should have exactly one source line after setup-teardown-setup cycle"); }); }); diff --git a/packages/safe-chain/src/shell-integration/supported-shells/powershell.js b/packages/safe-chain/src/shell-integration/supported-shells/powershell.js index 8cec258..2717e36 100644 --- a/packages/safe-chain/src/shell-integration/supported-shells/powershell.js +++ b/packages/safe-chain/src/shell-integration/supported-shells/powershell.js @@ -2,8 +2,11 @@ import { addLineToFile, doesExecutableExistOnSystem, removeLinesMatchingPattern, + validatePowerShellExecutionPolicy, } from "../helpers.js"; +import { getScriptsDir } from "../../config/safeChainDir.js"; import { execSync } from "child_process"; +import path from "path"; const shellName = "PowerShell Core"; const executableName = "pwsh"; @@ -25,25 +28,33 @@ function teardown(tools) { // Remove any existing alias for the tool removeLinesMatchingPattern( startupFile, - new RegExp(`^Set-Alias\\s+${tool}\\s+`) + new RegExp(`^Set-Alias\\s+${tool}\\s+`), ); } - // Remove the line that sources the safe-chain PowerShell initialization script + // Remove sourcing line to prevent shell from loading safe-chain after uninstallation removeLinesMatchingPattern( startupFile, - /^\.\s+["']?\$HOME[/\\].safe-chain[/\\]scripts[/\\]init-pwsh\.ps1["']?/ + /^\.\s+["']?.*init-pwsh\.ps1["']?.*#\s*Safe-chain/, ); return true; } -function setup() { +async function setup() { + const { isValid, policy } = + await validatePowerShellExecutionPolicy(executableName); + if (!isValid) { + throw new Error( + `PowerShell execution policy is set to '${policy}', which prevents safe-chain from running.\n -> To fix this, open PowerShell as Administrator and run: Set-ExecutionPolicy -ExecutionPolicy RemoteSigned.\n For more information, see: https://help.aikido.dev/code-scanning/aikido-malware-scanning/safe-chain-troubleshooting#powershell-execution-policy-blocks-scripts-windows`, + ); + } + const startupFile = getStartupFile(); addLineToFile( startupFile, - `. "$HOME\\.safe-chain\\scripts\\init-pwsh.ps1" # Safe-chain PowerShell initialization script` + `. "${path.join(getScriptsDir(), "init-pwsh.ps1")}" # Safe-chain PowerShell initialization script`, ); return true; @@ -57,11 +68,27 @@ function getStartupFile() { }).trim(); } catch (/** @type {any} */ error) { throw new Error( - `Command failed: ${startupFileCommand}. Error: ${error.message}` + `Command failed: ${startupFileCommand}. Error: ${error.message}`, ); } } +function getManualTeardownInstructions() { + return [ + `Remove the following line from your PowerShell profile (run "echo $PROFILE" to find its location):`, + ` . "${path.join(getScriptsDir(), "init-pwsh.ps1")}"`, + `Then restart your terminal or run: . $PROFILE`, + ]; +} + +function getManualSetupInstructions() { + return [ + `Add the following line to your PowerShell profile (run "echo $PROFILE" to find its location):`, + ` . "${path.join(getScriptsDir(), "init-pwsh.ps1")}"`, + `Then restart your terminal or run: . $PROFILE`, + ]; +} + /** * @type {import("../shellDetection.js").Shell} */ @@ -70,4 +97,6 @@ export default { isInstalled, setup, teardown, + getManualSetupInstructions, + getManualTeardownInstructions, }; diff --git a/packages/safe-chain/src/shell-integration/supported-shells/powershell.spec.js b/packages/safe-chain/src/shell-integration/supported-shells/powershell.spec.js index 3a15376..b14c73f 100644 --- a/packages/safe-chain/src/shell-integration/supported-shells/powershell.spec.js +++ b/packages/safe-chain/src/shell-integration/supported-shells/powershell.spec.js @@ -8,14 +8,20 @@ import { knownAikidoTools } from "../helpers.js"; describe("PowerShell Core shell integration", () => { let mockStartupFile; let powershell; + let executionPolicyResult; beforeEach(async () => { // Create temporary startup file for testing mockStartupFile = path.join( tmpdir(), - `test-powershell-profile-${Date.now()}.ps1` + `test-powershell-profile-${Date.now()}.ps1`, ); + executionPolicyResult = { + isValid: true, + policy: "RemoteSigned", + }; + // Mock the helpers module mock.module("../helpers.js", { namedExports: { @@ -33,6 +39,13 @@ describe("PowerShell Core shell integration", () => { const filteredLines = lines.filter((line) => !pattern.test(line)); fs.writeFileSync(filePath, filteredLines.join("\n"), "utf-8"); }, + validatePowerShellExecutionPolicy: () => executionPolicyResult, + }, + }); + + mock.module("../../config/safeChainDir.js", { + namedExports: { + getScriptsDir: () => "/test-home/.safe-chain/scripts", }, }); @@ -69,15 +82,15 @@ describe("PowerShell Core shell integration", () => { }); describe("setup", () => { - it("should add init-pwsh.ps1 source line", () => { - const result = powershell.setup(); + it("should add init-pwsh.ps1 source line", async () => { + const result = await powershell.setup(); assert.strictEqual(result, true); const content = fs.readFileSync(mockStartupFile, "utf-8"); assert.ok( content.includes( - '. "$HOME\\.safe-chain\\scripts\\init-pwsh.ps1" # Safe-chain PowerShell initialization script' - ) + '. "/test-home/.safe-chain/scripts/init-pwsh.ps1" # Safe-chain PowerShell initialization script', + ), ); }); }); @@ -86,7 +99,7 @@ describe("PowerShell Core shell integration", () => { it("should remove init-pwsh.ps1 source line", () => { const initialContent = [ "# PowerShell profile", - '. "$HOME\\.safe-chain\\scripts\\init-pwsh.ps1" # Safe-chain PowerShell initialization script', + '. "/test-home/.safe-chain/scripts/init-pwsh.ps1" # Safe-chain PowerShell initialization script', "Set-Alias ls Get-ChildItem", "Set-Alias grep Select-String", ].join("\n"); @@ -98,7 +111,7 @@ describe("PowerShell Core shell integration", () => { const content = fs.readFileSync(mockStartupFile, "utf-8"); assert.ok( - !content.includes('. "$HOME\\.safe-chain\\scripts\\init-pwsh.ps1"') + !content.includes('. "/test-home/.safe-chain/scripts/init-pwsh.ps1"'), ); assert.ok(content.includes("Set-Alias ls ")); assert.ok(content.includes("Set-Alias grep ")); @@ -168,33 +181,50 @@ describe("PowerShell Core shell integration", () => { }); describe("integration tests", () => { - it("should handle complete setup and teardown cycle", () => { + it("should handle complete setup and teardown cycle", async () => { // Setup - powershell.setup(); + await powershell.setup(); let content = fs.readFileSync(mockStartupFile, "utf-8"); assert.ok( - content.includes('. "$HOME\\.safe-chain\\scripts\\init-pwsh.ps1"') + content.includes('. "/test-home/.safe-chain/scripts/init-pwsh.ps1"'), ); // Teardown powershell.teardown(knownAikidoTools); content = fs.readFileSync(mockStartupFile, "utf-8"); assert.ok( - !content.includes('. "$HOME\\.safe-chain\\scripts\\init-pwsh.ps1"') + !content.includes('. "/test-home/.safe-chain/scripts/init-pwsh.ps1"'), ); }); - it("should handle multiple setup calls", () => { - powershell.setup(); + it("should handle multiple setup calls", async () => { + await powershell.setup(); powershell.teardown(knownAikidoTools); - powershell.setup(); + await powershell.setup(); const content = fs.readFileSync(mockStartupFile, "utf-8"); const sourceMatches = ( - content.match(/\. "\$HOME\\.safe-chain\\scripts\\init-pwsh\.ps1"/g) || + content.match(/\. "\/test-home\/\.safe-chain\/scripts\/init-pwsh\.ps1"/g) || [] ).length; assert.strictEqual(sourceMatches, 1, "Should not duplicate source lines"); }); }); + + describe("execution policy", () => { + it(`should throw for restricted policies`, async () => { + executionPolicyResult = { + isValid: false, + policy: "Restricted", + }; + + await assert.rejects( + () => powershell.setup(), + (err) => + err.message.startsWith( + "PowerShell execution policy is set to 'Restricted'", + ), + ); + }); + }); }); diff --git a/packages/safe-chain/src/shell-integration/supported-shells/windowsPowershell.js b/packages/safe-chain/src/shell-integration/supported-shells/windowsPowershell.js index e554a32..7213d38 100644 --- a/packages/safe-chain/src/shell-integration/supported-shells/windowsPowershell.js +++ b/packages/safe-chain/src/shell-integration/supported-shells/windowsPowershell.js @@ -2,8 +2,11 @@ import { addLineToFile, doesExecutableExistOnSystem, removeLinesMatchingPattern, + validatePowerShellExecutionPolicy, } from "../helpers.js"; +import { getScriptsDir } from "../../config/safeChainDir.js"; import { execSync } from "child_process"; +import path from "path"; const shellName = "Windows PowerShell"; const executableName = "powershell"; @@ -25,25 +28,33 @@ function teardown(tools) { // Remove any existing alias for the tool removeLinesMatchingPattern( startupFile, - new RegExp(`^Set-Alias\\s+${tool}\\s+`) + new RegExp(`^Set-Alias\\s+${tool}\\s+`), ); } - // Remove the line that sources the safe-chain PowerShell initialization script + // Remove sourcing line to clean up safe-chain integration from the shell profile removeLinesMatchingPattern( startupFile, - /^\.\s+["']?\$HOME[/\\].safe-chain[/\\]scripts[/\\]init-pwsh\.ps1["']?/ + /^\.\s+["']?.*init-pwsh\.ps1["']?.*#\s*Safe-chain/, ); return true; } -function setup() { +async function setup() { + const { isValid, policy } = + await validatePowerShellExecutionPolicy(executableName); + if (!isValid) { + throw new Error( + `PowerShell execution policy is set to '${policy}', which prevents safe-chain from running.\n -> To fix this, open PowerShell as Administrator and run: Set-ExecutionPolicy -ExecutionPolicy RemoteSigned.\n For more information, see: https://help.aikido.dev/code-scanning/aikido-malware-scanning/safe-chain-troubleshooting#powershell-execution-policy-blocks-scripts-windows`, + ); + } + const startupFile = getStartupFile(); addLineToFile( startupFile, - `. "$HOME\\.safe-chain\\scripts\\init-pwsh.ps1" # Safe-chain PowerShell initialization script` + `. "${path.join(getScriptsDir(), "init-pwsh.ps1")}" # Safe-chain PowerShell initialization script`, ); return true; @@ -57,11 +68,27 @@ function getStartupFile() { }).trim(); } catch (/** @type {any} */ error) { throw new Error( - `Command failed: ${startupFileCommand}. Error: ${error.message}` + `Command failed: ${startupFileCommand}. Error: ${error.message}`, ); } } +function getManualTeardownInstructions() { + return [ + `Remove the following line from your PowerShell profile (run "echo $PROFILE" to find its location):`, + ` . "${path.join(getScriptsDir(), "init-pwsh.ps1")}"`, + `Then restart your terminal or run: . $PROFILE`, + ]; +} + +function getManualSetupInstructions() { + return [ + `Add the following line to your PowerShell profile (run "echo $PROFILE" to find its location):`, + ` . "${path.join(getScriptsDir(), "init-pwsh.ps1")}"`, + `Then restart your terminal or run: . $PROFILE`, + ]; +} + /** * @type {import("../shellDetection.js").Shell} */ @@ -70,4 +97,6 @@ export default { isInstalled, setup, teardown, + getManualSetupInstructions, + getManualTeardownInstructions, }; diff --git a/packages/safe-chain/src/shell-integration/supported-shells/windowsPowershell.spec.js b/packages/safe-chain/src/shell-integration/supported-shells/windowsPowershell.spec.js index c201c60..277a3f7 100644 --- a/packages/safe-chain/src/shell-integration/supported-shells/windowsPowershell.spec.js +++ b/packages/safe-chain/src/shell-integration/supported-shells/windowsPowershell.spec.js @@ -8,14 +8,20 @@ import { knownAikidoTools } from "../helpers.js"; describe("Windows PowerShell shell integration", () => { let mockStartupFile; let windowsPowershell; + let executionPolicyResult; beforeEach(async () => { // Create temporary startup file for testing mockStartupFile = path.join( tmpdir(), - `test-windows-powershell-profile-${Date.now()}.ps1` + `test-windows-powershell-profile-${Date.now()}.ps1`, ); + executionPolicyResult = { + isValid: true, + policy: "RemoteSigned", + }; + // Mock the helpers module mock.module("../helpers.js", { namedExports: { @@ -33,6 +39,13 @@ describe("Windows PowerShell shell integration", () => { const filteredLines = lines.filter((line) => !pattern.test(line)); fs.writeFileSync(filePath, filteredLines.join("\n"), "utf-8"); }, + validatePowerShellExecutionPolicy: () => executionPolicyResult, + }, + }); + + mock.module("../../config/safeChainDir.js", { + namedExports: { + getScriptsDir: () => "/test-home/.safe-chain/scripts", }, }); @@ -69,15 +82,15 @@ describe("Windows PowerShell shell integration", () => { }); describe("setup", () => { - it("should add init-pwsh.ps1 source line", () => { - const result = windowsPowershell.setup(); + it("should add init-pwsh.ps1 source line", async () => { + const result = await windowsPowershell.setup(); assert.strictEqual(result, true); const content = fs.readFileSync(mockStartupFile, "utf-8"); assert.ok( content.includes( - '. "$HOME\\.safe-chain\\scripts\\init-pwsh.ps1" # Safe-chain PowerShell initialization script' - ) + '. "/test-home/.safe-chain/scripts/init-pwsh.ps1" # Safe-chain PowerShell initialization script', + ), ); }); }); @@ -86,7 +99,7 @@ describe("Windows PowerShell shell integration", () => { it("should remove init-pwsh.ps1 source line", () => { const initialContent = [ "# Windows PowerShell profile", - '. "$HOME\\.safe-chain\\scripts\\init-pwsh.ps1" # Safe-chain PowerShell initialization script', + '. "/test-home/.safe-chain/scripts/init-pwsh.ps1" # Safe-chain PowerShell initialization script', "Set-Alias ls Get-ChildItem", "Set-Alias grep Select-String", ].join("\n"); @@ -98,7 +111,7 @@ describe("Windows PowerShell shell integration", () => { const content = fs.readFileSync(mockStartupFile, "utf-8"); assert.ok( - !content.includes('. "$HOME\\.safe-chain\\scripts\\init-pwsh.ps1"') + !content.includes('. "/test-home/.safe-chain/scripts/init-pwsh.ps1"'), ); assert.ok(content.includes("Set-Alias ls ")); assert.ok(content.includes("Set-Alias grep ")); @@ -168,33 +181,50 @@ describe("Windows PowerShell shell integration", () => { }); describe("integration tests", () => { - it("should handle complete setup and teardown cycle", () => { + it("should handle complete setup and teardown cycle", async () => { // Setup - windowsPowershell.setup(); + await windowsPowershell.setup(); let content = fs.readFileSync(mockStartupFile, "utf-8"); assert.ok( - content.includes('. "$HOME\\.safe-chain\\scripts\\init-pwsh.ps1"') + content.includes('. "/test-home/.safe-chain/scripts/init-pwsh.ps1"'), ); // Teardown windowsPowershell.teardown(knownAikidoTools); content = fs.readFileSync(mockStartupFile, "utf-8"); assert.ok( - !content.includes('. "$HOME\\.safe-chain\\scripts\\init-pwsh.ps1"') + !content.includes('. "/test-home/.safe-chain/scripts/init-pwsh.ps1"'), ); }); - it("should handle multiple setup calls", () => { - windowsPowershell.setup(); + it("should handle multiple setup calls", async () => { + await windowsPowershell.setup(); windowsPowershell.teardown(knownAikidoTools); - windowsPowershell.setup(); + await windowsPowershell.setup(); const content = fs.readFileSync(mockStartupFile, "utf-8"); const sourceMatches = ( - content.match(/\. "\$HOME\\.safe-chain\\scripts\\init-pwsh\.ps1"/g) || + content.match(/\. "\/test-home\/\.safe-chain\/scripts\/init-pwsh\.ps1"/g) || [] ).length; assert.strictEqual(sourceMatches, 1, "Should not duplicate source lines"); }); }); + + describe("execution policy", () => { + it(`should throw for restricted policies`, async () => { + executionPolicyResult = { + isValid: false, + policy: "Restricted", + }; + + await assert.rejects( + () => windowsPowershell.setup(), + (err) => + err.message.startsWith( + "PowerShell execution policy is set to 'Restricted'", + ), + ); + }); + }); }); diff --git a/packages/safe-chain/src/shell-integration/supported-shells/zsh.js b/packages/safe-chain/src/shell-integration/supported-shells/zsh.js index fc2b807..c3e8d73 100644 --- a/packages/safe-chain/src/shell-integration/supported-shells/zsh.js +++ b/packages/safe-chain/src/shell-integration/supported-shells/zsh.js @@ -3,7 +3,9 @@ import { doesExecutableExistOnSystem, removeLinesMatchingPattern, } from "../helpers.js"; +import { getScriptsDir } from "../../config/safeChainDir.js"; import { execSync } from "child_process"; +import path from "path"; const shellName = "Zsh"; const executableName = "zsh"; @@ -31,10 +33,10 @@ function teardown(tools) { ); } - // Removes the line that sources the safe-chain zsh initialization script (~/.aikido/scripts/init-posix.sh) + // Remove sourcing line to complete shell integration cleanup removeLinesMatchingPattern( startupFile, - /^source\s+~\/\.safe-chain\/scripts\/init-posix\.sh/, + /^source\s+.*init-posix\.sh.*#\s*Safe-chain/, eol ); @@ -46,7 +48,7 @@ function setup() { addLineToFile( startupFile, - `source ~/.safe-chain/scripts/init-posix.sh # Safe-chain Zsh initialization script`, + `source ${path.join(getScriptsDir(), "init-posix.sh")} # Safe-chain Zsh initialization script`, eol ); @@ -66,9 +68,27 @@ function getStartupFile() { } } +function getManualTeardownInstructions() { + return [ + `Remove the following line from your ~/.zshrc file:`, + ` source ${path.join(getScriptsDir(), "init-posix.sh")}`, + `Then restart your terminal or run: source ~/.zshrc`, + ]; +} + +function getManualSetupInstructions() { + return [ + `Add the following line to your ~/.zshrc file:`, + ` source ${path.join(getScriptsDir(), "init-posix.sh")}`, + `Then restart your terminal or run: source ~/.zshrc`, + ]; +} + export default { name: shellName, isInstalled, setup, teardown, + getManualSetupInstructions, + getManualTeardownInstructions, }; diff --git a/packages/safe-chain/src/shell-integration/supported-shells/zsh.spec.js b/packages/safe-chain/src/shell-integration/supported-shells/zsh.spec.js index 99106ec..50af5ca 100644 --- a/packages/safe-chain/src/shell-integration/supported-shells/zsh.spec.js +++ b/packages/safe-chain/src/shell-integration/supported-shells/zsh.spec.js @@ -33,6 +33,12 @@ describe("Zsh shell integration", () => { }, }); + mock.module("../../config/safeChainDir.js", { + namedExports: { + getScriptsDir: () => "/test-home/.safe-chain/scripts", + }, + }); + // Mock child_process execSync mock.module("child_process", { namedExports: { @@ -73,7 +79,7 @@ describe("Zsh shell integration", () => { const content = fs.readFileSync(mockStartupFile, "utf-8"); assert.ok( content.includes( - "source ~/.safe-chain/scripts/init-posix.sh # Safe-chain Zsh initialization script" + "source /test-home/.safe-chain/scripts/init-posix.sh # Safe-chain Zsh initialization script" ) ); }); @@ -83,7 +89,7 @@ describe("Zsh shell integration", () => { assert.strictEqual(result, true); const content = fs.readFileSync(mockStartupFile, "utf-8"); - assert.ok(content.includes("source ~/.safe-chain/scripts/init-posix.sh")); + assert.ok(content.includes("source /test-home/.safe-chain/scripts/init-posix.sh")); }); }); @@ -114,7 +120,7 @@ describe("Zsh shell integration", () => { it("should remove zsh initialization script source line", () => { const initialContent = [ "#!/bin/zsh", - "source ~/.safe-chain/scripts/init-posix.sh", + "source /test-home/.safe-chain/scripts/init-posix.sh # Safe-chain Zsh initialization script", "alias ls='ls --color=auto'", ].join("\n"); @@ -125,7 +131,7 @@ describe("Zsh shell integration", () => { const content = fs.readFileSync(mockStartupFile, "utf-8"); assert.ok( - !content.includes("source ~/.safe-chain/scripts/init-posix.sh") + !content.includes("source /test-home/.safe-chain/scripts/init-posix.sh # Safe-chain Zsh initialization script") ); assert.ok(content.includes("alias ls=")); }); @@ -180,13 +186,13 @@ describe("Zsh shell integration", () => { // Setup zsh.setup(); let content = fs.readFileSync(mockStartupFile, "utf-8"); - assert.ok(content.includes("source ~/.safe-chain/scripts/init-posix.sh")); + assert.ok(content.includes("source /test-home/.safe-chain/scripts/init-posix.sh")); // Teardown zsh.teardown(tools); content = fs.readFileSync(mockStartupFile, "utf-8"); assert.ok( - !content.includes("source ~/.safe-chain/scripts/init-posix.sh") + !content.includes("source /test-home/.safe-chain/scripts/init-posix.sh") ); }); @@ -207,7 +213,7 @@ describe("Zsh shell integration", () => { const initialContent = [ "#!/bin/zsh", "alias npm='old-npm'", - "source ~/.safe-chain/scripts/init-posix.sh", + "source /test-home/.safe-chain/scripts/init-posix.sh # Safe-chain Zsh initialization script", "alias ls='ls --color=auto'", ].join("\n"); @@ -218,7 +224,7 @@ describe("Zsh shell integration", () => { const content = fs.readFileSync(mockStartupFile, "utf-8"); assert.ok(!content.includes("alias npm=")); assert.ok( - !content.includes("source ~/.safe-chain/scripts/init-posix.sh") + !content.includes("source /test-home/.safe-chain/scripts/init-posix.sh # Safe-chain Zsh initialization script") ); assert.ok(content.includes("alias ls=")); }); diff --git a/packages/safe-chain/src/shell-integration/teardown.js b/packages/safe-chain/src/shell-integration/teardown.js index bc83b48..cdeeae2 100644 --- a/packages/safe-chain/src/shell-integration/teardown.js +++ b/packages/safe-chain/src/shell-integration/teardown.js @@ -2,6 +2,8 @@ import chalk from "chalk"; import { ui } from "../environment/userInteraction.js"; import { detectShells } from "./shellDetection.js"; import { knownAikidoTools, getPackageManagerList } from "./helpers.js"; +import { getShimsDir, getScriptsDir } from "../config/safeChainDir.js"; +import fs from "fs"; /** * @returns {Promise} @@ -46,8 +48,14 @@ export async function teardown() { ui.writeError( `${chalk.bold("- " + shell.name + ":")} ${chalk.red( "Teardown failed" - )}. Please check your ${shell.name} configuration.` + )}` ); + ui.emptyLine(); + ui.writeInformation(` ${chalk.bold("To tear down manually:")}`); + for (const instruction of shell.getManualTeardownInstructions()) { + ui.writeInformation(` ${instruction}`); + } + ui.emptyLine(); } } @@ -62,3 +70,45 @@ export async function teardown() { return; } } + +/** + * Removes directories created by setup-ci and setup commands + * @returns {Promise} + */ +export async function teardownDirectories() { + const shimsDir = getShimsDir(); + const scriptsDir = getScriptsDir(); + + // Remove CI shims directory + if (fs.existsSync(shimsDir)) { + try { + fs.rmSync(shimsDir, { recursive: true, force: true }); + ui.writeInformation( + `${chalk.bold("- CI Shims:")} ${chalk.green("Removed successfully")}` + ); + } catch (/** @type {any} */ error) { + ui.writeError( + `${chalk.bold("- CI Shims:")} ${chalk.red( + "Failed to remove" + )}. Error: ${error.message}` + ); + } + } + + // Remove scripts directory + if (fs.existsSync(scriptsDir)) { + try { + fs.rmSync(scriptsDir, { recursive: true, force: true }); + ui.writeInformation( + `${chalk.bold("- Scripts:")} ${chalk.green("Removed successfully")}` + ); + } catch (/** @type {any} */ error) { + ui.writeError( + `${chalk.bold("- Scripts:")} ${chalk.red( + "Failed to remove" + )}. Error: ${error.message}` + ); + } + } + +} diff --git a/packages/safe-chain/src/utils/safeSpawn.js b/packages/safe-chain/src/utils/safeSpawn.js index e17bdb5..69c827a 100644 --- a/packages/safe-chain/src/utils/safeSpawn.js +++ b/packages/safe-chain/src/utils/safeSpawn.js @@ -1,5 +1,6 @@ import { spawn, execSync } from "child_process"; import os from "os"; +import { ui } from "../environment/userInteraction.js"; /** * @param {string} arg @@ -135,3 +136,18 @@ export async function safeSpawn(command, args, options = {}) { }); }); } + +/** + * @param {string} command + * @param {string[]} args + * @param {import("child_process").SpawnOptions} options + * + * @returns {Promise<{status: number, stdout: string, stderr: string}>} + */ +export async function printVerboseAndSafeSpawn(command, args, options = {}) { + ui.writeVerbose(`Running: ${command} ${args.join(" ")}`); + + const result = await safeSpawn(command, args, options); + + return result; +} diff --git a/test/e2e/DockerTestContainer.js b/test/e2e/DockerTestContainer.js index ec1af3c..543b1a3 100644 --- a/test/e2e/DockerTestContainer.js +++ b/test/e2e/DockerTestContainer.js @@ -33,12 +33,16 @@ export class DockerTestContainer { ].join(" "); execSync( - `docker build -t ${imageName} -f ${dockerFile} ${contextPath} ${buildArgs}`, + `docker build --progress=plain -t ${imageName} -f ${dockerFile} ${contextPath} ${buildArgs}`, { - stdio: "ignore", + stdio: "pipe", + maxBuffer: 10 * 1024 * 1024, // Default is 1MB, increase to 10MB to account for large build logs } ); } catch (error) { + // Only print the build logs if the build fails + if (error.stdout) console.log(error.stdout.toString()); + if (error.stderr) console.error(error.stderr.toString()); throw new Error(`Failed to build Docker image: ${error.message}`); } } @@ -54,12 +58,21 @@ export class DockerTestContainer { `docker run -d --name ${this.containerName} ${imageName} sleep infinity`, { stdio: "ignore" } ); + + await this.startMalwareMirror(); + this.isRunning = true; } catch (error) { throw new Error(`Failed to start container: ${error.message}`); } } + async startMalwareMirror() { + const shell = await this.openShell("zsh"); + await shell.runCommand("node /utils/malwarelistmirror.mjs &"); + await shell.runCommand("until curl -sf http://127.0.0.1:5555/ready; do sleep 0.2; done"); + } + dockerExec(command, daemon = false) { if (!this.isRunning) { throw new Error("Container is not running"); @@ -80,10 +93,14 @@ export class DockerTestContainer { } } - async openShell(shell) { + async openShell(shell, { user } = {}) { + const execArgs = user + ? ["exec", "-it", "-u", user, this.containerName, shell] + : ["exec", "-it", this.containerName, shell]; + let ptyProcess = pty.spawn( "docker", - ["exec", "-it", this.containerName, shell], + execArgs, { name: "xterm-color", cols: 80, @@ -117,7 +134,7 @@ export class DockerTestContainer { const timeout = setTimeout(() => { // Fallback in case the command doesn't finish in a reasonable time // oxlint-disable-next-line no-console - having this log in CI helps diagnose issues - console.log("Command timeout reached"); + console.log(`Command timeout reached for "${command}"`); resolve({ allData, output: parseShellOutput(allData), command }); ptyProcess.removeListener("data", handleInput); }, 15000); diff --git a/test/e2e/Dockerfile b/test/e2e/Dockerfile index 8c3b0a5..290922d 100644 --- a/test/e2e/Dockerfile +++ b/test/e2e/Dockerfile @@ -25,6 +25,7 @@ ARG NODE_VERSION=latest ARG NPM_VERSION=latest ARG YARN_VERSION=latest ARG PNPM_VERSION=latest +ARG RUSH_VERSION=latest ARG PYTHON_VERSION=3 SHELL ["/bin/bash", "-c"] @@ -41,11 +42,12 @@ RUN apt-get install -y fish && \ touch /root/.config/fish/config.fish # Install Volta and Node.js -RUN curl https://get.volta.sh | bash +RUN curl -fsSL https://get.volta.sh | bash RUN volta install node@${NODE_VERSION} RUN volta install npm@${NPM_VERSION} RUN volta install yarn@${YARN_VERSION} RUN volta install pnpm@${PNPM_VERSION} +RUN volta install @microsoft/rush@${RUSH_VERSION} # Install Bun RUN curl -fsSL https://bun.sh/install | bash @@ -71,6 +73,16 @@ EOF RUN curl -LsSf https://astral.sh/uv/install.sh | sh && \ echo 'source $HOME/.local/bin/env' >> ~/.bashrc +# Install pipx (recommended installer for Poetry) and Poetry itself +RUN apt-get update && apt-get install -y pipx && \ + pipx ensurepath && \ + pipx install poetry && \ + ln -sf /root/.local/bin/poetry /usr/local/bin/poetry + +# Install PDM +RUN pipx install pdm && \ + ln -sf /root/.local/bin/pdm /usr/local/bin/pdm + # Copy and install Safe chain COPY --from=builder /app/*.tgz /pkgs/ RUN npm install -g /pkgs/*.tgz @@ -78,3 +90,5 @@ RUN npm install -g /pkgs/*.tgz WORKDIR /testapp RUN npm init -y +COPY test/e2e/utils/malwarelistmirror.mjs /utils/malwarelistmirror.mjs +ENV SAFE_CHAIN_MALWARE_LIST_BASE_URL=http://127.0.0.1:5555 diff --git a/test/e2e/bun.e2e.spec.js b/test/e2e/bun.e2e.spec.js index 4f24b7d..589d863 100644 --- a/test/e2e/bun.e2e.spec.js +++ b/test/e2e/bun.e2e.spec.js @@ -28,7 +28,9 @@ describe("E2E: bun coverage", () => { it(`safe-chain succesfully installs safe packages`, async () => { const shell = await container.openShell("bash"); - const result = await shell.runCommand("bun i axios"); + const result = await shell.runCommand( + "bun i axios@1.13.0 --safe-chain-logging=verbose" + ); assert.ok( result.output.includes("no malware found."), @@ -44,8 +46,9 @@ describe("E2E: bun coverage", () => { var result = await shell.runCommand("bun install"); - assert.ok( - result.output.includes("blocked 1 malicious package downloads"), + assert.match( + result.output, + /blocked [1-9]\d* malicious package downloads/, `Output did not include expected text. Output was:\n${result.output}` ); assert.ok( @@ -63,8 +66,9 @@ describe("E2E: bun coverage", () => { const result = await shell.runCommand("bunx safe-chain-test"); - assert.ok( - result.output.includes("blocked 1 malicious package downloads"), + assert.match( + result.output, + /blocked [1-9]\d* malicious package downloads/, `Output did not include expected text. Output was:\n${result.output}` ); assert.ok( diff --git a/test/e2e/certbundle.e2e.spec.js b/test/e2e/certbundle.e2e.spec.js new file mode 100644 index 0000000..9c5102b --- /dev/null +++ b/test/e2e/certbundle.e2e.spec.js @@ -0,0 +1,347 @@ +import { describe, it, before, beforeEach, afterEach } from "node:test"; +import { DockerTestContainer } from "./DockerTestContainer.js"; +import assert from "node:assert"; + +describe("E2E: NODE_EXTRA_CA_CERTS merging", () => { + let container; + + before(async () => { + DockerTestContainer.buildImage(); + }); + + beforeEach(async () => { + // Run a new Docker container for each test + container = new DockerTestContainer(); + await container.start(); + + const installationShell = await container.openShell("zsh"); + await installationShell.runCommand("safe-chain setup"); + }); + + afterEach(async () => { + // Stop and clean up the container after each test + if (container) { + await container.stop(); + container = null; + } + }); + + it(`npm install works without NODE_EXTRA_CA_CERTS set`, async () => { + const shell = await container.openShell("zsh"); + + // Ensure NODE_EXTRA_CA_CERTS is not set + await shell.runCommand("unset NODE_EXTRA_CA_CERTS"); + + const result = await shell.runCommand("npm install axios@1.13.0"); + + assert.ok( + result.output.includes("added") || result.output.includes("up to date"), + `npm install failed without NODE_EXTRA_CA_CERTS. Output was:\n${result.output}` + ); + }); + + it(`npm install works with valid NODE_EXTRA_CA_CERTS set`, async () => { + const shell = await container.openShell("zsh"); + + // Create a temporary valid certificate (using the system's Mozilla CA bundle) + await shell.runCommand("cp /etc/ssl/certs/ca-certificates.crt /tmp/valid-certs.pem"); + + // Verify the cert file was created + const { output: checkOutput } = await shell.runCommand("test -f /tmp/valid-certs.pem && echo exists"); + assert.ok( + checkOutput.includes("exists"), + `Certificate file was not created at /tmp/valid-certs.pem` + ); + + // Set NODE_EXTRA_CA_CERTS and run npm install + const result = await shell.runCommand( + "NODE_EXTRA_CA_CERTS=/tmp/valid-certs.pem npm install axios@1.13.0" + ); + + assert.ok( + result.output.includes("added") || result.output.includes("up to date"), + `npm install failed with valid NODE_EXTRA_CA_CERTS. Output was:\n${result.output}` + ); + }); + + it(`npm install works with non-existent NODE_EXTRA_CA_CERTS path`, async () => { + const shell = await container.openShell("zsh"); + + // Set NODE_EXTRA_CA_CERTS to a non-existent path + const result = await shell.runCommand( + 'export NODE_EXTRA_CA_CERTS="/tmp/nonexistent-certs.pem" && npm install axios@1.13.0' + ); + + // Should still succeed - safe-chain should gracefully handle missing user certs + assert.ok( + result.output.includes("added") || result.output.includes("up to date"), + `npm install failed with non-existent NODE_EXTRA_CA_CERTS. Output was:\n${result.output}` + ); + + // Should show a warning + assert.ok( + result.output.includes("Safe-chain") || result.output.includes("Could not read"), + `Expected safe-chain warning about missing certs. Output was:\n${result.output}` + ); + }); + + it(`npm install works with invalid (non-PEM) NODE_EXTRA_CA_CERTS`, async () => { + const shell = await container.openShell("zsh"); + + // Create an invalid certificate file (not valid PEM) + await shell.runCommand( + 'echo "This is not a valid PEM certificate" > /tmp/invalid-certs.pem' + ); + + // Set NODE_EXTRA_CA_CERTS to invalid cert + const result = await shell.runCommand( + 'export NODE_EXTRA_CA_CERTS="/tmp/invalid-certs.pem" && npm install axios@1.13.0' + ); + + // Should still succeed - safe-chain should skip invalid user certs + assert.ok( + result.output.includes("added") || result.output.includes("up to date"), + `npm install failed with invalid NODE_EXTRA_CA_CERTS. Output was:\n${result.output}` + ); + + // Should show a warning about invalid cert + assert.ok( + result.output.includes("Safe-chain") || result.output.includes("Could not read"), + `Expected safe-chain warning about invalid certs. Output was:\n${result.output}` + ); + }); + + it(`npm install handles NODE_EXTRA_CA_CERTS with path traversal attempt`, async () => { + const shell = await container.openShell("zsh"); + + // Try to set NODE_EXTRA_CA_CERTS with path traversal + const result = await shell.runCommand( + 'export NODE_EXTRA_CA_CERTS="/tmp/../../../etc/passwd" && npm install axios@1.13.0' + ); + + // Should still succeed - safe-chain should reject path traversal + assert.ok( + result.output.includes("added") || result.output.includes("up to date"), + `npm install failed with path traversal NODE_EXTRA_CA_CERTS. Output was:\n${result.output}` + ); + }); + + it(`npm install handles empty NODE_EXTRA_CA_CERTS`, async () => { + const shell = await container.openShell("zsh"); + + // Create an empty certificate file + await shell.runCommand("touch /tmp/empty-certs.pem"); + + const result = await shell.runCommand( + 'export NODE_EXTRA_CA_CERTS="/tmp/empty-certs.pem" && npm install axios@1.13.0' + ); + + // Should still succeed - empty file should be ignored gracefully + assert.ok( + result.output.includes("added") || result.output.includes("up to date"), + `npm install failed with empty NODE_EXTRA_CA_CERTS. Output was:\n${result.output}` + ); + }); + + it(`npm install handles NODE_EXTRA_CA_CERTS pointing to a directory`, async () => { + const shell = await container.openShell("zsh"); + + // Create a directory instead of a file + await shell.runCommand("mkdir -p /tmp/cert-dir"); + + const result = await shell.runCommand( + 'export NODE_EXTRA_CA_CERTS="/tmp/cert-dir" && npm install axios@1.13.0' + ); + + // Should still succeed - directory should be treated as invalid cert file + assert.ok( + result.output.includes("added") || result.output.includes("up to date"), + `npm install failed when NODE_EXTRA_CA_CERTS points to directory. Output was:\n${result.output}` + ); + }); + + it(`npm install handles relative NODE_EXTRA_CA_CERTS path`, async () => { + const shell = await container.openShell("zsh"); + + // Create a cert file and try to reference it with relative path + await shell.runCommand( + "mkdir -p /tmp/cert-test && cp /etc/ssl/certs/ca-certificates.crt /tmp/cert-test/certs.pem" + ); + + const result = await shell.runCommand( + 'cd /tmp/cert-test && export NODE_EXTRA_CA_CERTS="./certs.pem" && npm install axios@1.13.0' + ); + + // Should still succeed - relative paths should be resolved properly + assert.ok( + result.output.includes("added") || result.output.includes("up to date"), + `npm install failed with relative NODE_EXTRA_CA_CERTS path. Output was:\n${result.output}` + ); + }); + + it(`npm install handles absolute NODE_EXTRA_CA_CERTS path`, async () => { + const shell = await container.openShell("zsh"); + + // Create cert file with absolute path + await shell.runCommand("cp /etc/ssl/certs/ca-certificates.crt /tmp/absolute-certs.pem"); + + const result = await shell.runCommand( + "NODE_EXTRA_CA_CERTS=/tmp/absolute-certs.pem npm install axios@1.13.0" + ); + + assert.ok( + result.output.includes("added") || result.output.includes("up to date"), + `npm install failed with absolute NODE_EXTRA_CA_CERTS path. Output was:\n${result.output}` + ); + }); + + it(`npm install with multiple packages still respects merged certificates`, async () => { + const shell = await container.openShell("zsh"); + + // Create valid cert + await shell.runCommand("cp /etc/ssl/certs/ca-certificates.crt /tmp/merge-certs.pem"); + + const result = await shell.runCommand( + "NODE_EXTRA_CA_CERTS=/tmp/merge-certs.pem npm install axios@1.13.0 lodash" + ); + + assert.ok( + result.output.includes("added") || result.output.includes("up to date"), + `npm install with multiple packages failed. Output was:\n${result.output}` + ); + }); + + it(`npm install correctly blocks malware even with merged certificates`, async () => { + const shell = await container.openShell("zsh"); + + // Create valid cert + await shell.runCommand("cp /etc/ssl/certs/ca-certificates.crt /tmp/secure-merge-certs.pem"); + + const result = await shell.runCommand( + "NODE_EXTRA_CA_CERTS=/tmp/secure-merge-certs.pem npm install safe-chain-test" + ); + + // Should block the malware package + assert.ok( + result.output.includes("Malicious") || result.output.includes("blocked"), + `Malware package should be blocked even with merged certificates. Output was:\n${result.output}` + ); + }); + + it(`pip install works without NODE_EXTRA_CA_CERTS set`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("safe-chain setup"); + await shell.runCommand("unset NODE_EXTRA_CA_CERTS"); + + const result = await shell.runCommand( + "pip3 install --break-system-packages requests" + ); + + assert.ok( + result.output.includes("Successfully installed") || result.output.includes("Requirement already satisfied"), + `pip3 install failed without NODE_EXTRA_CA_CERTS. Output was:\n${result.output}` + ); + }); + + it(`pip install works with valid NODE_EXTRA_CA_CERTS set`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("safe-chain setup"); + + // Create a temporary valid certificate + await shell.runCommand("cp /etc/ssl/certs/ca-certificates.crt /tmp/pip-valid-certs.pem"); + + const result = await shell.runCommand( + "NODE_EXTRA_CA_CERTS=/tmp/pip-valid-certs.pem pip3 install --break-system-packages requests" + ); + + assert.ok( + result.output.includes("Successfully installed") || result.output.includes("Requirement already satisfied"), + `pip3 install failed with valid NODE_EXTRA_CA_CERTS. Output was:\n${result.output}` + ); + }); + + it(`pip install handles non-existent NODE_EXTRA_CA_CERTS gracefully`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("safe-chain setup"); + + const result = await shell.runCommand( + 'export NODE_EXTRA_CA_CERTS="/tmp/nonexistent-pip-certs.pem" && pip3 install --break-system-packages requests' + ); + + // Should still work - gracefully handle missing user certs + assert.ok( + result.output.includes("Successfully installed") || result.output.includes("Requirement already satisfied"), + `pip3 install failed with non-existent NODE_EXTRA_CA_CERTS. Output was:\n${result.output}` + ); + }); + + it(`pip install handles invalid NODE_EXTRA_CA_CERTS gracefully`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("safe-chain setup"); + + // Create invalid cert + await shell.runCommand( + 'echo "invalid certificate content" > /tmp/pip-invalid-certs.pem' + ); + + const result = await shell.runCommand( + 'export NODE_EXTRA_CA_CERTS="/tmp/pip-invalid-certs.pem" && pip3 install --break-system-packages requests' + ); + + // Should still work - skip invalid user certs + assert.ok( + result.output.includes("Successfully installed") || result.output.includes("Requirement already satisfied"), + `pip3 install failed with invalid NODE_EXTRA_CA_CERTS. Output was:\n${result.output}` + ); + }); + + it(`yarn install works with valid NODE_EXTRA_CA_CERTS set`, async () => { + const shell = await container.openShell("zsh"); + + // Create valid cert + await shell.runCommand("cp /etc/ssl/certs/ca-certificates.crt /tmp/yarn-certs.pem"); + + const result = await shell.runCommand( + "NODE_EXTRA_CA_CERTS=/tmp/yarn-certs.pem yarn add axios@1.13.0" + ); + + assert.ok( + !result.output.toLowerCase().includes("error") || result.output.includes("Done"), + `yarn add failed with valid NODE_EXTRA_CA_CERTS. Output was:\n${result.output}` + ); + }); + + it(`pnpm install works with valid NODE_EXTRA_CA_CERTS set`, async () => { + const shell = await container.openShell("zsh"); + + // Create valid cert + await shell.runCommand("cp /etc/ssl/certs/ca-certificates.crt /tmp/pnpm-certs.pem"); + + const result = await shell.runCommand( + "NODE_EXTRA_CA_CERTS=/tmp/pnpm-certs.pem pnpm add axios@1.13.0" + ); + + assert.ok( + !result.output.toLowerCase().includes("error") || result.output.includes("Progress"), + `pnpm add failed with valid NODE_EXTRA_CA_CERTS. Output was:\n${result.output}` + ); + }); + + it(`bun install works with valid NODE_EXTRA_CA_CERTS set`, async () => { + const shell = await container.openShell("bash"); + + // Create valid cert and run bun in the same command to ensure file exists + const result = await shell.runCommand( + "cp /etc/ssl/certs/ca-certificates.crt /tmp/bun-certs.pem && NODE_EXTRA_CA_CERTS=/tmp/bun-certs.pem bun i axios@1.13.0" + ); + + assert.ok( + !result.output.toLowerCase().includes("error") || result.output.includes("installed"), + `bun i failed with valid NODE_EXTRA_CA_CERTS. Output was:\n${result.output}` + ); + }); +}); diff --git a/test/e2e/include-python-deprecation.e2e.spec.js b/test/e2e/include-python-deprecation.e2e.spec.js new file mode 100644 index 0000000..a7019b7 --- /dev/null +++ b/test/e2e/include-python-deprecation.e2e.spec.js @@ -0,0 +1,45 @@ +import { describe, it, before, beforeEach, afterEach } from "node:test"; +import { DockerTestContainer } from "./DockerTestContainer.js"; +import assert from "node:assert"; + +describe("E2E: deprecated --include-python handling", () => { + let container; + + before(async () => { + DockerTestContainer.buildImage(); + }); + + beforeEach(async () => { + container = new DockerTestContainer(); + await container.start(); + }); + + afterEach(async () => { + if (container) { + await container.stop(); + container = null; + } + }); + + for (let shell of ["bash", "zsh"]) { + it(`safe-chain setup warns and continues for ${shell}`, async () => { + const sh = await container.openShell(shell); + const result = await sh.runCommand("safe-chain setup --include-python"); + + assert.ok( + result.output.toLowerCase().includes("deprecated and ignored"), + `Expected warning about deprecated --include-python. Output was:\n${result.output}` + ); + }); + + it(`safe-chain setup-ci warns and continues for ${shell}`, async () => { + const sh = await container.openShell(shell); + const result = await sh.runCommand("safe-chain setup-ci --include-python"); + + assert.ok( + result.output.toLowerCase().includes("deprecated and ignored"), + `Expected warning about deprecated --include-python. Output was:\n${result.output}` + ); + }); + } +}); diff --git a/test/e2e/npm-ci.e2e.spec.js b/test/e2e/npm-ci.e2e.spec.js index 18ee789..1698759 100644 --- a/test/e2e/npm-ci.e2e.spec.js +++ b/test/e2e/npm-ci.e2e.spec.js @@ -33,7 +33,9 @@ describe("E2E: npm coverage using PATH", () => { it(`safe-chain succesfully installs safe packages`, async () => { const shell = await container.openShell("zsh"); - const result = await shell.runCommand("npm i axios"); + const result = await shell.runCommand( + "npm i axios@1.13.0 --safe-chain-logging=verbose" + ); assert.ok( result.output.includes("no malware found."), diff --git a/test/e2e/npm.e2e.spec.js b/test/e2e/npm.e2e.spec.js index b2b7211..810359e 100644 --- a/test/e2e/npm.e2e.spec.js +++ b/test/e2e/npm.e2e.spec.js @@ -28,7 +28,9 @@ describe("E2E: npm coverage", () => { it(`safe-chain succesfully installs safe packages`, async () => { const shell = await container.openShell("zsh"); - const result = await shell.runCommand("npm i axios"); + const result = await shell.runCommand( + "npm i axios@1.13.0 --safe-chain-logging=verbose" + ); assert.ok( result.output.includes("no malware found."), @@ -68,8 +70,9 @@ describe("E2E: npm coverage", () => { var result = await shell.runCommand("npm install"); - assert.ok( - result.output.includes("blocked 1 malicious package downloads"), + assert.match( + result.output, + /blocked [1-9]\d* malicious package downloads/, `Output did not include expected text. Output was:\n${result.output}` ); assert.ok( diff --git a/test/e2e/pdm.e2e.spec.js b/test/e2e/pdm.e2e.spec.js new file mode 100644 index 0000000..94bb5e0 --- /dev/null +++ b/test/e2e/pdm.e2e.spec.js @@ -0,0 +1,300 @@ +import { describe, it, before, beforeEach, afterEach } from "node:test"; +import { DockerTestContainer } from "./DockerTestContainer.js"; +import assert from "node:assert"; + +describe("E2E: pdm coverage", () => { + let container; + + before(async () => { + DockerTestContainer.buildImage(); + }); + + beforeEach(async () => { + // Run a new Docker container for each test + container = new DockerTestContainer(); + await container.start(); + + const installationShell = await container.openShell("zsh"); + await installationShell.runCommand("safe-chain setup"); + + // Clear pdm cache + await installationShell.runCommand("command pdm cache clear"); + }); + + afterEach(async () => { + // Stop and clean up the container after each test + if (container) { + await container.stop(); + container = null; + } + }); + + it(`successfully installs known safe packages with pdm add`, async () => { + const shell = await container.openShell("zsh"); + + // Initialize a new pdm project + await shell.runCommand("mkdir /tmp/test-pdm-project && cd /tmp/test-pdm-project"); + await shell.runCommand("cd /tmp/test-pdm-project && pdm init --non-interactive"); + + // Add a safe package + const result = await shell.runCommand( + "cd /tmp/test-pdm-project && pdm add requests" + ); + + assert.ok( + result.output.includes("no malware found.") || result.output.includes("Installing"), + `Output did not include expected text. Output was:\n${result.output}` + ); + }); + + it(`pdm add with specific version`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("mkdir /tmp/test-pdm-version && cd /tmp/test-pdm-version"); + await shell.runCommand("cd /tmp/test-pdm-version && pdm init --non-interactive"); + + const result = await shell.runCommand( + "cd /tmp/test-pdm-version && pdm add requests==2.32.3" + ); + + assert.ok( + result.output.includes("no malware found.") || result.output.includes("Installing"), + `Output did not include expected text. Output was:\n${result.output}` + ); + }); + + it(`safe-chain blocks installation of malicious Python packages via pdm`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("mkdir /tmp/test-pdm-malware && cd /tmp/test-pdm-malware"); + await shell.runCommand("cd /tmp/test-pdm-malware && pdm init --non-interactive"); + + const result = await shell.runCommand( + "cd /tmp/test-pdm-malware && pdm add numpy==2.4.4" + ); + + assert.ok( + result.output.includes("blocked") && result.output.includes("malicious package downloads"), + `Expected malware to be blocked. Output was:\n${result.output}` + ); + assert.ok( + result.output.includes("Exiting without installing malicious packages."), + `Expected exit message. Output was:\n${result.output}` + ); + }); + + it(`pdm install installs dependencies from pyproject.toml`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("mkdir /tmp/test-pdm-install && cd /tmp/test-pdm-install"); + await shell.runCommand("cd /tmp/test-pdm-install && pdm init --non-interactive"); + await shell.runCommand("cd /tmp/test-pdm-install && pdm add requests"); + + // Now remove the virtualenv and run install + await shell.runCommand("cd /tmp/test-pdm-install && rm -rf .venv"); + + const result = await shell.runCommand( + "cd /tmp/test-pdm-install && pdm install" + ); + + assert.ok( + result.output.includes("no malware found.") || result.output.includes("Installing"), + `Output did not include expected text. Output was:\n${result.output}` + ); + }); + + it(`pdm update with specific packages`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("mkdir /tmp/test-pdm-update-specific && cd /tmp/test-pdm-update-specific"); + await shell.runCommand("cd /tmp/test-pdm-update-specific && pdm init --non-interactive"); + await shell.runCommand("cd /tmp/test-pdm-update-specific && pdm add requests certifi"); + + const result = await shell.runCommand( + "cd /tmp/test-pdm-update-specific && pdm update requests" + ); + + assert.ok( + result.output.includes("no malware found.") || result.output.includes("Updating"), + `Output did not include expected text. Output was:\n${result.output}` + ); + }); + + it(`pdm add with multiple packages`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("mkdir /tmp/test-pdm-multi && cd /tmp/test-pdm-multi"); + await shell.runCommand("cd /tmp/test-pdm-multi && pdm init --non-interactive"); + + const result = await shell.runCommand( + "cd /tmp/test-pdm-multi && pdm add requests certifi" + ); + + assert.ok( + result.output.includes("no malware found.") || result.output.includes("Installing"), + `Output did not include expected text. Output was:\n${result.output}` + ); + }); + + it(`pdm add with extras`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("mkdir /tmp/test-pdm-extras && cd /tmp/test-pdm-extras"); + await shell.runCommand("cd /tmp/test-pdm-extras && pdm init --non-interactive"); + + // Use quotes to prevent shell expansion of square brackets + const result = await shell.runCommand( + 'cd /tmp/test-pdm-extras && pdm add "requests[security]"' + ); + + assert.ok( + result.output.includes("no malware found.") || result.output.includes("Installing"), + `Output did not include expected text. Output was:\n${result.output}` + ); + }); + + it(`pdm add with development group`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("mkdir /tmp/test-pdm-dev && cd /tmp/test-pdm-dev"); + await shell.runCommand("cd /tmp/test-pdm-dev && pdm init --non-interactive"); + + const result = await shell.runCommand( + "cd /tmp/test-pdm-dev && pdm add -dG dev pytest" + ); + + assert.ok( + result.output.includes("no malware found.") || result.output.includes("Installing"), + `Output did not include expected text. Output was:\n${result.output}` + ); + }); + + it(`pdm lock creates/updates lock file`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("mkdir /tmp/test-pdm-lock && cd /tmp/test-pdm-lock"); + await shell.runCommand("cd /tmp/test-pdm-lock && pdm init --non-interactive"); + await shell.runCommand("cd /tmp/test-pdm-lock && pdm add requests"); + await shell.runCommand("cd /tmp/test-pdm-lock && rm pdm.lock"); + + const result = await shell.runCommand( + "cd /tmp/test-pdm-lock && pdm lock" + ); + + assert.ok( + result.output.includes("no malware found.") || result.output.includes("Resolving") || result.output.includes("lock file"), + `Output did not include expected text. Output was:\n${result.output}` + ); + }); + + it(`pdm remove does not download packages`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("mkdir /tmp/test-pdm-remove && cd /tmp/test-pdm-remove"); + await shell.runCommand("cd /tmp/test-pdm-remove && pdm init --non-interactive"); + await shell.runCommand("cd /tmp/test-pdm-remove && pdm add requests"); + + const result = await shell.runCommand( + "cd /tmp/test-pdm-remove && pdm remove requests" + ); + + // Remove should succeed - it doesn't download packages, just modifies pyproject.toml + assert.ok( + !result.output.includes("blocked"), + `Remove command should not trigger downloads. Output was:\n${result.output}` + ); + }); + + it(`blocks malware during pdm install`, async () => { + const shell = await container.openShell("zsh"); + + // Create a project with malware in dependencies + await shell.runCommand("mkdir /tmp/test-pdm-install-malware && cd /tmp/test-pdm-install-malware"); + await shell.runCommand("cd /tmp/test-pdm-install-malware && pdm init --non-interactive"); + + // Add malware package - this will create lock file and attempt download + const result = await shell.runCommand( + "cd /tmp/test-pdm-install-malware && pdm add numpy==2.4.4 2>&1" + ); + + assert.ok( + result.output.includes("blocked") && result.output.includes("malicious package downloads"), + `Expected malware to be blocked during add (which triggers install). Output was:\n${result.output}` + ); + assert.ok( + result.output.includes("Exiting without installing malicious packages."), + `Expected exit message. Output was:\n${result.output}` + ); + }); + + it(`blocks malware when adding malicious dependency alongside safe one`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("mkdir /tmp/test-pdm-batch && cd /tmp/test-pdm-batch"); + await shell.runCommand("cd /tmp/test-pdm-batch && pdm init --non-interactive"); + + // Try to add malware alongside safe package + const result = await shell.runCommand( + "cd /tmp/test-pdm-batch && pdm add numpy==2.4.4 requests 2>&1" + ); + + assert.ok( + result.output.includes("blocked") && result.output.includes("malicious package downloads"), + `Expected malware to be blocked. Output was:\n${result.output}` + ); + assert.ok( + result.output.includes("Exiting without installing malicious packages."), + `Expected exit message. Output was:\n${result.output}` + ); + + // Verify safe package was also not installed due to malware in batch + const listResult = await shell.runCommand("cd /tmp/test-pdm-batch && pdm list"); + assert.ok( + !listResult.output.includes("requests"), + `Safe package should not be installed when batch includes malware. Output was:\n${listResult.output}` + ); + }); + + it(`pdm non-network commands work correctly`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("mkdir /tmp/test-pdm-nonnetwork && cd /tmp/test-pdm-nonnetwork"); + await shell.runCommand("cd /tmp/test-pdm-nonnetwork && pdm init --non-interactive"); + await shell.runCommand("cd /tmp/test-pdm-nonnetwork && pdm add requests"); + + // Test pdm --version + const versionResult = await shell.runCommand("pdm --version"); + assert.ok( + versionResult.output.includes("PDM") || versionResult.output.includes("pdm"), + `Expected version output. Output was:\n${versionResult.output}` + ); + + // Test pdm list (list installed packages) + const listResult = await shell.runCommand("cd /tmp/test-pdm-nonnetwork && pdm list"); + assert.ok( + listResult.output.includes("requests"), + `Expected to see installed package. Output was:\n${listResult.output}` + ); + + // Test pdm info (show project info) + const infoResult = await shell.runCommand("cd /tmp/test-pdm-nonnetwork && pdm info"); + assert.ok( + infoResult.output.includes("PDM") || infoResult.output.includes("Python") || infoResult.output.includes("Project"), + `Expected project info. Output was:\n${infoResult.output}` + ); + + // Test pdm config (show configuration) + const configResult = await shell.runCommand("pdm config"); + assert.ok( + configResult.output.length > 0, + `Expected configuration output. Output was:\n${configResult.output}` + ); + + // Test pdm run (execute command in virtualenv) - non-network command + const runResult = await shell.runCommand("cd /tmp/test-pdm-nonnetwork && pdm run python --version"); + assert.ok( + runResult.output.includes("Python"), + `Expected Python version output. Output was:\n${runResult.output}` + ); + }); +}); diff --git a/test/e2e/pip-ci.e2e.spec.js b/test/e2e/pip-ci.e2e.spec.js index 63bfd90..49db6ce 100644 --- a/test/e2e/pip-ci.e2e.spec.js +++ b/test/e2e/pip-ci.e2e.spec.js @@ -12,6 +12,10 @@ describe("E2E: safe-chain setup-ci command for pip/pip3", () => { beforeEach(async () => { container = new DockerTestContainer(); await container.start(); + + // Clear pip cache before each test to ensure fresh downloads through proxy + const shell = await container.openShell("zsh"); + await shell.runCommand("pip3 cache purge"); }); afterEach(async () => { @@ -82,7 +86,7 @@ describe("E2E: safe-chain setup-ci command for pip/pip3", () => { // Setup safe-chain CI shims const installationShell = await container.openShell(shell); await installationShell.runCommand( - "safe-chain setup-ci --include-python" + "safe-chain setup-ci" ); // Add $HOME/.safe-chain/shims to PATH for subsequent shells @@ -96,7 +100,7 @@ describe("E2E: safe-chain setup-ci command for pip/pip3", () => { const projectShell = await container.openShell(shell); // Use --break-system-packages to avoid Debian/Ubuntu external management restrictions const result = await projectShell.runCommand( - "pip3 install --break-system-packages certifi" + "pip3 install --break-system-packages certifi --safe-chain-logging=verbose" ); const hasExpectedOutput = result.output.includes("no malware found."); @@ -111,7 +115,7 @@ describe("E2E: safe-chain setup-ci command for pip/pip3", () => { it(`setup-ci routes python -m pip through safe-chain for ${shell}`, async () => { const installationShell = await container.openShell(shell); await installationShell.runCommand( - "safe-chain setup-ci --include-python" + "safe-chain setup-ci" ); await installationShell.runCommand( "echo 'export PATH=\"$HOME/.safe-chain/shims:$PATH\"' >> ~/.zshrc" @@ -122,7 +126,7 @@ describe("E2E: safe-chain setup-ci command for pip/pip3", () => { const projectShell = await container.openShell(shell); const result = await projectShell.runCommand( - "python -m pip install --break-system-packages certifi" + "python -m pip install --break-system-packages certifi --safe-chain-logging=verbose" ); assert.ok( @@ -134,7 +138,7 @@ describe("E2E: safe-chain setup-ci command for pip/pip3", () => { it(`setup-ci routes python3 -m pip through safe-chain for ${shell}`, async () => { const installationShell = await container.openShell(shell); await installationShell.runCommand( - "safe-chain setup-ci --include-python" + "safe-chain setup-ci" ); await installationShell.runCommand( "echo 'export PATH=\"$HOME/.safe-chain/shims:$PATH\"' >> ~/.zshrc" @@ -145,7 +149,7 @@ describe("E2E: safe-chain setup-ci command for pip/pip3", () => { const projectShell = await container.openShell(shell); const result = await projectShell.runCommand( - "python3 -m pip install --break-system-packages certifi" + "python3 -m pip install --break-system-packages certifi --safe-chain-logging=verbose" ); assert.ok( @@ -157,7 +161,7 @@ describe("E2E: safe-chain setup-ci command for pip/pip3", () => { it(`setup-ci routes pip through safe-chain for ${shell}`, async () => { const installationShell = await container.openShell(shell); await installationShell.runCommand( - "safe-chain setup-ci --include-python" + "safe-chain setup-ci" ); await installationShell.runCommand( "echo 'export PATH=\"$HOME/.safe-chain/shims:$PATH\"' >> ~/.zshrc" @@ -168,7 +172,7 @@ describe("E2E: safe-chain setup-ci command for pip/pip3", () => { const projectShell = await container.openShell(shell); const result = await projectShell.runCommand( - "pip install --break-system-packages certifi" + "pip install --break-system-packages certifi --safe-chain-logging=verbose" ); assert.ok( @@ -180,7 +184,7 @@ describe("E2E: safe-chain setup-ci command for pip/pip3", () => { it(`setup-ci routes pip3 through safe-chain for ${shell}`, async () => { const installationShell = await container.openShell(shell); await installationShell.runCommand( - "safe-chain setup-ci --include-python" + "safe-chain setup-ci" ); await installationShell.runCommand( "echo 'export PATH=\"$HOME/.safe-chain/shims:$PATH\"' >> ~/.zshrc" @@ -191,7 +195,7 @@ describe("E2E: safe-chain setup-ci command for pip/pip3", () => { const projectShell = await container.openShell(shell); const result = await projectShell.runCommand( - "pip3 install --break-system-packages certifi" + "pip3 install --break-system-packages certifi --safe-chain-logging=verbose" ); assert.ok( diff --git a/test/e2e/pip-minimum-age.e2e.spec.js b/test/e2e/pip-minimum-age.e2e.spec.js new file mode 100644 index 0000000..36705db --- /dev/null +++ b/test/e2e/pip-minimum-age.e2e.spec.js @@ -0,0 +1,168 @@ +import { describe, it, before, beforeEach, afterEach } from "node:test"; +import assert from "node:assert"; +import { DockerTestContainer } from "./DockerTestContainer.js"; + +describe("E2E: pip minimum package age", () => { + let container; + + before(async () => { + DockerTestContainer.buildImage(); + }); + + beforeEach(async () => { + container = new DockerTestContainer(); + await container.start(); + + const installationShell = await container.openShell("zsh"); + await installationShell.runCommand("safe-chain setup"); + await installationShell.runCommand("pip3 cache purge"); + }); + + afterEach(async () => { + if (container) { + await container.stop(); + container = null; + } + }); + + it("falls back to an older PyPI version for flexible constraints", async () => { + const shell = await container.openShell("zsh"); + const latestVersion = await getLatestPackageVersion(shell, "openai"); + const tooYoungTimestamps = getTooYoungReleaseTimestamps(); + + await startFeedServer(container, [ + { + source: "pypi", + package_name: "openai", + version: latestVersion, + ...tooYoungTimestamps, + }, + ]); + + const installResult = await shell.runCommand( + 'SAFE_CHAIN_MALWARE_LIST_BASE_URL=http://127.0.0.1:8123 pip3 install --break-system-packages "openai>=2.8.0,<3" --safe-chain-logging=verbose' + ); + + assert.ok( + installResult.output.includes(`openai@${latestVersion} is newer than 48 hours and was removed`), + `Expected Safe Chain to suppress the latest openai version. Output was:\n${installResult.output}` + ); + assert.ok( + !installResult.output.includes("blocked by safe-chain direct download minimum package age"), + `Expected fallback during resolution, not a direct-download block. Output was:\n${installResult.output}` + ); + assert.ok( + installResult.output.includes("Successfully installed"), + `Expected pip install to succeed after fallback. Output was:\n${installResult.output}` + ); + + const installedVersion = await getInstalledVersion(shell, "openai"); + assert.notEqual( + installedVersion, + latestVersion, + `Expected fallback to an older openai version, but installed ${latestVersion}.` + ); + }); + + it("fails cleanly for exact pinned too-young PyPI versions", async () => { + const shell = await container.openShell("zsh"); + const latestVersion = await getLatestPackageVersion(shell, "openai"); + const tooYoungTimestamps = getTooYoungReleaseTimestamps(); + + await startFeedServer(container, [ + { + source: "pypi", + package_name: "openai", + version: latestVersion, + ...tooYoungTimestamps, + }, + ]); + + const installResult = await shell.runCommand( + `SAFE_CHAIN_MALWARE_LIST_BASE_URL=http://127.0.0.1:8123 pip3 install --break-system-packages openai==${latestVersion} --safe-chain-logging=verbose` + ); + + assert.ok( + installResult.output.includes(`openai@${latestVersion} is newer than 48 hours and was removed`), + `Expected Safe Chain to suppress the pinned openai version. Output was:\n${installResult.output}` + ); + assert.ok( + installResult.output.includes(`No matching distribution found for openai==${latestVersion}`) || + installResult.output.includes(`Could not find a version that satisfies the requirement openai==${latestVersion}`), + `Expected pip to fail because the exact version was suppressed. Output was:\n${installResult.output}` + ); + assert.ok( + !installResult.output.includes("blocked by safe-chain direct download minimum package age"), + `Expected resolver failure for an exact pin, not a direct-download block. Output was:\n${installResult.output}` + ); + }); +}); + +async function getLatestPackageVersion(shell, packageName) { + const result = await shell.runCommand(`/usr/bin/pip3 index versions ${packageName}`); + const version = result.output.match(new RegExp(`${packageName} \\(([^)]+)\\)`))?.[1]; + + assert.ok( + version, + `Could not determine latest ${packageName} version from pip output:\n${result.output}` + ); + + return version; +} + +async function getInstalledVersion(shell, packageName) { + const result = await shell.runCommand( + `python3 - <<'PY' +import importlib.metadata +print(importlib.metadata.version("${packageName}")) +PY` + ); + + return result.output.trim(); +} + +async function startFeedServer(container, releases) { + const shell = await container.openShell("bash"); + const releasesJson = JSON.stringify(releases, null, 2); + + await shell.runCommand(`mkdir -p /tmp/safe-chain-feed/releases +cat > /tmp/safe-chain-feed/malware_pypi.json <<'EOF' +[] +EOF +cat > /tmp/safe-chain-feed/releases/pypi.json <<'EOF' +${releasesJson} +EOF`); + + container.dockerExec( + "nohup python3 -m http.server 8123 -d /tmp/safe-chain-feed >/tmp/safe-chain-feed.log 2>&1 /dev/null; then + break + fi + sleep 0.1 + i=$((i + 1)) +done +if [ "$i" -ge 100 ]; then + echo "feed server did not become ready" >&2 + cat /tmp/safe-chain-feed.log >&2 || true +fi`); + + assert.equal( + readinessResult.output.includes("feed server did not become ready"), + false, + `Expected local feed server to become ready. Output was:\n${readinessResult.output}` + ); +} + +function getTooYoungReleaseTimestamps() { + const now = Math.floor(Date.now() / 1000); + + return { + released_on: now, + scraped_on: now, + }; +} diff --git a/test/e2e/pip.e2e.spec.js b/test/e2e/pip.e2e.spec.js index 9a1adec..8044a0f 100644 --- a/test/e2e/pip.e2e.spec.js +++ b/test/e2e/pip.e2e.spec.js @@ -15,7 +15,10 @@ describe("E2E: pip coverage", () => { await container.start(); const installationShell = await container.openShell("zsh"); - await installationShell.runCommand("safe-chain setup --include-python"); + await installationShell.runCommand("safe-chain setup"); + + // Clear pip cache before each test to ensure fresh downloads through proxy + await installationShell.runCommand("pip3 cache purge"); }); afterEach(async () => { @@ -29,7 +32,7 @@ describe("E2E: pip coverage", () => { it(`successfully installs known safe packages with pip3`, async () => { const shell = await container.openShell("zsh"); const result = await shell.runCommand( - "pip3 install --break-system-packages requests" + "pip3 install --break-system-packages requests --safe-chain-logging=verbose" ); assert.ok( @@ -40,7 +43,9 @@ describe("E2E: pip coverage", () => { it(`pip3 download`, async () => { const shell = await container.openShell("zsh"); - const result = await shell.runCommand("pip3 download requests"); + const result = await shell.runCommand( + "pip3 download requests --safe-chain-logging=verbose" + ); assert.ok( result.output.includes("no malware found."), @@ -50,7 +55,9 @@ describe("E2E: pip coverage", () => { it(`pip3 .whl`, async () => { const shell = await container.openShell("zsh"); - const result = await shell.runCommand("pip3 wheel requests"); + const result = await shell.runCommand( + "pip3 wheel requests --safe-chain-logging=verbose" + ); assert.ok( result.output.includes("no malware found."), @@ -61,7 +68,7 @@ describe("E2E: pip coverage", () => { it(`pip3 install --dry-run is respected by scanner`, async () => { const shell = await container.openShell("zsh"); const result = await shell.runCommand( - "pip3 install --dry-run --break-system-packages requests" + "pip3 install --dry-run --break-system-packages requests --safe-chain-logging=verbose" ); assert.ok( @@ -73,7 +80,7 @@ describe("E2E: pip coverage", () => { it(`pip3 install with extras such as requests[socks]`, async () => { const shell = await container.openShell("zsh"); const result = await shell.runCommand( - 'pip3 install --break-system-packages "requests[socks]==2.32.3"' + 'pip3 install --break-system-packages "requests[socks]==2.32.3" --safe-chain-logging=verbose' ); assert.ok( @@ -85,7 +92,7 @@ describe("E2E: pip coverage", () => { it(`pip3 install with range version specifier`, async () => { const shell = await container.openShell("zsh"); const result = await shell.runCommand( - 'pip3 install --break-system-packages "Jinja2>=3.1,<3.2"' + 'pip3 install --break-system-packages "Jinja2>=3.1,<3.2" --safe-chain-logging=verbose' ); assert.ok( @@ -97,7 +104,7 @@ describe("E2E: pip coverage", () => { it(`python3 -m pip install routes through safe-chain`, async () => { const shell = await container.openShell("zsh"); const result = await shell.runCommand( - "python3 -m pip install --break-system-packages requests" + "python3 -m pip install --break-system-packages requests --safe-chain-logging=verbose" ); assert.ok( @@ -108,7 +115,9 @@ describe("E2E: pip coverage", () => { it(`python3 -m pip download routes through safe-chain`, async () => { const shell = await container.openShell("zsh"); - const result = await shell.runCommand("python3 -m pip download requests"); + const result = await shell.runCommand( + "python3 -m pip download requests --safe-chain-logging=verbose" + ); assert.ok( result.output.includes("no malware found."), @@ -118,19 +127,17 @@ describe("E2E: pip coverage", () => { it(`safe-chain blocks installation of malicious Python packages`, async () => { const shell = await container.openShell("zsh"); - // Clear pip cache to ensure network download through proxy - await shell.runCommand("pip3 cache purge"); - const result = await shell.runCommand( - "pip3 install --break-system-packages safe-chain-pi-test" + "pip3 install --break-system-packages numpy==2.4.4 --safe-chain-logging=verbose" ); - assert.ok( - result.output.includes("blocked 1 malicious package downloads:"), + assert.match( + result.output, + /blocked [1-9]\d* malicious package downloads:/, `Output did not include expected text. Output was:\n${result.output}` ); assert.ok( - result.output.includes("safe_chain_pi_test@0.0.1"), + result.output.includes("numpy@2.4.4"), `Output did not include expected text. Output was:\n${result.output}` ); assert.ok( @@ -140,7 +147,7 @@ describe("E2E: pip coverage", () => { const listResult = await shell.runCommand("pip3 list"); assert.ok( - !listResult.output.includes("safe-chain-pi-test"), + !listResult.output.includes("numpy"), `Malicious package was installed despite safe-chain protection. Output of 'pip3 list' was:\n${listResult.output}` ); }); @@ -148,7 +155,7 @@ describe("E2E: pip coverage", () => { it(`python -m pip routes to aikido-pip (uses pip command)`, async () => { const shell = await container.openShell("zsh"); const result = await shell.runCommand( - "python -m pip install --break-system-packages requests" + "python -m pip install --break-system-packages requests --safe-chain-logging=verbose" ); assert.ok( @@ -166,7 +173,7 @@ describe("E2E: pip coverage", () => { it(`python -m pip3 routes to aikido-pip3 (uses pip3 command)`, async () => { const shell = await container.openShell("zsh"); const result = await shell.runCommand( - "python -m pip3 install --break-system-packages requests" + "python -m pip3 install --break-system-packages requests --safe-chain-logging=verbose" ); assert.ok( @@ -184,7 +191,7 @@ describe("E2E: pip coverage", () => { it(`python3 -m pip routes to aikido-pip3 (uses pip3 command)`, async () => { const shell = await container.openShell("zsh"); const result = await shell.runCommand( - "python3 -m pip install --break-system-packages requests" + "python3 -m pip install --break-system-packages requests --safe-chain-logging=verbose" ); assert.ok( @@ -202,7 +209,7 @@ describe("E2E: pip coverage", () => { it(`python3 -m pip3 routes to aikido-pip3 (uses pip3 command)`, async () => { const shell = await container.openShell("zsh"); const result = await shell.runCommand( - "python3 -m pip3 install --break-system-packages requests" + "python3 -m pip3 install --break-system-packages requests --safe-chain-logging=verbose" ); assert.ok( @@ -222,7 +229,7 @@ describe("E2E: pip coverage", () => { // Install a simple package from GitHub - this should use TCP tunnel, not MITM // Using a popular, small package for testing const result = await shell.runCommand( - "pip3 install --break-system-packages git+https://github.com/psf/requests.git@v2.32.3" + "pip3 install --break-system-packages git+https://github.com/psf/requests.git@v2.32.3 --safe-chain-logging=verbose" ); assert.ok( @@ -247,11 +254,8 @@ describe("E2E: pip coverage", () => { it(`pip3 successfully validates certificates for HTTPS downloads`, async () => { const shell = await container.openShell("zsh"); - // Clear cache to force network download through proxy - await shell.runCommand("pip3 cache purge"); - const result = await shell.runCommand( - "pip3 install --break-system-packages certifi" + "pip3 install --break-system-packages certifi --safe-chain-logging=verbose" ); assert.ok( @@ -279,7 +283,7 @@ describe("E2E: pip coverage", () => { // Test installing from a direct HTTPS URL (not a registry) // This validates that non-registry HTTPS traffic works with our env-provided CA bundle const result = await shell.runCommand( - "pip3 install --break-system-packages https://files.pythonhosted.org/packages/70/8e/0e2d847013cb52cd35b38c009bb167a1a26b2ce6cd6965bf26b47bc0bf44/requests-2.31.0-py3-none-any.whl" + "pip3 install --break-system-packages https://files.pythonhosted.org/packages/70/8e/0e2d847013cb52cd35b38c009bb167a1a26b2ce6cd6965bf26b47bc0bf44/requests-2.31.0-py3-none-any.whl --safe-chain-logging=verbose" ); assert.ok( @@ -302,7 +306,7 @@ describe("E2E: pip coverage", () => { // This tests tunneled HTTPS with our env-provided CA bundle (Safe Chain CA + Mozilla + Node roots) // If the CA bundle doesn't include public roots, this will fail with CERTIFICATE_VERIFY_FAILED const result = await shell.runCommand( - "pip3 install --break-system-packages --index-url https://test.pypi.org/simple certifi" + "pip3 install --break-system-packages --index-url https://test.pypi.org/simple certifi --safe-chain-logging=verbose" ); assert.ok( @@ -336,4 +340,509 @@ describe("E2E: pip coverage", () => { `Output did not include expected text. Output was:\n${result.output}` ); }); + + it(`pip3 config set should work and persist configuration`, async () => { + const shell = await container.openShell("zsh"); + + // Set a config value + const setResult = await shell.runCommand( + "pip3 config set global.timeout 60" + ); + + assert.ok( + setResult.output.includes("Writing to"), + `pip3 config set should write config. Output was:\n${setResult.output}` + ); + + // Verify it was persisted by reading it back + const getResult = await shell.runCommand("pip3 config get global.timeout"); + + assert.ok( + getResult.output.includes("60"), + `Config value should be 60. Output was:\n${getResult.output}` + ); + }); + + it(`pip3 config list should show user configuration`, async () => { + const shell = await container.openShell("zsh"); + + // Set a value first + await shell.runCommand("pip3 config set global.timeout 90"); + + // List config + const listResult = await shell.runCommand("pip3 config list"); + + assert.ok( + listResult.output.includes("timeout") && listResult.output.includes("90"), + `Config list should show timeout=90. Output was:\n${listResult.output}` + ); + }); + + it(`pip3 config unset should remove configuration`, async () => { + const shell = await container.openShell("zsh"); + + // Set a value + await shell.runCommand("pip3 config set global.timeout 120"); + + // Verify it exists + const getResult = await shell.runCommand("pip3 config get global.timeout"); + assert.ok(getResult.output.includes("120")); + + // Unset it + const unsetResult = await shell.runCommand( + "pip3 config unset global.timeout" + ); + assert.ok( + unsetResult.output.includes("Writing to"), + `pip3 config unset should write config. Output was:\n${unsetResult.output}` + ); + }); + + it(`pip3 cache dir should return cache directory path`, async () => { + const shell = await container.openShell("zsh"); + + const result = await shell.runCommand("pip3 cache dir"); + + // Should output a directory path + assert.ok( + result.output.includes("/") && result.output.includes("cache"), + `Should output a cache directory path. Output was:\n${result.output}` + ); + }); + + it(`pip3 cache info should show cache information`, async () => { + const shell = await container.openShell("zsh"); + + // Install something first to populate cache + await shell.runCommand("pip3 install --break-system-packages certifi"); + + const result = await shell.runCommand("pip3 cache info"); + + // Output should contain cache-related information + assert.ok( + result.output.match(/cache|wheel|http/i), + `Should output cache information. Output was:\n${result.output}` + ); + }); + + it(`pip3 cache list should list cached packages`, async () => { + const shell = await container.openShell("zsh"); + + // Download a package to ensure something is in cache + await shell.runCommand("pip3 download certifi"); + + const result = await shell.runCommand("pip3 cache list certifi"); + + // Should show either cached wheels or "No locally built wheels" + assert.ok( + result.output.includes("certifi") || + result.output.includes("No locally built"), + `Should output cache list information. Output was:\n${result.output}` + ); + }); + + it(`pip3 debug should output debug information`, async () => { + const shell = await container.openShell("zsh"); + + const result = await shell.runCommand("pip3 debug"); + + // Should contain debug information about pip environment + assert.ok( + result.output.match(/pip version|sys\.version|sys\.executable/i), + `Should output debug information. Output was:\n${result.output}` + ); + + // Should NOT show safe-chain's temporary config file in the debug output + assert.ok( + !result.output.includes("safe-chain-pip-"), + `Debug output should not reference safe-chain temp config. Output was:\n${result.output}` + ); + }); + + it(`pip3 completion should generate shell completion script`, async () => { + const shell = await container.openShell("zsh"); + + const result = await shell.runCommand("pip3 completion --zsh"); + + // Should output shell completion code + assert.ok( + result.output.includes("compdef") || + result.output.includes("_pip") || + result.output.includes("pip completion"), + `Should output completion code. Output was:\n${result.output}` + ); + }); + + it(`pip3 install still works after config operations`, async () => { + const shell = await container.openShell("zsh"); + + // Perform config operations + await shell.runCommand("pip3 config set global.timeout 60"); + await shell.runCommand("pip3 cache dir"); + + // Now install should still work with malware protection + const result = await shell.runCommand( + "pip3 install --break-system-packages certifi --safe-chain-logging=verbose" + ); + + assert.ok( + result.output.includes("Successfully installed") || + result.output.includes("Requirement already satisfied"), + `Install should succeed after config operations. Output was:\n${result.output}` + ); + + assert.ok( + result.output.includes("no malware found."), + `Should still scan for malware. Output was:\n${result.output}` + ); + }); + + it(`pip3 download works after configuring pip settings`, async () => { + const shell = await container.openShell("zsh"); + + // Configure pip with timeout and extra index URL + const configTimeout = await shell.runCommand( + "pip3 config set global.timeout 60" + ); + assert.ok( + configTimeout.output.includes("Writing to"), + `Config set should succeed. Output was:\n${configTimeout.output}` + ); + + const configIndex = await shell.runCommand( + "pip3 config set global.extra-index-url https://pypi.org/simple" + ); + assert.ok( + configIndex.output.includes("Writing to"), + `Config set should succeed. Output was:\n${configIndex.output}` + ); + + // Verify config persisted + const listConfig = await shell.runCommand("pip3 config list"); + assert.ok( + listConfig.output.includes("timeout") && listConfig.output.includes("60"), + `Config should show timeout=60. Output was:\n${listConfig.output}` + ); + assert.ok( + listConfig.output.includes("extra-index-url") && + listConfig.output.includes("pypi.org"), + `Config should show extra-index-url. Output was:\n${listConfig.output}` + ); + + // Now download packages with the configured settings + const downloadResult = await shell.runCommand( + "pip3 download -d /tmp/packages requests certifi --safe-chain-logging=verbose" + ); + + assert.ok( + downloadResult.output.includes("no malware found."), + `Should scan for malware. Output was:\n${downloadResult.output}` + ); + + // Verify downloads succeeded + assert.ok( + downloadResult.output.includes("Saved") || + downloadResult.output.includes("requests"), + `Download should succeed with configured settings. Output was:\n${downloadResult.output}` + ); + assert.ok( + downloadResult.output.includes("certifi"), + `Should download certifi. Output was:\n${downloadResult.output}` + ); + }); + + // Tests for python/python3 bypass (non-pip invocations should go directly without safe-chain) + + it(`python3 --version should bypass safe-chain and work normally`, async () => { + const shell = await container.openShell("zsh"); + const result = await shell.runCommand("python3 --version"); + + // Should output Python version + assert.ok( + result.output.match(/Python 3\.\d+\.\d+/), + `Should output Python version. Output was:\n${result.output}` + ); + + // Should NOT go through safe-chain proxy + assert.ok( + !result.output.includes("Safe-chain"), + `python3 --version should not go through safe-chain. Output was:\n${result.output}` + ); + }); + + it(`python --version should bypass safe-chain and work normally`, async () => { + const shell = await container.openShell("zsh"); + const result = await shell.runCommand("python --version"); + + // Should output Python version + assert.ok( + result.output.match(/Python \d+\.\d+\.\d+/), + `Should output Python version. Output was:\n${result.output}` + ); + + // Should NOT go through safe-chain + assert.ok( + !result.output.includes("Safe-chain"), + `python --version should not go through safe-chain. Output was:\n${result.output}` + ); + }); + + it(`python3 -c "print('hello')" should bypass safe-chain and execute code`, async () => { + const shell = await container.openShell("zsh"); + const result = await shell.runCommand( + "python3 -c \"print('hello world')\"" + ); + + // Should execute Python code + assert.ok( + result.output.includes("hello world"), + `Should execute Python code. Output was:\n${result.output}` + ); + + // Should NOT go through safe-chain + assert.ok( + !result.output.includes("Safe-chain"), + `python3 -c should not go through safe-chain. Output was:\n${result.output}` + ); + }); + + it(`python -c should bypass safe-chain and execute code`, async () => { + const shell = await container.openShell("zsh"); + const result = await shell.runCommand( + 'python -c "import sys; print(sys.version)"' + ); + + // Should execute Python code and print version + assert.ok( + result.output.match(/\d+\.\d+\.\d+/), + `Should execute Python code. Output was:\n${result.output}` + ); + + // Should NOT go through safe-chain + assert.ok( + !result.output.includes("Safe-chain"), + `python -c should not go through safe-chain. Output was:\n${result.output}` + ); + }); + + it(`python3 script.py should bypass safe-chain and execute script`, async () => { + const shell = await container.openShell("zsh"); + + // Create a simple Python script + await shell.runCommand( + "echo \"print('script executed')\" > /tmp/test_script.py" + ); + + const result = await shell.runCommand("python3 /tmp/test_script.py"); + + // Should execute the script + assert.ok( + result.output.includes("script executed"), + `Should execute Python script. Output was:\n${result.output}` + ); + + // Should NOT go through safe-chain + assert.ok( + !result.output.includes("Safe-chain"), + `python3 script.py should not go through safe-chain. Output was:\n${result.output}` + ); + }); + + it(`python script.py should bypass safe-chain and execute script`, async () => { + const shell = await container.openShell("zsh"); + + // Create a simple Python script + await shell.runCommand( + "echo \"print('python2/3 compatible')\" > /tmp/test_script2.py" + ); + + const result = await shell.runCommand("python /tmp/test_script2.py"); + + // Should execute the script + assert.ok( + result.output.includes("python2/3 compatible"), + `Should execute Python script. Output was:\n${result.output}` + ); + + // Should NOT go through safe-chain + assert.ok( + !result.output.includes("Safe-chain"), + `python script.py should not go through safe-chain. Output was:\n${result.output}` + ); + }); + + it(`python3 -m json.tool should bypass safe-chain (module other than pip)`, async () => { + const shell = await container.openShell("zsh"); + + // json.tool is a built-in Python module for formatting JSON + const result = await shell.runCommand( + "echo '{\"test\": 123}' | python3 -m json.tool" + ); + + // Should format JSON + assert.ok( + result.output.includes('"test"') && result.output.includes("123"), + `Should format JSON. Output was:\n${result.output}` + ); + + // Should NOT go through safe-chain + assert.ok( + !result.output.includes("Safe-chain"), + `python3 -m json.tool should not go through safe-chain. Output was:\n${result.output}` + ); + }); + + it(`python3 -m http.server should bypass safe-chain (module other than pip)`, async () => { + const shell = await container.openShell("zsh"); + + // Start http.server in background and kill it immediately + // We just want to verify it starts without safe-chain interference + const result = await shell.runCommand( + "timeout 1 python3 -m http.server 8999 || true" + ); + + // Should NOT go through safe-chain + assert.ok( + !result.output.includes("Safe-chain"), + `python3 -m http.server should not go through safe-chain. Output was:\n${result.output}` + ); + + // Should either start the server or timeout (both are success for bypass test) + assert.ok( + result.output.includes("Serving HTTP") || + result.output === "" || + result.exitCode !== undefined, + `Should attempt to start server. Output was:\n${result.output}` + ); + }); + + it(`python3 interactive mode should bypass safe-chain`, async () => { + const shell = await container.openShell("zsh"); + + // Run python3 with a command piped to stdin to simulate interactive mode + const result = await shell.runCommand("echo 'print(2+2)' | python3"); + + // Should execute the command + assert.ok( + result.output.includes("4"), + `Should execute Python interactively. Output was:\n${result.output}` + ); + + // Should NOT go through safe-chain + assert.ok( + !result.output.includes("Safe-chain"), + `python3 interactive should not go through safe-chain. Output was:\n${result.output}` + ); + }); + + it(`python3 with no arguments should bypass safe-chain`, async () => { + const shell = await container.openShell("zsh"); + + // Python with no args goes to interactive REPL, pipe exit command + const result = await shell.runCommand("echo 'exit()' | python3"); + + // Should NOT go through safe-chain + assert.ok( + !result.output.includes("Safe-chain"), + `python3 with no args should not go through safe-chain. Output was:\n${result.output}` + ); + }); + + it(`python3 -m venv should bypass safe-chain (venv module)`, async () => { + const shell = await container.openShell("zsh"); + + const result = await shell.runCommand("python3 -m venv /tmp/test_venv"); + + // Should create venv without safe-chain + assert.ok( + !result.output.includes("Safe-chain"), + `python3 -m venv should not go through safe-chain. Output was:\n${result.output}` + ); + + // Verify venv was created + const checkVenv = await shell.runCommand( + "test -f /tmp/test_venv/bin/python3 && echo 'exists'" + ); + assert.ok( + checkVenv.output.includes("exists"), + `venv should be created. Output was:\n${checkVenv.output}` + ); + }); + + it(`python3 -m pytest should bypass safe-chain (pytest module)`, async () => { + const shell = await container.openShell("zsh"); + + // pytest may not be installed, but the bypass should work regardless + const result = await shell.runCommand( + "python3 -m pytest --version 2>&1 || true" + ); + + // Should NOT go through safe-chain + assert.ok( + !result.output.includes("Safe-chain"), + `python3 -m pytest should not go through safe-chain. Output was:\n${result.output}` + ); + }); + + it(`python3 -m site should bypass safe-chain (site module)`, async () => { + const shell = await container.openShell("zsh"); + + const result = await shell.runCommand("python3 -m site"); + + // Should output site information + assert.ok( + result.output.includes("sys.path") || result.output.includes("USER_BASE"), + `Should output site information. Output was:\n${result.output}` + ); + + // Should NOT go through safe-chain + assert.ok( + !result.output.includes("Safe-chain"), + `python3 -m site should not go through safe-chain. Output was:\n${result.output}` + ); + }); + + // Verify that -m pip* still goes through safe-chain (sanity check) + + it(`python3 -m pip DOES go through safe-chain (sanity check)`, async () => { + const shell = await container.openShell("zsh"); + const result = await shell.runCommand( + "python3 -m pip install --break-system-packages certifi --safe-chain-logging=verbose" + ); + + // SHOULD go through safe-chain + assert.ok( + result.output.includes("Safe-chain") || + result.output.includes("no malware found"), + `python3 -m pip SHOULD go through safe-chain. Output was:\n${result.output}` + ); + }); + + it(`python3 -m pip3 DOES go through safe-chain (sanity check)`, async () => { + const shell = await container.openShell("zsh"); + const result = await shell.runCommand( + "python3 -m pip3 install --break-system-packages certifi --safe-chain-logging=verbose" + ); + + // SHOULD go through safe-chain + assert.ok( + result.output.includes("Safe-chain") || + result.output.includes("no malware found"), + `python3 -m pip3 SHOULD go through safe-chain. Output was:\n${result.output}` + ); + }); + + it(`python -m pip DOES go through safe-chain (sanity check)`, async () => { + const shell = await container.openShell("zsh"); + const result = await shell.runCommand( + "python -m pip install --break-system-packages certifi --safe-chain-logging=verbose" + ); + + // SHOULD go through safe-chain + assert.ok( + result.output.includes("Safe-chain") || + result.output.includes("no malware found"), + `python -m pip SHOULD go through safe-chain. Output was:\n${result.output}` + ); + }); }); diff --git a/test/e2e/pipx.e2e.spec.js b/test/e2e/pipx.e2e.spec.js new file mode 100644 index 0000000..332709d --- /dev/null +++ b/test/e2e/pipx.e2e.spec.js @@ -0,0 +1,200 @@ +import { describe, it, before, beforeEach, afterEach } from "node:test"; +import { DockerTestContainer } from "./DockerTestContainer.js"; +import assert from "node:assert"; + +describe("E2E: pipx coverage", () => { + let container; + + before(async () => { + DockerTestContainer.buildImage(); + }); + + beforeEach(async () => { + container = new DockerTestContainer(); + await container.start(); + + const installationShell = await container.openShell("zsh"); + await installationShell.runCommand("safe-chain setup"); + }); + + afterEach(async () => { + if (container) { + await container.stop(); + container = null; + } + }); + + it(`successfully installs known safe packages with pipx install`, async () => { + const shell = await container.openShell("zsh"); + + const result = await shell.runCommand( + "pipx install ruff --safe-chain-logging=verbose" + ); + + assert.ok( + result.output.includes("no malware found.") || result.output.includes("installed successfully"), + `Output did not include expected text. Output was:\n${result.output}` + ); + }); + + it(`safe-chain blocks installation of malicious Python packages via pipx`, async () => { + const shell = await container.openShell("zsh"); + + const result = await shell.runCommand( + "pipx install numpy==2.4.4" + ); + + assert.ok( + result.output.includes("blocked by safe-chain"), + `Expected malware to be blocked. Output was:\n${result.output}` + ); + assert.ok( + result.output.includes("Exiting without installing malicious packages."), + `Expected exit message. Output was:\n${result.output}` + ); + }); + + it(`pipx upgrade upgrades installed packages`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("pipx install ruff==0.1.0"); + + const result = await shell.runCommand( + "pipx upgrade ruff" + ); + + assert.ok( + result.output.includes("no malware found.") || result.output.includes("Upgraded") || result.output.includes("upgraded"), + `Output did not include expected text. Output was:\n${result.output}` + ); + }); + + it(`pipx run downloads and executes a safe tool`, async () => { + const shell = await container.openShell("zsh"); + + const result = await shell.runCommand( + "pipx run ruff --version" + ); + + assert.ok( + result.output.includes("no malware found.") || /ruff/i.test(result.output), + `Expected safe run to succeed. Output was:\n${result.output}` + ); + }); + + it(`pipx run blocks malicious tool download`, async () => { + const shell = await container.openShell("zsh"); + + const result = await shell.runCommand( + "pipx run numpy==2.4.4 --version" + ); + + assert.ok( + result.output.includes("blocked by safe-chain"), + `Expected malicious run to be blocked. Output was:\n${result.output}` + ); + assert.ok( + result.output.includes("Exiting without installing malicious packages."), + `Expected exit message. Output was:\n${result.output}` + ); + }); + + it(`pipx runpip installs safe dependency inside an app venv`, async () => { + const shell = await container.openShell("zsh"); + + // Prepare an app environment + await shell.runCommand("pipx install ruff"); + + const result = await shell.runCommand( + "pipx runpip ruff install requests==2.32.3" + ); + + assert.ok( + result.output.includes("no malware found.") || /Successfully installed/i.test(result.output) || /requests/i.test(result.output), + `Expected safe dependency install inside app venv. Output was:\n${result.output}` + ); + }); + + it(`pipx runpip blocks malicious dependency install`, async () => { + const shell = await container.openShell("zsh"); + + // Prepare an app environment + await shell.runCommand("pipx install ruff"); + + const result = await shell.runCommand( + "pipx runpip ruff install numpy==2.4.4" + ); + + assert.ok( + result.output.includes("blocked by safe-chain"), + `Expected malicious dependency to be blocked. Output was:\n${result.output}` + ); + assert.ok( + result.output.includes("Exiting without installing malicious packages."), + `Expected exit message. Output was:\n${result.output}` + ); + }); + + it(`pipx list shows installed packages`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("pipx install ruff"); + + const result = await shell.runCommand( + "pipx list" + ); + + assert.ok( + result.output.includes("ruff"), + `Expected ruff in list output. Output was:\n${result.output}` + ); + }); + + it(`pipx uninstall removes packages`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("pipx install ruff --safe-chain-logging=verbose"); + await shell.runCommand("pipx uninstall ruff --safe-chain-logging=verbose"); + + const result = await shell.runCommand( + "pipx list" + ); + + assert.ok( + !result.output.includes("ruff"), + `Expected ruff to be removed from list. Output was:\n${result.output}` + ); + }); + + it('pipx inject installs safe packages into existing venvs', async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("pipx install ruff --safe-chain-logging=verbose"); + const result = await shell.runCommand( + "pipx inject ruff requests==2.32.3 --safe-chain-logging=verbose" + ); + + assert.ok( + result.output.includes("no malware found.") || /Successfully installed/i.test(result.output) || /requests/i.test(result.output), + `Expected safe package to be injected. Output was:\n${result.output}` + ); + }); + + it('pipx inject blocks malicious packages from being installed into existing venvs', async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("pipx install ruff --safe-chain-logging=verbose"); + const result = await shell.runCommand( + "pipx inject ruff numpy==2.4.4 --safe-chain-logging=verbose" + ); + + assert.ok( + result.output.includes("blocked by safe-chain"), + `Expected malicious package to be blocked. Output was:\n${result.output}` + ); + assert.ok( + result.output.includes("Exiting without installing malicious packages."), + `Expected exit message. Output was:\n${result.output}` + ); + }); +}); diff --git a/test/e2e/pnpm-ci.e2e.spec.js b/test/e2e/pnpm-ci.e2e.spec.js index 6b92399..a56bb77 100644 --- a/test/e2e/pnpm-ci.e2e.spec.js +++ b/test/e2e/pnpm-ci.e2e.spec.js @@ -33,7 +33,9 @@ describe("E2E: pnpm coverage", () => { it(`safe-chain succesfully installs safe packages`, async () => { const shell = await container.openShell("zsh"); - const result = await shell.runCommand("pnpm add axios"); + const result = await shell.runCommand( + "pnpm add axios@1.13.0 --safe-chain-logging=verbose" + ); assert.ok( result.output.includes("no malware found."), diff --git a/test/e2e/pnpm.e2e.spec.js b/test/e2e/pnpm.e2e.spec.js index 944530c..6f9dacf 100644 --- a/test/e2e/pnpm.e2e.spec.js +++ b/test/e2e/pnpm.e2e.spec.js @@ -28,7 +28,9 @@ describe("E2E: pnpm coverage", () => { it(`safe-chain succesfully installs safe packages`, async () => { const shell = await container.openShell("zsh"); - const result = await shell.runCommand("pnpm add axios"); + const result = await shell.runCommand( + "pnpm add axios --safe-chain-logging=verbose" + ); assert.ok( result.output.includes("no malware found."), @@ -68,8 +70,9 @@ describe("E2E: pnpm coverage", () => { var result = await shell.runCommand("pnpm install"); - assert.ok( - result.output.includes("blocked 1 malicious package downloads"), + assert.match( + result.output, + /blocked [1-9]\d* malicious package downloads/, `Output did not include expected text. Output was:\n${result.output}` ); assert.ok( diff --git a/test/e2e/poetry.e2e.spec.js b/test/e2e/poetry.e2e.spec.js new file mode 100644 index 0000000..7d77d9c --- /dev/null +++ b/test/e2e/poetry.e2e.spec.js @@ -0,0 +1,425 @@ +import { describe, it, before, beforeEach, afterEach } from "node:test"; +import { DockerTestContainer } from "./DockerTestContainer.js"; +import assert from "node:assert"; + +describe("E2E: poetry coverage", () => { + let container; + + before(async () => { + DockerTestContainer.buildImage(); + }); + + beforeEach(async () => { + // Run a new Docker container for each test + container = new DockerTestContainer(); + await container.start(); + + const installationShell = await container.openShell("zsh"); + await installationShell.runCommand("safe-chain setup"); + + // Clear poetry cache + await installationShell.runCommand("command poetry cache clear pypi --all -n"); + }); + + afterEach(async () => { + // Stop and clean up the container after each test + if (container) { + await container.stop(); + container = null; + } + }); + + it(`successfully installs known safe packages with poetry add`, async () => { + const shell = await container.openShell("zsh"); + + // Initialize a new poetry project + await shell.runCommand("mkdir /tmp/test-poetry-project && cd /tmp/test-poetry-project"); + await shell.runCommand("cd /tmp/test-poetry-project && poetry init --no-interaction"); + + // Add a safe package + const result = await shell.runCommand( + "cd /tmp/test-poetry-project && poetry add requests" + ); + + assert.ok( + result.output.includes("no malware found.") || result.output.includes("Installing"), + `Output did not include expected text. Output was:\n${result.output}` + ); + }); + + it(`poetry add with specific version`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("mkdir /tmp/test-poetry-version && cd /tmp/test-poetry-version"); + await shell.runCommand("cd /tmp/test-poetry-version && poetry init --no-interaction"); + + const result = await shell.runCommand( + "cd /tmp/test-poetry-version && poetry add requests==2.32.3" + ); + + assert.ok( + result.output.includes("no malware found.") || result.output.includes("Installing"), + `Output did not include expected text. Output was:\n${result.output}` + ); + }); + + it(`safe-chain blocks installation of malicious Python packages via poetry`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("mkdir /tmp/test-poetry-malware && cd /tmp/test-poetry-malware"); + await shell.runCommand("cd /tmp/test-poetry-malware && poetry init --no-interaction"); + + const result = await shell.runCommand( + "cd /tmp/test-poetry-malware && poetry add numpy==2.4.4" + ); + + assert.ok( + result.output.includes("blocked by safe-chain"), + `Expected malware to be blocked. Output was:\n${result.output}` + ); + assert.ok( + result.output.includes("Exiting without installing malicious packages."), + `Expected exit message. Output was:\n${result.output}` + ); + }); + + it(`poetry install installs dependencies from pyproject.toml`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("mkdir /tmp/test-poetry-install && cd /tmp/test-poetry-install"); + await shell.runCommand("cd /tmp/test-poetry-install && poetry init --no-interaction"); + await shell.runCommand("cd /tmp/test-poetry-install && poetry add requests"); + + // Now remove the virtualenv and run install + await shell.runCommand("cd /tmp/test-poetry-install && rm -rf .venv"); + + const result = await shell.runCommand( + "cd /tmp/test-poetry-install && poetry install" + ); + + assert.ok( + result.output.includes("no malware found.") || result.output.includes("Installing"), + `Output did not include expected text. Output was:\n${result.output}` + ); + }); + + it(`poetry update updates dependencies`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("mkdir /tmp/test-poetry-update && cd /tmp/test-poetry-update"); + await shell.runCommand("cd /tmp/test-poetry-update && poetry init --no-interaction"); + await shell.runCommand("cd /tmp/test-poetry-update && poetry add requests"); + + const result = await shell.runCommand( + "cd /tmp/test-poetry-update && poetry update" + ); + + assert.ok( + result.output.includes("no malware found.") || result.output.includes("Updating"), + `Output did not include expected text. Output was:\n${result.output}` + ); + }); + + it(`poetry update with specific packages`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("mkdir /tmp/test-poetry-update-specific && cd /tmp/test-poetry-update-specific"); + await shell.runCommand("cd /tmp/test-poetry-update-specific && poetry init --no-interaction"); + await shell.runCommand("cd /tmp/test-poetry-update-specific && poetry add requests certifi"); + + const result = await shell.runCommand( + "cd /tmp/test-poetry-update-specific && poetry update requests" + ); + + assert.ok( + result.output.includes("no malware found.") || result.output.includes("Updating"), + `Output did not include expected text. Output was:\n${result.output}` + ); + }); + + it(`poetry sync synchronizes environment`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("mkdir /tmp/test-poetry-sync && cd /tmp/test-poetry-sync"); + await shell.runCommand("cd /tmp/test-poetry-sync && poetry init --no-interaction"); + await shell.runCommand("cd /tmp/test-poetry-sync && poetry add requests"); + + const result = await shell.runCommand( + "cd /tmp/test-poetry-sync && poetry sync" + ); + + assert.ok( + result.output.includes("no malware found.") || result.output.includes("Installing"), + `Output did not include expected text. Output was:\n${result.output}` + ); + }); + + it(`poetry add with multiple packages`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("mkdir /tmp/test-poetry-multi && cd /tmp/test-poetry-multi"); + await shell.runCommand("cd /tmp/test-poetry-multi && poetry init --no-interaction"); + + const result = await shell.runCommand( + "cd /tmp/test-poetry-multi && poetry add requests certifi" + ); + + assert.ok( + result.output.includes("no malware found.") || result.output.includes("Installing"), + `Output did not include expected text. Output was:\n${result.output}` + ); + }); + + it(`poetry add with extras`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("mkdir /tmp/test-poetry-extras && cd /tmp/test-poetry-extras"); + await shell.runCommand("cd /tmp/test-poetry-extras && poetry init --no-interaction"); + + // Use quotes to prevent shell expansion of square brackets + const result = await shell.runCommand( + 'cd /tmp/test-poetry-extras && poetry add "requests[security]"' + ); + + assert.ok( + result.output.includes("no malware found.") || result.output.includes("Installing"), + `Output did not include expected text. Output was:\n${result.output}` + ); + }); + + it(`poetry add with development group`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("mkdir /tmp/test-poetry-dev && cd /tmp/test-poetry-dev"); + await shell.runCommand("cd /tmp/test-poetry-dev && poetry init --no-interaction"); + + const result = await shell.runCommand( + "cd /tmp/test-poetry-dev && poetry add --group dev pytest" + ); + + assert.ok( + result.output.includes("no malware found.") || result.output.includes("Installing"), + `Output did not include expected text. Output was:\n${result.output}` + ); + }); + + it(`poetry install with extras`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("mkdir /tmp/test-poetry-install-extras && cd /tmp/test-poetry-install-extras"); + await shell.runCommand("cd /tmp/test-poetry-install-extras && poetry init --no-interaction"); + await shell.runCommand('cd /tmp/test-poetry-install-extras && poetry add requests'); + await shell.runCommand("cd /tmp/test-poetry-install-extras && rm -rf .venv"); + + const result = await shell.runCommand( + 'cd /tmp/test-poetry-install-extras && poetry install' + ); + + assert.ok( + result.output.includes("no malware found.") || result.output.includes("Installing"), + `Output did not include expected text. Output was:\n${result.output}` + ); + }); + + it(`poetry install with dependency groups`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("mkdir /tmp/test-poetry-install-groups && cd /tmp/test-poetry-install-groups"); + await shell.runCommand("cd /tmp/test-poetry-install-groups && poetry init --no-interaction"); + await shell.runCommand("cd /tmp/test-poetry-install-groups && poetry add requests"); + await shell.runCommand("cd /tmp/test-poetry-install-groups && rm -rf .venv"); + + const result = await shell.runCommand( + "cd /tmp/test-poetry-install-groups && poetry install" + ); + + assert.ok( + result.output.includes("no malware found.") || result.output.includes("Installing"), + `Output did not include expected text. Output was:\n${result.output}` + ); + }); + + it(`poetry lock creates/updates lock file`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("mkdir /tmp/test-poetry-lock && cd /tmp/test-poetry-lock"); + await shell.runCommand("cd /tmp/test-poetry-lock && poetry init --no-interaction"); + await shell.runCommand("cd /tmp/test-poetry-lock && poetry add requests"); + await shell.runCommand("cd /tmp/test-poetry-lock && rm poetry.lock"); + + const result = await shell.runCommand( + "cd /tmp/test-poetry-lock && poetry lock" + ); + + assert.ok( + result.output.includes("no malware found.") || result.output.includes("Resolving") || result.output.includes("lock file"), + `Output did not include expected text. Output was:\n${result.output}` + ); + }); + + it(`poetry add with version constraint using @`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("mkdir /tmp/test-poetry-constraint && cd /tmp/test-poetry-constraint"); + await shell.runCommand("cd /tmp/test-poetry-constraint && poetry init --no-interaction"); + + const result = await shell.runCommand( + "cd /tmp/test-poetry-constraint && poetry add requests@^2.32.0" + ); + + assert.ok( + result.output.includes("no malware found.") || result.output.includes("Installing"), + `Output did not include expected text. Output was:\n${result.output}` + ); + }); + + it(`poetry remove does not download packages`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("mkdir /tmp/test-poetry-remove && cd /tmp/test-poetry-remove"); + await shell.runCommand("cd /tmp/test-poetry-remove && poetry init --no-interaction"); + await shell.runCommand("cd /tmp/test-poetry-remove && poetry add requests"); + + const result = await shell.runCommand( + "cd /tmp/test-poetry-remove && poetry remove requests" + ); + + // Remove should succeed - it doesn't download packages, just modifies pyproject.toml + assert.ok( + !result.output.includes("blocked"), + `Remove command should not trigger downloads. Output was:\n${result.output}` + ); + }); + + it(`blocks malware during poetry install`, async () => { + const shell = await container.openShell("zsh"); + + // Create a project with malware in dependencies + await shell.runCommand("mkdir /tmp/test-poetry-install-malware && cd /tmp/test-poetry-install-malware"); + await shell.runCommand("cd /tmp/test-poetry-install-malware && poetry init --no-interaction"); + + // Add malware package - this will create lock file and attempt download + const result = await shell.runCommand( + "cd /tmp/test-poetry-install-malware && poetry add numpy==2.4.4 2>&1" + ); + + assert.ok( + result.output.includes("blocked by safe-chain"), + `Expected malware to be blocked during add (which triggers install). Output was:\n${result.output}` + ); + assert.ok( + result.output.includes("Exiting without installing malicious packages."), + `Expected exit message. Output was:\n${result.output}` + ); + }); + + it(`blocks malware when updating to add malicious dependency`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("mkdir /tmp/test-poetry-update-add && cd /tmp/test-poetry-update-add"); + await shell.runCommand("cd /tmp/test-poetry-update-add && poetry init --no-interaction"); + + // Start with a safe dependency + await shell.runCommand("cd /tmp/test-poetry-update-add && poetry add requests"); + + // Now try to add malware via add command + const result = await shell.runCommand( + "cd /tmp/test-poetry-update-add && poetry add numpy==2.4.4 2>&1" + ); + + assert.ok( + result.output.includes("blocked by safe-chain"), + `Expected malware to be blocked. Output was:\n${result.output}` + ); + assert.ok( + result.output.includes("Exiting without installing malicious packages."), + `Expected exit message. Output was:\n${result.output}` + ); + }); + + it(`blocks malware when installing from requirements with malicious package`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("mkdir /tmp/test-poetry-req-malware && cd /tmp/test-poetry-req-malware"); + await shell.runCommand("cd /tmp/test-poetry-req-malware && poetry init --no-interaction"); + + // Try to add malware directly - this is the primary vector + const result = await shell.runCommand( + "cd /tmp/test-poetry-req-malware && poetry add numpy==2.4.4 requests 2>&1" + ); + + assert.ok( + result.output.includes("blocked by safe-chain"), + `Expected malware to be blocked. Output was:\n${result.output}` + ); + assert.ok( + result.output.includes("Exiting without installing malicious packages."), + `Expected exit message. Output was:\n${result.output}` + ); + + // Verify safe package was also not installed due to malware in batch + const listResult = await shell.runCommand("cd /tmp/test-poetry-req-malware && poetry show"); + assert.ok( + !listResult.output.includes("requests"), + `Safe package should not be installed when batch includes malware. Output was:\n${listResult.output}` + ); + }); + + it(`poetry non-network commands work correctly`, async () => { + const shell = await container.openShell("zsh"); + + await shell.runCommand("mkdir /tmp/test-poetry-nonnetwork && cd /tmp/test-poetry-nonnetwork"); + await shell.runCommand("cd /tmp/test-poetry-nonnetwork && poetry init --no-interaction"); + await shell.runCommand("cd /tmp/test-poetry-nonnetwork && poetry add requests"); + + // Test poetry --version + const versionResult = await shell.runCommand("poetry --version"); + assert.ok( + versionResult.output.includes("Poetry") && versionResult.output.includes("version"), + `Expected version output. Output was:\n${versionResult.output}` + ); + + // Test poetry show (list installed packages) + const showResult = await shell.runCommand("cd /tmp/test-poetry-nonnetwork && poetry show"); + assert.ok( + showResult.output.includes("requests"), + `Expected to see installed package. Output was:\n${showResult.output}` + ); + + // Test poetry env info (show virtual environment info) + const envInfoResult = await shell.runCommand("cd /tmp/test-poetry-nonnetwork && poetry env info"); + assert.ok( + envInfoResult.output.includes("Virtualenv") || envInfoResult.output.includes("Path"), + `Expected environment info. Output was:\n${envInfoResult.output}` + ); + + // Test poetry check (validate pyproject.toml) + const checkResult = await shell.runCommand("cd /tmp/test-poetry-nonnetwork && poetry check"); + assert.ok( + checkResult.output.includes("valid") || checkResult.output.includes("All"), + `Expected validation success. Output was:\n${checkResult.output}` + ); + + // Test poetry config --list (show configuration) + const configResult = await shell.runCommand("poetry config --list"); + assert.ok( + configResult.output.length > 0, + `Expected configuration output. Output was:\n${configResult.output}` + ); + + // Test poetry run (execute command in virtualenv) - non-network command + const runResult = await shell.runCommand("cd /tmp/test-poetry-nonnetwork && poetry run python --version"); + assert.ok( + runResult.output.includes("Python"), + `Expected Python version output. Output was:\n${runResult.output}` + ); + + // Test poetry shell would start an interactive shell, so we skip that + // Test poetry env list (list virtual environments) + const envListResult = await shell.runCommand("cd /tmp/test-poetry-nonnetwork && poetry env list"); + assert.ok( + envListResult.output.includes("py3") || envListResult.output.includes("Activated"), + `Expected env list output. Output was:\n${envListResult.output}` + ); + }); +}); diff --git a/test/e2e/rush.e2e.spec.js b/test/e2e/rush.e2e.spec.js new file mode 100644 index 0000000..fb6895f --- /dev/null +++ b/test/e2e/rush.e2e.spec.js @@ -0,0 +1,148 @@ +import { describe, it, before, beforeEach, afterEach } from "node:test"; +import { DockerTestContainer } from "./DockerTestContainer.js"; +import { + buildRushConfig, + resolveRushVersions, + writeTextFile, +} from "./utils/rushtestutils.mjs"; +import assert from "node:assert"; + +// These tests cover safe-chain's Rush wrapper: pre-scanning `rush add` and +// blocking malicious packages downloaded during `rush update` via the MITM +// proxy. They use a single Rush-internal package manager (pnpm) — see +// `utils/rushtestutils.mjs` for why this suite isn't parameterised over the +// CI matrix's NPM_VERSION/PNPM_VERSION/YARN_VERSION values. + +describe("E2E: rush coverage", () => { + let container; + /** @type {{ rushVersion: string, pnpmVersion: string } | undefined} */ + let resolvedVersions; + + before(async () => { + DockerTestContainer.buildImage(); + }); + + beforeEach(async () => { + container = new DockerTestContainer(); + await container.start(); + + const installationShell = await container.openShell("zsh"); + await installationShell.runCommand("safe-chain setup"); + + if (!resolvedVersions) { + resolvedVersions = await resolveRushVersions(installationShell); + } + + await setupRushWorkspace(installationShell, { resolvedVersions }); + }); + + afterEach(async () => { + if (container) { + await container.stop(); + container = null; + } + }); + + it("safe-chain successfully adds safe packages", async () => { + const shell = await container.openShell("zsh"); + const result = await shell.runCommand( + "cd /testapp/apps/test-app && rush add --package axios@1.13.0 --exact --skip-update --safe-chain-logging=verbose" + ); + + assert.ok( + result.output.includes("no malware found."), + `Output did not include expected text. Output was:\n${result.output}` + ); + }); + + it("safe-chain blocks rush add of malicious packages", async () => { + const shell = await container.openShell("zsh"); + const result = await shell.runCommand( + "cd /testapp/apps/test-app && rush add --package safe-chain-test --skip-update" + ); + + assert.ok( + result.output.includes("Malicious changes detected:"), + `Output did not include expected text. Output was:\n${result.output}` + ); + assert.ok( + result.output.includes("- safe-chain-test"), + `Output did not include expected text. Output was:\n${result.output}` + ); + assert.ok( + result.output.includes("Exiting without installing malicious packages."), + `Output did not include expected text. Output was:\n${result.output}` + ); + + const packageJson = await shell.runCommand( + "cat /testapp/apps/test-app/package.json" + ); + + assert.ok( + !packageJson.output.includes("safe-chain-test"), + `Malicious package was added despite safe-chain protection. Output was:\n${packageJson.output}` + ); + }); + + it("safe-chain proxy blocks malicious package downloads during rush update", async () => { + const shell = await container.openShell("zsh"); + await setupRushWorkspace(shell, { + resolvedVersions, + packageJson: `{ + "name": "test-app", + "version": "1.0.0", + "dependencies": { + "safe-chain-test": "0.0.1-security" + } +}`, + }); + + // `--safe-chain-skip-minimum-package-age` is needed because Rush's + // internal pnpm bootstrap (`npm install pnpm@`) goes + // through the safe-chain proxy. When the CI matrix selects pnpm + // `latest`, the just-released version can be below the minimum age + // threshold and Rush's install would otherwise be blocked before our + // malicious-download assertion is reached. + const result = await shell.runCommand( + "cd /testapp/apps/test-app && rush update --safe-chain-skip-minimum-package-age" + ); + + assert.match( + result.output, + /blocked [1-9]\d* malicious package downloads/, + `Output did not include expected text. Output was:\n${result.output}` + ); + assert.ok( + result.output.includes("- safe-chain-test"), + `Output did not include expected text. Output was:\n${result.output}` + ); + assert.ok( + result.output.includes("Exiting without installing malicious packages."), + `Output did not include expected text. Output was:\n${result.output}` + ); + }); +}); + +async function setupRushWorkspace(shell, { resolvedVersions, packageJson }) { + const rushConfig = buildRushConfig({ + rushVersion: resolvedVersions.rushVersion, + pnpmVersion: resolvedVersions.pnpmVersion, + }); + + await shell.runCommand("rm -rf /testapp/common /testapp/apps/test-app"); + await shell.runCommand("mkdir -p /testapp/apps/test-app"); + await writeTextFile( + shell, + "/testapp/rush.json", + JSON.stringify(rushConfig, null, 2) + ); + await writeTextFile( + shell, + "/testapp/apps/test-app/package.json", + packageJson ?? + `{ + "name": "test-app", + "version": "1.0.0" +}` + ); +} diff --git a/test/e2e/rushx.e2e.spec.js b/test/e2e/rushx.e2e.spec.js new file mode 100644 index 0000000..ec5ff75 --- /dev/null +++ b/test/e2e/rushx.e2e.spec.js @@ -0,0 +1,100 @@ +import { describe, it, before, beforeEach, afterEach } from "node:test"; +import { DockerTestContainer } from "./DockerTestContainer.js"; +import { + buildRushConfig, + resolveRushVersions, + writeTextFile, +} from "./utils/rushtestutils.mjs"; +import assert from "node:assert"; + +describe("E2E: rushx coverage", () => { + let container; + /** @type {{ rushVersion: string, pnpmVersion: string } | undefined} */ + let resolvedVersions; + + before(async () => { + DockerTestContainer.buildImage(); + }); + + beforeEach(async () => { + container = new DockerTestContainer(); + await container.start(); + + const installationShell = await container.openShell("zsh"); + await installationShell.runCommand("safe-chain setup"); + + if (!resolvedVersions) { + resolvedVersions = await resolveRushVersions(installationShell); + } + + await setupRushWorkspace(installationShell, { resolvedVersions }); + }); + + afterEach(async () => { + if (container) { + await container.stop(); + container = null; + } + }); + + it("safe-chain successfully scans safe package downloads from rushx scripts", async () => { + const shell = await container.openShell("zsh"); + const result = await shell.runCommand( + "cd /testapp/apps/test-app && rushx install-safe --safe-chain-logging=verbose" + ); + + assert.ok( + result.output.includes("no malware found."), + `Output did not include expected text. Output was:\n${result.output}` + ); + }); + + it("safe-chain blocks malicious package downloads from rushx scripts", async () => { + const shell = await container.openShell("zsh"); + const result = await shell.runCommand( + "cd /testapp/apps/test-app && rushx install-malicious" + ); + + assert.match( + result.output, + /blocked [1-9]\d* malicious package downloads/, + `Output did not include expected text. Output was:\n${result.output}` + ); + assert.ok( + result.output.includes("- safe-chain-test"), + `Output did not include expected text. Output was:\n${result.output}` + ); + assert.ok( + result.output.includes("Exiting without installing malicious packages."), + `Output did not include expected text. Output was:\n${result.output}` + ); + }); +}); + +async function setupRushWorkspace(shell, { resolvedVersions }) { + const rushConfig = buildRushConfig({ + rushVersion: resolvedVersions.rushVersion, + pnpmVersion: resolvedVersions.pnpmVersion, + }); + + await shell.runCommand( + "mkdir -p /testapp/common/config/rush /testapp/apps/test-app" + ); + await writeTextFile( + shell, + "/testapp/rush.json", + JSON.stringify(rushConfig, null, 2) + ); + await writeTextFile( + shell, + "/testapp/apps/test-app/package.json", + `{ + "name": "test-app", + "version": "1.0.0", + "scripts": { + "install-safe": "npm install axios@1.13.0", + "install-malicious": "npm install safe-chain-test@0.0.1-security" + } +}` + ); +} diff --git a/test/e2e/safe-chain-cli-python.e2e.spec.js b/test/e2e/safe-chain-cli-python.e2e.spec.js new file mode 100644 index 0000000..43187d8 --- /dev/null +++ b/test/e2e/safe-chain-cli-python.e2e.spec.js @@ -0,0 +1,109 @@ +import { describe, it, before, beforeEach, afterEach } from "node:test"; +import { DockerTestContainer } from "./DockerTestContainer.js"; +import assert from "node:assert"; + +describe("E2E: safe-chain CLI python/pip support", () => { + let container; + + before(async () => { + DockerTestContainer.buildImage(); + }); + + beforeEach(async () => { + container = new DockerTestContainer(); + await container.start(); + // Note: We do NOT run 'safe-chain setup' here. + // We want to test the 'safe-chain' CLI command directly. + + // Clear pip cache + const shell = await container.openShell("zsh"); + await shell.runCommand("pip3 cache purge"); + }); + + afterEach(async () => { + if (container) { + await container.stop(); + container = null; + } + }); + + it("safe-chain pip3 install routes through proxy", async () => { + const shell = await container.openShell("zsh"); + // Invoke safe-chain directly with pip3 command + const result = await shell.runCommand( + "safe-chain pip3 install --break-system-packages requests --safe-chain-logging=verbose" + ); + + assert.ok( + result.output.includes("no malware found."), + `Output did not include expected text. Output was:\n${result.output}` + ); + assert.ok( + result.output.includes("Successfully installed") || + result.output.includes("Requirement already satisfied"), + `Installation failed. Output was:\n${result.output}` + ); + }); + + it("safe-chain python3 -m pip install routes through proxy", async () => { + const shell = await container.openShell("zsh"); + const result = await shell.runCommand( + "safe-chain python3 -m pip install --break-system-packages requests --safe-chain-logging=verbose" + ); + + assert.ok( + result.output.includes("no malware found."), + `Output did not include expected text. Output was:\n${result.output}` + ); + }); + + it("safe-chain python3 script.py bypasses proxy", async () => { + const shell = await container.openShell("zsh"); + + // Create a simple script + await shell.runCommand("echo \"print('direct execution')\" > /tmp/test.py"); + + const result = await shell.runCommand("safe-chain python3 /tmp/test.py"); + + // Should execute the script + assert.ok( + result.output.includes("direct execution"), + `Script execution failed. Output was:\n${result.output}` + ); + + // Should NOT show safe-chain logs + assert.ok( + !result.output.includes("Safe-chain"), + `Should have bypassed safe-chain. Output was:\n${result.output}` + ); + }); + + it("safe-chain python3 --version bypasses proxy", async () => { + const shell = await container.openShell("zsh"); + const result = await shell.runCommand("safe-chain python3 --version"); + + assert.ok( + result.output.match(/Python 3\.\d+\.\d+/), + `Should show python version. Output was:\n${result.output}` + ); + assert.ok( + !result.output.includes("Safe-chain"), + `Should have bypassed safe-chain. Output was:\n${result.output}` + ); + }); + + it("safe-chain blocks malicious package via pip3", async () => { + const shell = await container.openShell("zsh"); + await shell.runCommand("pip3 cache purge"); + + const result = await shell.runCommand( + "safe-chain pip3 install --break-system-packages numpy==2.4.4" + ); + + assert.match( + result.output, + /blocked [1-9]\d* malicious package downloads/, + `Should have blocked malware. Output was:\n${result.output}` + ); + }); +}); diff --git a/test/e2e/setup-ci.e2e.spec.js b/test/e2e/setup-ci.e2e.spec.js index f22f884..7237b1a 100644 --- a/test/e2e/setup-ci.e2e.spec.js +++ b/test/e2e/setup-ci.e2e.spec.js @@ -39,7 +39,9 @@ describe("E2E: safe-chain setup-ci command", () => { ); const projectShell = await container.openShell(shell); - const result = await projectShell.runCommand("npm i axios"); + const result = await projectShell.runCommand( + "npm i axios@1.13.0 --safe-chain-logging=verbose" + ); const hasExpectedOutput = result.output.includes("Safe-chain: Scanned"); assert.ok( diff --git a/test/e2e/setup.teardown.e2e.spec.js b/test/e2e/setup.teardown.e2e.spec.js index b5c58bb..0ddfaf4 100644 --- a/test/e2e/setup.teardown.e2e.spec.js +++ b/test/e2e/setup.teardown.e2e.spec.js @@ -29,7 +29,9 @@ describe("E2E: safe-chain setup command", () => { const projectShell = await container.openShell(shell); await projectShell.runCommand("cd /testapp"); - const result = await projectShell.runCommand("npm i axios"); + const result = await projectShell.runCommand( + "npm i axios@1.13.0 --safe-chain-logging=verbose" + ); const hasExpectedOutput = result.output.includes("Safe-chain: Scanned"); assert.ok( @@ -48,8 +50,8 @@ describe("E2E: safe-chain setup command", () => { const projectShell = await container.openShell(shell); await projectShell.runCommand("cd /testapp"); - await projectShell.runCommand("npm i axios"); - const result = await projectShell.runCommand("npm i axios"); + await projectShell.runCommand("npm i axios@1.13.0"); + const result = await projectShell.runCommand("npm i axios@1.13.0"); assert.ok( !result.output.includes("Scanning for malicious packages..."), diff --git a/test/e2e/teardown-dirs.e2e.spec.js b/test/e2e/teardown-dirs.e2e.spec.js new file mode 100644 index 0000000..853c503 --- /dev/null +++ b/test/e2e/teardown-dirs.e2e.spec.js @@ -0,0 +1,96 @@ +import { describe, it, before, beforeEach, afterEach } from "node:test"; +import { DockerTestContainer } from "./DockerTestContainer.js"; +import assert from "node:assert"; + +describe("E2E: safe-chain teardown command", () => { + let container; + + before(async () => { + DockerTestContainer.buildImage(); + }); + + beforeEach(async () => { + container = new DockerTestContainer(); + await container.start(); + }); + + afterEach(async () => { + if (container) { + await container.stop(); + container = null; + } + }); + + it("safe-chain teardown removes shims directory created by setup-ci", async () => { + const shell = await container.openShell("bash"); + + // Run setup-ci + await shell.runCommand("safe-chain setup-ci"); + + // Verify shims directory exists + const checkShimsExist = await shell.runCommand("test -d ~/.safe-chain/shims && echo 'exists' || echo 'missing'"); + assert.ok(checkShimsExist.output.includes("exists"), "Shims directory should exist after setup-ci"); + + // Run teardown + await shell.runCommand("safe-chain teardown"); + + // Verify shims directory is gone + const checkShimsGone = await shell.runCommand("test -d ~/.safe-chain/shims && echo 'exists' || echo 'missing'"); + assert.ok(checkShimsGone.output.includes("missing"), "Shims directory should be removed after teardown"); + }); + + it("safe-chain teardown removes scripts directory created by setup", async () => { + const shell = await container.openShell("bash"); + + // Run setup + await shell.runCommand("safe-chain setup"); + + // Verify scripts directory exists + const checkScriptsExist = await shell.runCommand("test -d ~/.safe-chain/scripts && echo 'exists' || echo 'missing'"); + assert.ok(checkScriptsExist.output.includes("exists"), "Scripts directory should exist after setup"); + + // Run teardown + await shell.runCommand("safe-chain teardown"); + + // Verify scripts directory is gone + const checkScriptsGone = await shell.runCommand("test -d ~/.safe-chain/scripts && echo 'exists' || echo 'missing'"); + assert.ok(checkScriptsGone.output.includes("missing"), "Scripts directory should be removed after teardown"); + }); + + it("safe-chain teardown removes shims directory created by setup-ci", async () => { + const shell = await container.openShell("bash"); + + // Run setup-ci + await shell.runCommand("safe-chain setup-ci"); + // Verify shims directory exists + const checkShimsExist = await shell.runCommand("test -d ~/.safe-chain/shims && echo 'exists' || echo 'missing'"); + assert.ok(checkShimsExist.output.includes("exists"), "Shims directory should exist after setup-ci"); + + // Verify Python shims were created + const checkPythonShims = await shell.runCommand("test -f ~/.safe-chain/shims/pip && echo 'exists' || echo 'missing'"); + assert.ok(checkPythonShims.output.includes("exists"), "Python shims should exist after setup-ci"); + // Run teardown + await shell.runCommand("safe-chain teardown"); + + // Verify shims directory is gone + const checkShimsGone = await shell.runCommand("test -d ~/.safe-chain/shims && echo 'exists' || echo 'missing'"); + assert.ok(checkShimsGone.output.includes("missing"), "Shims directory should be removed after teardown"); + }); + + it("safe-chain teardown removes scripts directory created by setup", async () => { + const shell = await container.openShell("bash"); + + // Run setup + await shell.runCommand("safe-chain setup"); + // Verify scripts directory exists + const checkScriptsExist = await shell.runCommand("test -d ~/.safe-chain/scripts && echo 'exists' || echo 'missing'"); + assert.ok(checkScriptsExist.output.includes("exists"), "Scripts directory should exist after setup"); + + // Run teardown + await shell.runCommand("safe-chain teardown"); + + // Verify scripts directory is gone + const checkScriptsGone = await shell.runCommand("test -d ~/.safe-chain/scripts && echo 'exists' || echo 'missing'"); + assert.ok(checkScriptsGone.output.includes("missing"), "Scripts directory should be removed after teardown"); + }); +}); diff --git a/test/e2e/utils/malwarelistmirror.mjs b/test/e2e/utils/malwarelistmirror.mjs new file mode 100644 index 0000000..e8091b0 --- /dev/null +++ b/test/e2e/utils/malwarelistmirror.mjs @@ -0,0 +1,79 @@ +// Test-only mirror of the malware list. Injects known-safe packages as malicious +// to simulate blocking behavior in e2e tests without affecting real data. + +import * as http from "node:http"; + +const lists = await downloadLists(); +const server = http.createServer(handleRequest); +server.listen(5555, "127.0.0.1"); +console.log("listening on http://127.0.0.1:5555"); + +function handleRequest(req, res) { + if (req.method !== "GET" || !req.url) { + res.writeHead(404); + res.end(); + return; + } + + if (req.url.startsWith("/ready")) { + res.writeHead(200); + res.end(); + return; + } + + for (const list of lists) { + if (req.url.startsWith(list.path)) { + res.writeHead(200, { "Content-Type": "application/json" }); + res.end(JSON.stringify(list.data)); + return; + } + } + + res.writeHead(404); + res.end(); +} + +async function downloadLists() { + const lists = [ + { + "path": "/malware_predictions.json", + "patchFunc": (data) => data, + }, + { + "path": "/malware_pypi.json", + "patchFunc": patchPypi, + }, + { + "path": "/releases/npm.json", + "patchFunc": (data) => data, + }, + { + "path": "/releases/pypi.json", + "patchFunc": (data) => data, + }, + ] + + for (const list of lists) { + list.data = list.patchFunc(await downloadList(list.path)); + } + + return lists; +} + +async function downloadList(path) { + const baseUrl = "https://malware-list.aikido.dev"; + const url = `${baseUrl}${path}`; + const response = await fetch(url); + return await response.json(); +} + +function patchPypi(data) { + + data.push({ + "package_name": "numpy", + "version": "2.4.4", + "reason": "MALWARE" + }); + + return data; +} diff --git a/test/e2e/utils/rushtestutils.mjs b/test/e2e/utils/rushtestutils.mjs new file mode 100644 index 0000000..285c50e --- /dev/null +++ b/test/e2e/utils/rushtestutils.mjs @@ -0,0 +1,69 @@ +// Helpers for the Rush E2E suites. +// +// What these suites actually test: that safe-chain's shim intercepts `rush` +// and `rushx` invocations correctly. The contents of `rush.json` are just +// fixture noise needed to make Rush run at all — Rush's schema requires +// exact semver for `rushVersion`/`pnpmVersion` and refuses dist-tags like +// "latest", so we read both back from the binaries baked into the image. +// +// * `rushVersion` ← `rush --version` (image installs +// `@microsoft/rush@${RUSH_VERSION:-latest}`). +// * `pnpmVersion` ← `pnpm --version` (image installs +// `pnpm@${PNPM_VERSION:-latest}`). Rush downloads its own copy of this +// into `~/.rush/...`; using the same exact version as the system pnpm +// just keeps the fixture in lockstep with whatever the CI matrix picks. + +/** Resolves the versions to put into `rush.json`. */ +export async function resolveRushVersions(shell) { + // Sequential: the helper drives a single PTY shell. + const rushVersion = await getInstalledVersion(shell, "rush"); + const pnpmVersion = await getInstalledVersion(shell, "pnpm"); + return { rushVersion, pnpmVersion }; +} + +/** Builds the standard `rush.json` body for the e2e fixtures. */ +export function buildRushConfig({ rushVersion, pnpmVersion, projects }) { + return { + $schema: + "https://developer.microsoft.com/json-schemas/rush/v5/rush.schema.json", + rushVersion, + pnpmVersion, + nodeSupportedVersionRange: ">=18.0.0", + projectFolderMinDepth: 1, + projectFolderMaxDepth: 2, + gitPolicy: {}, + repository: { + url: "https://example.com/testapp.git", + defaultBranch: "main", + }, + eventHooks: { + preRushInstall: [], + postRushInstall: [], + preRushBuild: [], + postRushBuild: [], + }, + projects: projects ?? [ + { packageName: "test-app", projectFolder: "apps/test-app" }, + ], + }; +} + +/** + * Writes a UTF-8 text file inside the container, base64-encoding the payload + * to avoid shell escaping issues for arbitrary content. + */ +export async function writeTextFile(shell, filePath, content) { + const encoded = Buffer.from(content).toString("base64"); + await shell.runCommand(`printf '%s' '${encoded}' | base64 -d > ${filePath}`); +} + +async function getInstalledVersion(shell, command) { + const { output } = await shell.runCommand(`${command} --version`); + const match = output.match(/\b(\d+\.\d+\.\d+)\b/); + if (!match) { + throw new Error( + `Could not determine installed ${command} version. Output was:\n${output}` + ); + } + return match[1]; +} diff --git a/test/e2e/uv.e2e.spec.js b/test/e2e/uv.e2e.spec.js index eae7c12..728d4c5 100644 --- a/test/e2e/uv.e2e.spec.js +++ b/test/e2e/uv.e2e.spec.js @@ -15,7 +15,10 @@ describe("E2E: uv coverage", () => { await container.start(); const installationShell = await container.openShell("zsh"); - await installationShell.runCommand("safe-chain setup --include-python"); + await installationShell.runCommand("safe-chain setup"); + + // Clear uv cache + await installationShell.runCommand("uv cache clean"); }); afterEach(async () => { @@ -29,7 +32,7 @@ describe("E2E: uv coverage", () => { it(`successfully installs known safe packages with uv pip install`, async () => { const shell = await container.openShell("zsh"); const result = await shell.runCommand( - "uv pip install --system --break-system-packages requests" + "uv pip install --system --break-system-packages requests --safe-chain-logging=verbose" ); assert.ok( @@ -41,7 +44,7 @@ describe("E2E: uv coverage", () => { it(`uv pip install with specific version`, async () => { const shell = await container.openShell("zsh"); const result = await shell.runCommand( - "uv pip install --system --break-system-packages requests==2.32.3" + "uv pip install --system --break-system-packages requests==2.32.3 --safe-chain-logging=verbose" ); assert.ok( @@ -53,7 +56,7 @@ describe("E2E: uv coverage", () => { it(`uv pip install with version specifiers (>=)`, async () => { const shell = await container.openShell("zsh"); const result = await shell.runCommand( - 'uv pip install --system --break-system-packages "Jinja2>=3.1"' + 'uv pip install --system --break-system-packages "Jinja2>=3.1" --safe-chain-logging=verbose' ); assert.ok( @@ -65,7 +68,7 @@ describe("E2E: uv coverage", () => { it(`uv pip install with extras such as requests[socks]`, async () => { const shell = await container.openShell("zsh"); const result = await shell.runCommand( - 'uv pip install --system --break-system-packages "requests[socks]==2.32.3"' + 'uv pip install --system --break-system-packages "requests[socks]==2.32.3" --safe-chain-logging=verbose' ); assert.ok( @@ -77,7 +80,7 @@ describe("E2E: uv coverage", () => { it(`uv pip install multiple packages`, async () => { const shell = await container.openShell("zsh"); const result = await shell.runCommand( - "uv pip install --system --break-system-packages requests certifi urllib3" + "uv pip install --system --break-system-packages requests certifi urllib3 --safe-chain-logging=verbose" ); assert.ok( @@ -88,13 +91,13 @@ describe("E2E: uv coverage", () => { it(`uv pip install from requirements file`, async () => { const shell = await container.openShell("zsh"); - + // Create a requirements.txt file await shell.runCommand("echo 'requests==2.32.3' > requirements.txt"); await shell.runCommand("echo 'certifi>=2024.0.0' >> requirements.txt"); - + const result = await shell.runCommand( - "uv pip install --system --break-system-packages -r requirements.txt" + "uv pip install --system --break-system-packages -r requirements.txt --safe-chain-logging=verbose" ); assert.ok( @@ -105,12 +108,12 @@ describe("E2E: uv coverage", () => { it(`uv pip sync with requirements file`, async () => { const shell = await container.openShell("zsh"); - + // Create a requirements.txt file await shell.runCommand("echo 'requests==2.32.3' > requirements-sync.txt"); - + const result = await shell.runCommand( - "uv pip sync --system --break-system-packages requirements-sync.txt" + "uv pip sync --system --break-system-packages requirements-sync.txt --safe-chain-logging=verbose" ); assert.ok( @@ -121,17 +124,18 @@ describe("E2E: uv coverage", () => { it(`safe-chain blocks installation of malicious Python packages via uv`, async () => { const shell = await container.openShell("zsh"); - + const result = await shell.runCommand( - "uv pip install --system --break-system-packages safe-chain-pi-test" + "uv pip install --system --break-system-packages numpy==2.4.4" ); - assert.ok( - result.output.includes("blocked 1 malicious package downloads:"), + assert.match( + result.output, + /blocked [1-9]\d* malicious package downloads:/, `Output did not include expected text. Output was:\n${result.output}` ); assert.ok( - result.output.includes("safe_chain_pi_test@0.0.1"), + result.output.includes("numpy@2.4.4"), `Output did not include expected text. Output was:\n${result.output}` ); assert.ok( @@ -141,7 +145,7 @@ describe("E2E: uv coverage", () => { const listResult = await shell.runCommand("uv pip list --system"); assert.ok( - !listResult.output.includes("safe-chain-pi-test"), + !listResult.output.includes("numpy"), `Malicious package was installed despite safe-chain protection. Output of 'uv pip list' was:\n${listResult.output}` ); }); @@ -149,7 +153,7 @@ describe("E2E: uv coverage", () => { it(`uv pip install from GitHub URL using the CA bundle`, async () => { const shell = await container.openShell("zsh"); const result = await shell.runCommand( - "uv pip install --system --break-system-packages git+https://github.com/psf/requests.git@v2.32.3" + "uv pip install --system --break-system-packages git+https://github.com/psf/requests.git@v2.32.3 --safe-chain-logging=verbose" ); assert.ok( @@ -167,9 +171,9 @@ describe("E2E: uv coverage", () => { it(`uv pip successfully validates certificates for HTTPS downloads`, async () => { const shell = await container.openShell("zsh"); - + const result = await shell.runCommand( - "uv pip install --system --break-system-packages certifi" + "uv pip install --system --break-system-packages certifi --safe-chain-logging=verbose" ); assert.ok( @@ -196,7 +200,7 @@ describe("E2E: uv coverage", () => { it(`uv pip install from direct HTTPS wheel URL`, async () => { const shell = await container.openShell("zsh"); const result = await shell.runCommand( - "uv pip install --system --break-system-packages https://files.pythonhosted.org/packages/70/8e/0e2d847013cb52cd35b38c009bb167a1a26b2ce6cd6965bf26b47bc0bf44/requests-2.31.0-py3-none-any.whl" + "uv pip install --system --break-system-packages https://files.pythonhosted.org/packages/70/8e/0e2d847013cb52cd35b38c009bb167a1a26b2ce6cd6965bf26b47bc0bf44/requests-2.31.0-py3-none-any.whl --safe-chain-logging=verbose" ); assert.ok( @@ -213,13 +217,15 @@ describe("E2E: uv coverage", () => { it(`uv pip install with --upgrade flag`, async () => { const shell = await container.openShell("zsh"); - + // First install a package - await shell.runCommand("uv pip install --system --break-system-packages requests==2.31.0"); - + await shell.runCommand( + "uv pip install --system --break-system-packages requests==2.31.0" + ); + // Then upgrade it const result = await shell.runCommand( - "uv pip install --system --break-system-packages --upgrade requests" + "uv pip install --system --break-system-packages --upgrade requests --safe-chain-logging=verbose" ); assert.ok( @@ -231,7 +237,7 @@ describe("E2E: uv coverage", () => { it(`uv pip install with --no-deps flag`, async () => { const shell = await container.openShell("zsh"); const result = await shell.runCommand( - "uv pip install --system --break-system-packages --no-deps requests" + "uv pip install --system --break-system-packages --no-deps requests --safe-chain-logging=verbose" ); assert.ok( @@ -242,14 +248,18 @@ describe("E2E: uv coverage", () => { it(`uv pip install with --editable flag from local directory`, async () => { const shell = await container.openShell("zsh"); - + // Create a simple package structure await shell.runCommand("mkdir -p /tmp/test-pkg"); - await shell.runCommand("echo 'from setuptools import setup' > /tmp/test-pkg/setup.py"); - await shell.runCommand("echo \"setup(name='test-pkg', version='0.1.0')\" >> /tmp/test-pkg/setup.py"); - + await shell.runCommand( + "echo 'from setuptools import setup' > /tmp/test-pkg/setup.py" + ); + await shell.runCommand( + "echo \"setup(name='test-pkg', version='0.1.0')\" >> /tmp/test-pkg/setup.py" + ); + const result = await shell.runCommand( - "uv pip install --system --break-system-packages -e /tmp/test-pkg" + "uv pip install --system --break-system-packages -e /tmp/test-pkg --safe-chain-logging=verbose" ); assert.ok( @@ -260,13 +270,11 @@ describe("E2E: uv coverage", () => { it(`uv pip compile creates locked requirements`, async () => { const shell = await container.openShell("zsh"); - + // Create an input requirements file await shell.runCommand("echo 'requests' > requirements.in"); - - const result = await shell.runCommand( - "uv pip compile requirements.in" - ); + + const result = await shell.runCommand("uv pip compile requirements.in"); // uv pip compile doesn't install packages, just resolves dependencies // It should complete successfully and output resolved requirements @@ -279,7 +287,7 @@ describe("E2E: uv coverage", () => { it(`uv pip install with --index-url for alternate registry`, async () => { const shell = await container.openShell("zsh"); const result = await shell.runCommand( - "uv pip install --system --break-system-packages --index-url https://test.pypi.org/simple certifi" + "uv pip install --system --break-system-packages --index-url https://test.pypi.org/simple certifi --safe-chain-logging=verbose" ); assert.ok( @@ -300,7 +308,7 @@ describe("E2E: uv coverage", () => { const result = await shell.runCommand( "uv pip install --system --break-system-packages requests --safe-chain-logging=verbose" ); - + assert.ok( result.output.includes("no malware found."), `Output did not include expected text. Output was:\n${result.output}` @@ -310,7 +318,7 @@ describe("E2E: uv coverage", () => { it(`uv pip install with version range constraint`, async () => { const shell = await container.openShell("zsh"); const result = await shell.runCommand( - 'uv pip install --system --break-system-packages "requests>=2.31.0,<2.33.0"' + 'uv pip install --system --break-system-packages "requests>=2.31.0,<2.33.0" --safe-chain-logging=verbose' ); assert.ok( @@ -321,10 +329,12 @@ describe("E2E: uv coverage", () => { it(`uv pip list shows installed packages`, async () => { const shell = await container.openShell("zsh"); - + // Install a package first - await shell.runCommand("uv pip install --system --break-system-packages requests"); - + await shell.runCommand( + "uv pip install --system --break-system-packages requests" + ); + // Then list packages - this shouldn't trigger safe-chain scanning const result = await shell.runCommand("uv pip list --system"); @@ -337,10 +347,10 @@ describe("E2E: uv coverage", () => { it(`uv add installs package and updates project`, async () => { const shell = await container.openShell("zsh"); - + // Initialize a new uv project and add package in same command const result = await shell.runCommand( - "uv init test-project && cd test-project && uv add requests" + "uv init test-project && cd test-project && uv add requests --safe-chain-logging=verbose" ); assert.ok( @@ -351,12 +361,12 @@ describe("E2E: uv coverage", () => { it(`uv add with specific version`, async () => { const shell = await container.openShell("zsh"); - + // Initialize a new uv project await shell.runCommand("uv init test-project-version"); - + const result = await shell.runCommand( - "cd test-project-version && uv add requests==2.32.3" + "cd test-project-version && uv add requests==2.32.3 --safe-chain-logging=verbose" ); assert.ok( @@ -367,12 +377,12 @@ describe("E2E: uv coverage", () => { it(`uv add --dev for development dependencies`, async () => { const shell = await container.openShell("zsh"); - + // Initialize a new uv project await shell.runCommand("uv init test-project-dev"); - + const result = await shell.runCommand( - "cd test-project-dev && uv add --dev pytest" + "cd test-project-dev && uv add --dev pytest --safe-chain-logging=verbose" ); assert.ok( @@ -383,12 +393,12 @@ describe("E2E: uv coverage", () => { it(`uv add multiple packages at once`, async () => { const shell = await container.openShell("zsh"); - + // Initialize a new uv project await shell.runCommand("uv init test-project-multi"); - + const result = await shell.runCommand( - "cd test-project-multi && uv add requests certifi urllib3" + "cd test-project-multi && uv add requests certifi urllib3 --safe-chain-logging=verbose" ); assert.ok( @@ -399,20 +409,21 @@ describe("E2E: uv coverage", () => { it(`safe-chain blocks malicious packages via uv add`, async () => { const shell = await container.openShell("zsh"); - + // Initialize a new uv project await shell.runCommand("uv init test-project-malware"); - + const result = await shell.runCommand( - "cd test-project-malware && uv add safe-chain-pi-test" + "cd test-project-malware && uv add numpy==2.4.4" ); - assert.ok( - result.output.includes("blocked 1 malicious package downloads:"), + assert.match( + result.output, + /blocked [1-9]\d* malicious package downloads:/, `Output did not include expected text. Output was:\n${result.output}` ); assert.ok( - result.output.includes("safe_chain_pi_test@0.0.1"), + result.output.includes("numpy@2.4.4"), `Output did not include expected text. Output was:\n${result.output}` ); assert.ok( @@ -424,39 +435,41 @@ describe("E2E: uv coverage", () => { it(`uv tool install installs a global tool`, async () => { const shell = await container.openShell("zsh"); const result = await shell.runCommand( - "uv tool install ruff" + "uv tool install ruff --safe-chain-logging=verbose" ); assert.ok( - result.output.includes("no malware found.") || result.output.includes("Installed"), + result.output.includes("no malware found.") || + result.output.includes("Installed"), `Output did not include expected text. Output was:\n${result.output}` ); }); it(`safe-chain blocks malicious packages via uv tool install`, async () => { const shell = await container.openShell("zsh"); - const result = await shell.runCommand( - "uv tool install safe-chain-pi-test" - ); + const result = await shell.runCommand("uv tool install numpy==2.4.4"); - assert.ok( - result.output.includes("blocked 1 malicious package downloads:"), + assert.match( + result.output, + /blocked [1-9]\d* malicious package downloads:/, `Output did not include expected text. Output was:\n${result.output}` ); assert.ok( - result.output.includes("safe_chain_pi_test@0.0.1"), + result.output.includes("numpy@2.4.4"), `Output did not include expected text. Output was:\n${result.output}` ); }); it(`uv run --with installs ephemeral dependency`, async () => { const shell = await container.openShell("zsh"); - + // Create a simple Python script - await shell.runCommand("echo 'import requests; print(requests.__version__)' > test_script.py"); - + await shell.runCommand( + "echo 'import requests; print(requests.__version__)' > test_script.py" + ); + const result = await shell.runCommand( - "uv run --with requests test_script.py" + "uv run --with requests test_script.py --safe-chain-logging=verbose" ); assert.ok( @@ -467,26 +480,27 @@ describe("E2E: uv coverage", () => { it(`safe-chain blocks malicious packages via uv run --with`, async () => { const shell = await container.openShell("zsh"); - + // Create a simple Python script await shell.runCommand("echo 'print(\"test\")' > test_script2.py"); - + const result = await shell.runCommand( - "uv run --with safe-chain-pi-test test_script2.py" + "uv run --with numpy==2.4.4 test_script2.py" ); - assert.ok( - result.output.includes("blocked 1 malicious package downloads:"), + assert.match( + result.output, + /blocked [1-9]\d* malicious package downloads:/, `Output did not include expected text. Output was:\n${result.output}` ); }); it(`uv sync syncs project dependencies`, async () => { const shell = await container.openShell("zsh"); - + // Initialize a new uv project, add a dependency, remove venv, and sync in one command chain const result = await shell.runCommand( - "uv init test-sync-project && cd test-sync-project && uv add requests && rm -rf .venv && uv sync" + "uv init test-sync-project && cd test-sync-project && uv add requests --safe-chain-logging=verbose && rm -rf .venv && uv sync --safe-chain-logging=verbose" ); assert.ok( @@ -497,12 +511,12 @@ describe("E2E: uv coverage", () => { it(`uv add from git URL`, async () => { const shell = await container.openShell("zsh"); - + // Initialize a new uv project await shell.runCommand("uv init test-git-add"); - + const result = await shell.runCommand( - "cd test-git-add && uv add git+https://github.com/psf/requests.git@v2.32.3" + "cd test-git-add && uv add git+https://github.com/psf/requests.git@v2.32.3 --safe-chain-logging=verbose" ); assert.ok( @@ -513,12 +527,12 @@ describe("E2E: uv coverage", () => { it(`uv add with --optional group`, async () => { const shell = await container.openShell("zsh"); - + // Initialize a new uv project await shell.runCommand("uv init test-optional"); - + const result = await shell.runCommand( - "cd test-optional && uv add --optional dev pytest" + "cd test-optional && uv add --optional dev pytest --safe-chain-logging=verbose" ); assert.ok( @@ -529,13 +543,15 @@ describe("E2E: uv coverage", () => { it(`uv run --with-requirements installs from requirements file`, async () => { const shell = await container.openShell("zsh"); - + // Create requirements file and script await shell.runCommand("echo 'requests' > run_requirements.txt"); - await shell.runCommand("echo 'import requests; print(requests.__version__)' > run_script.py"); - + await shell.runCommand( + "echo 'import requests; print(requests.__version__)' > run_script.py" + ); + const result = await shell.runCommand( - "uv run --with-requirements run_requirements.txt run_script.py" + "uv run --with-requirements run_requirements.txt run_script.py --safe-chain-logging=verbose" ); assert.ok( @@ -546,10 +562,10 @@ describe("E2E: uv coverage", () => { it(`uv sync --all-extras syncs all optional dependencies`, async () => { const shell = await container.openShell("zsh"); - + // Initialize project with optional dependency and sync in one command chain const result = await shell.runCommand( - "uv init test-extras && cd test-extras && uv add --optional dev pytest && uv sync --all-extras" + "uv init test-extras && cd test-extras && uv add --optional dev pytest --safe-chain-logging=verbose && uv sync --all-extras" ); assert.ok( @@ -558,4 +574,3 @@ describe("E2E: uv coverage", () => { ); }); }); - diff --git a/test/e2e/uvx.e2e.spec.js b/test/e2e/uvx.e2e.spec.js new file mode 100644 index 0000000..61fb924 --- /dev/null +++ b/test/e2e/uvx.e2e.spec.js @@ -0,0 +1,132 @@ +import { describe, it, before, beforeEach, afterEach } from "node:test"; +import { DockerTestContainer } from "./DockerTestContainer.js"; +import assert from "node:assert"; + +describe("E2E: uvx coverage", () => { + let container; + + before(async () => { + DockerTestContainer.buildImage(); + }); + + beforeEach(async () => { + container = new DockerTestContainer(); + await container.start(); + + const installationShell = await container.openShell("zsh"); + await installationShell.runCommand("safe-chain setup"); + + // Clear uv cache + await installationShell.runCommand("uv cache clean"); + }); + + afterEach(async () => { + if (container) { + await container.stop(); + container = null; + } + }); + + it(`successfully runs a known safe tool with uvx`, async () => { + const shell = await container.openShell("zsh"); + + const result = await shell.runCommand( + "uvx ruff --version --safe-chain-logging=verbose" + ); + + assert.ok( + result.output.includes("no malware found.") || /ruff/i.test(result.output), + `Expected safe tool to run successfully. Output was:\n${result.output}` + ); + }); + + it(`safe-chain blocks malicious packages via uvx`, async () => { + const shell = await container.openShell("zsh"); + + const result = await shell.runCommand( + "uvx numpy==2.4.4" + ); + + assert.ok( + result.output.includes("blocked by safe-chain"), + `Expected malicious package to be blocked. Output was:\n${result.output}` + ); + assert.ok( + result.output.includes("Exiting without installing malicious packages."), + `Expected exit message. Output was:\n${result.output}` + ); + }); + + it(`uvx with --from flag runs a safe tool`, async () => { + const shell = await container.openShell("zsh"); + + const result = await shell.runCommand( + "uvx --from ruff ruff --version --safe-chain-logging=verbose" + ); + + assert.ok( + result.output.includes("no malware found.") || /ruff/i.test(result.output), + `Expected safe tool to run successfully with --from. Output was:\n${result.output}` + ); + }); + + it(`uvx with --from flag blocks malicious packages`, async () => { + const shell = await container.openShell("zsh"); + + const result = await shell.runCommand( + "uvx --from numpy==2.4.4 some-command" + ); + + assert.ok( + result.output.includes("blocked by safe-chain"), + `Expected malicious package to be blocked with --from. Output was:\n${result.output}` + ); + assert.ok( + result.output.includes("Exiting without installing malicious packages."), + `Expected exit message. Output was:\n${result.output}` + ); + }); + + it(`uvx with specific version runs successfully`, async () => { + const shell = await container.openShell("zsh"); + + const result = await shell.runCommand( + "uvx ruff@0.4.0 --version --safe-chain-logging=verbose" + ); + + assert.ok( + result.output.includes("no malware found.") || /ruff/i.test(result.output), + `Expected safe tool with version to run. Output was:\n${result.output}` + ); + }); + + it(`uvx with --with flag for additional dependencies`, async () => { + const shell = await container.openShell("zsh"); + + const result = await shell.runCommand( + "uvx --with requests ruff --version --safe-chain-logging=verbose" + ); + + assert.ok( + result.output.includes("no malware found.") || /ruff/i.test(result.output), + `Expected safe tool with --with dependency to run. Output was:\n${result.output}` + ); + }); + + it(`uvx with --with flag blocks malicious additional dependencies`, async () => { + const shell = await container.openShell("zsh"); + + const result = await shell.runCommand( + "uvx --with numpy==2.4.4 ruff --version" + ); + + assert.ok( + result.output.includes("blocked by safe-chain"), + `Expected malicious --with dependency to be blocked. Output was:\n${result.output}` + ); + assert.ok( + result.output.includes("Exiting without installing malicious packages."), + `Expected exit message. Output was:\n${result.output}` + ); + }); +}); diff --git a/test/e2e/yarn-ci.e2e.spec.js b/test/e2e/yarn-ci.e2e.spec.js index 8aac426..47e2120 100644 --- a/test/e2e/yarn-ci.e2e.spec.js +++ b/test/e2e/yarn-ci.e2e.spec.js @@ -33,7 +33,9 @@ describe("E2E: yarn coverage", () => { it(`safe-chain succesfully installs safe packages`, async () => { const shell = await container.openShell("zsh"); - const result = await shell.runCommand("yarn add axios"); + const result = await shell.runCommand( + "yarn add axios@1.13.0 --safe-chain-logging=verbose" + ); assert.ok( result.output.includes("no malware found."), diff --git a/test/e2e/yarn.e2e.spec.js b/test/e2e/yarn.e2e.spec.js index 32a8114..e70d6fc 100644 --- a/test/e2e/yarn.e2e.spec.js +++ b/test/e2e/yarn.e2e.spec.js @@ -28,7 +28,9 @@ describe("E2E: yarn coverage", () => { it(`safe-chain succesfully installs safe packages`, async () => { const shell = await container.openShell("zsh"); - const result = await shell.runCommand("yarn add axios"); + const result = await shell.runCommand( + "yarn add axios@1.13.0 --safe-chain-logging=verbose" + ); assert.ok( result.output.includes("no malware found."), @@ -68,8 +70,9 @@ describe("E2E: yarn coverage", () => { var result = await shell.runCommand("yarn"); - assert.ok( - result.output.includes("blocked 1 malicious package downloads"), + assert.match( + result.output, + /blocked [1-9]\d* malicious package downloads/, `Output did not include expected text. Output was:\n${result.output}` ); assert.ok(