mirror of
https://github.com/safedep/pmg.git
synced 2026-08-03 07:24:09 +02:00
* feat(cooldown): respect trusted_packages in dependency cooldown Trusted packages are now treated as a superset waiver that bypasses every PMG control (malware analysis, cooldown, and any future controls). A globally trusted package is automatically exempt from the cooldown window and no longer needs a duplicate entry in dependency_cooldown.skip. The skip list remains the narrower, cooldown-only waiver for packages that must bypass the cooldown wait but still be malware-scanned. * refactor(cooldown): tag skip reason and audit-log skipped packages Address review feedback on #342: - Restore cooldownSkip to a pure single-list function (SRP); the merge into trusted_packages now happens in a separate mergeCooldownSkip step, driven by the exported CooldownSkip wrapper. - Extend CooldownSkipInfo with a CooldownSkipReason (TrustedPackage / CooldownSkipList) on both SkipAll and per-version entries, so callers can tell apart the broad waiver from the cooldown-only one. When both lists match the same package, trusted_packages wins. - Add audit.LogCooldownSkipped and emit it from the npm and PyPI interceptors on the SkipAll path, alongside the existing info log, carrying the source list as the reason. * refactor(cooldown): inline list merge, audit per-version exemptions Address further review feedback: - Drop the separate mergeCooldownSkip helper; cooldownSkip now writes into a shared *CooldownSkipInfo and is called twice from CooldownSkip (cooldown skip list first, trusted_packages on top so trusted entries override the reason on overlap). - Audit log every exemption, not just SkipAll: a new auditCooldownSkip helper in proxy/interceptors/cooldown.go emits one event per match (package-wide or per-version), each tagged with its source list. LogCooldownSkipped gains a version argument for the per-version case. - Cover the trusted_packages reason path in TestCooldownSkip. * fix(cooldown): avoid double-auditing trusted package exemptions auditCooldownSkip now only emits EventTypeCooldownSkipped for entries that came from dependency_cooldown.skip. Trusted-package exemptions already get an EventTypeInstallTrustedAllowed event at tarball-download time (proxy/interceptors/base_registry.go), so emitting a cooldown event for them too would double-count the same waiver. * emit trusted and cooldown skip events to cloud * fix tests * refactor(cooldown): return value from collectCooldownSkip, short-circuit on trusted SkipAll Address PR review feedback: - Rename cooldownSkip to collectCooldownSkip and return CooldownSkipInfo instead of mutating an input pointer. - Add mergeCooldownSkip to combine per-list results with trusted_packages taking precedence on overlap. - CooldownSkip now consults trusted_packages first and returns immediately on a package-wide trusted exemption (DC skip list cannot add anything). - Extend tests to cover disjoint pinned entries across both lists and the case where DC version-less subsumes a trusted pinned entry. * fix(audit): address cooldown review feedback * fix(cooldown): audit cooldown skips at download time with concrete version Backend rejects PackageVersion messages without a version, and audit logs should reflect the runtime fact (a specific version was skipped) rather than the config rule. Move the audit emission from metadata-request handling to download-request handling, where the concrete version is known, and require version in LogCooldownSkipped. * chore(audit): drop dead scope assignment in LogCooldownSkipped * refactor(cooldown): move skip-list logic into cooldown handlers Registry interceptors no longer compute CooldownSkip or branch on SkipAll; they just call HandleMetadataRequest. The npm and pypi cooldown handlers own the skip lookup, the package-wide exemption short-circuit, and (for pypi) the canonical-name denormalization. Also align LogCooldownSkipped with other LogXxx signatures by taking *packagev1.PackageVersion. * fix: Simplify audit logging for dependency cooldown skip * refactor: Simplify cooldown handling and maintain separation of concepts for trusted and DC skip packages * fix: Code review fixes * fix: Emit cooldown skipped audit event ONLY when an in-window version is skipped --------- Co-authored-by: Abhisek Datta <abhisek.datta@gmail.com>
143 lines
5.2 KiB
Go
143 lines
5.2 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,
|
|
execContext InterceptorContext,
|
|
) *NpmRegistryInterceptor {
|
|
return &NpmRegistryInterceptor{
|
|
baseRegistryInterceptor: baseRegistryInterceptor{
|
|
analyzer: analyzer,
|
|
cache: cache,
|
|
statsCollector: statsCollector,
|
|
confirmationChan: confirmationChan,
|
|
circuitBreaker: newAnalyzerCircuitBreaker("malysis-analyzer-npm"),
|
|
execContext: execContext,
|
|
},
|
|
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 {
|
|
if pmgconfig.IsTrustedPackageAllVersions(packagev1.Ecosystem_ECOSYSTEM_NPM, pkgInfo.GetName()) {
|
|
return &proxy.InterceptorResponse{Action: proxy.ActionAllow}, nil
|
|
}
|
|
return i.cooldownHandler.HandleMetadataRequest(ctx, pkgInfo.GetName(), depCooldownConfig.Days, i.execContext.PinnedVersions[pkgInfo.GetName()])
|
|
}
|
|
|
|
log.Debugf("[%s] Skipping analysis for metadata request: %s", ctx.RequestID, pkgInfo.GetName())
|
|
return &proxy.InterceptorResponse{Action: proxy.ActionAllow}, nil
|
|
}
|
|
|
|
if resp, ok := i.fastAllow(ctx, packagev1.Ecosystem_ECOSYSTEM_NPM, pkgInfo.GetName(), pkgInfo.GetVersion()); ok {
|
|
return resp, 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)
|
|
}
|