Bulwark Organizational Asset and Vulnerability Management Tool

Bulwark is an organizational asset and vulnerability management tool designed for building and generating application security reports.

Note

Please keep in mind, this project is very early in the development phase.

Installing

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

Run in development mode:

$ npm run start:dev

Run in production mode:

$ npm start

Environment variables

Create a .env file which will be parsed with dotenv.

`DB_PASSWORD`

DB_PASSWORD="somePassword"

Set this variable to database password

`DB_USERNAME`

DB_USERNAME="foobar"

Set this variable to database user name

`DB_URL`

DB_URL=something-foo-bar.dbnet

Set this variable to database URL

`DB_PORT`

DB_PORT=3306

Set this variable to database port

`DB_NAME`

DB_NAME="foobar"

Set this variable to database connection name

`DB_TYPE`

DB_TYPE="mysql"

The application was developed using a MySQL database. See the typeorm documentation for more database options.

`NODE_ENV`

NODE_ENV=production

Set this variable to determine node environment

`DEV_URL="http://localhost:4200"`

Only update if a different port is required

`PROD_URL="http://localhost:5000"`

Only update if a different port is required

`JWT_KEY`

JWT_KEY="changeMe"

Set this variable to the JWT secret

`JWT_REFRESH_KEY`

JWT_REFRESH_KEY="changeMe"

Set this variable to the refresh JWT secret

`FROM_EMAIL`

FROM_EMAIL="foo@bar.com"

Set this variable to sender email

`FROM_EMAIL_PASSWORD`

FROM_EMAIL_PASSWORD="somePassword"

Set this variable to sender email password or a Gmail app passwords

`COMPANY_NAME`

COMPANY_NAME="United Nations Space Command"

Set this variable to the application security company name to be published on the report

Empty .env example

DB_PASSWORD=""
DB_URL=""
DB_USERNAME=""
DB_PORT=3306
DB_NAME=""
DB_TYPE=""
NODE_ENV=""
DEV_URL="http://localhost:4200"
PROD_URL="http://localhost:5000"
JWT_KEY=""
JWT_REFRESH_KEY=""
FROM_EMAIL=""
FROM_EMAIL_PASSWORD=""
COMPANY_NAME=""

Seed Initial User

On initial startup, Bulwark will not have any users. Therefore, it is necessary to seed the first user.

$ npm install
$ npm run start:dev
Navigate to seed-user.ts
Update the userConfig object with user credentials, save, and wait for the JS to compile
$ node ./dist/temp/seed-user.js
Log into Bulwark with credentials used in step 4