|
1 | 1 | # dnsenum-crystal |
2 | 2 |
|
3 | | -TODO: Write a description here |
| 3 | +`dnsenum-crystal` is a modern, high-performance reimagining of the infamous `dnsenum` tool, rewritten from the ground up in Crystal. While the original `dnsenum` served its purpose, its reliance on Perl makes it feel increasingly outdated in today's development landscape. |
4 | 4 |
|
5 | | -## Installation |
| 5 | +This project aims to provide the same powerful DNS enumeration capabilities with the speed, type safety, and modern development experience that Crystal offers. |
| 6 | + |
| 7 | +## Features (Planned/Current) |
6 | 8 |
|
7 | | -TODO: Write installation instructions here |
| 9 | +- **Fast:** Leveraging Crystal's native compilation for blazing-fast execution. |
| 10 | +- **Modern:** Built with a contemporary language and ecosystem. |
| 11 | +- **Familiar:** Retains the core functionality and spirit of the original `dnsenum`. |
8 | 12 |
|
9 | 13 | ## Usage |
10 | 14 |
|
11 | | -TODO: Write usage instructions here |
| 15 | +```bash |
| 16 | +dnsenum [options] <domain> |
| 17 | +``` |
12 | 18 |
|
13 | | -## Development |
| 19 | +**Options:** |
14 | 20 |
|
15 | | -TODO: Write development instructions here |
| 21 | +* `--dnsserver server`: Specify a DNS server to use for queries |
| 22 | +* `--enum`: Perform a full enumeration (A, NS, MX, Zone Transfer, Reverse Lookup, WHOIS) |
| 23 | +* `--noreverse`: Skip reverse DNS lookups |
| 24 | +* `--threads n`: Set the number of threads (default: 10) |
| 25 | +* `-v`, `--verbose`: Enable verbose mode |
| 26 | +* `-o file`, `--output file`: Specify the output file |
| 27 | +* `-h`, `--help`: Show this help message |
| 28 | +* `--version`: Show version information |
16 | 29 |
|
17 | | -## Contributing |
| 30 | +**Example:** |
18 | 31 |
|
19 | | -1. Fork it (<https://github.com/your-github-user/dnsenum-crystal/fork>) |
20 | | -2. Create your feature branch (`git checkout -b my-new-feature`) |
21 | | -3. Commit your changes (`git commit -am 'Add some feature'`) |
22 | | -4. Push to the branch (`git push origin my-new-feature`) |
23 | | -5. Create a new Pull Request |
| 32 | +```bash |
| 33 | +dnsenum -v --threads 20 example.com |
| 34 | +dnsenum example.com |
| 35 | +``` |
| 36 | + |
| 37 | +## Installation |
24 | 38 |
|
25 | | -## Contributors |
| 39 | +```bash |
| 40 | +wget https://github.com/evait-security/dnsenum-crystal/releases/download/latest/dnsenum |
| 41 | +chmod +x dnsenum |
26 | 42 |
|
27 | | -- [Paul Werther](https://github.com/your-github-user) - creator and maintainer |
| 43 | +./dnsenum |
| 44 | +``` |
0 commit comments