contributing-docs icon indicating copy to clipboard operation
contributing-docs copied to clipboard

[WIP] introduce generator deep dive documentation

Open audreyality opened this issue 7 months ago • 2 comments

🎟️ Tracking

N/A

📔 Objective

Document the credential generator used by the javascript clients.

(Rendered)

[!NOTE] This PR is a work in progress. It is provided for preview and is not ready to merge.

⏰ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) or informed the documentation team

🦮 Reviewer guidelines

  • 👍 (:+1:) or similar for great changes
  • 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
  • ❓ (:question:) for questions
  • 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion
  • 🎨 (:art:) for suggestions / improvements
  • ❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
  • 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
  • ⛏ (:pick:) for minor or nitpick changes

audreyality avatar May 22 '25 13:05 audreyality

Deploying contributing-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 47e5d9e
Status: ✅  Deploy successful!
Preview URL: https://6ef41a18.contributing-docs.pages.dev
Branch Preview URL: https://tools-generator-deep-dive.contributing-docs.pages.dev

View logs

Logo Checkmarx One – Scan Summary & Details5ddcbf52-a3da-440b-939b-49c0452f7134

New Issues (4)

Checkmarx found the following issues in this Pull Request

Severity Issue Source File / Package Checkmarx Insight
HIGH Cx7c1ed3d7-0e49 Npm-image-size-1.2.0
detailsRecommended version: 1.2.1
Description: Image-size is vulnerable to a Denial of Service (DoS) vulnerability when processing specially crafted images. The issue occurs because of an infine...
Attack Vector: NETWORK
Attack Complexity: LOW

ID: DN6BYKz6Vnve4m00Qh5PFPuC6Mcqjla8MmY0676hGZo%3D
Vulnerable Package
MEDIUM CVE-2025-32014 Npm-estree-util-value-to-estree-3.3.2
detailsRecommended version: 3.3.3
Description: A vulnerability in estree-util-value-to-estree versions prior to 3.3.3 allows an attacker to generate an "ESTree" object that specifies a prototype...
Attack Vector: NETWORK
Attack Complexity: LOW

ID: S9nm0SvWhz5cq12Z0aiTQ2ngO1ifx60XJk2038dsbRs%3D
Vulnerable Package
MEDIUM CVE-2025-32996 Npm-http-proxy-middleware-2.0.7
detailsRecommended version: 2.0.9
Description: In http-proxy-middleware v1.3.0 through v2.0.7 and v3.x through v3.0.3, "writeBody" function can be called twice because "else if" is not used.
Attack Vector: NETWORK
Attack Complexity: HIGH

ID: HMlXfEk8SUC9kM5RzNbjrEg%2Fs8OPVzF1hndtwvms9mo%3D
Vulnerable Package
MEDIUM CVE-2025-32997 Npm-http-proxy-middleware-2.0.7
detailsRecommended version: 2.0.9
Description: In http-proxy-middleware versions 1.3.0 through 2.0.8 and 3.x through 3.0.4, the "fixRequestBody" function proceeds even if "bodyParser" has failed.
Attack Vector: NETWORK
Attack Complexity: HIGH

ID: SYx0SfxZ7hmer3r2IG%2BxwUZmQjbPVX1jUCSOgF4IFVU%3D
Vulnerable Package

github-actions[bot] avatar May 22 '25 13:05 github-actions[bot]