Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/zmap/zgrab2

Fast Application Layer Scanner
https://github.com/zmap/zgrab2

internet-scanning network-scanner

Last synced: about 1 month ago
JSON representation

Fast Application Layer Scanner

Awesome Lists containing this project

README 

        
ZGrab 2.0

=========



ZGrab is a fast, modular application-layer network scanner designed for completing large Internet-wide surveys. ZGrab is built to work with ZMap (ZMap identifies L4 responsive hosts, ZGrab performs in-depth, follow-up L7 handshakes). Unlike many other network scanners, ZGrab outputs detailed transcripts of network handshakes (e.g., all messages exchanged in a TLS handshake) for offline analysis.  



ZGrab 2.0 contains a new, modular ZGrab framework, which fully supersedes https://github.com/zmap/zgrab.



## Installation



### With Docker



You can run ZGrab 2.0 with our official Docker image. For example, to scan a single website using the HTTP module, you can use:



```shell

echo 'example.com' | docker run --rm -i ghcr.io/zmap/zgrab2 http

```



For more complex scanning scenarios, such as using multiple modules or custom configurations, you can create a configuration file and pass it to the container:



```shell

docker run --rm -i -v /path/to/your/config.ini:/config.ini ghcr.io/zmap/zgrab2 multiple -c /config.ini

```



Replace `/path/to/your/config.ini` with the path to your configuration file on the host machine. See [Multiple Module Usage](#multiple-module-usage) for more details on configurations.



### Building from Source



ZGrab2 requires Go 1.23 or later to build from source.



```shell

git clone https://github.com/zmap/zgrab2.git

cd zgrab2

make

./zgrab2 http --help # to see the http module's help message

```



Starting in Go 1.21, Go added [support](https://go.dev/doc/toolchain) for auto-downloading the appropriate toolchain for building a given module.



This will let you build ZGrab2 using Go 1.21.X or 1.22.X without needing to manually install another version.



```shell

go version

$ go version go1.21.13 linux/arm64



export GOTOOLCHAIN=auto

git clone https://github.com/zmap/zgrab2.git

cd zgrab2

make # Go will download the required 1.23 toolchain automatically

./zgrab2 http --help # to see the http module's help message

```



## Single Module Usage 



ZGrab2 supports modules. For example, to run the ssh module use



```shell

./zgrab2 ssh

```



To retrieve detailed command-line usage and options for a specific module, append `-h` to the command:



```bash

./zgrab2 [module] -h

```



This will display the module-specific options, as well as the application-wide options, including usage examples, available flags, and descriptions for each option. 



Module specific options must be included after the module. Application specific options can be specified at any time.



## Input Format



Targets are specified with input files or from `stdin`, in CSV format.  Each input line has up to four fields:



```text

IP, DOMAIN, TAG, PORT

```



Each line must specify `IP`, `DOMAIN`, or both.  If only `DOMAIN` is provided, scanners perform a DNS hostname lookup to determine the IP address.  If both `IP` and `DOMAIN` are provided, scanners connect to `IP` but use `DOMAIN` in protocol-specific contexts, such as the HTTP HOST header and TLS SNI extension.



If the `IP` field contains a CIDR block, the framework will expand it to one target for each IP address in the block.



The `TAG` field is optional and used with the `--trigger` scanner argument. The `PORT` field is also optional, and acts

as a per-line override for the `-p`/`--port` option.



Unused fields can be blank, and trailing unused fields can be omitted entirely.  For backwards compatibility, the parser allows lines with only one field to contain `DOMAIN`.



These are examples of valid input lines:



```text

10.0.0.1

domain.com

10.0.0.1, domain.com

10.0.0.1, domain.com, tag

10.0.0.1, domain.com, tag, 1234

10.0.0.1, , tag

10.0.0.1, , , 5678

, domain.com, tag

192.168.0.0/24, , tag

```



And an example of calling zgrab2 with input:



```shell

echo "en.wikipedia.org" | ./zgrab2 http --max-redirects=1 --endpoint="/wiki/New_York_City"

```



## Multiple Module Usage



To run a scan with multiple modules, a `.ini` file must be used with the `multiple` module. Below is an example `.ini` file with the corresponding zgrab2 command. 



***multiple.ini***

```ini

[Application Options]

output-file="output.txt"

input-file="input.txt"

[http]

name="http80"

port=80

endpoint="/"

[http]

name="http8080"

port=8080

endpoint="/"

[ssh]

port=22

```

```shell

./zgrab2 multiple -c multiple.ini

```

`Application Options` must be the initial section name. Other section names should correspond exactly to the relevant zgrab2 module name. The default name for each module is the command name. If the same module is to be used multiple times then `name` must be specified and unique. 



Multiple module support is particularly powerful when combined with input tags and the `--trigger` scanner argument. For example, this input contains targets with two different tags:



```text

141.212.113.199, , tagA

216.239.38.21, censys.io, tagB

```



Invoking zgrab2 with the following `multiple` configuration will perform an SSH grab on the first target above and an HTTP grab on the second target:



```ini

[ssh]

trigger="tagA"

name="ssh22"

port=22



[http]

trigger="tagB"

name="http80"

port=80

```



## Adding New Protocols 



Add module to modules/ that satisfies the following interfaces: `Scanner`, `ScanModule`, `ScanFlags`.



The flags struct must embed zgrab2.BaseFlags. In the modules `init()` function the following must be included. 



```go

func init() {

    var newModule NewModule

    _, err := zgrab2.AddCommand("module", "short description", "long description of module", portNumber, &newModule)

    if err != nil {

        log.Fatal(err)

    }

}

```



### Output schema



To add a schema for the new module, add a module under schemas, and update [`zgrab2_schemas/zgrab2/__init__.py`](zgrab2_schemas/zgrab2/__init__.py) to ensure that it is loaded.



See [zgrab2_schemas/README.md](zgrab2_schemas/README.md) for details.



### Integration tests

To add integration tests for the new module, you'll need to add a test service to scan against to `integration_tests/docker-compose.yml` and a `test.sh` in a folder named after your module.

Follow the examples in `integration_tests/.template` to create the necessary files.

See [integration_tests/mysql/*](integration_tests/mysql) for an example.

The only hard requirement is that the `test.sh` script drops its output in `$ZGRAB_OUTPUT/[your-module]/*.json`, so that it can be validated against the schema.



#### How to Run Integration Tests



To run integration tests, you must have [Docker](https://www.docker.com/) and **Python 3** on host installed. Then, you can follow the following steps to run integration tests:



```shell

# Install Python dependencies

sudo apt update

sudo apt install -y python3 jp python3-pip

python3 -m venv venv

source venv/bin/activate

# Install Python dependencies

pip install zschema

pip install -r requirements.txt

make integration-test-clean; make integration-test

```



Running the integration tests will generate quite a bit of debug output. To ensure that tests completed successfully, you can check for a successful exit code after the tests complete:



```shell

echo $?

0

```



To just run a single/few module's integration tests, you can use the `TEST_MODULES` env. var.:



```shell

make integration-test-clean; TEST_MODULES="http" make integration-test

make integration-test-clean; TEST_MODULES="http ssh" make integration-test

```



Refer to our [Github Actions workflow](.github/workflows/integration-test.yml) for an example of how to prepare environment for integration tests.



## License

ZGrab2.0 is licensed under Apache 2.0 and ISC. For more information, see the LICENSE file.