Status: WIP / PoC

This project is an attempt to implement a lightweight burp collaborator-esc application and consists of two main components: a DNS Server (Custom Python Implemention with dnslib) and an API.

For more information on Burp Collaborator, checkout burp's documentation

When answering queries, the DNS server hits the API with information regarding the DNS query. The API will then serve the log of the DNS queries via a RESTful HTTP API as well as front-end (HTML/JS) web GUI.

As of now the project can only automatically build for development. The build system uses docker and docker-compose to raise multiple services which the application requires.

Run the following to build and pull the containers.

$ ./compose.sh dev build

Go into the .env folder and copy all the examples to files with the ".example" extension removed. You will need to reference the next section to create a DNS API Token for the "dns.env" folder.

Run the following to generate the API_TOKEN.

$ ./api-token.sh

Copy the relevant output to dns.env to set the API_TOKEN variable.

This is only required for development containers where the front end code is mounted.

$ cd bountydns/webui
$ npm install
$ npm run build

# alternatively, you can run watch to automatically rebuild the frontend

$ npm run watch

Run the following to run the containers.

$ ./compose.sh dev up

The development Docker Compose project uses mounts to mount the correct folders and files onto the "bountydns" and "dns" containers. In addition, the command uses "--reload" so you can edit the python project on your host and automatically refresh the servers inside the containers.

The frontend WebUI application is also mounted. To setup automatic rebuilding, run the following:

$ cd bountydns/webui
$ npm run watch

You will still need to refresh the browser to view changes.

The following details the general outline for the future of this project.

The first iteration of the project will be a proof of concept to demonstrate the project's viability. At this point, the project should not be considered stable, secure, or feature complete.

Features:

• Create API Tokens via WebUI / CLI for Dns Servers
• Create Zones for Specific DNS Servers
• Log DNS Resolution

After demonstrating that the project is worth dedicating time to, Phase 2 will involve making the project feature complete with all clients (WebUI / CLI) and features (webhooks / email / queue) completed. At this point, the project should not be considered stable nor secure.

Features:

• Manage DNS Records through WebUI / API
• Ability to update the DNS server's records for running DNS Server (WebSocket)
• Receive Notifications on DNS Resolution via email or webhook
• Easily build the application with Docker, Packer, & Terraform

Next, sanity checks and proper handlers will be put in place so that API calls fail gracefully. At this point the project should not be considered secure.

Features:

• Actual validation & Error Handling

Once I'm satisfied the code is not complete trash, I'll release it as version 0.1.0-alpha. At this point, the project should be considered secure enough to deploy. Though I'd recommend doing so in a protected network. If the application proves valuable enough to me personally or others, I'll continue to add features / improvements.

Once the core DNS use case is satisfied, the API will be extended to support the resolution of HTTP/S and SMTP requests.

TODO:

• Build DNS Implementation

• Build CLI Foundation

• Build Alembic Commands

• Build API Auth Routes

• Build API Authentication Controls

• Build API Token Capabilities (Generate Extended Auth Tokens)

• Build API Zone / DNS Routes

• Integrate API Callbacks into DNS Server

• Build Web GUI Foundation

• Incorporate ApiClient and ApiTokens into DNS Server

• Get Websockets Working

• Handle Pagination on the Front End

• Create docker compose files

• Create Server Page

• Create DNS Server Create Form

• Create DNS Server Edit Form

• Fix API Tokens Page (validation, etc)

• Create DNS Record Repo, Factory, Seed Data, etc

• Create DNS Server View Page

• Create DNS Zone page with Record Table

• Create DNS Create Record Form

• Create DNS Edit Record Form

• Validate DNS Records in create and edit forms

• Change DNS Server to Pull Records from API

• Allow user to seed from yaml

• Perform Validation on the Front End for other pages

• Perform Better Validation on the Backend

• Handle Errors on the Front End

• Fix WebSockets

• Check for refreshable WebSocket token on page load

• Add tests to API

• Use vuex store for datatable data

• Make relationsips sortable in repo

• Create DNS Payloads Page

• Create DNS Payloads Form

• Create Packer build
• Create Terraform build
• Transfer record creation to the API
• Implement websocket in DNS server to receive updates regarding records
• Build ability for webhook's / events
• Confirm DNS Server is as Compliant as possible
• Divide the project into submodules

usage: bdnsctl.py [-h]
                  {db-seed,seed,db-setup,setup,db-truncate,truncate,test,tests,user-create,user,user-list,users,alembic-current,al-current,alembic-downgrade,al-downgrade,alembic-history,al-history,alembic-init,al-init,alembic-migrate,al-migrate,alembic-show,al-show,alembic-stamp,al-stamp,alembic-upgrade,al-upgrade,zone-create,zone,zone-list,zones,api-login,login,api-server,api,api-urls,urls,api-user-create,api-user,api-user-list,api-users,api-zone-create,api-zone,api-zone-list,api-zones,api-token-list,api-tokens,dns-server,dns}
                  ...

positional arguments:
  {db-seed,seed,db-setup,setup,db-truncate,truncate,test,tests,user-create,user,user-list,users,alembic-current,al-current,alembic-downgrade,al-downgrade,alembic-history,al-history,alembic-init,al-init,alembic-migrate,al-migrate,alembic-show,al-show,alembic-stamp,al-stamp,alembic-upgrade,al-upgrade,zone-create,zone,zone-list,zones,api-login,login,api-server,api,api-urls,urls,api-user-create,api-user,api-user-list,api-users,api-zone-create,api-zone,api-zone-list,api-zones,api-token-list,api-tokens,dns-server,dns}
                        command
    db-seed (seed)      seed db
    db-setup (setup)    setup db
    db-truncate (truncate)
                        truncate db
    test (tests)        run tests
    user-create (user)  create users via DB
    user-list (users)   list users via DB
    alembic-current (al-current)
                        run alembic current
    alembic-downgrade (al-downgrade)
                        run alembic downgrade
    alembic-history (al-history)
                        run alembic history
    alembic-init (al-init)
                        run alembic init
    alembic-migrate (al-migrate)
                        run alembic migrate
    alembic-show (al-show)
                        run alembic show
    alembic-stamp (al-stamp)
                        run alembic stamp
    alembic-upgrade (al-upgrade)
                        run alembic upgrade
    zone-create (zone)  create zones via DB
    zone-list (zones)   list zones via DB
    api-login (login)   login via API
    api-server (api)    run api server
    api-urls (urls)     list api urls
    api-user-create (api-user)
                        create user via API
    api-user-list (api-users)
                        list users via API
    api-zone-create (api-zone)
                        create user via API
    api-zone-list (api-zones)
                        list zones via API
    api-token-list (api-tokens)
                        list api-tokens via DB
    dns-server (dns)    run dns server

optional arguments:
  -h, --help            show this help message and exit