ronin-recon 0.1.0.rc1

data/man/ronin-recon-new.1

@@ -0,0 +1,58 @@
+.\" Generated by kramdown-man 1.0.1
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-recon-new 1 "May 2022" Ronin "User Manuals"
+.SH NAME
+.PP
+ronin\-recon\-new \- Creates a new recon worker file
+.SH SYNOPSIS
+.PP
+\fBronin\-recon new\fR \[lB]\fIoptions\fP\[rB] \fIPATH\fP
+.SH DESCRIPTION
+.PP
+Generates a new recon worker file\.
+.SH ARGUMENTS
+.TP
+\fIPATH\fP
+The path to the new recon worker file to generate\.
+.SH OPTIONS
+.TP
+\fB\-t\fR, \fB\-\-type\fR \fBworker\fR\[or]\fBdns\fR\[or]\fBweb\fR
+The type of recon worker to generate\.
+.TP
+\fB\-a\fR, \fB\-\-author\fR \fINAME\fP
+The name of the author\. Defaults to the configured git author name or the
+\fBUSERNAME\fR environment variable\.
+.TP
+\fB\-e\fR, \fB\-\-author\-email\fR \fIEMAIL\fP
+The email address of the author\. Defaults to the configured git author email\.
+.TP
+\fB\-S\fR, \fB\-\-summary\fR \fITEXT\fP
+The summary text for the new recon worker\.
+.TP
+\fB\-D\fR, \fB\-\-description\fR \fITEXT\fP
+The description text for the new recon worker\.
+.TP
+\fB\-R\fR, \fB\-\-reference\fR \fIURL\fP
+Adds a reference URL to the new recon worker\.
+.TP
+\fB\-A\fR, \fB\-\-accepts\fR \fBcert\fR\[or]\fBdomain\[or]email\[ru]address\[or]host\[or]ip\[ru]range\[or]ip\[or]mailserver\[or]nameserver\[or]open\[ru]port\[or]url\[or]website\[or]wildcard\fR
+The value type(s) that the recon worker accepts\.
+.TP
+\fB\-O\fR, \fB\-\-outputs\fR \fBcert\fR\[or]\fBdomain\[or]email\[ru]address\[or]host\[or]ip\[ru]range\[or]ip\[or]mailserver\[or]nameserver\[or]open\[ru]port\[or]url\[or]website\[or]wildcard\fR
+The value type(s) that the recon worker outputs\.
+.TP
+\fB\-I\fR, \fB\-\-intensity\fR \fBpassive\fR\[or]\fBactive\fR\[or]\fBaggressive\fR
+The intensity of the recon worker\.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print help information
+.SH AUTHOR
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME
+.SH SEE ALSO
+.PP
+.BR ronin\-payloads\-workers (1)
+.BR ronin\-payloads\-worker (1)
+.BR ronin\-payloads\-test (1)

data/man/ronin-recon-new.1.md

@@ -0,0 +1,59 @@
+# ronin-recon-new 1 "May 2022" Ronin "User Manuals"
+
+## NAME
+
+ronin-recon-new - Creates a new recon worker file
+
+## SYNOPSIS
+
+`ronin-recon new` [*options*] *PATH*
+
+## DESCRIPTION
+
+Generates a new recon worker file.
+
+## ARGUMENTS
+
+*PATH*
+: The path to the new recon worker file to generate.
+
+## OPTIONS
+
+`-t`, `--type` `worker`\|`dns`\|`web`
+: The type of recon worker to generate.
+
+`-a`, `--author` *NAME*
+: The name of the author. Defaults to the configured git author name or the
+  `USERNAME` environment variable.
+
+`-e`, `--author-email` *EMAIL*
+: The email address of the author. Defaults to the configured git author email.
+
+`-S`, `--summary` *TEXT*
+: The summary text for the new recon worker.
+
+`-D`, `--description` *TEXT*
+: The description text for the new recon worker.
+
+`-R`, `--reference` *URL*
+: Adds a reference URL to the new recon worker.
+
+`-A`, `--accepts` `cert`\|`domain|email_address|host|ip_range|ip|mailserver|nameserver|open_port|url|website|wildcard`
+: The value type(s) that the recon worker accepts.
+
+`-O`, `--outputs` `cert`\|`domain|email_address|host|ip_range|ip|mailserver|nameserver|open_port|url|website|wildcard`
+: The value type(s) that the recon worker outputs.
+
+`-I`, `--intensity` `passive`\|`active`\|`aggressive`
+: The intensity of the recon worker.
+
+`-h`, `--help`
+: Print help information
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+[ronin-payloads-workers](ronin-payloads-workers.1.md) [ronin-payloads-worker](ronin-payloads-worker.1.md) [ronin-payloads-test](ronin-payloads-test.1.md)

data/man/ronin-recon-run.1

@@ -0,0 +1,137 @@
+.\" Generated by kramdown-man 1.0.1
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-recon-test 1 "2023-05-01" Ronin "User Manuals"
+.SH NAME
+.PP
+ronin\-recon\-run \- Runs the recon engine with one or more initial values
+.SH SYNOPSIS
+.PP
+\fBronin\-recon run\fR \[lB]\fIoptions\fP\[rB] \[lC]\fIIP\fP \[or] \fIIP\-range\fP \[or] \fIDOMAIN\fP \[or] \fIHOST\fP \[or] \fIWILDCARD\fP \[or] \fIWEBSITE\fP\[rC] \.\.\.
+.SH DESCRIPTION
+.PP
+Runs the recon engine with one or more initial values\.
+.SH ARGUMENTS
+.TP
+\fIIP\fP
+An IP address to recon (ex: \fB192\.168\.1\.1\fR)\.
+.TP
+\fIIP\-range\fP
+A CIDR IP range to recon (ex: \fB192\.168\.1\.0\[sl]24\fR)\.
+.TP
+\fIDOMAIN\fP
+A top\-level domain name to recon (ex: \fBexample\.com\fR)\.
+.TP
+\fIHOST\fP
+A sub\-domain to recon (ex: \fBwww\.example\.com\fR)\.
+.TP
+\fIWILDCARD\fP
+A wildcard host name (ex: \fB*\.example\.com\fR)\.
+.TP
+\fIWEBSITE\fP
+A website base URL to recon (ex: \fBhttps:\[sl]\[sl]example\.com\fR)\.
+.SH OPTIONS
+.TP
+\fB\-D\fR, \fB\-\-debug\fR
+Enables debugging output\.
+.TP
+\fB\-C\fR, \fB\-\-config\-file\fR \fIFILE\fP
+Loads the \fBronin\-recon\fR configuration file\. If not specified, then
+\fB\[ti]\[sl]\.config\[sl]ronin\-recon\[sl]config\.yml\fR will be loaded instead\.
+.TP
+\fB\-w\fR, \fB\-\-worker\fR \fIWORKER\fP
+Explicitly uses the specified worker instead of the default set of workers\.
+.TP
+\fB\-e\fR, \fB\-\-enable\fR \fIWORKER\fP
+Enables the worker in addition to the default set of workers\.
+.TP
+\fB\-d\fR, \fB\-\-disable\fR \fIWORKER\fP
+Disables the worker from the default set of workers\.
+.TP
+\fB\-\-worker\-file\fR \fIFILE\fP
+Loads a custom worker from the specified \fB\.rb\fR file\.
+.TP
+\fB\-p\fR, \fB\-\-param\fR \fIWORKER\fP\fB\.\fR\fINAME\fP\fB\[eq]\fR\fIVALUE\fP
+Sets a param value for the given worker\.
+.TP
+\fB\-c\fR, \fB\-\-concurrency\fR \fIWORKER\fP\fB\[eq]\fR\fINUM\fP
+Overrides the concurrency for the given worker\.
+.TP
+\fB\-\-max\-depth\fR \fINUM\fP
+The maximum recon depth\. Defaults to depth of \fB3\fR if the option is not
+specified\.
+.TP
+\fB\-o\fR, \fB\-\-output\fR \fIFILE\fP
+The output file to write results to\.
+.TP
+\fB\-F\fR, \fB\-\-output\-format\fR \fBtxt\fR\[or]\fBlist\fR\[or]\fBcsv\fR\[or]\fBjson\fR\[or]\fBndjson\fR\[or]\fBdot\fR\[or]\fBsvg\fR\[or]\fBpng\fR\[or]\fBpdf\fR
+The output format\. If not specified, the output format will be inferred from
+the \fB\-\-output\fR \fIFILE\fP extension\.
+.TP
+\fB\-\-import\fR
+Imports each newly discovered value into the Ronin database\.
+.TP
+\fB\-I\fR, \fB\-\-ignore\fR \fIVALUE\fP
+The value to ignore from the result\.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print help information
+.SH EXAMPLES
+.PP
+Run the recon engine on a single domain:
+.PP
+.RS 4
+.EX
+\[Do] ronin\-recon run example\.com
+.EE
+.RE
+.PP
+Run the recon engine on a single host\-name:
+.PP
+.RS 4
+.EX
+\[Do] ronin\-recon run www\.example\.com
+.EE
+.RE
+.PP
+Run the recon engine on a single IP address:
+.PP
+.RS 4
+.EX
+\[Do] ronin\-recon run 1\.1\.1\.1
+.EE
+.RE
+.PP
+Run the recon engine on an IP range:
+.PP
+.RS 4
+.EX
+\[Do] ronin\-recon run 1\.1\.1\.1\[sl]24
+.EE
+.RE
+.PP
+Run the recon engine on multiple targets:
+.PP
+.RS 4
+.EX
+\[Do] ronin\-recon run example1\.com example2\.com secret\.foo\.example1\.com \e
+                  secret\.bar\.example2\.com 1\.1\.1\.1\[sl]24
+.EE
+.RE
+.PP
+Run the recon engine and ignore specific hosts, IPs, URLs, etc\.:
+.PP
+.RS 4
+.EX
+\[Do] ronin\-recon run \-\-ignore staging\.example\.com example\.com
+.EE
+.RE
+.SH AUTHOR
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME
+.SH SEE ALSO
+.PP
+.BR ronin\-recon\-workers (1)
+.BR ronin\-recon\-worker (1)
+.BR ronin\-recon\-test (1)

data/man/ronin-recon-run.1.md

@@ -0,0 +1,115 @@
+# ronin-recon-test 1 "2023-05-01" Ronin "User Manuals"
+
+## NAME
+
+ronin-recon-run - Runs the recon engine with one or more initial values
+
+## SYNOPSIS
+
+`ronin-recon run` [*options*] {*IP* \| *IP-range* \| *DOMAIN* \| *HOST* \| *WILDCARD* \| *WEBSITE*} ... 
+
+## DESCRIPTION
+
+Runs the recon engine with one or more initial values.
+
+## ARGUMENTS
+
+*IP*
+: An IP address to recon (ex: `192.168.1.1`).
+
+*IP-range*
+: A CIDR IP range to recon (ex: `192.168.1.0/24`).
+
+*DOMAIN*
+: A top-level domain name to recon (ex: `example.com`).
+
+*HOST*
+: A sub-domain to recon (ex: `www.example.com`).
+
+*WILDCARD*
+: A wildcard host name (ex: `*.example.com`).
+
+*WEBSITE*
+: A website base URL to recon (ex: `https://example.com`).
+
+## OPTIONS
+
+`-D`, `--debug`
+: Enables debugging output.
+
+`-C`, `--config-file` *FILE*
+: Loads the `ronin-recon` configuration file. If not specified, then
+  `~/.config/ronin-recon/config.yml` will be loaded instead.
+
+`-w`, `--worker` *WORKER*
+: Explicitly uses the specified worker instead of the default set of workers.
+
+`-e`, `--enable` *WORKER*
+: Enables the worker in addition to the default set of workers.
+
+`-d`, `--disable` *WORKER*
+: Disables the worker from the default set of workers.
+
+`--worker-file` *FILE*
+: Loads a custom worker from the specified `.rb` file.
+
+`-p`, `--param` *WORKER*`.`*NAME*`=`*VALUE*
+: Sets a param value for the given worker.
+
+`-c`, `--concurrency` *WORKER*`=`*NUM*
+: Overrides the concurrency for the given worker.
+
+`--max-depth` *NUM*
+: The maximum recon depth. Defaults to depth of `3` if the option is not
+  specified.
+
+`-o`, `--output` *FILE*
+: The output file to write results to.
+
+`-F`, `--output-format` `txt`\|`list`\|`csv`\|`json`\|`ndjson`\|`dot`\|`svg`\|`png`\|`pdf`
+: The output format. If not specified, the output format will be inferred from
+  the `--output` *FILE* extension.
+
+`--import`
+: Imports each newly discovered value into the Ronin database.
+
+`-I`, `--ignore` *VALUE*
+: The value to ignore from the result.
+
+`-h`, `--help`
+: Print help information
+
+## EXAMPLES
+
+Run the recon engine on a single domain:
+
+    $ ronin-recon run example.com
+
+Run the recon engine on a single host-name:
+
+    $ ronin-recon run www.example.com
+
+Run the recon engine on a single IP address:
+
+    $ ronin-recon run 1.1.1.1
+
+Run the recon engine on an IP range:
+
+    $ ronin-recon run 1.1.1.1/24
+
+Run the recon engine on multiple targets:
+
+    $ ronin-recon run example1.com example2.com secret.foo.example1.com \
+                      secret.bar.example2.com 1.1.1.1/24
+
+Run the recon engine and ignore specific hosts, IPs, URLs, etc.:
+
+    $ ronin-recon run --ignore staging.example.com example.com
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+[ronin-recon-workers](ronin-recon-workers.1.md) [ronin-recon-worker](ronin-recon-worker.1.md) [ronin-recon-test](ronin-recon-test.1.md)

data/man/ronin-recon-test.1

@@ -0,0 +1,53 @@
+.\" Generated by kramdown-man 1.0.1
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-recon-test 1 "2023-05-01" Ronin "User Manuals"
+.SH NAME
+.PP
+ronin\-recon\-test \- Loads an individual worker and tests it
+.SH SYNOPSIS
+.PP
+\fBronin\-recon test\fR \[lB]\fIoptions\fP\[rB] \[lC]\fB\-\-file\fR \fIFILE\fP \[or] \fINAME\fP\[rC] \[lC]\fIIP\fP \[or] \fIIP\-range\fP \[or] \fIDOMAIN\fP \[or] \fIHOST\fP \[or] \fIWILDCARD\fP \[or] \fIWEBSITE\fP\[rC]
+.SH DESCRIPTION
+.PP
+Loads an individual worker and tests it with an input value\.\.
+.SH ARGUMENTS
+.TP
+\fINAME\fP
+The name of the recon worker to load\.
+.TP
+\fIIP\fP
+An IP address to recon (ex: \fB192\.168\.1\.1\fR)\.
+.TP
+\fIIP\-range\fP
+A CIDR IP range to recon (ex: \fB192\.168\.1\.0\[sl]24\fR)\.
+.TP
+\fIDOMAIN\fP
+A top\-level domain name to recon (ex: \fBexample\.com\fR)\.
+.TP
+\fIHOST\fP
+A sub\-domain to recon (ex: \fBwww\.example\.com\fR)\.
+.TP
+\fIWILDCARD\fP
+A wildcard host name (ex: \fB*\.example\.com\fR)\.
+.TP
+\fIWEBSITE\fP
+A website base URL to recon (ex: \fBhttps:\[sl]\[sl]example\.com\fR)\.
+.SH OPTIONS
+.TP
+\fB\-f\fR, \fB\-\-file\fR \fIFILE\fP
+Optionally loads the recon worker from the file\.
+.TP
+\fB\-D\fR, \fB\-\-debug\fR
+Enables debugging output\.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print help information
+.SH AUTHOR
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME
+.SH SEE ALSO
+.PP
+.BR ronin\-recon\-workers (1)
+.BR ronin\-recon\-run (1)

data/man/ronin-recon-test.1.md

@@ -0,0 +1,55 @@
+# ronin-recon-test 1 "2023-05-01" Ronin "User Manuals"
+
+## NAME
+
+ronin-recon-test - Loads an individual worker and tests it
+
+## SYNOPSIS
+
+`ronin-recon test` [*options*] {`--file` *FILE* \| *NAME*} {*IP* \| *IP-range* \| *DOMAIN* \| *HOST* \| *WILDCARD* \| *WEBSITE*}
+
+## DESCRIPTION
+
+Loads an individual worker and tests it with an input value..
+
+## ARGUMENTS
+
+*NAME*
+: The name of the recon worker to load.
+
+*IP*
+: An IP address to recon (ex: `192.168.1.1`).
+
+*IP-range*
+: A CIDR IP range to recon (ex: `192.168.1.0/24`).
+
+*DOMAIN*
+: A top-level domain name to recon (ex: `example.com`).
+
+*HOST*
+: A sub-domain to recon (ex: `www.example.com`).
+
+*WILDCARD*
+: A wildcard host name (ex: `*.example.com`).
+
+*WEBSITE*
+: A website base URL to recon (ex: `https://example.com`).
+
+## OPTIONS
+
+`-f`, `--file` *FILE*
+: Optionally loads the recon worker from the file.
+
+`-D`, `--debug`
+: Enables debugging output.
+
+`-h`, `--help`
+: Print help information
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+[ronin-recon-workers](ronin-recon-workers.1.md) [ronin-recon-run](ronin-recon-run.1.md)

data/man/ronin-recon-worker.1

@@ -0,0 +1,32 @@
+.\" Generated by kramdown-man 1.0.1
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-recon-worker 1 "2023-05-01" Ronin "User Manuals"
+.SH NAME
+.PP
+ronin\-recon\-worker \- Prints information about a recon worker
+.SH SYNOPSIS
+.PP
+\fBronin\-recon worker\fR \[lB]\fIoptions\fP\[rB] \[lC]\fB\-\-file\fR \fIFILE\fP \[or] \fINAME\fP\[rC]
+.SH DESCRIPTION
+.PP
+Prints information about a recon worker\.
+.SH ARGUMENTS
+.TP
+\fINAME\fP
+The name of the recon worker to load\.
+.SH OPTIONS
+.TP
+\fB\-f\fR, \fB\-\-file\fR \fIFILE\fP
+Optionally loads the recon worker from the file\.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print help information
+.SH AUTHOR
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME
+.SH SEE ALSO
+.PP
+.BR ronin\-recon\-workers (1)
+.BR ronin\-recon\-run (1)

data/man/ronin-recon-worker.1.md

@@ -0,0 +1,34 @@
+# ronin-recon-worker 1 "2023-05-01" Ronin "User Manuals"
+
+## NAME
+
+ronin-recon-worker - Prints information about a recon worker
+
+## SYNOPSIS
+
+`ronin-recon worker` [*options*] {`--file` *FILE* \| *NAME*}
+
+## DESCRIPTION
+
+Prints information about a recon worker.
+
+## ARGUMENTS
+
+*NAME*
+: The name of the recon worker to load.
+
+## OPTIONS
+
+`-f`, `--file` *FILE*
+: Optionally loads the recon worker from the file.
+
+`-h`, `--help`
+: Print help information
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+[ronin-recon-workers](ronin-recon-workers.1.md) [ronin-recon-run](ronin-recon-run.1.md)

data/man/ronin-recon-workers.1

@@ -0,0 +1,29 @@
+.\" Generated by kramdown-man 1.0.1
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-recon-workers 1 "2023-05-01" Ronin "User Manuals"
+.SH NAME
+.PP
+ronin\-recon\-workers \- Lists the available recon workers
+.SH SYNOPSIS
+.PP
+\fBronin\-recon workers\fR \[lB]\fIoptions\fP\[rB] \fIDIR\fP
+.SH DESCRIPTION
+.PP
+Lists available recon workers\.
+.SH ARGUMENTS
+.TP
+\fIDIR\fP
+The optional directory to list workers from\.
+.SH OPTIONS
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print help information
+.SH AUTHOR
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME
+.SH SEE ALSO
+.PP
+.BR ronin\-recon\-worker (1)
+.BR ronin\-recon\-run (1)

data/man/ronin-recon-workers.1.md

@@ -0,0 +1,31 @@
+# ronin-recon-workers 1 "2023-05-01" Ronin "User Manuals"
+
+## NAME
+
+ronin-recon-workers - Lists the available recon workers
+
+## SYNOPSIS
+
+`ronin-recon workers` [*options*] *DIR*
+
+## DESCRIPTION
+
+Lists available recon workers.
+
+## ARGUMENTS
+
+*DIR*
+: The optional directory to list workers from.
+
+## OPTIONS
+
+`-h`, `--help`
+: Print help information
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+[ronin-recon-worker](ronin-recon-worker.1.md) [ronin-recon-run](ronin-recon-run.1.md)

data/man/ronin-recon.1

@@ -0,0 +1,57 @@
+.\" Generated by kramdown-man 1.0.1
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-recon 1 "2024-01-01" Ronin Recon "User Manuals"
+.SH NAME
+.PP
+ronin\-recon \- A micro\-framework and tool for performing reconnaissance\.
+.SH SYNOPSIS
+.PP
+\fBronin\-recon\fR \[lB]\fIoptions\fP\[rB] \[lB]\fICOMMAND\fP \[lB]\.\.\.\[rB]\[rB]
+.SH DESCRIPTION
+.PP
+Runs a \fBronin\-recon\fR \fICOMMAND\fP\.
+.SH ARGUMENTS
+.TP
+\fICOMMAND\fP
+The \fBronin\-recon\fR command to execute\.
+.SH OPTIONS
+.TP
+\fB\-V\fR, \fB\-\-version\fR
+Prints the \fBronin\-recon\fR version and exits\.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print help information
+.SH COMMANDS
+.TP
+\fIcompletion\fP
+Manages the shell completion rules for \fBronin\-recon\fR\.
+.TP
+\fIhelp\fP
+Lists available commands or shows help about a specific command\.
+.TP
+\fIirb\fP
+Starts an interactive Ruby shell with ronin\-recon loaded\.
+.TP
+\fInew\fP
+Creates a new recon worker file\.
+.TP
+\fItest\fP
+Loads an individual worker and tests it\.
+.TP
+\fIworker\fP
+Prints information about a recon worker\.
+.TP
+\fIworkers\fP
+Lists the available recon workers\.
+.SH AUTHOR
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME
+.SH SEE ALSO
+.PP
+.BR ronin\-recon\-completion (1)
+.BR ronin\-recon\-new (1)
+.BR ronin\-recon\-test (1)
+.BR ronin\-recon\-worker (1)
+.BR ronin\-recon\-workers (1)