bulwark

Ein Tool zur Verwaltung von organisatorischen Assets und Schwachstellen, mit Jira-Integration, entwickelt für die Erstellung von Anwendungssicherheitsberichten.

Funktionen

• Multi-Client-Schwachstellenverwaltung
• Erstellung von Sicherheitsberichten
• Jira-Integration
• Rollenbasierte Teamautorisierung
• API-Schlüssel & Verwaltung
• E-Mail-Integration
• Markdown-Unterstützung
• Benutzeraktivierung/-deaktivierung (Admin)

Hinweis

Bitte bedenken Sie, dass sich dieses Projekt in einer frühen Entwicklungsphase befindet.

Demo

Jira-Integration

Start mit Docker

1. Installieren Sie Docker
2. Erstellen Sie eine .env-Datei und geben Sie die folgenden Eigenschaften an:

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"

Bulwark-Container erstellen und starten:

docker-compose up

Bulwark-Container starten/stoppen:

docker-compose start
docker-compose stop

Bulwark-Container entfernen:

docker-compose down

Bulwark ist unter localhost:4500 verfügbar.

Lokale Installation

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

Das Ausführen von npm install installiert sowohl serverseitige als auch clientseitige Module. Außerdem wird das Skript npm run config ausgeführt, das die Umgebungsvariablen dynamisch setzt und zusätzlich die Angular-Umgebung aktualisiert.

Entwicklungsmodus

Setzen Sie NODE_ENV="development"

$ npm run config
$ npm run start:dev

Produktionsmodus

Setzen Sie NODE_ENV="production" Bitte beachten: npm install baut automatisch im Produktionsmodus

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

Umgebungsvariablen

Erstellen Sie eine .env-Datei im Hauptverzeichnis. Diese wird von der Anwendung mit dotenv geparst.

DB_PASSWORD

DB_PASSWORD="somePassword"

Setzen Sie diese Variable auf das Datenbank-Passwort

DB_USERNAME

DB_USERNAME="foobar"

Setzen Sie diese Variable auf den Datenbank-Benutzernamen

DB_URL

DB_URL=something-foo-bar.dbnet

Setzen Sie diese Variable auf die Datenbank-URL

DB_PORT

DB_PORT=3306

Setzen Sie diese Variable auf den Datenbank-Port

DB_NAME

DB_NAME="foobar"

Setzen Sie diese Variable auf den Datenbank-Verbindungsnamen

DB_TYPE

DB_TYPE="mysql"

Die Anwendung wurde mit einer MySQL-Datenbank entwickelt. Weitere Datenbankoptionen finden Sie in der typeorm-Dokumentation.

NODE_ENV

NODE_ENV=production

Setzen Sie diese Variable, um die Node-Umgebung zu bestimmen

DEV_URL="http://localhost:4200"

Wird von Angular zum Erstellen und Bereitstellen der Anwendung verwendet

SERVER_ADDRESS="http://localhost"

Aktualisieren Sie dies, falls eine andere Serveradresse erforderlich ist

PORT=4500

Aktualisieren Sie dies, falls ein anderer Serverport erforderlich ist

JWT_KEY

JWT_KEY="changeMe"

Setzen Sie diese Variable auf das JWT-Geheimnis

JWT_REFRESH_KEY

JWT_REFRESH_KEY="changeMe"

Setzen Sie diese Variable auf das Refresh-JWT-Geheimnis

CRYPTO_SECRET

CRYPTO_SECRET="randomValue"

Setzen Sie diese Variable auf das Scrypt-Passwort.

CRYPTO_SALT

CRYPTO_SECRET="randomValue"

Setzen Sie diese Variable auf das Scrypt-Salt.

Leeres .env-Datei-Template

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=""

Hinweis für M1/M2-Macs

Install sqlite3: 
brew install sqlite3

Export compiler related env variables: 
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

Prepare for a fresh install:
rm -rf node_modules
npm cache verify
npm i --force

Erste Datenbankmigration erstellen

1. Erstellen Sie die erste Datenbankmigration

$ npm run migration:init

2. Führen Sie die erste Datenbankmigration aus

$ npm run migration:run

Standard-Anmeldedaten

Beim ersten Start wird ein Benutzerkonto mit folgenden Anmeldedaten erstellt:

• E-Mail: [email protected]
• Passwort: changeMe

Nach dem ersten Login aktualisieren Sie das Standard-Passwort im Profilbereich.

Rollen

Die Anwendung verwendet das Prinzip der geringsten Privilegien mit teambasierter Autorisierung. Teams wird eine Rolle zugewiesen, die die für dieses Team verfügbaren Funktionen bestimmt. Ein Benutzer erbt Rollen durch die Teammitgliedschaft. Administratoren haben Teamverwaltungszugriff und müssen Benutzer Teams zuweisen. Anfangs werden Benutzer ohne Teamzuordnung erstellt und haben keinen Zugriff auf Funktionen in der Anwendung.

Die drei Rollen umfassen:

1. Admin
2. Tester
3. Schreibgeschützt

Ein Team kann nur einer einzigen Organisation zugeordnet werden. Ein Team kann jedoch mehreren Assets innerhalb derselben Organisation zugeordnet werden. Ein Benutzer kann Mitglied mehrerer Teams sein. Wenn ein Benutzer mehreren Teams derselben Organisation zugewiesen ist, wählt das System das am höchsten autorisierte Team aus.

Bitte beachten: Der Standardbenutzer wird beim ersten Start automatisch dem Team Administrators zugewiesen

Rollenmatrix

API-Schlüssel & Verwaltung

Ein Benutzer kann einen einzelnen API-Schlüssel generieren, der anstelle des Autorisierungstokens verwendet werden kann. Dieser API-Schlüssel ermöglicht alle Aktionen in der Anwendung, für die der Benutzer autorisiert ist.

Generieren eines API-Schlüsselpaars

1. Melden Sie sich bei der Anwendung an
2. Navigieren Sie zum Bereich Benutzerprofil
3. Wählen Sie API-Schlüssel generieren

Diese Aktion generiert ein Paar von Schlüsseln:

1. Bulwark-Api-Key
   1. Dies ist ein generierter Klartextwert zur Identifizierung des Benutzers.
2. Bulwark-Secret-Key
   1. Dies ist ein generierter Klartextwert zur Überprüfung des Benutzers durch Vergleich eines in der Datenbank gespeicherten Bcrypt-Hashs.

Notieren Sie die generierten Schlüssel an einem sicheren Ort. Sie können die Schlüssel zu einem späteren Zeitpunkt nicht abrufen.

So verwenden Sie API-Schlüssel

Die Werte des API-Schlüsselpaars müssen übereinstimmen und an die folgenden HTTP-Request-Header angehängt werden:

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

Beispiel:

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

Erstellt mit

• Typeorm - Das verwendete ORM
• Angular - Das Angular-Framework
• Express - Ein minimales und flexibles Node.js-Webanwendungsframework

Mitwirken

Pull-Requests sind willkommen. Bei größeren Änderungen öffnen Sie bitte zunächst ein Issue, um zu besprechen, was Sie ändern möchten. Lesen Sie die Beitragsrichtlinien für weitere Informationen.

Lizenz

MIT