knyga/ddos-attack-benchmarker

DDoS Attack Benchmarker

HTTP/TCP/UDP server to generate benchmark details for DDoS (benchmark) tools. It helps to understand what DDoS (benchmark) tool is working and how well it performs.

Where to find benchmark tools

• https://github.com/denji/awesome-http-benchmark
• https://github.com/alexmon1989/russia_ddos
• https://github.com/MatrixTM/MHDDoS

API

Parts

1. HTTP Control API. It is started with process boot.
2. Benchmark Server. It is started with start request for HTTP Control API.

HTTP Control API is REST API with methods

1. HTTP GET /start?type=(http|tcp|udp)&port=$PORT_NUMBER&view=(text|json)&duration=$DURATION_IN_SECONDS.

• Request resets Stats and boots up Server of Type on the Port. It changes Status to Started.
• type is a type of Benchmark Server. Supported types: http, tcp, udp. Required.
• port is a port number for Benchmark Server. Required.
• view is type of response format. Default is json. Optional.
• duration is lifetime in seconds of the Benchmark Server. By default Benchmark Server listens while stop is not requested. Optional.
• If Status is not Stopped then it will return 400 HTTP code. Only one Server could run at the same time.
• If case of success then it will return 200 HTTP code.
• If Server can't be started then it will return 403 HTTP code.
• Duration is an optional param. It specifies lifetime of the Benchmark Server in seconds.
• Benchmark Server session start time (lower boundary) will correspond to the first request.

2. HTTP GET /stop?view=(text|json).

• Request stops Stats accumulation, kills Server, and returns Stats. It changes Status to Stopped.
• view is type of response format. Default is json. Optional.
• If Status is not Started then it will return 400 HTTP code.
• If case of success it will return 200 HTTP code and Stats object.

3. HTTP GET /stats?view=(text|json).

• Request returns latests Stats accumulation without changing State.
• view is type of response format. Default is json. Optional.
• If Status is not Started then it will return 400 HTTP code.
• If case of success it will return 200 HTTP code and Stats object.
• Benchmark Server session stop time (upper boundary) will correspond to the latests request.

Object details

enum Status {
  Started,
  Stopped,
}

enum Type {
  TCP = 'tcp',
  UDP = 'udp',
  HTTP = 'http',
}

interface Stats {
  type: Type,
  duration: {
    seconds: Number,
  },
  requests: {
    total: {
      count: Number,
      bytes: Number,
    },
    average: {
      perSecond: {
        count: Number,
        bytes: Number,
      },
    },
  },
}

How to start

Without Docker

Prerequisites

1. Node.js >= 14.17.6 and < 15.
2. NPM >= 6.14.15 and < 7.

Installation

npm ci.

Start

To start HTTP Control API on port 8070: npm run start -- -p 8070 or node ddbenchmarker -p 8070 or ./ddbenchmarker.js -p 8070.

Arguments

1. -p, --port. Port for HTTP Control API
2. -l, --duration. Lifetime in seconds.
3. -d, --detach. Detach process from execution.

Usage example

node ddbenchmarker -p 8070 # start in separate process or daemon

curl http://localhost:8070/start?type=http&port=5555
# {"code":200,"message":"HTTP Control API is listening on port 5555"}
curl http://localhost:5555
curl http://localhost:5555
curl http://localhost:5555
curl http://localhost:5555
curl http://localhost:5555
curl http://localhost:8070/stop
# {"code":200,"data":{"type":"http","duration":{"seconds":0.03},"requests":{"average":{"perSecond":{"count":147.05882352941177,"bytes":11470.588235294117}},"total":{"count":5,"bytes":390}}}}

If you prefer response in text format:

curl http://localhost:8070/start?type=http&port=5555&view=text
# HTTP Benchmark Server is listening on port 5555
curl http://localhost:5555
curl http://localhost:5555
curl http://localhost:5555
curl http://localhost:5555
curl http://localhost:5555
curl http://localhost:8070/stop?view=text
# Benchmark server type: http
# Execution duration (seconds): 0.03
# Total request number: 5
# Total received bytes: 390
# Average number of requests per second: 151.52
# Average number of received bytes per second: 11818.18

It is not required to stop server to get stats:

curl http://localhost:8070/start?type=http&port=5555&view=text
curl http://localhost:5555
curl http://localhost:5555
curl http://localhost:5555
curl http://localhost:5555
curl http://localhost:5555
curl http://localhost:8070/stats?view=text
# Benchmark server type: http
# Execution duration (seconds): 0.03
# Total request number: 5
# Total received bytes: 390
# Average number of requests per second: 161.29
# Average number of received bytes per second: 12580.65

Remarks

1. Default HTTP Control API port in 80.
2. Access to some ports might require root permissions.
3. You can't start multiple servers of same type.
4. Known bug. UDP Benchmark Server doesn't accept more than 9216 bytes per message.

With Docker

Docker is not implemented yet.

Warning

Docker comes with performance limitations. It is not recommended to use it for benchmarking.

Prerequisites

Docker.

Start

To start HTTP Control API on port 8080 and preplanned exposed port (UDP) for Benchmark Server 8053: docker run -it -p 8080:80/tcp -p 8053:53/udp --rm oknyga/ddos-attack-benchmarker:latest -p 80.

Usage example

docker run -it -p 8080:80/tcp -p 5555:5555/tcp --rm oknyga/ddos-attack-benchmarker:latest -p 80 # start in separate process or daemon

# ... same as in (Without Docker)

Remarks

1. Same remarks as for Without Docker.
2. Plan ports you will be using ahead, read Published ports in Container networking documentation of the Docker: https://docs.docker.com/config/containers/container-networking/

License

This project is distributed under the MIT License, see LICENSE for more information.