From 7f7ef5b7da7696ddb91d6a74dccf7d38fdf3b34c Mon Sep 17 00:00:00 2001 From: Jacob Baines <113205286+j-baines@users.noreply.github.com> Date: Wed, 17 Jul 2024 13:44:02 -0400 Subject: [PATCH] Update README.md --- README.md | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 69cca7d..80cd87b 100644 --- a/README.md +++ b/README.md @@ -34,16 +34,33 @@ time=2024-07-16T16:33:07.243-04:00 level=STATUS msg="The target appears to be a ## Currently Supported Inputs -go-exploit-cache currently supports Shodan download files (.json.gz) and PCAP files. Usage examples: +go-exploit-cache currently supports Shodan download files (.json.gz) and PCAP files. ### Shodan GZIP Usage Example: +A sample file can be found in the `test/testdata` directory: + ```console -./build/go-exploit-cache -type shodan-gzip -in file.json.gz -out vc.db +albinolobster@mournland:~/go-exploit-cache$ ./build/go-exploit-cache -type shodan-gzip -in ./test/testdata/shodan-confluence.json.gz -out confluence.db +2024/07/17 13:43:01 Decompressing the Shodan GZIP... this can be slow +2024/07/17 13:43:01 Decompressed file written to .tmp/shodan.json +2024/07/17 13:43:01 Generating database entries ``` ### PCAP Usage Example: ```console -./build/go-exploit-cache -type pcap -in file.pcap -out vc.db -``` \ No newline at end of file +albinolobster@mournland:~/go-exploit-cache$ ./build/go-exploit-cache -type pcap -in ./test/testdata/confluence-exploit.pcapng -out confluence.db +2024/07/17 13:43:41 Locating all HTTP requests... +2024/07/17 13:43:41 Locating all HTTP responses... +2024/07/17 13:43:41 Generating database entries... +``` + +## Compiling + +go-exploit-cache can be compiled on Ubuntu like so (assuming [Go](https://go.dev/doc/install) is installed): + +```console +sudo apt install libpcap-dev +make +```