Security Vulnerability Detection

Pastoralist can check dependencies against security providers and connect fixes to the same appendix used for override tracking.

Overview

Security checks scan your dependencies, report vulnerable packages, and can suggest or apply package manager overrides when a safe version is available. The appendix keeps the CVE, provider, severity, patched version, and reason with the override.

Quick Start

Basic Check

# Check for vulnerabilities and display a report
pastoralist --checkSecurity

Auto Fix

# Automatically apply security fixes
pastoralist --checkSecurity --forceSecurityRefactor

Interactive

# Choose which fixes to apply
pastoralist --checkSecurity --interactive

Workspaces

# Include workspace packages in the scan
pastoralist --checkSecurity --hasWorkspaceSecurityChecks

Configuration

You can configure security settings in your package.json:

{
  "pastoralist": {
    "security": {
      "enabled": false,
      "provider": "osv",
      "autoFix": false,
      "interactive": false,
      "hasWorkspaceSecurityChecks": false,
      "severityThreshold": "medium",
      "excludePackages": []
    }
  }
}

Configuration Options

CLI Options

Token Handling

Set provider tokens with environment variables whenever possible: GITHUB_TOKEN, SNYK_TOKEN, SOCKET_SECURITY_API_KEY, or SPEKTION_API_KEY. securityProviderToken remains available for controlled local or generated config, but do not commit real tokens to the repository.

Release Assurance

Pastoralist npm releases are published from GitHub Actions with npm provenance. The release workflow also packs the npm tarball before publishing and creates a GitHub artifact attestation for that exact tarball.

You can inspect provenance on the npm package page and verify registry signatures from your own project:

npm audit signatures

These checks prove where the package was built and which artifact was published. They do not prove the code is bug-free, so the project also runs CI, CodeQL, OpenSSF Scorecard, dependency update policy checks, and unit, integration, and e2e tests.

Security Providers

OSV (Open Source Vulnerabilities)

Free and requires no token.

The OSV database is a distributed vulnerability database for open source, created by Google and the open source community.

GitHub Provider

Requires a token but provides more in-depth security awareness, including transitive dependencies.

The GitHub provider uses Dependabot alerts to check for vulnerabilities. This provider queries GitHub's Dependabot API for your repository.

Setup

The GitHub provider supports two authentication methods:

Option 1: GitHub CLI (Recommended)

If you have the GitHub CLI installed and authenticated, no additional setup is required:

# Install and authenticate gh CLI
gh auth login

# Run pastoralist with GitHub provider
pastoralist --checkSecurity --securityProvider github

Option 2: Personal Access Token

If you don't have the GitHub CLI, you can provide a GitHub token:

1. Create a personal access token at https://github.com/settings/tokens with repo scope
2. Set the token as an environment variable:

   export GITHUB_TOKEN=your_token_here
   

3. Or pass it via CLI in one-off/local use:

   pastoralist --checkSecurity --securityProvider github --securityProviderToken your_token_here
   

CI/CD Permissions

When using the GitHub provider in CI workflows, you need to:

1. Add workflow permissions:

permissions:
  contents: read
  vulnerability-alerts: read

2. Enable Dependabot alerts in your repository: Settings → Code security and analysis → Dependabot alerts

If permissions are insufficient, Pastoralist will display a warning with guidance and continue (your workflow won't fail).

npm Audit Provider

Runs the current package manager's audit command and converts the result into Pastoralist security alerts.

pastoralist --checkSecurity --securityProvider npm

This provider uses the package manager detected for the project: npm, Yarn, pnpm, or Bun.

Snyk Provider [EXPERIMENTAL]

:::caution[Experimental] The Snyk provider is experimental and may have breaking changes. Report issues at https://github.com/yowainwright/pastoralist/issues :::

Requires the Snyk CLI and API authentication token.

# Set your Snyk token
export SNYK_TOKEN=your_token_here

# Run with Snyk provider
pastoralist --checkSecurity --securityProvider snyk

Socket Provider [EXPERIMENTAL]

:::caution[Experimental] The Socket provider is experimental and may have breaking changes. Report issues at https://github.com/yowainwright/pastoralist/issues :::

Requires the Socket CLI and API key.

# Set your Socket API key
export SOCKET_SECURITY_API_KEY=your_key_here

# Run with Socket provider
pastoralist --checkSecurity --securityProvider socket

Spektion Provider [EXPERIMENTAL]

:::caution[Experimental] The Spektion provider is experimental and may have breaking changes. Report issues at https://github.com/yowainwright/pastoralist/issues :::

Requires a Spektion API key.

# Set your Spektion API key
export SPEKTION_API_KEY=your_key_here

# Run with Spektion provider
pastoralist --checkSecurity --securityProvider spektion

CVE Tracking in the Ledger

Every appendix entry has a ledger. When a security provider detects a fix, Pastoralist adds CVE, severity, provider, and vulnerable-range metadata to that ledger alongside the addedDate:

{
  "[email protected]": {
    "dependents": { "my-app": "lodash@^4.17.0" },
    "ledger": {
      "addedDate": "2026-05-30T00:00:00.000Z",
      "source": "security",
      "securityChecked": true,
      "securityProvider": "osv",
      "cves": ["CVE-2021-23337"],
      "cveDetails": [
        {
          "cve": "CVE-2021-23337",
          "severity": "high",
          "patchedVersion": "4.17.21"
        }
      ],
      "severity": "high",
      "vulnerableRange": "<4.17.21",
      "patchedVersion": "4.17.21"
    }
  }
}

Multiple CVEs from the same package are aggregated — cveDetails gives per-CVE granularity (severity and patched version per identifier), while cves is the deduplicated flat list for quick reference.

Keeping Security Overrides with keep

By default, --remove-unused will remove overrides whose dependents no longer require them. For security overrides you want to retain regardless, set keep on the ledger:

{
  "ledger": {
    "addedDate": "2026-05-30T00:00:00.000Z",
    "cves": ["CVE-2024-12345"],
    "keep": true
  }
}

For expiring keeps, use a KeepConstraint object:

{
  "ledger": {
    "addedDate": "2026-05-30T00:00:00.000Z",
    "cves": ["CVE-2024-12345"],
    "keep": {
      "reason": "Waiting for upstream patch",
      "untilVersion": "4.18.0"
    }
  }
}

Once the root dependency reaches 4.18.0, the keep is considered expired and --remove-unused will treat it as removable again.

How It Works

1. Scanning: Pastoralist extracts all dependencies from your package.json (and optionally workspace packages)
2. Checking: Dependencies are checked against the configured provider or providers
3. Reporting: Vulnerable packages are displayed with severity levels and available fixes
4. Fixing: If fixes are available, Pastoralist can:
   • Display them for review
   • Apply them automatically (with --forceSecurityRefactor)
   • Let you choose interactively (with --interactive)
5. Applying: Selected fixes are added to your package.json overrides section with full CVE context in the ledger

Example Output

pastoralist checking for security vulnerabilities...

Security Check Report
==================================================

Found 3 vulnerable package(s):

[email protected]
   Prototype Pollution
   CVE: CVE-2021-23337
   Fix available: 4.17.21
   https://osv.dev/vulnerability/GHSA-35jh-r3h4-6jhm

[email protected]
   Prototype Pollution
   CVE: CVE-2021-44906
   Fix available: 1.2.6
   https://osv.dev/vulnerability/GHSA-xvch-5gv4-984h

Generated 2 override(s):

  "lodash": "4.17.21" // Security fix: Prototype Pollution (high)
  "minimist": "1.2.6" // Security fix: Prototype Pollution (medium)

Performance Considerations

:::caution[Performance Impact]

• Security scanning is disabled by default to maintain fast performance
• Workspace scanning is opt-in via the hasWorkspaceSecurityChecks option
• The OSV provider is optimized for batch queries
• Provider results can be cached using the CLI cache options
• Results are processed in parallel when possible :::

Limitations

:::note[Current Limitations]

• Security checks focus on npm ecosystem packages
• Some providers require credentials or local CLI access
• Some vulnerabilities may not have available fixes :::

Troubleshooting

No vulnerabilities found when expected

• Ensure you're using the latest version of pastoralist
• Check that your dependencies are correctly specified in package.json
• Try running with --debug to see detailed logs

Fixes not being applied

• Verify you have write permissions to package.json
• Check for existing overrides that might conflict
• Ensure the package manager supports overrides

Performance issues

• Disable workspace scanning if not needed
• Consider excluding large dependency trees with excludePackages
• Use severity threshold to limit results

GitHub provider shows "security check skipped"

This happens when the GitHub API can't access Dependabot alerts. To fix:

1. Add vulnerability-alerts: read permission to your workflow
2. Enable Dependabot alerts in Settings → Code security and analysis
3. Ensure the GITHUB_TOKEN is available in your workflow

Pastoralist will show specific guidance in the warning message.

Example: CI/CD Integration

GitHub Actions

name: Security Check
on: [push, pull_request]

jobs:
  security:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      vulnerability-alerts: read # Required for GitHub provider
    steps:
      - uses: actions/checkout@v7
      - uses: actions/[email protected]
      - run: npm install
      - run: npx pastoralist --checkSecurity --securityProvider github
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

For OSV provider (no permissions needed):

name: Security Check
on: [push, pull_request]

jobs:
  security:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
      - uses: actions/[email protected]
      - run: npm install
      - run: npx pastoralist --checkSecurity

GitLab CI

security:
  script:
    - npm install
    - npx pastoralist --checkSecurity
  only:
    - main
    - merge_requests