|
1 | 1 | # gfwKnock |
| 2 | +![go] |
| 3 | + |
2 | 4 | knock up GFW detection with packet fragmentation method PoC |
| 5 | + |
| 6 | +## Installation |
| 7 | + |
| 8 | +### Getting the Latest Release |
| 9 | +You can get the release of gfwKnock from [Releases](https://github.com/SonyaCore/gfwKnock/releases) section |
| 10 | + |
| 11 | +Make sure to properly set configuration file. |
| 12 | + |
| 13 | + |
| 14 | +### Building from Source |
| 15 | +Clone the Repository this by running this command : |
| 16 | + |
| 17 | +```bash |
| 18 | + git clone https://github.com/SonyaCore/gfwKnock.git |
| 19 | +``` |
| 20 | + |
| 21 | +Now Cd into project directory and use the following command to compile the program and then run the compiled binary : |
| 22 | + |
| 23 | +```bash |
| 24 | +cd gfwKnock |
| 25 | +go build -o gfwKnock -ldflags "-s -w -buildid=" . |
| 26 | + ./gfwKnock |
| 27 | +``` |
| 28 | + |
| 29 | +## Configuration |
| 30 | +gfwKnock Uses default a configuration file with the following specifications : |
| 31 | + |
| 32 | +* `listen_port` : port for running gfwKnock client. |
| 33 | +* `cloud_flare_ip` : cloudflare ip. |
| 34 | +* `cloud_flare_port` : cloudflare port. |
| 35 | +* `socket_timeout`: time in seconds for closing the server socket if the socket doesn't respond. |
| 36 | +* `fragment_sleep` : sleep in milliseconds between each fragment. |
| 37 | +* `l_fragment` : length of fragments of Client hello packets. |
| 38 | + |
| 39 | +example of config.json : |
| 40 | + |
| 41 | +```json |
| 42 | +{ |
| 43 | + // key : value : type |
| 44 | + "listen_port": 8080, // Integer |
| 45 | + "cloud_flare_ip": "45.85.118.88", // String |
| 46 | + "cloud_flare_port": 443, // Integer |
| 47 | + "socket_timeout": "60", // int Seconds |
| 48 | + "fragment_sleep": "100" // int Miliseconds, |
| 49 | + "l_fragment": 77 // int Byte |
| 50 | + |
| 51 | +} |
| 52 | +``` |
| 53 | + |
| 54 | +## License |
| 55 | + |
| 56 | +Licensed under the [GPL-3][license] license. |
| 57 | + |
| 58 | + |
| 59 | +[license]: LICENCE |
| 60 | +[go]: https://img.shields.io/badge/Go-cyan?logo=go |
| 61 | + |
| 62 | + |
0 commit comments