Skip to content

Latest commit

 

History

History
84 lines (63 loc) · 2.48 KB

README.md

File metadata and controls

84 lines (63 loc) · 2.48 KB
Raw

product-golang-backend-interview

This interview station involves a small microservice architecture that scans root domains for subdomains and persists that information in a SQL database.

Microservice Documentation

Dependencies

In order to run the Kafka zookeeper, Kafka broker, and MySQL server, you'll need to install docker-compose.

In order to compile the two microservices, you'll need Go 1.17 or newer.

Component Breakdown

There are four components in this project:

  • Orchestrator (orchestrator/)
    • API server that serves for requests to scan a domain and view information about previously scanned domains and their subdomains
  • Enumeration (enumeration/)
    • Ingests a domain, iterates over its subdomains, and publishes individual events for the subdomains
  • MySQL (docker-compose.yaml)
    • Consists of a scanner database accessible to the root user
  • Kafka (docker-compose.yaml)
    • Consists of a zookeeper and a single broker

Usage

To run the Kafka and MySQL containers, spin them up with docker-compose:

docker-compose up -d

Don't forget to create the kafka topics:

./create-topics.sh

To run the orchestrator and enumeration services, cd into the respective directory and run

./run.sh

Once both services are running, start a subdomain scan by calling the orchestrator's ingest endpoint:

curl -v -X POST "localhost:9000/api/v1/ingest" -H "Content-type: application/json" -d '{"Domain": "praetorian.com"}'

If the call succeeds, the output from cURL should look like:

Note: Unnecessary use of -X or --request, POST is already inferred.
*   Trying 127.0.0.1:9000...
* Connected to localhost (127.0.0.1) port 9000 (#0)
> POST /api/v1/ingest HTTP/1.1
> Host: localhost:9000
> User-Agent: curl/7.87.0
> Accept: */*
> Content-type: application/json
> Content-Length: 28
> 
* Mark bundle as not supporting multiuse
< HTTP/1.1 200 OK
< Date: Wed, 02 Aug 2023 21:31:38 GMT
< Content-Length: 0
< 
* Connection #0 to host localhost left intact

API

These are the endpoints that the orchestrator supports:

POST /api/v1/ingest
  example body: { "Domain": "praetorian.com" }
  
  Initiates a scan of the provided domain.

GET  /api/v1/domain
  Returns all domains that have been scanned since startup

GET  /api/v1/subdomain?page=<uint32>&limit=<uint32>
  Returns up to <limit> starting on page <page>.