mirror of
https://github.com/safedep/pmg.git
synced 2026-08-03 07:24:09 +02:00
* feat: Add dependency cooldown for npm packages Strip recently-published package versions from npm registry metadata responses so npm's resolver naturally falls back to older versions. Overrides the Accept header to force full packument responses (which include the "time" field needed for publish-date checks). Reports cooldown blocks only when all versions are stripped (remaining == 0), matching npm's --min-release-age behavior for silent fallback. * fix: Report oldest version in cooldown block (shortest wait) When all versions are blocked by cooldown, report the oldest version since it exits the cooldown window first — giving the user the shortest wait time instead of the longest. * fix: Handle resp.Body.Close error return for errcheck linter * test: Add dependency cooldown assertions to template config tests * fix: config template for dependency cooldown * fix: Prevent npm from caching cooldown-stripped metadata responses * fix: Restore body on ReadAll failure and log Close errors in response modifier * fix: Close response body before replacing to prevent connection leak * fix: Correct daysLeft ceiling math and update ContentLength on error recovery * fix: Clear Status on status code change and update ContentLength in modifier error path * refactor: address review comments on dependency cooldown PR - Make NpmCooldownHandler and constructor package-private - Pass cooldown days as parameter instead of reading config internally - Convert standalone functions to methods on npmCooldownHandler - Set Accept-Encoding: identity to prevent gzip responses breaking JSON parsing - Return 503 with descriptive message when upstream body read fails * fix: log errors in stripCooldownVersions instead of swallowing them * fix: Config preserve fallback defaults * fix: Code review fixes * fix: correct cooldown tip to show wait time instead of incorrect trusted_packages advice * fix: prevent integer overflow in cooldown duration calculation with large days values * refactor: deduplicate CooldownBlock into internal/models, fix misleading variable names - Move CooldownBlock struct to internal/models to eliminate duplication between proxy/interceptors and internal/ui packages - Simplify proxy_flow.go by using direct assignment instead of field copy - Rename latestStripped/latestDate to oldestVer/oldestDate for clarity * fix: Dependency Cooldown Check Encapsulation (#207) * fix: Encapsulate cooldown check * feat: Add --skip-dependency-cooldown override * fix: Code review fixes --------- Co-authored-by: Abhisek Datta <abhisek.datta@gmail.com>
134 lines
4.7 KiB
Go
134 lines
4.7 KiB
Go
package interceptors
|
|
|
|
import (
|
|
packagev1 "buf.build/gen/go/safedep/api/protocolbuffers/go/safedep/messages/package/v1"
|
|
"github.com/safedep/dry/log"
|
|
"github.com/safedep/pmg/analyzer"
|
|
pmgconfig "github.com/safedep/pmg/config"
|
|
"github.com/safedep/pmg/proxy"
|
|
)
|
|
|
|
var npmRegistryDomains = registryConfigMap{
|
|
"registry.npmjs.org": {
|
|
Host: "registry.npmjs.org",
|
|
SupportedForAnalysis: true,
|
|
Parser: npmParser{},
|
|
},
|
|
"registry.yarnpkg.com": {
|
|
Host: "registry.yarnpkg.com",
|
|
SupportedForAnalysis: true,
|
|
Parser: npmParser{},
|
|
},
|
|
"npm.pkg.github.com": {
|
|
Host: "npm.pkg.github.com",
|
|
SupportedForAnalysis: false, // Skip analysis for now (private packages, auth complexity)
|
|
Parser: npmGithubParser{},
|
|
},
|
|
"pkg-npm.githubusercontent.com": {
|
|
Host: "pkg-npm.githubusercontent.com",
|
|
SupportedForAnalysis: false, // Skip analysis (blob storage, redirected downloads)
|
|
Parser: npmGithubBlobParser{},
|
|
},
|
|
}
|
|
|
|
// NpmRegistryInterceptor intercepts NPM registry requests and analyzes packages for malware
|
|
// It embeds baseRegistryInterceptor to reuse ecosystem agnostic functionality
|
|
type NpmRegistryInterceptor struct {
|
|
baseRegistryInterceptor
|
|
cooldownHandler *npmCooldownHandler
|
|
}
|
|
|
|
var _ proxy.Interceptor = (*NpmRegistryInterceptor)(nil)
|
|
var _ proxy.MITMDecider = (*NpmRegistryInterceptor)(nil)
|
|
|
|
// NewNpmRegistryInterceptor creates a new NPM registry interceptor
|
|
func NewNpmRegistryInterceptor(
|
|
analyzer analyzer.PackageVersionAnalyzer,
|
|
cache AnalysisCache,
|
|
statsCollector *AnalysisStatsCollector,
|
|
confirmationChan chan *ConfirmationRequest,
|
|
) *NpmRegistryInterceptor {
|
|
return &NpmRegistryInterceptor{
|
|
baseRegistryInterceptor: baseRegistryInterceptor{
|
|
analyzer: analyzer,
|
|
cache: cache,
|
|
statsCollector: statsCollector,
|
|
confirmationChan: confirmationChan,
|
|
circuitBreaker: newAnalyzerCircuitBreaker("malysis-analyzer-npm"),
|
|
},
|
|
cooldownHandler: newNpmCooldownHandler(statsCollector),
|
|
}
|
|
}
|
|
|
|
// Name returns the interceptor name for logging
|
|
func (i *NpmRegistryInterceptor) Name() string {
|
|
return "npm-registry-interceptor"
|
|
}
|
|
|
|
func (i *NpmRegistryInterceptor) ShouldMITM(ctx *proxy.RequestContext) bool {
|
|
config := npmRegistryDomains.GetConfigForHostname(ctx.Hostname)
|
|
if config == nil {
|
|
return false
|
|
}
|
|
|
|
return config.SupportedForAnalysis
|
|
}
|
|
|
|
// ShouldIntercept determines if this interceptor should handle the given request
|
|
func (i *NpmRegistryInterceptor) ShouldIntercept(ctx *proxy.RequestContext) bool {
|
|
return npmRegistryDomains.ContainsHostname(ctx.Hostname)
|
|
}
|
|
|
|
// HandleRequest processes the request and returns response action
|
|
// We take a fail-open approach here, allowing requests that we can't parse the package information from the URL.
|
|
func (i *NpmRegistryInterceptor) HandleRequest(ctx *proxy.RequestContext) (*proxy.InterceptorResponse, error) {
|
|
log.Debugf("[%s] Handling NPM registry request: %s", ctx.RequestID, ctx.URL.Path)
|
|
|
|
// Get registry configuration
|
|
config := npmRegistryDomains.GetConfigForHostname(ctx.Hostname)
|
|
if config == nil {
|
|
// Shouldn't happen if ShouldIntercept is working correctly
|
|
log.Warnf("[%s] No registry config found for hostname: %s", ctx.RequestID, ctx.Hostname)
|
|
return &proxy.InterceptorResponse{Action: proxy.ActionAllow}, nil
|
|
}
|
|
|
|
// Skip analysis for registries that are not supported for analysis
|
|
if !config.SupportedForAnalysis {
|
|
log.Debugf("[%s] Skipping analysis for %s registry (not supported for analysis): %s",
|
|
ctx.RequestID, config.Host, ctx.URL.String())
|
|
return &proxy.InterceptorResponse{Action: proxy.ActionAllow}, nil
|
|
}
|
|
|
|
// Parse URL using registry-specific strategy
|
|
pkgInfo, err := config.Parser.ParseURL(ctx.URL.Path)
|
|
if err != nil {
|
|
log.Warnf("[%s] Failed to parse NPM registry URL %s for %s: %v",
|
|
ctx.RequestID, ctx.URL.Path, config.Host, err)
|
|
return &proxy.InterceptorResponse{Action: proxy.ActionAllow}, nil
|
|
}
|
|
|
|
depCooldownConfig := pmgconfig.Get().Config.DependencyCooldown
|
|
|
|
if !pkgInfo.IsFileDownload() {
|
|
if depCooldownConfig.Enabled {
|
|
return i.cooldownHandler.HandleMetadataRequest(ctx, pkgInfo.GetName(), depCooldownConfig.Days)
|
|
}
|
|
|
|
log.Debugf("[%s] Skipping analysis for metadata request: %s", ctx.RequestID, pkgInfo.GetName())
|
|
return &proxy.InterceptorResponse{Action: proxy.ActionAllow}, nil
|
|
}
|
|
|
|
result, err := i.analyzePackage(
|
|
ctx,
|
|
packagev1.Ecosystem_ECOSYSTEM_NPM,
|
|
pkgInfo.GetName(),
|
|
pkgInfo.GetVersion(),
|
|
)
|
|
if err != nil {
|
|
log.Errorf("[%s] Failed to analyze package %s@%s: %v", ctx.RequestID, pkgInfo.GetName(), pkgInfo.GetVersion(), err)
|
|
return &proxy.InterceptorResponse{Action: proxy.ActionAllow}, nil
|
|
}
|
|
|
|
return i.handleAnalysisResult(ctx, packagev1.Ecosystem_ECOSYSTEM_NPM, pkgInfo.GetName(), pkgInfo.GetVersion(), result)
|
|
}
|