Skip to content

Commit

Permalink
fixes #3: basic readme added
Browse files Browse the repository at this point in the history
  • Loading branch information
bilalcaliskan committed Jun 26, 2021
1 parent 59d9968 commit 4371be7
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,26 @@

[![CI](https://github.com/bilalcaliskan/syn-flood/workflows/CI/badge.svg?event=push)](https://github.com/bilalcaliskan/syn-flood/actions?query=workflow%3ACI)
[![Docker pulls](https://img.shields.io/docker/pulls/bilalcaliskan/syn-flood)](https://hub.docker.com/r/bilalcaliskan/syn-flood/)
[![Go Report Card](https://goreportcard.com/badge/github.com/bilalcaliskan/syn-flood)](https://goreportcard.com/report/github.com/bilalcaliskan/syn-flood)
[![Go Report Card](https://goreportcard.com/badge/github.com/bilalcaliskan/syn-flood)](https://goreportcard.com/report/github.com/bilalcaliskan/syn-flood)

This project is developed with the objective of learning low level network operations with Golang. It starts a syn flood attack
with raw sockets. Do not use it with devil needs.

### Configuration
syn-flood can be customized with several command line arguments:
```
--dstIpStr Provide public ip of the destination
--dstPort Provide reachable port of the destination
--payloadLength Provide payload length in bytes for each SYN packet
```

### Download

#### Binary
Binary can be downloaded from [Releases](https://github.com/bilalcaliskan/syn-flood/releases) page.

#### Docker
Docker image can be downloaded with below command:
```shell
$ docker run bilalcaliskan/syn-flood:latest
```

0 comments on commit 4371be7

Please sign in to comment.