From e6c519f00446899c6372565d49f626ba816e5363 Mon Sep 17 00:00:00 2001 From: Sven Strittmatter Date: Mon, 20 May 2024 01:47:48 +0200 Subject: [PATCH] Fix build instructions (#383) * Removes leading $ from command line examples If you use the copy & paste feature from GH's rendered README.md this $ sign is also copied and needs to be removed when pasted into a shell. Removing the $ makes it possible to paste the command w/o manual edit. Signed-off-by: Sven Strittmatter * Adds style name to fenced code to improve Markdown rendering Signed-off-by: Sven Strittmatter * Updates the build instruction due to error The documented way to build seems to be outdated: ``` go get github.com/zmap/zgrab2 go: go.mod file not found in current directory or any parent directory. 'go get' is no longer supported outside a module. To build and install a command, use 'go install' with a version, like 'go install example.com/cmd@latest' For more information, see https://golang.org/doc/go-get-install-deprecation or run 'go help get' or 'go help install'. ``` What works for me: Clone the repo and simply run `make` inside the repo to build the binary. Signed-off-by: Sven Strittmatter * Update README.md --------- Signed-off-by: Sven Strittmatter Co-authored-by: Raymond Nook <59678453+developStorm@users.noreply.github.com> --- README.md | 50 +++++++++++++++++++++++++------------------------- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index bf568c63..049eb759 100644 --- a/README.md +++ b/README.md @@ -5,16 +5,16 @@ ZGrab is a fast, modular application-layer network scanner designed for completi ZGrab 2.0 contains a new, modular ZGrab framework, which fully supersedes https://github.com/zmap/zgrab. + ## Building For Go 1.17 and later you must build from source: -``` -$ git clone https://github.com/zmap/zgrab2.git -$ cd zgrab2 -$ go build -$ make -$ ./zgrab2 +```shell +git clone https://github.com/zmap/zgrab2.git +cd zgrab2 +make +./zgrab2 ``` @@ -24,22 +24,22 @@ You will need to have a valid `$GOPATH` set up, for more information about `$GOP Once you have a working `$GOPATH`, run: -``` -$ go get github.com/zmap/zgrab2 +```shell +go get github.com/zmap/zgrab2 ``` This will install zgrab under `$GOPATH/src/github.com/zmap/zgrab2` -``` -$ cd $GOPATH/src/github.com/zmap/zgrab2 -$ make +```shell +cd $GOPATH/src/github.com/zmap/zgrab2 +make ``` ## Single Module Usage ZGrab2 supports modules. For example, to run the ssh module use -```bash +```shell ./zgrab2 ssh ``` @@ -57,7 +57,7 @@ Module specific options must be included after the module. Application specific Targets are specified with input files or from `stdin`, in CSV format. Each input line has three fields: -``` +```text IP, DOMAIN, TAG ``` @@ -71,7 +71,7 @@ Unused fields can be blank, and trailing unused fields can be omitted entirely. These are examples of valid input lines: -``` +```text 10.0.0.1 domain.com 10.0.0.1, domain.com @@ -87,7 +87,7 @@ domain.com 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" @@ -102,21 +102,21 @@ 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" @@ -134,7 +134,7 @@ Add module to modules/ that satisfies the following interfaces: `Scanner`, `Scan 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) @@ -160,16 +160,16 @@ The only hard requirement is that the `test.sh` script drops its output in `$ZGR To run integration tests, you must have [Docker](https://www.docker.com/) 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 +```shell +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 $? +```shell +echo $? 0 ```