ronin-db 0.1.3-java → 0.2.0.rc1-java

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

@@ -1,4 +1,8 @@
-# ronin-db-urls 1 "2023-02-01" Ronin "User Manuals"
+# ronin-db-urls 1 "2023-02-01" Ronin DB "User Manuals"
+
+## NAME
+
+ronin-db-urls - Manages URLs in the database
 
 ## SYNOPSIS
 
@@ -11,72 +15,75 @@ Manages URLs.
 ## 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` *VALUE*
-  Adds the URL to the database.
+: Adds the URL to the database.
 
 `--import` *FILE*
-  Imports the URLs from the given *FILE*.
+: Imports the URLs from the given *FILE*.
 
 `--delete` *VALUE*
-  Deletes the URL from the database.
+: Deletes the URL from the database.
 
 `--delete-all`
-  Deletes every URL from the database.
+: Deletes every URL from the database.
 
 `--http`
-	Searches for `http://` URLs.
+: Searches for `http://` URLs.
 
 `--https`
-	Searches for `https://` URLs.
+: Searches for `https://` URLs.
 
 `-H`, `--host` *HOST*
-	Searches for URLs with the given *HOST*.
+: Searches for URLs with the given *HOST*.
 
 `-p`, `--with-port` *PORT*
-	Searches for URLs associated with the *PORT*.
+: Searches for URLs associated with the *PORT*.
 
 `-d`, `--directory` *DIRECTORY*
-	Searches for URLs sharing the DIRECTORY.
+: Searches for URLs sharing the DIRECTORY.
 
 `-q`, `--with-query-param` *NAME* [...]
-	Searches for URLs containing the query-param NAME.
+: Searches for URLs containing the query-param NAME.
 
 `-Q`, `--with-query-value` *VALUE* [...]
-	Searches for URLs containing the query-param VALUE.
+: Searches for URLs containing the query-param VALUE.
 
 `-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-web-vulns.1

@@ -0,0 +1,87 @@
+.\" Generated by kramdown-man 1.0.1
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-db-web-vulns 1 "2024-01-01" Ronin DB "User Manuals"
+.SH NAME
+.PP
+ronin\-db\-web\-vulns \- Manages Web Vulns in the database
+.SH SYNOPSIS
+.PP
+\fBronin\-db urls\fR \[lB]\fIoptions\fP\[rB]
+.SH DESCRIPTION
+.PP
+Manages and queries discovered Web Vulnerabilities in the database\.
+.SH OPTIONS
+.TP
+\fB\-\-db\fR \fINAME\fP
+The database 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
+Enable verbose output\.
+.TP
+\fB\-t\fR, \fB\-\-with\-type\fR \fBlfi\fR\[or]\fBrfi\fR\[or]\fBsqli\fR\[or]\fBssti\fR\[or]\fBopen\-redirect\fR\[or]\fBreflected\-xss\fR\[or]\fBcommand\-injection\fR
+Searches for all web vulnerabilities of the given type\.
+.TP
+\fB\-H\fR, \fB\-\-for\-host\fR \fIHOST\fP
+Searches for web vulnerabilities effecting the host\.
+.TP
+\fB\-d\fR, \fB\-\-for\-domain\fR \fIDOMAIN\fP
+Searches for web vulnerabilities effecting the domain\.
+.TP
+\fB\-p\fR, \fB\-\-for\-path\fR \fIPATH\fP
+Searches for web vulnerabilities effecting the given URL\[cq]s path\.
+.TP
+\fB\-q\fR, \fB\-\-with\-query\-param\fR \fINAME\fP
+Searches for web vulnerabilities effecting the query param name\.
+.TP
+\fB\-\-with\-header\-name\fR \fINAME\fP
+Searches for web vulnerabilities effecting the HTTP header name\.
+.TP
+\fB\-c\fR, \fB\-\-with\-cookie\-param\fR \fINAME\fP
+Searches for web vulnerabilities effecting the cookie param name\.
+.TP
+\fB\-f\fR, \fB\-\-with\-form\-param\fR \fINAME\fP
+Searches for web vulnerabilities effecting the form param name\.
+.TP
+\fB\-M\fR, \fB\-\-with\-request\-method\fR \fIHTTP\[ru]METHOD\fP
+Searches for all web vulnerabilities with the HTTP request method\.
+.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-web-vulns.1.md

@@ -0,0 +1,85 @@
+# ronin-db-web-vulns 1 "2024-01-01" Ronin DB "User Manuals"
+
+## NAME
+
+ronin-db-web-vulns - Manages Web Vulns in the database
+
+## SYNOPSIS
+
+`ronin-db urls` [*options*]
+
+## DESCRIPTION
+
+Manages and queries discovered Web Vulnerabilities in the database.
+
+## OPTIONS
+
+`--db` *NAME*
+: The database 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`
+: Enable verbose output.
+
+`-t`, `--with-type` `lfi`\|`rfi`\|`sqli`\|`ssti`\|`open-redirect`\|`reflected-xss`\|`command-injection`
+: Searches for all web vulnerabilities of the given type.
+
+`-H`, `--for-host` *HOST*
+: Searches for web vulnerabilities effecting the host.
+
+`-d`, `--for-domain` *DOMAIN*
+: Searches for web vulnerabilities effecting the domain.
+
+`-p`, `--for-path` *PATH*
+: Searches for web vulnerabilities effecting the given URL's path.
+
+`-q`, `--with-query-param` *NAME*
+: Searches for web vulnerabilities effecting the query param name.
+
+`--with-header-name` *NAME*
+: Searches for web vulnerabilities effecting the HTTP header name.
+
+`-c`, `--with-cookie-param` *NAME*
+: Searches for web vulnerabilities effecting the cookie param name.
+
+`-f`, `--with-form-param` *NAME*
+: Searches for web vulnerabilities effecting the form param name.
+
+`-M`, `--with-request-method` *HTTP_METHOD*
+: Searches for all web vulnerabilities with the HTTP request method.
+
+`-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.1

@@ -0,0 +1,118 @@
+.\" Generated by kramdown-man 1.0.1
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-db 1 "2023-02-01" Ronin DB "User Manuals"
+.SH NAME
+.PP
+ronin\-db \- manages ronin\[cq]s database(s)
+.SH SYNOPSIS
+.PP
+\fBronin\-db\fR \[lB]\fIoptions\fP\[rB] \[lB]\fICOMMAND\fP\[rB]
+.SH DESCRIPTION
+.PP
+The \fBronin\-db\fR provides commands for adding, removing, listing, databases,
+and querying, inserting, or deleting data from the various tables within a
+database\.
+.SH OPTIONS
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Prints help information\.
+.SH COMMANDS
+.TP
+\fBadd\fR
+Adds a pre\-existing database to ronin\-db\.
+.TP
+\fBasn\fR
+Queries and updates ASNs\.
+.TP
+\fBcerts\fR
+Queries or imports SSL\[sl]TLS certificates\.
+.TP
+\fBcompletion\fR
+Manages shell completion rules for the \fBronin\-db\fR command\.
+.TP
+\fBcreds\fR
+Manages all credentials in the database\.
+.TP
+\fBedit\fR
+Manually edits the \fBdatabase\.yml\fR configuration file\.
+.TP
+\fBemails\fR
+Manages all email addresses in the database\.
+.TP
+\fBhosts\fR
+Manages all host names in the database\.
+.TP
+\fBips\fR
+Manages IP addresses in the database\.
+.TP
+\fBirb\fR
+Connects to a database and start an interactive Ruby shell\.
+.TP
+\fBlist\fR
+List the configured database(s)\.
+.TP
+\fBmigrate\fR
+Runs database migrations\.
+.TP
+\fBopen\-ports\fR
+Queries open ports in the database\.
+.TP
+\fBoses\fR
+Queries OSes in the database
+.TP
+\fBpasswords\fR
+Manages all passwords in the database\.
+.TP
+\fBpeople\fR
+Queries people in the database\.
+.TP
+\fBphone\-numbers\fR
+Manages phone numbers in the database\.
+.TP
+\fBports\fR
+Manages port numbers in the database\.
+.TP
+\fBremove\fR
+Removes a database from the configuration file\.
+.TP
+\fBservices\fR
+Manages services in the database\.
+.TP
+\fBsoftware\fR
+Queries software in the database\.
+.TP
+\fBstreet\-addresses\fR
+Queries street addresses in the database\.
+.TP
+\fBurls\fR
+Manages URLs in the database\.
+.SH AUTHOR
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME
+.SH SEE ALSO
+.PP
+.BR ronin\-db\-add (1)
+.BR ronin\-db\-asn (1)
+.BR ronin\-db\-certs (1)
+.BR ronin\-db\-completion (1)
+.BR ronin\-db\-creds (1)
+.BR ronin\-db\-edit (1)
+.BR ronin\-db\-emails (1)
+.BR ronin\-db\-hosts (1)
+.BR ronin\-db\-ips (1)
+.BR ronin\-db\-irb (1)
+.BR ronin\-db\-list (1)
+.BR ronin\-db\-migrate (1)
+.BR ronin\-db\-open\-ports (1)
+.BR ronin\-db\-oses (1)
+.BR ronin\-db\-passwords (1)
+.BR ronin\-db\-people (1)
+.BR ronin\-db\-phone\-numbers (1)
+.BR ronin\-db\-ports (1)
+.BR ronin\-db\-remove (1)
+.BR ronin\-db\-services (1)
+.BR ronin\-db\-software (1)
+.BR ronin\-db\-street\-addresses (1)
+.BR ronin\-db\-urls (1)

data/man/ronin-db.1.md

@@ -0,0 +1,99 @@
+# ronin-db 1 "2023-02-01" Ronin DB "User Manuals"
+
+## NAME
+
+ronin-db - manages ronin's database(s)
+
+## SYNOPSIS
+
+`ronin-db` [*options*] [*COMMAND*]
+
+## DESCRIPTION
+
+The `ronin-db` provides commands for adding, removing, listing, databases,
+and querying, inserting, or deleting data from the various tables within a
+database.
+
+## OPTIONS
+
+`-h`, `--help`
+: Prints help information.
+
+## COMMANDS
+
+`add`
+: Adds a pre-existing database to ronin-db.
+
+`asn`
+: Queries and updates ASNs.
+
+`certs`
+: Queries or imports SSL/TLS certificates.
+
+`completion`
+: Manages shell completion rules for the `ronin-db` command.
+
+`creds`
+: Manages all credentials in the database.
+
+`edit`
+: Manually edits the `database.yml` configuration file.
+
+`emails`
+: Manages all email addresses in the database.
+
+`hosts`
+: Manages all host names in the database.
+
+`ips`
+: Manages IP addresses in the database.
+
+`irb`
+: Connects to a database and start an interactive Ruby shell.
+
+`list`
+: List the configured database(s).
+
+`migrate`
+: Runs database migrations.
+
+`open-ports`
+: Queries open ports in the database.
+
+`oses`
+: Queries OSes in the database
+
+`passwords`
+: Manages all passwords in the database.
+
+`people`
+: Queries people in the database.
+
+`phone-numbers`
+: Manages phone numbers in the database.
+
+`ports`
+: Manages port numbers in the database.
+
+`remove`
+: Removes a database from the configuration file.
+
+`services`
+: Manages services in the database.
+
+`software`
+: Queries software in the database.
+
+`street-addresses`
+: Queries street addresses in the database.
+
+`urls`
+: Manages URLs in the database.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+[ronin-db-add](ronin-db-add.1.md) [ronin-db-asn](ronin-db-asn.1.md) [ronin-db-certs](ronin-db-certs.1.md) [ronin-db-completion](ronin-db-completion.1.md) [ronin-db-creds](ronin-db-creds.1.md) [ronin-db-edit](ronin-db-edit.1.md) [ronin-db-emails](ronin-db-emails.1.md) [ronin-db-hosts](ronin-db-hosts.1.md) [ronin-db-ips](ronin-db-ips.1.md) [ronin-db-irb](ronin-db-irb.1.md) [ronin-db-list](ronin-db-list.1.md) [ronin-db-migrate](ronin-db-migrate.1.md) [ronin-db-open-ports](ronin-db-open-ports.1.md) [ronin-db-oses](ronin-db-oses.1.md) [ronin-db-passwords](ronin-db-passwords.1.md) [ronin-db-people](ronin-db-people.1.md) [ronin-db-phone-numbers](ronin-db-phone-numbers.1.md) [ronin-db-ports](ronin-db-ports.1.md) [ronin-db-remove](ronin-db-remove.1.md) [ronin-db-services](ronin-db-services.1.md) [ronin-db-software](ronin-db-software.1.md) [ronin-db-street-addresses](ronin-db-street-addresses.1.md) [ronin-db-urls](ronin-db-urls.1.md)

data/scripts/setup

@@ -0,0 +1,58 @@
+#!/usr/bin/env bash
+
+#
+# Prints a log message.
+#
+function log()
+{
+	if [[ -t 1 ]]; then
+		echo -e "\x1b[1m\x1b[32m>>>\x1b[0m \x1b[1m$1\x1b[0m"
+	else
+		echo ">>> $1"
+	fi
+}
+
+#
+# Prints a warn message.
+#
+function warn()
+{
+	if [[ -t 1 ]]; then
+		echo -e "\x1b[1m\x1b[33m***\x1b[0m \x1b[1m$1\x1b[0m" >&2
+	else
+		echo "*** $1" >&2
+	fi
+}
+
+#
+# Prints an error message.
+#
+function error()
+{
+	if [[ -t 1 ]]; then
+		echo -e "\x1b[1m\x1b[31m!!!\x1b[0m \x1b[1m$1\x1b[0m" >&2
+	else
+		echo "!!! $1" >&2
+	fi
+}
+
+#
+# Prints an error message and exists with -1.
+#
+function fail()
+{
+	error "$@"
+	exit -1
+}
+
+# default to installing gems into vendor/bundle
+if [[ ! -f .bundle/config ]]; then
+	bundle config set --local path vendor/bundle >/dev/null || \
+	  fail "Failed to run 'bundle config'"
+fi
+
+log "Installing gems ..."
+bundle install || fail "Failed to run 'bundle install'!"
+
+log "Setting up the project ..."
+bundle exec rake setup || "Failed to run 'rake setup'!"