Replace Secvisogram with `csaf-validator-lib`
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 42/100
- Tipo di issue
- Refactoring
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- node.js, typescript
- Ambito
- build-system, security
Direzione di ricerca
Inizia tracciando l’attuale sottomodulo Secvisogram, la configurazione delle dipendenze di package.json, la pipeline di build e gli import da dist/shared/Core. Sostituisci questa integrazione con il sottomodulo csaf-validator-lib e le relative dipendenze di produzione, quindi verifica che la validazione CSAF e la build esistente continuino a funzionare, inclusa la copertura di validazione più recente descritta nell’issue.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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
- Lingua principale
- TypeScript
- Stelle
- 4
- Fork
- 1
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di loopbackio/security
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 45/100
loopbackio/security#42 ·
-
Adopt Staged Publishing Aperta
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
loopbackio/security#41 ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
loopbackio/security#40 ·
-
openjsf
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
loopbackio/security#39 ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
loopbackio/security#38 ·
Tutte le issue di loopbackio/security
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
bug v2
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
modelcontextprotocol/inspector#2458 · 1 commento ·
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 75/100
railmapgen/rmp-gallery#4068 ·
-
Mend: dependency security vulnerability status: needs triage 🕵️♀️
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
carbon-design-system/ibm-products#9907 ·