ronin-db 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4b43b9a27235b5f27c1c8eac976121fb6d207fa5732ece4346c16eeea9e2614
-  data.tar.gz: 4a9bbb30e223ed07cc457e2f78e4a502aa1b2f9888903fb0f299389617a4cf52
+  metadata.gz: d310dd9211968ccd20e1f7f7962673217fac978bb9d1698a443db713196be894
+  data.tar.gz: a279d215f78d2e40d04a2ff6519537ed275be707d1adeba2450bbe805a688009
 SHA512:
-  metadata.gz: ccc855cd8baf3f69497d49cf553c2a1afec91bc0bbf2b7a0c6346740ad71da85a21b62449bd845e5f817317775c3fa254cf8e9adfa00782fac6b477c0e258a5a
-  data.tar.gz: 1ebfb16680d714807171106c3510ae4256573f7c7feca27937c76cf382fa91928e4a17e2ecaef276bd7befaed5977d84c12e25fd4dae4f1c19e0f6e62348e64c
+  metadata.gz: 73778356b09c0ec1f7ff37f7faba38c64c46d23d5b44aeed49a78248bd5c72794e2057a690c1bacdced48d522f2cdec4dc65b628e64580dc0a9d640d5a6968c6
+  data.tar.gz: 18edf72f11d0748f17b4a8f18541fdcdc45b541053231cbf3b75c40f5dbb68a8a943e19654b8081a28b5d3348c9772304ead95f38810825fc448e5ed6ceb442b

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,12 @@
-### 0.1.0 / 2023-XX-XX
+### 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/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/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.1'
   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.

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
@@ -70,6 +70,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
 
@@ -53,6 +53,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>

data/man/ronin-db-creds.1

@@ -1,6 +1,6 @@
 .\" Generated by kramdown-man 0.1.8
 .\" https://github.com/postmodern/kramdown-man#readme
-.TH ronin-db-creds 1 "April 2012" Ronin "User Manuals"
+.TH ronin-db-creds 1 "2023-01-02" Ronin "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
@@ -37,37 +37,43 @@ Imports the credentials from the given \fIFILE\fP\.
 .LP
 .TP
 \fB--delete\fR \fIVALUE\fP
-Deletes a value from the database\.
+Deletes a credential value from the database\.
 .LP
 .TP
 \fB--delete-all\fR
-Deletes every value from the database\.
+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 USER\.
 .LP
 .TP
 \fB-p\fR, \fB--with-password\fR \fIPASSWORD\fP
-Searches for Credentials that have the PASSWORD\.
+Searches for credentials that have the PASSWORD\.
 .LP
-.SH FILES
+.SH ENVIRONMENT
+.LP
+.TP
+\fIHOME\fP
+Alternate location for the user\[cq]s home directory\.
 .LP
 .TP
-\fI\[ti]\[sl]\.ronin\[sl]\fP
-Ronin configuration directory\.
+\fIXDG\[ru]CONFIG\[ru]HOME\fP
+Alternate location for the \fB~/.config\fR directory\.
 .LP
 .TP
-\fI\[ti]\[sl]\.ronin\[sl]database\.log\fP
-Database log\.
+\fIXDG\[ru]DATA\[ru]HOME\fP
+Alternate location for the \fB~/.local/share\fR directory\.
+.LP
+.SH FILES
 .LP
 .TP
-\fI\[ti]\[sl]\.ronin\[sl]database\.sqlite3\fP
-The default sqlite3 Database file\.
+\fB~/.local/share/ronin-db/database.sqlite3\fR
+The default sqlite3 database file\.
 .LP
 .TP
-\fI\[ti]\[sl]\.ronin\[sl]database\.yml\fP
-Optional Database configuration\.
+\fB~/.config/ronin-db/database.yml\fR
+Optional database configuration\.
 .LP
 .SH AUTHOR
 .LP

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

@@ -1,4 +1,4 @@
-# ronin-db-creds 1 "April 2012" Ronin "User Manuals"
+# ronin-db-creds 1 "2023-01-02" Ronin "User Manuals"
 
 ## SYNOPSIS
 
@@ -27,30 +27,35 @@ Manages credentials.
   Imports the credentials from the given *FILE*.
 
 `--delete` *VALUE*
-  Deletes a value from the database.
+  Deletes a credential value from the database.
 
 `--delete-all`
-  Deletes every value 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.
 
-## FILES
+## ENVIRONMENT
+
+*HOME*
+  Alternate location for the user's home directory.
 
-*~/.ronin/*
-	Ronin configuration directory.
+*XDG_CONFIG_HOME*
+  Alternate location for the `~/.config` directory.
 
-*~/.ronin/database.log*
-	Database log.
+*XDG_DATA_HOME*
+  Alternate location for the `~/.local/share` directory.
+
+## FILES
 
-*~/.ronin/database.sqlite3*
-	The default sqlite3 Database file.
+`~/.local/share/ronin-db/database.sqlite3`
+  The default sqlite3 database file.
 
-*~/.ronin/database.yml*
-	Optional Database configuration.
+`~/.config/ronin-db/database.yml`
+  Optional database configuration.
 
 ## AUTHOR
 

data/man/ronin-db-edit.1

@@ -1,6 +1,6 @@
 .\" Generated by kramdown-man 0.1.8
 .\" https://github.com/postmodern/kramdown-man#readme
-.TH ronin-db-edit 1 "2022-01-01" Ronin DB "User Manuals"
+.TH ronin-db-edit 1 "2023-02-01" Ronin DB "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
@@ -18,22 +18,29 @@ Manually edits the \fB~/.config/ronin-db/database.yml\fR configuration file\.
 \fB-h\fR, \fB--help\fR
 Print help information\.
 .LP
-.SH FILES
+.SH ENVIRONMENT
 .LP
 .TP
-\fI\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fP
-The \fBronin-db\fR database(s) configuration file\.
+\fIHOME\fP
+Alternate location for the user\[cq]s home directory\.
 .LP
-.SH ENVIRONMENT
+.TP
+\fIXDG\[ru]CONFIG\[ru]HOME\fP
+Alternate location for the \fB~/.config\fR directory\.
 .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\.
+.TP
+\fIXDG\[ru]DATA\[ru]HOME\fP
+Alternate location for the \fB~/.local/share\fR directory\.
 .LP
-.PP
-XDG\[ru]CONFIG\[ru]HOME
-Specifies the cache directory to use\. Defaults to \fI\[Do]HOME\[sl]\.config\fP\.
+.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