ronin-db 0.1.0-java → 0.1.2-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a1e34813d6e31800174b9bf80798e088fcf8c0cc26f49f480d28f5ab38c31a7
-  data.tar.gz: e977959fce2b57e7563bf037d431ba9ed2a16cf4d7c8b4da04bb606fab80b62d
+  metadata.gz: 5e20fde641f025149b699e70299af69f99289adf64e968fee91a49f9caf33ac1
+  data.tar.gz: b7b02264509ad9800f61320bc3a8042c34a7e9552e4c658c4d8d1c5a34dfac96
 SHA512:
-  metadata.gz: da55ca64bf9f4a57972a7f657490b808ac77de8cc5b9dc5014942dd7a6be37bed29f2f9340520f4b4cf0068ed592cae87e340ee085a3772a8418a151fa12c083
-  data.tar.gz: 752ec88041d604d14106bd14086cf3ca995621b58cbeb94fbe1a09f3ae52a481da96a7b056c72eb652971faac361580b294552db03ddaaff881bced2924722e7
+  metadata.gz: c83dc934afed20756221f7b54336c30e957e6a9849a5846bec7d068a81e1cf4a68c5bb098a57096bbba912da9353d9a2d9690374f1de024e38e71c2d420856cc
+  data.tar.gz: 1f62303657c9c113a2a4b14ce16e4f3849fb2f6f475757164e81b29cd431d9fa6ec43b6ad2e08737e14f40bf034036ff85bc06766a5a0cf126f3dea53e051232

data/.document

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

data/.github/workflows/ruby.yml

@@ -30,3 +30,17 @@ jobs:
         run: bundle install --jobs 4 --retry 3
       - name: Run tests
         run: bundle exec rake test
+
+  # rubocop linting
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      - name: Run rubocop
+        run: bundle exec rubocop --parallel

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 3.1
+
+inherit_gem:
+  rubocop-ronin: rubocop.yml
+
+#
+# ronin-db specific exceptions
+#
+
+# This looks like a rubocop bug.
+Lint/ShadowingOuterLocalVariable:
+  Exclude:
+    - 'lib/ronin/db/cli/commands/list.rb'

data/ChangeLog.md

@@ -1,4 +1,17 @@
-### 0.1.0 / 2023-XX-XX
+### 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
+
+* Fixed typos in the `ronin-db add` man-page.
+* Fixed typos in the `ronin-db creds` man-page.
+* Fixed formatting of man-pages.
+
+### 0.1.0 / 2023-02-01
 
 * Initial release:
   * Uses a [sqlite] database by default.

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
@@ -8,11 +10,11 @@ gem 'jruby-openssl',	'~> 0.7', platform: :jruby
 #                             branch: 'main'
 
 # Library dependencies
-# gem 'ronin-db-activerecord', '~> 0.1', github: "ronin-rb/ronin-db-activerecord",
+# gem 'ronin-db-activerecord', '~> 0.1', github: 'ronin-rb/ronin-db-activerecord',
 #                                        branch: 'main'
-# gem 'ronin-support',	       '~> 1.0', github: "ronin-rb/ronin-support",
+# gem 'ronin-support',	       '~> 1.0', github: 'ronin-rb/ronin-support',
 #                                        branch: '1.0.0'
-# gem 'ronin-core',	           '~> 0.1', github: "ronin-rb/ronin-core",
+# gem 'ronin-core',	           '~> 0.1', github: 'ronin-rb/ronin-core',
 #                                        branch: 'main'
 
 group :development do
@@ -31,4 +33,6 @@ group :development do
   gem 'dead_end',        require: false
   gem 'sord',            require: false, platform: :mri
   gem 'stackprof',       require: false, platform: :mri
+  gem 'rubocop',         require: false, platform: :mri
+  gem 'rubocop-ronin',   require: false, platform: :mri
 end

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/Rakefile

@@ -1,11 +1,11 @@
-require 'rubygems'
+# frozen_string_literal: true
 
 begin
   require 'bundler'
 rescue LoadError => e
   warn e.message
   warn "Run `gem install bundler` to install Bundler"
-  exit -1
+  exit(-1)
 end
 
 begin
@@ -35,7 +35,6 @@ task :docs => :yara
 require 'kramdown/man/task'
 Kramdown::Man::Task.new
 
-
 directory 'db'
 file 'db/dev.sqlite3' => %w[db db:migrate]
 

data/bin/ronin-db

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 #
 # Copyright (c) 2021 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
@@ -21,13 +22,11 @@
 root = File.expand_path(File.join(__dir__,'..'))
 if File.file?(File.join(root,'Gemfile.lock'))
   Dir.chdir(root) do
-    begin
-      require 'bundler/setup'
-    rescue LoadError => e
-      warn e.message
-      warn "Run `gem install bundler` to install Bundler"
-      exit -1
-    end
+    require 'bundler/setup'
+  rescue LoadError => e
+    warn e.message
+    warn "Run `gem install bundler` to install Bundler"
+    exit(-1)
   end
 end
 

data/lib/ronin/db/cli/command.rb

@@ -25,6 +25,9 @@ require 'ronin/core/cli/command'
 module Ronin
   module DB
     class CLI
+      #
+      # Base class for all `ronin-db` commands.
+      #
       class Command < Core::CLI::Command
 
         man_dir File.join(ROOT,'man')

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

@@ -61,7 +61,7 @@ module Ronin
 
           option :number, short: '-n',
                           value: {
-                            type: Integer,
+                            type: Integer
                           },
                           desc: 'Searches for all ASN records with the AS number' do |number|
                             @query_method_calls << [:with_number, [number]]

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/cli/commands/migrate.rb

@@ -37,7 +37,7 @@ module Ronin
         #         --db NAME                    The database to connect to (Default: default)
         #         --db-uri URI                 The database URI to connect to
         #     -h, --help                       Print help information
-        # 
+        #
         class Migrate < DatabaseCommand
 
           usage '[options]'

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

@@ -122,7 +122,7 @@ module Ronin
           option :query_string, short: '-q',
                                 value: {
                                   type:  String,
-                                  usage: 'STRING',
+                                  usage: 'STRING'
                                 },
                                 desc: 'Searches for all URLs with the query string' do |string|
                                   @query_method_calls << [:where, [], {query: string}]
@@ -136,11 +136,11 @@ module Ronin
                                     desc: 'Searches for the associated query-param NAME(s)' do |string|
                                       name, value = string.split('=',2)
 
-                                      if value
-                                        @query_method_calls << [:with_query_param, [name, value]]
-                                      else
-                                        @query_method_calls << [:with_query_param_name, [name]]
-                                      end
+                                      @query_method_calls << if value
+                                                               [:with_query_param, [name, value]]
+                                                             else
+                                                               [:with_query_param_name, [name]]
+                                                             end
                                     end
 
           option :with_query_param_name, value: {

data/lib/ronin/db/cli/resources_command.rb

@@ -60,8 +60,6 @@ module Ronin
           end
         end
 
-        protected
-
         #
         # Sets the model used by the command.
         #

data/lib/ronin/db/cli/uri_methods.rb

@@ -24,6 +24,10 @@ require 'ronin/db'
 module Ronin
   module DB
     class CLI
+      #
+      # Mixin which adds methods for parsing database URIs
+      # (ex: `sqlite3:path/to/db.sqlite3`).
+      #
       module URIMethods
         # Common database adapter names and their ActiveRecord equivalents.
         ADAPTER_ALIASES = {
@@ -57,8 +61,8 @@ module Ronin
         #   The expanded path or `":memory:"` if the path was `":memory:"`.
         #
         def normalize_sqlite3_path(path)
-          if path== ':memory:' then path
-          else                      File.expand_path(path)
+          if path == ':memory:' then path
+          else                       File.expand_path(path)
           end
         end
 
@@ -72,7 +76,7 @@ module Ronin
         #   The database configuration Hash.
         #
         def parse_uri(uri)
-          if (match = uri.match(/\Asqlite[3]?:(.+)\z/))
+          if (match = uri.match(/\Asqlite(?:3)?:(.+)\z/))
             {
               adapter: 'sqlite3',
               database: normalize_sqlite3_path(match[1])
@@ -82,6 +86,7 @@ module Ronin
             adapter = normalize_adapter(uri.scheme)
 
             hash = {adapter: adapter}
+
             hash[:host]     = uri.host if uri.host
             hash[:port]     = uri.port if uri.port
             hash[:username] = uri.user if uri.user

data/lib/ronin/db/cli.rb

@@ -26,6 +26,11 @@ require 'command_kit/options/version'
 
 module Ronin
   module DB
+    #
+    # The `ronin-db` command-line interface (CLI).
+    #
+    # @api private
+    #
     class CLI
 
       include CommandKit::Commands

data/lib/ronin/db/config_file.rb

@@ -35,7 +35,8 @@ module Ronin
       # Path to the `~/.config/ronin-db/databases.yml` configuration file.
       PATH = File.join(DB::Home::CONFIG_DIR,'databases.yml')
 
-      # Path to the default sqlite3 database file.
+      # Path to the default sqlite3 database file
+      # (`~/.local/share/ronin-db/default.sqlite3`).
       DEFAULT_DB_FILE = File.join(DB::Home::LOCAL_SHARE_DIR,'default.sqlite3')
 
       # Default database configuration.

data/lib/ronin/db/version.rb

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

data/lib/ronin/db.rb

@@ -23,6 +23,9 @@ require 'ronin/db/config_file'
 require 'ronin/db/version'
 
 module Ronin
+  #
+  # Manages the Ronin database.
+  #
   module DB
     #
     # Sets up the Database logger.
@@ -83,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
     #
@@ -97,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-add.1

@@ -1,6 +1,6 @@
 .\" Generated by kramdown-man 0.1.8
 .\" https://github.com/postmodern/kramdown-man#readme
-.TH ronin-db-add 1 "2022-01-01" Ronin DB "User Manuals"
+.TH ronin-db-add 1 "2023-02-01" Ronin DB "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
@@ -10,7 +10,8 @@
 .SH DESCRIPTION
 .LP
 .PP
-Lists entries in the \fB~/.config/ronin-db/database.yml\fR configuration file\.
+Adds a pre\-existing database to the \fB~/.config/ronin-db/database.yml\fR
+configuration file\.
 .LP
 .SH ARGUMENTS
 .LP
@@ -69,22 +70,52 @@ may be given instead\.
 \fB-h\fR, \fB--help\fR
 Print help information\.
 .LP
-.SH FILES
+.SH EXAMPLES
 .LP
-.TP
-\fI\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fP
-The \fBronin-db\fR database(s) configuration file\.
+.PP
+Add a sqlite3 database file:
 .LP
-.SH ENVIRONMENT
+.nf
+    \[Do] ronin\-db add other\[ru]db \-\-sqlite3 path\[sl]to\[sl]db\.sqlite3
+.fi
 .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\.
+Add a PostgeSQL database:
+.LP
+.nf
+    \[Do] ronin\-db add other\[ru]db \-\-postgres \-\-host example\.com \-\-port 5432 \-\-username ronin \-\-password s3r3t \-\-database ronin\[ru]db
+.fi
 .LP
 .PP
-XDG\[ru]CONFIG\[ru]HOME
-Specifies the cache directory to use\. Defaults to \fI\[Do]HOME\[sl]\.config\fP\.
+Add a MySQL database:
+.LP
+.nf
+    \[Do] ronin\-db add other\[ru]db \-\-mysql2 \-\-host example\.com \-\-port 3306 \-\-username ronin \-\-password s3r3t \-\-database ronin\[ru]db
+.fi
+.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
+.TP
+\fIXDG\[ru]DATA\[ru]HOME\fP
+Alternate location for the \fB~/.local/share\fR directory\.
+.LP
+.SH FILES
+.LP
+.TP
+\fB~/.local/share/ronin-db/database.sqlite3\fR
+The default sqlite3 database file\.
+.LP
+.TP
+\fB~/.config/ronin-db/database.yml\fR
+Optional database configuration\.
 .LP
 .SH AUTHOR
 .LP

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

@@ -1,4 +1,4 @@
-# ronin-db-add 1 "2022-01-01" Ronin DB "User Manuals"
+# ronin-db-add 1 "2023-02-01" Ronin DB "User Manuals"
 
 ## SYNOPSIS
 
@@ -6,7 +6,8 @@
 
 ## DESCRIPTION
 
-Lists entries in the `~/.config/ronin-db/database.yml` configuration file.
+Adds a pre-existing database to the `~/.config/ronin-db/database.yml`
+configuration file.
 
 ## ARGUMENTS
 
@@ -52,19 +53,38 @@ Lists entries in the `~/.config/ronin-db/database.yml` configuration file.
 `-h`, `--help`
   Print help information.
 
-## FILES
+## EXAMPLES
+
+Add a sqlite3 database file:
+
+        $ 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
+
+Add a MySQL database:
 
-*~/.config/ronin-db/database.yml*
-	The `ronin-db` database(s) configuration file.
+        $ ronin-db add other_db --mysql2 --host example.com --port 3306 --username ronin --password s3r3t --database ronin_db
 
 ## ENVIRONMENT
 
-HOME
-	Specifies the home directory of the user. Ronin will search for the
-	*~/.config/ronin-db* cache directory within the home directory.
+*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.
 
-XDG_CONFIG_HOME
-  Specifies the cache directory to use. Defaults to *$HOME/.config*.
+`~/.config/ronin-db/database.yml`
+  Optional database configuration.
 
 ## AUTHOR
 

data/man/ronin-db-asn.1

@@ -1,6 +1,6 @@
 .\" Generated by kramdown-man 0.1.8
 .\" https://github.com/postmodern/kramdown-man#readme
-.TH ronin-db-asn 1 "April 2012" Ronin "User Manuals"
+.TH ronin-db-asn 1 "2023-02-01" Ronin "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
@@ -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
@@ -70,6 +78,30 @@ if not given\.
 \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
+.TP
+\fIXDG\[ru]DATA\[ru]HOME\fP
+Alternate location for the \fB~/.local/share\fR directory\.
+.LP
+.SH FILES
+.LP
+.TP
+\fB~/.local/share/ronin-db/database.sqlite3\fR
+The default sqlite3 database file\.
+.LP
+.TP
+\fB~/.config/ronin-db/database.yml\fR
+Optional database configuration\.
+.LP
 .SH AUTHOR
 .LP
 .PP

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

@@ -1,4 +1,4 @@
-# ronin-db-asn 1 "April 2012" Ronin "User Manuals"
+# ronin-db-asn 1 "2023-02-01" Ronin "User Manuals"
 
 ## SYNOPSIS
 
@@ -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
@@ -53,6 +56,25 @@ Queries or updates Autonomous System Numbers (ASNs) in the database.
 `-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>