ronin-db 0.1.3 → 0.2.0

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

@@ -1,5 +1,9 @@
 # ronin-db-add 1 "2023-02-01" Ronin DB "User Manuals"
 
+## NAME
+
+ronin-db-add - Adds a pre-existing database to ronin-db
+
 ## SYNOPSIS
 
 `ronin-db add` [*options*] *NAME* [*URI*]
@@ -12,79 +16,79 @@ configuration file.
 ## ARGUMENTS
 
 *NAME*
-  The name of the database to add.
+: The name of the database to add.
 
 *URI*
-  The optional URI to the database to add.
+: The optional URI to the database to add.
 
 ## OPTIONS
 
 `-A`, `--adapter` `sqlite3|mysql2|postgres|...`
-  The adapter of the database to add.
+: The adapter of the database to add.
 
 `--sqlite3` *FILE*
-  Alias for `--adapter sqlite3 --database` *FILE*.
+: Alias for `--adapter sqlite3 --database` *FILE*.
 
 `--mysql2`
-  Alias for `--adapter mysql2`.
+: Alias for `--adapter mysql2`.
 
 `--postgresql`
-  Alias for `--adapter postgresql`.
+: Alias for `--adapter postgresql`.
 
 `-H`, `--host` *HOST*
-  The host of the database to add.
+: The host of the database to add.
 
 `-p`, `--port` *PORT*
-  The port of the database to add.
+: The port of the database to add.
 
 `-u`, `--username` *USER*
-  The username to authenticate with for the database.
+: The username to authenticate with for the database.
 
 `-P`, `--password` *PASSWORD*
-  The password to authenticate with for the database.
+: The password to authenticate with for the database.
 
 `--read-password`
-  Reads the database password from STDIN.
+: Reads the database password from STDIN.
 
 `-D`, `--database` *NAME*|*PATH*
-  The database name to connect to. If `--adapter sqlite3` is given then a path
+: The database name to connect to. If `--adapter sqlite3` is given then a path
   may be given instead.
 
 `-h`, `--help`
-  Print help information.
+: Print help information.
 
 ## EXAMPLES
 
 Add a sqlite3 database file:
 
-        $ ronin-db add other_db --sqlite3 path/to/db.sqlite3
+    $ ronin-db add other_db --sqlite3 path/to/db.sqlite3
 
 Add a PostgeSQL database:
 
-        $ ronin-db add other_db --postgres --host example.com --port 5432 --username ronin --password s3r3t --database ronin_db
+    $ ronin-db add other_db --postgres --host example.com --port 5432 --username ronin --password s3r3t --database ronin_db
 
 Add a MySQL database:
 
-        $ ronin-db add other_db --mysql2 --host example.com --port 3306 --username ronin --password s3r3t --database ronin_db
+    $ ronin-db add other_db --mysql2 --host example.com --port 3306 --username ronin --password s3r3t --database ronin_db
 
 ## ENVIRONMENT
 
 *HOME*
-  Alternate location for the user's home directory.
+: Alternate location for the user's home directory.
 
 *XDG_CONFIG_HOME*
-  Alternate location for the `~/.config` directory.
+: Alternate location for the `~/.config` directory.
 
 *XDG_DATA_HOME*
-  Alternate location for the `~/.local/share` directory.
+: Alternate location for the `~/.local/share` directory.
 
 ## FILES
 
 `~/.local/share/ronin-db/database.sqlite3`
-  The default sqlite3 database file.
+: The default sqlite3 database file.
 
 `~/.config/ronin-db/database.yml`
-  Optional database configuration.
+: Optional database configuration.
 
 ## AUTHOR
 
@@ -92,4 +96,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-db(1) ronin-db-list(1) ronin-db-edit(1) ronin-db-remove(1)
+[ronin-db](ronin-db.1.md) [ronin-db-list](ronin-db-list.1.md) [ronin-db-edit](ronin-db-edit.1.md) [ronin-db-remove](ronin-db-remove.1.md)

data/man/ronin-db-asn.1

@@ -1,111 +1,93 @@
-.\" Generated by kramdown-man 0.1.9
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
-.TH ronin-db-asn 1 "2023-02-01" Ronin "User Manuals"
-.LP
+.TH ronin-db-asn 1 "2023-02-01" Ronin DB "User Manuals"
+.SH NAME
+.PP
+ronin\-db\-asn \- Queries and updates ASNs
 .SH SYNOPSIS
-.LP
 .PP
-\fBronin-db asn\fR \[lB]\fIoptions\fP\[rB]
-.LP
+\fBronin\-db asn\fR \[lB]\fIoptions\fP\[rB]
 .SH DESCRIPTION
-.LP
 .PP
 Queries or updates Autonomous System Numbers (ASNs) in the database\.
-.LP
 .SH OPTIONS
-.LP
 .TP
-\fB--db\fR \fINAME\fP
+\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
+\fB\-\-db\-uri\fR \fIURI\fP
 The explicit database URI to connect to\.
-.LP
+.RS
 .RS
 .IP \(bu 2
-\fBsqlite3\fP: \fBsqlite3:relative/path.db\fR or \fBsqlite3:///absolute/path.db\fR
+\fBsqlite3\fP: \fBsqlite3:relative\[sl]path\.db\fR or \fBsqlite3:\[sl]\[sl]\[sl]absolute\[sl]path\.db\fR
 .IP \(bu 2
-\fBmysql\fP: \fBmysql://user:password@host/database\fR
+\fBmysql\fP: \fBmysql:\[sl]\[sl]user:password\[at]host\[sl]database\fR
 .IP \(bu 2
-\fBpostgres\fP: \fBpostgres://user:password@host/database\fR
+\fBpostgres\fP: \fBpostgres:\[sl]\[sl]user:password\[at]host\[sl]database\fR
+.RE
 .RE
-.LP
 .TP
-\fB-v\fR, \fB--verbose\fR
+\fB\-\-db\-file\fR \fIPATH\fP
+The sqlite3 database file to use\.
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
 Enables verbose output
-.LP
 .TP
-\fB-n\fR, \fB--number\fR \fIINT\fP
+\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]\fBUnknown\fR
+\fB\-C\fR, \fB\-\-country\-code\fR \fIXX\fP\[or]\fBNone\fR\[or]\fBUnknown\fR
 Searches for all ASN records with the country code\.
-.LP
 .TP
-\fB-N\fR, \fB--name\fR \fINAME\fP
+\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
+\fB\-\-named\fR \fINAME\fP
+Searches for all ASN records containing the name\.
+.TP
+\fB\-I\fR, \fB\-\-ip\fR \fIIP\fP
 Queries the ASN record for the IP\.
-.LP
 .TP
-\fB-4\fR, \fB--ipv4\fR
+\fB\-4\fR, \fB\-\-ipv4\fR
 Filter ASN records for only IPv4 ranges\.
-.LP
 .TP
-\fB-6\fR, \fB--ipv6\fR
+\fB\-6\fR, \fB\-\-ipv6\fR
 Filter ASN records for only IPv6 ranges\.
-.LP
 .TP
-\fB-u\fR, \fB--update\fR
+\fB\-u\fR, \fB\-\-update\fR
 Updates the ASN records\.
-.LP
 .TP
-\fB-U\fR, \fB--url\fR \fIURI\fP
+\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
+Defaults to \fBhttps:\[sl]\[sl]iptoasn\.com\[sl]data\[sl]ip2asn\-combined\.tsv\.gz\fR if not given\.
 .TP
-\fB-f\fR, \fB--file\fR \fIFILE\fP
+\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
+Defaults to \fB\[ti]\[sl]\.local\[sl]share\[sl]ronin\[sl]ronin\-support\[sl]ip2asn\-combined\.tsv\.gz\fR
 if not given\.
-.LP
 .TP
-\fB-h\fR, \fB--help\fR
+\fB\-h\fR, \fB\-\-help\fR
 Print help information\.
-.LP
 .SH ENVIRONMENT
-.LP
 .TP
 \fIHOME\fP
 Alternate location for the user\[cq]s home directory\.
-.LP
 .TP
 \fIXDG\[ru]CONFIG\[ru]HOME\fP
-Alternate location for the \fB~/.config\fR directory\.
-.LP
+Alternate location for the \fB\[ti]\[sl]\.config\fR directory\.
 .TP
 \fIXDG\[ru]DATA\[ru]HOME\fP
-Alternate location for the \fB~/.local/share\fR directory\.
-.LP
+Alternate location for the \fB\[ti]\[sl]\.local\[sl]share\fR directory\.
 .SH FILES
-.LP
 .TP
-\fB~/.local/share/ronin-db/database.sqlite3\fR
+\fB\[ti]\[sl]\.local\[sl]share\[sl]ronin\-db\[sl]database\.sqlite3\fR
 The default sqlite3 database file\.
-.LP
 .TP
-\fB~/.config/ronin-db/database.yml\fR
+\fB\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fR
 Optional database configuration\.
-.LP
 .SH AUTHOR
-.LP
 .PP
 Postmodern 
 .MT postmodern\.mod3\[at]gmail\.com
 .ME
-.LP

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

@@ -1,4 +1,8 @@
-# ronin-db-asn 1 "2023-02-01" Ronin "User Manuals"
+# ronin-db-asn 1 "2023-02-01" Ronin DB "User Manuals"
+
+## NAME
+
+ronin-db-asn - Queries and updates ASNs
 
 ## SYNOPSIS
 
@@ -11,69 +15,75 @@ 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.
+: The database name to connect to. Defaults to `default` if not given.
 
 `--db-uri` *URI*
-  The explicit database URI to connect to.
+: The explicit database URI to connect to.
 
   * **sqlite3**: `sqlite3:relative/path.db` or `sqlite3:///absolute/path.db`
   * **mysql**: `mysql://user:password@host/database`
   * **postgres**: `postgres://user:password@host/database`
 
+`--db-file` *PATH*
+: The sqlite3 database file to use.
+
 `-v`, `--verbose`
-  Enables verbose output
+: Enables verbose output
 
 `-n`, `--number` *INT*
-  Searches for all ASN records with the AS number.
+: Searches for all ASN records with the AS number.
 
 `-C`, `--country-code` *XX*\|`None`\|`Unknown`
-  Searches for all ASN records with the country code.
+: Searches for all ASN records with the country code.
 
 `-N`, `--name` *NAME*
-  Searches for all ASN records with the matching name.
+: Searches for all ASN records with the matching name.
+
+`--named` *NAME*
+: Searches for all ASN records containing the name.
 
 `-I`, `--ip` *IP*
-  Queries the ASN record for the IP.
+: Queries the ASN record for the IP.
 
 `-4`, `--ipv4`
-  Filter ASN records for only IPv4 ranges.
+: Filter ASN records for only IPv4 ranges.
 
 `-6`, `--ipv6`
-  Filter ASN records for only IPv6 ranges.
+: Filter ASN records for only IPv6 ranges.
 
 `-u`, `--update`
-  Updates the ASN records.
+: Updates the ASN records.
 
 `-U`, `--url` *URI*
-  Overrides the default ASN list URL.
+: 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.
+: 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.
+: Print help information.
 
 ## ENVIRONMENT
 
 *HOME*
-  Alternate location for the user's home directory.
+: Alternate location for the user's home directory.
 
 *XDG_CONFIG_HOME*
-  Alternate location for the `~/.config` directory.
+: Alternate location for the `~/.config` directory.
 
 *XDG_DATA_HOME*
-  Alternate location for the `~/.local/share` directory.
+: Alternate location for the `~/.local/share` directory.
 
 ## FILES
 
 `~/.local/share/ronin-db/database.sqlite3`
-  The default sqlite3 database file.
+: The default sqlite3 database file.
 
 `~/.config/ronin-db/database.yml`
-  Optional database configuration.
+: Optional database configuration.
 
 ## AUTHOR
 

data/man/ronin-db-certs.1

@@ -0,0 +1,108 @@
+.\" Generated by kramdown-man 1.0.1
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-db-certs 1 "2023-02-01" Ronin DB "User Manuals"
+.SH NAME
+.PP
+ronin\-db\-certs \- Queries or imports SSL\[sl]TLS certificates
+.SH SYNOPSIS
+.PP
+\fBronin\-db certs\fR \[lB]\fIoptions\fP\[rB]
+.SH DESCRIPTION
+.PP
+Queries or imports SSL\[sl]TLS certificates into the database\.
+.SH OPTIONS
+.TP
+\fB\-\-db\fR \fINAME\fP
+The database name to connect to\. Defaults to \fBdefault\fR if not given\.
+.TP
+\fB\-\-db\-uri\fR \fIURI\fP
+The explicit database URI to connect to\.
+.RS
+.RS
+.IP \(bu 2
+\fBsqlite3\fP: \fBsqlite3:relative\[sl]path\.db\fR or \fBsqlite3:\[sl]\[sl]\[sl]absolute\[sl]path\.db\fR
+.IP \(bu 2
+\fBmysql\fP: \fBmysql:\[sl]\[sl]user:password\[at]host\[sl]database\fR
+.IP \(bu 2
+\fBpostgres\fP: \fBpostgres:\[sl]\[sl]user:password\[at]host\[sl]database\fR
+.RE
+.RE
+.TP
+\fB\-\-db\-file\fR \fIPATH\fP
+The sqlite3 database file to use\.
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Enables verbose output
+.TP
+\fB\-A\fR, \fB\-\-active\fR
+Searches for all Certs that are still valid\.
+.TP
+\fB\-E\fR, \fB\-\-expired\fR
+Searches for all Certs that are expired\.
+.TP
+\fB\-\-issuer\-common\-name\fR \fINAME\fP
+Searches for all Certs with the Issuer Common Name (CN)\.
+.TP
+\fB\-\-issuer\-organization\fR \fINAME\fP
+Searches for all Certs with the Issuer Organization (O)\.
+.TP
+\fB\-\-issuer\-organizational\-unit\fR \fINAME\fP
+Searches for all Certs with the Issuer Organizational Unit (OU)\.
+.TP
+\fB\-\-issuer\-locality\fR \fILOCALITY\fP
+Searches for all Certs with the Issuer Locality (L)\.
+.TP
+\fB\-\-issuer\-state\fR \fISTATE\fP
+Searches for all Certs with the Issuer State (ST)\.
+.TP
+\fB\-\-issuer\-country\fR \fICOUNTRY\fP
+Searches for all Certs with the Issuer Country (C)\.
+.TP
+\fB\-\-common\-name\fR \fIHOST\fP
+Searches for all Certs with the Subject Common Name (CN)\.
+.TP
+\fB\-\-subject\-alt\-name\fR \fIHOST\fP
+Searches for all Certs with the Subject Alternative Name (SAN)\.
+.TP
+\fB\-\-organization\fR \fINAME\fP
+Searches for all Certs with the Subject Organization (O)\.
+.TP
+\fB\-\-organizational\-unit\fR \fINAME\fP
+Searches for all Certs with the Subject Organizational Unit (OU)\.
+.TP
+\fB\-\-locality\fR \fILOCALITY\fP
+Searches for all Certs with the Subject Locality (L)\.
+.TP
+\fB\-\-state\fR \fISTATE\fP
+Searches for all Certs with the Subject State (ST)\.
+.TP
+\fB\-\-country\fR \fICOUNTRY\fP
+Searches for all Certs with the Subject Country (C)\.
+.TP
+\fB\-\-import\fR \fIFILE\fP
+Imports a SSL\[sl]TLS certificate from a PEM encoded file\.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print help information\.
+.SH ENVIRONMENT
+.TP
+\fIHOME\fP
+Alternate location for the user\[cq]s home directory\.
+.TP
+\fIXDG\[ru]CONFIG\[ru]HOME\fP
+Alternate location for the \fB\[ti]\[sl]\.config\fR directory\.
+.TP
+\fIXDG\[ru]DATA\[ru]HOME\fP
+Alternate location for the \fB\[ti]\[sl]\.local\[sl]share\fR directory\.
+.SH FILES
+.TP
+\fB\[ti]\[sl]\.local\[sl]share\[sl]ronin\-db\[sl]database\.sqlite3\fR
+The default sqlite3 database file\.
+.TP
+\fB\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fR
+Optional database configuration\.
+.SH AUTHOR
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME

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

@@ -0,0 +1,106 @@
+# ronin-db-certs 1 "2023-02-01" Ronin DB "User Manuals"
+
+## NAME
+
+ronin-db-certs - Queries or imports SSL/TLS certificates
+
+## SYNOPSIS
+
+`ronin-db certs` [*options*]
+
+## DESCRIPTION
+
+Queries or imports SSL/TLS certificates into 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.
+
+  * **sqlite3**: `sqlite3:relative/path.db` or `sqlite3:///absolute/path.db`
+  * **mysql**: `mysql://user:password@host/database`
+  * **postgres**: `postgres://user:password@host/database`
+
+`--db-file` *PATH*
+: The sqlite3 database file to use.
+
+`-v`, `--verbose`
+: Enables verbose output
+
+`-A`, `--active`
+: Searches for all Certs that are still valid.
+
+`-E`, `--expired`
+: Searches for all Certs that are expired.
+
+`--issuer-common-name` *NAME*
+: Searches for all Certs with the Issuer Common Name (CN).
+
+`--issuer-organization` *NAME*
+: Searches for all Certs with the Issuer Organization (O).
+
+`--issuer-organizational-unit` *NAME*
+: Searches for all Certs with the Issuer Organizational Unit (OU).
+
+`--issuer-locality` *LOCALITY*
+: Searches for all Certs with the Issuer Locality (L).
+
+`--issuer-state` *STATE*
+: Searches for all Certs with the Issuer State (ST).
+
+`--issuer-country` *COUNTRY*
+: Searches for all Certs with the Issuer Country (C).
+
+`--common-name` *HOST*
+: Searches for all Certs with the Subject Common Name (CN).
+
+`--subject-alt-name` *HOST*
+: Searches for all Certs with the Subject Alternative Name (SAN).
+
+`--organization` *NAME*
+: Searches for all Certs with the Subject Organization (O).
+
+`--organizational-unit` *NAME*
+: Searches for all Certs with the Subject Organizational Unit (OU).
+
+`--locality` *LOCALITY*
+: Searches for all Certs with the Subject Locality (L).
+
+`--state` *STATE*
+: Searches for all Certs with the Subject State (ST).
+
+`--country` *COUNTRY*
+: Searches for all Certs with the Subject Country (C).
+
+`--import` *FILE*
+: Imports a SSL/TLS certificate from a PEM encoded file.
+
+`-h`, `--help`
+: Print help information.
+
+## ENVIRONMENT
+
+*HOME*
+: Alternate location for the user's home directory.
+
+*XDG_CONFIG_HOME*
+: Alternate location for the `~/.config` directory.
+
+*XDG_DATA_HOME*
+: Alternate location for the `~/.local/share` directory.
+
+## FILES
+
+`~/.local/share/ronin-db/database.sqlite3`
+: The default sqlite3 database file.
+
+`~/.config/ronin-db/database.yml`
+: Optional database configuration.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+

data/man/ronin-db-completion.1

@@ -0,0 +1,76 @@
+.\" Generated by kramdown-man 1.0.1
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-db-completion 1 "2024-01-01" Ronin DB "User Manuals"
+.SH NAME
+.PP
+ronin\-db\-completion \- Manages shell completion rules for \fBronin\-db\fR
+.SH SYNOPSIS
+.PP
+\fBronin\-db completion\fR \[lB]\fIoptions\fP\[rB]
+.SH DESCRIPTION
+.PP
+The \fBronin\-db completion\fR command can print, install, or uninstall shell
+completion rules for the \fBronin\-db\fR command\.
+.PP
+Supports installing completion rules for Bash or Zsh shells\.
+Completion rules for the Fish shell is currently not supported\.
+.SS ZSH SUPPORT
+.PP
+Zsh users will have to add the following lines to their \fB\[ti]\[sl]\.zshrc\fR file in
+order to enable Zsh\[cq]s Bash completion compatibility layer:
+.PP
+.RS 4
+.EX
+autoload \-Uz \[pl]X compinit && compinit
+autoload \-Uz \[pl]X bashcompinit && bashcompinit
+.EE
+.RE
+.SH OPTIONS
+.TP
+\fB\-\-print\fR
+Prints the shell completion file\.
+.TP
+\fB\-\-install\fR
+Installs the shell completion file\.
+.TP
+\fB\-\-uninstall\fR
+Uninstalls the shell completion file\.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Prints help information\.
+.SH ENVIRONMENT
+.TP
+\fIPREFIX\fP
+Specifies the root prefix for the file system\.
+.TP
+\fIHOME\fP
+Specifies the home directory of the user\. Ronin will search for the
+\fB\[ti]\[sl]\.cache\[sl]ronin\-db\fR cache directory within the home directory\.
+.TP
+\fIXDG\[ru]DATA\[ru]HOME\fP
+Specifies the data directory to use\. Defaults to \fB\[Do]HOME\[sl]\.local\[sl]share\fR\.
+.SH FILES
+.TP
+\fB\[ti]\[sl]\.local\[sl]share\[sl]bash\-completion\[sl]completions\[sl]\fR
+The user\-local installation directory for Bash completion files\.
+.TP
+\fB\[sl]usr\[sl]local\[sl]share\[sl]bash\-completion\[sl]completions\[sl]\fR
+The system\-wide installation directory for Bash completions files\.
+.TP
+\fB\[sl]usr\[sl]local\[sl]share\[sl]zsh\[sl]site\-functions\[sl]\fR
+The installation directory for Zsh completion files\.
+.SH EXAMPLES
+.TP
+\fBronin\-db completion \-\-print\fR
+Prints the shell completion rules instead of installing them\.
+.TP
+\fBronin\-db completion \-\-install\fR
+Installs the shell completion rules for \fBronin\-db\fR\.
+.TP
+\fBronin\-db completion \-\-uninstall\fR
+Uninstalls the shell completion rules for \fBronin\-db\fR\.
+.SH AUTHOR
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME