diff --git a/README.md b/README.md index 7f81f0e..13acdf1 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,17 @@ # drone-shodan +Provided a newline delimited file containing cidr netblocks or ip addresses, this drone uses shodan's 'net' and 'host' search operators to identify and import available services into lair. Requests are made to shodan concurrently using a pool of 10 goroutines. -Provided a newline delimited file containing cidr netblocks or ip -addresses, this drone uses shodan's 'net' and 'host' search operators to identify and import available -services into lair. Requests are made to shodan concurrently using a pool of 10 goroutines. +## Install +Download a compiled binary for supported operating systems from [here](https://github.com/lair-framework/drone-shodan/releases/latest). + +``` +$ mv drone-shodan* drone-shodan +$ ./drone-shodan -h +``` + + +## Shodan API Key +This drone requires a shodan API key. The key is provided using an environment variable. +``` +$ export SHODAN_KEY='yourkeygoeshere' +``` diff --git a/main.go b/main.go index 6193c5a..52ddeda 100644 --- a/main.go +++ b/main.go @@ -24,8 +24,8 @@ const ( tool = "shodan" osWeight = 50 usage = ` -Provided a file containing a new line delimited file containing cidr netblocks or ip -addresses, this drone uses shodan's 'net' and 'host' search to identify and import available +Provided a newline delimited file containing cidr netblocks or ip +addresses, this drone uses shodan's 'net' and 'host' search operators to identify and import available services into lair. Requests are made to shodan concurrently using a pool of 10 goroutines. Usage: