loopbackio / loopbackio/security
Replace Secvisogram with `csaf-validator-lib`
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 4
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
Overview
Secvisogram is a project for a React-powered, web-based Common Security Advisory Framework Version 2.0 (CSAF 2.0) validator.
https://github.com/loopbackio/security/pull/5 / https://github.com/loopbackio/security/commit/17f860ad6f885177033f809bc4fefb14782e0c53 added CSAF 2.0 validation with Secvisogram. When that change was merged, Secvisogram was bundled as a single solution, and the validation code was not distributed separately. Hence, we implemented a hacky solution to import the entire project and then to call only the validation logic. Notably, this includes:
- Installing all of Secvisogram's depenencies
- Re-constructing and executing relevant parts of Secvisogram's custom build pipeline
Since then, this validation code has been decoupled and Secvisogram has been updated to use the csaf-validator-lib Node.js module (https://github.com/BSI-Bund/secvisogram/pull/39 / https://github.com/BSI-Bund/secvisogram/commit/4487b6b0032348b487fe05e881da8f654b2f78ec).
Benefits of making the switch include:
- A more stable interface for us to bootstrap and use the dependency.
- Reduced build pipeline complexity
- Removed need for frontend build pipeline knowledge
- Reduced attack surface from unneeded web frontend packages.
Implementation remarks
The current approach involves:
git submodule-ing https://github.com/BSI-Bund/secvisogram.git- Installing Secvisogram's dependencies and calling Babel as part of the build pipeline
- Manually copying some non-JavaScript resources to the
distibution directory - Importing validation logic from
dist/shared/Core
In contrast, the new approach would involve:
git submodule-ing https://github.com/secvisogram/csaf-validator-lib.git
Although thecsaf-validator-libREADME indicates to usegit subtree,git submoduleis better for explicitly linking two Git repositories together. In contrast,git subtreecopies the Git history without any coupling to the source Git repository.- Installing
csaf-validator-lib's production dependencies
This switch would also bring in the latest features and validation tests such Test 6.3.8 ("Spell check", powered by the Hunspell spell checking library), of which the BSI-Bund Git repository is currently lacking.
Mitigating against NPM dependency confusion attacks
At time of writing, csaf-validator-lib is not published as an NPM package, hence the need to install this as a "local dependency". To mitigate against NPM dependency confusion attacks, it is important that the package.json dependency entry explicitly points to the local copy.
We can achieve this "explicit pointer" requirement by leveraging package aliases, which was introduced in
This issue is to track switching over to csaf-validator-lib
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing the current Secvisogram submodule, package.json dependency setup, build pipeline, and imports from dist/shared/Core. Replace that integration with the csaf-validator-lib submodule and its production dependencies, then verify that CSAF validation and the existing build still work, including the newer validation coverage described in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- node.js, typescript
- Domain
- build-system, security
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100