Skip to content

Commit

Permalink
Documentation
Browse files Browse the repository at this point in the history
typo
  • Loading branch information
tsebastiani committed Jul 12, 2024
1 parent dc03912 commit 1a72e10
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
![action](https://github.com/krkn-chaos/krkn-syn-flood/actions/workflows/build.yaml/badge.svg)
# SYN Flood Scenario attacker container
This is the container used by the syn flood scenario in krkn that creates the syn traffic against the target service. Krkn manages to deploy the number of pods specified by the user respecting, when available, the node affinity specified.
This container expects the following environment variables:

### SYN Flood Scenario Attacker Container

|Variable Name | Description| Default |
|-------------| -----------|---------|
|TARGET | The target ip address or hostname||
|DURATION | The SYN flood attack duration in seconds||
|PACKET_SIZE | The SYN TCP packet size in bytes|120|
|WINDOW_SIZE | The TCP window size | 64|
This container is used in the SYN flood scenario within Krkn, generating SYN traffic against the target service. Krkn deploys the specified number of pods, adhering to node affinity when available.

To more detailed information about this settings please visit the [hping3 documentation](https://github.com/NullHypothesis/hping3).
The following environment variables are expected by this container:

| Variable Name | Description | Default |
|---------------|---------------------------------------|---------|
| TARGET | The target IP address or hostname | |
| DURATION | The duration of the SYN flood attack in seconds | |
| PACKET_SIZE | The size of the SYN TCP packet in bytes | 120 |
| WINDOW_SIZE | The TCP window size | 64 |

For more detailed information about these settings, please refer to the [hping3 documentation](https://github.com/NullHypothesis/hping3).

0 comments on commit 1a72e10

Please sign in to comment.