verdaccio-security-filter 1.3.10 → 1.3.11

package/README.md

@@ -36,17 +36,15 @@ This plugin implements **two independent security layers** for complete protecti
 
 #### 🔒 Version Management
 - **Version Range Blocking** - Block vulnerable versions using semver ranges
-  - **Block Strategy**: Completely remove versions from registry
-  - **Fallback Strategy**: Transparently redirect to safe versions
+  - Matching versions are hidden from metadata and their tarballs return 403, so npm resolves to the highest allowed version
 - **Exact Version Blocking** - Block specific package@version combinations
 - **Semver Support** - Full semver syntax (`^`, `~`, `>`, `>=`, `<`, `<=`, `x`, `*`)
 
 #### 🛡️ CVE & Vulnerability Scanning
 - **OSV Database Integration** - Automatic vulnerability scanning via [OSV API](https://osv.dev/)
 - **Severity Filtering** - Filter by severity: `low`, `medium`, `high`, `critical`
-- **Auto-Block Vulnerable Packages** - Automatically block packages with known CVEs
-- **Caching System** - Configurable cache with update intervals
-- **Multiple Database Support** - Ready for OSV, Snyk, GitHub Advisory
+- **Auto-Block Vulnerable Versions** - Remove versions with known CVEs from metadata
+- **Caching System** - One OSV lookup per package, cached per package with a configurable refresh interval
 
 #### ⚖️ License Compliance
 - **License Filtering** - Enforce license policies with allowed/blocked lists
@@ -62,7 +60,7 @@ This plugin implements **two independent security layers** for complete protecti
 
 #### 📊 Monitoring & Observability
 - **Enhanced Logging** - Configurable log levels (`debug`, `info`, `warn`, `error`)
-- **Metrics Collection** - Track security events (blocks, fallbacks, CVEs, license violations)
+- **Metrics Collection** - Track security events (blocks with their reason, author blocks)
 - **Security Audit Trail** - Detailed logging of all security decisions
 - **Customizable Output** - Log to stdout or file in JSON format
 
@@ -83,9 +81,7 @@ This plugin implements **two independent security layers** for complete protecti
   - Prevents blocked packages from being installed as dependencies
   - Intercepts requests to `/:package/-/:filename.tgz` routes
   - Returns 403 Forbidden with detailed error messages
-- **Size Limits** - Enforce minimum and maximum package sizes
 - **Metadata Validation** - Verify package integrity and detect dangerous characters
-- **Checksum Enforcement** - Ensure package integrity
 
 #### ⚙️ Reliability & Error Handling
 - **Fail-Safe/Fail-Closed Configuration** - Choose error handling strategy
@@ -274,7 +270,6 @@ filters:
       enabled: true
       databases:
         - osv
-        - github
       severity:
         - high
         - critical
@@ -304,8 +299,7 @@ filters:
     versionRangeRules:
       - package: lodash
         range: "<4.17.21"
-        strategy: fallback
-        fallbackVersion: "4.17.21"
+        strategy: block
         reason: "CVE-2021-23337: Command injection"
 
       - package: minimist
@@ -379,7 +373,7 @@ filters:
 
     cveCheck:
       enabled: true
-      databases: [osv, github, snyk]
+      databases: [osv]
       severity: [low, medium, high, critical]  # Block ALL
       autoBlock: true
       updateInterval: 6                         # Check every 6 hours
@@ -389,9 +383,6 @@ filters:
       blocked: [GPL-3.0, AGPL-3.0, LGPL-3.0]
       requireLicense: true
 
-    minPackageSize: 10000      # 10KB minimum
-    maxPackageSize: 10485760   # 10MB maximum
-
     logger:
       level: debug             # Log everything
       enabled: true
@@ -419,23 +410,22 @@ middlewares:
 | `blockedPatterns` | `string[]` | `[]` | Regex patterns for package names |
 | `allowedScopes` | `string[]` | `[]` | Allowed package scopes |
 | `blockedScopes` | `string[]` | `[]` | Blocked package scopes |
-| `minPackageSize` | `number` | `0` | Minimum package size in bytes |
-| `maxPackageSize` | `number` | `104857600` | Maximum package size (100MB) |
-| `enforceChecksum` | `boolean` | `true` | Enforce checksum validation |
 
 ### CVE Check Options
 
 | Option | Type | Default | Description |
 |--------|------|---------|-------------|
 | `cveCheck.enabled` | `boolean` | `false` | Enable CVE scanning |
-| `cveCheck.databases` | `string[]` | `['osv']` | Databases: `osv`, `snyk`, `github` |
+| `cveCheck.databases` | `string[]` | `['osv']` | Vulnerability databases. Only `osv` is implemented; it already includes GitHub Security Advisories |
 | `cveCheck.severity` | `string[]` | `['high', 'critical']` | Severity levels to check |
 | `cveCheck.autoBlock` | `boolean` | `false` | Remove vulnerable versions from metadata (whole package blocked if every version is vulnerable) |
-| `cveCheck.updateInterval` | `number` | `24` | Cache update interval (hours) |
+| `cveCheck.updateInterval` | `number` | `24` | How long a package's vulnerability data is cached (hours) |
 | `cveCheck.cacheDir` | `string` | `./.security-cache` | Cache directory path |
 
 > **Note on `autoBlock` and dist-tags:** only the vulnerable versions are removed; unaffected versions stay installable. Any dist-tag (including `latest`) that points to a removed version is dropped and **not** re-pointed to another version. If `latest` is vulnerable, `npm install <pkg>` without a version or range will fail - install an explicit safe version or range instead (e.g. `npm install <pkg>@^1.2.0`).
 
+> **When OSV is unreachable:** a lookup gets one retry with a 5 second timeout each. After a failure the same package is not looked up again for 60 seconds. Previously cached data, even if older than `updateInterval`, keeps being used. With no cached data, `errorHandling.onCveCheckError` decides: `fail-open` serves the package unchecked, `fail-closed` blocks it.
+
 ### License Options
 
 | Option | Type | Default | Description |
@@ -496,8 +486,7 @@ middlewares:
 | Option | Type | Default | Description |
 |--------|------|---------|-------------|
 | `errorHandling.onFilterError` | `'fail-open' \| 'fail-closed'` | `'fail-open'` | Strategy when filter errors occur |
-| `errorHandling.onCveCheckError` | `'fail-open' \| 'fail-closed'` | `'fail-open'` | Strategy when CVE check fails |
-| `errorHandling.onLicenseCheckError` | `'fail-open' \| 'fail-closed'` | `'fail-open'` | Strategy when license check fails |
+| `errorHandling.onCveCheckError` | `'fail-open' \| 'fail-closed'` | `'fail-open'` | Strategy when the vulnerability lookup fails and no cached data exists |
 
 **Error Handling Strategies:**
 - **fail-open** (Default): Allow packages through on errors (prioritizes availability)
@@ -509,19 +498,16 @@ middlewares:
 errorHandling:
   onFilterError: fail-closed
   onCveCheckError: fail-closed
-  onLicenseCheckError: fail-closed
 
 # Development: Availability-first approach
 errorHandling:
   onFilterError: fail-open
   onCveCheckError: fail-open
-  onLicenseCheckError: fail-open
 
-# Balanced: Block only on license failures
+# Balanced: block only when vulnerability data is unavailable
 errorHandling:
   onFilterError: fail-open
-  onCveCheckError: fail-open
-  onLicenseCheckError: fail-closed
+  onCveCheckError: fail-closed
 ```
 
 ### Version Range Rules
@@ -530,8 +516,7 @@ errorHandling:
 {
   package: string;           // Package name
   range: string;             // Semver range
-  strategy: 'block' | 'fallback';
-  fallbackVersion?: string;  // Required for fallback strategy
+  strategy: 'block';         // 'fallback' is deprecated and behaves like 'block'
   reason?: string;           // Explanation for blocking
 }
 ```
@@ -586,12 +571,7 @@ npm run build -- --watch
 
 When metrics are enabled, the plugin tracks:
 
-- `block` - Packages blocked by version/pattern/scope rules
-- `fallback` - Versions redirected to safe alternatives
-- `publish_rejected` - Publish attempts rejected
-- `cve_detected` - CVE vulnerabilities found
-- `license_blocked` - Packages blocked by license rules
-- `package_too_new` - Packages/versions blocked due to age restrictions
+- `block` - Packages or versions blocked by rules, CVE, license or age checks; the `reason` field says which
 - `author_blocked` - Packages blocked due to author/region filtering
 
 Example metrics output:
@@ -621,17 +601,18 @@ versionRangeRules:
     reason: "CVE-2021-23337: Command injection vulnerability"
 ```
 
-### 2. Transparent Security Patches (Fallback)
+### 2. Steer Installs to a Patched Version
 
 ```yaml
 versionRangeRules:
   - package: axios
     range: "0.21.1"
-    strategy: fallback
-    fallbackVersion: "0.21.4"
+    strategy: block
     reason: "SSRF vulnerability fix"
 ```
 
+The blocked version disappears from the package metadata, so a range such as `axios@^0.21.0` resolves to the newest allowed version. A lockfile pinned to the blocked version fails with 403 until it is updated.
+
 ### 3. Enforce Corporate License Policy
 
 ```yaml
@@ -665,7 +646,7 @@ whitelist:
 ```yaml
 cveCheck:
   enabled: true
-  databases: [osv, github]
+  databases: [osv]
   severity: [high, critical]
   autoBlock: true
   updateInterval: 12

package/build/index.js

@@ -64,7 +64,6 @@ class SecurityFilterPlugin {
             this.config.errorHandling = {
                 onFilterError: 'fail-open',
                 onCveCheckError: 'fail-open',
-                onLicenseCheckError: 'fail-open',
             };
         }
         this.logger = new logger_1.SecurityLogger(options.logger, this.config.logger);
@@ -77,11 +76,8 @@ class SecurityFilterPlugin {
         this.securityRules = {
             blockedVersions: this.config.blockedVersions || [],
             blockedPatterns: this.config.blockedPatterns || [],
-            minPackageSize: this.config.minPackageSize || 0,
-            maxPackageSize: this.config.maxPackageSize || 100 * 1024 * 1024,
             allowedScopes: this.config.allowedScopes || [],
             blockedScopes: this.config.blockedScopes || [],
-            enforceChecksum: this.config.enforceChecksum !== false,
             versionRangeRules: this._parseVersionRangeRules(this.config.versionRangeRules || [])
         };
         this.blockedPatternRegexes = this.securityRules.blockedPatterns.flatMap(pattern => {
@@ -323,9 +319,10 @@ class SecurityFilterPlugin {
                     this.metrics.recordBlock(packageName, '*', blockResult.reason);
                     return this._blockedPackage(pkg, blockResult.reason, { rules: this._getAppliedRules(packageName) });
                 }
-                if (this.securityRules.blockedVersions.length > 0 || this.securityRules.versionRangeRules.length > 0) {
-                    const ruleBlocked = Object.keys(pkg.versions || {})
-                        .filter(version => this._versionBlockReason(packageName, version) !== null);
+                const whitelistMode = this.config.mode === 'whitelist';
+                if (whitelistMode || this.securityRules.blockedVersions.length > 0 || this.securityRules.versionRangeRules.length > 0) {
+                    const ruleBlocked = Object.keys(pkg.versions || {}).filter(version => this._versionBlockReason(packageName, version) !== null ||
+                        (whitelistMode && !this.whitelistChecker.isWhitelisted(packageName, version).allowed));
                     if (ruleBlocked.length > 0) {
                         this.logger.warn(`[filter_metadata] RULE FILTERED: ${packageName}: ${ruleBlocked.join(', ')}`);
                         pkg = this._removeVersions(pkg, ruleBlocked);

package/build/lib/metrics.d.ts

@@ -9,9 +9,7 @@ export declare class MetricsCollector {
     constructor(config?: MetricsConfig);
     record(event: MetricsData): void;
     recordBlock(packageName: string, version: string, reason: string, metadata?: Record<string, any>): void;
-    recordFallback(packageName: string, fromVersion: string, toVersion: string, reason: string): void;
     recordPublishRejected(packageName: string, version: string, reason: string): void;
-    recordCVE(packageName: string, version: string, cveId: string, severity: string): void;
     recordLicenseBlock(packageName: string, version: string, license: string, reason: string): void;
     recordPackageTooNew(packageName: string, version: string, reason: string, metadata?: Record<string, any>): void;
     flush(): void;

package/build/lib/metrics.js

@@ -75,16 +75,6 @@ class MetricsCollector {
             metadata,
         });
     }
-    recordFallback(packageName, fromVersion, toVersion, reason) {
-        this.record({
-            timestamp: new Date().toISOString(),
-            event: 'fallback',
-            packageName,
-            version: fromVersion,
-            reason,
-            metadata: { toVersion },
-        });
-    }
     recordPublishRejected(packageName, version, reason) {
         this.record({
             timestamp: new Date().toISOString(),
@@ -94,16 +84,6 @@ class MetricsCollector {
             reason,
         });
     }
-    recordCVE(packageName, version, cveId, severity) {
-        this.record({
-            timestamp: new Date().toISOString(),
-            event: 'cve_detected',
-            packageName,
-            version,
-            reason: `CVE ${cveId} (${severity})`,
-            metadata: { cveId, severity },
-        });
-    }
     recordLicenseBlock(packageName, version, license, reason) {
         this.record({
             timestamp: new Date().toISOString(),

package/build/lib/whitelist-checker.d.ts

@@ -12,13 +12,8 @@ export declare class WhitelistChecker {
     addPackage(packageName: string, versionRange?: string): void;
     removePackage(packageName: string): void;
     addPattern(pattern: string): void;
-    meetsAutoApproveCriteria(_packageName: string): Promise<{
-        approved: boolean;
-        reason?: string;
-    }>;
     getSummary(): {
         totalPackages: number;
         totalPatterns: number;
-        hasAutoApprove: boolean;
     };
 }

package/build/lib/whitelist-checker.js

@@ -32,15 +32,6 @@ var __importStar = (this && this.__importStar) || (function () {
         return result;
     };
 })();
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WhitelistChecker = void 0;
 const semver = __importStar(require("semver"));
@@ -51,7 +42,6 @@ class WhitelistChecker {
             packages: (config === null || config === void 0 ? void 0 : config.packages) || [],
             patterns: (config === null || config === void 0 ? void 0 : config.patterns) || [],
             versions: (config === null || config === void 0 ? void 0 : config.versions) || {},
-            autoApprove: config === null || config === void 0 ? void 0 : config.autoApprove,
         };
     }
     isWhitelisted(packageName, version) {
@@ -115,22 +105,10 @@ class WhitelistChecker {
             this.config.patterns.push(pattern);
         }
     }
-    meetsAutoApproveCriteria(_packageName) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!this.config.autoApprove) {
-                return { approved: false, reason: 'Auto-approve not configured' };
-            }
-            return {
-                approved: false,
-                reason: 'Auto-approve requires npm registry API integration (not implemented)',
-            };
-        });
-    }
     getSummary() {
         return {
             totalPackages: this.config.packages.length,
             totalPatterns: this.config.patterns.length,
-            hasAutoApprove: !!this.config.autoApprove,
         };
     }
 }

package/build/types.d.ts

@@ -1,4 +1,4 @@
-import { Config, Version } from '@verdaccio/types';
+import { Config } from '@verdaccio/types';
 export interface VersionRangeRule {
     package: string;
     range: string;
@@ -8,7 +8,7 @@ export interface VersionRangeRule {
 }
 export interface CVECheckConfig {
     enabled: boolean;
-    databases: ('osv' | 'snyk' | 'github')[];
+    databases: 'osv'[];
     severity: ('low' | 'medium' | 'high' | 'critical')[];
     autoBlock: boolean;
     updateInterval?: number;
@@ -18,11 +18,6 @@ export interface WhitelistConfig {
     packages: string[];
     patterns: string[];
     versions?: Record<string, string>;
-    autoApprove?: {
-        minDownloads?: number;
-        minStars?: number;
-        verifiedPublisher?: boolean;
-    };
 }
 export interface LicenseConfig {
     allowed: string[];
@@ -59,11 +54,8 @@ export interface AuthorFilterConfig {
 export interface SecurityConfig extends Config {
     blockedVersions?: string[];
     blockedPatterns?: string[];
-    minPackageSize?: number;
-    maxPackageSize?: number;
     allowedScopes?: string[];
     blockedScopes?: string[];
-    enforceChecksum?: boolean;
     versionRangeRules?: VersionRangeRule[];
     mode?: 'blacklist' | 'whitelist';
     whitelist?: WhitelistConfig;
@@ -76,32 +68,15 @@ export interface SecurityConfig extends Config {
     errorHandling?: {
         onFilterError?: 'fail-open' | 'fail-closed';
         onCveCheckError?: 'fail-open' | 'fail-closed';
-        onLicenseCheckError?: 'fail-open' | 'fail-closed';
     };
 }
 export interface SecurityRules {
     blockedVersions: string[];
     blockedPatterns: string[];
-    minPackageSize: number;
-    maxPackageSize: number;
     allowedScopes: string[];
     blockedScopes: string[];
-    enforceChecksum: boolean;
     versionRangeRules: VersionRangeRule[];
 }
-export interface VersionData extends Version {
-    _fallback?: boolean;
-    _fallbackFrom?: string;
-    _fallbackReason?: string;
-}
-export interface FilterResult {
-    versions: Record<string, VersionData>;
-    blockedVersions: string[];
-    fallbacksApplied: Array<{
-        original: string;
-        fallback: string;
-    }>;
-}
 export interface CVEVulnerability {
     id: string;
     severity: 'low' | 'medium' | 'high' | 'critical';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "verdaccio-security-filter",
-  "version": "1.3.10",
+  "version": "1.3.11",
   "description": "Advanced security filter plugin for Verdaccio with version range blocking and fallback strategies",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -28,6 +28,7 @@
     "test": "jest",
     "test:watch": "jest --watch",
     "test:coverage": "jest --coverage",
+    "test:e2e": "npm run build && jest --testMatch \"**/*.e2e.ts\" --coverage=false",
     "debug:verdaccio": "node --inspect-brk $(which verdaccio)",
     "debug:build": "npm run build && npm link",
     "prepack": "npm run build",
@@ -55,7 +56,7 @@
   },
   "overrides": {
     "qs": "6.16.0",
-    "@cypress/request": "latest"
+    "@cypress/request": "3.0.10"
   },
   "author": {
     "name": "Vitaliy Ponomarenko",