ronin-db 0.1.0.beta1

data/man/ronin-db-add.1.md

@@ -0,0 +1,75 @@
+# ronin-db-add 1 "2022-01-01" Ronin DB "User Manuals"
+
+## SYNOPSIS
+
+`ronin-db add` [*options*] *NAME* [*URI*]
+
+## DESCRIPTION
+
+Lists entries in the `~/.config/ronin-db/database.yml` configuration file.
+
+## ARGUMENTS
+
+*NAME*
+  The name of the database to add.
+
+*URI*
+  The optional URI to the database to add.
+
+## OPTIONS
+
+`-A`, `--adapter` `sqlite3|mysql2|postgres|...`
+  The adapter of the database to add.
+
+`--sqlite3` *FILE*
+  Alias for `--adapter sqlite3 --database` *FILE*.
+
+`--mysql2`
+  Alias for `--adapter mysql2`.
+
+`--postgresql`
+  Alias for `--adapter postgresql`.
+
+`-H`, `--host` *HOST*
+  The host of the database to add.
+
+`-p`, `--port` *PORT*
+  The port of the database to add.
+
+`-u`, `--username` *USER*
+  The username to authenticate with for the database.
+
+`-P`, `--password` *PASSWORD*
+  The password to authenticate with for the database.
+
+`--read-password`
+  Reads the database password from STDIN.
+
+`-D`, `--database` *NAME*|*PATH*
+  The database name to connect to. If `--adapter sqlite3` is given then a path
+  may be given instead.
+
+`-h`, `--help`
+  Print help information.
+
+## FILES
+
+*~/.config/ronin-db/database.yml*
+	The `ronin-db` database(s) configuration file.
+
+## ENVIRONMENT
+
+HOME
+	Specifies the home directory of the user. Ronin will search for the
+	*~/.config/ronin-db* cache directory within the home directory.
+
+XDG_CONFIG_HOME
+  Specifies the cache directory to use. Defaults to *$HOME/.config*.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+ronin-db(1) ronin-db-list(1) ronin-db-edit(1) ronin-db-remove(1)

data/man/ronin-db-asn.1

@@ -0,0 +1,79 @@
+.\" Generated by kramdown-man 0.1.8
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-db-asn 1 "April 2012" Ronin "User Manuals"
+.LP
+.SH SYNOPSIS
+.LP
+.HP
+\fBronin-db asn\fR \[lB]\fIoptions\fP\[rB]
+.LP
+.SH DESCRIPTION
+.LP
+.PP
+Queries or updates Autonomous System Numbers (ASNs) in the database\.
+.LP
+.SH OPTIONS
+.LP
+.TP
+\fB--db\fR \fINAME\fP
+The database name to connect to\. Defaults to \fBdefault\fR if not given\.
+.LP
+.TP
+\fB--db-uri\fR \fIURI\fP
+The explicit database URI to connect to
+(ex: \fBpostgres://user:password@host/db\fR)\.
+.LP
+.TP
+\fB-v\fR, \fB--verbose\fR
+Enables verbose output
+.LP
+.TP
+\fB-n\fR, \fB--number\fR \fIINT\fP
+Searches for all ASN records with the AS number\.
+.LP
+.TP
+\fB-C\fR, \fB--country-code\fR \fIXX\fP\[or]\fBNone\fR\[or]\fBUknown\fR
+Searches for all ASN records with the country code\.
+.LP
+.TP
+\fB-N\fR, \fB--name\fR \fINAME\fP
+Searches for all ASN records with the matching name\.
+.LP
+.TP
+\fB-I\fR, \fB--ip\fR \fIIP\fP
+Queries the ASN record for the IP\.
+.LP
+.TP
+\fB-4\fR, \fB--ipv4\fR
+Filter ASN records for only IPv4 ranges\.
+.LP
+.TP
+\fB-6\fR, \fB--ipv6\fR
+Filter ASN records for only IPv6 ranges\.
+.LP
+.TP
+\fB-u\fR, \fB--update\fR
+Updates the ASN records\.
+.LP
+.TP
+\fB-U\fR, \fB--url\fR \fIURI\fP
+Overrides the default ASN list URL\.
+Defaults to \fBhttps://iptoasn.com/data/ip2asn-combined.tsv.gz\fR if not given\.
+.LP
+.TP
+\fB-f\fR, \fB--file\fR \fIFILE\fP
+Overrides the default ASN list file\.
+Defaults to \fB~/.local/share/ronin/ronin-support/ip2asn-combined.tsv.gz\fR
+if not given\.
+.LP
+.TP
+\fB-h\fR, \fB--help\fR
+Print help information\.
+.LP
+.SH AUTHOR
+.LP
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME
+.LP

data/man/ronin-db-asn.1.md

@@ -0,0 +1,59 @@
+# ronin-db-asn 1 "April 2012" Ronin "User Manuals"
+
+## SYNOPSIS
+
+`ronin-db asn` [*options*]
+
+## DESCRIPTION
+
+Queries or updates Autonomous System Numbers (ASNs) in the database.
+
+## OPTIONS
+
+`--db` *NAME*
+  The database name to connect to. Defaults to `default` if not given.
+
+`--db-uri` *URI*
+  The explicit database URI to connect to
+  (ex: `postgres://user:password@host/db`).
+
+`-v`, `--verbose`
+  Enables verbose output
+
+`-n`, `--number` *INT*
+  Searches for all ASN records with the AS number.
+
+`-C`, `--country-code` *XX*\|`None`\|`Uknown`
+  Searches for all ASN records with the country code.
+
+`-N`, `--name` *NAME*
+  Searches for all ASN records with the matching name.
+
+`-I`, `--ip` *IP*
+  Queries the ASN record for the IP.
+
+`-4`, `--ipv4`
+  Filter ASN records for only IPv4 ranges.
+
+`-6`, `--ipv6`
+  Filter ASN records for only IPv6 ranges.
+
+`-u`, `--update`
+  Updates the ASN records.
+
+`-U`, `--url` *URI*
+  Overrides the default ASN list URL.
+  Defaults to `https://iptoasn.com/data/ip2asn-combined.tsv.gz` if not given.
+
+`-f`, `--file` *FILE*
+  Overrides the default ASN list file.
+  Defaults to `~/.local/share/ronin/ronin-support/ip2asn-combined.tsv.gz`
+  if not given.
+
+`-h`, `--help`
+  Print help information.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+

data/man/ronin-db-creds.1

@@ -0,0 +1,78 @@
+.\" Generated by kramdown-man 0.1.8
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-db-creds 1 "April 2012" Ronin "User Manuals"
+.LP
+.SH SYNOPSIS
+.LP
+.HP
+\fBronin-db creds\fR \[lB]\fIoptions\fP\[rB]
+.LP
+.SH DESCRIPTION
+.LP
+.PP
+Manages credentials\.
+.LP
+.SH OPTIONS
+.LP
+.TP
+\fB--db\fR \fINAME\fP
+The database to connect to\. Defaults to \fBdefault\fR if not given\.
+.LP
+.TP
+\fB--db-uri\fR \fIURI\fP
+The explicit database URI to connect to
+(ex: \fBmysql://user:password@host/ronin\fR)\.
+.LP
+.TP
+\fB-v\fR, \fB--verbose\fR
+Enable verbose output\.
+.LP
+.TP
+\fB--add\fR \fIUSER\fP:\fIPASSWORD\fP
+Adds the \fIUSER\fP and \fIPASSWORD\fP to the database\.
+.LP
+.TP
+\fB--import\fR \fIFILE\fP
+Imports the credentials from the given \fIFILE\fP\.
+.LP
+.TP
+\fB--delete\fR \fIVALUE\fP
+Deletes a value from the database\.
+.LP
+.TP
+\fB--delete-all\fR
+Deletes every value from the database\.
+.LP
+.TP
+\fB-u\fR, \fB--for-user\fR \fIUSER\fP
+Searches for Credentials associated with the USER\.
+.LP
+.TP
+\fB-p\fR, \fB--with-password\fR \fIPASSWORD\fP
+Searches for Credentials that have the PASSWORD\.
+.LP
+.SH FILES
+.LP
+.TP
+\fI\[ti]\[sl]\.ronin\[sl]\fP
+Ronin configuration directory\.
+.LP
+.TP
+\fI\[ti]\[sl]\.ronin\[sl]database\.log\fP
+Database log\.
+.LP
+.TP
+\fI\[ti]\[sl]\.ronin\[sl]database\.sqlite3\fP
+The default sqlite3 Database file\.
+.LP
+.TP
+\fI\[ti]\[sl]\.ronin\[sl]database\.yml\fP
+Optional Database configuration\.
+.LP
+.SH AUTHOR
+.LP
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME
+.LP

data/man/ronin-db-creds.1.md

@@ -0,0 +1,58 @@
+# ronin-db-creds 1 "April 2012" Ronin "User Manuals"
+
+## SYNOPSIS
+
+`ronin-db creds` [*options*]
+
+## DESCRIPTION
+
+Manages credentials.
+
+## OPTIONS
+
+`--db` *NAME*
+  The database to connect to. Defaults to `default` if not given.
+
+`--db-uri` *URI*
+  The explicit database URI to connect to
+  (ex: `mysql://user:password@host/ronin`).
+
+`-v`, `--verbose`
+	Enable verbose output.
+
+`--add` *USER*:*PASSWORD*
+  Adds the *USER* and *PASSWORD* to the database.
+
+`--import` *FILE*
+  Imports the credentials from the given *FILE*.
+
+`--delete` *VALUE*
+  Deletes a value from the database.
+
+`--delete-all`
+  Deletes every value from the database.
+
+`-u`, `--for-user` *USER*
+	Searches for Credentials associated with the USER.
+
+`-p`, `--with-password` *PASSWORD*
+	Searches for Credentials that have the PASSWORD.
+
+## FILES
+
+*~/.ronin/*
+	Ronin configuration directory.
+
+*~/.ronin/database.log*
+	Database log.
+
+*~/.ronin/database.sqlite3*
+	The default sqlite3 Database file.
+
+*~/.ronin/database.yml*
+	Optional Database configuration.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+

data/man/ronin-db-edit.1

@@ -0,0 +1,48 @@
+.\" Generated by kramdown-man 0.1.8
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-db-edit 1 "2022-01-01" Ronin DB "User Manuals"
+.LP
+.SH SYNOPSIS
+.LP
+.HP
+\fBronin-db edit\fR \[lB]\fIoptions\fP\[rB]
+.LP
+.SH DESCRIPTION
+.LP
+.PP
+Manually edits the \fB~/.config/ronin-db/database.yml\fR configuration file\.
+.LP
+.SH OPTIONS
+.LP
+.TP
+\fB-h\fR, \fB--help\fR
+Print help information\.
+.LP
+.SH FILES
+.LP
+.TP
+\fI\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fP
+The \fBronin-db\fR database(s) configuration file\.
+.LP
+.SH ENVIRONMENT
+.LP
+.PP
+HOME
+Specifies the home directory of the user\. Ronin will search for the
+\fI\[ti]\[sl]\.config\[sl]ronin\-db\fP cache directory within the home directory\.
+.LP
+.PP
+XDG\[ru]CONFIG\[ru]HOME
+Specifies the cache directory to use\. Defaults to \fI\[Do]HOME\[sl]\.config\fP\.
+.LP
+.SH AUTHOR
+.LP
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME
+.LP
+.SH SEE ALSO
+.LP
+.PP
+ronin\-db(1) ronin\-db\-add(1) ronin\-db\-list(1) ronin\-db\-remove(1)

data/man/ronin-db-edit.1.md

@@ -0,0 +1,36 @@
+# ronin-db-edit 1 "2022-01-01" Ronin DB "User Manuals"
+
+## SYNOPSIS
+
+`ronin-db edit` [*options*]
+
+## DESCRIPTION
+
+Manually edits the `~/.config/ronin-db/database.yml` configuration file.
+
+## OPTIONS
+
+`-h`, `--help`
+  Print help information.
+
+## FILES
+
+*~/.config/ronin-db/database.yml*
+	The `ronin-db` database(s) configuration file.
+
+## ENVIRONMENT
+
+HOME
+	Specifies the home directory of the user. Ronin will search for the
+	*~/.config/ronin-db* cache directory within the home directory.
+
+XDG_CONFIG_HOME
+  Specifies the cache directory to use. Defaults to *$HOME/.config*.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+ronin-db(1) ronin-db-add(1) ronin-db-list(1) ronin-db-remove(1)

data/man/ronin-db-emails.1

@@ -0,0 +1,82 @@
+.\" Generated by kramdown-man 0.1.8
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-db-emails 1 "April 2012" Ronin "User Manuals"
+.LP
+.SH SYNOPSIS
+.LP
+.HP
+\fBronin-db emails\fR \[lB]\fIoptions\fP\[rB]
+.LP
+.SH DESCRIPTION
+.LP
+.PP
+Manages email addresses\.
+.LP
+.SH OPTIONS
+.LP
+.TP
+\fB--db\fR \fINAME\fP
+The database to connect to\. Defaults to \fBdefault\fR if not given\.
+.LP
+.TP
+\fB--db-uri\fR \fIURI\fP
+The explicit database URI to connect to
+(ex: \fBmysql://user:password@host/ronin\fR)\.
+.LP
+.TP
+\fB-v\fR, \fB--verbose\fR
+Enable verbose output\.
+.LP
+.TP
+\fB--add\fR \fIUSER\fP:\fIPASSWORD\fP
+Adds the \fIUSER\fP and \fIPASSWORD\fP to the database\.
+.LP
+.TP
+\fB--import\fR \fIFILE\fP
+Imports the credentials from the given \fIFILE\fP\.
+.LP
+.TP
+\fB--delete\fR \fIVALUE\fP
+Deletes a value from the database\.
+.LP
+.TP
+\fB--delete-all\fR
+Deletes every value from the database\.
+.LP
+.TP
+\fB-H\fR, \fB--with-host\fR \fIHOST\fP
+Searches for email addresses associated with the \fIHOST\fP\.
+.LP
+.TP
+\fB-I\fR, \fB--with-ip\fR \fIIP\fP
+Searches for email addresses associated with the IP address\.
+.LP
+.HP
+\fB-u\fR, \fB--with-users\fR \fINAME\fP \[lB]\.\.\.\[rB]
+Searches for email addresses associated with the user NAME(s)\.
+.LP
+.SH FILES
+.LP
+.TP
+\fI\[ti]\[sl]\.ronin\[sl]\fP
+Ronin configuration directory\.
+.LP
+.TP
+\fI\[ti]\[sl]\.ronin\[sl]database\.log\fP
+Database log\.
+.LP
+.TP
+\fI\[ti]\[sl]\.ronin\[sl]database\.sqlite3\fP
+The default sqlite3 Database file\.
+.LP
+.TP
+\fI\[ti]\[sl]\.ronin\[sl]database\.yml\fP
+Optional Database configuration\.
+.LP
+.SH AUTHOR
+.LP
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME
+.LP

data/man/ronin-db-emails.1.md

@@ -0,0 +1,61 @@
+# ronin-db-emails 1 "April 2012" Ronin "User Manuals"
+
+## SYNOPSIS
+
+`ronin-db emails` [*options*]
+
+## DESCRIPTION
+
+Manages email addresses.
+
+## OPTIONS
+
+`--db` *NAME*
+  The database to connect to. Defaults to `default` if not given.
+
+`--db-uri` *URI*
+  The explicit database URI to connect to
+  (ex: `mysql://user:password@host/ronin`).
+
+`-v`, `--verbose`
+	Enable verbose output.
+
+`--add` *USER*:*PASSWORD*
+  Adds the *USER* and *PASSWORD* to the database.
+
+`--import` *FILE*
+  Imports the credentials from the given *FILE*.
+
+`--delete` *VALUE*
+  Deletes a value from the database.
+
+`--delete-all`
+  Deletes every value from the database.
+
+`-H`, `--with-host` *HOST*
+	Searches for email addresses associated with the *HOST*.
+
+`-I`, `--with-ip` *IP*
+	Searches for email addresses associated with the IP address.
+
+`-u`, `--with-users` *NAME* [...]
+	Searches for email addresses associated with the user NAME(s).
+
+## FILES
+
+*~/.ronin/*
+	Ronin configuration directory.
+
+*~/.ronin/database.log*
+	Database log.
+
+*~/.ronin/database.sqlite3*
+	The default sqlite3 Database file.
+
+*~/.ronin/database.yml*
+	Optional Database configuration.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+

data/man/ronin-db-hosts.1

@@ -0,0 +1,86 @@
+.\" Generated by kramdown-man 0.1.8
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-db-hosts 1 "April 2012" Ronin "User Manuals"
+.LP
+.SH SYNOPSIS
+.LP
+.HP
+\fBronin-db hosts\fR \[lB]\fIoptions\fP\[rB]
+.LP
+.SH DESCRIPTION
+.LP
+.PP
+Manages host names\.
+.LP
+.SH OPTIONS
+.LP
+.TP
+\fB--db\fR \fINAME\fP
+The database to connect to\. Defaults to \fBdefault\fR if not given\.
+.LP
+.TP
+\fB--db-uri\fR \fIURI\fP
+The explicit database URI to connect to
+(ex: \fBmysql://user:password@host/ronin\fR)\.
+.LP
+.TP
+\fB-v\fR, \fB--verbose\fR
+Enable verbose output\.
+.LP
+.TP
+\fB--add\fR \fIUSER\fP:\fIPASSWORD\fP
+Adds the \fIUSER\fP and \fIPASSWORD\fP to the database\.
+.LP
+.TP
+\fB--import\fR \fIFILE\fP
+Imports the credentials from the given \fIFILE\fP\.
+.LP
+.TP
+\fB--delete\fR \fIVALUE\fP
+Deletes a value from the database\.
+.LP
+.TP
+\fB--delete-all\fR
+Deletes every value from the database\.
+.LP
+.TP
+\fB-I\fR, \fB--with-ip\fR \fIIP\fP
+Searches for HostNames associated with the IP address\.
+.LP
+.TP
+\fB-p\fR, \fB--with-port\fR \fIPORT\fP
+Searches for HostNames associated with the \fIPORT\fP\.
+.LP
+.TP
+\fB-D\fR, \fB--domain\fR \fIDOMAIN\fP
+Searches for HostNames belonging to the DOMAIN (\fBco.uk\fR)\.
+.LP
+.TP
+\fB-T\fR, \fB--tld\fR \fITLD\fP
+Searches for HostNames with the Top\-Level\-Domain (TLD) (\fBru\fR)\.
+.LP
+.SH FILES
+.LP
+.TP
+\fI\[ti]\[sl]\.ronin\[sl]\fP
+Ronin configuration directory\.
+.LP
+.TP
+\fI\[ti]\[sl]\.ronin\[sl]database\.log\fP
+Database log\.
+.LP
+.TP
+\fI\[ti]\[sl]\.ronin\[sl]database\.sqlite3\fP
+The default sqlite3 Database file\.
+.LP
+.TP
+\fI\[ti]\[sl]\.ronin\[sl]database\.yml\fP
+Optional Database configuration\.
+.LP
+.SH AUTHOR
+.LP
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME
+.LP