ronin-db 0.1.2-java → 0.2.0-java

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

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

@@ -0,0 +1,78 @@
+# ronin-db-completion 1 "2024-01-01" Ronin DB "User Manuals"
+
+## NAME
+
+ronin-db-completion - Manages shell completion rules for `ronin-db`
+
+## SYNOPSIS
+
+`ronin-db completion` [*options*]
+
+## DESCRIPTION
+
+The `ronin-db completion` command can print, install, or uninstall shell
+completion rules for the `ronin-db` command.
+
+Supports installing completion rules for Bash or Zsh shells.
+Completion rules for the Fish shell is currently not supported.
+
+### ZSH SUPPORT
+
+Zsh users will have to add the following lines to their `~/.zshrc` file in
+order to enable Zsh's Bash completion compatibility layer:
+
+    autoload -Uz +X compinit && compinit
+    autoload -Uz +X bashcompinit && bashcompinit
+
+## OPTIONS
+
+`--print`
+: Prints the shell completion file.
+
+`--install`
+: Installs the shell completion file.
+
+`--uninstall`
+: Uninstalls the shell completion file.
+
+`-h`, `--help`
+: Prints help information.
+
+## ENVIRONMENT
+
+*PREFIX*
+: Specifies the root prefix for the file system.
+
+*HOME*
+: Specifies the home directory of the user. Ronin will search for the
+  `~/.cache/ronin-db` cache directory within the home directory.
+
+*XDG_DATA_HOME*
+: Specifies the data directory to use. Defaults to `$HOME/.local/share`.
+
+## FILES
+
+`~/.local/share/bash-completion/completions/`
+: The user-local installation directory for Bash completion files.
+
+`/usr/local/share/bash-completion/completions/`
+: The system-wide installation directory for Bash completions files.
+
+`/usr/local/share/zsh/site-functions/`
+: The installation directory for Zsh completion files.
+
+## EXAMPLES
+
+`ronin-db completion --print`
+: Prints the shell completion rules instead of installing them.
+
+`ronin-db completion --install`
+: Installs the shell completion rules for `ronin-db`.
+
+`ronin-db completion --uninstall`
+: Uninstalls the shell completion rules for `ronin-db`.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+

data/man/ronin-db-creds.1

@@ -1,96 +1,78 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
-.TH ronin-db-creds 1 "2023-01-02" Ronin "User Manuals"
-.LP
+.TH ronin-db-creds 1 "2023-01-02" Ronin DB "User Manuals"
+.SH NAME
+.PP
+ronin\-db\-creds \- Manages all credentials in the database
 .SH SYNOPSIS
-.LP
-.HP
-\fBronin-db creds\fR \[lB]\fIoptions\fP\[rB]
-.LP
+.PP
+\fBronin\-db creds\fR \[lB]\fIoptions\fP\[rB]
 .SH DESCRIPTION
-.LP
 .PP
 Manages credentials\.
-.LP
 .SH OPTIONS
-.LP
 .TP
-\fB--db\fR \fINAME\fP
+\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
+\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
-.LP
+.RE
+.TP
+\fB\-\-db\-file\fR \fIPATH\fP
+The sqlite3 database file to use\.
 .TP
-\fB-v\fR, \fB--verbose\fR
+\fB\-v\fR, \fB\-\-verbose\fR
 Enable verbose output\.
-.LP
 .TP
-\fB--add\fR \fIUSER\fP:\fIPASSWORD\fP
+\fB\-\-add\fR \fIUSER\fP:\fIPASSWORD\fP
 Adds the \fIUSER\fP and \fIPASSWORD\fP to the database\.
-.LP
 .TP
-\fB--import\fR \fIFILE\fP
+\fB\-\-import\fR \fIFILE\fP
 Imports the credentials from the given \fIFILE\fP\.
-.LP
 .TP
-\fB--delete\fR \fIVALUE\fP
+\fB\-\-delete\fR \fIVALUE\fP
 Deletes a credential value from the database\.
-.LP
 .TP
-\fB--delete-all\fR
+\fB\-\-delete\-all\fR
 Deletes every credential from the database\.
-.LP
 .TP
-\fB-u\fR, \fB--for-user\fR \fIUSER\fP
+\fB\-u\fR, \fB\-\-for\-user\fR \fIUSER\fP
 Searches for credentials associated with the \fIUSER\fP\.
-.LP
 .TP
-\fB-p\fR, \fB--with-password\fR \fIPASSWORD\fP
+\fB\-p\fR, \fB\-\-with\-password\fR \fIPASSWORD\fP
 Searches for credentials that have the \fIPASSWORD\fP\.
-.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-creds.1.md

@@ -1,4 +1,8 @@
-# ronin-db-creds 1 "2023-01-02" Ronin "User Manuals"
+# ronin-db-creds 1 "2023-01-02" Ronin DB "User Manuals"
+
+## NAME
+
+ronin-db-creds - Manages all credentials in the database
 
 ## SYNOPSIS
 
@@ -11,57 +15,60 @@ Manages credentials.
 ## OPTIONS
 
 `--db` *NAME*
-  The database to connect to. Defaults to `default` if not given.
+: The database 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`
-	Enable verbose output.
+: Enable verbose output.
 
 `--add` *USER*:*PASSWORD*
-  Adds the *USER* and *PASSWORD* to the database.
+: Adds the *USER* and *PASSWORD* to the database.
 
 `--import` *FILE*
-  Imports the credentials from the given *FILE*.
+: Imports the credentials from the given *FILE*.
 
 `--delete` *VALUE*
-  Deletes a credential value from the database.
+: Deletes a credential value from the database.
 
 `--delete-all`
-  Deletes every credential from the database.
+: Deletes every credential from the database.
 
 `-u`, `--for-user` *USER*
-	Searches for credentials associated with the *USER*.
+: Searches for credentials associated with the *USER*.
 
 `-p`, `--with-password` *PASSWORD*
-	Searches for credentials that have the *PASSWORD*.
+: Searches for credentials that have the *PASSWORD*.
 
 `-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-edit.1

@@ -1,55 +1,44 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-db-edit 1 "2023-02-01" Ronin DB "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-db\-edit \- Manually edits the database\.yml configuration file
 .SH SYNOPSIS
-.LP
-.HP
-\fBronin-db edit\fR \[lB]\fIoptions\fP\[rB]
-.LP
+.PP
+\fBronin\-db edit\fR \[lB]\fIoptions\fP\[rB]
 .SH DESCRIPTION
-.LP
 .PP
-Manually edits the \fB~/.config/ronin-db/database.yml\fR configuration file\.
-.LP
+Manually edits the \fB\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fR configuration file\.
 .SH OPTIONS
-.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
 .SH SEE ALSO
-.LP
 .PP
-ronin\-db(1) ronin\-db\-add(1) ronin\-db\-list(1) ronin\-db\-remove(1)
+.BR ronin\-db (1)
+.BR ronin\-db\-add (1)
+.BR ronin\-db\-list (1)
+.BR ronin\-db\-remove (1)

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

@@ -1,5 +1,9 @@
 # ronin-db-edit 1 "2023-02-01" Ronin DB "User Manuals"
 
+## NAME
+
+ronin-db-edit - Manually edits the database.yml configuration file
+
 ## SYNOPSIS
 
 `ronin-db edit` [*options*]
@@ -11,26 +15,26 @@ Manually edits the `~/.config/ronin-db/database.yml` configuration file.
 ## OPTIONS
 
 `-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
 
@@ -38,4 +42,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-db(1) ronin-db-add(1) ronin-db-list(1) ronin-db-remove(1)
+[ronin-db](ronin-db.1.md) [ronin-db-add](ronin-db-add.1.md) [ronin-db-list](ronin-db-list.1.md) [ronin-db-remove](ronin-db-remove.1.md)