Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
j-baines authored Jul 17, 2024
1 parent b8b5281 commit 7f7ef5b
Showing 1 changed file with 21 additions and 4 deletions.
25 changes: 21 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
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
```

0 comments on commit 7f7ef5b

Please sign in to comment.