@soos-io/soos-sbom 0.1.7 → 0.1.8

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 +13 -19
  2. package/bin/index.js +7 -3
  3. package/package.json +4 -3
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
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
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 SBOMs](https://kb.soos.io/help/soos-reports-for-export). Govern your open source dependencies. Run the [SOOS DAST vulnerability scanner](https://soos.io/products/dast) against your web apps or APIs.
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
6
 
7
7
  [Demo SOOS](https://app.soos.io/demo) or [Register for a Free Trial](https://app.soos.io/register).
8
8
 
@@ -21,28 +21,22 @@ Then Run `soos-sbom` from any terminal and add the parameters you want.
21
21
  run `npm install --prefix ./soos @soos-io/soos-sbom`
22
22
  Then run from the same terminal `node ./soos/node_modules/@soos-io/soos-sbom/bin/index.js`
23
23
 
24
- ## Parameters
24
+ ## Client Parameters
25
25
 
26
26
 
27
27
  | Argument | Default | Description |
28
28
  | ----------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
29
- | `--apiKey` | N/A | SSOOS API Key - get yours from [SOOS Integration](https://app.soos.io/integrate/sbom). Uses `SOOS_API_KEY` env value if present. |
30
- | `--apiURL` | N/A | SOOS API URL - Intended for internal use only, do not modify. |
31
- | `--appVersion` | N/A | App Version - Intended for internal use only. |
32
- | `--branchName` | `null` | The name of the branch from the SCM System. |
33
- | `--branchURI` | `null` | The URI to the branch from the SCM System. |
34
- | `--buildURI` | `null` | URI to CI build info. |
35
- | `--buildVersion` | `null` | Version of application build artifacts. |
36
- | `--clientId` | N/A | SSOOS Client ID - get yours from [SOOS Integration](https://app.soos.io/integrate/sbom). Uses `SOOS_API_CLIENT` env value if present. |
37
- | `--commitHash` | `null` | The commit hash value from the SCM System. |
38
- | `--integrationName` | N/A | Integration Name - Intended for internal use only. |
39
- | `--integrationType` | N/A | Integration Type - Intended for internal use only. |
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. |
40
36
  | `--logLevel` | `INFO` | Minimum level to show logs: PASS, IGNORE, INFO, WARN, or FAIL. |
41
-
42
37
  | `--onFailure` | `continue_on_failure` | Action to perform when the scan fails. Options: fail_the_build, continue_on_failure. |
43
- | `--operatingEnvironment`| `null` | Set Operating environment for information purposes only. |
44
- | `--otherOptions` | `null` | Other Options to pass to syft. |
45
- | `--projectName` | N/A | Project Name - this is what will be displayed in the SOOS app. |
46
- | `--scriptVersion` | N/A | Script Version - Intended for internal use only. |
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. |
47
41
  | `--verbose` | `false` | Enable verbose logging. |
48
- | `sbomPath` | N/A | 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. |
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/bin/index.js CHANGED
@@ -58,6 +58,8 @@ class SOOSSBOMAnalysis {
58
58
  },
59
59
  ],
60
60
  scanType,
61
+ toolName: undefined,
62
+ toolVersion: undefined,
61
63
  });
62
64
  projectHash = result.projectHash;
63
65
  branchHash = result.branchHash;
@@ -88,9 +90,9 @@ class SOOSSBOMAnalysis {
88
90
  scanUrl: result.scanUrl,
89
91
  scanType,
90
92
  });
91
- const exitCode = (0, utilities_1.getAnalysisExitCode)(scanStatus, this.args.integrationName, this.args.onFailure);
92
- api_client_1.soosLogger.debug(`Exiting with code ${exitCode}`);
93
- (0, process_1.exit)(exitCode);
93
+ const exitCodeWithMessage = (0, utilities_1.getAnalysisExitCodeWithMessage)(scanStatus, this.args.integrationName, this.args.onFailure);
94
+ api_client_1.soosLogger.always(`${exitCodeWithMessage.message} - exit ${exitCodeWithMessage.exitCode}`);
95
+ (0, process_1.exit)(exitCodeWithMessage.exitCode);
94
96
  }
95
97
  catch (error) {
96
98
  if (projectHash && branchHash && analysisId) {
@@ -106,6 +108,7 @@ class SOOSSBOMAnalysis {
106
108
  });
107
109
  }
108
110
  api_client_1.soosLogger.error(error);
111
+ api_client_1.soosLogger.always(`${error} - exit 1`);
109
112
  (0, process_1.exit)(1);
110
113
  }
111
114
  }
@@ -139,6 +142,7 @@ class SOOSSBOMAnalysis {
139
142
  }
140
143
  catch (error) {
141
144
  api_client_1.soosLogger.error(`Error on createAndRun: ${error}`);
145
+ api_client_1.soosLogger.always(`Error on createAndRun: ${error} - exit 1`);
142
146
  (0, process_1.exit)(1);
143
147
  }
144
148
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@soos-io/soos-sbom",
3
- "version": "0.1.7",
3
+ "version": "0.1.8",
4
4
  "description": "SOOS wrapper script to upload SBOMs.",
5
5
  "main": "bin/index.js",
6
6
  "scripts": {
@@ -13,7 +13,8 @@
13
13
  "format": "prettier ./src --check",
14
14
  "format:fix": "prettier ./src --write",
15
15
  "typecheck": "tsc --noEmit",
16
- "check": "npm run format && npm run typecheck && npm outdated"
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"
17
18
  },
18
19
  "repository": {
19
20
  "type": "git",
@@ -26,7 +27,7 @@
26
27
  },
27
28
  "homepage": "https://github.com/soos-io/soos-sbom#readme",
28
29
  "dependencies": {
29
- "@soos-io/api-client": "0.2.18",
30
+ "@soos-io/api-client": "0.2.26",
30
31
  "argparse": "^2.0.1",
31
32
  "glob": "^10.3.10",
32
33
  "tslib": "^2.6.2"