# README
ZGrab 2.0
NETSCOUT NOTES:
This repository is a direct clone of a 3rd party vendor.
No changes should ever be made on vendor branches to allow us to stay in sync withhttps://github.com/zmap/zgrab2.
NETSCOUT development changes should be worked on a branch based from 'netscout-master' and merged into the 'netscout-master' branch.
This repo contains the new ZGrab framework, and will eventually replace https://github.com/zmap/zgrab.
Building
You will need to have a valid $GOPATH set up, for more information about $GOPATH, see https://golang.org/doc/code.html.
Once you have a working $GOPATH, run:
$ go get github.com/packetloop/zgrab2
This will install zgrab under $GOPATH/src/github.com/packetloop/zgrab2
$ cd $GOPATH/src/github.com/packetloop/zgrab2
$ make
Single Module Usage
ZGrab2 supports modules. For example, to run the ssh module use
./zgrab2 ssh
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 three fields:
IP, DOMAIN, TAG
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.
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:
10.0.0.1
domain.com
10.0.0.1, domain.com
10.0.0.1, domain.com, tag
10.0.0.1, , tag
, domain.com, tag
192.168.0.0/24, , tag
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
[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
./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:
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:
[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.
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 schemas/__init__.py to ensure that it is loaded.
See schemas/README.md for details.
Integration tests
To add integration tests for the new module, run integration_tests/new.sh [your_new_protocol_name].
This will add stub shell scripts in integration_tests/your_new_protocol_name; update these as needed.
See 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 installed. Then, you can follow the following steps to run integration tests:
$ go get github.com/jmespath/jp && go build github.com/jmespath/jp
$ pip install --user zschema
$ 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:
$ echo $?
0
License
ZGrab2.0 is licensed under Apache 2.0 and ISC. For more information, see the LICENSE file.