chore: DOC-1325 security bulletin component (#3639) (#4817)

* chore: security bulletin * chore: fix gitignore * docs: DOC-1356 * docs: add cve cards * docs: progress on component * docs: progress * docs: working prototype * docs: protype * docs: default sort order * chore: WIP * chore: placeholder * chore: fixed route duplicates * chore: fixed path * chore: adde routing * chore: improve log output * chore: cleaned up global variable * chore: fixed plugin name * chore: fix date to pull data using west coast * chore: update plugin * chore: save * chore: added logic for generating markdown files * docs: add more fields to the markdown template * chore: refactored plugin to node script * chore: added types * chore: prettier ignore * save * docs: fixes * chore: fix table * chore: added sorting for versions * chore: wip * docs: fix CVE redirects * chore: updated to use new API * chore: updated sorting * docs: add affected versions * docs: add revision history * docs: add tests for revision history * docs: change column names and array formatting * chore: updated logic to handle multple product instances * chore: add package name * chore: support for multiple versions without breaking table * chore: update comment * chore: fix jank page behavior issue * chore: CSS cleanup * chore: updated table to sort by version * chore: updated CSS to not display table for small displays * chore: updated view * tests: fixed tests * chore: sort revision history by date * chore: update * chore: add sorting to Third Party Vulnerability * chore: progress * chore: fix revision logic and simplified logic to improve readability * chore: memory optimization * chore: more improvements * chore: ci * chore: fix logger * chore: udate * chore: fixed semver sorting in affected tables * chore: removed newlines from revision * docs: added virtual list with fixed header * docs: added missing columns * chore: fixed broken URL * chore: add ability to link tab * docs: added explenation of status * chore: updated state to status * ci: set logic for skipping security bulletins * chore: add logic for no CVE * docs: updated README * chore: save * ci: test change * ci: bump eslint * chore: fix eslint * chore: ignore eslint * chore: fix jitter --------- Co-authored-by: Lenny Chen <[email protected]>
spectrocloud · Nov 27, 2024 · 9c70f4c · 9c70f4c
1 parent aae1cef
commit 9c70f4c
Show file tree

Hide file tree

Showing 48 changed files with 1,669 additions and 689 deletions.
diff --git a/.github/workflows/api_format.yaml b/.github/workflows/api_format.yaml
@@ -19,6 +19,8 @@ env:
   ALGOLIA_INDEX_NAME: ${{ secrets.ALGOLIA_INDEX_NAME }}
   PALETTE_API_KEY: ${{ secrets.PALETTE_API_KEY }}
   DISABLE_PACKS_INTEGRATIONS: ${{ secrets.DISABLE_PACKS_INTEGRATIONS }}
+  DISABLE_SECURITY_INTEGRATIONS: ${{ secrets.DISABLE_SECURITY_INTEGRATIONS }}
+  DSO_AUTH_TOKEN: ${{ secrets.DSO_AUTH_TOKEN }}
 
 jobs:
   backport:

diff --git a/.github/workflows/dependabot.yaml b/.github/workflows/dependabot.yaml
@@ -23,6 +23,8 @@ env:
   ALGOLIA_INDEX_NAME: ${{ secrets.ALGOLIA_INDEX_NAME }}
   PALETTE_API_KEY: ${{ secrets.PALETTE_API_KEY }}
   DISABLE_PACKS_INTEGRATIONS: ${{ secrets.DISABLE_PACKS_INTEGRATIONS }}
+  DISABLE_SECURITY_INTEGRATIONS: ${{ secrets.DISABLE_SECURITY_INTEGRATIONS }}
+  DSO_AUTH_TOKEN: ${{ secrets.DSO_AUTH_TOKEN }}
 
 jobs:
   dependabot_build:

diff --git a/.github/workflows/nightly-docker-build.yaml b/.github/workflows/nightly-docker-build.yaml
@@ -15,6 +15,8 @@ env:
   ALGOLIA_INDEX_NAME: "madeup-index"
   PALETTE_API_KEY: ${{ secrets.PALETTE_API_KEY }}
   DISABLE_PACKS_INTEGRATIONS: ${{ secrets.DISABLE_PACKS_INTEGRATIONS }}
+  DISABLE_SECURITY_INTEGRATIONS: ${{ secrets.DISABLE_SECURITY_INTEGRATIONS }}
+  DSO_AUTH_TOKEN: ${{ secrets.DSO_AUTH_TOKEN }}
 
 jobs:
   build:

diff --git a/.github/workflows/post_release.yaml b/.github/workflows/post_release.yaml
@@ -18,6 +18,8 @@ env:
   ALGOLIA_INDEX_NAME: ${{ secrets.ALGOLIA_INDEX_NAME }}
   PALETTE_API_KEY: ${{ secrets.PALETTE_API_KEY }}
   DISABLE_PACKS_INTEGRATIONS: ${{ secrets.DISABLE_PACKS_INTEGRATIONS }}
+  DISABLE_SECURITY_INTEGRATIONS: ${{ secrets.DISABLE_SECURITY_INTEGRATIONS }}
+  DSO_AUTH_TOKEN: ${{ secrets.DSO_AUTH_TOKEN }}
 
 jobs:
 

diff --git a/.github/workflows/pull_request.yaml b/.github/workflows/pull_request.yaml
@@ -22,6 +22,8 @@ env:
   ALGOLIA_INDEX_NAME: ${{ secrets.ALGOLIA_INDEX_NAME }}
   PALETTE_API_KEY: ${{ secrets.PALETTE_API_KEY }}
   DISABLE_PACKS_INTEGRATIONS: ${{ secrets.DISABLE_PACKS_INTEGRATIONS }}
+  DISABLE_SECURITY_INTEGRATIONS: ${{ secrets.DISABLE_SECURITY_INTEGRATIONS }}
+  DSO_AUTH_TOKEN: ${{ secrets.DSO_AUTH_TOKEN }}
 
 jobs:
   run-ci:

diff --git a/.github/workflows/release-branch-pr.yaml b/.github/workflows/release-branch-pr.yaml
@@ -19,6 +19,8 @@ env:
   GITHUB_BRANCH: ${{ github.ref_name }} 
   PALETTE_API_KEY: ${{ secrets.PALETTE_API_KEY }}
   DISABLE_PACKS_INTEGRATIONS: ${{ secrets.DISABLE_PACKS_INTEGRATIONS }}
+  DISABLE_SECURITY_INTEGRATIONS: ${{ secrets.DISABLE_SECURITY_INTEGRATIONS }}
+  DSO_AUTH_TOKEN: ${{ secrets.DSO_AUTH_TOKEN }}
 
 
 concurrency:

diff --git a/.github/workflows/release-preview.yaml b/.github/workflows/release-preview.yaml
@@ -18,6 +18,8 @@ env:
   ALGOLIA_INDEX_NAME: ${{ secrets.ALGOLIA_INDEX_NAME }}
   PALETTE_API_KEY: ${{ secrets.PALETTE_API_KEY }}
   DISABLE_PACKS_INTEGRATIONS: ${{ secrets.DISABLE_PACKS_INTEGRATIONS }}
+  DISABLE_SECURITY_INTEGRATIONS: ${{ secrets.DISABLE_SECURITY_INTEGRATIONS }}
+  DSO_AUTH_TOKEN: ${{ secrets.DSO_AUTH_TOKEN }}
 
 
 concurrency:

diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -7,12 +7,14 @@ on:
   schedule:
     - cron: '0 20 * * 1-5'  # At 12:00 PM PST (8 PM UTC), Monday through Friday
     - cron: '0 5 * * 2-6'  # At 9:00 PM PST (5 AM UTC next day), Monday through Friday
+    - cron: '0 20 * * 6' # At 12:00 PM PST (8 PM UTC next day), Saturday - Due to Security Buletin Publication
+    - cron: '0 20 * * 0' # At 12:00 PM PST (8 PM UTC next day),  Sunday - Due to Security Buletin Publication
   workflow_dispatch:
     inputs:
       useGitHubHostedLargeRunner:
         description: 'Use the GitHub-hosted large runner. Allowed values are true or false. Caution - this results in additional charges to the organization.'
         required: false
-        default: false
+        default: 'false'
 
 env:
   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -27,6 +29,8 @@ env:
   ALGOLIA_INDEX_NAME: ${{ secrets.ALGOLIA_INDEX_NAME }}
   PALETTE_API_KEY: ${{ secrets.PALETTE_API_KEY }}
   DISABLE_PACKS_INTEGRATIONS: ${{ secrets.DISABLE_PACKS_INTEGRATIONS }}
+  DISABLE_SECURITY_INTEGRATIONS: ${{ secrets.DISABLE_SECURITY_INTEGRATIONS }}
+  DSO_AUTH_TOKEN: ${{ secrets.DSO_AUTH_TOKEN }}
 
 
 concurrency:

diff --git a/.github/workflows/screenshot_capture.yaml b/.github/workflows/screenshot_capture.yaml
@@ -21,6 +21,8 @@ env:
   ALGOLIA_INDEX_NAME: ${{ secrets.ALGOLIA_INDEX_NAME }}
   PALETTE_API_KEY: ${{ secrets.PALETTE_API_KEY }}
   DISABLE_PACKS_INTEGRATIONS: ${{ secrets.DISABLE_PACKS_INTEGRATIONS }}
+  DISABLE_SECURITY_INTEGRATIONS: ${{ secrets.DISABLE_SECURITY_INTEGRATIONS }}
+  DSO_AUTH_TOKEN: ${{ secrets.DSO_AUTH_TOKEN }}
 
 
 jobs:

diff --git a/.github/workflows/versions_robot.yaml b/.github/workflows/versions_robot.yaml
@@ -22,7 +22,10 @@ env:
   ALGOLIA_SEARCH_KEY: ${{ secrets.ALGOLIA_SEARCH_KEY }}
   ALGOLIA_INDEX_NAME: ${{ secrets.ALGOLIA_INDEX_NAME }}
   PALETTE_API_KEY: ${{ secrets.PALETTE_API_KEY }}
-  GITHUB_BRANCH: ${{ github.ref_name }} 
+  GITHUB_BRANCH: ${{ github.ref_name }}
+  DISABLE_PACKS_INTEGRATIONS: ${{ secrets.DISABLE_PACKS_INTEGRATIONS }}
+  DISABLE_SECURITY_INTEGRATIONS: ${{ secrets.DISABLE_SECURITY_INTEGRATIONS }} 
+  DSO_AUTH_TOKEN: ${{ secrets.DSO_AUTH_TOKEN }}
 
 jobs:
   run-ci:

diff --git a/.github/workflows/visual-comparison.yaml b/.github/workflows/visual-comparison.yaml
@@ -17,6 +17,8 @@ env:
   ALGOLIA_INDEX_NAME: ${{ secrets.ALGOLIA_INDEX_NAME }}
   HTML_REPORT_URL_PATH: reports/${{ github.head_ref }}/${{ github.run_id }}/${{ github.run_attempt }}
   DISABLE_PACKS_INTEGRATIONS: ${{ secrets.DISABLE_PACKS_INTEGRATIONS }}
+  DISABLE_SECURITY_INTEGRATIONS: ${{ secrets.DISABLE_SECURITY_INTEGRATIONS }} 
+  DSO_AUTH_TOKEN: ${{ secrets.DSO_AUTH_TOKEN }}
 
 
 concurrency:

diff --git a/.gitignore b/.gitignore
@@ -39,6 +39,10 @@ docs/api-content/api-docs/v1/sidebar.*
 docs/api-content/api-docs/edge-v1/*.mdx
 docs/api-content/api-docs/edge-v1/sidebar.*
 
+# Security Bulletins (Autogenerated)
+
+docs/docs-content/security-bulletins/reports/*.md
+
 # Versions Content
 versions.json
 versioned_docs/
@@ -71,6 +75,7 @@ _partials/index.ts
 
 # Ignore statoc/img/packs
 static/img/packs
+static/data/security-bulletins/*
 
 
 .vale-config/

diff --git a/.prettierignore b/.prettierignore
@@ -13,6 +13,7 @@ docs/api-content/**/*.json
 tsconfig.json
 src/components/IconMapper/dynamicFontAwesomeImports.*
 docs/docs-content/security-bulletins/cve-reports.md
+docs/docs-content/security-bulletins/reports/*.md
 
 # Ignore partials
 _partials/
diff --git a/Makefile b/Makefile
@@ -32,7 +32,7 @@ initialize: ## Initialize the repository dependencies
 	npx husky-init
 	vale sync
 
-clean: ## Clean common artifacts
+clean: clean-security ## Clean common artifacts
 	npm run clear && npm run clean-api-docs
 	rm -rfv build
 
@@ -56,6 +56,10 @@ clean-packs: ## Clean supplemental packs and pack images
 	rm -rf .docusaurus/packs-integrations/api_pack_response.json
 	rm -rf .docusaurus/packs-integrations/api_repositories_response.json
 
+clean-security: ## Clean security bulletins
+	rm -rf .docusaurus/security-bulletins/default/*.json
+	rm -rfv docs/docs-content/security-bulletins/reports/*.md 
+
 clean-api: ## Clean API docs
 	@echo "cleaning api docs"
 	npm run clean-api-docs
@@ -80,6 +84,7 @@ init: ## Initialize npm dependencies
 
 start: ## Start a local development server
 	make generate-partials
+	npm run cves
 	npm run start
 
 start-cached-packs: ## Start a local development server with cached packs retry.

diff --git a/README.md b/README.md
@@ -751,6 +751,28 @@ Below is an example of how to use the component when the URLs are different:
   /> page to learn more about system administrator roles.
 ```
 
+## Security Bulletins
+
+The security bulletins are auto-generated upon server start or the build process. The bulletins are generated by
+querying an internal Spectro Cloud API. The bulletins are displayed in the security bulletins page
+`https://docs.spectrocloud.com/security-bulletins/reports/`.
+
+The logic for generated the security bulletins is located in the [cves folder](./utils/cves/index.js). The script is
+invoked before a build or a local development server start. The script will fetch the security bulletins and store the
+data in the `.docusaurus/security-bulletins/default/` folder. The data is stored in the `data.json` file.
+
+The script will also generate each markdown file for each security bulletin. The markdown files are stored in the
+`/security-bulletins/reports/` folder.
+
+### Disable Security Bulletins
+
+To disable the security bulletins, you can set the environment variable `DISABLE_SECURITY_INTEGRATIONS` to `true`. This
+will stop the pre-build script from fetching the security bulletins.
+
+```shell
+export DISABLE_SECURITY_INTEGRATIONS=true
+```
+
 ## Packs Component
 
 The packs component is a custom component that displays all packs available in Palette SaaS by querying the Palette API

diff --git a/babel.config.js b/babel.config.js
diff --git a/docs/docs-content/security-bulletins/reports/cve-2015-8855.md b/docs/docs-content/security-bulletins/reports/cve-2015-8855.md
diff --git a/docs/docs-content/security-bulletins/reports/cve-2022-25883.md b/docs/docs-content/security-bulletins/reports/cve-2022-25883.md
diff --git a/docs/docs-content/security-bulletins/reports/cve-2022-41723.md b/docs/docs-content/security-bulletins/reports/cve-2022-41723.md
diff --git a/docs/docs-content/security-bulletins/reports/cve-2022-4450.md b/docs/docs-content/security-bulletins/reports/cve-2022-4450.md
diff --git a/docs/docs-content/security-bulletins/reports/cve-2023-0215.md b/docs/docs-content/security-bulletins/reports/cve-2023-0215.md