hc registry firewall - Harness CLI

The firewall commands help you audit dependencies for security vulnerabilities, license compliance, and policy violations before deploying or publishing artifacts.

Usage

hc registry firewall <subcommand> [flags]

Alias

You can use fw as a shorthand:

hc registry fw audit --registry my-npm-reg --file package-lock.json

Available Subcommands

Subcommand	Description
audit	Parse and evaluate dependencies from lock files
explain	Get detailed firewall status for a specific artifact

Audit Dependencies

Parse dependency lock files and evaluate all dependencies against firewall policies configured in your registry.

Usage

hc registry firewall audit --registry <registry-name> --file <lock-file> [flags]

Options

--registry

string

required

Registry name to evaluate against

--file

string

required

Path to dependency lock file

--org

string

Organization identifier (defaults to global config)

--project

string

Project identifier (defaults to global config)

Supported Dependency Files

NPM Registries

package.json
package-lock.json
yarn.lock
pnpm-lock.yaml

Python Registries

requirements.txt
pyproject.toml
Pipfile.lock
poetry.lock

Maven Registries

pom.xml
build.gradle
build.gradle.kts

Examples

Audit NPM Dependencies

hc registry firewall audit \
  --registry my-npm-registry \
  --file package-lock.json

Audit Python Dependencies

hc registry firewall audit \
  --registry my-pypi-registry \
  --file requirements.txt

Audit Maven Dependencies

hc registry firewall audit \
  --registry my-maven-registry \
  --file pom.xml

Audit Output

$ hc registry firewall audit --registry my-npm-registry --file package-lock.json

✓ Found registry: abc123 (type: NPM)
✓ Found 145 dependencies in package-lock.json
✓ Bulk evaluation initiated with ID: eval-xyz789
✓ Bulk evaluation completed successfully

✓ Scan Results for 145 dependencies:

✗ Blocked: 3
⚠ Warnings: 12
✓ Allowed: 128
? Unknown: 2

Package Name           Version    Status
axios                  0.21.1     BLOCKED
lodash                 4.17.20    BLOCKED
node-fetch             2.6.0      BLOCKED
moment                 2.29.1     WARN
request                2.88.2     WARN
express                4.17.1     ALLOWED
react                  17.0.2     ALLOWED
...

Status Meanings

Status	Icon	Description
BLOCKED	✗	Dependency violates firewall policy and should not be used
WARN	⚠	Dependency has warnings but is not blocked
ALLOWED	✓	Dependency passes all firewall policies
UNKNOWN	?	Dependency status could not be determined

JSON Output

hc registry firewall audit \
  --registry my-npm-registry \
  --file package-lock.json \
  --format json

[
  {
    "packageName": "axios",
    "version": "0.21.1",
    "scanId": "550e8400-e29b-41d4-a716-446655440000",
    "scanStatus": "BLOCKED"
  },
  {
    "packageName": "express",
    "version": "4.17.1",
    "scanId": "660e8400-e29b-41d4-a716-446655440001",
    "scanStatus": "ALLOWED"
  }
]

Explain Status

Get detailed information about why a specific package version is blocked, warned, or allowed.

Usage

hc registry firewall explain \
  --registry <registry-name> \
  --package <package-name> \
  --version <version> \
  [flags]

Options

--registry

string

required

Registry name

--package

string

required

Package name to explain

--version

string

required

Package version to explain

--org

string

Organization identifier (defaults to global config)

--project

string

Project identifier (defaults to global config)

Examples

Explain Why Package is Blocked

hc registry firewall explain \
  --registry my-npm-registry \
  --package axios \
  --version 0.21.1

Explain Python Package

hc registry firewall explain \
  --registry my-pypi-registry \
  --package requests \
  --version 2.25.1

Explain Maven Artifact

hc registry firewall explain \
  --registry my-maven-registry \
  --package "org.springframework:spring-core" \
  --version "5.3.8"

Explain Output

$ hc registry firewall explain --registry my-npm-registry --package axios --version 0.21.1

✓ Found registry UUID: abc-123
✓ Evaluation initiated with ID: eval-xyz
✓ Evaluation completed successfully

Scan Result
   Package:     axios
   Version:     0.21.1
   Evaluation Status: BLOCKED
   Evaluation ID:     550e8400-e29b-41d4-a716-446655440000

✗ This artifact version is BLOCKED by the firewall

Evaluation Details:
============================================================
Last Evaluated: 2024-03-15 14:32:10 UTC

Security Fix Information:
  Fix Available: true
  Current Version: 0.21.1
  Fix Version: 0.21.2

Policy Set Violations:

Policy Set 1: Production Security Policy
Policy Set Ref: account.default/prod-security
------------------------------------------------------------

  1.1 Security
      Policy Name: CVE Severity Threshold
      Policy Ref: account.default/cve-threshold

      Vulnerabilities:
      CVE ID              CVSS Score  CVSS Threshold
      CVE-2021-3749      7.5         7.0
      CVE-2021-28918     5.3         7.0

Policy Set 2: License Compliance
Policy Set Ref: account.default/license-policy
------------------------------------------------------------

  2.1 License
      Policy Name: Approved Licenses
      Policy Ref: account.default/approved-licenses

      Blocked License: GPL-3.0
      Allowed Licenses: MIT, Apache-2.0, BSD-3-Clause

Violation Categories

The explain command shows detailed information for three policy categories:

Security Violations

Shows CVE vulnerabilities with CVSS scores:

Security
  Policy Name: CVE Severity Threshold
  
  Vulnerabilities:
  CVE ID         CVSS Score  CVSS Threshold
  CVE-2021-3749  7.5         7.0
  CVE-2022-1234  8.2         7.0

License Violations

Shows license compliance issues:

License
  Policy Name: Approved Licenses
  
  Blocked License: GPL-3.0
  Allowed Licenses: MIT, Apache-2.0, BSD-3-Clause

Package Age Violations

Shows package age policy violations:

PackageAge
  Policy Name: Minimum Package Age
  
  Published On: 2024-03-01 10:00:00 UTC
  Package Age Threshold: 7 days

Workflow Integration

CI/CD Pipeline Integration

Integrate firewall audits into your CI/CD:

name: Security Audit

on: [push, pull_request]

jobs:
  audit:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      
      - name: Install Harness CLI
        run: |
          curl -L https://github.com/harness/harness-cli/releases/latest/download/hc-linux-amd64 -o hc
          chmod +x hc
          sudo mv hc /usr/local/bin/
      
      - name: Login to Harness
        run: hc login --api-key ${{ secrets.HARNESS_API_KEY }}
      
      - name: Audit Dependencies
        run: |
          hc registry firewall audit \
            --registry npm-prod \
            --file package-lock.json
      
      - name: Fail on Blocked Dependencies
        run: |
          RESULT=$(hc registry firewall audit \
            --registry npm-prod \
            --file package-lock.json \
            --format json)
          
          BLOCKED=$(echo "$RESULT" | jq '[.[] | select(.scanStatus == "BLOCKED")] | length')
          
          if [ "$BLOCKED" -gt 0 ]; then
            echo "❌ Found $BLOCKED blocked dependencies"
            exit 1
          fi

Pre-commit Hook

Add a pre-commit hook to audit before committing:

#!/bin/bash
# .git/hooks/pre-commit

echo "Running dependency audit..."

if [ -f package-lock.json ]; then
  RESULT=$(hc registry firewall audit \
    --registry npm-prod \
    --file package-lock.json \
    --format json 2>/dev/null)
  
  BLOCKED=$(echo "$RESULT" | jq '[.[] | select(.scanStatus == "BLOCKED")] | length')
  
  if [ "$BLOCKED" -gt 0 ]; then
    echo "❌ Commit blocked: Found $BLOCKED blocked dependencies"
    echo "Run 'hc registry firewall audit --registry npm-prod --file package-lock.json' for details"
    exit 1
  fi
  
  echo "✓ All dependencies passed firewall audit"
fi

Pre-publish Script

Add to package.json:

{
  "scripts": {
    "prepublishOnly": "hc registry firewall audit --registry npm-prod --file package-lock.json"
  }
}

Remediation Workflow

Identify Blocked Dependencies:

hc registry firewall audit --registry my-npm-registry --file package-lock.json

Get Details for Each Blocked Package:

hc registry firewall explain \
  --registry my-npm-registry \
  --package axios \
  --version 0.21.1

Update to Fix Version:
```
npm install axios@0.21.2
```

Re-audit:

hc registry firewall audit --registry my-npm-registry --file package-lock.json

Error Messages

File Not Supported

file 'README.md' is not compatible with package type 'NPM'. 
Valid files for NPM: package.json, package-lock.json, yarn.lock, pnpm-lock.yaml

Solution: Use a supported lock file for the package type.

Registry Not Found

Registry 'nonexistent-registry' not found

Solution: Verify registry name:

hc registry list --package-type NPM

Package Type Mismatch

file 'pom.xml' is not compatible with package type 'NPM'

Solution: Ensure the lock file matches the registry’s package type.

Best Practices

Automate Audits: Run in CI/CD on every commit
Gate Deployments: Block deployments with blocked dependencies
Regular Scans: Audit dependencies weekly even without changes
Fix Immediately: Address blocked dependencies before merging
Monitor Warnings: Track warnings and plan updates
Document Exceptions: Record why specific packages are allowed

hc registry list - List registries
hc registry get - Get registry details
hc registry configure - Configure package managers

Authentication

Registry

Artifact

Infrastructure as Code

Global Options

Utility Commands

Documentation Index

​Usage

​Alias

​Available Subcommands

​Audit Dependencies

​Usage

​Options

​Supported Dependency Files

​NPM Registries

​Python Registries

​Maven Registries

​Examples

​Audit NPM Dependencies

​Audit Python Dependencies

​Audit Maven Dependencies

​Audit Output

​Status Meanings

​JSON Output

​Explain Status

​Usage

​Options

​Examples

​Explain Why Package is Blocked

​Explain Python Package

​Explain Maven Artifact

​Explain Output

​Violation Categories

​Security Violations

​License Violations

​Package Age Violations

​Workflow Integration

​CI/CD Pipeline Integration

​Pre-commit Hook

​Pre-publish Script

​Remediation Workflow

​Error Messages

​File Not Supported

​Registry Not Found

​Package Type Mismatch

​Best Practices

​Related Commands

Build docs developers (and LLMs) love

Usage

Alias

Available Subcommands

Audit Dependencies

Usage

Options

Supported Dependency Files

NPM Registries

Python Registries

Maven Registries

Examples

Audit NPM Dependencies

Audit Python Dependencies

Audit Maven Dependencies

Audit Output

Status Meanings

JSON Output

Explain Status

Usage

Options

Examples

Explain Why Package is Blocked

Explain Python Package

Explain Maven Artifact

Explain Output

Violation Categories

Security Violations

License Violations

Package Age Violations

Workflow Integration

CI/CD Pipeline Integration

Pre-commit Hook

Pre-publish Script

Remediation Workflow

Error Messages

File Not Supported

Registry Not Found

Package Type Mismatch

Best Practices

Related Commands