bulwark

Un outil de gestion des actifs et des vulnérabilités organisationnelles, avec intégration Jira, conçu pour la génération de rapports de sécurité applicative.

Fonctionnalités

• Gestion multi-client des vulnérabilités
• Génération de rapports de sécurité
• Intégration Jira
• Autorisation basée sur les rôles d'équipe
• Clé API et gestion
• Intégration email
• Support Markdown
• Activation/Désactivation d'utilisateurs (Admin)

Remarque

Veuillez noter que ce projet est en phase de développement précoce.

Démo

Intégration Jira

Lancement avec Docker

1. Installez Docker
2. Créez un fichier .env avec les propriétés suivantes :

MYSQL_DATABASE="bulwark"
MYSQL_PASSWORD="bulwark"
MYSQL_ROOT_PASSWORD="bulwark"
MYSQL_USER="root"
MYSQL_DB_CHECK="mysql"
DB_PASSWORD="bulwark"
DB_URL="172.16.16.3"
DB_ROOT="root"
DB_USERNAME="bulwark"
DB_PORT=3306
DB_NAME="bulwark"
DB_TYPE="mysql"
NODE_ENV="production"
DEV_URL="http://localhost:4200"
SERVER_ADDRESS="http://localhost"
PORT=4500
JWT_KEY="changeme"
JWT_REFRESH_KEY="changeme"
CRYPTO_SECRET="changeme"
CRYPTO_SALT="changeme"

Construisez et démarrez les conteneurs Bulwark :

docker-compose up

Démarrer/Arrêter les conteneurs Bulwark :

docker-compose start
docker-compose stop

Supprimer les conteneurs Bulwark :

docker-compose down

Bulwark sera disponible sur localhost:4500

Installation locale

$ git clone (url)
$ cd bulwark
$ npm install

L'exécution de npm install installera à la fois les modules côté serveur et côté client. De plus, il exécutera le script npm run config qui définira dynamiquement les variables d'environnement et mettra à jour l'environnement Angular.

Mode développement

Définissez NODE_ENV="development"

$ npm run config
$ npm run start:dev

Mode production

Définissez NODE_ENV="production" Veuillez noter : npm install construira automatiquement en mode production

$ npm run config
$ npm run build:prod
$ npm start

Variables d'environnement

Créez un fichier .env à la racine du répertoire. Il sera analysé avec dotenv par l'application.

DB_PASSWORD

DB_PASSWORD="somePassword"

Définissez cette variable pour le mot de passe de la base de données.

DB_USERNAME

DB_USERNAME="foobar"

Définissez cette variable pour le nom d'utilisateur de la base de données.

DB_URL

DB_URL=something-foo-bar.dbnet

Définissez cette variable pour l'URL de la base de données.

DB_PORT

DB_PORT=3306

Définissez cette variable pour le port de la base de données.

DB_NAME

DB_NAME="foobar"

Définissez cette variable pour le nom de connexion à la base de données.

DB_TYPE

DB_TYPE="mysql"

L'application a été développée avec une base de données MySQL. Consultez la documentation de typeorm pour plus d'options de base de données.

NODE_ENV

NODE_ENV=production

Définissez cette variable pour déterminer l'environnement Node.

DEV_URL="http://localhost:4200"

Utilisé par Angular pour construire et servir l'application.

SERVER_ADDRESS="http://localhost"

Mettez à jour si une adresse serveur différente est nécessaire.

PORT=4500

Mettez à jour si un port serveur différent est nécessaire.

JWT_KEY

JWT_KEY="changeMe"

Définissez cette variable pour le secret JWT.

JWT_REFRESH_KEY

JWT_REFRESH_KEY="changeMe"

Définissez cette variable pour le secret JWT de rafraîchissement.

CRYPTO_SECRET

CRYPTO_SECRET="randomValue"

Définissez cette variable pour le mot de passe Scrypt.

CRYPTO_SALT

CRYPTO_SECRET="randomValue"

Définissez cette variable pour le sel Scrypt.

Modèle de fichier .env vide

DB_PASSWORD=""
DB_URL=""
DB_USERNAME=""
DB_PORT=3306
DB_NAME=""
DB_TYPE=""
NODE_ENV=""
DEV_URL="http://localhost:4200"
SERVER_ADDRESS="http://localhost"
PORT=4500
JWT_KEY=""
JWT_REFRESH_KEY=""
CRYPTO_SECRET=""
CRYPTO_SALT=""

Note pour les Mac M1/M2

Installer sqlite3 : 
brew install sqlite3

Exporter les variables d'environnement liées au compilateur : 
export LDFLAGS="-L/opt/homebrew/opt/sqlite/lib"
export CPPFLAGS="-I/opt/homebrew/opt/sqlite/include"
export PKG_CONFIG_PATH="/opt/homebrew/opt/sqlite/lib/pkgconfig"
export NODE_OPTIONS=--openssl-legacy-provider

Préparer une nouvelle installation :
rm -rf node_modules
npm cache verify
npm i --force

Créer une migration initiale de base de données

1. Créez la migration initiale de la base de données

$ npm run migration:init

2. Exécutez la migration initiale de la base de données

$ npm run migration:run

Identifiants par défaut

Un compte utilisateur est créé au premier démarrage avec les identifiants suivants :

• email : [email protected]
• mot de passe : changeMe

Lors de la première connexion, mettez à jour le mot de passe de l'utilisateur par défaut dans la section profil.

Rôles

L'application utilise le principe du moindre privilège avec une autorisation basée sur les équipes. Les équipes se voient attribuer un rôle qui détermine les fonctionnalités disponibles pour cette équipe. Un utilisateur hérite des rôles de l'appartenance à une équipe. Les administrateurs ont accès à la gestion des équipes et doivent assigner les utilisateurs aux équipes. Initialement, les utilisateurs sont créés sans association à une équipe et n'auront accès à aucune fonctionnalité de l'application.

Les trois rôles sont :

1. Admin
2. Testeur
3. Lecture seule

Une équipe ne peut être associée qu'à une seule organisation. Cependant, une équipe peut être associée à plusieurs actifs au sein de la même organisation. Un utilisateur peut être membre de plusieurs équipes. Si un utilisateur est assigné à plusieurs équipes de la même organisation, le système choisira l'équipe avec la plus haute autorisation.

Veuillez noter : L'utilisateur par défaut est automatiquement assigné à l'équipe Administrateurs au premier démarrage

Matrice des rôles

Clé API et gestion

Un utilisateur peut générer une seule clé API qui peut être utilisée à la place de son jeton d'autorisation. Cette clé API permet toutes les actions sur l'application pour lesquelles l'utilisateur est autorisé.

Génération d'une paire de clés API

1. Connectez-vous à l'application
2. Accédez à la section Profil utilisateur
3. Sélectionnez Générer une clé API

Cette action générera une paire de clés :

1. Bulwark-Api-Key
   1. Il s'agit d'une valeur en texte clair générée pour identifier l'utilisateur.
2. Bulwark-Secret-Key
   1. Il s'agit d'une valeur en texte clair générée pour vérifier l'utilisateur en comparant un hachage Bcrypt stocké dans la base de données.

Notez les clés générées dans un endroit sûr. Vous ne pourrez pas les récupérer ultérieurement.

Comment utiliser les clés API

Les valeurs de la paire de clés API doivent être appariées et ajoutées aux en-têtes de requête HTTP suivants :

• Bulwark-Api-Key
• Bulwark-Secret-Key

Exemple :

GET /api/assessment/1 HTTP/1.1
Host: localhost:4500
Accept: application/json, text/plain, */*
Accept-Language: en-US,en;q=0.5
Accept-Encoding: gzip, deflate
Bulwark-Api-Key: {{changeMe}}
Bulwark-Secret-Key: {{changeMe}}
Origin: http://localhost:4200
Connection: close
Referer: http://localhost:4200/
Pragma: no-cache
Cache-Control: no-cache

Construit avec

• Typeorm - L'ORM utilisé
• Angular - Le framework Angular
• Express - Un framework d'application web Node.js minimal et flexible

Contribuer

Les pull requests sont les bienvenues. Pour des changements majeurs, veuillez d'abord ouvrir un ticket pour discuter de ce que vous souhaitez modifier. Lisez les directives de contribution pour plus d'informations.

Licence

MIT