Skip to content

feat: Add the origin field to the output format of syftjson #1327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wagoodman merged 5 commits into from
Jan 12, 2023
Merged

feat: Add the origin field to the output format of syftjson #1327

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8078f70
moved the relevant fields to the Metadata field
Dec 6, 2022
55b8676
added metadata types
Dec 6, 2022
c491ccc
Added hashes to metadata of packge-lock.json and Pipfile.lock
Dec 20, 2022
8cecacf
move package metadata types to "pkg" package
wagoodman Jan 12, 2023
37a021d
re-generate json schema to include new npm, python, and binary metadatas
wagoodman Jan 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 26 additions & 19 deletions schema/json/generate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,26 +27,33 @@ can be extended to include specific package metadata struct shapes in the future
// This should represent all possible metadatas represented in the pkg.Package.Metadata field (an interface{}).
// When a new package metadata definition is created it will need to be manually added here. The variable name does
// not matter as long as it is exported.

// TODO: this should be generated from reflection of whats in the pkg package
type artifactMetadataContainer struct {
Apk pkg.ApkMetadata
Alpm pkg.AlpmMetadata
Dpkg pkg.DpkgMetadata
Gem pkg.GemMetadata
Java pkg.JavaMetadata
Npm pkg.NpmPackageJSONMetadata
Python pkg.PythonPackageMetadata
Rpm pkg.RpmMetadata
Cargo pkg.CargoPackageMetadata
Go pkg.GolangMetadata
Php pkg.PhpComposerJSONMetadata
Dart pkg.DartPubMetadata
Dotnet pkg.DotnetDepsMetadata
Portage pkg.PortageMetadata
Conan pkg.ConanMetadata
ConanLock pkg.ConanLockMetadata
KbPackage pkg.KbPackageMetadata
Hackage pkg.HackageMetadata
SwiftCocopods pkg.CocoapodsMetadata
Alpm pkg.AlpmMetadata
Apk pkg.ApkMetadata
Binary pkg.BinaryMetadata
Cocopods pkg.CocoapodsMetadata
Conan pkg.ConanMetadata
ConanLock pkg.ConanLockMetadata
Dart pkg.DartPubMetadata
Dotnet pkg.DotnetDepsMetadata
Dpkg pkg.DpkgMetadata
Gem pkg.GemMetadata
Go pkg.GolangMetadata
Hackage pkg.HackageMetadata
Java pkg.JavaMetadata
KbPackage pkg.KbPackageMetadata
NpmPackage pkg.NpmPackageJSONMetadata
NpmPackageLock pkg.NpmPackageLockJSONMetadata
MixLock pkg.MixLockMetadata
Php pkg.PhpComposerJSONMetadata
Portage pkg.PortageMetadata
PythonPackage pkg.PythonPackageMetadata
PythonPipfilelock pkg.PythonPipfileLockMetadata
Rebar pkg.RebarLockMetadata
Rpm pkg.RpmMetadata
RustCargo pkg.CargoPackageMetadata
}

func main() {
Expand Down
113 changes: 113 additions & 0 deletions schema/json/schema-6.1.0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,25 @@
"files"
]
},
"BinaryMetadata": {
"properties": {
"classifier": {
"type": "string"
},
"realPath": {
"type": "string"
},
"virtualPath": {
"type": "string"
}
},
"type": "object",
"required": [
"classifier",
"realPath",
"virtualPath"
]
},
"CargoPackageMetadata": {
"properties": {
"name": {
Expand Down Expand Up @@ -766,6 +785,29 @@
},
"type": "object"
},
"MixLockMetadata": {
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string"
},
"pkgHash": {
"type": "string"
},
"pkgHashExt": {
"type": "string"
}
},
"type": "object",
"required": [
"name",
"version",
"pkgHash",
"pkgHashExt"
]
},
"NpmPackageJSONMetadata": {
"properties": {
"name": {
Expand Down Expand Up @@ -814,6 +856,21 @@
"private"
]
},
"NpmPackageLockJSONMetadata": {
"properties": {
"resolved": {
"type": "string"
},
"integrity": {
"type": "string"
}
},
"type": "object",
"required": [
"resolved",
"integrity"
]
},
"Package": {
"properties": {
"id": {
Expand Down Expand Up @@ -869,6 +926,9 @@
{
"$ref": "#/$defs/ApkMetadata"
},
{
"$ref": "#/$defs/BinaryMetadata"
},
{
"$ref": "#/$defs/CargoPackageMetadata"
},
Expand Down Expand Up @@ -905,9 +965,15 @@
{
"$ref": "#/$defs/KbPackageMetadata"
},
{
"$ref": "#/$defs/MixLockMetadata"
},
{
"$ref": "#/$defs/NpmPackageJSONMetadata"
},
{
"$ref": "#/$defs/NpmPackageLockJSONMetadata"
},
{
"$ref": "#/$defs/PhpComposerJSONMetadata"
},
Expand All @@ -917,6 +983,12 @@
{
"$ref": "#/$defs/PythonPackageMetadata"
},
{
"$ref": "#/$defs/PythonPipfileLockMetadata"
},
{
"$ref": "#/$defs/RebarLockMetadata"
},
{
"$ref": "#/$defs/RpmMetadata"
}
Expand Down Expand Up @@ -1291,6 +1363,47 @@
"sitePackagesRootPath"
]
},
"PythonPipfileLockMetadata": {
"properties": {
"hashes": {
"items": {
"type": "string"
},
"type": "array"
},
"index": {
"type": "string"
}
},
"type": "object",
"required": [
"hashes",
"index"
]
},
"RebarLockMetadata": {
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string"
},
"pkgHash": {
"type": "string"
},
"pkgHashExt": {
"type": "string"
}
},
"type": "object",
"required": [
"name",
"version",
"pkgHash",
"pkgHashExt"
]
},
"Relationship": {
"properties": {
"parent": {
Expand Down
Loading