Update step/stage terminology, refactor v1 Scanner Reference topics STO-7458 #6410

douglas-j-bothwell · 2024-04-20T20:42:44Z

Changes in this PR

Update all Security Tests stage references to Security stage
Update all Security step references to
- Custom Scan step for scanners without step palettes
- Bandit step, Semgrep step, etc. for scanners with step palettes
- scan step or Security Test step to refer generically to any STO scan step
Refactor v1 scanner references (ie integrations based on Custom Scan step)
- Streamline/simplify Important Notes
- Better support for copy-pasting YAML step definitions and strings such as ingestionOnly
- Add button links at the top of each reference so you can immediately see the target types and ingestion modes supported for each scanner

Updates to scanner references

Custom Scan step reference

This topic includes all the snippets used in the other Custom Scan steps.

List of all non-step-palette scanner integrations:

_scanners-that-use-custom-scan-step.md

Workflow snippets:

_workflow-ingest-only.md For scanners that only support ingestion mode
_workflow-repo.md For orchestration/extraction scans of code repos. Includes a step to configure the codebase.
_workflow.md A generic snippet for all other workflows:

Settings snippets:

Custom Scan reference topics organized by workflow type

_workflow-ingest-only.md For scanners that only support ingestion mode:
_workflow-repo.md For orchestration/extraction scans of code repos. Includes a step to configure the codebase.
_workflow.md A generic snippet for all other workflows:

Scanner and Product Access settings

These links point to the Scanner settings and Product access sections that are "hard-coded" i.e not imported snippets. Each updated topic includes a (legacy) link that points to the earliest committed version of the topic (i.e., when the content first got ported over to the HDH). These legacy links make it easier to cross-check the current content against the legacy content.

Clair scanner reference {HDH
a. Scanner settings
Data Theorem (HDH)
a. Scanner settings
b. Product access
Docker Content Trust (HDH)
a. Scanner settings
Fortify Static Code Analyzer scanner reference (HDH)
a. Scanner settings
Fortify on Demand (HDH)
a. Scanner settings
b. Product access
HCL AppScan
a. Scanner settings
Metasploit (HDH)
a. Scanner settings
Nessus (HDH)
a. Scanner settings
b. Product access
Nexus (HDH)
a. Scanner settings
b. Product access
OpenVAS (HDH)
a. Scanner settings
b. Product access
Qualys Web Application Scanning (HDH)
a. Scanner settings
Qwiet AI (formerly ShiftLeft) (HDH)
a. Scanner settings
b. Product access
Reapsaw (HDH)
a. Scanner settings
ScoutSuite (HDH)
a. Scanner settings
Tenable (HDH)
a. Scanner settings
b. Product access
Veracode (HDH)
a. Scanner settings
JFrog Xray (HDH)
a. Scanner settings

Prepub checks

PRs must meet these requirements to be merged:

Successful preview build.
SME review.
Editorial review.
PM review (went over with PC in our weekly 1:1)
No merge conflicts.
Release notes/new features docs: Feature/version released to at least one prod environment.

…> Custom Scan step), add Custom Scan step and related snippets STO-7396

bot-gitexp-user · 2024-04-20T20:56:12Z

Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step behind the Harness VPN and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app. Current Draft URL is: https://66242b7526144c239513ceff--harness-developer.netlify.app

bot-gitexp-user · 2024-04-20T21:09:13Z

Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step behind the Harness VPN and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app. Current Draft URL is: https://66242e8439bba626d5d6faa4--harness-developer.netlify.app

…7458

…tration/sto-techref-category/archive/_security-test-steps.txt STO-7458

bot-gitexp-user · 2024-04-22T03:13:01Z

Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step behind the Harness VPN and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app. Current Draft URL is: https://6625d541cfeeb534c9a13f98--harness-developer.netlify.app

bot-gitexp-user · 2024-04-22T19:17:51Z

Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step behind the Harness VPN and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app. Current Draft URL is: https://6626b7674e7ec624f0cd9375--harness-developer.netlify.app

bot-gitexp-user · 2024-04-22T20:12:38Z

Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step behind the Harness VPN and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app. Current Draft URL is: https://6626c43812ba7a2844f28946--harness-developer.netlify.app

…Scan step STO-7458

bot-gitexp-user · 2024-04-23T17:28:30Z

Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step behind the Harness VPN and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app. Current Draft URL is: https://6627ef3e1662c22309b9a689--harness-developer.netlify.app

bot-gitexp-user · 2024-05-13T22:17:31Z

Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step behind the Harness VPN and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app. Current Draft URL is: https://664290fc275d193bda16295a--harness-developer.netlify.app

bot-gitexp-user · 2024-05-14T23:14:16Z

Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step behind the Harness VPN and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app. Current Draft URL is: https://6643efc9f1a25715417ec263--harness-developer.netlify.app

bot-gitexp-user · 2024-05-15T14:32:34Z

Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step behind the Harness VPN and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app. Current Draft URL is: https://6644c6ffd89973256eba0083--harness-developer.netlify.app

bot-gitexp-user · 2024-05-17T14:00:48Z

Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step behind the Harness VPN and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app. Current Draft URL is: https://664762919e6c50d6f9b17346--harness-developer.netlify.app

aklaft

left a couple comments. I think I'll have to reapprove anyway, but if you look at these I think it's good.

docs/security-testing-orchestration/sto-techref-category/custom-scan-reference.md

docs/security-testing-orchestration/sto-techref-category/clair-scanner-reference.md

aklaft · 2024-05-17T19:32:54Z

docs/security-testing-orchestration/sto-techref-category/custom-scan-reference.md

+
+<CustomScanRepo />
+
+### Container images 


are these artifact scans now?

Did a global update of headings from ### Container images to ### Artifacts

Custom Scan step reference > Artifacts

…7458

…Configs and Advanced Settings to snippets STO-7458

bot-gitexp-user · 2024-05-19T17:35:51Z

Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step behind the Harness VPN and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app. Current Draft URL is: https://664a37f89e6c50e5c6b1698c--harness-developer.netlify.app

bot-gitexp-user · 2024-05-19T17:55:50Z

Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step behind the Harness VPN and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app. Current Draft URL is: https://664a3ca589a77bb6052686d3--harness-developer.netlify.app

bot-gitexp-user · 2024-05-19T19:42:35Z

Please check the Execution Link of the Pipeline for the Website Draft URL. This is located in the Preview Step behind the Harness VPN and also is available in #hdh_alerts. E.g Website Draft URL: https://unique-id--harness-developer.netlify.app. Current Draft URL is: https://664a55b389a77bcac8268550--harness-developer.netlify.app

update Security Test stage (> Security stage), update Security Step (…

9ecde15

…> Custom Scan step), add Custom Scan step and related snippets STO-7396

douglas-j-bothwell self-assigned this Apr 20, 2024

fix heading STO-7396

893ca43

douglas-j-bothwell added 8 commits April 21, 2024 08:44

update references to scanner templates STO-7458

13e6642

move list of scanners that use Custom Scan to a reusable snippet STO-…

f8e21d7

…7458

move old Security Step config content to docs/security-testing-orches…

c1be7fb

…tration/sto-techref-category/archive/_security-test-steps.txt STO-7458

## Security step settings > ## Custom Scan step settings STO-7458

06baafb

StoLegacyTargetAndVariant legacy > custom-scan STO-7458

5155aa2

StoLegacyContainer legacy > custom-scan STO-7458

301c07d

StoLegacyIngest legacy > custom-scan STO-7458

1214ca5

StoLegacyFailOnSeverity legacy > custom-scan STO-7458

9f75332

douglas-j-bothwell added 4 commits April 22, 2024 07:49

merge main

8bd74c5

add scanner settings to Custom Scan, tweaks to snippets STO-7396

acbe704

tweak snippet, add XRay pipeline example STO-7458

f399135

add YAML step example STO-7458

cc3624b

douglas-j-bothwell added 2 commits April 22, 2024 12:57

add step visual/YAML step example STO-7458

7f23ffd

word tweak STO-7458

bb34b2d

update Security Tests stage > Security stage, Security Step > Custom …

3c0aa31

…Scan step STO-7458

douglas-j-bothwell changed the title ~~update Security Test stage (> Security stage), update Security Step (…~~ Update step/stage terminology, refactor v1 Scanner Reference topics STO-7458 Apr 23, 2024

douglas-j-bothwell added 5 commits April 23, 2024 12:28

misc tweaks STO-7458

a97b778

add Scanner and Product Access settings STO-7458

7c98f7a

add scanner and product-access settings STO-7458

524667c

DCT update Scanner settings STO-7458

b9fe612

HCL scanner settings STO-7458

17be932

merge main, resolve conflicts STO-7458

2d22f26

douglas-j-bothwell dismissed SmritiSatya’s stale review via 2d22f26 May 13, 2024 22:04

douglas-j-bothwell added 6 commits May 13, 2024 15:24

update Supported Scanners table from latest main STO-7458

8996501

merge Supported Scanners table from main STO-7458

50fd72c

test pill colors STO-7458

024c1cf

fix grammer glitch STO-7458

a1e670b

update Product Access settings STO-7458

f13d870

misc fixes/updates STO-7458

e5b9d37

remove extra lines STO-7458

e33488e

douglas-j-bothwell added 2 commits May 15, 2024 10:24

update scan-mode pills to purple STO-7458

58626f3

misc tweaks/updates STO-7458

c19585b

douglas-j-bothwell requested a review from aklaft May 17, 2024 14:12

aklaft reviewed May 17, 2024

View reviewed changes

douglas-j-bothwell added 6 commits May 19, 2024 07:31

AK feedback: update product_name, refactor workflow descriptions STO-…

b5ad4de

…7458

AK feedback: refactor workflow descriptions STO-7458

7eba10d

fix spacing in sub-step paragraph STO-7458

ec6f41f

AK feedback: add info from tooltips to Container descriptions STO-7458

74eedc2

AK feedback: add Timeout to Additional Configs. Also move Additional …

f124d50

…Configs and Advanced Settings to snippets STO-7458

merge main

87f5065

AK feedback: ### Container images > ### Artifacts STO-7458

df14d82

AK feedback: ### Container images > ### Artifacts STO-7458

631ad0d

douglas-j-bothwell merged commit c97fe2b into main May 19, 2024

douglas-j-bothwell deleted the updates-for-step-stage-ui-updates-sto-7458 branch May 19, 2024 20:12

Update step/stage terminology, refactor v1 Scanner Reference topics STO-7458 #6410

Update step/stage terminology, refactor v1 Scanner Reference topics STO-7458 #6410

Uh oh!

Conversation

douglas-j-bothwell commented Apr 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes in this PR

Updates to scanner references

Custom Scan step reference

Custom Scan reference topics organized by workflow type

Scanner and Product Access settings

Prepub checks

Uh oh!

bot-gitexp-user commented Apr 20, 2024

Uh oh!

bot-gitexp-user commented Apr 20, 2024

Uh oh!

bot-gitexp-user commented Apr 22, 2024

Uh oh!

bot-gitexp-user commented Apr 22, 2024

Uh oh!

bot-gitexp-user commented Apr 22, 2024

Uh oh!

bot-gitexp-user commented Apr 23, 2024

Uh oh!

bot-gitexp-user commented May 13, 2024

Uh oh!

bot-gitexp-user commented May 14, 2024

Uh oh!

bot-gitexp-user commented May 15, 2024

Uh oh!

bot-gitexp-user commented May 17, 2024

Uh oh!

aklaft left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aklaft May 17, 2024

Choose a reason for hiding this comment

Uh oh!

douglas-j-bothwell May 19, 2024

Choose a reason for hiding this comment

Uh oh!

bot-gitexp-user commented May 19, 2024

Uh oh!

bot-gitexp-user commented May 19, 2024

Uh oh!

bot-gitexp-user commented May 19, 2024

Uh oh!

Uh oh!

douglas-j-bothwell commented Apr 20, 2024 •

edited

Loading