eMASS V3.9 Specification Updates #1426

georgedias · 2023-05-23T22:02:04Z

Make updates provided by eMASS specifications 3.5 to 3.9
Add additional endpoints provide by eMASS specifications 3.5 to 3.9

How to test

Checkout (gh pr checkout 1426) or clone (git clone -b emass_v3_9 [email protected]:mitre/saf.git) the PR

Install dependencies

> git install

Build the executables

> npm run prepack

Generate the .env variables

Run the configure command to generate a .env configuration file containing the necessary environmental variables.

For additional information on how too references Generating an eMASS Configuration file

The command to invoke the configure utility from the development environment is:

> node bin\run emasser configure (use -h for help)

You need to know the appropriate API and user key, certificates (key.pem and cert.pem), key cert password, dev env host url.

endpoints added (to test)

> node bin\run emasser get dashboards artifacts_summary -o 14
> node bin\run emasser get dashboards artifacts_details -o 14
> node bin\run emasser get dashboards sensor_hardware_summary -o 14
> node bin\run emasser get dashboards sensor_hardware_details -o 14
> node bin\run emasser get dashboards ports_protocols_summary -o 14
> node bin\run emasser get dashboards ports_protocols_summary -o 14
> node bin\run emasser get dashboards ports_protocols_details -o 14
> node bin\run emasser get dashboards fisma_inventory_crypto_summary -o 14
> node bin\run emasser get dashboards va_threat_risk_summary -o 14
> node bin\run emasser get dashboards va_threat_source_details -o 14
> node bin\run emasser get dashboards va_threat_architecture_details -o 14

Note Some endpoints don't return any data, but should return a 200 status

Test all emasser endpoints

To run all of the emasser unit tests (51) use this command:

> ts-mocha --timeout 8500 --forbid-only .\test\commands\emasser\*

Signed-off-by: George Dias <[email protected]>

mergify · 2023-05-24T05:30:00Z

This pull request has a conflict. Could you fix it @georgedias?

Signed-off-by: George Dias <[email protected]>

package.json

Signed-off-by: George Dias <[email protected]>

em-c-rod · 2023-05-26T14:23:34Z

src/commands/emasser/get/artifacts.ts

@@ -13,7 +13,7 @@ import {FlagOptions,
 const endpoint = 'artifacts'

 export default class EmasserGetArtifacts extends Command {
-  static usage = '<%= command.id %> [ARGUMENTS]';
+  static usage = '<%= command.id %> [ARGUMENT] \n \x1B[93m NOTE: see EXAMPLES for argument case format\x1B[0m';


Which command makes this show up?

bin/run emasser get artifacts -h or --help

em-c-rod · 2023-05-26T14:23:52Z

src/commands/emasser/delete/poams.ts

@@ -9,7 +9,7 @@ import {outputError} from '../../../utils/emasser/outputError'
 import {FlagOptions, getFlagsForEndpoint} from '../../../utils/emasser/utilities'

 export default class EmasserDeletePoams extends Command {
-  static usage = '<%= command.id %> [ARGUMENTS]';
+  static usage = '<%= command.id %> [options]';


What is the difference between ARGUMENTS and options?

options are actually the FLAGS, I contemplated what to put there.
Should we use [flag options] or [FLAG options] or simply [flags] or just [FLAGS] - what do you think?

… – natural format Signed-off-by: George Dias <[email protected]>

Signed-off-by: George Dias <[email protected]>

em-c-rod · 2023-05-30T14:19:53Z

src/help/help.ts

+      this.log(this.formatCommand(command))
+    }
+
+    this.log('')


Out of curiosity, what effect does this.log('') have?

em-c-rod · 2023-05-30T14:22:11Z

src/help/help.ts

+  }
+
+  protected log(...args: string[]): void {
+    stdout.write(util.format.apply(this, args) + '\n') // skipcq: JS-0357


Oh, does this.log('') effectively print a newline?

this.log is what is outputting to the console. I had to implement the Streams class to add the additional logModify(), where the new display values are replaced.

sonarcloud · 2023-05-30T14:25:46Z

SonarCloud Quality Gate failed.

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
30.6% Duplication

em-c-rod

LGTM

Updates to the artifacts put flags

b52cb36

Signed-off-by: George Dias <[email protected]>

georgedias added 2 commits May 24, 2023 21:54

Added additional dashboards, updates test suite

f9dd08d

Signed-off-by: George Dias <[email protected]>

DeepSource Javascript fixes

1605b8e

Signed-off-by: George Dias <[email protected]>

georgedias requested a review from em-c-rod May 25, 2023 03:50

Merge branch 'main' into emass_v3_9

aa6630e

em-c-rod reviewed May 25, 2023

View reviewed changes

package.json Outdated Show resolved Hide resolved

georgedias added 3 commits May 25, 2023 20:52

added clarification for argument list format case

b107dc0

Signed-off-by: George Dias <[email protected]>

Merge branch 'emass_v3_9' of github.com:mitre/saf into emass_v3_9

480fff0

fixed deepsource: javascript findings

c921377

Signed-off-by: George Dias <[email protected]>

em-c-rod reviewed May 26, 2023

View reviewed changes

georgedias and others added 3 commits May 27, 2023 19:16

Added override oclif help class to modify how arguments are displayed…

de15e5a

… – natural format Signed-off-by: George Dias <[email protected]>

DeepSource:Javascript fixes

84b2c27

Signed-off-by: George Dias <[email protected]>

Update help.ts

01fc000

em-c-rod reviewed May 30, 2023

View reviewed changes

src/help/help.ts

this.log(this.formatCommand(command))

}

this.log('')

Copy link

Contributor

em-c-rod May 30, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of curiosity, what effect does this.log('') have?

em-c-rod reviewed May 30, 2023

View reviewed changes

em-c-rod approved these changes May 30, 2023

View reviewed changes

em-c-rod merged commit 32a6ffc into main May 30, 2023

em-c-rod deleted the emass_v3_9 branch May 30, 2023 17:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

eMASS V3.9 Specification Updates #1426

eMASS V3.9 Specification Updates #1426

georgedias commented May 23, 2023 •

edited

Loading

mergify bot commented May 24, 2023

em-c-rod May 26, 2023

georgedias May 26, 2023

em-c-rod May 26, 2023

georgedias May 27, 2023 •

edited

Loading

em-c-rod May 30, 2023

em-c-rod May 30, 2023

georgedias May 30, 2023

sonarcloud bot commented May 30, 2023

em-c-rod left a comment

eMASS V3.9 Specification Updates #1426

eMASS V3.9 Specification Updates #1426

Conversation

georgedias commented May 23, 2023 • edited Loading

How to test

Install dependencies

Build the executables

Generate the .env variables

endpoints added (to test)

Test all emasser endpoints

mergify bot commented May 24, 2023

em-c-rod May 26, 2023

Choose a reason for hiding this comment

georgedias May 26, 2023

Choose a reason for hiding this comment

em-c-rod May 26, 2023

Choose a reason for hiding this comment

georgedias May 27, 2023 • edited Loading

Choose a reason for hiding this comment

em-c-rod May 30, 2023

Choose a reason for hiding this comment

em-c-rod May 30, 2023

Choose a reason for hiding this comment

georgedias May 30, 2023

Choose a reason for hiding this comment

sonarcloud bot commented May 30, 2023

em-c-rod left a comment

Choose a reason for hiding this comment

georgedias commented May 23, 2023 •

edited

Loading

georgedias May 27, 2023 •

edited

Loading