loopbackio / loopbackio/security

Replace Secvisogram with `csaf-validator-lib`

Ouverte
#35 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
TypeScript
Étoiles
4
Forks
1
Métriques de merge des PR
Aucune PR mergée en 30 j

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 the csaf-validator-lib README indicates to use git subtree, git submodule is better for explicitly linking two Git repositories together. In contrast, git subtree copies 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

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par retracer le sous-module Secvisogram actuel, la configuration des dépendances de package.json, le pipeline de build et les imports depuis dist/shared/Core. Remplacez cette intégration par le sous-module csaf-validator-lib et ses dépendances de production, puis vérifiez que la validation CSAF et le build existant fonctionnent toujours, y compris la couverture de validation plus récente décrite dans l’issue.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
node.js, typescript
Domaine
build-system, security
Type d'issue
Refactorisation
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
42/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.