mirror of
https://github.com/anchore/syft.git
synced 2026-10-31 06:26:30 +01:00
Alex Goodman
eec86cf88d
`:` was escaped as `%3A`, but `%` itself wasn't, so an entry named `a:b.jar` and one named `a%3Ab.jar` got the same `ArchivePath`. Their contents then collide in `FileMetadata` / `FileDigests` (last writer wins) and share artifact IDs. `%` is now escaped as `%25` before `:`, which makes the encoding injective. The encoding is documented on `Coordinates.ArchivePath` and in the schema. Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>
67 lines
2.7 KiB
Go
67 lines
2.7 KiB
Go
package archive
|
|
|
|
import (
|
|
"context"
|
|
"strings"
|
|
|
|
"github.com/anchore/syft/syft/file"
|
|
)
|
|
|
|
// Traversal describes the archive whose contents a cataloger is running against. The archive
|
|
// cataloger task puts one on the context before running catalogers inside an archive, so a cataloger
|
|
// such as java can describe the archive it is inside without owning the recursion.
|
|
type Traversal struct {
|
|
// Location is the archive file's location within its parent filesystem. Its ArchivePath names the
|
|
// archives above it, so VirtualPath(Location) is the full chain from the scan root.
|
|
Location file.Location
|
|
|
|
// Digests are of the archive file itself, taken during extraction; a cataloger running inside the
|
|
// archive cannot compute them since the archive is not inside itself.
|
|
Digests []file.Digest
|
|
}
|
|
|
|
// VirtualPath returns the colon-delimited chain of archives from the scan root to loc, ending in loc
|
|
// itself: "app.war:WEB-INF/lib/dep.jar". Outside any archive it is the location's path unchanged. In an
|
|
// entry name '%' is escaped as "%25" and then ':' as "%3A", so splitting on ':' recovers the archive
|
|
// boundaries and no two entry names share an escaped form. The leading slash is dropped to match the
|
|
// java cataloger, which joins slash-less zip entry names onto the containing archive's path.
|
|
func VirtualPath(loc file.Location) string {
|
|
if loc.ArchivePath == "" {
|
|
return loc.Path()
|
|
}
|
|
return loc.ArchivePath + ":" + strings.TrimPrefix(escapeEntryPath(loc.Path()), "/")
|
|
}
|
|
|
|
var entryPathEscaper = strings.NewReplacer("%", "%25", ":", "%3A")
|
|
|
|
func escapeEntryPath(p string) string {
|
|
return entryPathEscaper.Replace(p)
|
|
}
|
|
|
|
type traversalCtxKey struct{}
|
|
|
|
func WithTraversal(ctx context.Context, t *Traversal) context.Context {
|
|
return context.WithValue(ctx, traversalCtxKey{}, t)
|
|
}
|
|
|
|
// TraversalFromContext returns the archive traversal on the context, or nil outside an archive.
|
|
func TraversalFromContext(ctx context.Context) *Traversal {
|
|
t, _ := ctx.Value(traversalCtxKey{}).(*Traversal)
|
|
return t
|
|
}
|
|
|
|
type nestedCatalogingCtxKey struct{}
|
|
|
|
// WithNestedCataloging marks the context of a scan whose archive cataloger task will extract every
|
|
// archive and run the catalogers inside it. syft.CreateSBOM sets it before any task runs, so a
|
|
// cataloger that would otherwise open archives itself can leave them to the task instead.
|
|
func WithNestedCataloging(ctx context.Context) context.Context {
|
|
return context.WithValue(ctx, nestedCatalogingCtxKey{}, true)
|
|
}
|
|
|
|
// NestedCatalogingEnabled reports whether the archive cataloger task is extracting archives in this scan.
|
|
func NestedCatalogingEnabled(ctx context.Context) bool {
|
|
enabled, _ := ctx.Value(nestedCatalogingCtxKey{}).(bool)
|
|
return enabled
|
|
}
|