@soos-io/soos-sbom 0.1.10-pre.1 → 0.1.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +42 -42
  2. package/package.json +44 -44
  3. package/test-files/graphql.cdx.json +104 -104
package/README.md CHANGED
@@ -1,42 +1,42 @@
1
- # [SOOS SBOM](https://soos.io/products/sbom-manager)
2
-
3
- SOOS is an independent software security company, located in Winooski, VT USA, building security software for your team. [SOOS, Software security, simplified](https://soos.io).
4
-
5
- Use SOOS to scan your software for [vulnerabilities](https://app.soos.io/research/vulnerabilities) and [open source license](https://app.soos.io/research/licenses) issues with [SOOS Core SCA](https://soos.io/products/sca). [Generate and ingest SBOMs](https://soos.io/products/sbom-manager). [Export reports](https://kb.soos.io/help/soos-reports-for-export) to industry standards. Govern your open source dependencies. Run the [SOOS DAST vulnerability scanner](https://soos.io/products/dast) against your web apps or APIs. [Scan your Docker containers](https://soos.io/products/containers) for vulnerabilities. Check your source code for issues with [SAST Analysis](https://soos.io/products/sast).
6
-
7
- [Demo SOOS](https://app.soos.io/demo) or [Register for a Free Trial](https://app.soos.io/register).
8
-
9
- If you maintain an Open Source project, sign up for the Free as in Beer [SOOS Community Edition](https://soos.io/products/community-edition).
10
-
11
- ## Requirements
12
- - [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
13
-
14
- ## Installation
15
-
16
- ### Globally
17
- run `npm i -g @soos-io/soos-sbom@latest`
18
- Then Run `soos-sbom` from any terminal and add the parameters you want.
19
-
20
- ### Locally
21
- run `npm install --prefix ./soos @soos-io/soos-sbom`
22
- Then run from the same terminal `node ./soos/node_modules/@soos-io/soos-sbom/bin/index.js`
23
-
24
- ## Client Parameters
25
-
26
-
27
- | Argument | Default | Description |
28
- | ----------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
29
- | `--apiKey` | | SOOS API Key - get yours from [SOOS Integration](https://app.soos.io/integrate/sbom). Uses `SOOS_API_KEY` env value if present. |
30
- | `--branchName` | | The name of the branch from the SCM System. |
31
- | `--branchURI` | | The URI to the branch from the SCM System. |
32
- | `--buildURI` | | URI to CI build info. |
33
- | `--buildVersion` | | Version of application build artifacts. |
34
- | `--clientId` | | SOOS Client ID - get yours from [SOOS Integration](https://app.soos.io/integrate/sbom). Uses `SOOS_API_CLIENT` env value if present. |
35
- | `--commitHash` | | The commit hash value from the SCM System. |
36
- | `--logLevel` | `INFO` | Minimum level to show logs: PASS, IGNORE, INFO, WARN, or FAIL. |
37
- | `--onFailure` | `continue_on_failure` | Action to perform when the scan fails. Options: fail_the_build, continue_on_failure. |
38
- | `--operatingEnvironment`| | Set Operating environment for information purposes only. |
39
- | `--otherOptions` | | Other Options to pass to syft. |
40
- | `--projectName` | | Project Name - this is what will be displayed in the SOOS app. |
41
- | `--verbose` | `false` | Enable verbose logging. |
42
- | `sbomPath` | | The SBOM File to scan, it could be the location of the file or the file itself. When location is specified only the first file found will be scanned. |
1
+ # [SOOS SBOM](https://soos.io/products/sbom-manager)
2
+
3
+ SOOS is an independent software security company, located in Winooski, VT USA, building security software for your team. [SOOS, Software security, simplified](https://soos.io).
4
+
5
+ Use SOOS to scan your software for [vulnerabilities](https://app.soos.io/research/vulnerabilities) and [open source license](https://app.soos.io/research/licenses) issues with [SOOS Core SCA](https://soos.io/products/sca). [Generate and ingest SBOMs](https://soos.io/products/sbom-manager). [Export reports](https://kb.soos.io/help/soos-reports-for-export) to industry standards. Govern your open source dependencies. Run the [SOOS DAST vulnerability scanner](https://soos.io/products/dast) against your web apps or APIs. [Scan your Docker containers](https://soos.io/products/containers) for vulnerabilities. Check your source code for issues with [SAST Analysis](https://soos.io/products/sast).
6
+
7
+ [Demo SOOS](https://app.soos.io/demo) or [Register for a Free Trial](https://app.soos.io/register).
8
+
9
+ If you maintain an Open Source project, sign up for the Free as in Beer [SOOS Community Edition](https://soos.io/products/community-edition).
10
+
11
+ ## Requirements
12
+ - [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
13
+
14
+ ## Installation
15
+
16
+ ### Globally
17
+ run `npm i -g @soos-io/soos-sbom@latest`
18
+ Then Run `soos-sbom` from any terminal and add the parameters you want.
19
+
20
+ ### Locally
21
+ run `npm install --prefix ./soos @soos-io/soos-sbom`
22
+ Then run from the same terminal `node ./soos/node_modules/@soos-io/soos-sbom/bin/index.js`
23
+
24
+ ## Client Parameters
25
+
26
+
27
+ | Argument | Default | Description |
28
+ | ----------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
29
+ | `--apiKey` | | SOOS API Key - get yours from [SOOS Integration](https://app.soos.io/integrate/sbom). Uses `SOOS_API_KEY` env value if present. |
30
+ | `--branchName` | | The name of the branch from the SCM System. |
31
+ | `--branchURI` | | The URI to the branch from the SCM System. |
32
+ | `--buildURI` | | URI to CI build info. |
33
+ | `--buildVersion` | | Version of application build artifacts. |
34
+ | `--clientId` | | SOOS Client ID - get yours from [SOOS Integration](https://app.soos.io/integrate/sbom). Uses `SOOS_API_CLIENT` env value if present. |
35
+ | `--commitHash` | | The commit hash value from the SCM System. |
36
+ | `--logLevel` | `INFO` | Minimum level to show logs: PASS, IGNORE, INFO, WARN, or FAIL. |
37
+ | `--onFailure` | `continue_on_failure` | Action to perform when the scan fails. Options: fail_the_build, continue_on_failure. |
38
+ | `--operatingEnvironment`| | Set Operating environment for information purposes only. |
39
+ | `--otherOptions` | | Other Options to pass to syft. |
40
+ | `--projectName` | | Project Name - this is what will be displayed in the SOOS app. |
41
+ | `--verbose` | `false` | Enable verbose logging. |
42
+ | `sbomPath` | | The SBOM File to scan, it could be the location of the file or the file itself. When location is specified only the first file found will be scanned. |
package/package.json CHANGED
@@ -1,44 +1,44 @@
1
- {
2
- "name": "@soos-io/soos-sbom",
3
- "version": "0.1.10-pre.1",
4
- "description": "SOOS wrapper script to upload SBOMs.",
5
- "main": "bin/index.js",
6
- "scripts": {
7
- "setup:install": "npm install",
8
- "setup:clean-install": "npm ci",
9
- "setup:update": "npx npm-check -u",
10
- "setup:clean": "npx rimraf node_modules && npx rimraf package-lock.json",
11
- "build": "tsc",
12
- "build:clean": "npx rimraf build",
13
- "format": "prettier ./src --check",
14
- "format:fix": "prettier ./src --write",
15
- "typecheck": "tsc --noEmit",
16
- "check": "npm run format && npm run typecheck && npm outdated",
17
- "patch-api-client": "npm version patch --no-git-tag-version && npm run setup:clean && npm install @soos-io/api-client@latest --save-exact && npm install && npm run check"
18
- },
19
- "repository": {
20
- "type": "git",
21
- "url": "git+https://github.com/soos-io/soos-sbom.git"
22
- },
23
- "author": "SOOS",
24
- "license": "MIT",
25
- "bugs": {
26
- "url": "https://github.com/soos-io/soos-sbom/issues"
27
- },
28
- "homepage": "https://github.com/soos-io/soos-sbom#readme",
29
- "dependencies": {
30
- "@soos-io/api-client": "0.2.29",
31
- "argparse": "^2.0.1",
32
- "glob": "^10.3.10",
33
- "tslib": "^2.6.2"
34
- },
35
- "devDependencies": {
36
- "@types/argparse": "^2.0.14",
37
- "@types/node": "^20.11.5",
38
- "prettier": "^3.2.4",
39
- "typescript": "^5.3.3"
40
- },
41
- "bin": {
42
- "soos-sbom": "bin/index.js"
43
- }
44
- }
1
+ {
2
+ "name": "@soos-io/soos-sbom",
3
+ "version": "0.1.10",
4
+ "description": "SOOS wrapper script to upload SBOMs.",
5
+ "main": "bin/index.js",
6
+ "scripts": {
7
+ "setup:install": "npm install",
8
+ "setup:clean-install": "npm ci",
9
+ "setup:update": "npx npm-check -u",
10
+ "setup:clean": "npx rimraf node_modules && npx rimraf package-lock.json",
11
+ "build": "tsc",
12
+ "build:clean": "npx rimraf build",
13
+ "format": "prettier ./src --check",
14
+ "format:fix": "prettier ./src --write",
15
+ "typecheck": "tsc --noEmit",
16
+ "check": "npm run format && npm run typecheck && npm outdated",
17
+ "patch-api-client": "npm version patch --no-git-tag-version && npm run setup:clean && npm install @soos-io/api-client@latest --save-exact && npm install && npm run check"
18
+ },
19
+ "repository": {
20
+ "type": "git",
21
+ "url": "git+https://github.com/soos-io/soos-sbom.git"
22
+ },
23
+ "author": "SOOS",
24
+ "license": "MIT",
25
+ "bugs": {
26
+ "url": "https://github.com/soos-io/soos-sbom/issues"
27
+ },
28
+ "homepage": "https://github.com/soos-io/soos-sbom#readme",
29
+ "dependencies": {
30
+ "@soos-io/api-client": "0.2.29",
31
+ "argparse": "^2.0.1",
32
+ "glob": "^10.3.10",
33
+ "tslib": "^2.6.2"
34
+ },
35
+ "devDependencies": {
36
+ "@types/argparse": "^2.0.14",
37
+ "@types/node": "^20.11.5",
38
+ "prettier": "^3.2.4",
39
+ "typescript": "^5.3.3"
40
+ },
41
+ "bin": {
42
+ "soos-sbom": "bin/index.js"
43
+ }
44
+ }
package/test-files/graphql.cdx.json CHANGED
@@ -1,105 +1,105 @@
1
- {
2
- "bomFormat": "CycloneDX",
3
- "specVersion": "1.4",
4
- "serialNumber": "urn:uuid:d01162e3-dadf-40cd-bbc8-6a5c1ec4e2f3",
5
- "version": 1,
6
- "metadata": {
7
- "timestamp": "2023-09-27T00:24:23Z",
8
- "tools": [
9
- {
10
- "vendor": "SOOS",
11
- "name": "SOOS SCA",
12
- "version": "31.12.0.1",
13
- "externalReferences": [
14
- {
15
- "url": "https://soos.io/",
16
- "type": "website"
17
- },
18
- {
19
- "url": "https://soos.io/terms-of-service",
20
- "type": "license",
21
- "comment": "SOOS is providing this SBOM for non-commercial use. By downloading an SBOM from SOOS, you agree to all applicable terms at https://soos.io/terms-of-service. If you are interested in commercial SBOM access please contact sales@soos.io"
22
- }
23
- ]
24
- }
25
- ],
26
- "authors": [
27
- {
28
- "email": "support@soos.io"
29
- }
30
- ],
31
- "component": {
32
- "type": "application",
33
- "author": " (support@soos.io)",
34
- "publisher": "SOOS",
35
- "name": "graphql",
36
- "description": "SOOS SCA scan against pkg:npm/graphql@16.8.1",
37
- "hashes": [
38
- {
39
- "alg": "SHA-256",
40
- "content": "fc511a27f8e66409eaad43c808737eed838a6c72640b71bb32c602267c155c4b"
41
- }
42
- ]
43
- },
44
- "licenses": [
45
- {
46
- "license": {
47
- "id": "CC0-1.0"
48
- }
49
- }
50
- ]
51
- },
52
- "components": [
53
- {
54
- "type": "library",
55
- "bom-ref": "pkg:npm/graphql@16.8.1",
56
- "supplier": {
57
- "name": "graphql",
58
- "url": [
59
- "https://github.com/graphql/graphql-js"
60
- ],
61
- "contact": []
62
- },
63
- "name": "graphql",
64
- "version": "16.8.1",
65
- "hashes": [
66
- {
67
- "alg": "SHA-1",
68
- "content": "1930a965bef1170603702acdb68aedd3f3cf6f07"
69
- }
70
- ],
71
- "licenses": [
72
- {
73
- "license": {
74
- "id": "MIT"
75
- }
76
- }
77
- ],
78
- "purl": "pkg:npm/graphql@16.8.1",
79
- "externalReferences": [
80
- {
81
- "url": "https://www.npmjs.com/package/graphql/v/16.8.1",
82
- "type": "website"
83
- }
84
- ]
85
- }
86
- ],
87
- "dependencies": [
88
- {
89
- "ref": "pkg:npm/graphql@16.8.1",
90
- "dependsOn": []
91
- }
92
- ],
93
- "compositions": [
94
- {
95
- "aggregate": "complete",
96
- "dependencies": [
97
- "pkg:npm/graphql@16.8.1"
98
- ]
99
- },
100
- {
101
- "aggregate": "incomplete",
102
- "dependencies": []
103
- }
104
- ]
1
+ {
2
+ "bomFormat": "CycloneDX",
3
+ "specVersion": "1.4",
4
+ "serialNumber": "urn:uuid:d01162e3-dadf-40cd-bbc8-6a5c1ec4e2f3",
5
+ "version": 1,
6
+ "metadata": {
7
+ "timestamp": "2023-09-27T00:24:23Z",
8
+ "tools": [
9
+ {
10
+ "vendor": "SOOS",
11
+ "name": "SOOS SCA",
12
+ "version": "31.12.0.1",
13
+ "externalReferences": [
14
+ {
15
+ "url": "https://soos.io/",
16
+ "type": "website"
17
+ },
18
+ {
19
+ "url": "https://soos.io/terms-of-service",
20
+ "type": "license",
21
+ "comment": "SOOS is providing this SBOM for non-commercial use. By downloading an SBOM from SOOS, you agree to all applicable terms at https://soos.io/terms-of-service. If you are interested in commercial SBOM access please contact sales@soos.io"
22
+ }
23
+ ]
24
+ }
25
+ ],
26
+ "authors": [
27
+ {
28
+ "email": "support@soos.io"
29
+ }
30
+ ],
31
+ "component": {
32
+ "type": "application",
33
+ "author": " (support@soos.io)",
34
+ "publisher": "SOOS",
35
+ "name": "graphql",
36
+ "description": "SOOS SCA scan against pkg:npm/graphql@16.8.1",
37
+ "hashes": [
38
+ {
39
+ "alg": "SHA-256",
40
+ "content": "fc511a27f8e66409eaad43c808737eed838a6c72640b71bb32c602267c155c4b"
41
+ }
42
+ ]
43
+ },
44
+ "licenses": [
45
+ {
46
+ "license": {
47
+ "id": "CC0-1.0"
48
+ }
49
+ }
50
+ ]
51
+ },
52
+ "components": [
53
+ {
54
+ "type": "library",
55
+ "bom-ref": "pkg:npm/graphql@16.8.1",
56
+ "supplier": {
57
+ "name": "graphql",
58
+ "url": [
59
+ "https://github.com/graphql/graphql-js"
60
+ ],
61
+ "contact": []
62
+ },
63
+ "name": "graphql",
64
+ "version": "16.8.1",
65
+ "hashes": [
66
+ {
67
+ "alg": "SHA-1",
68
+ "content": "1930a965bef1170603702acdb68aedd3f3cf6f07"
69
+ }
70
+ ],
71
+ "licenses": [
72
+ {
73
+ "license": {
74
+ "id": "MIT"
75
+ }
76
+ }
77
+ ],
78
+ "purl": "pkg:npm/graphql@16.8.1",
79
+ "externalReferences": [
80
+ {
81
+ "url": "https://www.npmjs.com/package/graphql/v/16.8.1",
82
+ "type": "website"
83
+ }
84
+ ]
85
+ }
86
+ ],
87
+ "dependencies": [
88
+ {
89
+ "ref": "pkg:npm/graphql@16.8.1",
90
+ "dependsOn": []
91
+ }
92
+ ],
93
+ "compositions": [
94
+ {
95
+ "aggregate": "complete",
96
+ "dependencies": [
97
+ "pkg:npm/graphql@16.8.1"
98
+ ]
99
+ },
100
+ {
101
+ "aggregate": "incomplete",
102
+ "dependencies": []
103
+ }
104
+ ]
105
105
  }