mirror of
https://github.com/AikidoSec/safe-chain.git
synced 2026-05-26 12:10:49 +00:00
Merge branch 'rama-integration-beta' into rama-min-package-age-reporting
This commit is contained in:
commit
5f82e45b2b
131 changed files with 6372 additions and 2461 deletions
94
.github/workflows/build-and-release.yml
vendored
94
.github/workflows/build-and-release.yml
vendored
|
|
@ -4,6 +4,8 @@ on:
|
||||||
push:
|
push:
|
||||||
tags:
|
tags:
|
||||||
- "*"
|
- "*"
|
||||||
|
release:
|
||||||
|
types: [published]
|
||||||
|
|
||||||
permissions:
|
permissions:
|
||||||
id-token: write
|
id-token: write
|
||||||
|
|
@ -12,30 +14,19 @@ permissions:
|
||||||
jobs:
|
jobs:
|
||||||
set-version:
|
set-version:
|
||||||
name: Set version number
|
name: Set version number
|
||||||
runs-on: ubuntu-latest
|
if: github.event_name == 'push'
|
||||||
|
runs-on: open-source-releaser
|
||||||
outputs:
|
outputs:
|
||||||
version: ${{ steps.get_version.outputs.tag }}
|
version: ${{ steps.get_version.outputs.tag }}
|
||||||
is_prerelease: ${{ steps.check_prerelease.outputs.is_prerelease }}
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout code
|
|
||||||
uses: actions/checkout@v3
|
|
||||||
|
|
||||||
- name: Set version number
|
- name: Set version number
|
||||||
id: get_version
|
id: get_version
|
||||||
run: |
|
run: |
|
||||||
version="${{ github.ref_name }}"
|
version="${{ github.ref_name }}"
|
||||||
echo "tag=$version" >> $GITHUB_OUTPUT
|
echo "tag=$version" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
- name: Check if pre-release
|
|
||||||
id: check_prerelease
|
|
||||||
env:
|
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
run: |
|
|
||||||
IS_PRERELEASE=$(gh release view ${{ steps.get_version.outputs.tag }} --json isPrerelease --jq '.isPrerelease')
|
|
||||||
echo "is_prerelease=$IS_PRERELEASE" >> $GITHUB_OUTPUT
|
|
||||||
echo "Release ${{ steps.get_version.outputs.tag }} is pre-release: $IS_PRERELEASE"
|
|
||||||
|
|
||||||
create-binaries:
|
create-binaries:
|
||||||
|
if: github.event_name == 'push'
|
||||||
needs: set-version
|
needs: set-version
|
||||||
uses: ./.github/workflows/create-artifact.yml
|
uses: ./.github/workflows/create-artifact.yml
|
||||||
with:
|
with:
|
||||||
|
|
@ -43,9 +34,9 @@ jobs:
|
||||||
|
|
||||||
publish-binaries:
|
publish-binaries:
|
||||||
name: Publish to GitHub release
|
name: Publish to GitHub release
|
||||||
|
if: github.event_name == 'push'
|
||||||
needs: [set-version, create-binaries]
|
needs: [set-version, create-binaries]
|
||||||
runs-on: ubuntu-latest
|
runs-on: open-source-releaser
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout code
|
- name: Checkout code
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v3
|
||||||
|
|
@ -69,20 +60,59 @@ jobs:
|
||||||
mv binaries/safe-chain-win-x64/safe-chain.exe release-artifacts/safe-chain-win-x64.exe
|
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
|
mv binaries/safe-chain-win-arm64/safe-chain.exe release-artifacts/safe-chain-win-arm64.exe
|
||||||
|
|
||||||
- name: Move install scripts and hard-code version
|
- name: Move install scripts and hard-code version and checksums
|
||||||
env:
|
env:
|
||||||
VERSION: ${{ needs.set-version.outputs.version }}
|
VERSION: ${{ needs.set-version.outputs.version }}
|
||||||
run: |
|
run: |
|
||||||
sed "s/\$(fetch_latest_version)/${VERSION}/" install-scripts/install-safe-chain.sh > release-artifacts/install-safe-chain.sh
|
SHA_MACOS_X64=$(sha256sum release-artifacts/safe-chain-macos-x64 | awk '{print $1}')
|
||||||
sed "s/\$Version = Get-LatestVersion/\$Version = \"${VERSION}\"/" install-scripts/install-safe-chain.ps1 > release-artifacts/install-safe-chain.ps1
|
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.sh release-artifacts/uninstall-safe-chain.sh
|
||||||
cp install-scripts/uninstall-safe-chain.ps1 release-artifacts/uninstall-safe-chain.ps1
|
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: Upload binaries to existing GitHub Release
|
- name: Create draft release and upload assets
|
||||||
env:
|
env:
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
VERSION: ${{ needs.set-version.outputs.version }}
|
||||||
run: |
|
run: |
|
||||||
gh release upload ${{ needs.set-version.outputs.version }} \
|
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-x64 \
|
||||||
release-artifacts/safe-chain-macos-arm64 \
|
release-artifacts/safe-chain-macos-arm64 \
|
||||||
release-artifacts/safe-chain-linux-x64 \
|
release-artifacts/safe-chain-linux-x64 \
|
||||||
|
|
@ -94,12 +124,15 @@ jobs:
|
||||||
release-artifacts/install-safe-chain.sh \
|
release-artifacts/install-safe-chain.sh \
|
||||||
release-artifacts/install-safe-chain.ps1 \
|
release-artifacts/install-safe-chain.ps1 \
|
||||||
release-artifacts/uninstall-safe-chain.sh \
|
release-artifacts/uninstall-safe-chain.sh \
|
||||||
release-artifacts/uninstall-safe-chain.ps1
|
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:
|
publish-npm:
|
||||||
name: Publish to npm
|
name: Publish to npm
|
||||||
needs: [set-version, create-binaries]
|
if: github.event_name == 'release'
|
||||||
if: needs.set-version.outputs.is_prerelease != 'true'
|
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
|
|
@ -118,7 +151,7 @@ jobs:
|
||||||
run: curl -fsSL https://github.com/AikidoSec/safe-chain/releases/latest/download/install-safe-chain.sh | sh -s -- --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
|
- 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
|
- name: Install dependencies
|
||||||
run: npm ci
|
run: npm ci
|
||||||
|
|
@ -131,8 +164,15 @@ jobs:
|
||||||
cp README.md packages/safe-chain/
|
cp README.md packages/safe-chain/
|
||||||
cp LICENSE packages/safe-chain/
|
cp LICENSE packages/safe-chain/
|
||||||
cp -r docs packages/safe-chain/
|
cp -r docs packages/safe-chain/
|
||||||
|
cp npm-shrinkwrap.json packages/safe-chain/
|
||||||
|
|
||||||
- name: Publish to npm
|
- name: Publish to npm
|
||||||
run: |
|
run: |
|
||||||
echo "Publishing version ${{ needs.set-version.outputs.version }} to NPM"
|
VERSION="${{ github.event.release.tag_name }}"
|
||||||
npm publish --workspace=packages/safe-chain --access public --provenance
|
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
|
||||||
|
|
|
||||||
5
.github/workflows/create-artifact.yml
vendored
5
.github/workflows/create-artifact.yml
vendored
|
|
@ -78,7 +78,10 @@ jobs:
|
||||||
|
|
||||||
- name: Set the version in safe-chain package
|
- name: Set the version in safe-chain package
|
||||||
if: inputs.version != ''
|
if: inputs.version != ''
|
||||||
run: npm --no-git-tag-version version ${{ inputs.version }} --workspace=packages/safe-chain --ignore-scripts
|
env:
|
||||||
|
VERSION: ${{ inputs.version }}
|
||||||
|
shell: bash
|
||||||
|
run: npm --no-git-tag-version version $VERSION --workspace=packages/safe-chain --ignore-scripts
|
||||||
|
|
||||||
- name: Create binary
|
- name: Create binary
|
||||||
run: |
|
run: |
|
||||||
|
|
|
||||||
5
.github/workflows/test-on-pr.yml
vendored
5
.github/workflows/test-on-pr.yml
vendored
|
|
@ -93,11 +93,6 @@ jobs:
|
||||||
npm_version: "latest"
|
npm_version: "latest"
|
||||||
yarn_version: "latest"
|
yarn_version: "latest"
|
||||||
pnpm_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:
|
steps:
|
||||||
- name: Checkout code
|
- name: Checkout code
|
||||||
|
|
|
||||||
119
README.md
119
README.md
|
|
@ -7,9 +7,17 @@
|
||||||
|
|
||||||
- ✅ **Block malware on developer laptops and CI/CD**
|
- ✅ **Block malware on developer laptops and CI/CD**
|
||||||
- ✅ **Supports npm and PyPI** more package managers coming
|
- ✅ **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**
|
- ✅ **Tokenless, free, no build data shared**
|
||||||
|
|
||||||
|
## 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:
|
Aikido Safe Chain supports the following package managers:
|
||||||
|
|
||||||
- 📦 **npm**
|
- 📦 **npm**
|
||||||
|
|
@ -23,6 +31,7 @@ Aikido Safe Chain supports the following package managers:
|
||||||
- 📦 **pip3**
|
- 📦 **pip3**
|
||||||
- 📦 **uv**
|
- 📦 **uv**
|
||||||
- 📦 **poetry**
|
- 📦 **poetry**
|
||||||
|
- 📦 **uvx**
|
||||||
- 📦 **pipx**
|
- 📦 **pipx**
|
||||||
|
|
||||||
# Usage
|
# Usage
|
||||||
|
|
@ -66,7 +75,7 @@ You can find all available versions on the [releases page](https://github.com/Ai
|
||||||
### Verify the installation
|
### Verify the installation
|
||||||
|
|
||||||
1. **❗Restart your terminal** to start using the Aikido Safe Chain.
|
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, bun, bunx, pip, pip3, poetry, uv and pipx 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, pip, pip3, poetry, uv, uvx and pipx 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 the verification command:
|
||||||
|
|
||||||
|
|
@ -97,7 +106,7 @@ You can find all available versions on the [releases page](https://github.com/Ai
|
||||||
|
|
||||||
- The output should show that Aikido Safe Chain is blocking the installation of these test packages as they are flagged as malware.
|
- 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`, `pip`, `pip3`, `uv`, `poetry` and `pipx` 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`, `bun`, `bunx`, `pip`, `pip3`, `uv`, `uvx`, `poetry` and `pipx` 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:
|
You can check the installed version by running:
|
||||||
|
|
||||||
|
|
@ -109,17 +118,26 @@ safe-chain --version
|
||||||
|
|
||||||
### Malware Blocking
|
### 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, pip, pip3, uv, poetry or pipx 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, bun, bunx, pip, pip3, uv, uvx, poetry or pipx 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, poetry, pipx).
|
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
|
### 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 (pip, uv, poetry, pipx). 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, bun, bunx, and Python package managers (pip, uv, uvx, poetry, pipx). 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**
|
- ✅ **Bash**
|
||||||
- ✅ **Zsh**
|
- ✅ **Zsh**
|
||||||
|
|
@ -183,7 +201,17 @@ You can set the logging level through multiple sources (in order of priority):
|
||||||
|
|
||||||
## Minimum Package Age
|
## 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
|
### Configuration Options
|
||||||
|
|
||||||
|
|
@ -202,7 +230,7 @@ You can set the minimum package age through multiple sources (in order of priori
|
||||||
npm install express
|
npm install express
|
||||||
```
|
```
|
||||||
|
|
||||||
3. **Config File** (`~/.aikido/config.json`):
|
3. **Config File** (`~/.safe-chain/config.json`):
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
|
|
@ -215,13 +243,16 @@ You can set the minimum package age through multiple sources (in order of priori
|
||||||
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:
|
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
|
```shell
|
||||||
export SAFE_CHAIN_NPM_MINIMUM_PACKAGE_AGE_EXCLUSIONS="@aikidosec/*"
|
export SAFE_CHAIN_MINIMUM_PACKAGE_AGE_EXCLUSIONS="@aikidosec/*"
|
||||||
```
|
```
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"npm": {
|
"npm": {
|
||||||
"minimumPackageAgeExclusions": ["@aikidosec/*"]
|
"minimumPackageAgeExclusions": ["@aikidosec/*"]
|
||||||
|
},
|
||||||
|
"pip": {
|
||||||
|
"minimumPackageAgeExclusions": ["requests"]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
@ -246,7 +277,7 @@ You can set custom registries through environment variable or config file. Both
|
||||||
export SAFE_CHAIN_PIP_CUSTOM_REGISTRIES="pip.company.com,registry.internal.net"
|
export SAFE_CHAIN_PIP_CUSTOM_REGISTRIES="pip.company.com,registry.internal.net"
|
||||||
```
|
```
|
||||||
|
|
||||||
2. **Config File** (`~/.aikido/config.json`):
|
2. **Config File** (`~/.safe-chain/config.json`):
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
|
|
@ -259,6 +290,65 @@ You can set custom registries through environment variable or config file. Both
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## 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
|
# 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.
|
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.
|
||||||
|
|
@ -349,6 +439,7 @@ pipeline {
|
||||||
environment {
|
environment {
|
||||||
// Jenkins does not automatically persist PATH updates from setup-ci,
|
// Jenkins does not automatically persist PATH updates from setup-ci,
|
||||||
// so add the shims + binary directory explicitly for all stages.
|
// 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}"
|
PATH = "${env.HOME}/.safe-chain/shims:${env.HOME}/.safe-chain/bin:${env.PATH}"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -386,7 +477,7 @@ steps:
|
||||||
name: Install
|
name: Install
|
||||||
script:
|
script:
|
||||||
- curl -fsSL https://github.com/AikidoSec/safe-chain/releases/latest/download/install-safe-chain.sh | sh -s -- --ci
|
- curl -fsSL https://github.com/AikidoSec/safe-chain/releases/latest/download/install-safe-chain.sh | sh -s -- --ci
|
||||||
- export PATH=~/.safe-chain/shims:$PATH
|
- export PATH=~/.safe-chain/shims:~/.safe-chain/bin:$PATH
|
||||||
- npm ci
|
- npm ci
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -404,7 +495,7 @@ To add safe-chain in GitLab pipelines, you need to install it in the image runni
|
||||||
# Install safe-chain
|
# Install safe-chain
|
||||||
RUN curl -fsSL https://github.com/AikidoSec/safe-chain/releases/latest/download/install-safe-chain.sh | sh -s -- --ci
|
RUN curl -fsSL https://github.com/AikidoSec/safe-chain/releases/latest/download/install-safe-chain.sh | sh -s -- --ci
|
||||||
|
|
||||||
# Add safe-chain to PATH
|
# 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}"
|
ENV PATH="/root/.safe-chain/shims:/root/.safe-chain/bin:${PATH}"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
||||||
25
docs/Release.md
Normal file
25
docs/Release.md
Normal file
|
|
@ -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.
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
The shell integration automatically wraps common package manager commands (`npm`, `npx`, `yarn`, `pnpm`, `pnpx`, `bun`, `bunx`, `pip`, `pip3`, `uv`, `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.
|
The shell integration automatically wraps common package manager commands (`npm`, `npx`, `yarn`, `pnpm`, `pnpx`, `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
|
## Supported Shells
|
||||||
|
|
||||||
|
|
@ -28,7 +28,7 @@ This command:
|
||||||
|
|
||||||
- Copies necessary startup scripts to Safe Chain's installation directory (`~/.safe-chain/scripts`)
|
- Copies necessary startup scripts to Safe Chain's installation directory (`~/.safe-chain/scripts`)
|
||||||
- Detects all supported shells on your system
|
- 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`, `pip3`, `uv`, `poetry` and `pipx`
|
- Sources each shell's startup file to add Safe Chain functions for `npm`, `npx`, `yarn`, `pnpm`, `pnpx`, `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
|
- 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.
|
❗ 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:
|
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
|
- 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`, `aikido-pip3`, `aikido-uv`, `aikido-poetry` and `aikido-pipx` commands exist
|
- Verify the `aikido-npm`, `aikido-npx`, `aikido-yarn`, `aikido-pnpm`, `aikido-pnpx`, `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
|
- Check that these commands are in your system's PATH
|
||||||
|
|
||||||
### Manual Verification
|
### Manual Verification
|
||||||
|
|
@ -121,7 +121,7 @@ npm() {
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Repeat this pattern for `npx`, `yarn`, `pnpm`, `pnpx`, `bun`, `bunx`, `pip`, `pip3`, `uv`, `poetry` and `pipx` using their respective `aikido-*` commands. After adding these functions, restart your terminal to apply the changes.
|
Repeat this pattern for `npx`, `yarn`, `pnpm`, `pnpx`, `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:
|
To intercept Python module invocations for pip without altering Python itself, you can add small forwarding functions:
|
||||||
|
|
||||||
|
|
|
||||||
133
install-scripts/install-endpoint-mac.sh
Executable file
133
install-scripts/install-endpoint-mac.sh
Executable file
|
|
@ -0,0 +1,133 @@
|
||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
# Downloads and installs Aikido Endpoint Protection on macOS
|
||||||
|
#
|
||||||
|
# Usage: curl -fsSL <url> | sudo sh -s -- --token <TOKEN>
|
||||||
|
|
||||||
|
set -e # Exit on error
|
||||||
|
|
||||||
|
# Configuration
|
||||||
|
INSTALL_URL="https://github.com/AikidoSec/safechain-internals/releases/download/v1.3.4/EndpointProtection.pkg"
|
||||||
|
DOWNLOAD_SHA256="f2ea55588d42e4aa17545ad787f46dd36001009e2ddb9655c497b1a36edf3581"
|
||||||
|
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 <url> | sudo sh -s -- --token <TOKEN>"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Check if token is provided via command argument
|
||||||
|
if [ -z "$TOKEN" ]; then
|
||||||
|
error "Token is required. Pass it with --token <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 "$@"
|
||||||
100
install-scripts/install-endpoint-windows.ps1
Normal file
100
install-scripts/install-endpoint-windows.ps1
Normal file
|
|
@ -0,0 +1,100 @@
|
||||||
|
# Downloads and installs Aikido Endpoint Protection on Windows
|
||||||
|
#
|
||||||
|
# Usage: iex "& { $(iwr '<url>' -UseBasicParsing) } -token <TOKEN>"
|
||||||
|
|
||||||
|
param(
|
||||||
|
[string]$token
|
||||||
|
)
|
||||||
|
|
||||||
|
# Configuration
|
||||||
|
$InstallUrl = "https://github.com/AikidoSec/safechain-internals/releases/download/v1.3.4/EndpointProtection.msi"
|
||||||
|
$DownloadSha256 = "0699379716a9a8b1531befa538befb237252af9f7fd780b33f4dce73588c6f83"
|
||||||
|
|
||||||
|
# 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 <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: $_"
|
||||||
|
}
|
||||||
|
|
@ -4,13 +4,68 @@
|
||||||
|
|
||||||
param(
|
param(
|
||||||
[switch]$ci,
|
[switch]$ci,
|
||||||
[switch]$includepython
|
[switch]$includepython,
|
||||||
|
[string]$InstallDir
|
||||||
)
|
)
|
||||||
|
|
||||||
|
# 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
|
$Version = $env:SAFE_CHAIN_VERSION # Will be fetched from latest release if not set
|
||||||
$InstallDir = Join-Path $env:USERPROFILE ".safe-chain\bin"
|
$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"
|
$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
|
# Ensure TLS 1.2 is enabled for downloads
|
||||||
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
|
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
|
||||||
|
|
||||||
|
|
@ -98,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
|
# Check and uninstall npm global package if present
|
||||||
function Remove-NpmInstallation {
|
function Remove-NpmInstallation {
|
||||||
# Check if npm is available
|
# Check if npm is available
|
||||||
|
|
@ -149,19 +289,7 @@ function Remove-VoltaInstallation {
|
||||||
|
|
||||||
# Main installation
|
# Main installation
|
||||||
function Install-SafeChain {
|
function Install-SafeChain {
|
||||||
# Show deprecation warning if SAFE_CHAIN_VERSION is set
|
Write-VersionDeprecationWarning
|
||||||
if (-not [string]::IsNullOrWhiteSpace($env:SAFE_CHAIN_VERSION)) {
|
|
||||||
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 ""
|
|
||||||
}
|
|
||||||
|
|
||||||
# Fetch latest version if VERSION is not set
|
# Fetch latest version if VERSION is not set
|
||||||
if ([string]::IsNullOrWhiteSpace($Version)) {
|
if ([string]::IsNullOrWhiteSpace($Version)) {
|
||||||
|
|
@ -192,7 +320,7 @@ function Install-SafeChain {
|
||||||
|
|
||||||
# Detect platform
|
# Detect platform
|
||||||
$arch = Get-Architecture
|
$arch = Get-Architecture
|
||||||
$binaryName = "safe-chain-win-$arch.exe"
|
$binaryName = Get-BinaryName -Architecture $arch
|
||||||
|
|
||||||
Write-Info "Detected architecture: $arch"
|
Write-Info "Detected architecture: $arch"
|
||||||
|
|
||||||
|
|
@ -223,6 +351,9 @@ function Install-SafeChain {
|
||||||
Write-Error-Custom "Failed to download from $downloadUrl : $_"
|
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
|
# Rename to final location
|
||||||
$finalFile = Join-Path $InstallDir "safe-chain.exe"
|
$finalFile = Join-Path $InstallDir "safe-chain.exe"
|
||||||
try {
|
try {
|
||||||
|
|
@ -238,31 +369,7 @@ function Install-SafeChain {
|
||||||
|
|
||||||
Write-Info "Binary installed to: $finalFile"
|
Write-Info "Binary installed to: $finalFile"
|
||||||
|
|
||||||
# Build setup command based on parameters
|
Invoke-SafeChainSetup -BinaryPath $finalFile -InstallDirectory $InstallDir
|
||||||
$setupCmd = if ($ci) { "setup-ci" } else { "setup" }
|
|
||||||
$setupArgs = @()
|
|
||||||
|
|
||||||
# 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."
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
# Run installation
|
# Run installation
|
||||||
|
|
|
||||||
|
|
@ -6,11 +6,67 @@
|
||||||
|
|
||||||
set -e # Exit on error
|
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
|
# Configuration
|
||||||
VERSION="${SAFE_CHAIN_VERSION:-}" # Will be fetched from latest release if not set
|
VERSION="${SAFE_CHAIN_VERSION:-}" # Will be fetched from latest release if not set
|
||||||
INSTALL_DIR="${HOME}/.safe-chain/bin"
|
SAFE_CHAIN_BASE="${HOME}/.safe-chain"
|
||||||
|
|
||||||
|
INSTALL_DIR="${SAFE_CHAIN_BASE}/bin"
|
||||||
REPO_URL="https://github.com/AikidoSec/safe-chain"
|
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
|
# Colors for output
|
||||||
RED='\033[0;31m'
|
RED='\033[0;31m'
|
||||||
GREEN='\033[0;32m'
|
GREEN='\033[0;32m'
|
||||||
|
|
@ -112,6 +168,57 @@ fetch_latest_version() {
|
||||||
echo "$latest_version"
|
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 file
|
||||||
download() {
|
download() {
|
||||||
url="$1"
|
url="$1"
|
||||||
|
|
@ -126,6 +233,75 @@ download() {
|
||||||
fi
|
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 and uninstall npm global package if present
|
||||||
remove_npm_installation() {
|
remove_npm_installation() {
|
||||||
if ! command_exists npm; then
|
if ! command_exists npm; then
|
||||||
|
|
@ -229,11 +405,27 @@ remove_nvm_installation() {
|
||||||
|
|
||||||
# Parse command-line arguments
|
# Parse command-line arguments
|
||||||
parse_arguments() {
|
parse_arguments() {
|
||||||
for arg in "$@"; do
|
while [ $# -gt 0 ]; do
|
||||||
case "$arg" in
|
case "$1" in
|
||||||
--ci)
|
--ci)
|
||||||
USE_CI_SETUP=true
|
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)
|
||||||
warn "--include-python is deprecated and ignored. Python ecosystem is now included by default."
|
warn "--include-python is deprecated and ignored. Python ecosystem is now included by default."
|
||||||
;;
|
;;
|
||||||
|
|
@ -241,10 +433,14 @@ parse_arguments() {
|
||||||
USE_RAMA_PROXY=true
|
USE_RAMA_PROXY=true
|
||||||
;;
|
;;
|
||||||
*)
|
*)
|
||||||
error "Unknown argument: $arg"
|
error "Unknown argument: $1"
|
||||||
;;
|
;;
|
||||||
esac
|
esac
|
||||||
|
shift
|
||||||
done
|
done
|
||||||
|
|
||||||
|
validate_install_dir "${SAFE_CHAIN_BASE}"
|
||||||
|
INSTALL_DIR="${SAFE_CHAIN_BASE}/bin"
|
||||||
}
|
}
|
||||||
|
|
||||||
# Main installation
|
# Main installation
|
||||||
|
|
@ -256,25 +452,9 @@ main() {
|
||||||
# Parse command-line arguments
|
# Parse command-line arguments
|
||||||
parse_arguments "$@"
|
parse_arguments "$@"
|
||||||
|
|
||||||
# Show deprecation warning if SAFE_CHAIN_VERSION is set
|
warn_deprecated_version_env
|
||||||
if [ -n "$SAFE_CHAIN_VERSION" ]; then
|
|
||||||
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 ""
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Fetch latest version if VERSION is not set
|
ensure_version
|
||||||
if [ -z "$VERSION" ]; then
|
|
||||||
info "Fetching latest release version..."
|
|
||||||
VERSION=$(fetch_latest_version)
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Check if the requested version is already installed
|
# Check if the requested version is already installed
|
||||||
if is_version_installed "$VERSION"; then
|
if is_version_installed "$VERSION"; then
|
||||||
|
|
@ -298,11 +478,7 @@ main() {
|
||||||
# Detect platform
|
# Detect platform
|
||||||
OS=$(detect_os)
|
OS=$(detect_os)
|
||||||
ARCH=$(detect_arch)
|
ARCH=$(detect_arch)
|
||||||
if [ "$OS" = "win" ]; then
|
BINARY_NAME=$(get_binary_name "$OS" "$ARCH")
|
||||||
BINARY_NAME="safe-chain-${OS}-${ARCH}.exe"
|
|
||||||
else
|
|
||||||
BINARY_NAME="safe-chain-${OS}-${ARCH}"
|
|
||||||
fi
|
|
||||||
|
|
||||||
info "Detected platform: ${OS}-${ARCH}"
|
info "Detected platform: ${OS}-${ARCH}"
|
||||||
|
|
||||||
|
|
@ -319,12 +495,11 @@ main() {
|
||||||
info "Downloading from: $DOWNLOAD_URL"
|
info "Downloading from: $DOWNLOAD_URL"
|
||||||
download "$DOWNLOAD_URL" "$TEMP_FILE"
|
download "$DOWNLOAD_URL" "$TEMP_FILE"
|
||||||
|
|
||||||
|
EXPECTED_SHA256=$(get_expected_sha256 "$OS" "$ARCH")
|
||||||
|
verify_checksum "$TEMP_FILE" "$EXPECTED_SHA256"
|
||||||
|
|
||||||
# Rename and make executable
|
# Rename and make executable
|
||||||
if [ "$OS" = "win" ]; then
|
FINAL_FILE=$(get_final_binary_path "$OS")
|
||||||
FINAL_FILE="${INSTALL_DIR}/safe-chain.exe"
|
|
||||||
else
|
|
||||||
FINAL_FILE="${INSTALL_DIR}/safe-chain"
|
|
||||||
fi
|
|
||||||
mv "$TEMP_FILE" "$FINAL_FILE" || error "Failed to move binary to $FINAL_FILE"
|
mv "$TEMP_FILE" "$FINAL_FILE" || error "Failed to move binary to $FINAL_FILE"
|
||||||
if [ "$OS" != "win" ]; then
|
if [ "$OS" != "win" ]; then
|
||||||
chmod +x "$FINAL_FILE" || error "Failed to make binary executable"
|
chmod +x "$FINAL_FILE" || error "Failed to make binary executable"
|
||||||
|
|
@ -359,20 +534,7 @@ main() {
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Build setup command based on arguments
|
run_setup_command "$FINAL_FILE"
|
||||||
SETUP_CMD="setup"
|
|
||||||
SETUP_ARGS=""
|
|
||||||
|
|
||||||
if [ "$USE_CI_SETUP" = "true" ]; then
|
|
||||||
SETUP_CMD="setup-ci"
|
|
||||||
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
|
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|
|
||||||
50
install-scripts/uninstall-endpoint-mac.sh
Executable file
50
install-scripts/uninstall-endpoint-mac.sh
Executable file
|
|
@ -0,0 +1,50 @@
|
||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
# Uninstalls Aikido Endpoint Protection on macOS
|
||||||
|
#
|
||||||
|
# Usage: curl -fsSL <url> | 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 <url> | 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 "$@"
|
||||||
59
install-scripts/uninstall-endpoint-windows.ps1
Normal file
59
install-scripts/uninstall-endpoint-windows.ps1
Normal file
|
|
@ -0,0 +1,59 @@
|
||||||
|
# Uninstalls Aikido Endpoint Protection endpoint on Windows
|
||||||
|
#
|
||||||
|
# Usage: iex (iwr '<url>' -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: $_"
|
||||||
|
}
|
||||||
|
|
@ -4,7 +4,6 @@
|
||||||
|
|
||||||
# Use HOME on Unix, USERPROFILE on Windows (PowerShell Core is cross-platform)
|
# Use HOME on Unix, USERPROFILE on Windows (PowerShell Core is cross-platform)
|
||||||
$HomeDir = if ($env:HOME) { $env:HOME } else { $env:USERPROFILE }
|
$HomeDir = if ($env:HOME) { $env:HOME } else { $env:USERPROFILE }
|
||||||
$InstallDir = Join-Path $HomeDir ".safe-chain/bin"
|
|
||||||
|
|
||||||
# Helper functions
|
# Helper functions
|
||||||
function Write-Info {
|
function Write-Info {
|
||||||
|
|
@ -23,6 +22,146 @@ function Write-Error-Custom {
|
||||||
exit 1
|
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
|
# Check and uninstall npm global package if present
|
||||||
function Remove-NpmInstallation {
|
function Remove-NpmInstallation {
|
||||||
# Check if npm is available
|
# Check if npm is available
|
||||||
|
|
@ -75,82 +214,27 @@ function Remove-VoltaInstallation {
|
||||||
# Main uninstallation
|
# Main uninstallation
|
||||||
function Uninstall-SafeChain {
|
function Uninstall-SafeChain {
|
||||||
Write-Info "Uninstalling safe-chain..."
|
Write-Info "Uninstalling safe-chain..."
|
||||||
|
$DotSafeChain = Get-SafeChainInstallDir
|
||||||
# Run teardown if safe-chain is available
|
$safeChainPath = Find-SafeChainBinary -DotSafeChain $DotSafeChain
|
||||||
# Check for both safe-chain.exe (Windows) and safe-chain (Unix) since PowerShell Core runs on all platforms
|
Invoke-SafeChainTeardown -SafeChainPath $safeChainPath
|
||||||
$safeChainExe = Join-Path $InstallDir "safe-chain.exe"
|
|
||||||
$safeChainBin = Join-Path $InstallDir "safe-chain"
|
|
||||||
|
|
||||||
$safeChainPath = $null
|
|
||||||
if (Test-Path $safeChainExe) {
|
|
||||||
$safeChainPath = $safeChainExe
|
|
||||||
}
|
|
||||||
elseif (Test-Path $safeChainBin) {
|
|
||||||
$safeChainPath = $safeChainBin
|
|
||||||
}
|
|
||||||
|
|
||||||
if ($safeChainPath) {
|
|
||||||
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..."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
elseif (Get-Command safe-chain -ErrorAction SilentlyContinue) {
|
|
||||||
Write-Info "Running safe-chain teardown..."
|
|
||||||
try {
|
|
||||||
safe-chain 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..."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
Write-Warn "safe-chain command not found. Proceeding with uninstallation."
|
|
||||||
}
|
|
||||||
|
|
||||||
# Remove npm and Volta installations
|
# Remove npm and Volta installations
|
||||||
Remove-NpmInstallation
|
Remove-NpmInstallation
|
||||||
Remove-VoltaInstallation
|
Remove-VoltaInstallation
|
||||||
|
|
||||||
# Remove installation directory
|
# Remove .safe-chain directory
|
||||||
if (Test-Path $InstallDir) {
|
if (Test-Path $DotSafeChain) {
|
||||||
Write-Info "Removing installation directory: $InstallDir"
|
Write-Info "Removing installation directory: $DotSafeChain"
|
||||||
try {
|
try {
|
||||||
Remove-Item -Path $InstallDir -Recurse -Force
|
Remove-Item -Path $DotSafeChain -Recurse -Force
|
||||||
Write-Info "Successfully removed installation directory"
|
Write-Info "Successfully removed installation directory"
|
||||||
}
|
}
|
||||||
catch {
|
catch {
|
||||||
Write-Error-Custom "Failed to remove $InstallDir : $_"
|
Write-Error-Custom "Failed to remove $DotSafeChain : $_"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
else {
|
else {
|
||||||
Write-Info "Installation directory $InstallDir does not exist. Nothing to remove."
|
Write-Info "Installation directory $DotSafeChain does not exist. Nothing to remove."
|
||||||
}
|
|
||||||
|
|
||||||
# Also try to remove the parent .safe-chain directory if it's empty
|
|
||||||
$parentDir = Split-Path $InstallDir -Parent
|
|
||||||
if (Test-Path $parentDir) {
|
|
||||||
$items = Get-ChildItem -Path $parentDir -Force
|
|
||||||
if ($items.Count -eq 0) {
|
|
||||||
Write-Info "Removing empty parent directory: $parentDir"
|
|
||||||
try {
|
|
||||||
Remove-Item -Path $parentDir -Force
|
|
||||||
}
|
|
||||||
catch {
|
|
||||||
Write-Warn "Could not remove empty parent directory: $_"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
Write-Info "safe-chain has been uninstalled successfully!"
|
Write-Info "safe-chain has been uninstalled successfully!"
|
||||||
|
|
|
||||||
|
|
@ -7,7 +7,6 @@
|
||||||
set -e # Exit on error
|
set -e # Exit on error
|
||||||
|
|
||||||
# Configuration
|
# Configuration
|
||||||
INSTALL_DIR="${HOME}/.safe-chain/bin"
|
|
||||||
|
|
||||||
# Colors for output
|
# Colors for output
|
||||||
RED='\033[0;31m'
|
RED='\033[0;31m'
|
||||||
|
|
@ -34,6 +33,159 @@ command_exists() {
|
||||||
command -v "$1" >/dev/null 2>&1
|
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
|
# Check and uninstall npm global package if present
|
||||||
remove_npm_installation() {
|
remove_npm_installation() {
|
||||||
if ! command_exists npm; then
|
if ! command_exists npm; then
|
||||||
|
|
@ -139,17 +291,9 @@ remove_nvm_installation() {
|
||||||
|
|
||||||
# Main uninstallation
|
# Main uninstallation
|
||||||
main() {
|
main() {
|
||||||
SAFE_CHAIN_LOCATION="$INSTALL_DIR/safe-chain"
|
DOT_SAFE_CHAIN=$(get_install_dir)
|
||||||
|
SAFE_CHAIN_COMMAND=$(find_installed_safe_chain_binary "$DOT_SAFE_CHAIN" || true)
|
||||||
if [ -x "$SAFE_CHAIN_LOCATION" ]; then
|
run_safe_chain_teardown "$SAFE_CHAIN_COMMAND"
|
||||||
info "Running safe-chain teardown..."
|
|
||||||
"$SAFE_CHAIN_LOCATION" teardown || warn "safe-chain teardown encountered issues, continuing with uninstallation..."
|
|
||||||
elif command_exists safe-chain; then
|
|
||||||
info "Running safe-chain teardown..."
|
|
||||||
safe-chain teardown || warn "safe-chain teardown encountered issues, continuing with uninstallation..."
|
|
||||||
else
|
|
||||||
warn "safe-chain command not found. Proceeding with uninstallation."
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Check for existing safe-chain installation through nvm, volta, or npm
|
# Check for existing safe-chain installation through nvm, volta, or npm
|
||||||
remove_npm_installation
|
remove_npm_installation
|
||||||
|
|
@ -157,11 +301,11 @@ main() {
|
||||||
remove_nvm_installation
|
remove_nvm_installation
|
||||||
|
|
||||||
# Remove install dir recursively if it exists
|
# Remove install dir recursively if it exists
|
||||||
if [ -d "$INSTALL_DIR" ]; then
|
if [ -d "$DOT_SAFE_CHAIN" ]; then
|
||||||
info "Removing installation directory $INSTALL_DIR"
|
info "Removing installation directory $DOT_SAFE_CHAIN"
|
||||||
rm -rf "$INSTALL_DIR" || error "Failed to remove $INSTALL_DIR"
|
rm -rf "$DOT_SAFE_CHAIN" || error "Failed to remove $DOT_SAFE_CHAIN"
|
||||||
else
|
else
|
||||||
info "Installation directory $INSTALL_DIR does not exist. Nothing to remove."
|
info "Installation directory $DOT_SAFE_CHAIN does not exist. Nothing to remove."
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
944
package-lock.json → npm-shrinkwrap.json
generated
944
package-lock.json → npm-shrinkwrap.json
generated
File diff suppressed because it is too large
Load diff
16
packages/safe-chain/bin/aikido-uvx.js
Executable file
16
packages/safe-chain/bin/aikido-uvx.js
Executable file
|
|
@ -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);
|
||||||
|
})();
|
||||||
|
|
@ -16,6 +16,7 @@ import path from "path";
|
||||||
import { fileURLToPath } from "url";
|
import { fileURLToPath } from "url";
|
||||||
import fs from "fs";
|
import fs from "fs";
|
||||||
import { knownAikidoTools } from "../src/shell-integration/helpers.js";
|
import { knownAikidoTools } from "../src/shell-integration/helpers.js";
|
||||||
|
import { getInstalledSafeChainDir } from "../src/installLocation.js";
|
||||||
|
|
||||||
/** @type {string} */
|
/** @type {string} */
|
||||||
// This checks the current file's dirname in a way that's compatible with:
|
// This checks the current file's dirname in a way that's compatible with:
|
||||||
|
|
@ -67,6 +68,17 @@ if (tool) {
|
||||||
teardownDirectories();
|
teardownDirectories();
|
||||||
} else if (command === "setup-ci") {
|
} else if (command === "setup-ci") {
|
||||||
setupCi();
|
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") {
|
} else if (command === "--version" || command === "-v" || command === "-v") {
|
||||||
(async () => {
|
(async () => {
|
||||||
ui.writeInformation(`Current safe-chain version: ${await getVersion()}`);
|
ui.writeInformation(`Current safe-chain version: ${await getVersion()}`);
|
||||||
|
|
@ -88,7 +100,7 @@ function writeHelp() {
|
||||||
ui.writeInformation(
|
ui.writeInformation(
|
||||||
`Available commands: ${chalk.cyan("setup")}, ${chalk.cyan(
|
`Available commands: ${chalk.cyan("setup")}, ${chalk.cyan(
|
||||||
"teardown",
|
"teardown",
|
||||||
)}, ${chalk.cyan("setup-ci")}, ${chalk.cyan("help")}, ${chalk.cyan(
|
)}, ${chalk.cyan("setup-ci")}, ${chalk.cyan("get-install-dir")}, ${chalk.cyan("help")}, ${chalk.cyan(
|
||||||
"--version",
|
"--version",
|
||||||
)}`,
|
)}`,
|
||||||
);
|
);
|
||||||
|
|
@ -108,6 +120,11 @@ function writeHelp() {
|
||||||
"safe-chain setup-ci",
|
"safe-chain setup-ci",
|
||||||
)}: This will setup safe-chain for CI environments by creating shims and modifying the PATH.`,
|
)}: This will setup safe-chain for CI environments by creating shims and modifying the PATH.`,
|
||||||
);
|
);
|
||||||
|
ui.writeInformation(
|
||||||
|
`- ${chalk.cyan(
|
||||||
|
"safe-chain get-install-dir",
|
||||||
|
)}: Print the install directory for packaged safe-chain binaries.`,
|
||||||
|
);
|
||||||
ui.writeInformation(
|
ui.writeInformation(
|
||||||
`- ${chalk.cyan("safe-chain --version")} (or ${chalk.cyan(
|
`- ${chalk.cyan("safe-chain --version")} (or ${chalk.cyan(
|
||||||
"-v",
|
"-v",
|
||||||
|
|
|
||||||
|
|
@ -16,6 +16,7 @@
|
||||||
"aikido-bun": "bin/aikido-bun.js",
|
"aikido-bun": "bin/aikido-bun.js",
|
||||||
"aikido-bunx": "bin/aikido-bunx.js",
|
"aikido-bunx": "bin/aikido-bunx.js",
|
||||||
"aikido-uv": "bin/aikido-uv.js",
|
"aikido-uv": "bin/aikido-uv.js",
|
||||||
|
"aikido-uvx": "bin/aikido-uvx.js",
|
||||||
"aikido-pip": "bin/aikido-pip.js",
|
"aikido-pip": "bin/aikido-pip.js",
|
||||||
"aikido-pip3": "bin/aikido-pip3.js",
|
"aikido-pip3": "bin/aikido-pip3.js",
|
||||||
"aikido-python": "bin/aikido-python.js",
|
"aikido-python": "bin/aikido-python.js",
|
||||||
|
|
@ -36,9 +37,8 @@
|
||||||
"keywords": [],
|
"keywords": [],
|
||||||
"author": "Aikido Security",
|
"author": "Aikido Security",
|
||||||
"license": "AGPL-3.0-or-later",
|
"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), [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, uvx, or pip/pip3 from downloading or running the malware.",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"archiver": "^7.0.1",
|
|
||||||
"certifi": "14.5.15",
|
"certifi": "14.5.15",
|
||||||
"chalk": "5.4.1",
|
"chalk": "5.4.1",
|
||||||
"https-proxy-agent": "7.0.6",
|
"https-proxy-agent": "7.0.6",
|
||||||
|
|
@ -49,7 +49,6 @@
|
||||||
"semver": "7.7.2"
|
"semver": "7.7.2"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/archiver": "^7.0.0",
|
|
||||||
"@types/ini": "^4.1.1",
|
"@types/ini": "^4.1.1",
|
||||||
"@types/make-fetch-happen": "^10.0.4",
|
"@types/make-fetch-happen": "^10.0.4",
|
||||||
"@types/node": "^18.19.130",
|
"@types/node": "^18.19.130",
|
||||||
|
|
|
||||||
|
|
@ -3,14 +3,22 @@ import {
|
||||||
getEcoSystem,
|
getEcoSystem,
|
||||||
ECOSYSTEM_JS,
|
ECOSYSTEM_JS,
|
||||||
ECOSYSTEM_PY,
|
ECOSYSTEM_PY,
|
||||||
|
getMalwareListBaseUrl,
|
||||||
} from "../config/settings.js";
|
} from "../config/settings.js";
|
||||||
import { ui } from "../environment/userInteraction.js";
|
import { ui } from "../environment/userInteraction.js";
|
||||||
|
|
||||||
const malwareDatabaseUrls = {
|
const malwareDatabasePaths = {
|
||||||
[ECOSYSTEM_JS]: "https://malware-list.aikido.dev/malware_predictions.json",
|
[ECOSYSTEM_JS]: "malware_predictions.json",
|
||||||
[ECOSYSTEM_PY]: "https://malware-list.aikido.dev/malware_pypi.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
|
* @typedef {Object} MalwarePackage
|
||||||
* @property {string} package_name
|
* @property {string} package_name
|
||||||
|
|
@ -18,18 +26,26 @@ const malwareDatabaseUrls = {
|
||||||
* @property {string} reason
|
* @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}>}
|
* @returns {Promise<{malwareDatabase: MalwarePackage[], version: string | undefined}>}
|
||||||
*/
|
*/
|
||||||
export async function fetchMalwareDatabase() {
|
export async function fetchMalwareDatabase() {
|
||||||
const numberOfAttempts = 4;
|
|
||||||
|
|
||||||
return retry(async () => {
|
return retry(async () => {
|
||||||
const ecosystem = getEcoSystem();
|
const ecosystem = getEcoSystem();
|
||||||
const malwareDatabaseUrl =
|
const baseUrl = getMalwareListBaseUrl();
|
||||||
malwareDatabaseUrls[
|
const path = malwareDatabasePaths[
|
||||||
/** @type {keyof typeof malwareDatabaseUrls} */ (ecosystem)
|
/** @type {keyof typeof malwareDatabasePaths} */ (ecosystem)
|
||||||
];
|
];
|
||||||
|
const malwareDatabaseUrl = `${baseUrl}/${path}`;
|
||||||
const response = await fetch(malwareDatabaseUrl);
|
const response = await fetch(malwareDatabaseUrl);
|
||||||
if (!response.ok) {
|
if (!response.ok) {
|
||||||
throw new Error(
|
throw new Error(
|
||||||
|
|
@ -46,21 +62,20 @@ export async function fetchMalwareDatabase() {
|
||||||
} catch (/** @type {any} */ error) {
|
} catch (/** @type {any} */ error) {
|
||||||
throw new Error(`Error parsing malware database: ${error.message}`);
|
throw new Error(`Error parsing malware database: ${error.message}`);
|
||||||
}
|
}
|
||||||
}, numberOfAttempts);
|
}, DEFAULT_FETCH_RETRY_ATTEMPTS);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @returns {Promise<string | undefined>}
|
* @returns {Promise<string | undefined>}
|
||||||
*/
|
*/
|
||||||
export async function fetchMalwareDatabaseVersion() {
|
export async function fetchMalwareDatabaseVersion() {
|
||||||
const numberOfAttempts = 4;
|
|
||||||
|
|
||||||
return retry(async () => {
|
return retry(async () => {
|
||||||
const ecosystem = getEcoSystem();
|
const ecosystem = getEcoSystem();
|
||||||
const malwareDatabaseUrl =
|
const baseUrl = getMalwareListBaseUrl();
|
||||||
malwareDatabaseUrls[
|
const path = malwareDatabasePaths[
|
||||||
/** @type {keyof typeof malwareDatabaseUrls} */ (ecosystem)
|
/** @type {keyof typeof malwareDatabasePaths} */ (ecosystem)
|
||||||
];
|
];
|
||||||
|
const malwareDatabaseUrl = `${baseUrl}/${path}`;
|
||||||
const response = await fetch(malwareDatabaseUrl, {
|
const response = await fetch(malwareDatabaseUrl, {
|
||||||
method: "HEAD",
|
method: "HEAD",
|
||||||
});
|
});
|
||||||
|
|
@ -71,7 +86,67 @@ export async function fetchMalwareDatabaseVersion() {
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
return response.headers.get("etag") || undefined;
|
return response.headers.get("etag") || undefined;
|
||||||
}, numberOfAttempts);
|
}, 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<string | undefined>}
|
||||||
|
*/
|
||||||
|
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);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
@ -91,7 +166,7 @@ async function retry(func, attempts) {
|
||||||
return await func();
|
return await func();
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
ui.writeVerbose(
|
ui.writeVerbose(
|
||||||
"An error occurred while trying to download the Aikido Malware database",
|
"An error occurred while trying to download Aikido data",
|
||||||
error
|
error
|
||||||
);
|
);
|
||||||
lastError = error;
|
lastError = error;
|
||||||
|
|
|
||||||
|
|
@ -3,6 +3,7 @@ import assert from "node:assert";
|
||||||
|
|
||||||
describe("aikido API", async () => {
|
describe("aikido API", async () => {
|
||||||
const mockFetch = mock.fn();
|
const mockFetch = mock.fn();
|
||||||
|
let ecosystem = "js";
|
||||||
|
|
||||||
mock.module("make-fetch-happen", {
|
mock.module("make-fetch-happen", {
|
||||||
defaultExport: mockFetch,
|
defaultExport: mockFetch,
|
||||||
|
|
@ -18,17 +19,23 @@ describe("aikido API", async () => {
|
||||||
|
|
||||||
mock.module("../config/settings.js", {
|
mock.module("../config/settings.js", {
|
||||||
namedExports: {
|
namedExports: {
|
||||||
getEcoSystem: () => "js",
|
getEcoSystem: () => ecosystem,
|
||||||
ECOSYSTEM_JS: "js",
|
ECOSYSTEM_JS: "js",
|
||||||
ECOSYSTEM_PY: "py",
|
ECOSYSTEM_PY: "py",
|
||||||
|
getMalwareListBaseUrl: () => "https://malware-list.aikido.dev",
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
const { fetchMalwareDatabase, fetchMalwareDatabaseVersion } =
|
const {
|
||||||
await import("./aikido.js");
|
fetchMalwareDatabase,
|
||||||
|
fetchMalwareDatabaseVersion,
|
||||||
|
fetchNewPackagesList,
|
||||||
|
fetchNewPackagesListVersion,
|
||||||
|
} = await import("./aikido.js");
|
||||||
|
|
||||||
beforeEach(() => {
|
beforeEach(() => {
|
||||||
mockFetch.mock.resetCalls();
|
mockFetch.mock.resetCalls();
|
||||||
|
ecosystem = "js";
|
||||||
});
|
});
|
||||||
|
|
||||||
describe("fetchMalwareDatabase", () => {
|
describe("fetchMalwareDatabase", () => {
|
||||||
|
|
@ -130,4 +137,95 @@ describe("aikido API", async () => {
|
||||||
assert.strictEqual(result, '"final-etag"');
|
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);
|
||||||
|
});
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|
|
||||||
|
|
@ -1,12 +1,13 @@
|
||||||
import { ui } from "../environment/userInteraction.js";
|
import { ui } from "../environment/userInteraction.js";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @type {{loggingLevel: string | undefined, skipMinimumPackageAge: boolean | undefined, minimumPackageAgeHours: string | undefined}}
|
* @type {{loggingLevel: string | undefined, skipMinimumPackageAge: boolean | undefined, minimumPackageAgeHours: string | undefined, malwareListBaseUrl: string | undefined}}
|
||||||
*/
|
*/
|
||||||
const state = {
|
const state = {
|
||||||
loggingLevel: undefined,
|
loggingLevel: undefined,
|
||||||
skipMinimumPackageAge: undefined,
|
skipMinimumPackageAge: undefined,
|
||||||
minimumPackageAgeHours: undefined,
|
minimumPackageAgeHours: undefined,
|
||||||
|
malwareListBaseUrl: undefined,
|
||||||
};
|
};
|
||||||
|
|
||||||
const SAFE_CHAIN_ARG_PREFIX = "--safe-chain-";
|
const SAFE_CHAIN_ARG_PREFIX = "--safe-chain-";
|
||||||
|
|
@ -20,6 +21,7 @@ export function initializeCliArguments(args) {
|
||||||
state.loggingLevel = undefined;
|
state.loggingLevel = undefined;
|
||||||
state.skipMinimumPackageAge = undefined;
|
state.skipMinimumPackageAge = undefined;
|
||||||
state.minimumPackageAgeHours = undefined;
|
state.minimumPackageAgeHours = undefined;
|
||||||
|
state.malwareListBaseUrl = undefined;
|
||||||
|
|
||||||
const safeChainArgs = [];
|
const safeChainArgs = [];
|
||||||
const remainingArgs = [];
|
const remainingArgs = [];
|
||||||
|
|
@ -35,6 +37,7 @@ export function initializeCliArguments(args) {
|
||||||
setLoggingLevel(safeChainArgs);
|
setLoggingLevel(safeChainArgs);
|
||||||
setSkipMinimumPackageAge(safeChainArgs);
|
setSkipMinimumPackageAge(safeChainArgs);
|
||||||
setMinimumPackageAgeHours(safeChainArgs);
|
setMinimumPackageAgeHours(safeChainArgs);
|
||||||
|
setMalwareListBaseUrl(safeChainArgs);
|
||||||
checkDeprecatedPythonFlag(args);
|
checkDeprecatedPythonFlag(args);
|
||||||
return remainingArgs;
|
return remainingArgs;
|
||||||
}
|
}
|
||||||
|
|
@ -109,6 +112,26 @@ export function getMinimumPackageAgeHours() {
|
||||||
return state.minimumPackageAgeHours;
|
return state.minimumPackageAgeHours;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {string[]} args
|
||||||
|
* @returns {void}
|
||||||
|
*/
|
||||||
|
function setMalwareListBaseUrl(args) {
|
||||||
|
const argName = SAFE_CHAIN_ARG_PREFIX + "malware-list-base-url=";
|
||||||
|
|
||||||
|
const value = getLastArgEqualsValue(args, argName);
|
||||||
|
if (value) {
|
||||||
|
state.malwareListBaseUrl = value;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @returns {string | undefined}
|
||||||
|
*/
|
||||||
|
export function getMalwareListBaseUrl() {
|
||||||
|
return state.malwareListBaseUrl;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {string[]} args
|
* @param {string[]} args
|
||||||
* @param {string} flagName
|
* @param {string} flagName
|
||||||
|
|
|
||||||
|
|
@ -3,6 +3,7 @@ import path from "path";
|
||||||
import os from "os";
|
import os from "os";
|
||||||
import { ui } from "../environment/userInteraction.js";
|
import { ui } from "../environment/userInteraction.js";
|
||||||
import { getEcoSystem } from "./settings.js";
|
import { getEcoSystem } from "./settings.js";
|
||||||
|
import { getSafeChainBaseDir } from "./safeChainDir.js";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @typedef {Object} SafeChainConfig
|
* @typedef {Object} SafeChainConfig
|
||||||
|
|
@ -10,6 +11,7 @@ import { getEcoSystem } from "./settings.js";
|
||||||
* We cannot trust the input and should add the necessary validations
|
* We cannot trust the input and should add the necessary validations
|
||||||
* @property {unknown | Number} scanTimeout
|
* @property {unknown | Number} scanTimeout
|
||||||
* @property {unknown | Number} minimumPackageAgeHours
|
* @property {unknown | Number} minimumPackageAgeHours
|
||||||
|
* @property {unknown | string} malwareListBaseUrl
|
||||||
* @property {unknown | SafeChainRegistryConfiguration} npm
|
* @property {unknown | SafeChainRegistryConfiguration} npm
|
||||||
* @property {unknown | SafeChainRegistryConfiguration} pip
|
* @property {unknown | SafeChainRegistryConfiguration} pip
|
||||||
*
|
*
|
||||||
|
|
@ -84,6 +86,18 @@ export function getMinimumPackageAgeHours() {
|
||||||
return undefined;
|
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)
|
* Gets the custom npm registries from the config file (format parsing only, no validation)
|
||||||
* @returns {string[]}
|
* @returns {string[]}
|
||||||
|
|
@ -129,18 +143,21 @@ export function getPipCustomRegistries() {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets the minimum package age exclusions from the config file
|
* Gets the minimum package age exclusions from the config file for the current ecosystem
|
||||||
* @returns {string[]}
|
* @returns {string[]}
|
||||||
*/
|
*/
|
||||||
export function getNpmMinimumPackageAgeExclusions() {
|
export function getMinimumPackageAgeExclusions() {
|
||||||
const config = readConfigFile();
|
const config = readConfigFile();
|
||||||
|
const ecosystem = getEcoSystem();
|
||||||
|
const registryConfig = ecosystem === "py" ? config.pip : config.npm;
|
||||||
|
|
||||||
if (!config || !config.npm) {
|
if (!config || !registryConfig) {
|
||||||
return [];
|
return [];
|
||||||
}
|
}
|
||||||
|
|
||||||
const npmConfig = /** @type {SafeChainRegistryConfiguration} */ (config.npm);
|
const typedRegistryConfig =
|
||||||
const exclusions = npmConfig.minimumPackageAgeExclusions;
|
/** @type {SafeChainRegistryConfiguration} */ (registryConfig);
|
||||||
|
const exclusions = typedRegistryConfig.minimumPackageAgeExclusions;
|
||||||
|
|
||||||
if (!Array.isArray(exclusions)) {
|
if (!Array.isArray(exclusions)) {
|
||||||
return [];
|
return [];
|
||||||
|
|
@ -211,6 +228,7 @@ function readConfigFile() {
|
||||||
const emptyConfig = {
|
const emptyConfig = {
|
||||||
scanTimeout: undefined,
|
scanTimeout: undefined,
|
||||||
minimumPackageAgeHours: undefined,
|
minimumPackageAgeHours: undefined,
|
||||||
|
malwareListBaseUrl: undefined,
|
||||||
npm: {
|
npm: {
|
||||||
customRegistries: undefined,
|
customRegistries: undefined,
|
||||||
},
|
},
|
||||||
|
|
@ -248,11 +266,51 @@ function getDatabaseVersionPath() {
|
||||||
return path.join(aikidoDir, `version_${ecosystem}.txt`);
|
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}
|
* @returns {string}
|
||||||
*/
|
*/
|
||||||
function getConfigFilePath() {
|
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;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
||||||
|
|
@ -1,16 +1,35 @@
|
||||||
import { describe, it, beforeEach, afterEach, mock } from "node:test";
|
import { describe, it, beforeEach, afterEach, mock } from "node:test";
|
||||||
import assert from "node:assert";
|
import assert from "node:assert";
|
||||||
|
import os from "os";
|
||||||
|
import path from "path";
|
||||||
|
|
||||||
let configFileContent = undefined;
|
const safeChainConfigPath = path.join(os.homedir(), ".safe-chain", "config.json");
|
||||||
|
const aikidoConfigPath = path.join(os.homedir(), ".aikido", "config.json");
|
||||||
|
|
||||||
|
/** @type {Map<string, string>} */
|
||||||
|
let mockFiles = new Map();
|
||||||
mock.module("fs", {
|
mock.module("fs", {
|
||||||
namedExports: {
|
namedExports: {
|
||||||
existsSync: () => configFileContent !== undefined,
|
existsSync: (filePath) => mockFiles.has(filePath),
|
||||||
readFileSync: () => configFileContent,
|
readFileSync: (filePath) => {
|
||||||
writeFileSync: (content) => (configFileContent = content),
|
if (!mockFiles.has(filePath)) {
|
||||||
|
throw new Error(`ENOENT: no such file: ${filePath}`);
|
||||||
|
}
|
||||||
|
return mockFiles.get(filePath);
|
||||||
|
},
|
||||||
|
writeFileSync: (filePath, content) => mockFiles.set(filePath, content),
|
||||||
mkdirSync: () => {},
|
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 () => {
|
describe("getScanTimeout", async () => {
|
||||||
let originalEnv;
|
let originalEnv;
|
||||||
|
|
||||||
|
|
@ -29,12 +48,11 @@ describe("getScanTimeout", async () => {
|
||||||
delete process.env.AIKIDO_SCAN_TIMEOUT_MS;
|
delete process.env.AIKIDO_SCAN_TIMEOUT_MS;
|
||||||
}
|
}
|
||||||
|
|
||||||
configFileContent = undefined;
|
mockFiles.clear();
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should return default timeout of 10000ms when no config or env var is set", () => {
|
it("should return default timeout of 10000ms when no config or env var is set", () => {
|
||||||
delete process.env.AIKIDO_SCAN_TIMEOUT_MS;
|
delete process.env.AIKIDO_SCAN_TIMEOUT_MS;
|
||||||
configFileContent = undefined;
|
|
||||||
|
|
||||||
const timeout = getScanTimeout();
|
const timeout = getScanTimeout();
|
||||||
|
|
||||||
|
|
@ -43,7 +61,7 @@ describe("getScanTimeout", async () => {
|
||||||
|
|
||||||
it("should return timeout from config file when set", () => {
|
it("should return timeout from config file when set", () => {
|
||||||
delete process.env.AIKIDO_SCAN_TIMEOUT_MS;
|
delete process.env.AIKIDO_SCAN_TIMEOUT_MS;
|
||||||
configFileContent = JSON.stringify({ scanTimeout: 5000 });
|
setConfigContent(JSON.stringify({ scanTimeout: 5000 }));
|
||||||
|
|
||||||
const timeout = getScanTimeout();
|
const timeout = getScanTimeout();
|
||||||
|
|
||||||
|
|
@ -52,7 +70,7 @@ describe("getScanTimeout", async () => {
|
||||||
|
|
||||||
it("should prioritize environment variable over config file", () => {
|
it("should prioritize environment variable over config file", () => {
|
||||||
process.env.AIKIDO_SCAN_TIMEOUT_MS = "20000";
|
process.env.AIKIDO_SCAN_TIMEOUT_MS = "20000";
|
||||||
configFileContent = JSON.stringify({ scanTimeout: 5000 });
|
setConfigContent(JSON.stringify({ scanTimeout: 5000 }));
|
||||||
|
|
||||||
const timeout = getScanTimeout();
|
const timeout = getScanTimeout();
|
||||||
|
|
||||||
|
|
@ -61,7 +79,7 @@ describe("getScanTimeout", async () => {
|
||||||
|
|
||||||
it("should handle invalid environment variable and fall back to config", () => {
|
it("should handle invalid environment variable and fall back to config", () => {
|
||||||
process.env.AIKIDO_SCAN_TIMEOUT_MS = "invalid";
|
process.env.AIKIDO_SCAN_TIMEOUT_MS = "invalid";
|
||||||
configFileContent = JSON.stringify({ scanTimeout: 7000 });
|
setConfigContent(JSON.stringify({ scanTimeout: 7000 }));
|
||||||
|
|
||||||
const timeout = getScanTimeout();
|
const timeout = getScanTimeout();
|
||||||
|
|
||||||
|
|
@ -69,8 +87,6 @@ describe("getScanTimeout", async () => {
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should ignore zero and negative values and fall back to default", () => {
|
it("should ignore zero and negative values and fall back to default", () => {
|
||||||
configFileContent = undefined;
|
|
||||||
|
|
||||||
process.env.AIKIDO_SCAN_TIMEOUT_MS = "0";
|
process.env.AIKIDO_SCAN_TIMEOUT_MS = "0";
|
||||||
|
|
||||||
let timeout = getScanTimeout();
|
let timeout = getScanTimeout();
|
||||||
|
|
@ -84,7 +100,7 @@ describe("getScanTimeout", async () => {
|
||||||
|
|
||||||
it("should ignore textual non-numeric values in environment variable and fall back to config", () => {
|
it("should ignore textual non-numeric values in environment variable and fall back to config", () => {
|
||||||
process.env.AIKIDO_SCAN_TIMEOUT_MS = "fast";
|
process.env.AIKIDO_SCAN_TIMEOUT_MS = "fast";
|
||||||
configFileContent = JSON.stringify({ scanTimeout: 8000 });
|
setConfigContent(JSON.stringify({ scanTimeout: 8000 }));
|
||||||
|
|
||||||
const timeout = getScanTimeout();
|
const timeout = getScanTimeout();
|
||||||
|
|
||||||
|
|
@ -93,7 +109,7 @@ describe("getScanTimeout", async () => {
|
||||||
|
|
||||||
it("should ignore textual non-numeric values in config file and fall back to default", () => {
|
it("should ignore textual non-numeric values in config file and fall back to default", () => {
|
||||||
delete process.env.AIKIDO_SCAN_TIMEOUT_MS;
|
delete process.env.AIKIDO_SCAN_TIMEOUT_MS;
|
||||||
configFileContent = JSON.stringify({ scanTimeout: "slow" });
|
setConfigContent(JSON.stringify({ scanTimeout: "slow" }));
|
||||||
|
|
||||||
const timeout = getScanTimeout();
|
const timeout = getScanTimeout();
|
||||||
|
|
||||||
|
|
@ -102,7 +118,7 @@ describe("getScanTimeout", async () => {
|
||||||
|
|
||||||
it("should ignore textual non-numeric values in both env and config, fall back to default", () => {
|
it("should ignore textual non-numeric values in both env and config, fall back to default", () => {
|
||||||
process.env.AIKIDO_SCAN_TIMEOUT_MS = "quick";
|
process.env.AIKIDO_SCAN_TIMEOUT_MS = "quick";
|
||||||
configFileContent = JSON.stringify({ scanTimeout: "medium" });
|
setConfigContent(JSON.stringify({ scanTimeout: "medium" }));
|
||||||
|
|
||||||
const timeout = getScanTimeout();
|
const timeout = getScanTimeout();
|
||||||
|
|
||||||
|
|
@ -111,7 +127,7 @@ describe("getScanTimeout", async () => {
|
||||||
|
|
||||||
it("should ignore mixed alphanumeric strings in environment variable", () => {
|
it("should ignore mixed alphanumeric strings in environment variable", () => {
|
||||||
process.env.AIKIDO_SCAN_TIMEOUT_MS = "5000ms";
|
process.env.AIKIDO_SCAN_TIMEOUT_MS = "5000ms";
|
||||||
configFileContent = JSON.stringify({ scanTimeout: 6000 });
|
setConfigContent(JSON.stringify({ scanTimeout: 6000 }));
|
||||||
|
|
||||||
const timeout = getScanTimeout();
|
const timeout = getScanTimeout();
|
||||||
|
|
||||||
|
|
@ -120,7 +136,7 @@ describe("getScanTimeout", async () => {
|
||||||
|
|
||||||
it("should ignore mixed alphanumeric strings in config file", () => {
|
it("should ignore mixed alphanumeric strings in config file", () => {
|
||||||
delete process.env.AIKIDO_SCAN_TIMEOUT_MS;
|
delete process.env.AIKIDO_SCAN_TIMEOUT_MS;
|
||||||
configFileContent = JSON.stringify({ scanTimeout: "3000ms" });
|
setConfigContent(JSON.stringify({ scanTimeout: "3000ms" }));
|
||||||
|
|
||||||
const timeout = getScanTimeout();
|
const timeout = getScanTimeout();
|
||||||
|
|
||||||
|
|
@ -132,19 +148,17 @@ describe("getMinimumPackageAgeHours", async () => {
|
||||||
const { getMinimumPackageAgeHours } = await import("./configFile.js");
|
const { getMinimumPackageAgeHours } = await import("./configFile.js");
|
||||||
|
|
||||||
afterEach(() => {
|
afterEach(() => {
|
||||||
configFileContent = undefined;
|
mockFiles.clear();
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should return null when config file doesn't exist", () => {
|
it("should return null when config file doesn't exist", () => {
|
||||||
configFileContent = undefined;
|
|
||||||
|
|
||||||
const hours = getMinimumPackageAgeHours();
|
const hours = getMinimumPackageAgeHours();
|
||||||
|
|
||||||
assert.strictEqual(hours, undefined);
|
assert.strictEqual(hours, undefined);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should return null when config file exists but minimumPackageAgeHours is not set", () => {
|
it("should return null when config file exists but minimumPackageAgeHours is not set", () => {
|
||||||
configFileContent = JSON.stringify({ scanTimeout: 5000 });
|
setConfigContent(JSON.stringify({ scanTimeout: 5000 }));
|
||||||
|
|
||||||
const hours = getMinimumPackageAgeHours();
|
const hours = getMinimumPackageAgeHours();
|
||||||
|
|
||||||
|
|
@ -152,7 +166,7 @@ describe("getMinimumPackageAgeHours", async () => {
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should return value from config file when set to valid number", () => {
|
it("should return value from config file when set to valid number", () => {
|
||||||
configFileContent = JSON.stringify({ minimumPackageAgeHours: 48 });
|
setConfigContent(JSON.stringify({ minimumPackageAgeHours: 48 }));
|
||||||
|
|
||||||
const hours = getMinimumPackageAgeHours();
|
const hours = getMinimumPackageAgeHours();
|
||||||
|
|
||||||
|
|
@ -160,7 +174,7 @@ describe("getMinimumPackageAgeHours", async () => {
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should handle string numbers in config file", () => {
|
it("should handle string numbers in config file", () => {
|
||||||
configFileContent = JSON.stringify({ minimumPackageAgeHours: "72" });
|
setConfigContent(JSON.stringify({ minimumPackageAgeHours: "72" }));
|
||||||
|
|
||||||
const hours = getMinimumPackageAgeHours();
|
const hours = getMinimumPackageAgeHours();
|
||||||
|
|
||||||
|
|
@ -168,7 +182,7 @@ describe("getMinimumPackageAgeHours", async () => {
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should handle decimal values", () => {
|
it("should handle decimal values", () => {
|
||||||
configFileContent = JSON.stringify({ minimumPackageAgeHours: 1.5 });
|
setConfigContent(JSON.stringify({ minimumPackageAgeHours: 1.5 }));
|
||||||
|
|
||||||
const hours = getMinimumPackageAgeHours();
|
const hours = getMinimumPackageAgeHours();
|
||||||
|
|
||||||
|
|
@ -176,7 +190,7 @@ describe("getMinimumPackageAgeHours", async () => {
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should return null for non-numeric strings", () => {
|
it("should return null for non-numeric strings", () => {
|
||||||
configFileContent = JSON.stringify({ minimumPackageAgeHours: "invalid" });
|
setConfigContent(JSON.stringify({ minimumPackageAgeHours: "invalid" }));
|
||||||
|
|
||||||
const hours = getMinimumPackageAgeHours();
|
const hours = getMinimumPackageAgeHours();
|
||||||
|
|
||||||
|
|
@ -184,7 +198,7 @@ describe("getMinimumPackageAgeHours", async () => {
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should return undefined for values with units suffix", () => {
|
it("should return undefined for values with units suffix", () => {
|
||||||
configFileContent = JSON.stringify({ minimumPackageAgeHours: "48h" });
|
setConfigContent(JSON.stringify({ minimumPackageAgeHours: "48h" }));
|
||||||
|
|
||||||
const hours = getMinimumPackageAgeHours();
|
const hours = getMinimumPackageAgeHours();
|
||||||
|
|
||||||
|
|
@ -192,7 +206,7 @@ describe("getMinimumPackageAgeHours", async () => {
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should handle malformed JSON and return null", () => {
|
it("should handle malformed JSON and return null", () => {
|
||||||
configFileContent = "{ invalid json";
|
setConfigContent("{ invalid json");
|
||||||
|
|
||||||
const hours = getMinimumPackageAgeHours();
|
const hours = getMinimumPackageAgeHours();
|
||||||
|
|
||||||
|
|
@ -200,7 +214,7 @@ describe("getMinimumPackageAgeHours", async () => {
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should return 0 when minimumPackageAgeHours is set to 0", () => {
|
it("should return 0 when minimumPackageAgeHours is set to 0", () => {
|
||||||
configFileContent = JSON.stringify({ minimumPackageAgeHours: 0 });
|
setConfigContent(JSON.stringify({ minimumPackageAgeHours: 0 }));
|
||||||
|
|
||||||
const hours = getMinimumPackageAgeHours();
|
const hours = getMinimumPackageAgeHours();
|
||||||
|
|
||||||
|
|
@ -208,7 +222,7 @@ describe("getMinimumPackageAgeHours", async () => {
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should return 0 when minimumPackageAgeHours is set to string '0'", () => {
|
it("should return 0 when minimumPackageAgeHours is set to string '0'", () => {
|
||||||
configFileContent = JSON.stringify({ minimumPackageAgeHours: "0" });
|
setConfigContent(JSON.stringify({ minimumPackageAgeHours: "0" }));
|
||||||
|
|
||||||
const hours = getMinimumPackageAgeHours();
|
const hours = getMinimumPackageAgeHours();
|
||||||
|
|
||||||
|
|
@ -216,7 +230,7 @@ describe("getMinimumPackageAgeHours", async () => {
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should handle negative numeric values", () => {
|
it("should handle negative numeric values", () => {
|
||||||
configFileContent = JSON.stringify({ minimumPackageAgeHours: -24 });
|
setConfigContent(JSON.stringify({ minimumPackageAgeHours: -24 }));
|
||||||
|
|
||||||
const hours = getMinimumPackageAgeHours();
|
const hours = getMinimumPackageAgeHours();
|
||||||
|
|
||||||
|
|
@ -224,7 +238,7 @@ describe("getMinimumPackageAgeHours", async () => {
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should handle negative string values", () => {
|
it("should handle negative string values", () => {
|
||||||
configFileContent = JSON.stringify({ minimumPackageAgeHours: "-48" });
|
setConfigContent(JSON.stringify({ minimumPackageAgeHours: "-48" }));
|
||||||
|
|
||||||
const hours = getMinimumPackageAgeHours();
|
const hours = getMinimumPackageAgeHours();
|
||||||
|
|
||||||
|
|
@ -249,19 +263,17 @@ for (const { packageManager, getCustomRegistries } of [
|
||||||
{
|
{
|
||||||
describe(getCustomRegistries.name, async () => {
|
describe(getCustomRegistries.name, async () => {
|
||||||
afterEach(() => {
|
afterEach(() => {
|
||||||
configFileContent = undefined;
|
mockFiles.clear();
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should return empty array when config file doesn't exist", () => {
|
it("should return empty array when config file doesn't exist", () => {
|
||||||
configFileContent = undefined;
|
|
||||||
|
|
||||||
const registries = getCustomRegistries();
|
const registries = getCustomRegistries();
|
||||||
|
|
||||||
assert.deepStrictEqual(registries, []);
|
assert.deepStrictEqual(registries, []);
|
||||||
});
|
});
|
||||||
|
|
||||||
it(`should return empty array when ${packageManager} config is not set`, () => {
|
it(`should return empty array when ${packageManager} config is not set`, () => {
|
||||||
configFileContent = JSON.stringify({ scanTimeout: 5000 });
|
setConfigContent(JSON.stringify({ scanTimeout: 5000 }));
|
||||||
|
|
||||||
const registries = getCustomRegistries();
|
const registries = getCustomRegistries();
|
||||||
|
|
||||||
|
|
@ -269,9 +281,9 @@ for (const { packageManager, getCustomRegistries } of [
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should return empty array when customRegistries is not an array", () => {
|
it("should return empty array when customRegistries is not an array", () => {
|
||||||
configFileContent = JSON.stringify({
|
setConfigContent(JSON.stringify({
|
||||||
[packageManager]: { customRegistries: "not-an-array" },
|
[packageManager]: { customRegistries: "not-an-array" },
|
||||||
});
|
}));
|
||||||
|
|
||||||
const registries = getCustomRegistries();
|
const registries = getCustomRegistries();
|
||||||
|
|
||||||
|
|
@ -279,11 +291,11 @@ for (const { packageManager, getCustomRegistries } of [
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should return array of custom registries when set", () => {
|
it("should return array of custom registries when set", () => {
|
||||||
configFileContent = JSON.stringify({
|
setConfigContent(JSON.stringify({
|
||||||
[packageManager]: {
|
[packageManager]: {
|
||||||
customRegistries: [`${packageManager}.company.com`, "registry.internal.net"],
|
customRegistries: [`${packageManager}.company.com`, "registry.internal.net"],
|
||||||
},
|
},
|
||||||
});
|
}));
|
||||||
|
|
||||||
const registries = getCustomRegistries();
|
const registries = getCustomRegistries();
|
||||||
|
|
||||||
|
|
@ -294,7 +306,7 @@ for (const { packageManager, getCustomRegistries } of [
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should filter out non-string values", () => {
|
it("should filter out non-string values", () => {
|
||||||
configFileContent = JSON.stringify({
|
setConfigContent(JSON.stringify({
|
||||||
[packageManager]: {
|
[packageManager]: {
|
||||||
customRegistries: [
|
customRegistries: [
|
||||||
`${packageManager}.company.com`,
|
`${packageManager}.company.com`,
|
||||||
|
|
@ -305,7 +317,7 @@ for (const { packageManager, getCustomRegistries } of [
|
||||||
{},
|
{},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
});
|
}));
|
||||||
|
|
||||||
const registries = getCustomRegistries();
|
const registries = getCustomRegistries();
|
||||||
|
|
||||||
|
|
@ -316,9 +328,9 @@ for (const { packageManager, getCustomRegistries } of [
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should return empty array for empty customRegistries array", () => {
|
it("should return empty array for empty customRegistries array", () => {
|
||||||
configFileContent = JSON.stringify({
|
setConfigContent(JSON.stringify({
|
||||||
[packageManager]: { customRegistries: [] },
|
[packageManager]: { customRegistries: [] },
|
||||||
});
|
}));
|
||||||
|
|
||||||
const registries = getCustomRegistries();
|
const registries = getCustomRegistries();
|
||||||
|
|
||||||
|
|
@ -326,7 +338,7 @@ for (const { packageManager, getCustomRegistries } of [
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should handle malformed JSON and return empty array", () => {
|
it("should handle malformed JSON and return empty array", () => {
|
||||||
configFileContent = "{ invalid json";
|
setConfigContent("{ invalid json");
|
||||||
|
|
||||||
const registries = getCustomRegistries();
|
const registries = getCustomRegistries();
|
||||||
|
|
||||||
|
|
@ -334,3 +346,35 @@ for (const { packageManager, getCustomRegistries } of [
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
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);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
|
||||||
|
|
@ -41,6 +41,17 @@ export function getLoggingLevel() {
|
||||||
* Example: "react,@aikidosec/safe-chain,lodash"
|
* Example: "react,@aikidosec/safe-chain,lodash"
|
||||||
* @returns {string | undefined}
|
* @returns {string | undefined}
|
||||||
*/
|
*/
|
||||||
export function getNpmMinimumPackageAgeExclusions() {
|
export function getMinimumPackageAgeExclusions() {
|
||||||
return process.env.SAFE_CHAIN_NPM_MINIMUM_PACKAGE_AGE_EXCLUSIONS;
|
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;
|
||||||
}
|
}
|
||||||
|
|
|
||||||
71
packages/safe-chain/src/config/safeChainDir.js
Normal file
71
packages/safe-chain/src/config/safeChainDir.js
Normal file
|
|
@ -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);
|
||||||
|
}
|
||||||
|
|
@ -1,6 +1,7 @@
|
||||||
import * as cliArguments from "./cliArguments.js";
|
import * as cliArguments from "./cliArguments.js";
|
||||||
import * as configFile from "./configFile.js";
|
import * as configFile from "./configFile.js";
|
||||||
import * as environmentVariables from "./environmentVariables.js";
|
import * as environmentVariables from "./environmentVariables.js";
|
||||||
|
import { ui } from "../environment/userInteraction.js";
|
||||||
|
|
||||||
export const LOGGING_SILENT = "silent";
|
export const LOGGING_SILENT = "silent";
|
||||||
export const LOGGING_NORMAL = "normal";
|
export const LOGGING_NORMAL = "normal";
|
||||||
|
|
@ -45,7 +46,7 @@ export function setEcoSystem(setting) {
|
||||||
ecosystemSettings.ecoSystem = setting;
|
ecosystemSettings.ecoSystem = setting;
|
||||||
}
|
}
|
||||||
|
|
||||||
const defaultMinimumPackageAge = 24;
|
const defaultMinimumPackageAge = 48;
|
||||||
/** @returns {number} */
|
/** @returns {number} */
|
||||||
export function getMinimumPackageAgeHours() {
|
export function getMinimumPackageAgeHours() {
|
||||||
// Priority 1: CLI argument
|
// Priority 1: CLI argument
|
||||||
|
|
@ -188,13 +189,59 @@ function parseExclusionsFromEnv(envValue) {
|
||||||
* Gets the minimum package age exclusions from both environment variable and config file (merged)
|
* Gets the minimum package age exclusions from both environment variable and config file (merged)
|
||||||
* @returns {string[]}
|
* @returns {string[]}
|
||||||
*/
|
*/
|
||||||
export function getNpmMinimumPackageAgeExclusions() {
|
export function getMinimumPackageAgeExclusions() {
|
||||||
const envExclusions = parseExclusionsFromEnv(
|
const envExclusions = parseExclusionsFromEnv(
|
||||||
environmentVariables.getNpmMinimumPackageAgeExclusions()
|
environmentVariables.getMinimumPackageAgeExclusions()
|
||||||
);
|
);
|
||||||
const configExclusions = configFile.getNpmMinimumPackageAgeExclusions();
|
const configExclusions = configFile.getMinimumPackageAgeExclusions();
|
||||||
|
|
||||||
// Merge both sources and remove duplicates
|
// Merge both sources and remove duplicates
|
||||||
const allExclusions = [...envExclusions, ...configExclusions];
|
const allExclusions = [...envExclusions, ...configExclusions];
|
||||||
return [...new Set(allExclusions)];
|
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(/\/+$/, "");
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -14,7 +14,11 @@ mock.module("fs", {
|
||||||
const {
|
const {
|
||||||
getNpmCustomRegistries,
|
getNpmCustomRegistries,
|
||||||
getPipCustomRegistries,
|
getPipCustomRegistries,
|
||||||
getNpmMinimumPackageAgeExclusions,
|
getMinimumPackageAgeExclusions,
|
||||||
|
getMalwareListBaseUrl,
|
||||||
|
setEcoSystem,
|
||||||
|
ECOSYSTEM_JS,
|
||||||
|
ECOSYSTEM_PY,
|
||||||
getLoggingLevel,
|
getLoggingLevel,
|
||||||
LOGGING_SILENT,
|
LOGGING_SILENT,
|
||||||
LOGGING_NORMAL,
|
LOGGING_NORMAL,
|
||||||
|
|
@ -367,13 +371,18 @@ describe("getLoggingLevel", () => {
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
describe("getNpmMinimumPackageAgeExclusions", () => {
|
describe("getMinimumPackageAgeExclusions", () => {
|
||||||
let originalEnv;
|
let originalEnv;
|
||||||
const envVarName = "SAFE_CHAIN_NPM_MINIMUM_PACKAGE_AGE_EXCLUSIONS";
|
let originalLegacyEnv;
|
||||||
|
const envVarName = "SAFE_CHAIN_MINIMUM_PACKAGE_AGE_EXCLUSIONS";
|
||||||
|
const legacyEnvVarName = "SAFE_CHAIN_NPM_MINIMUM_PACKAGE_AGE_EXCLUSIONS";
|
||||||
|
|
||||||
beforeEach(() => {
|
beforeEach(() => {
|
||||||
originalEnv = process.env[envVarName];
|
originalEnv = process.env[envVarName];
|
||||||
|
originalLegacyEnv = process.env[legacyEnvVarName];
|
||||||
delete process.env[envVarName];
|
delete process.env[envVarName];
|
||||||
|
delete process.env[legacyEnvVarName];
|
||||||
|
setEcoSystem(ECOSYSTEM_JS);
|
||||||
});
|
});
|
||||||
|
|
||||||
afterEach(() => {
|
afterEach(() => {
|
||||||
|
|
@ -382,13 +391,18 @@ describe("getNpmMinimumPackageAgeExclusions", () => {
|
||||||
} else {
|
} else {
|
||||||
delete process.env[envVarName];
|
delete process.env[envVarName];
|
||||||
}
|
}
|
||||||
|
if (originalLegacyEnv !== undefined) {
|
||||||
|
process.env[legacyEnvVarName] = originalLegacyEnv;
|
||||||
|
} else {
|
||||||
|
delete process.env[legacyEnvVarName];
|
||||||
|
}
|
||||||
configFileContent = undefined;
|
configFileContent = undefined;
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should return empty array when no exclusions configured", () => {
|
it("should return empty array when no exclusions configured", () => {
|
||||||
configFileContent = undefined;
|
configFileContent = undefined;
|
||||||
|
|
||||||
const exclusions = getNpmMinimumPackageAgeExclusions();
|
const exclusions = getMinimumPackageAgeExclusions();
|
||||||
|
|
||||||
assert.deepStrictEqual(exclusions, []);
|
assert.deepStrictEqual(exclusions, []);
|
||||||
});
|
});
|
||||||
|
|
@ -400,7 +414,7 @@ describe("getNpmMinimumPackageAgeExclusions", () => {
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
const exclusions = getNpmMinimumPackageAgeExclusions();
|
const exclusions = getMinimumPackageAgeExclusions();
|
||||||
|
|
||||||
assert.deepStrictEqual(exclusions, ["react", "@aikidosec/safe-chain"]);
|
assert.deepStrictEqual(exclusions, ["react", "@aikidosec/safe-chain"]);
|
||||||
});
|
});
|
||||||
|
|
@ -409,7 +423,7 @@ describe("getNpmMinimumPackageAgeExclusions", () => {
|
||||||
process.env[envVarName] = "lodash,express,@types/node";
|
process.env[envVarName] = "lodash,express,@types/node";
|
||||||
configFileContent = undefined;
|
configFileContent = undefined;
|
||||||
|
|
||||||
const exclusions = getNpmMinimumPackageAgeExclusions();
|
const exclusions = getMinimumPackageAgeExclusions();
|
||||||
|
|
||||||
assert.deepStrictEqual(exclusions, ["lodash", "express", "@types/node"]);
|
assert.deepStrictEqual(exclusions, ["lodash", "express", "@types/node"]);
|
||||||
});
|
});
|
||||||
|
|
@ -422,7 +436,7 @@ describe("getNpmMinimumPackageAgeExclusions", () => {
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
const exclusions = getNpmMinimumPackageAgeExclusions();
|
const exclusions = getMinimumPackageAgeExclusions();
|
||||||
|
|
||||||
assert.deepStrictEqual(exclusions, ["lodash", "react"]);
|
assert.deepStrictEqual(exclusions, ["lodash", "react"]);
|
||||||
});
|
});
|
||||||
|
|
@ -435,7 +449,7 @@ describe("getNpmMinimumPackageAgeExclusions", () => {
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
const exclusions = getNpmMinimumPackageAgeExclusions();
|
const exclusions = getMinimumPackageAgeExclusions();
|
||||||
|
|
||||||
assert.deepStrictEqual(exclusions, ["lodash", "react", "express"]);
|
assert.deepStrictEqual(exclusions, ["lodash", "react", "express"]);
|
||||||
});
|
});
|
||||||
|
|
@ -444,7 +458,7 @@ describe("getNpmMinimumPackageAgeExclusions", () => {
|
||||||
process.env[envVarName] = " lodash , react ";
|
process.env[envVarName] = " lodash , react ";
|
||||||
configFileContent = undefined;
|
configFileContent = undefined;
|
||||||
|
|
||||||
const exclusions = getNpmMinimumPackageAgeExclusions();
|
const exclusions = getMinimumPackageAgeExclusions();
|
||||||
|
|
||||||
assert.deepStrictEqual(exclusions, ["lodash", "react"]);
|
assert.deepStrictEqual(exclusions, ["lodash", "react"]);
|
||||||
});
|
});
|
||||||
|
|
@ -456,7 +470,7 @@ describe("getNpmMinimumPackageAgeExclusions", () => {
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
const exclusions = getNpmMinimumPackageAgeExclusions();
|
const exclusions = getMinimumPackageAgeExclusions();
|
||||||
|
|
||||||
assert.deepStrictEqual(exclusions, ["@babel/core", "@types/react"]);
|
assert.deepStrictEqual(exclusions, ["@babel/core", "@types/react"]);
|
||||||
});
|
});
|
||||||
|
|
@ -465,7 +479,7 @@ describe("getNpmMinimumPackageAgeExclusions", () => {
|
||||||
process.env[envVarName] = "lodash,,react,";
|
process.env[envVarName] = "lodash,,react,";
|
||||||
configFileContent = undefined;
|
configFileContent = undefined;
|
||||||
|
|
||||||
const exclusions = getNpmMinimumPackageAgeExclusions();
|
const exclusions = getMinimumPackageAgeExclusions();
|
||||||
|
|
||||||
assert.deepStrictEqual(exclusions, ["lodash", "react"]);
|
assert.deepStrictEqual(exclusions, ["lodash", "react"]);
|
||||||
});
|
});
|
||||||
|
|
@ -474,7 +488,7 @@ describe("getNpmMinimumPackageAgeExclusions", () => {
|
||||||
process.env[envVarName] = "";
|
process.env[envVarName] = "";
|
||||||
configFileContent = undefined;
|
configFileContent = undefined;
|
||||||
|
|
||||||
const exclusions = getNpmMinimumPackageAgeExclusions();
|
const exclusions = getMinimumPackageAgeExclusions();
|
||||||
|
|
||||||
assert.deepStrictEqual(exclusions, []);
|
assert.deepStrictEqual(exclusions, []);
|
||||||
});
|
});
|
||||||
|
|
@ -483,7 +497,7 @@ describe("getNpmMinimumPackageAgeExclusions", () => {
|
||||||
process.env[envVarName] = " , , ";
|
process.env[envVarName] = " , , ";
|
||||||
configFileContent = undefined;
|
configFileContent = undefined;
|
||||||
|
|
||||||
const exclusions = getNpmMinimumPackageAgeExclusions();
|
const exclusions = getMinimumPackageAgeExclusions();
|
||||||
|
|
||||||
assert.deepStrictEqual(exclusions, []);
|
assert.deepStrictEqual(exclusions, []);
|
||||||
});
|
});
|
||||||
|
|
@ -495,8 +509,139 @@ describe("getNpmMinimumPackageAgeExclusions", () => {
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
const exclusions = getNpmMinimumPackageAgeExclusions();
|
const exclusions = getMinimumPackageAgeExclusions();
|
||||||
|
|
||||||
assert.deepStrictEqual(exclusions, ["react", "lodash"]);
|
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");
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|
|
||||||
42
packages/safe-chain/src/installLocation.js
Normal file
42
packages/safe-chain/src/installLocation.js
Normal file
|
|
@ -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,
|
||||||
|
);
|
||||||
|
}
|
||||||
51
packages/safe-chain/src/installLocation.spec.js
Normal file
51
packages/safe-chain/src/installLocation.spec.js
Normal file
|
|
@ -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",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
@ -1,125 +0,0 @@
|
||||||
import { createWriteStream, createReadStream } from "fs";
|
|
||||||
import { createHash } from "crypto";
|
|
||||||
import { pipeline } from "stream/promises";
|
|
||||||
import fetch from "make-fetch-happen";
|
|
||||||
|
|
||||||
const ULTIMATE_VERSION = "v1.0.0";
|
|
||||||
|
|
||||||
export const DOWNLOAD_URLS = {
|
|
||||||
win32: {
|
|
||||||
x64: {
|
|
||||||
url: `https://github.com/AikidoSec/safechain-internals/releases/download/${ULTIMATE_VERSION}/SafeChainUltimate-windows-amd64.msi`,
|
|
||||||
checksum:
|
|
||||||
"sha256:c6a36f9b8e55ab6b7e8742cbabc4469d85809237c0f5e6c21af20b36c416ee1d",
|
|
||||||
},
|
|
||||||
arm64: {
|
|
||||||
url: `https://github.com/AikidoSec/safechain-internals/releases/download/${ULTIMATE_VERSION}/SafeChainUltimate-windows-arm64.msi`,
|
|
||||||
checksum:
|
|
||||||
"sha256:46acd1af6a9938ea194c8ee8b34ca9b47c8de22e088a0791f3c0751dd6239c90",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
darwin: {
|
|
||||||
x64: {
|
|
||||||
url: `https://github.com/AikidoSec/safechain-internals/releases/download/${ULTIMATE_VERSION}/SafeChainUltimate-darwin-amd64.pkg`,
|
|
||||||
checksum:
|
|
||||||
"sha256:bb1829e8ca422e885baf37bef08dcbe7df7a30f248e2e89c4071564f7d4f3396",
|
|
||||||
},
|
|
||||||
arm64: {
|
|
||||||
url: `https://github.com/AikidoSec/safechain-internals/releases/download/${ULTIMATE_VERSION}/SafeChainUltimate-darwin-arm64.pkg`,
|
|
||||||
checksum:
|
|
||||||
"sha256:7fe4a785709911cc366d8224b4c290677573b8c4833bd9054768299e55c5f0ed",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Builds the download URL for the SafeChain Agent installer.
|
|
||||||
* @param {string} fileName
|
|
||||||
*/
|
|
||||||
export function getAgentDownloadUrl(fileName) {
|
|
||||||
return `https://github.com/AikidoSec/safechain-internals/releases/download/${ULTIMATE_VERSION}/${fileName}`;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Downloads a file from a URL to a local path.
|
|
||||||
* @param {string} url
|
|
||||||
* @param {string} destPath
|
|
||||||
*/
|
|
||||||
export async function downloadFile(url, destPath) {
|
|
||||||
const response = await fetch(url);
|
|
||||||
if (!response.ok) {
|
|
||||||
throw new Error(`Download failed: ${response.statusText}`);
|
|
||||||
}
|
|
||||||
await pipeline(response.body, createWriteStream(destPath));
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the current agent version.
|
|
||||||
*/
|
|
||||||
export function getAgentVersion() {
|
|
||||||
return ULTIMATE_VERSION;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns download info (url, checksum) for the current OS and architecture.
|
|
||||||
* @returns {{ url: string, checksum: string } | null}
|
|
||||||
*/
|
|
||||||
export function getDownloadInfoForCurrentPlatform() {
|
|
||||||
const platform = process.platform;
|
|
||||||
const arch = process.arch;
|
|
||||||
|
|
||||||
if (!Object.hasOwn(DOWNLOAD_URLS, platform)) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
const platformUrls =
|
|
||||||
DOWNLOAD_URLS[/** @type {keyof typeof DOWNLOAD_URLS} */ (platform)];
|
|
||||||
|
|
||||||
if (!Object.hasOwn(platformUrls, arch)) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
return platformUrls[/** @type {keyof typeof platformUrls} */ (arch)];
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Verifies the checksum of a file.
|
|
||||||
* @param {string} filePath
|
|
||||||
* @param {string} expectedChecksum - Format: "algorithm:hash" (e.g., "sha256:abc123...")
|
|
||||||
* @returns {Promise<boolean>}
|
|
||||||
*/
|
|
||||||
export async function verifyChecksum(filePath, expectedChecksum) {
|
|
||||||
const [algorithm, expected] = expectedChecksum.split(":");
|
|
||||||
|
|
||||||
const hash = createHash(algorithm);
|
|
||||||
|
|
||||||
if (filePath.includes("..")) throw new Error("Invalid file path");
|
|
||||||
const stream = createReadStream(filePath);
|
|
||||||
|
|
||||||
for await (const chunk of stream) {
|
|
||||||
hash.update(chunk);
|
|
||||||
}
|
|
||||||
|
|
||||||
const actual = hash.digest("hex");
|
|
||||||
return actual === expected;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Downloads the SafeChain agent for the current OS/arch and verifies its checksum.
|
|
||||||
* @param {string} fileName - Destination file path
|
|
||||||
* @returns {Promise<string | null>} The file path if successful, null if no download URL for current platform
|
|
||||||
*/
|
|
||||||
export async function downloadAgentToFile(fileName) {
|
|
||||||
const info = getDownloadInfoForCurrentPlatform();
|
|
||||||
if (!info) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
await downloadFile(info.url, fileName);
|
|
||||||
|
|
||||||
const isValid = await verifyChecksum(fileName, info.checksum);
|
|
||||||
if (!isValid) {
|
|
||||||
throw new Error("Checksum verification failed");
|
|
||||||
}
|
|
||||||
|
|
||||||
return fileName;
|
|
||||||
}
|
|
||||||
|
|
@ -1,45 +0,0 @@
|
||||||
import { describe, it, after } from "node:test";
|
|
||||||
import assert from "node:assert";
|
|
||||||
import { tmpdir } from "node:os";
|
|
||||||
import { join } from "node:path";
|
|
||||||
import { unlinkSync } from "node:fs";
|
|
||||||
import {
|
|
||||||
DOWNLOAD_URLS,
|
|
||||||
downloadFile,
|
|
||||||
verifyChecksum,
|
|
||||||
} from "./downloadAgent.js";
|
|
||||||
|
|
||||||
describe("downloadAgent checksums", { timeout: 120_000 }, () => {
|
|
||||||
const downloadedFiles = [];
|
|
||||||
|
|
||||||
after(() => {
|
|
||||||
for (const file of downloadedFiles) {
|
|
||||||
try {
|
|
||||||
unlinkSync(file);
|
|
||||||
} catch {
|
|
||||||
// ignore cleanup errors
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
for (const [platform, architectures] of Object.entries(DOWNLOAD_URLS)) {
|
|
||||||
for (const [arch, { url, checksum }] of Object.entries(architectures)) {
|
|
||||||
it(`${platform}/${arch} checksum matches`, async () => {
|
|
||||||
const destPath = join(
|
|
||||||
tmpdir(),
|
|
||||||
`safe-chain-test-${platform}-${arch}-${Date.now()}`
|
|
||||||
);
|
|
||||||
downloadedFiles.push(destPath);
|
|
||||||
|
|
||||||
await downloadFile(url, destPath);
|
|
||||||
|
|
||||||
const isValid = await verifyChecksum(destPath, checksum);
|
|
||||||
assert.strictEqual(
|
|
||||||
isValid,
|
|
||||||
true,
|
|
||||||
`Checksum mismatch for ${platform}/${arch} (${url})`
|
|
||||||
);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
@ -1,155 +0,0 @@
|
||||||
import { tmpdir } from "os";
|
|
||||||
import { unlinkSync } from "fs";
|
|
||||||
import { join } from "path";
|
|
||||||
import { execSync, spawnSync } from "child_process";
|
|
||||||
import { ui } from "../environment/userInteraction.js";
|
|
||||||
import { printVerboseAndSafeSpawn } from "../utils/safeSpawn.js";
|
|
||||||
import { downloadAgentToFile, getAgentVersion } from "./downloadAgent.js";
|
|
||||||
import chalk from "chalk";
|
|
||||||
|
|
||||||
const MACOS_PKG_IDENTIFIER = "com.aikidosecurity.safechainultimate";
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Checks if root privileges are available and displays error message if not.
|
|
||||||
* @param {string} command - The sudo command to show in the error message
|
|
||||||
* @returns {boolean} True if running as root, false otherwise.
|
|
||||||
*/
|
|
||||||
function requireRootPrivileges(command) {
|
|
||||||
if (isRunningAsRoot()) {
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
ui.writeError("Root privileges required.");
|
|
||||||
ui.writeInformation("Please run this command with sudo:");
|
|
||||||
ui.writeInformation(` ${command}`);
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
function isRunningAsRoot() {
|
|
||||||
const rootUserUid = 0;
|
|
||||||
return process.getuid?.() === rootUserUid;
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function installOnMacOS() {
|
|
||||||
if (!requireRootPrivileges("sudo safe-chain ultimate")) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const pkgPath = join(tmpdir(), `SafeChainUltimate-${Date.now()}.pkg`);
|
|
||||||
|
|
||||||
ui.emptyLine();
|
|
||||||
ui.writeInformation(`📥 Downloading SafeChain Ultimate ${getAgentVersion()}`);
|
|
||||||
ui.writeVerbose(`Destination: ${pkgPath}`);
|
|
||||||
|
|
||||||
const result = await downloadAgentToFile(pkgPath);
|
|
||||||
if (!result) {
|
|
||||||
ui.writeError("No download available for this platform/architecture.");
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
|
||||||
ui.writeInformation("⚙️ Installing SafeChain Ultimate...");
|
|
||||||
await runPkgInstaller(pkgPath);
|
|
||||||
|
|
||||||
ui.emptyLine();
|
|
||||||
ui.writeInformation(
|
|
||||||
"✅ SafeChain Ultimate installed and started successfully!",
|
|
||||||
);
|
|
||||||
ui.emptyLine();
|
|
||||||
ui.writeInformation(
|
|
||||||
chalk.cyan("🔐 ") +
|
|
||||||
chalk.bold("ACTION REQUIRED: ") +
|
|
||||||
"macOS will show a popup to install our certificate.",
|
|
||||||
);
|
|
||||||
ui.writeInformation(
|
|
||||||
" " +
|
|
||||||
chalk.bold("Please accept the certificate") +
|
|
||||||
" to complete the installation.",
|
|
||||||
);
|
|
||||||
ui.emptyLine();
|
|
||||||
} finally {
|
|
||||||
ui.writeVerbose(`Cleaning up temporary file: ${pkgPath}`);
|
|
||||||
cleanup(pkgPath);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const MACOS_UNINSTALL_SCRIPT =
|
|
||||||
"/Library/Application\\ Support/AikidoSecurity/SafeChainUltimate/scripts/uninstall";
|
|
||||||
|
|
||||||
export async function uninstallOnMacOS() {
|
|
||||||
if (!requireRootPrivileges("sudo safe-chain ultimate uninstall")) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
ui.emptyLine();
|
|
||||||
|
|
||||||
if (!isPackageInstalled()) {
|
|
||||||
ui.writeInformation("SafeChain Ultimate is not installed.");
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
ui.writeInformation("🗑️ Uninstalling SafeChain Ultimate...");
|
|
||||||
ui.writeVerbose(`Running: ${MACOS_UNINSTALL_SCRIPT}`);
|
|
||||||
|
|
||||||
const result = spawnSync(MACOS_UNINSTALL_SCRIPT, {
|
|
||||||
stdio: "inherit",
|
|
||||||
shell: true,
|
|
||||||
});
|
|
||||||
|
|
||||||
if (result.status !== 0) {
|
|
||||||
ui.writeError(
|
|
||||||
`Uninstall script failed (exit code: ${result.status}). Please try again or remove manually.`,
|
|
||||||
);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
ui.emptyLine();
|
|
||||||
ui.writeInformation("✅ SafeChain Ultimate has been uninstalled.");
|
|
||||||
ui.emptyLine();
|
|
||||||
}
|
|
||||||
|
|
||||||
function isPackageInstalled() {
|
|
||||||
try {
|
|
||||||
const output = execSync(`pkgutil --pkg-info ${MACOS_PKG_IDENTIFIER}`, {
|
|
||||||
encoding: "utf8",
|
|
||||||
stdio: "pipe",
|
|
||||||
});
|
|
||||||
return output.includes(MACOS_PKG_IDENTIFIER);
|
|
||||||
} catch {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {string} pkgPath
|
|
||||||
*/
|
|
||||||
async function runPkgInstaller(pkgPath) {
|
|
||||||
// Uses installer to install the package (https://ss64.com/mac/installer.html)
|
|
||||||
// Options:
|
|
||||||
// -pkg (required): The package to be installed.
|
|
||||||
// -target (required): The target volume is specified with the -target parameter.
|
|
||||||
// --> "-target /" installs to the current boot volume.
|
|
||||||
|
|
||||||
const result = await printVerboseAndSafeSpawn(
|
|
||||||
"installer",
|
|
||||||
["-pkg", pkgPath, "-target", "/"],
|
|
||||||
{
|
|
||||||
stdio: "inherit",
|
|
||||||
},
|
|
||||||
);
|
|
||||||
|
|
||||||
if (result.status !== 0) {
|
|
||||||
throw new Error(`PKG installer failed (exit code: ${result.status})`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {string} pkgPath
|
|
||||||
*/
|
|
||||||
function cleanup(pkgPath) {
|
|
||||||
try {
|
|
||||||
unlinkSync(pkgPath);
|
|
||||||
} catch {
|
|
||||||
ui.writeVerbose("Failed to clean up temporary installer file.");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,203 +0,0 @@
|
||||||
import { tmpdir } from "os";
|
|
||||||
import { unlinkSync } from "fs";
|
|
||||||
import { join } from "path";
|
|
||||||
import { execSync } from "child_process";
|
|
||||||
import { ui } from "../environment/userInteraction.js";
|
|
||||||
import { printVerboseAndSafeSpawn, safeSpawn } from "../utils/safeSpawn.js";
|
|
||||||
import { downloadAgentToFile, getAgentVersion } from "./downloadAgent.js";
|
|
||||||
|
|
||||||
const WINDOWS_SERVICE_NAME = "SafeChainUltimate";
|
|
||||||
const WINDOWS_APP_NAME = "SafeChain Ultimate";
|
|
||||||
|
|
||||||
export async function uninstallOnWindows() {
|
|
||||||
if (!(await requireAdminPrivileges())) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
ui.emptyLine();
|
|
||||||
|
|
||||||
const productCode = getInstalledProductCode();
|
|
||||||
if (!productCode) {
|
|
||||||
ui.writeInformation("SafeChain Ultimate is not installed.");
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
await stopServiceIfRunning();
|
|
||||||
|
|
||||||
ui.writeInformation("🗑️ Uninstalling SafeChain Ultimate...");
|
|
||||||
await uninstallByProductCode(productCode);
|
|
||||||
|
|
||||||
ui.emptyLine();
|
|
||||||
ui.writeInformation("✅ SafeChain Ultimate has been uninstalled.");
|
|
||||||
ui.emptyLine();
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function installOnWindows() {
|
|
||||||
if (!(await requireAdminPrivileges())) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const msiPath = join(tmpdir(), `SafeChainUltimate-${Date.now()}.msi`);
|
|
||||||
|
|
||||||
ui.emptyLine();
|
|
||||||
ui.writeInformation(`📥 Downloading SafeChain Ultimate ${getAgentVersion()}`);
|
|
||||||
ui.writeVerbose(`Destination: ${msiPath}`);
|
|
||||||
|
|
||||||
const result = await downloadAgentToFile(msiPath);
|
|
||||||
if (!result) {
|
|
||||||
ui.writeError("No download available for this platform/architecture.");
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
|
||||||
ui.emptyLine();
|
|
||||||
await stopServiceIfRunning();
|
|
||||||
await uninstallIfInstalled();
|
|
||||||
|
|
||||||
ui.writeInformation("⚙️ Installing SafeChain Ultimate...");
|
|
||||||
await runMsiInstaller(msiPath);
|
|
||||||
|
|
||||||
ui.emptyLine();
|
|
||||||
ui.writeInformation(
|
|
||||||
"✅ SafeChain Ultimate installed and started successfully!",
|
|
||||||
);
|
|
||||||
ui.emptyLine();
|
|
||||||
} finally {
|
|
||||||
ui.writeVerbose(`Cleaning up temporary file: ${msiPath}`);
|
|
||||||
cleanup(msiPath);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Checks if admin privileges are available and displays error message if not.
|
|
||||||
* @returns {Promise<boolean>} True if running as admin, false otherwise.
|
|
||||||
*/
|
|
||||||
async function requireAdminPrivileges() {
|
|
||||||
if (await isRunningAsAdmin()) {
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
ui.writeError("Administrator privileges required.");
|
|
||||||
ui.writeInformation(
|
|
||||||
"Please run this command in an elevated terminal (Run as Administrator).",
|
|
||||||
);
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
async function isRunningAsAdmin() {
|
|
||||||
// Uses Windows Security API to check if current process has admin privileges.
|
|
||||||
// Returns "True" or "False" as a string.
|
|
||||||
const result = await safeSpawn(
|
|
||||||
"powershell",
|
|
||||||
[
|
|
||||||
"-Command",
|
|
||||||
"([Security.Principal.WindowsPrincipal][Security.Principal.WindowsIdentity]::GetCurrent()).IsInRole([Security.Principal.WindowsBuiltInRole]::Administrator)",
|
|
||||||
],
|
|
||||||
{ stdio: "pipe" },
|
|
||||||
);
|
|
||||||
|
|
||||||
return result.status === 0 && result.stdout.trim() === "True";
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the MSI product code for SafeChain Ultimate, or null if not installed.
|
|
||||||
* @returns {string | null}
|
|
||||||
*/
|
|
||||||
function getInstalledProductCode() {
|
|
||||||
// Query Win32_Product via WMI to find the installed SafeChain Agent.
|
|
||||||
// If found, outputs the product GUID (e.g., "{12345678-1234-...}") needed for msiexec uninstall.
|
|
||||||
ui.writeVerbose(`Finding product code with PowerShell`);
|
|
||||||
|
|
||||||
let productCode;
|
|
||||||
try {
|
|
||||||
productCode = execSync(
|
|
||||||
`powershell -Command "$app = Get-WmiObject -Class Win32_Product -Filter \\"Name='${WINDOWS_APP_NAME}'\\"; if ($app) { Write-Output $app.IdentifyingNumber }"`,
|
|
||||||
{ encoding: "utf8" },
|
|
||||||
).trim();
|
|
||||||
} catch {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
return productCode || null;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {string} productCode
|
|
||||||
*/
|
|
||||||
async function uninstallByProductCode(productCode) {
|
|
||||||
ui.writeVerbose(`Found product code: ${productCode}`);
|
|
||||||
|
|
||||||
// Use msiexec to run the msi installer quitely (https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/msiexec)
|
|
||||||
// Options:
|
|
||||||
// - /x: Uninstalls the package.
|
|
||||||
// - /qn: Specifies there's no UI during the installation process.
|
|
||||||
// - /norestart: Stops the device from restarting after the installation completes.
|
|
||||||
const uninstallResult = await printVerboseAndSafeSpawn(
|
|
||||||
"msiexec",
|
|
||||||
["/x", productCode, "/qn", "/norestart"],
|
|
||||||
{ stdio: "inherit" },
|
|
||||||
);
|
|
||||||
|
|
||||||
if (uninstallResult.status !== 0) {
|
|
||||||
throw new Error(`Uninstall failed (exit code: ${uninstallResult.status})`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async function uninstallIfInstalled() {
|
|
||||||
const productCode = getInstalledProductCode();
|
|
||||||
if (!productCode) {
|
|
||||||
ui.writeVerbose("No existing installation found (fresh install).");
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
ui.writeInformation("🗑️ Removing previous installation...");
|
|
||||||
await uninstallByProductCode(productCode);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {string} msiPath
|
|
||||||
*/
|
|
||||||
async function runMsiInstaller(msiPath) {
|
|
||||||
// Use msiexec to run the msi installer quitely (https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/msiexec)
|
|
||||||
// Options:
|
|
||||||
// - /i: Specifies normal installation
|
|
||||||
// - /qn: Specifies there's no UI during the installation process.
|
|
||||||
|
|
||||||
const result = await printVerboseAndSafeSpawn(
|
|
||||||
"msiexec",
|
|
||||||
["/i", msiPath, "/qn"],
|
|
||||||
{
|
|
||||||
stdio: "inherit",
|
|
||||||
},
|
|
||||||
);
|
|
||||||
|
|
||||||
if (result.status !== 0) {
|
|
||||||
throw new Error(`MSI installer failed (exit code: ${result.status})`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async function stopServiceIfRunning() {
|
|
||||||
ui.writeInformation("⏹️ Stopping running service...");
|
|
||||||
|
|
||||||
const result = await printVerboseAndSafeSpawn(
|
|
||||||
"net",
|
|
||||||
["stop", WINDOWS_SERVICE_NAME],
|
|
||||||
{
|
|
||||||
stdio: "pipe",
|
|
||||||
},
|
|
||||||
);
|
|
||||||
|
|
||||||
if (result.status !== 0) {
|
|
||||||
ui.writeVerbose("Service not running (will start after installation).");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {string} msiPath
|
|
||||||
*/
|
|
||||||
function cleanup(msiPath) {
|
|
||||||
try {
|
|
||||||
unlinkSync(msiPath);
|
|
||||||
} catch {
|
|
||||||
ui.writeVerbose("Failed to clean up temporary installer file.");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,35 +0,0 @@
|
||||||
import { platform } from "os";
|
|
||||||
import { ui } from "../environment/userInteraction.js";
|
|
||||||
import { initializeCliArguments } from "../config/cliArguments.js";
|
|
||||||
import { installOnWindows, uninstallOnWindows } from "./installOnWindows.js";
|
|
||||||
import { installOnMacOS, uninstallOnMacOS } from "./installOnMacOS.js";
|
|
||||||
|
|
||||||
export async function uninstallUltimate() {
|
|
||||||
initializeCliArguments(process.argv);
|
|
||||||
|
|
||||||
const operatingSystem = platform();
|
|
||||||
|
|
||||||
if (operatingSystem === "win32") {
|
|
||||||
await uninstallOnWindows();
|
|
||||||
} else if (operatingSystem === "darwin") {
|
|
||||||
await uninstallOnMacOS();
|
|
||||||
} else {
|
|
||||||
ui.writeInformation(
|
|
||||||
`Uninstall is not yet supported on ${operatingSystem}.`,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function installUltimate() {
|
|
||||||
const operatingSystem = platform();
|
|
||||||
|
|
||||||
if (operatingSystem === "win32") {
|
|
||||||
await installOnWindows();
|
|
||||||
} else if (operatingSystem === "darwin") {
|
|
||||||
await installOnMacOS();
|
|
||||||
} else {
|
|
||||||
ui.writeInformation(
|
|
||||||
`${operatingSystem} is not supported yet by SafeChain's ultimate version.`,
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -20,8 +20,10 @@ export async function main(args) {
|
||||||
process.on("SIGINT", handleProcessTermination);
|
process.on("SIGINT", handleProcessTermination);
|
||||||
process.on("SIGTERM", handleProcessTermination);
|
process.on("SIGTERM", handleProcessTermination);
|
||||||
|
|
||||||
/** @type {import("./registryProxy/registryProxy.js").MalwareBlockedEvent[]} */
|
/** @type {import("./registryProxy/registryProxy.js").PackageBlockedEvent[]} */
|
||||||
let malwareBlockedEvents = [];
|
let malwareBlockedEvents = [];
|
||||||
|
/** @type {import("./registryProxy/registryProxy.js").PackageBlockedEvent[]} */
|
||||||
|
let minPackageAgeBlocks = [];
|
||||||
|
|
||||||
/** @type {import("./registryProxy/registryProxy.js").MinPackageAgeSuppressionEvent[]} */
|
/** @type {import("./registryProxy/registryProxy.js").MinPackageAgeSuppressionEvent[]} */
|
||||||
let suppressedVersionEvents = [];
|
let suppressedVersionEvents = [];
|
||||||
|
|
@ -32,6 +34,9 @@ export async function main(args) {
|
||||||
proxy.addListener("minPackageAgeVersionsSuppressed", (ev) =>
|
proxy.addListener("minPackageAgeVersionsSuppressed", (ev) =>
|
||||||
suppressedVersionEvents.push(ev),
|
suppressedVersionEvents.push(ev),
|
||||||
);
|
);
|
||||||
|
proxy.addListener("minimumAgeRequestBlocked", (ev) =>
|
||||||
|
minPackageAgeBlocks.push(ev),
|
||||||
|
);
|
||||||
|
|
||||||
// Global error handlers to log unhandled errors
|
// Global error handlers to log unhandled errors
|
||||||
process.on("uncaughtException", (error) => {
|
process.on("uncaughtException", (error) => {
|
||||||
|
|
@ -79,6 +84,11 @@ export async function main(args) {
|
||||||
return 1;
|
return 1;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (minPackageAgeBlocks.length > 0) {
|
||||||
|
printMinPackageAgeBlocks(minPackageAgeBlocks);
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
|
||||||
const auditStats = getAuditStats();
|
const auditStats = getAuditStats();
|
||||||
if (auditStats.totalPackages > 0) {
|
if (auditStats.totalPackages > 0) {
|
||||||
ui.writeVerbose(
|
ui.writeVerbose(
|
||||||
|
|
@ -122,7 +132,7 @@ function isSafeChainVerify(args) {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
* @param {import("./registryProxy/registryProxy.js").MalwareBlockedEvent[]} malwareBlockedEvents
|
* @param {import("./registryProxy/registryProxy.js").PackageBlockedEvent[]} malwareBlockedEvents
|
||||||
*/
|
*/
|
||||||
function printBlockedMalware(malwareBlockedEvents) {
|
function printBlockedMalware(malwareBlockedEvents) {
|
||||||
ui.emptyLine();
|
ui.emptyLine();
|
||||||
|
|
@ -142,6 +152,36 @@ function printBlockedMalware(malwareBlockedEvents) {
|
||||||
ui.emptyLine();
|
ui.emptyLine();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* @param {import("./registryProxy/registryProxy.js").PackageBlockedEvent[]} minPackageAgeBlocks
|
||||||
|
*/
|
||||||
|
function printMinPackageAgeBlocks(minPackageAgeBlocks) {
|
||||||
|
ui.emptyLine();
|
||||||
|
|
||||||
|
ui.writeInformation(
|
||||||
|
`Safe-chain: ${chalk.bold(
|
||||||
|
`blocked ${minPackageAgeBlocks.length} direct package download request(s) due to minimum package age`,
|
||||||
|
)}:`,
|
||||||
|
);
|
||||||
|
|
||||||
|
for (const req of minPackageAgeBlocks) {
|
||||||
|
ui.writeInformation(` - ${req.packageName}@${req.packageVersion}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
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();
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
* @param {import("./registryProxy/registryProxy.js").MinPackageAgeSuppressionEvent[]} minPackageAgeSuppressionEvents
|
* @param {import("./registryProxy/registryProxy.js").MinPackageAgeSuppressionEvent[]} minPackageAgeSuppressionEvents
|
||||||
|
|
@ -150,7 +190,7 @@ function printSuppressedVersions(minPackageAgeSuppressionEvents) {
|
||||||
ui.writeVerbose(
|
ui.writeVerbose(
|
||||||
`${chalk.yellow(
|
`${chalk.yellow(
|
||||||
"ℹ",
|
"ℹ",
|
||||||
)} Safe-chain: Suppressed package versions due to minimum age requirement:`,
|
)} Safe-chain: Some package versions were suppressed during package metadata resolution due to minimum package age:`,
|
||||||
);
|
);
|
||||||
|
|
||||||
for (const ev of minPackageAgeSuppressionEvents) {
|
for (const ev of minPackageAgeSuppressionEvents) {
|
||||||
|
|
|
||||||
|
|
@ -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 };
|
||||||
|
}
|
||||||
|
|
@ -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?",
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
import { ui } from "../../environment/userInteraction.js";
|
|
||||||
import { safeSpawn } from "../../utils/safeSpawn.js";
|
import { safeSpawn } from "../../utils/safeSpawn.js";
|
||||||
import { mergeSafeChainProxyEnvironmentVariables } from "../../registryProxy/registryProxy.js";
|
import { mergeSafeChainProxyEnvironmentVariables } from "../../registryProxy/registryProxy.js";
|
||||||
|
import { reportCommandExecutionFailure } from "../_shared/commandErrors.js";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @returns {import("../currentPackageManager.js").PackageManager}
|
* @returns {import("../currentPackageManager.js").PackageManager}
|
||||||
|
|
@ -43,11 +43,6 @@ async function runBunCommand(command, args) {
|
||||||
});
|
});
|
||||||
return { status: result.status };
|
return { status: result.status };
|
||||||
} catch (/** @type any */ error) {
|
} catch (/** @type any */ error) {
|
||||||
if (error.status) {
|
return reportCommandExecutionFailure(error, command);
|
||||||
return { status: error.status };
|
|
||||||
} else {
|
|
||||||
ui.writeError("Error executing command:", error.message);
|
|
||||||
return { status: 1 };
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -13,6 +13,7 @@ import { createPipPackageManager } from "./pip/createPackageManager.js";
|
||||||
import { createUvPackageManager } from "./uv/createUvPackageManager.js";
|
import { createUvPackageManager } from "./uv/createUvPackageManager.js";
|
||||||
import { createPoetryPackageManager } from "./poetry/createPoetryPackageManager.js";
|
import { createPoetryPackageManager } from "./poetry/createPoetryPackageManager.js";
|
||||||
import { createPipXPackageManager } from "./pipx/createPipXPackageManager.js";
|
import { createPipXPackageManager } from "./pipx/createPipXPackageManager.js";
|
||||||
|
import { createUvxPackageManager } from "./uvx/createUvxPackageManager.js";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @type {{packageManagerName: PackageManager | null}}
|
* @type {{packageManagerName: PackageManager | null}}
|
||||||
|
|
@ -60,6 +61,8 @@ export function initializePackageManager(packageManagerName, context) {
|
||||||
state.packageManagerName = createPipPackageManager(context);
|
state.packageManagerName = createPipPackageManager(context);
|
||||||
} else if (packageManagerName === "uv") {
|
} else if (packageManagerName === "uv") {
|
||||||
state.packageManagerName = createUvPackageManager();
|
state.packageManagerName = createUvPackageManager();
|
||||||
|
} else if (packageManagerName === "uvx") {
|
||||||
|
state.packageManagerName = createUvxPackageManager();
|
||||||
} else if (packageManagerName === "poetry") {
|
} else if (packageManagerName === "poetry") {
|
||||||
state.packageManagerName = createPoetryPackageManager();
|
state.packageManagerName = createPoetryPackageManager();
|
||||||
} else if (packageManagerName === "pipx") {
|
} else if (packageManagerName === "pipx") {
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
import { ui } from "../../environment/userInteraction.js";
|
|
||||||
import { safeSpawn } from "../../utils/safeSpawn.js";
|
import { safeSpawn } from "../../utils/safeSpawn.js";
|
||||||
import { mergeSafeChainProxyEnvironmentVariables } from "../../registryProxy/registryProxy.js";
|
import { mergeSafeChainProxyEnvironmentVariables } from "../../registryProxy/registryProxy.js";
|
||||||
|
import { reportCommandExecutionFailure } from "../_shared/commandErrors.js";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {string[]} args
|
* @param {string[]} args
|
||||||
|
|
@ -15,11 +15,6 @@ export async function runNpm(args) {
|
||||||
});
|
});
|
||||||
return { status: result.status };
|
return { status: result.status };
|
||||||
} catch (/** @type any */ error) {
|
} catch (/** @type any */ error) {
|
||||||
if (error.status) {
|
return reportCommandExecutionFailure(error, "npm");
|
||||||
return { status: error.status };
|
|
||||||
} else {
|
|
||||||
ui.writeError("Error executing command:", error.message);
|
|
||||||
return { status: 1 };
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
import { ui } from "../../environment/userInteraction.js";
|
|
||||||
import { safeSpawn } from "../../utils/safeSpawn.js";
|
import { safeSpawn } from "../../utils/safeSpawn.js";
|
||||||
import { mergeSafeChainProxyEnvironmentVariables } from "../../registryProxy/registryProxy.js";
|
import { mergeSafeChainProxyEnvironmentVariables } from "../../registryProxy/registryProxy.js";
|
||||||
|
import { reportCommandExecutionFailure } from "../_shared/commandErrors.js";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {string[]} args
|
* @param {string[]} args
|
||||||
|
|
@ -15,11 +15,6 @@ export async function runNpx(args) {
|
||||||
});
|
});
|
||||||
return { status: result.status };
|
return { status: result.status };
|
||||||
} catch (/** @type any */ error) {
|
} catch (/** @type any */ error) {
|
||||||
if (error.status) {
|
return reportCommandExecutionFailure(error, "npx");
|
||||||
return { status: error.status };
|
|
||||||
} else {
|
|
||||||
ui.writeError("Error executing command:", error.message);
|
|
||||||
return { status: 1 };
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -11,6 +11,7 @@ import os from "node:os";
|
||||||
import path from "node:path";
|
import path from "node:path";
|
||||||
import ini from "ini";
|
import ini from "ini";
|
||||||
import { spawn } from "child_process";
|
import { spawn } from "child_process";
|
||||||
|
import { reportCommandExecutionFailure } from "../_shared/commandErrors.js";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Checks if this pip invocation should bypass safe-chain and spawn directly.
|
* Checks if this pip invocation should bypass safe-chain and spawn directly.
|
||||||
|
|
@ -205,12 +206,6 @@ export async function runPip(command, args) {
|
||||||
|
|
||||||
return { status: result.status };
|
return { status: result.status };
|
||||||
} catch (/** @type any */ error) {
|
} catch (/** @type any */ error) {
|
||||||
if (error.status) {
|
return reportCommandExecutionFailure(error, command);
|
||||||
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 };
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -4,6 +4,7 @@ import {
|
||||||
getProxySettings,
|
getProxySettings,
|
||||||
mergeSafeChainProxyEnvironmentVariables,
|
mergeSafeChainProxyEnvironmentVariables,
|
||||||
} from "../../registryProxy/registryProxy.js";
|
} from "../../registryProxy/registryProxy.js";
|
||||||
|
import { reportCommandExecutionFailure } from "../_shared/commandErrors.js";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sets CA bundle environment variables used by Python libraries and pipx.
|
* Sets CA bundle environment variables used by Python libraries and pipx.
|
||||||
|
|
@ -56,12 +57,6 @@ export async function runPipX(command, args) {
|
||||||
|
|
||||||
return { status: result.status };
|
return { status: result.status };
|
||||||
} catch (/** @type any */ error) {
|
} catch (/** @type any */ error) {
|
||||||
if (error.status) {
|
return reportCommandExecutionFailure(error, command);
|
||||||
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 };
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
import { ui } from "../../environment/userInteraction.js";
|
|
||||||
import { mergeSafeChainProxyEnvironmentVariables } from "../../registryProxy/registryProxy.js";
|
import { mergeSafeChainProxyEnvironmentVariables } from "../../registryProxy/registryProxy.js";
|
||||||
import { safeSpawn } from "../../utils/safeSpawn.js";
|
import { safeSpawn } from "../../utils/safeSpawn.js";
|
||||||
|
import { reportCommandExecutionFailure } from "../_shared/commandErrors.js";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {string[]} args
|
* @param {string[]} args
|
||||||
|
|
@ -26,11 +26,7 @@ export async function runPnpmCommand(args, toolName = "pnpm") {
|
||||||
|
|
||||||
return { status: result.status };
|
return { status: result.status };
|
||||||
} catch (/** @type any */ error) {
|
} catch (/** @type any */ error) {
|
||||||
if (error.status) {
|
const target = toolName === "pnpm" ? "pnpm" : "pnpx";
|
||||||
return { status: error.status };
|
return reportCommandExecutionFailure(error, target);
|
||||||
} else {
|
|
||||||
ui.writeError("Error executing command:", error.message);
|
|
||||||
return { status: 1 };
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -4,6 +4,7 @@ import {
|
||||||
getProxySettings,
|
getProxySettings,
|
||||||
mergeSafeChainProxyEnvironmentVariables,
|
mergeSafeChainProxyEnvironmentVariables,
|
||||||
} from "../../registryProxy/registryProxy.js";
|
} from "../../registryProxy/registryProxy.js";
|
||||||
|
import { reportCommandExecutionFailure } from "../_shared/commandErrors.js";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @returns {import("../currentPackageManager.js").PackageManager}
|
* @returns {import("../currentPackageManager.js").PackageManager}
|
||||||
|
|
@ -68,12 +69,6 @@ async function runPoetryCommand(args) {
|
||||||
|
|
||||||
return { status: result.status };
|
return { status: result.status };
|
||||||
} catch (/** @type any */ error) {
|
} catch (/** @type any */ error) {
|
||||||
if (error.status) {
|
return reportCommandExecutionFailure(error, "poetry");
|
||||||
return { status: error.status };
|
|
||||||
} else {
|
|
||||||
ui.writeError("Error executing command:", error.message);
|
|
||||||
ui.writeError("Is 'poetry' installed and available on your system?");
|
|
||||||
return { status: 1 };
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -4,6 +4,7 @@ import {
|
||||||
getProxySettings,
|
getProxySettings,
|
||||||
mergeSafeChainProxyEnvironmentVariables,
|
mergeSafeChainProxyEnvironmentVariables,
|
||||||
} from "../../registryProxy/registryProxy.js";
|
} from "../../registryProxy/registryProxy.js";
|
||||||
|
import { reportCommandExecutionFailure } from "../_shared/commandErrors.js";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sets CA bundle environment variables used by Python libraries and uv.
|
* Sets CA bundle environment variables used by Python libraries and uv.
|
||||||
|
|
@ -62,12 +63,6 @@ export async function runUv(command, args) {
|
||||||
|
|
||||||
return { status: result.status };
|
return { status: result.status };
|
||||||
} catch (/** @type any */ error) {
|
} catch (/** @type any */ error) {
|
||||||
if (error.status) {
|
return reportCommandExecutionFailure(error, command);
|
||||||
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 };
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -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: () => [],
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
@ -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(), []);
|
||||||
|
});
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
import { ui } from "../../environment/userInteraction.js";
|
|
||||||
import { safeSpawn } from "../../utils/safeSpawn.js";
|
import { safeSpawn } from "../../utils/safeSpawn.js";
|
||||||
import { mergeSafeChainProxyEnvironmentVariables } from "../../registryProxy/registryProxy.js";
|
import { mergeSafeChainProxyEnvironmentVariables } from "../../registryProxy/registryProxy.js";
|
||||||
|
import { reportCommandExecutionFailure } from "../_shared/commandErrors.js";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {string[]} args
|
* @param {string[]} args
|
||||||
|
|
@ -18,12 +18,7 @@ export async function runYarnCommand(args) {
|
||||||
});
|
});
|
||||||
return { status: result.status };
|
return { status: result.status };
|
||||||
} catch (/** @type any */ error) {
|
} catch (/** @type any */ error) {
|
||||||
if (error.status) {
|
return reportCommandExecutionFailure(error, "yarn");
|
||||||
return { status: error.status };
|
|
||||||
} else {
|
|
||||||
ui.writeError("Error executing command:", error.message);
|
|
||||||
return { status: 1 };
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,9 +1,8 @@
|
||||||
import forge from "node-forge";
|
import forge from "node-forge";
|
||||||
import path from "path";
|
import path from "path";
|
||||||
import fs from "fs";
|
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 ca = loadCa();
|
||||||
|
|
||||||
const certCache = new Map();
|
const certCache = new Map();
|
||||||
|
|
@ -20,7 +19,7 @@ function createKeyIdentifier(publicKey) {
|
||||||
}
|
}
|
||||||
|
|
||||||
export function getCaCertPath() {
|
export function getCaCertPath() {
|
||||||
return path.join(certFolder, "ca-cert.pem");
|
return path.join(getCertsDir(), "ca-cert.pem");
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
@ -112,6 +111,7 @@ export function generateCertForHost(hostname) {
|
||||||
}
|
}
|
||||||
|
|
||||||
function loadCa() {
|
function loadCa() {
|
||||||
|
const certFolder = getCertsDir();
|
||||||
const keyPath = path.join(certFolder, "ca-key.pem");
|
const keyPath = path.join(certFolder, "ca-key.pem");
|
||||||
const certPath = path.join(certFolder, "ca-cert.pem");
|
const certPath = path.join(certFolder, "ca-cert.pem");
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -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",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
@ -8,6 +8,8 @@ import { getCaCertPath } from "./certUtils.js";
|
||||||
import { readFileSync } from "fs";
|
import { readFileSync } from "fs";
|
||||||
import EventEmitter from "events";
|
import EventEmitter from "events";
|
||||||
import { modifyResponseEventEmitter } from "./interceptors/npm/modifyNpmInfo.js";
|
import { modifyResponseEventEmitter } from "./interceptors/npm/modifyNpmInfo.js";
|
||||||
|
import { cleanupCertBundle } from "../certBundle.js";
|
||||||
|
import { getHasSuppressedVersions } from "./interceptors/suppressedVersionsState.js";
|
||||||
|
|
||||||
/** *
|
/** *
|
||||||
* @returns {import("../registryProxy.js").SafeChainProxy} */
|
* @returns {import("../registryProxy.js").SafeChainProxy} */
|
||||||
|
|
@ -50,8 +52,11 @@ export function createBuiltInProxyServer() {
|
||||||
*/
|
*/
|
||||||
function startServer(server) {
|
function startServer(server) {
|
||||||
return new Promise((resolve, reject) => {
|
return new Promise((resolve, reject) => {
|
||||||
// Passing port 0 makes the OS assign an available port
|
// Bind to loopback only. Without an explicit host, Node listens on every
|
||||||
server.listen(0, () => {
|
// 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();
|
const address = server.address();
|
||||||
if (address && typeof address === "object") {
|
if (address && typeof address === "object") {
|
||||||
state.port = address.port;
|
state.port = address.port;
|
||||||
|
|
@ -76,12 +81,16 @@ export function createBuiltInProxyServer() {
|
||||||
return new Promise((resolve) => {
|
return new Promise((resolve) => {
|
||||||
try {
|
try {
|
||||||
server.close(() => {
|
server.close(() => {
|
||||||
|
cleanupCertBundle();
|
||||||
resolve();
|
resolve();
|
||||||
});
|
});
|
||||||
} catch {
|
} catch {
|
||||||
resolve();
|
resolve();
|
||||||
}
|
}
|
||||||
setTimeout(() => resolve(), SERVER_STOP_TIMEOUT_MS);
|
setTimeout(() => {
|
||||||
|
cleanupCertBundle();
|
||||||
|
resolve();
|
||||||
|
}, SERVER_STOP_TIMEOUT_MS);
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -112,6 +121,18 @@ export function createBuiltInProxyServer() {
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|
||||||
|
interceptor.on(
|
||||||
|
"minimumAgeRequestBlocked",
|
||||||
|
(
|
||||||
|
/** @type {import("./interceptors/interceptorBuilder.js").MinimumAgeRequestBlockedEvent} */ event,
|
||||||
|
) => {
|
||||||
|
emitter.emit("minimumAgeRequestBlocked", {
|
||||||
|
packageName: event.packageName,
|
||||||
|
packageVersion: event.version,
|
||||||
|
});
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
mitmConnect(req, clientSocket, interceptor);
|
mitmConnect(req, clientSocket, interceptor);
|
||||||
} else {
|
} else {
|
||||||
// For other hosts, just tunnel the request to the destination tcp socket
|
// For other hosts, just tunnel the request to the destination tcp socket
|
||||||
|
|
|
||||||
|
|
@ -15,3 +15,66 @@ export function getHeaderValueAsString(headers, headerName) {
|
||||||
|
|
||||||
return header;
|
return header;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns a copy of headers without the provided header names, matched
|
||||||
|
* either exactly or case-insensitively.
|
||||||
|
*
|
||||||
|
* @param {NodeJS.Dict<string | string[]> | undefined} headers
|
||||||
|
* @param {string[]} headerNames
|
||||||
|
* @param {{ caseInsensitive?: boolean }} [options]
|
||||||
|
* @returns {NodeJS.Dict<string | string[]> | 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<string | string[]>} */
|
||||||
|
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<string | string[]> | 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);
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@ import {
|
||||||
getEcoSystem,
|
getEcoSystem,
|
||||||
} from "../../../config/settings.js";
|
} from "../../../config/settings.js";
|
||||||
import { npmInterceptorForUrl } from "./npm/npmInterceptor.js";
|
import { npmInterceptorForUrl } from "./npm/npmInterceptor.js";
|
||||||
import { pipInterceptorForUrl } from "./pipInterceptor.js";
|
import { pipInterceptorForUrl } from "./pip/pipInterceptor.js";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {string} url
|
* @param {string} url
|
||||||
|
|
|
||||||
|
|
@ -10,6 +10,7 @@ import { EventEmitter } from "events";
|
||||||
* @typedef {Object} RequestInterceptionContext
|
* @typedef {Object} RequestInterceptionContext
|
||||||
* @property {string} targetUrl
|
* @property {string} targetUrl
|
||||||
* @property {(packageName: string | undefined, version: string | undefined) => void} blockMalware
|
* @property {(packageName: string | undefined, version: string | undefined) => void} blockMalware
|
||||||
|
* @property {(packageName: string, version: string, message: string) => void} blockMinimumAgeRequest
|
||||||
* @property {(modificationFunc: (headers: NodeJS.Dict<string | string[]>) => NodeJS.Dict<string | string[]>) => void} modifyRequestHeaders
|
* @property {(modificationFunc: (headers: NodeJS.Dict<string | string[]>) => NodeJS.Dict<string | string[]>) => void} modifyRequestHeaders
|
||||||
* @property {(modificationFunc: (body: Buffer, headers: NodeJS.Dict<string | string[]> | undefined) => Buffer) => void} modifyBody
|
* @property {(modificationFunc: (body: Buffer, headers: NodeJS.Dict<string | string[]> | undefined) => Buffer) => void} modifyBody
|
||||||
* @property {() => RequestInterceptionHandler} build
|
* @property {() => RequestInterceptionHandler} build
|
||||||
|
|
@ -26,6 +27,12 @@ import { EventEmitter } from "events";
|
||||||
* @property {string} version
|
* @property {string} version
|
||||||
* @property {string} targetUrl
|
* @property {string} targetUrl
|
||||||
* @property {number} timestamp
|
* @property {number} timestamp
|
||||||
|
*
|
||||||
|
* @typedef {Object} MinimumAgeRequestBlockedEvent
|
||||||
|
* @property {string} packageName
|
||||||
|
* @property {string} version
|
||||||
|
* @property {string} targetUrl
|
||||||
|
* @property {number} timestamp
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
@ -81,10 +88,7 @@ function createRequestContext(targetUrl, eventEmitter) {
|
||||||
* @param {string | undefined} version
|
* @param {string | undefined} version
|
||||||
*/
|
*/
|
||||||
function blockMalwareSetup(packageName, version) {
|
function blockMalwareSetup(packageName, version) {
|
||||||
blockResponse = {
|
blockResponse = createBlockResponse("Forbidden - blocked by safe-chain");
|
||||||
statusCode: 403,
|
|
||||||
message: "Forbidden - blocked by safe-chain",
|
|
||||||
};
|
|
||||||
|
|
||||||
// Emit the malwareBlocked event
|
// Emit the malwareBlocked event
|
||||||
eventEmitter.emit("malwareBlocked", {
|
eventEmitter.emit("malwareBlocked", {
|
||||||
|
|
@ -95,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} */
|
/** @returns {RequestInterceptionHandler} */
|
||||||
function build() {
|
function build() {
|
||||||
/**
|
/**
|
||||||
|
|
@ -139,6 +171,7 @@ function createRequestContext(targetUrl, eventEmitter) {
|
||||||
return {
|
return {
|
||||||
targetUrl,
|
targetUrl,
|
||||||
blockMalware: blockMalwareSetup,
|
blockMalware: blockMalwareSetup,
|
||||||
|
blockMinimumAgeRequest: blockMinimumAgeRequestSetup,
|
||||||
modifyRequestHeaders: (func) => reqheaderModificationFuncs.push(func),
|
modifyRequestHeaders: (func) => reqheaderModificationFuncs.push(func),
|
||||||
modifyBody: (func) => modifyBodyFuncs.push(func),
|
modifyBody: (func) => modifyBodyFuncs.push(func),
|
||||||
build,
|
build,
|
||||||
|
|
|
||||||
|
|
@ -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))
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
@ -4,7 +4,7 @@ import {
|
||||||
getNpmMinimumPackageAgeExclusions,
|
getNpmMinimumPackageAgeExclusions,
|
||||||
} from "../../../../config/settings.js";
|
} from "../../../../config/settings.js";
|
||||||
import { ui } from "../../../../environment/userInteraction.js";
|
import { ui } from "../../../../environment/userInteraction.js";
|
||||||
import { getHeaderValueAsString } from "../../http-utils.js";
|
import { clearCachingHeaders, getHeaderValueAsString } from "../../http-utils.js";
|
||||||
|
|
||||||
/** @type {EventEmitter<{ versionsRemoved: [{packageName: string, packageVersions: string[]}] }>} */
|
/** @type {EventEmitter<{ versionsRemoved: [{packageName: string, packageVersions: string[]}] }>} */
|
||||||
export const modifyResponseEventEmitter = new EventEmitter();
|
export const modifyResponseEventEmitter = new EventEmitter();
|
||||||
|
|
@ -104,15 +104,7 @@ export function modifyNpmInfoResponse(body, headers) {
|
||||||
removedVersions.push(version);
|
removedVersions.push(version);
|
||||||
|
|
||||||
deleteVersionFromJson(bodyJson, version);
|
deleteVersionFromJson(bodyJson, version);
|
||||||
if (headers) {
|
clearCachingHeaders(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"];
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -213,3 +205,22 @@ function matchesExclusionPattern(packageName, pattern) {
|
||||||
}
|
}
|
||||||
return packageName === pattern;
|
return packageName === pattern;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {Buffer} body
|
||||||
|
* @param {NodeJS.Dict<string | string[]> | undefined} headers
|
||||||
|
* @returns {string | undefined}
|
||||||
|
*/
|
||||||
|
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;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -5,11 +5,16 @@ import {
|
||||||
import { isMalwarePackage } from "../../../../scanning/audit/index.js";
|
import { isMalwarePackage } from "../../../../scanning/audit/index.js";
|
||||||
import { interceptRequests } from "../interceptorBuilder.js";
|
import { interceptRequests } from "../interceptorBuilder.js";
|
||||||
import {
|
import {
|
||||||
|
getPackageNameFromMetadataResponse,
|
||||||
isPackageInfoUrl,
|
isPackageInfoUrl,
|
||||||
modifyNpmInfoRequestHeaders,
|
modifyNpmInfoRequestHeaders,
|
||||||
modifyNpmInfoResponse,
|
modifyNpmInfoResponse,
|
||||||
} from "./modifyNpmInfo.js";
|
} from "./modifyNpmInfo.js";
|
||||||
import { parseNpmPackageUrl } from "./parseNpmPackageUrl.js";
|
import { parseNpmPackageUrl } from "./parseNpmPackageUrl.js";
|
||||||
|
import { openNewPackagesDatabase } from "../../../../scanning/newPackagesListCache.js";
|
||||||
|
import {
|
||||||
|
isExcludedFromMinimumPackageAge,
|
||||||
|
} from "../minimumPackageAgeExclusions.js";
|
||||||
|
|
||||||
const knownJsRegistries = [
|
const knownJsRegistries = [
|
||||||
"registry.npmjs.org",
|
"registry.npmjs.org",
|
||||||
|
|
@ -43,14 +48,54 @@ function buildNpmInterceptor(registry) {
|
||||||
reqContext.targetUrl,
|
reqContext.targetUrl,
|
||||||
registry
|
registry
|
||||||
);
|
);
|
||||||
|
const minimumAgeChecksEnabled = !skipMinimumPackageAge();
|
||||||
|
|
||||||
if (await isMalwarePackage(packageName, version)) {
|
if (await isMalwarePackage(packageName, version)) {
|
||||||
reqContext.blockMalware(packageName, version);
|
reqContext.blockMalware(packageName, version);
|
||||||
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!skipMinimumPackageAge() && isPackageInfoUrl(reqContext.targetUrl)) {
|
if (minimumAgeChecksEnabled && isPackageInfoUrl(reqContext.targetUrl)) {
|
||||||
reqContext.modifyRequestHeaders(modifyNpmInfoRequestHeaders);
|
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<string | string[]> | undefined} headers
|
||||||
|
* @returns {Buffer}
|
||||||
|
*/
|
||||||
|
function modifyNpmInfoResponseUnlessExcluded(body, headers) {
|
||||||
|
const metadataPackageName = getPackageNameFromMetadataResponse(body, headers);
|
||||||
|
|
||||||
|
if (
|
||||||
|
metadataPackageName &&
|
||||||
|
isExcludedFromMinimumPackageAge(metadataPackageName)
|
||||||
|
) {
|
||||||
|
return body;
|
||||||
|
}
|
||||||
|
|
||||||
|
return modifyNpmInfoResponse(body, headers);
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -5,13 +5,25 @@ describe("npmInterceptor minimum package age", async () => {
|
||||||
let minimumPackageAgeSettings = 48;
|
let minimumPackageAgeSettings = 48;
|
||||||
let skipMinimumPackageAgeSetting = false;
|
let skipMinimumPackageAgeSetting = false;
|
||||||
let minimumPackageAgeExclusionsSetting = [];
|
let minimumPackageAgeExclusionsSetting = [];
|
||||||
|
let newlyReleasedPackages = new Set();
|
||||||
|
|
||||||
mock.module("../../../../config/settings.js", {
|
mock.module("../../../../config/settings.js", {
|
||||||
namedExports: {
|
namedExports: {
|
||||||
|
ECOSYSTEM_JS: "js",
|
||||||
|
ECOSYSTEM_PY: "py",
|
||||||
getMinimumPackageAgeHours: () => minimumPackageAgeSettings,
|
getMinimumPackageAgeHours: () => minimumPackageAgeSettings,
|
||||||
skipMinimumPackageAge: () => skipMinimumPackageAgeSetting,
|
skipMinimumPackageAge: () => skipMinimumPackageAgeSetting,
|
||||||
getNpmCustomRegistries: () => [],
|
getNpmCustomRegistries: () => [],
|
||||||
getNpmMinimumPackageAgeExclusions: () => minimumPackageAgeExclusionsSetting,
|
getMinimumPackageAgeExclusions: () => minimumPackageAgeExclusionsSetting,
|
||||||
|
getEcoSystem: () => "js",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
mock.module("../../../../scanning/newPackagesListCache.js", {
|
||||||
|
namedExports: {
|
||||||
|
openNewPackagesDatabase: async () => ({
|
||||||
|
isNewlyReleasedPackage: (name, version) =>
|
||||||
|
newlyReleasedPackages.has(`${name}@${version}`),
|
||||||
|
}),
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|
@ -359,6 +371,67 @@ describe("npmInterceptor minimum package age", async () => {
|
||||||
assert.equal(modifiedJson["dist-tags"]["latest"], "2.0.0");
|
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 () => {
|
it("Should not filter packages when package is in exclusion list", async () => {
|
||||||
minimumPackageAgeSettings = 5;
|
minimumPackageAgeSettings = 5;
|
||||||
skipMinimumPackageAgeSetting = false;
|
skipMinimumPackageAgeSetting = false;
|
||||||
|
|
@ -540,6 +613,7 @@ describe("npmInterceptor minimum package age", async () => {
|
||||||
minimumPackageAgeSettings = 5;
|
minimumPackageAgeSettings = 5;
|
||||||
skipMinimumPackageAgeSetting = false;
|
skipMinimumPackageAgeSetting = false;
|
||||||
minimumPackageAgeExclusionsSetting = []; // Reset to empty
|
minimumPackageAgeExclusionsSetting = []; // Reset to empty
|
||||||
|
newlyReleasedPackages = new Set();
|
||||||
|
|
||||||
const packageUrl = "https://registry.npmjs.org/lodash";
|
const packageUrl = "https://registry.npmjs.org/lodash";
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,9 +1,11 @@
|
||||||
import { describe, it, mock } from "node:test";
|
import { describe, it, mock, beforeEach } from "node:test";
|
||||||
import assert from "node:assert";
|
import assert from "node:assert";
|
||||||
|
|
||||||
let lastPackage;
|
let lastPackage;
|
||||||
let malwareResponse = false;
|
let malwareResponse = false;
|
||||||
let customRegistries = [];
|
let customRegistries = [];
|
||||||
|
let newlyReleasedPackages = new Set();
|
||||||
|
let skipMinimumPackageAgeSetting = false;
|
||||||
|
|
||||||
mock.module("../../../../scanning/audit/index.js", {
|
mock.module("../../../../scanning/audit/index.js", {
|
||||||
namedExports: {
|
namedExports: {
|
||||||
|
|
@ -26,14 +28,30 @@ mock.module("../../../../config/settings.js", {
|
||||||
setEcoSystem: () => {},
|
setEcoSystem: () => {},
|
||||||
getMinimumPackageAgeHours: () => 24,
|
getMinimumPackageAgeHours: () => 24,
|
||||||
getNpmCustomRegistries: () => customRegistries,
|
getNpmCustomRegistries: () => customRegistries,
|
||||||
getNpmMinimumPackageAgeExclusions: () => [],
|
getMinimumPackageAgeExclusions: () => [],
|
||||||
skipMinimumPackageAge: () => false,
|
skipMinimumPackageAge: () => skipMinimumPackageAgeSetting,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
mock.module("../../../../scanning/newPackagesListCache.js", {
|
||||||
|
namedExports: {
|
||||||
|
openNewPackagesDatabase: async () => ({
|
||||||
|
isNewlyReleasedPackage: (name, version) =>
|
||||||
|
newlyReleasedPackages.has(`${name}@${version}`),
|
||||||
|
}),
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
describe("npmInterceptor", async () => {
|
describe("npmInterceptor", async () => {
|
||||||
const { npmInterceptorForUrl } = await import("./npmInterceptor.js");
|
const { npmInterceptorForUrl } = await import("./npmInterceptor.js");
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
lastPackage = undefined;
|
||||||
|
malwareResponse = false;
|
||||||
|
customRegistries = [];
|
||||||
|
newlyReleasedPackages = new Set();
|
||||||
|
skipMinimumPackageAgeSetting = false;
|
||||||
|
});
|
||||||
|
|
||||||
const parserCases = [
|
const parserCases = [
|
||||||
// Regular packages
|
// Regular packages
|
||||||
{
|
{
|
||||||
|
|
@ -109,6 +127,10 @@ describe("npmInterceptor", async () => {
|
||||||
url: "https://registry.yarnpkg.com/@babel/core/-/core-7.21.4.tgz",
|
url: "https://registry.yarnpkg.com/@babel/core/-/core-7.21.4.tgz",
|
||||||
expected: { packageName: "@babel/core", version: "7.21.4" },
|
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 to get package info, not tarball
|
||||||
{
|
{
|
||||||
url: "https://registry.npmjs.org/lodash",
|
url: "https://registry.npmjs.org/lodash",
|
||||||
|
|
@ -178,6 +200,36 @@ describe("npmInterceptor", async () => {
|
||||||
"Block response should have correct status message"
|
"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 () => {
|
describe("npmInterceptor with custom registries", async () => {
|
||||||
|
|
|
||||||
|
|
@ -5,12 +5,29 @@
|
||||||
*/
|
*/
|
||||||
export function parseNpmPackageUrl(url, registry) {
|
export function parseNpmPackageUrl(url, registry) {
|
||||||
let packageName, version;
|
let packageName, version;
|
||||||
if (!registry || !url.endsWith(".tgz")) {
|
let parsedUrl;
|
||||||
|
|
||||||
|
try {
|
||||||
|
parsedUrl = new URL(url);
|
||||||
|
} catch {
|
||||||
return { packageName, version };
|
return { packageName, version };
|
||||||
}
|
}
|
||||||
|
|
||||||
const registryIndex = url.indexOf(registry);
|
const pathname = parsedUrl.pathname;
|
||||||
const afterRegistry = url.substring(registryIndex + registry.length + 1); // +1 to skip the slash
|
|
||||||
|
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("/-/");
|
const separatorIndex = afterRegistry.indexOf("/-/");
|
||||||
if (separatorIndex === -1) {
|
if (separatorIndex === -1) {
|
||||||
|
|
|
||||||
|
|
@ -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<string | string[]>} headers
|
||||||
|
* @returns {NodeJS.Dict<string | string[]>}
|
||||||
|
*/
|
||||||
|
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 =
|
||||||
|
/<a\b[^>]*href\s*=\s*(["'])([^"']+)\1[^>]*>[\s\S]*?<\/a>/gi;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {Buffer} body
|
||||||
|
* @param {NodeJS.Dict<string | string[]> | 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<string | string[]> | 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<string | string[]> | 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;
|
||||||
|
}
|
||||||
|
|
@ -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(`
|
||||||
|
<!doctype html>
|
||||||
|
<html>
|
||||||
|
<body>
|
||||||
|
<a href="https://files.pythonhosted.org/packages/source/r/requests/requests-1.0.0.tar.gz">requests-1.0.0.tar.gz</a>
|
||||||
|
<a href="https://files.pythonhosted.org/packages/source/r/requests/requests-2.0.0.tar.gz">requests-2.0.0.tar.gz</a>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
`);
|
||||||
|
|
||||||
|
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(
|
||||||
|
`<a href="https://files.pythonhosted.org/packages/source/r/requests/requests-1.0.0.tar.gz">requests-1.0.0.tar.gz</a>`
|
||||||
|
);
|
||||||
|
|
||||||
|
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(
|
||||||
|
`<a href="https://files.pythonhosted.org/packages/xx/yy/foo_bar-2.0.0.tar.gz">foo_bar-2.0.0.tar.gz</a>` +
|
||||||
|
`<a href="https://files.pythonhosted.org/packages/xx/yy/foo_bar-1.0.0.tar.gz">foo_bar-1.0.0.tar.gz</a>`
|
||||||
|
);
|
||||||
|
|
||||||
|
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(`
|
||||||
|
<a
|
||||||
|
data-requires-python=">=3.9"
|
||||||
|
class="pkg"
|
||||||
|
href='https://files.pythonhosted.org/packages/xx/yy/foo_bar-2.0.0.tar.gz'
|
||||||
|
>
|
||||||
|
foo_bar-2.0.0.tar.gz
|
||||||
|
</a>
|
||||||
|
<a href="https://files.pythonhosted.org/packages/xx/yy/foo_bar-1.0.0.tar.gz">foo_bar-1.0.0.tar.gz</a>
|
||||||
|
`);
|
||||||
|
|
||||||
|
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");
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
@ -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);
|
||||||
|
}
|
||||||
|
|
@ -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 };
|
||||||
|
}
|
||||||
|
|
@ -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 }
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
@ -2,20 +2,36 @@ import { describe, it, mock } from "node:test";
|
||||||
import assert from "node:assert";
|
import assert from "node:assert";
|
||||||
|
|
||||||
describe("pipInterceptor custom registries", async () => {
|
describe("pipInterceptor custom registries", async () => {
|
||||||
let lastPackage;
|
let scannedPackages;
|
||||||
let malwareResponse = false;
|
let malwareResponse = false;
|
||||||
let customRegistries = [];
|
let customRegistries = [];
|
||||||
|
|
||||||
mock.module("../../../config/settings.js", {
|
mock.module("../../../../config/settings.js", {
|
||||||
namedExports: {
|
namedExports: {
|
||||||
|
ECOSYSTEM_PY: "py",
|
||||||
|
getEcoSystem: () => "py",
|
||||||
|
getLoggingLevel: () => "silent",
|
||||||
|
getMinimumPackageAgeHours: () => 48,
|
||||||
|
getMinimumPackageAgeExclusions: () => [],
|
||||||
getPipCustomRegistries: () => customRegistries,
|
getPipCustomRegistries: () => customRegistries,
|
||||||
|
LOGGING_SILENT: "silent",
|
||||||
|
LOGGING_VERBOSE: "verbose",
|
||||||
|
skipMinimumPackageAge: () => false,
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
mock.module("../../../scanning/audit/index.js", {
|
mock.module("../../../../scanning/newPackagesListCache.js", {
|
||||||
|
namedExports: {
|
||||||
|
openNewPackagesDatabase: async () => ({
|
||||||
|
isNewlyReleasedPackage: () => false,
|
||||||
|
}),
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
mock.module("../../../../scanning/audit/index.js", {
|
||||||
namedExports: {
|
namedExports: {
|
||||||
isMalwarePackage: async (packageName, version) => {
|
isMalwarePackage: async (packageName, version) => {
|
||||||
lastPackage = { packageName, version };
|
scannedPackages.push({ packageName, version });
|
||||||
return malwareResponse;
|
return malwareResponse;
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|
@ -30,42 +46,45 @@ describe("pipInterceptor custom registries", async () => {
|
||||||
|
|
||||||
const interceptor = pipInterceptorForUrl(url);
|
const interceptor = pipInterceptorForUrl(url);
|
||||||
|
|
||||||
assert.ok(
|
assert.ok(interceptor);
|
||||||
interceptor,
|
|
||||||
"Interceptor should be created for custom registry"
|
|
||||||
);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should parse package from custom registry URL", async () => {
|
it("should parse package from custom registry URL", async () => {
|
||||||
|
scannedPackages = [];
|
||||||
customRegistries = ["my-custom-registry.example.com"];
|
customRegistries = ["my-custom-registry.example.com"];
|
||||||
const url =
|
const url =
|
||||||
"https://my-custom-registry.example.com/packages/xx/yy/foobar-1.2.3.tar.gz";
|
"https://my-custom-registry.example.com/packages/xx/yy/foobar-1.2.3.tar.gz";
|
||||||
|
|
||||||
const interceptor = pipInterceptorForUrl(url);
|
const interceptor = pipInterceptorForUrl(url);
|
||||||
assert.ok(interceptor, "Interceptor should be created");
|
assert.ok(interceptor);
|
||||||
|
|
||||||
await interceptor.handleRequest(url);
|
await interceptor.handleRequest(url);
|
||||||
|
|
||||||
assert.deepEqual(lastPackage, {
|
assert.ok(
|
||||||
packageName: "foobar",
|
scannedPackages.some(
|
||||||
version: "1.2.3",
|
({ packageName, version }) =>
|
||||||
});
|
packageName === "foobar" && version === "1.2.3"
|
||||||
|
)
|
||||||
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should parse wheel package from custom registry URL", async () => {
|
it("should parse wheel package from custom registry URL", async () => {
|
||||||
|
scannedPackages = [];
|
||||||
customRegistries = ["private-pypi.internal.com"];
|
customRegistries = ["private-pypi.internal.com"];
|
||||||
const url =
|
const url =
|
||||||
"https://private-pypi.internal.com/packages/foo_bar-2.0.0-py3-none-any.whl";
|
"https://private-pypi.internal.com/packages/foo_bar-2.0.0-py3-none-any.whl";
|
||||||
|
|
||||||
const interceptor = pipInterceptorForUrl(url);
|
const interceptor = pipInterceptorForUrl(url);
|
||||||
assert.ok(interceptor, "Interceptor should be created");
|
assert.ok(interceptor);
|
||||||
|
|
||||||
await interceptor.handleRequest(url);
|
await interceptor.handleRequest(url);
|
||||||
|
|
||||||
assert.deepEqual(lastPackage, {
|
assert.ok(
|
||||||
packageName: "foo-bar",
|
scannedPackages.some(
|
||||||
version: "2.0.0",
|
({ packageName, version }) =>
|
||||||
});
|
packageName === "foo-bar" && version === "2.0.0"
|
||||||
|
)
|
||||||
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should handle multiple custom registries", async () => {
|
it("should handle multiple custom registries", async () => {
|
||||||
|
|
@ -82,14 +101,12 @@ describe("pipInterceptor custom registries", async () => {
|
||||||
const interceptor1 = pipInterceptorForUrl(url1);
|
const interceptor1 = pipInterceptorForUrl(url1);
|
||||||
const interceptor2 = pipInterceptorForUrl(url2);
|
const interceptor2 = pipInterceptorForUrl(url2);
|
||||||
|
|
||||||
assert.ok(interceptor1, "Interceptor should be created for first registry");
|
assert.ok(interceptor1);
|
||||||
assert.ok(
|
assert.ok(interceptor2);
|
||||||
interceptor2,
|
|
||||||
"Interceptor should be created for second registry"
|
|
||||||
);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should block malicious package from custom registry", async () => {
|
it("should block malicious package from custom registry", async () => {
|
||||||
|
scannedPackages = [];
|
||||||
customRegistries = ["my-custom-registry.example.com"];
|
customRegistries = ["my-custom-registry.example.com"];
|
||||||
malwareResponse = true;
|
malwareResponse = true;
|
||||||
|
|
||||||
|
|
@ -97,26 +114,19 @@ describe("pipInterceptor custom registries", async () => {
|
||||||
"https://my-custom-registry.example.com/packages/malicious_package-1.0.0.tar.gz";
|
"https://my-custom-registry.example.com/packages/malicious_package-1.0.0.tar.gz";
|
||||||
|
|
||||||
const interceptor = pipInterceptorForUrl(url);
|
const interceptor = pipInterceptorForUrl(url);
|
||||||
assert.ok(interceptor, "Interceptor should be created");
|
assert.ok(interceptor);
|
||||||
|
|
||||||
const result = await interceptor.handleRequest(url);
|
const result = await interceptor.handleRequest(url);
|
||||||
|
|
||||||
assert.ok(result.blockResponse, "Should contain a blockResponse");
|
assert.ok(result.blockResponse);
|
||||||
assert.equal(
|
assert.equal(result.blockResponse.statusCode, 403);
|
||||||
result.blockResponse.statusCode,
|
assert.equal(result.blockResponse.message, "Forbidden - blocked by safe-chain");
|
||||||
403,
|
|
||||||
"Block response should have status code 403"
|
|
||||||
);
|
|
||||||
assert.equal(
|
|
||||||
result.blockResponse.message,
|
|
||||||
"Forbidden - blocked by safe-chain",
|
|
||||||
"Block response should have correct status message"
|
|
||||||
);
|
|
||||||
|
|
||||||
malwareResponse = false;
|
malwareResponse = false;
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should still work with known registries when custom registries are set", async () => {
|
it("should still work with known registries when custom registries are set", async () => {
|
||||||
|
scannedPackages = [];
|
||||||
customRegistries = ["my-custom-registry.example.com"];
|
customRegistries = ["my-custom-registry.example.com"];
|
||||||
|
|
||||||
const url =
|
const url =
|
||||||
|
|
@ -124,17 +134,16 @@ describe("pipInterceptor custom registries", async () => {
|
||||||
|
|
||||||
const interceptor = pipInterceptorForUrl(url);
|
const interceptor = pipInterceptorForUrl(url);
|
||||||
|
|
||||||
assert.ok(
|
assert.ok(interceptor);
|
||||||
interceptor,
|
|
||||||
"Interceptor should be created for known registry even with custom registries set"
|
|
||||||
);
|
|
||||||
|
|
||||||
await interceptor.handleRequest(url);
|
await interceptor.handleRequest(url);
|
||||||
|
|
||||||
assert.deepEqual(lastPackage, {
|
assert.ok(
|
||||||
packageName: "foobar",
|
scannedPackages.some(
|
||||||
version: "1.2.3",
|
({ packageName, version }) =>
|
||||||
});
|
packageName === "foobar" && version === "1.2.3"
|
||||||
|
)
|
||||||
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should not create interceptor for unknown registry when custom registries are set", () => {
|
it("should not create interceptor for unknown registry when custom registries are set", () => {
|
||||||
|
|
@ -143,11 +152,7 @@ describe("pipInterceptor custom registries", async () => {
|
||||||
|
|
||||||
const interceptor = pipInterceptorForUrl(url);
|
const interceptor = pipInterceptorForUrl(url);
|
||||||
|
|
||||||
assert.equal(
|
assert.equal(interceptor, undefined);
|
||||||
interceptor,
|
|
||||||
undefined,
|
|
||||||
"Interceptor should be undefined for unknown registry"
|
|
||||||
);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should handle empty custom registries array", () => {
|
it("should handle empty custom registries array", () => {
|
||||||
|
|
@ -157,42 +162,44 @@ describe("pipInterceptor custom registries", async () => {
|
||||||
|
|
||||||
const interceptor = pipInterceptorForUrl(url);
|
const interceptor = pipInterceptorForUrl(url);
|
||||||
|
|
||||||
assert.equal(
|
assert.equal(interceptor, undefined);
|
||||||
interceptor,
|
|
||||||
undefined,
|
|
||||||
"Interceptor should be undefined when no custom registries are configured"
|
|
||||||
);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should parse .whl.metadata from custom registry", async () => {
|
it("should parse .whl.metadata from custom registry", async () => {
|
||||||
|
scannedPackages = [];
|
||||||
customRegistries = ["private-pypi.internal.com"];
|
customRegistries = ["private-pypi.internal.com"];
|
||||||
const url =
|
const url =
|
||||||
"https://private-pypi.internal.com/packages/foo_bar-2.0.0-py3-none-any.whl.metadata";
|
"https://private-pypi.internal.com/packages/foo_bar-2.0.0-py3-none-any.whl.metadata";
|
||||||
|
|
||||||
const interceptor = pipInterceptorForUrl(url);
|
const interceptor = pipInterceptorForUrl(url);
|
||||||
assert.ok(interceptor, "Interceptor should be created");
|
assert.ok(interceptor);
|
||||||
|
|
||||||
await interceptor.handleRequest(url);
|
await interceptor.handleRequest(url);
|
||||||
|
|
||||||
assert.deepEqual(lastPackage, {
|
assert.ok(
|
||||||
packageName: "foo-bar",
|
scannedPackages.some(
|
||||||
version: "2.0.0",
|
({ packageName, version }) =>
|
||||||
});
|
packageName === "foo-bar" && version === "2.0.0"
|
||||||
|
)
|
||||||
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should parse .tar.gz.metadata from custom registry", async () => {
|
it("should parse .tar.gz.metadata from custom registry", async () => {
|
||||||
|
scannedPackages = [];
|
||||||
customRegistries = ["private-pypi.internal.com"];
|
customRegistries = ["private-pypi.internal.com"];
|
||||||
const url =
|
const url =
|
||||||
"https://private-pypi.internal.com/packages/foo_bar-2.0.0.tar.gz.metadata";
|
"https://private-pypi.internal.com/packages/foo_bar-2.0.0.tar.gz.metadata";
|
||||||
|
|
||||||
const interceptor = pipInterceptorForUrl(url);
|
const interceptor = pipInterceptorForUrl(url);
|
||||||
assert.ok(interceptor, "Interceptor should be created");
|
assert.ok(interceptor);
|
||||||
|
|
||||||
await interceptor.handleRequest(url);
|
await interceptor.handleRequest(url);
|
||||||
|
|
||||||
assert.deepEqual(lastPackage, {
|
assert.ok(
|
||||||
packageName: "foo-bar",
|
scannedPackages.some(
|
||||||
version: "2.0.0",
|
({ packageName, version }) =>
|
||||||
});
|
packageName === "foo-bar" && version === "2.0.0"
|
||||||
|
)
|
||||||
|
);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
@ -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<void>}
|
||||||
|
*/
|
||||||
|
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})`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
@ -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(`
|
||||||
|
<a href="https://files.pythonhosted.org/packages/xx/yy/foo_bar-1.0.0.tar.gz">foo_bar-1.0.0.tar.gz</a>
|
||||||
|
<a href="https://files.pythonhosted.org/packages/xx/yy/foo_bar-2.0.0.tar.gz">foo_bar-2.0.0.tar.gz</a>
|
||||||
|
`),
|
||||||
|
{
|
||||||
|
"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;
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
@ -0,0 +1,163 @@
|
||||||
|
import { describe, it, mock } from "node:test";
|
||||||
|
import assert from "node:assert";
|
||||||
|
|
||||||
|
describe("pipInterceptor", async () => {
|
||||||
|
let scannedPackages;
|
||||||
|
let malwareResponse = false;
|
||||||
|
|
||||||
|
mock.module("../../../../scanning/audit/index.js", {
|
||||||
|
namedExports: {
|
||||||
|
isMalwarePackage: async (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 = [
|
||||||
|
{
|
||||||
|
url: "https://files.pythonhosted.org/packages/xx/yy/foobar-1.2.3.tar.gz",
|
||||||
|
expected: { packageName: "foobar", version: "1.2.3" },
|
||||||
|
},
|
||||||
|
{
|
||||||
|
url: "https://pypi.org/packages/source/f/foobar/foobar-1.2.3.tar.gz",
|
||||||
|
expected: { packageName: "foobar", version: "1.2.3" },
|
||||||
|
},
|
||||||
|
{
|
||||||
|
url: "https://pypi.org/packages/source/f/foo-bar/foo-bar-0.9.0.tar.gz",
|
||||||
|
expected: { packageName: "foo-bar", version: "0.9.0" },
|
||||||
|
},
|
||||||
|
{
|
||||||
|
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" },
|
||||||
|
},
|
||||||
|
{
|
||||||
|
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" },
|
||||||
|
},
|
||||||
|
{
|
||||||
|
url: "https://pypi.org/packages/source/f/foo.bar/foo.bar-1.0.0.tar.gz",
|
||||||
|
expected: { packageName: "foo.bar", version: "1.0.0" },
|
||||||
|
},
|
||||||
|
{
|
||||||
|
url: "https://pypi.org/packages/source/f/foo_bar/foo_bar-2.0.0b1.tar.gz",
|
||||||
|
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" },
|
||||||
|
},
|
||||||
|
{
|
||||||
|
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" },
|
||||||
|
},
|
||||||
|
{
|
||||||
|
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" },
|
||||||
|
},
|
||||||
|
{
|
||||||
|
url: "https://pypi.org/packages/source/f/foo_bar/foo_bar-2.0.0a1.tar.gz",
|
||||||
|
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" },
|
||||||
|
},
|
||||||
|
{
|
||||||
|
url: "https://pypi.org/simple/",
|
||||||
|
expected: { packageName: undefined, version: undefined },
|
||||||
|
},
|
||||||
|
{
|
||||||
|
url: "https://pypi.org/project/foobar/",
|
||||||
|
expected: { packageName: undefined, version: undefined },
|
||||||
|
},
|
||||||
|
{
|
||||||
|
url: "https://files.pythonhosted.org/packages/xx/yy/foobar-latest.tar.gz",
|
||||||
|
expected: { packageName: undefined, version: undefined },
|
||||||
|
},
|
||||||
|
{
|
||||||
|
url: "https://pypi.org/packages/source/f/foo_bar/foo_bar-latest.tar.gz",
|
||||||
|
expected: { packageName: undefined, version: undefined },
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
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 pip registry");
|
||||||
|
|
||||||
|
await interceptor.handleRequest(url);
|
||||||
|
|
||||||
|
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);
|
||||||
|
});
|
||||||
|
|
||||||
|
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);
|
||||||
|
assert.equal(result.blockResponse.statusCode, 403);
|
||||||
|
assert.equal(
|
||||||
|
result.blockResponse.message,
|
||||||
|
"Forbidden - blocked by safe-chain"
|
||||||
|
);
|
||||||
|
|
||||||
|
malwareResponse = false;
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
@ -2,22 +2,43 @@ import { describe, it, mock } from "node:test";
|
||||||
import assert from "node:assert";
|
import assert from "node:assert";
|
||||||
|
|
||||||
describe("pipInterceptor", async () => {
|
describe("pipInterceptor", async () => {
|
||||||
let lastPackage;
|
let scannedPackages;
|
||||||
let malwareResponse = false;
|
let malwareResponse = false;
|
||||||
|
|
||||||
mock.module("../../../scanning/audit/index.js", {
|
mock.module("../../../../scanning/audit/index.js", {
|
||||||
namedExports: {
|
namedExports: {
|
||||||
isMalwarePackage: async (packageName, version) => {
|
isMalwarePackage: async (packageName, version) => {
|
||||||
lastPackage = { packageName, version };
|
scannedPackages.push({ packageName, version });
|
||||||
return malwareResponse;
|
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 { pipInterceptorForUrl } = await import("./pipInterceptor.js");
|
||||||
|
|
||||||
const parserCases = [
|
const parserCases = [
|
||||||
// Valid pip URLs
|
|
||||||
{
|
{
|
||||||
url: "https://files.pythonhosted.org/packages/xx/yy/foobar-1.2.3.tar.gz",
|
url: "https://files.pythonhosted.org/packages/xx/yy/foobar-1.2.3.tar.gz",
|
||||||
expected: { packageName: "foobar", version: "1.2.3" },
|
expected: { packageName: "foobar", version: "1.2.3" },
|
||||||
|
|
@ -35,7 +56,6 @@ describe("pipInterceptor", async () => {
|
||||||
expected: { packageName: "foo-bar", version: "2.0.0" },
|
expected: { packageName: "foo-bar", version: "2.0.0" },
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
// Poetry preflight metadata alongside wheel (.whl.metadata)
|
|
||||||
url: "https://files.pythonhosted.org/packages/xx/yy/foo_bar-2.0.0-py3-none-any.whl.metadata",
|
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" },
|
expected: { packageName: "foo-bar", version: "2.0.0" },
|
||||||
},
|
},
|
||||||
|
|
@ -52,7 +72,6 @@ describe("pipInterceptor", async () => {
|
||||||
expected: { packageName: "foo-bar", version: "2.0.0b1" },
|
expected: { packageName: "foo-bar", version: "2.0.0b1" },
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
// sdist with metadata sidecar (.tar.gz.metadata)
|
|
||||||
url: "https://files.pythonhosted.org/packages/xx/yy/foo_bar-2.0.0.tar.gz.metadata",
|
url: "https://files.pythonhosted.org/packages/xx/yy/foo_bar-2.0.0.tar.gz.metadata",
|
||||||
expected: { packageName: "foo-bar", version: "2.0.0" },
|
expected: { packageName: "foo-bar", version: "2.0.0" },
|
||||||
},
|
},
|
||||||
|
|
@ -76,7 +95,6 @@ describe("pipInterceptor", async () => {
|
||||||
url: "https://pypi.org/packages/source/f/foo_bar/foo_bar-2.0.0-cp38-cp38-manylinux1_x86_64.whl",
|
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/",
|
url: "https://pypi.org/simple/",
|
||||||
expected: { packageName: undefined, version: undefined },
|
expected: { packageName: undefined, version: undefined },
|
||||||
|
|
@ -97,49 +115,49 @@ describe("pipInterceptor", async () => {
|
||||||
|
|
||||||
parserCases.forEach(({ url, expected }, index) => {
|
parserCases.forEach(({ url, expected }, index) => {
|
||||||
it(`should parse URL ${index + 1}: ${url}`, async () => {
|
it(`should parse URL ${index + 1}: ${url}`, async () => {
|
||||||
|
scannedPackages = [];
|
||||||
const interceptor = pipInterceptorForUrl(url);
|
const interceptor = pipInterceptorForUrl(url);
|
||||||
assert.ok(
|
assert.ok(interceptor, "Interceptor should be created for known pip registry");
|
||||||
interceptor,
|
|
||||||
"Interceptor should be created for known npm registry"
|
|
||||||
);
|
|
||||||
|
|
||||||
await interceptor.handleRequest(url);
|
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", () => {
|
it("should not create interceptor for unknown registry", () => {
|
||||||
const url = "https://example.com/packages/xx/yy/foobar-1.2.3.tar.gz";
|
const url = "https://example.com/packages/xx/yy/foobar-1.2.3.tar.gz";
|
||||||
|
|
||||||
const interceptor = pipInterceptorForUrl(url);
|
const interceptor = pipInterceptorForUrl(url);
|
||||||
|
assert.equal(interceptor, undefined);
|
||||||
assert.equal(
|
|
||||||
interceptor,
|
|
||||||
undefined,
|
|
||||||
"Interceptor should be undefined for unknown registry"
|
|
||||||
);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
it("should block malicious package", async () => {
|
it("should block malicious package", async () => {
|
||||||
|
scannedPackages = [];
|
||||||
const url =
|
const url =
|
||||||
"https://files.pythonhosted.org/packages/xx/yy/malicious_package-1.0.0.tar.gz";
|
"https://files.pythonhosted.org/packages/xx/yy/malicious_package-1.0.0.tar.gz";
|
||||||
malwareResponse = true;
|
malwareResponse = true;
|
||||||
|
|
||||||
const interceptor = pipInterceptorForUrl(url);
|
const interceptor = pipInterceptorForUrl(url);
|
||||||
|
|
||||||
const result = await interceptor.handleRequest(url);
|
const result = await interceptor.handleRequest(url);
|
||||||
|
|
||||||
assert.ok(result.blockResponse, "Should contain a blockResponse");
|
assert.ok(result.blockResponse);
|
||||||
assert.equal(
|
assert.equal(result.blockResponse.statusCode, 403);
|
||||||
result.blockResponse.statusCode,
|
|
||||||
403,
|
|
||||||
"Block response should have status code 403"
|
|
||||||
);
|
|
||||||
assert.equal(
|
assert.equal(
|
||||||
result.blockResponse.message,
|
result.blockResponse.message,
|
||||||
"Forbidden - blocked by safe-chain",
|
"Forbidden - blocked by safe-chain"
|
||||||
"Block response should have correct status message"
|
|
||||||
);
|
);
|
||||||
|
|
||||||
|
malwareResponse = false;
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
@ -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<string | string[]> | 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).`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
@ -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);
|
||||||
|
}
|
||||||
|
|
@ -1,132 +0,0 @@
|
||||||
import { getPipCustomRegistries } from "../../../config/settings.js";
|
|
||||||
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 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(async (reqContext) => {
|
|
||||||
const { packageName, version } = parsePipPackageFromUrl(
|
|
||||||
reqContext.targetUrl,
|
|
||||||
registry
|
|
||||||
);
|
|
||||||
|
|
||||||
// Normalize underscores to hyphens for DB matching, as PyPI allows underscores in distribution names.
|
|
||||||
// Per python, packages that differ only by hyphen vs underscore are considered the same.
|
|
||||||
const hyphenName = packageName?.includes("_") ? packageName.replace(/_/g, "-") : packageName;
|
|
||||||
|
|
||||||
const isMalicious =
|
|
||||||
await isMalwarePackage(packageName, version)
|
|
||||||
|| await isMalwarePackage(hyphenName, version);
|
|
||||||
|
|
||||||
if (isMalicious) {
|
|
||||||
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) and Poetry's preflight metadata (.whl.metadata)
|
|
||||||
// Examples:
|
|
||||||
// foo_bar-2.0.0-py3-none-any.whl
|
|
||||||
// foo_bar-2.0.0-py3-none-any.whl.metadata
|
|
||||||
const wheelExtRe = /\.whl(?:\.metadata)?$/;
|
|
||||||
const wheelExtMatch = filename.match(wheelExtRe);
|
|
||||||
if (wheelExtMatch) {
|
|
||||||
const base = filename.replace(wheelExtRe, "");
|
|
||||||
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;
|
|
||||||
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) and potential metadata sidecars (e.g., .tar.gz.metadata)
|
|
||||||
const sdistExtWithMetadataRe = /\.(tar\.gz|zip|tar\.bz2|tar\.xz)(\.metadata)?$/i;
|
|
||||||
const sdistExtMatch = filename.match(sdistExtWithMetadataRe);
|
|
||||||
if (sdistExtMatch) {
|
|
||||||
const base = filename.replace(sdistExtWithMetadataRe, "");
|
|
||||||
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 };
|
|
||||||
}
|
|
||||||
|
|
@ -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;
|
||||||
|
}
|
||||||
|
|
@ -2,7 +2,8 @@ import https from "https";
|
||||||
import { generateCertForHost } from "./certUtils.js";
|
import { generateCertForHost } from "./certUtils.js";
|
||||||
import { HttpsProxyAgent } from "https-proxy-agent";
|
import { HttpsProxyAgent } from "https-proxy-agent";
|
||||||
import { ui } from "../../environment/userInteraction.js";
|
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
|
* @typedef {import("./interceptors/interceptorBuilder.js").Interceptor} Interceptor
|
||||||
|
|
@ -215,11 +216,16 @@ function createProxyRequest(hostname, port, req, res, requestHandler) {
|
||||||
|
|
||||||
buffer = requestHandler.modifyBody(buffer, headers);
|
buffer = requestHandler.modifyBody(buffer, headers);
|
||||||
|
|
||||||
if (proxyRes.headers["content-encoding"] === "gzip") {
|
// For rewritten responses, send the final body uncompressed.
|
||||||
buffer = gzipSync(buffer);
|
// This avoids mismatches between upstream compression metadata and the
|
||||||
}
|
// rewritten payload on the wire.
|
||||||
|
const rewrittenHeaders = omitHeaders(
|
||||||
res.writeHead(statusCode, headers);
|
headers,
|
||||||
|
["content-length", "transfer-encoding", "content-encoding"],
|
||||||
|
{ caseInsensitive: true }
|
||||||
|
) || {};
|
||||||
|
rewrittenHeaders["content-length"] = String(buffer.byteLength);
|
||||||
|
res.writeHead(statusCode, rewrittenHeaders);
|
||||||
res.end(buffer);
|
res.end(buffer);
|
||||||
});
|
});
|
||||||
} else {
|
} else {
|
||||||
|
|
|
||||||
|
|
@ -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)
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
@ -7,6 +7,9 @@ import tls from "node:tls";
|
||||||
import { X509Certificate } from "node:crypto";
|
import { X509Certificate } from "node:crypto";
|
||||||
import { ui } from "../environment/userInteraction.js";
|
import { ui } from "../environment/userInteraction.js";
|
||||||
|
|
||||||
|
/** @type {string | null} */
|
||||||
|
let bundlePath = null;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Check if a PEM string contains only parsable cert blocks.
|
* Check if a PEM string contains only parsable cert blocks.
|
||||||
* @param {string} pem - PEM-encoded certificate string
|
* @param {string} pem - PEM-encoded certificate string
|
||||||
|
|
@ -54,6 +57,11 @@ function isParsable(pem) {
|
||||||
* @returns {string} Path to the combined CA bundle PEM file
|
* @returns {string} Path to the combined CA bundle PEM file
|
||||||
*/
|
*/
|
||||||
export function getCombinedCaBundlePath(proxyCaCert) {
|
export function getCombinedCaBundlePath(proxyCaCert) {
|
||||||
|
if (bundlePath)
|
||||||
|
{
|
||||||
|
return bundlePath;
|
||||||
|
}
|
||||||
|
|
||||||
// 1) Safe Chain CA (for MITM'd registries)
|
// 1) Safe Chain CA (for MITM'd registries)
|
||||||
const parts = [];
|
const parts = [];
|
||||||
if (proxyCaCert && isParsable(proxyCaCert)) parts.push(proxyCaCert.trim());
|
if (proxyCaCert && isParsable(proxyCaCert)) parts.push(proxyCaCert.trim());
|
||||||
|
|
@ -92,9 +100,23 @@ export function getCombinedCaBundlePath(proxyCaCert) {
|
||||||
}
|
}
|
||||||
|
|
||||||
const combined = parts.filter(Boolean).join("\n");
|
const combined = parts.filter(Boolean).join("\n");
|
||||||
const target = path.join(os.tmpdir(), `safe-chain-ca-bundle-${Date.now()}.pem`);
|
bundlePath = path.join(os.tmpdir(), `safe-chain-ca-bundle-${Date.now()}.pem`);
|
||||||
fs.writeFileSync(target, combined, { encoding: "utf8" });
|
fs.writeFileSync(bundlePath, combined, { encoding: "utf8" });
|
||||||
return target;
|
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;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@ import { createBuiltInProxyServer } from "./builtInProxy/createBuiltInProxyServe
|
||||||
import { getCombinedCaBundlePath } from "./certBundle.js";
|
import { getCombinedCaBundlePath } from "./certBundle.js";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @typedef {Object} MalwareBlockedEvent
|
* @typedef {Object} PackageBlockedEvent
|
||||||
* @prop {string} packageName
|
* @prop {string} packageName
|
||||||
* @prop {string} packageVersion
|
* @prop {string} packageVersion
|
||||||
*
|
*
|
||||||
|
|
@ -13,7 +13,8 @@ import { getCombinedCaBundlePath } from "./certBundle.js";
|
||||||
* @prop {string[]} packageVersions
|
* @prop {string[]} packageVersions
|
||||||
*
|
*
|
||||||
* @typedef {{
|
* @typedef {{
|
||||||
* malwareBlocked: [MalwareBlockedEvent],
|
* malwareBlocked: [PackageBlockedEvent],
|
||||||
|
* minimumAgeRequestBlocked: [PackageBlockedEvent]
|
||||||
* minPackageAgeVersionsSuppressed: [MinPackageAgeSuppressionEvent]
|
* minPackageAgeVersionsSuppressed: [MinPackageAgeSuppressionEvent]
|
||||||
* }} ProxyServerEvents
|
* }} ProxyServerEvents
|
||||||
*
|
*
|
||||||
|
|
@ -61,7 +62,7 @@ export function getProxySettings() {
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
const proxyUrl = `http://localhost:${server.getServerPort()}`;
|
const proxyUrl = `http://127.0.0.1:${server.getServerPort()}`;
|
||||||
const caCert = server.getCaCert();
|
const caCert = server.getCaCert();
|
||||||
const caCertBundlePath = getCombinedCaBundlePath(caCert);
|
const caCertBundlePath = getCombinedCaBundlePath(caCert);
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -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();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
@ -15,8 +15,12 @@ import { getEcoSystem, ECOSYSTEM_PY } from "../config/settings.js";
|
||||||
* @property {function(string, string): boolean} isMalware
|
* @property {function(string, string): boolean} isMalware
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** @type {MalwareDatabase | null} */
|
// Caching the Promise (rather than the resolved database) prevents duplicate fetches. If we cached the resolved
|
||||||
let cachedMalwareDatabase = null;
|
// 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<MalwareDatabase> | null} */
|
||||||
|
let cachedMalwareDatabasePromise = null;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Normalize package name for comparison.
|
* Normalize package name for comparison.
|
||||||
|
|
@ -34,45 +38,44 @@ function normalizePackageName(name) {
|
||||||
return name;
|
return name;
|
||||||
}
|
}
|
||||||
|
|
||||||
export async function openMalwareDatabase() {
|
export function openMalwareDatabase() {
|
||||||
if (cachedMalwareDatabase) {
|
if (!cachedMalwareDatabasePromise) {
|
||||||
return cachedMalwareDatabase;
|
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;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
return packageData.reason;
|
||||||
* @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 === "*");
|
|
||||||
}
|
}
|
||||||
);
|
|
||||||
|
|
||||||
if (!packageData) {
|
return {
|
||||||
return MALWARE_STATUS_OK;
|
getPackageStatus,
|
||||||
}
|
isMalware: (/** @type {string} */ name, /** @type {string} */ version) => {
|
||||||
|
const status = getPackageStatus(name, version);
|
||||||
return packageData.reason;
|
return isMalwareStatus(status);
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}).catch((error) => {
|
||||||
|
cachedMalwareDatabasePromise = null;
|
||||||
|
throw error;
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
return cachedMalwareDatabasePromise;
|
||||||
// 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;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
||||||
267
packages/safe-chain/src/scanning/newPackagesDatabase.spec.js
Normal file
267
packages/safe-chain/src/scanning/newPackagesDatabase.spec.js
Normal file
|
|
@ -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"
|
||||||
|
)
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
@ -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 };
|
||||||
|
}
|
||||||
|
|
@ -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";
|
||||||
|
});
|
||||||
|
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
@ -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;
|
||||||
|
}
|
||||||
|
|
@ -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);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
123
packages/safe-chain/src/scanning/newPackagesListCache.js
Normal file
123
packages/safe-chain/src/scanning/newPackagesListCache.js
Normal file
|
|
@ -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<NewPackagesDatabase> | null} */
|
||||||
|
let cachedNewPackagesDatabasePromise = null;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @returns {Promise<NewPackagesDatabase>}
|
||||||
|
*/
|
||||||
|
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<import("../api/aikido.js").NewPackageEntry[]>}
|
||||||
|
*/
|
||||||
|
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 };
|
||||||
|
}
|
||||||
|
}
|
||||||
178
packages/safe-chain/src/scanning/newPackagesListCache.spec.js
Normal file
178
packages/safe-chain/src/scanning/newPackagesListCache.spec.js
Normal file
|
|
@ -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"));
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
29
packages/safe-chain/src/scanning/packageNameVariants.js
Normal file
29
packages/safe-chain/src/scanning/packageNameVariants.js
Normal file
|
|
@ -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])];
|
||||||
|
}
|
||||||
|
|
@ -66,6 +66,12 @@ export const knownAikidoTools = [
|
||||||
ecoSystem: ECOSYSTEM_PY,
|
ecoSystem: ECOSYSTEM_PY,
|
||||||
internalPackageManagerName: "uv",
|
internalPackageManagerName: "uv",
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
tool: "uvx",
|
||||||
|
aikidoCommand: "aikido-uvx",
|
||||||
|
ecoSystem: ECOSYSTEM_PY,
|
||||||
|
internalPackageManagerName: "uvx",
|
||||||
|
},
|
||||||
{
|
{
|
||||||
tool: "pip",
|
tool: "pip",
|
||||||
aikidoCommand: "aikido-pip",
|
aikidoCommand: "aikido-pip",
|
||||||
|
|
@ -121,20 +127,6 @@ export function getPackageManagerList() {
|
||||||
return `${tools.join(", ")}, and ${lastTool} commands`;
|
return `${tools.join(", ")}, and ${lastTool} commands`;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* @returns {string}
|
|
||||||
*/
|
|
||||||
export function getShimsDir() {
|
|
||||||
return path.join(os.homedir(), ".safe-chain", "shims");
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @returns {string}
|
|
||||||
*/
|
|
||||||
export function getScriptsDir() {
|
|
||||||
return path.join(os.homedir(), ".safe-chain", "scripts");
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {string} executableName
|
* @param {string} executableName
|
||||||
*
|
*
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
import { describe, it, beforeEach, afterEach, mock } from "node:test";
|
import { describe, it, beforeEach, afterEach, mock } from "node:test";
|
||||||
import assert from "node:assert";
|
import assert from "node:assert";
|
||||||
import { tmpdir } from "node:os";
|
import { tmpdir, homedir } from "node:os";
|
||||||
import fs from "node:fs";
|
import fs from "node:fs";
|
||||||
import path from "path";
|
import path from "path";
|
||||||
|
|
||||||
|
|
@ -15,6 +15,7 @@ describe("removeLinesMatchingPatternTests", () => {
|
||||||
mock.module("node:os", {
|
mock.module("node:os", {
|
||||||
namedExports: {
|
namedExports: {
|
||||||
EOL: "\r\n", // Simulate Windows line endings
|
EOL: "\r\n", // Simulate Windows line endings
|
||||||
|
homedir,
|
||||||
tmpdir: tmpdir,
|
tmpdir: tmpdir,
|
||||||
platform: () => "linux",
|
platform: () => "linux",
|
||||||
},
|
},
|
||||||
|
|
@ -182,3 +183,30 @@ describe("removeLinesMatchingPatternTests", () => {
|
||||||
assert.strictEqual(resultLines.length, 5, "Should have exactly 5 lines");
|
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"));
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
|
||||||
|
|
@ -4,13 +4,28 @@
|
||||||
|
|
||||||
# Function to remove shim from PATH (POSIX-compliant)
|
# Function to remove shim from PATH (POSIX-compliant)
|
||||||
remove_shim_from_path() {
|
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
|
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
|
||||||
PATH=$(remove_shim_from_path) exec safe-chain {{PACKAGE_MANAGER}} "$@"
|
PATH=$(remove_shim_from_path) exec safe-chain {{PACKAGE_MANAGER}} "$@"
|
||||||
else
|
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)
|
# Dynamically find original {{PACKAGE_MANAGER}} (excluding this shim directory)
|
||||||
original_cmd=$(PATH=$(remove_shim_from_path) command -v {{PACKAGE_MANAGER}})
|
original_cmd=$(PATH=$(remove_shim_from_path) command -v {{PACKAGE_MANAGER}})
|
||||||
if [ -n "$original_cmd" ]; then
|
if [ -n "$original_cmd" ]; then
|
||||||
|
|
|
||||||
|
|
@ -3,7 +3,8 @@ REM Generated wrapper for {{PACKAGE_MANAGER}} by safe-chain
|
||||||
REM This wrapper intercepts {{PACKAGE_MANAGER}} calls for non-interactive environments
|
REM This wrapper intercepts {{PACKAGE_MANAGER}} calls for non-interactive environments
|
||||||
|
|
||||||
REM Remove shim directory from PATH to prevent infinite loops
|
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%;=%%"
|
call set "CLEAN_PATH=%%PATH:%SHIM_DIR%;=%%"
|
||||||
|
|
||||||
REM Check if aikido command is available with clean PATH
|
REM Check if aikido command is available with clean PATH
|
||||||
|
|
@ -21,4 +22,4 @@ if %errorlevel%==0 (
|
||||||
REM If we get here, original command was not found
|
REM If we get here, original command was not found
|
||||||
echo Error: Could not find original {{PACKAGE_MANAGER}} >&2
|
echo Error: Could not find original {{PACKAGE_MANAGER}} >&2
|
||||||
exit /b 1
|
exit /b 1
|
||||||
)
|
)
|
||||||
|
|
|
||||||
|
|
@ -1,24 +1,14 @@
|
||||||
import chalk from "chalk";
|
import chalk from "chalk";
|
||||||
import { ui } from "../environment/userInteraction.js";
|
import { ui } from "../environment/userInteraction.js";
|
||||||
import { getPackageManagerList, knownAikidoTools, getShimsDir } from "./helpers.js";
|
import { getPackageManagerList, knownAikidoTools } from "./helpers.js";
|
||||||
|
import {
|
||||||
|
getShimsDir,
|
||||||
|
getBinDir,
|
||||||
|
getPathWrapperTemplatePath,
|
||||||
|
} from "../config/safeChainDir.js";
|
||||||
import fs from "fs";
|
import fs from "fs";
|
||||||
import os from "os";
|
import os from "os";
|
||||||
import path from "path";
|
import path from "path";
|
||||||
import { fileURLToPath } from "url";
|
|
||||||
|
|
||||||
/** @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);
|
|
||||||
} else {
|
|
||||||
dirname = __dirname;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Loops over the detected shells and calls the setup function for each.
|
* Loops over the detected shells and calls the setup function for each.
|
||||||
|
|
@ -31,7 +21,7 @@ export async function setupCi() {
|
||||||
ui.emptyLine();
|
ui.emptyLine();
|
||||||
|
|
||||||
const shimsDir = getShimsDir();
|
const shimsDir = getShimsDir();
|
||||||
const binDir = path.join(os.homedir(), ".safe-chain", "bin");
|
const binDir = getBinDir();
|
||||||
// Create the shims directory if it doesn't exist
|
// Create the shims directory if it doesn't exist
|
||||||
if (!fs.existsSync(shimsDir)) {
|
if (!fs.existsSync(shimsDir)) {
|
||||||
fs.mkdirSync(shimsDir, { recursive: true });
|
fs.mkdirSync(shimsDir, { recursive: true });
|
||||||
|
|
@ -50,12 +40,7 @@ export async function setupCi() {
|
||||||
*/
|
*/
|
||||||
function createUnixShims(shimsDir) {
|
function createUnixShims(shimsDir) {
|
||||||
// Read the template file
|
// Read the template file
|
||||||
const templatePath = path.resolve(
|
const templatePath = getPathWrapperTemplatePath(import.meta.url, "unix-wrapper.template.sh");
|
||||||
dirname,
|
|
||||||
"path-wrappers",
|
|
||||||
"templates",
|
|
||||||
"unix-wrapper.template.sh"
|
|
||||||
);
|
|
||||||
|
|
||||||
if (!fs.existsSync(templatePath)) {
|
if (!fs.existsSync(templatePath)) {
|
||||||
ui.writeError(`Template file not found: ${templatePath}`);
|
ui.writeError(`Template file not found: ${templatePath}`);
|
||||||
|
|
@ -89,12 +74,7 @@ function createUnixShims(shimsDir) {
|
||||||
*/
|
*/
|
||||||
function createWindowsShims(shimsDir) {
|
function createWindowsShims(shimsDir) {
|
||||||
// Read the template file
|
// Read the template file
|
||||||
const templatePath = path.resolve(
|
const templatePath = getPathWrapperTemplatePath(import.meta.url, "windows-wrapper.template.cmd");
|
||||||
dirname,
|
|
||||||
"path-wrappers",
|
|
||||||
"templates",
|
|
||||||
"windows-wrapper.template.cmd"
|
|
||||||
);
|
|
||||||
|
|
||||||
if (!fs.existsSync(templatePath)) {
|
if (!fs.existsSync(templatePath)) {
|
||||||
ui.writeError(`Windows template file not found: ${templatePath}`);
|
ui.writeError(`Windows template file not found: ${templatePath}`);
|
||||||
|
|
|
||||||
|
|
@ -22,12 +22,12 @@ describe("Setup CI shell integration", () => {
|
||||||
fs.mkdirSync(path.join(mockTemplateDir, "path-wrappers", "templates"), { recursive: true });
|
fs.mkdirSync(path.join(mockTemplateDir, "path-wrappers", "templates"), { recursive: true });
|
||||||
fs.writeFileSync(
|
fs.writeFileSync(
|
||||||
path.join(mockTemplateDir, "path-wrappers", "templates", "unix-wrapper.template.sh"),
|
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"
|
"utf-8"
|
||||||
);
|
);
|
||||||
fs.writeFileSync(
|
fs.writeFileSync(
|
||||||
path.join(mockTemplateDir, "path-wrappers", "templates", "windows-wrapper.template.cmd"),
|
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"
|
"utf-8"
|
||||||
);
|
);
|
||||||
|
|
||||||
|
|
@ -50,7 +50,15 @@ describe("Setup CI shell integration", () => {
|
||||||
{ tool: "yarn", aikidoCommand: "aikido-yarn" },
|
{ tool: "yarn", aikidoCommand: "aikido-yarn" },
|
||||||
],
|
],
|
||||||
getPackageManagerList: () => "npm, yarn",
|
getPackageManagerList: () => "npm, yarn",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
mock.module("../config/safeChainDir.js", {
|
||||||
|
namedExports: {
|
||||||
getShimsDir: () => mockShimsDir,
|
getShimsDir: () => mockShimsDir,
|
||||||
|
getBinDir: () => path.join(mockHomeDir, ".safe-chain", "bin"),
|
||||||
|
getPathWrapperTemplatePath: (_moduleUrl, fileName) =>
|
||||||
|
path.join(mockTemplateDir, "path-wrappers", "templates", fileName),
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|
@ -63,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
|
// Import setupCi module after mocking
|
||||||
setupCi = (await import("./setup-ci.js")).setupCi;
|
setupCi = (await import("./setup-ci.js")).setupCi;
|
||||||
});
|
});
|
||||||
|
|
@ -119,6 +111,10 @@ describe("Setup CI shell integration", () => {
|
||||||
const npmShimContent = fs.readFileSync(npmShimPath, "utf-8");
|
const npmShimContent = fs.readFileSync(npmShimPath, "utf-8");
|
||||||
assert.ok(npmShimContent.includes("aikido-npm"), "npm shim should contain aikido-npm");
|
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("#!/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 () => {
|
it("should create Windows .cmd shims on win32 platform", async () => {
|
||||||
|
|
@ -142,6 +138,10 @@ describe("Setup CI shell integration", () => {
|
||||||
assert.ok(npmShimContent.includes("aikido-npm"), "npm.cmd should contain aikido-npm");
|
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("@echo off"), "npm.cmd should have Windows batch header");
|
||||||
assert.ok(npmShimContent.includes("%*"), "npm.cmd should use Windows argument passing");
|
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
|
// Verify Unix shims were NOT created
|
||||||
const unixNpmShim = path.join(mockShimsDir, "npm");
|
const unixNpmShim = path.join(mockShimsDir, "npm");
|
||||||
|
|
|
||||||
|
|
@ -1,28 +1,10 @@
|
||||||
import chalk from "chalk";
|
import chalk from "chalk";
|
||||||
import { ui } from "../environment/userInteraction.js";
|
import { ui } from "../environment/userInteraction.js";
|
||||||
import { detectShells } from "./shellDetection.js";
|
import { detectShells } from "./shellDetection.js";
|
||||||
import {
|
import { knownAikidoTools, getPackageManagerList } from "./helpers.js";
|
||||||
knownAikidoTools,
|
import { getScriptsDir, getStartupScriptSourcePath } from "../config/safeChainDir.js";
|
||||||
getPackageManagerList,
|
|
||||||
getScriptsDir,
|
|
||||||
} from "./helpers.js";
|
|
||||||
import fs from "fs";
|
import fs from "fs";
|
||||||
import path from "path";
|
import path from "path";
|
||||||
import { fileURLToPath } from "url";
|
|
||||||
|
|
||||||
/** @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);
|
|
||||||
} else {
|
|
||||||
dirname = __dirname;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Loops over the detected shells and calls the setup function for each.
|
* Loops over the detected shells and calls the setup function for each.
|
||||||
|
|
@ -91,9 +73,7 @@ async function setupShell(shell) {
|
||||||
);
|
);
|
||||||
} else {
|
} else {
|
||||||
ui.writeError(
|
ui.writeError(
|
||||||
`${chalk.bold("- " + shell.name + ":")} ${chalk.red(
|
`${chalk.bold("- " + shell.name + ":")} ${chalk.red("Setup failed")}`,
|
||||||
"Setup failed",
|
|
||||||
)}. Please check your ${shell.name} configuration.`,
|
|
||||||
);
|
);
|
||||||
if (error) {
|
if (error) {
|
||||||
let message = ` Error: ${error.message}`;
|
let message = ` Error: ${error.message}`;
|
||||||
|
|
@ -102,6 +82,12 @@ async function setupShell(shell) {
|
||||||
}
|
}
|
||||||
ui.writeError(message);
|
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;
|
return success;
|
||||||
|
|
@ -118,8 +104,7 @@ function copyStartupFiles() {
|
||||||
fs.mkdirSync(targetDir, { recursive: true });
|
fs.mkdirSync(targetDir, { recursive: true });
|
||||||
}
|
}
|
||||||
|
|
||||||
// Use absolute path for source
|
const sourcePath = getStartupScriptSourcePath(import.meta.url, file);
|
||||||
const sourcePath = path.join(dirname, "startup-scripts", file);
|
|
||||||
fs.copyFileSync(sourcePath, targetPath);
|
fs.copyFileSync(sourcePath, targetPath);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -11,6 +11,8 @@ import { ui } from "../environment/userInteraction.js";
|
||||||
* @property {() => boolean} isInstalled
|
* @property {() => boolean} isInstalled
|
||||||
* @property {(tools: import("./helpers.js").AikidoTool[]) => boolean|Promise<boolean>} setup
|
* @property {(tools: import("./helpers.js").AikidoTool[]) => boolean|Promise<boolean>} setup
|
||||||
* @property {(tools: import("./helpers.js").AikidoTool[]) => boolean} teardown
|
* @property {(tools: import("./helpers.js").AikidoTool[]) => boolean} teardown
|
||||||
|
* @property {() => string[]} getManualSetupInstructions
|
||||||
|
* @property {() => string[]} getManualTeardownInstructions
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,7 @@
|
||||||
set -gx PATH $PATH $HOME/.safe-chain/bin
|
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
|
function npx
|
||||||
wrapSafeChainCommand "npx" $argv
|
wrapSafeChainCommand "npx" $argv
|
||||||
|
|
@ -51,6 +54,10 @@ function uv
|
||||||
wrapSafeChainCommand "uv" $argv
|
wrapSafeChainCommand "uv" $argv
|
||||||
end
|
end
|
||||||
|
|
||||||
|
function uvx
|
||||||
|
wrapSafeChainCommand "uvx" $argv
|
||||||
|
end
|
||||||
|
|
||||||
function poetry
|
function poetry
|
||||||
wrapSafeChainCommand "poetry" $argv
|
wrapSafeChainCommand "poetry" $argv
|
||||||
end
|
end
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,16 @@
|
||||||
export PATH="$PATH:$HOME/.safe-chain/bin"
|
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() {
|
function npx() {
|
||||||
wrapSafeChainCommand "npx" "$@"
|
wrapSafeChainCommand "npx" "$@"
|
||||||
|
|
@ -47,6 +59,10 @@ function uv() {
|
||||||
wrapSafeChainCommand "uv" "$@"
|
wrapSafeChainCommand "uv" "$@"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function uvx() {
|
||||||
|
wrapSafeChainCommand "uvx" "$@"
|
||||||
|
}
|
||||||
|
|
||||||
function poetry() {
|
function poetry() {
|
||||||
wrapSafeChainCommand "poetry" "$@"
|
wrapSafeChainCommand "poetry" "$@"
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,8 @@
|
||||||
# $IsWindows is only available in PowerShell Core 6.0+. If it doesn't exist, assume Windows PowerShell
|
# $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 }
|
$isWindowsPlatform = if (Test-Path variable:IsWindows) { $IsWindows } else { $true }
|
||||||
$pathSeparator = if ($isWindowsPlatform) { ';' } else { ':' }
|
$pathSeparator = if ($isWindowsPlatform) { ';' } else { ':' }
|
||||||
$safeChainBin = Join-Path (Join-Path $HOME '.safe-chain') 'bin'
|
$safeChainBase = Split-Path -Parent $PSScriptRoot
|
||||||
|
$safeChainBin = Join-Path $safeChainBase 'bin'
|
||||||
$env:PATH = "$env:PATH$pathSeparator$safeChainBin"
|
$env:PATH = "$env:PATH$pathSeparator$safeChainBin"
|
||||||
|
|
||||||
function npx {
|
function npx {
|
||||||
|
|
@ -52,6 +53,10 @@ function uv {
|
||||||
Invoke-WrappedCommand "uv" $args $MyInvocation.Line $MyInvocation.OffsetInLine
|
Invoke-WrappedCommand "uv" $args $MyInvocation.Line $MyInvocation.OffsetInLine
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function uvx {
|
||||||
|
Invoke-WrappedCommand "uvx" $args $MyInvocation.Line $MyInvocation.OffsetInLine
|
||||||
|
}
|
||||||
|
|
||||||
function poetry {
|
function poetry {
|
||||||
Invoke-WrappedCommand "poetry" $args $MyInvocation.Line $MyInvocation.OffsetInLine
|
Invoke-WrappedCommand "poetry" $args $MyInvocation.Line $MyInvocation.OffsetInLine
|
||||||
}
|
}
|
||||||
|
|
|
||||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue