bulwark

Uma ferramenta de gerenciamento de ativos organizacionais e vulnerabilidades, com integração com Jira, projetada para gerar relatórios de segurança de aplicações.

Funcionalidades

• Gerenciamento de Vulnerabilidades Multi-cliente
• Geração de Relatórios de Segurança
• Integração com Jira
• Autorização baseada em funções de equipe
• Chave de API e Gerenciamento
• Integração de E-mail
• Suporte a Markdown
• Ativação/Desativação de Usuário (Admin)

Nota

Por favor, lembre-se, este projeto está em desenvolvimento inicial.

Demonstração

Integração com Jira

Iniciar com Docker

1. Instale o Docker
2. Crie um arquivo .env e forneça as seguintes propriedades:

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"

Construa e inicie os containers do Bulwark:

docker-compose up

Iniciar/Parar containers do Bulwark:

docker-compose start
docker-compose stop

Remover containers do Bulwark:

docker-compose down

O Bulwark estará disponível em localhost:4500

Instalação Local

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

Executar npm install instalará ambos os módulos do lado do servidor e do cliente. Além disso, executará o script npm run config que definirá dinamicamente as variáveis de ambiente, além de atualizar o ambiente Angular.

Modo de Desenvolvimento

Defina NODE_ENV="development"

$ npm run config
$ npm run start:dev

Modo de Produção

Defina NODE_ENV="production" Observe: npm install fará a construção automaticamente em modo de produção

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

Variáveis de ambiente

Crie um arquivo .env no diretório raiz. Isso será interpretado com dotenv pela aplicação.

DB_PASSWORD

DB_PASSWORD="somePassword"

Defina esta variável para a senha do banco de dados

DB_USERNAME

DB_USERNAME="foobar"

Defina esta variável para o nome de usuário do banco de dados

DB_URL

DB_URL=something-foo-bar.dbnet

Defina esta variável para a URL do banco de dados

DB_PORT

DB_PORT=3306

Defina esta variável para a porta do banco de dados

DB_NAME

DB_NAME="foobar"

Defina esta variável para o nome de conexão do banco de dados

DB_TYPE

DB_TYPE="mysql"

A aplicação foi desenvolvida usando um banco de dados MySQL. Consulte a documentação do typeorm para mais opções de banco de dados.

NODE_ENV

NODE_ENV=production

Defina esta variável para determinar o ambiente do Node

DEV_URL="http://localhost:4200"

Usado pelo Angular para construir e servir a aplicação

SERVER_ADDRESS="http://localhost"

Atualize se for necessário um endereço de servidor diferente

PORT=4500

Atualize se for necessária uma porta de servidor diferente

JWT_KEY

JWT_KEY="changeMe"

Defina esta variável para o segredo JWT

JWT_REFRESH_KEY

JWT_REFRESH_KEY="changeMe"

Defina esta variável para o segredo de atualização JWT

CRYPTO_SECRET

CRYPTO_SECRET="randomValue"

Defina esta variável para a senha Scrypt.

CRYPTO_SALT

CRYPTO_SECRET="randomValue"

Defina esta variável para o salt Scrypt.

Modelo de arquivo .env vazio

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 sobre Macs M1/M2

Instale o sqlite3: 
brew install sqlite3

Exporte variáveis de ambiente relacionadas ao 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 uma instalação limpa:
rm -rf node_modules
npm cache verify
npm i --force

Criar Migração Inicial do Banco de Dados

1. Crie a migração inicial do banco de dados

$ npm run migration:init

2. Execute a migração inicial do banco de dados

$ npm run migration:run

Credenciais padrão

Uma conta de usuário é criada na inicialização com as seguintes credenciais:

• email: [email protected]
• password: changeMe

Após o primeiro login, atualize a senha do usuário padrão na seção de perfil.

Funções

A aplicação utiliza acesso com privilégios mínimos com autorização baseada em equipes. As equipes recebem uma função que determina os recursos disponíveis para essa equipe específica. Um usuário herdará funções da associação à equipe. Os administradores têm acesso de gerenciamento de equipes e devem atribuir usuários às equipes. Inicialmente, os usuários são criados sem associação a nenhuma equipe e não terão acesso a nenhum recurso da aplicação.

As três funções incluem:

1. Administrador
2. Testador
3. Somente Leitura

Uma equipe pode estar associada apenas a uma única organização. No entanto, uma equipe pode estar associada a vários ativos dentro da mesma organização. Um usuário pode ser membro de várias equipes. Se um usuário for atribuído a várias equipes da mesma organização, o sistema escolherá a equipe com maior autorização.

Observação: O usuário padrão é automaticamente atribuído à equipe Administrators na inicialização.

Matriz de Funções

Chave de API e Gerenciamento

Um usuário pode gerar uma única chave de API que pode ser usada no lugar de seu token de autorização. Essa chave de API permite todas as ações contra a aplicação para as quais o usuário está autorizado.

Gerando um par de chaves de API

1. Faça login na aplicação
2. Navegue até a seção User Profile
3. Selecione Generate API Key

Esta ação gerará um par de chaves:

1. Bulwark-Api-Key
   1. Este é um valor de texto simples gerado para identificar o usuário.
2. Bulwark-Secret-Key
   1. Este é um valor de texto simples gerado para verificar o usuário comparando um hash Bcrypt armazenado no banco de dados.

Anote as chaves geradas em um local seguro. Você não poderá recuperar as chaves posteriormente.

Como usar as chaves de API

Os valores do par de chaves de API devem ser combinados e adicionados aos seguintes cabeçalhos de requisição HTTP:

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

Exemplo:

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

Construído Com

• Typeorm - O ORM usado
• Angular - O Framework Angular
• Express - Um framework de aplicação web Node.js minimalista e flexível

Contribuição

Pull requests são bem-vindos. Para mudanças significativas, por favor, abra uma issue primeiro para discutir o que você gostaria de alterar. Leia as diretrizes de contribuição para mais informações.

Licença

MIT