ronin-db 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d310dd9211968ccd20e1f7f7962673217fac978bb9d1698a443db713196be894
-  data.tar.gz: a279d215f78d2e40d04a2ff6519537ed275be707d1adeba2450bbe805a688009
+  metadata.gz: eb843bad7ea3acbc3e60ab034a6a7eae3d89b95433a46e80ee92c49d38a0d7e1
+  data.tar.gz: 37af4e6642c8a551df6b83547ae96c642359c3e3964e0bae173cbd9bf7d34e39
 SHA512:
-  metadata.gz: 73778356b09c0ec1f7ff37f7faba38c64c46d23d5b44aeed49a78248bd5c72794e2057a690c1bacdced48d522f2cdec4dc65b628e64580dc0a9d640d5a6968c6
-  data.tar.gz: 18edf72f11d0748f17b4a8f18541fdcdc45b541053231cbf3b75c40f5dbb68a8a943e19654b8081a28b5d3348c9772304ead95f38810825fc448e5ed6ceb442b
+  metadata.gz: 1480524a5b1356e1206f1a24dc928faf9c37e7b54109949180626dd5be4bd0b32e93f36a3b3527a9fe6f9ed70d3699ab94bd50c1fcf38f185ef1359afac734e6
+  data.tar.gz: 8a02d484ff3620a7165940d5eb77b5815f57571768c6353aaffdba5358700ea9114f629f42918a97d70938b77a5bd9547ac6851e7fd875be2136b4c92c44d77c

data/.document

@@ -2,4 +2,3 @@ lib/**/*.rb
 - 
 ChangeLog.md
 COPYING.txt
-man/*.md

data/ChangeLog.md

@@ -1,3 +1,8 @@
+### 0.1.2 / 2023-09-19
+
+* Fixed a typo in an exception message in {Ronin::DB.connect}.
+* Documentation fixes and improvements.
+
 ### 0.1.1 / 2023-06-09
 
 #### CLI

data/README.md

@@ -9,7 +9,6 @@
 * [Issues](https://github.com/ronin-rb/ronin-db/issues)
 * [Documentation](https://ronin-rb.dev/docs/ronin-db/frames)
 * [Discord](https://discord.gg/6WAb3PsVX9) |
-  [Twitter](https://twitter.com/ronin_rb) |
   [Mastodon](https://infosec.exchange/@ronin_rb)
 
 ## Description

data/lib/ronin/db/cli/commands/creds.rb

@@ -26,11 +26,11 @@ module Ronin
     class CLI
       module Commands
         #
-        # Queries all credentials in the database.
+        # Manages all credentials in the database.
         #
         # ## Usage
         #
-        #     ronin creds [options]
+        #     ronin-db creds [options]
         #
         # ## Options
         #
@@ -41,8 +41,8 @@ module Ronin
         #         --import FILE                Imports the values from the FILE into the database
         #         --delete VALUE               Deletes a value from the database
         #         --delete-all                 Deletes all values from the database
-        #     -u, --user [USER]                Username to search for.
-        #     -p, --password [PASS]            Password to search for.
+        #     -u, --for-user USER              Username to search for
+        #     -p, --with-password PASSWORD     Password to search for
         #
         class Creds < ModelCommand
 
@@ -51,25 +51,25 @@ module Ronin
           model_file 'ronin/db/credential'
           model_name 'Credential'
 
-          option :user, short: '-u',
-                        value: {
-                          type:  String,
-                          usage: 'USER'
-                        },
-                        desc: 'Username to search for' do |user|
-                          @query_method_calls << [:for_user, [user]]
-                        end
-
-          option :password, short: '-P',
+          option :for_user, short: '-u',
                             value: {
                               type:  String,
-                              usage: 'PASSWORD'
+                              usage: 'USER'
                             },
-                            desc: 'Password to search for' do |password|
-                              @query_method_calls << [:with_password, [password]]
+                            desc: 'Username to search for' do |user|
+                              @query_method_calls << [:for_user, [user]]
                             end
 
-          description 'Queries all credentials in the database'
+          option :with_password, short: '-P',
+                                 value: {
+                                   type:  String,
+                                   usage: 'PASSWORD'
+                                 },
+                                 desc: 'Password to search for' do |password|
+                                   @query_method_calls << [:with_password, [password]]
+                                 end
+
+          description 'Manages all credentials in the database'
 
           man_page 'ronin-db-creds.1'
 

data/lib/ronin/db/version.rb

@@ -21,6 +21,6 @@
 module Ronin
   module DB
     # ronin-db version
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end
 end

data/lib/ronin/db.rb

@@ -86,8 +86,10 @@ module Ronin
     #   Specifies whether to load all models or just connect to the database.
     #
     # @raise [UnknownDatabase]
+    #   The database name was not listed in the config file.
     #
     # @raise [ArgumentError]
+    #   The given database was not a Symbol or a Hash.
     #
     # @api semipublic
     #
@@ -100,7 +102,7 @@ module Ronin
                    raise(UnknownDatabase,"unknown database: #{database.inspect}")
                  end
                else
-                 raise(ArgumentError,"#{self.class}.#{__method__} only accepts a Symbol or a Hash")
+                 raise(ArgumentError,"#{self}.#{__method__} only accepts a Symbol or a Hash")
                end
 
       # load activerecord

data/man/ronin-db-asn.1

@@ -20,8 +20,16 @@ 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)\.
+The explicit database URI to connect to\.
+.LP
+.RS
+.IP \(bu 2
+\fBsqlite3\fP: \fBsqlite3:relative/path.db\fR or \fBsqlite3:///absolute/path.db\fR
+.IP \(bu 2
+\fBmysql\fP: \fBmysql://user:password@host/database\fR
+.IP \(bu 2
+\fBpostgres\fP: \fBpostgres://user:password@host/database\fR
+.RE
 .LP
 .TP
 \fB-v\fR, \fB--verbose\fR

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

@@ -14,8 +14,11 @@ Queries or updates Autonomous System Numbers (ASNs) in the database.
   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`).
+  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`
 
 `-v`, `--verbose`
   Enables verbose output

data/man/ronin-db-creds.1

@@ -20,8 +20,16 @@ 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)\.
+The explicit database URI to connect to\.
+.LP
+.RS
+.IP \(bu 2
+\fBsqlite3\fP: \fBsqlite3:relative/path.db\fR or \fBsqlite3:///absolute/path.db\fR
+.IP \(bu 2
+\fBmysql\fP: \fBmysql://user:password@host/database\fR
+.IP \(bu 2
+\fBpostgres\fP: \fBpostgres://user:password@host/database\fR
+.RE
 .LP
 .TP
 \fB-v\fR, \fB--verbose\fR
@@ -45,11 +53,15 @@ Deletes every credential from the database\.
 .LP
 .TP
 \fB-u\fR, \fB--for-user\fR \fIUSER\fP
-Searches for credentials associated with the USER\.
+Searches for credentials associated with the \fIUSER\fP\.
 .LP
 .TP
 \fB-p\fR, \fB--with-password\fR \fIPASSWORD\fP
-Searches for credentials that have the PASSWORD\.
+Searches for credentials that have the \fIPASSWORD\fP\.
+.LP
+.TP
+\fB-h\fR, \fB--help\fR
+Print help information\.
 .LP
 .SH ENVIRONMENT
 .LP

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

@@ -14,8 +14,11 @@ Manages credentials.
   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`).
+  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`
 
 `-v`, `--verbose`
 	Enable verbose output.
@@ -33,10 +36,13 @@ Manages credentials.
   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.
 
 ## ENVIRONMENT
 

data/man/ronin-db-emails.1

@@ -20,8 +20,16 @@ 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)\.
+The explicit database URI to connect to\.
+.LP
+.RS
+.IP \(bu 2
+\fBsqlite3\fP: \fBsqlite3:relative/path.db\fR or \fBsqlite3:///absolute/path.db\fR
+.IP \(bu 2
+\fBmysql\fP: \fBmysql://user:password@host/database\fR
+.IP \(bu 2
+\fBpostgres\fP: \fBpostgres://user:password@host/database\fR
+.RE
 .LP
 .TP
 \fB-v\fR, \fB--verbose\fR
@@ -55,6 +63,10 @@ Searches for email addresses associated with the IP address\.
 \fB-u\fR, \fB--with-users\fR \fINAME\fP \[lB]\.\.\.\[rB]
 Searches for email addresses associated with the user NAME(s)\.
 .LP
+.TP
+\fB-h\fR, \fB--help\fR
+Print help information\.
+.LP
 .SH ENVIRONMENT
 .LP
 .TP

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

@@ -14,8 +14,11 @@ Manages email addresses.
   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`).
+  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`
 
 `-v`, `--verbose`
 	Enable verbose output.
@@ -41,6 +44,9 @@ Manages email addresses.
 `-u`, `--with-users` *NAME* [...]
 	Searches for email addresses associated with the user NAME(s).
 
+`-h`, `--help`
+  Print help information.
+
 ## ENVIRONMENT
 
 *HOME*

data/man/ronin-db-hosts.1

@@ -20,8 +20,16 @@ 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)\.
+The explicit database URI to connect to\.
+.LP
+.RS
+.IP \(bu 2
+\fBsqlite3\fP: \fBsqlite3:relative/path.db\fR or \fBsqlite3:///absolute/path.db\fR
+.IP \(bu 2
+\fBmysql\fP: \fBmysql://user:password@host/database\fR
+.IP \(bu 2
+\fBpostgres\fP: \fBpostgres://user:password@host/database\fR
+.RE
 .LP
 .TP
 \fB-v\fR, \fB--verbose\fR
@@ -59,6 +67,10 @@ Searches for HostNames belonging to the DOMAIN (\fBco.uk\fR)\.
 \fB-T\fR, \fB--tld\fR \fITLD\fP
 Searches for HostNames with the Top\-Level\-Domain (TLD) (\fBru\fR)\.
 .LP
+.TP
+\fB-h\fR, \fB--help\fR
+Print help information\.
+.LP
 .SH ENVIRONMENT
 .LP
 .TP

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

@@ -14,8 +14,11 @@ Manages host names.
   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`).
+  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`
 
 `-v`, `--verbose`
 	Enable verbose output.
@@ -44,6 +47,9 @@ Manages host names.
 `-T`, `--tld` *TLD*
 	Searches for HostNames with the Top-Level-Domain (TLD) (`ru`).
 
+`-h`, `--help`
+  Print help information.
+
 ## ENVIRONMENT
 
 *HOME*

data/man/ronin-db-ips.1

@@ -20,8 +20,16 @@ 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)\.
+The explicit database URI to connect to\.
+.LP
+.RS
+.IP \(bu 2
+\fBsqlite3\fP: \fBsqlite3:relative/path.db\fR or \fBsqlite3:///absolute/path.db\fR
+.IP \(bu 2
+\fBmysql\fP: \fBmysql://user:password@host/database\fR
+.IP \(bu 2
+\fBpostgres\fP: \fBpostgres://user:password@host/database\fR
+.RE
 .LP
 .TP
 \fB-v\fR, \fB--verbose\fR
@@ -63,6 +71,10 @@ Searches for IP addresses associated with the MAC address\.
 \fB-I\fR, \fB--with-host\fR \fIHOST\fP
 Searches for IP addresses associated with the \fIHOST\fP\.
 .LP
+.TP
+\fB-h\fR, \fB--help\fR
+Print help information\.
+.LP
 .SH ENVIRONMENT
 .LP
 .TP

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

@@ -14,8 +14,11 @@ Manages IP addresses.
   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`).
+  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`
 
 `-v`, `--verbose`
 	Enable verbose output.
@@ -47,6 +50,9 @@ Manages IP addresses.
 `-I`, `--with-host` *HOST*
 	Searches for IP addresses associated with the *HOST*.
 
+`-h`, `--help`
+  Print help information.
+
 ## ENVIRONMENT
 
 *HOME*

data/man/ronin-db-irb.1

@@ -23,6 +23,15 @@ specified\.
 \fB--db-uri\fR \fIURI\fP
 The database URI to connect to\.
 .LP
+.RS
+.IP \(bu 2
+\fBsqlite3\fP: \fBsqlite3:relative/path.db\fR or \fBsqlite3:///absolute/path.db\fR
+.IP \(bu 2
+\fBmysql\fP: \fBmysql://user:password@host/database\fR
+.IP \(bu 2
+\fBpostgres\fP: \fBpostgres://user:password@host/database\fR
+.RE
+.LP
 .TP
 \fB--no-connect\fR
 Causes the Ruby shell to not connect to a database on startup\.

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

@@ -17,6 +17,10 @@ Connects to a database and start an interactive Ruby shell.
 `--db-uri` *URI*
   The 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`
+
 `--no-connect`
   Causes the Ruby shell to not connect to a database on startup.
 

data/man/ronin-db-migrate.1

@@ -23,6 +23,15 @@ specified\.
 \fB--db-uri\fR \fIURI\fP
 The database URI to connect to\.
 .LP
+.RS
+.IP \(bu 2
+\fBsqlite3\fP: \fBsqlite3:relative/path.db\fR or \fBsqlite3:///absolute/path.db\fR
+.IP \(bu 2
+\fBmysql\fP: \fBmysql://user:password@host/database\fR
+.IP \(bu 2
+\fBpostgres\fP: \fBpostgres://user:password@host/database\fR
+.RE
+.LP
 .TP
 \fB--no-connect\fR
 Causes the Ruby shell to not connect to a database on startup\.

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

@@ -17,6 +17,10 @@ Runs database migrations.
 `--db-uri` *URI*
   The 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`
+
 `--no-connect`
   Causes the Ruby shell to not connect to a database on startup.
 

data/man/ronin-db-urls.1

@@ -20,8 +20,16 @@ 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)\.
+The explicit database URI to connect to\.
+.LP
+.RS
+.IP \(bu 2
+\fBsqlite3\fP: \fBsqlite3:relative/path.db\fR or \fBsqlite3:///absolute/path.db\fR
+.IP \(bu 2
+\fBmysql\fP: \fBmysql://user:password@host/database\fR
+.IP \(bu 2
+\fBpostgres\fP: \fBpostgres://user:password@host/database\fR
+.RE
 .LP
 .TP
 \fB-v\fR, \fB--verbose\fR
@@ -71,6 +79,10 @@ Searches for URLs containing the query\-param NAME\.
 \fB-Q\fR, \fB--with-query-value\fR \fIVALUE\fP \[lB]\.\.\.\[rB]
 Searches for URLs containing the query\-param VALUE\.
 .LP
+.TP
+\fB-h\fR, \fB--help\fR
+Print help information\.
+.LP
 .SH ENVIRONMENT
 .LP
 .TP

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

@@ -14,8 +14,11 @@ Manages URLs.
   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`).
+  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`
 
 `-v`, `--verbose`
 	Enable verbose output.
@@ -53,6 +56,9 @@ Manages URLs.
 `-Q`, `--with-query-value` *VALUE* [...]
 	Searches for URLs containing the query-param VALUE.
 
+`-h`, `--help`
+  Print help information.
+
 ## ENVIRONMENT
 
 *HOME*

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ronin-db
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-09 00:00:00.000000000 Z
+date: 2023-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3