Skip to content

Commit 3a31ff6

Browse files
IlonaShishovritz303agunn303
authored
chore: disable snyk token (#694)
* chore: disable snyk token Signed-off-by: Ilona Shishov <[email protected]> * 3/21/24 - ritz303 : Removed mention of Snyk (#695) Co-authored-by: Aron Gunn <[email protected]> * docs: update screencasts Signed-off-by: Ilona Shishov <[email protected]> --------- Signed-off-by: Ilona Shishov <[email protected]> Co-authored-by: ritz303 <[email protected]> Co-authored-by: Aron Gunn <[email protected]>
1 parent 7e74d72 commit 3a31ff6

17 files changed

+44
-81
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
# Change Log
2+
## 0.9.4 (?)
3+
- informational - Removing access to Snyk's Vulnerability Database.
24
## 0.9.3 (Mar 6th 2024)
35
- enhancement - Red Hat Dependency Analytics reporting has integrated the ONGuard service by using [Open Source Vulnerability (OSV)](https://google.github.io/osv.dev/) and the [National Vulnerability Database (NVD)](https://nvd.nist.gov/) data sources for additional vulnerability information.
46
- enhancement - Integrated VS Code's [Secret Storage](https://code.visualstudio.com/api/references/vscode-api#SecretStorage) feature for securing the Snyk token. See [PR689](https://github.com/fabric8-analytics/fabric8-analytics-vscode-extension/pull/689) for details.

README.md

Lines changed: 1 addition & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
Red Hat's Dependency Analytics (RHDA) extension gives you awareness to security concerns within your software supply chain while you code your application.
88
The Red Hat Dependency Analytics extension uses the following data sources for the most up-to-date vulnerability information available:
99

10-
- [Snyk's Vulnerability Database](https://snyk.io/product/vulnerability-database/) is an industry-leading security intelligence service. Red Hat Dependency Analytics uses Snyk's REST API to query for the latest vulnerability information available.
1110
- The [ONGuard](https://github.com/RHEcosystemAppEng/ONguard) service, integrates the [Open Source Vulnerability (OSV)](https://google.github.io/osv.dev/) and the [National Vulnerability Database (NVD)](https://nvd.nist.gov/) data sources. When given a set of packages to the ONGuard service, a query to OSV retrieves the associated vulnerability information, and then a query to NVD for public Common Vulnerability and Exposures (CVE) information.
1211

1312
**NOTE:**
@@ -58,12 +57,6 @@ Click the **Workspace** tab, search for the word _executable_, and specify the a
5857
- Open a manifest file, and click the **pie chart** icon ![ Pie chart icon ](icon/report-icon.png).
5958
- Right click on a manifest file in the **Explorer** view, and click **Red Hat Dependency Analytics Report...**.
6059
- From the vulnerability pop-up alert message, click **Open detailed vulnerability report**.
61-
7. (OPTIONAL) You can link your Snyk account to Red Hat Dependency Analytics by doing the following:
62-
1. Log into your [Snyk account](https://app.snyk.io/login?utm_campaign=Code-Ready-Analytics-2020&utm_source=code_ready&code_ready=FF1B53D9-57BE-4613-96D7-1D06066C38C9).
63-
2. On the account landing page, you can find your Snyk Token, copy the token.
64-
3. From VS Code's Command Palette, enter `RHDA: Set Snyk Token`.
65-
4. Paste the Snyk token into the input field.
66-
4. After adding your Snyk token, the vulnerability report gives you detailed information about security vulnerabilities unique to Snyk, and vulnerabilities that have publicly known exploits.
6760

6861
## Configuration
6962

@@ -80,23 +73,6 @@ The Red Hat Dependency Analytics extension has some configurable parameters that
8073

8174
### Configurable parameters
8275

83-
**Snyk Token Storage** :
84-
<br >The Snyk token allows Exhort to authenticate with the Snyk Vulnerability Database.
85-
If a Snyk token is not provided, Snyk vulnerability information is not displayed.
86-
87-
To securely store your Snyk token, RHDA uses VS Code's [Secret Storage](https://code.visualstudio.com/api/references/vscode-api#SecretStorage) feature.
88-
From VS Code's Command Palette, enter `RHDA: Set Snyk Token`.
89-
Next, enter your Snyk token.
90-
<br >![ Screenshot of the Snyk token dialog box](images/screenshots/RHDA_Snyk_Token_dialog_box.png)
91-
92-
If you enter a invalid Snyk token, the dialog box alerts you that your Snyk token is not valid.
93-
<br >![ Screenshot of the invalid Snyk token dialog box ](images/screenshots/RHDA_Invalid_Snyk_Token.png)
94-
95-
In the extension settings, you can set RHDA to always use VS Code's Secret Storage.
96-
<br >![ Screenshot of the RHDA Snyk token storage setting](images/screenshots/RHDA_Snyk_Token_Storage_Setting.png)
97-
98-
If you need a new Snyk token, you can generate a new token [here](https://app.snyk.io/login?utm_campaign=Code-Ready-Analytics-2020&utm_source=code_ready&code_ready=FF1B53D9-57BE-4613-96D7-1D06066C38C9).
99-
10076
**Red Hat Dependency Analytics Report File Path** :
10177
<br >Specify the local path to create the Red Hat Dependency Analytics report file.
10278
The default path is `/tmp/redhatDependencyAnalyticsReport.html`.
@@ -143,7 +119,7 @@ The default path is `/tmp/redhatDependencyAnalyticsReport.html`.
143119
```
144120

145121
If you wish to ignore vulnerabilities for a dependency in a `package.json` file, you must add `exhortignore` as a attribute-value pair.
146-
If `exhortignore` is followed by a list of comma-separated Snyk vulnerability IDs, only the listed vulnerabilities will be ignored during analysis.
122+
If `exhortignore` is followed by a list of comma-separated vulnerability IDs, only the listed vulnerabilities are ignored during analysis.
147123
For example:
148124

149125
```json
62 KB
Loading

images/screencasts/quickfix.gif

313 KB
Loading
-9.96 KB
Binary file not shown.
-24.3 KB
Binary file not shown.
-7.18 KB
Binary file not shown.

images/screenshots/empty-token.png

-23 KB
Binary file not shown.

images/screenshots/valid-token.png

-4.69 KB
Binary file not shown.
-12 KB
Binary file not shown.

0 commit comments

Comments
 (0)