Skip to content

Commit b520e16

Browse files
committed
update readme
1 parent 7346be6 commit b520e16

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

+18-3
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ The output of bulkDNS is a detailed JSON structure (example at the end of the pa
1818
* [A note on threads and concurrency](#A-note-on-threads-and-concurrency)
1919
* [A note on names and conventions](#Names-and-output-convention)
2020
* [Hex representation of the output](#Hex-represantaion-of-the-output)
21+
* [Using Lua for customized scan scenario](#Using-Lua-for-customized-scan-scenario)
22+
* [Running bulkDNS in server mode](#Running-bulkDNS-in-server-mode)
2123
* [FAQ](#FAQ)
2224

2325

@@ -79,7 +81,7 @@ make with-lua
7981
The compiled output is inside the `bin` directory.
8082

8183
In case the `pkg-config` commands gives you a different output for Lua headers and library locations, then
82-
you must specify the values in the make file like this:
84+
you must specify the values when running `make` command like this:
8385

8486
```bash
8587
make LUALIB=<your-lua-lib-name> LUAINCDIR=<your-path-to-lua-include-dir> with-lua
@@ -203,7 +205,7 @@ We try to keep the output as close as possible to DNS RFC standards.
203205
scan the whole domain name system in less than one day.
204206
This makes it probably the most practical (and maybe fastest) DNS scanner. It does not have any requirements in terms of CPU or RAM. As all other network scanners,
205207
the bottleneck is always the network bandwidth, firewalls and the remote recursive resolver. We recommend using Cloudflare quad one (1.1.1.1) as the resolver since
206-
it has no limit in terms of the number of queries. However, you can also run your own recursive resolver to do the job. If you decrease the number of threads, you can
208+
it has no limit in terms of the number of queries. However, you can also run your own recursive resolver to do the job. If you decrease the concurrency, you can
207209
also use google quad-eight (8.8.8.8) which has 1,500 queries/second limit.
208210

209211
* Using `--concurrency` option, you can increase or decrease the number of concurrent requests based on your network and your experience. It's important to note that if you set `--concurrency=1000`, it means you ask for openning 1,000
@@ -258,6 +260,19 @@ answer
258260

259261
In the above example the `cpu` is the hex represantation of `some-kinda-cpu` and os is the hex represantation of `some-kinda-os`.
260262

263+
### Using Lua for customized scan scenario
264+
265+
Using bulkDNS, you can write your own modules to perform any type of scan. The [modules](./modules) directory contains
266+
a tutorial on how to create a custom scan module along with several examples. To use this feature, you must compile bulkDNS
267+
with Lua library.
268+
269+
### Running bulkDNS in server mode
270+
271+
bulkDNS is not just a scanner. You can also run it in server mode by passing `--server-mode` switch.
272+
If you want to run bulkDNS in server mode, you must compile it with Lua library.
273+
In the server mode, bulkDNS acts like a DNS server. A complete tutorial provided in [modules](./modules) directory
274+
along with examples.
275+
261276

262277
### FAQ
263278
1. Why another scanner?
@@ -266,7 +281,7 @@ In the above example the `cpu` is the hex represantation of `some-kinda-cpu` and
266281
- I don't know CMake
267282
2. Is there any similar project like this?
268283
- The only comparable project to this one (that I'm aware of) is zmap/zdns.
269-
3. Can I pass a domain name (e.g., `ns1.google.com` as the resolver)?
284+
3. Can I pass a domain name (e.g., `ns1.google.com`) as the resolver?
270285
- No. The resolver must be an IPv4 address. We pass this value to `inet_addr()` function which accepts an IPv4.
271286
4. How fast it can scan domain names?
272287
- It highly depends on your network and the (remote) resolver you use.

0 commit comments

Comments
 (0)