bulwark

Una herramienta organizativa de gestión de activos y vulnerabilidades, con integración con Jira, diseñada para generar informes de seguridad de aplicaciones.

Funcionalidades

• Gestión de vulnerabilidades para múltiples clientes
• Generación de informes de seguridad
• Integración con Jira
• Autorización basada en roles de equipo
• Clave API y gestión
• Integración de correo electrónico
• Soporte de Markdown
• Activación/desactivación de usuarios (admin)

Nota

Tenga en cuenta que este proyecto está en desarrollo temprano.

Demostración

Integración con Jira

Iniciar con Docker

1. Instale Docker
2. Cree un archivo .env y proporcione las siguientes propiedades:

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"

Construya e inicie los contenedores de Bulwark:

docker-compose up

Iniciar/Detener contenedores de Bulwark:

docker-compose start
docker-compose stop

Eliminar contenedores de Bulwark:

docker-compose down

Bulwark estará disponible en localhost:4500

Instalación local

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

Ejecutar npm install instalará tanto los módulos del servidor como los del cliente. Además, ejecutará el script npm run config que establecerá dinámicamente las variables de entorno además de actualizar el entorno de Angular.

Modo de desarrollo

Establezca NODE_ENV="development"

$ npm run config
$ npm run start:dev

Modo de producción

Establezca NODE_ENV="production" Tenga en cuenta: npm install compilará automáticamente en modo de producción

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

Variables de entorno

Cree un archivo .env en el directorio raíz. La aplicación lo analizará con dotenv.

DB_PASSWORD

DB_PASSWORD="somePassword"

Establezca esta variable a la contraseña de la base de datos

DB_USERNAME

DB_USERNAME="foobar"

Establezca esta variable al nombre de usuario de la base de datos

DB_URL

DB_URL=something-foo-bar.dbnet

Establezca esta variable a la URL de la base de datos

DB_PORT

DB_PORT=3306

Establezca esta variable al puerto de la base de datos

DB_NAME

DB_NAME="foobar"

Establezca esta variable al nombre de conexión de la base de datos

DB_TYPE

DB_TYPE="mysql"

La aplicación fue desarrollada utilizando una base de datos MySQL. Consulte la documentación de typeorm para más opciones de bases de datos.

NODE_ENV

NODE_ENV=production

Establezca esta variable para determinar el entorno de Node

DEV_URL="http://localhost:4200"

Usado por Angular para construir y servir la aplicación

SERVER_ADDRESS="http://localhost"

Actualice si se requiere una dirección de servidor diferente

PORT=4500

Actualice si se requiere un puerto de servidor diferente

JWT_KEY

JWT_KEY="changeMe"

Establezca esta variable al secreto de JWT

JWT_REFRESH_KEY

JWT_REFRESH_KEY="changeMe"

Establezca esta variable al secreto de actualización de JWT

CRYPTO_SECRET

CRYPTO_SECRET="randomValue"

Establezca esta variable a la contraseña de Scrypt.

CRYPTO_SALT

CRYPTO_SECRET="randomValue"

Establezca esta variable a la sal de Scrypt.

Plantilla de archivo .env vacío

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

Nota para Macs M1/M2

Instale sqlite3:
brew install sqlite3

Exporte las variables de entorno relacionadas con el compilador:
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 para una instalación limpia:
rm -rf node_modules
npm cache verify
npm i --force

Crear la migración inicial de la base de datos

1. Cree la migración inicial de la base de datos

$ npm run migration:init

2. Ejecute la migración inicial de la base de datos

$ npm run migration:run

Credenciales predeterminadas

Se crea una cuenta de usuario al iniciar por primera vez con las siguientes credenciales:

• email: [email protected]
• password: changeMe

Al iniciar sesión por primera vez, actualice la contraseña del usuario predeterminado en la sección de perfil.

Roles

La aplicación utiliza el principio de mínimo privilegio con autorización basada en equipos. A los equipos se les asigna un rol que determina las funcionalidades disponibles para ese equipo específico. Un usuario hereda los roles de la membresía del equipo. Los administradores tienen acceso de gestión de equipos y deben asignar usuarios a equipos. Inicialmente, los usuarios se crean sin asociación a ningún equipo y no tendrán acceso a ninguna funcionalidad de la aplicación.

Los tres roles incluyen:

1. Admin
2. Tester
3. Solo lectura

Un equipo solo puede estar asociado a una única organización. Sin embargo, un equipo puede estar asociado a múltiples activos dentro de la misma organización. Un usuario puede ser miembro de varios equipos. Si un usuario está asignado a varios equipos de la misma organización, el sistema elegirá el equipo con la autorización más alta.

Tenga en cuenta: El usuario predeterminado se asigna automáticamente al equipo Administrators al iniciar por primera vez

Matriz de roles

Clave API y gestión

Un usuario puede generar una única clave API que se puede usar en lugar de su token de autorización. Esta clave API permite todas las acciones contra la aplicación para las que el usuario está autorizado.

Generar un par de claves API

1. Inicie sesión en la aplicación
2. Navegue a la sección Perfil de usuario
3. Seleccione Generar clave API

Esta acción generará un par de claves:

1. Bulwark-Api-Key
   1. Este es un valor en texto plano generado para identificar al usuario.
2. Bulwark-Secret-Key
   1. Este es un valor en texto plano generado para verificar al usuario comparando un hash Bcrypt almacenado en la base de datos.

Anote las claves generadas en un lugar seguro. No podrá recuperar las claves más adelante.

Cómo usar las claves API

Los valores del par de claves API deben coincidir y agregarse a los siguientes encabezados de solicitud HTTP:

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

Ejemplo:

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

Construido con

• Typeorm - El ORM utilizado
• Angular - El framework Angular
• Express - Un framework de aplicaciones web Node.js minimalista y flexible

Contribuir

Las solicitudes de extracción son bienvenidas. Para cambios importantes, abra primero un issue para discutir lo que le gustaría cambiar. Lea las guías de contribución para más información.

Licencia

MIT