ronin-db 0.1.2 → 0.2.0.rc1

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

@@ -2,7 +2,7 @@
 #
 # ronin-db - A common database library for managing and querying security data.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-db is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -18,122 +18,30 @@
 # along with ronin-db.  If not, see <https://www.gnu.org/licenses/>.
 #
 
+require 'ronin/db/cli/deletable'
+require 'ronin/db/cli/importable'
+
 module Ronin
   module DB
     class CLI
       #
-      # Allows a {ModelCommand} to add, import, delete, or delete all records.
+      # Allows a {ModelCommand} to add, import records from a file, delete
+      # individual records, or delete all records.
       #
       module Modifiable
         #
-        # Adds the `--add`, `--import`, `--delete`, and `--delete-all` options
+        # Adds the `--add`, `--import`, `--delete` and `--delete-all` options
         # to the command.
         #
         # @param [Class<ModelCommand>] command
         #   The command class including {Modifiable}.
         #
-        def self.included(command)
-          command.option :add, value: {
-                                 type: String,
-                                 usage: 'VALUE'
-                               },
-                               desc: 'Adds a value to the database'
-
-          command.option :import, value: {
-                                    type:  String,
-                                    usage: 'FILE'
-                                  },
-                                  desc: 'Imports the values from the FILE into the database'
-
-          command.option :delete, value: {
-                                    type: String,
-                                    usage: 'VALUE'
-                                  },
-                                  desc: 'Deletes a value from the database'
-
-          command.option :delete_all, desc: 'Deletes all values from the database'
-        end
-
+        # @see Importable
+        # @see Deletable
         #
-        # Runs the command.
-        #
-        def run
-          connect
-
-          if options[:add]
-            add(options[:add])
-          elsif options[:import]
-            import_file(options[:import])
-          elsif options[:delete]
-            delete(options[:delete])
-          elsif options[:delete_all]
-            delete_all
-          else
-            list
-          end
-        end
-
-        #
-        # Adds a value to the database.
-        #
-        # @param [String] value
-        #   The value to add.
-        #
-        def add(value)
-          record = model.import(value)
-
-          unless record.valid?
-            print_error "failed to import #{value}!"
-
-            record.errors.full_messages.each do |message|
-              print_error " - #{message}"
-            end
-          end
-        end
-
-        #
-        # Imports the values from the given file.
-        #
-        # @param [String] path
-        #   The path to the file.
-        #
-        def import_file(path)
-          unless File.file?(path)
-            print_error "no such file or directory: #{path}"
-            exit(-1)
-          end
-
-          File.open(path) do |file|
-            model.transaction do
-              file.each_line(chomp: true) do |value|
-                log_info "Importing #{value} ..." if verbose?
-
-                add(value)
-              end
-            end
-          end
-        end
-
-        #
-        # Deletes a value from the database.
-        #
-        # @param [String] value
-        #   The value to lookup and delete.
-        #
-        def delete(value)
-          if (record = model.lookup(value))
-            record.destroy
-          else
-            print_error "value does not exist in the database: #{value}"
-            exit(-1)
-          end
-        end
-
-        #
-        # Deletes all values from the database.
-        #
-        def delete_all
-          model.destroy_all
+        def self.included(command)
+          command.include Deletable
+          command.include Importable
         end
       end
     end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+#
+# ronin-db - A common database library for managing and querying security data.
+#
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-db is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-db is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-db.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+module Ronin
+  module DB
+    class CLI
+      #
+      # Helper methods for printing {Ronin::DB} records.
+      #
+      # @since 0.2.0
+      #
+      # @api semipublic
+      #
+      module Printing
+        #
+        # Maps a record to a human readable display name.
+        #
+        # @param [Ronin::DB::IPAddress,
+        #         Ronin::DB::MACAddress,
+        #         Ronin::DB::HostName,
+        #         Ronin::DB::Port,
+        #         Ronin::DB::Service,
+        #         Ronin::DB::OpenPort] record
+        #
+        # @return [String, nil]
+        #   The human readable type or `nil` if the record model is unknown.
+        #
+        def record_type(record)
+          case record
+          when HostName   then 'host'
+          when IPAddress  then 'IP'
+          when MACAddress then 'MAC'
+          when Port       then 'port'
+          when Service    then 'service'
+          when OpenPort   then 'open port'
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -2,7 +2,7 @@
 #
 # ronin-db - A common database library for managing and querying security data.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-db is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

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

@@ -2,7 +2,7 @@
 #
 # ronin-db - A common database library for managing and querying security data.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-db is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/db/cli.rb

@@ -2,7 +2,7 @@
 #
 # ronin-db - A common database library for managing and querying security data.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-db is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -43,6 +43,8 @@ module Ronin
       command_name 'ronin-db'
       version Ronin::DB::VERSION
 
+      command_aliases['console'] = 'irb'
+
     end
   end
 end

data/lib/ronin/db/config_file.rb

@@ -2,7 +2,7 @@
 #
 # ronin-db - A common database library for managing and querying security data.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-db is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -21,6 +21,7 @@
 require 'ronin/db/exceptions'
 require 'ronin/db/home'
 
+require 'fileutils'
 require 'yaml'
 require 'yaml/store'
 
@@ -65,21 +66,21 @@ module Ronin
       #
       def self.validate(path,data)
         unless data.kind_of?(Hash)
-          raise(InvalidConfig)
+          raise(InvalidConfig,"config data must be a Hash: #{data.inspect}")
         end
 
         data.each do |key,value|
-          unless (key.kind_of?(Symbol) || key.kind_of?(String))
-            raise(InvalidConfig)
+          unless key.kind_of?(Symbol)
+            raise(InvalidConfig,"all Hash keys must be a Symbol: #{key.inspect}")
           end
 
           unless value.kind_of?(Hash)
-            raise(InvalidConfig)
+            raise(InvalidConfig,"all Hash values must also be a Hash: #{value.inspect}")
           end
 
           value.each_key do |sub_key|
-            unless (sub_key.kind_of?(Symbol) || sub_key.kind_of?(String))
-              raise(InvalidConfig)
+            unless sub_key.kind_of?(Symbol)
+              raise(InvalidConfig,"all sub-keys must be a Symbol: #{sub_key.inspect}")
             end
           end
         end
@@ -124,8 +125,12 @@ module Ronin
       #   The loaded YAML configuration data.
       #
       def self.edit(path=PATH,&block)
-        store = YAML::Store.new(path)
+        unless File.file?(path)
+          # create the parent directory for YAML::Store
+          FileUtils.mkdir_p(File.dirname(path))
+        end
 
+        store = YAML::Store.new(path)
         store.transaction(&block)
       end
     end

data/lib/ronin/db/exceptions.rb

@@ -2,7 +2,7 @@
 #
 # ronin-db - A common database library for managing and querying security data.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-db is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -20,7 +20,16 @@
 
 module Ronin
   module DB
+    #
+    # Indicates that the given database name is not in the config file.
+    #
     class UnknownDatabase < RuntimeError
     end
+
+    #
+    # Indicates that the config file is corrupted.
+    #
+    class InvalidConfig < RuntimeError
+    end
   end
 end

data/lib/ronin/db/home.rb

@@ -2,7 +2,7 @@
 #
 # ronin-db - A common database library for managing and querying security data.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-db is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/db/root.rb

@@ -2,7 +2,7 @@
 #
 # ronin-db - A common database library for managing and querying security data.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-db is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/db/tasks.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+#
+# ronin-db - A common database library for managing and querying security data.
+#
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-db is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-db is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-db.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'rake/tasklib'
+
+module Ronin
+  module DB
+    #
+    # Defines `ronin:db` tasks in a `Rakefile`.
+    #
+    # ## Example
+    #
+    #     require 'ronin/db/tasks'
+    #     Ronin::DB::Tasks.new
+    #
+    class Tasks < Rake::TaskLib
+
+      # The database to connect to.
+      #
+      # @return [Symbol, Hash]
+      attr_reader :database
+
+      #
+      # Initializes the tasks.
+      #
+      # @param [Symbol, Hash] database
+      #   The database name or Hash to connect to.
+      #
+      # @api public
+      #
+      def initialize(database: :default)
+        super()
+
+        @database = database
+
+        define
+      end
+
+      #
+      # Defines the `ronin:db` tasks.
+      #
+      # @api private
+      #
+      def define
+        namespace :db do
+          task :connect do
+            require 'ronin/db'
+            DB.connect(@database)
+          end
+
+          desc 'Migrates the development database'
+          task :migrate => :connect do
+            require 'ronin/db/migrations'
+            DB::Migrations.up
+          end
+
+          desc 'Starts an interactive database console'
+          task :console => :connect do
+            require 'logger'
+            DB.logger = Logger.new($stderr,:debug)
+
+            require 'ronin/db/cli/ruby_shell'
+            DB::CLI::RubyShell.start
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/ronin/db/version.rb

@@ -2,7 +2,7 @@
 #
 # ronin-db - A common database library for managing and querying security data.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-db is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -21,6 +21,6 @@
 module Ronin
   module DB
     # ronin-db version
-    VERSION = '0.1.2'
+    VERSION = '0.2.0.rc1'
   end
 end

data/lib/ronin/db.rb

@@ -2,7 +2,7 @@
 #
 # ronin-db - A common database library for managing and querying security data.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-db is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -76,8 +76,11 @@ module Ronin
     #
     # Connects to the Database.
     #
-    # @param [Symbol, Hash] database
-    #   The optional database name or Hash of database information.
+    # @param [Symbol, String, Hash] database
+    #   The optional database name, String URL, or Hash of database information.
+    #
+    # @param [Integer, nil] pool
+    #   Sets the connection pool for the database.
     #
     # @param [Boolean] migrate
     #   Specifies whether to hard or lazy migrate the database.
@@ -89,14 +92,25 @@ module Ronin
     #   The database name was not listed in the config file.
     #
     # @raise [ArgumentError]
-    #   The given database was not a Symbol or a Hash.
+    #   The given database was not a Symbol, String, or a Hash.
+    #
+    # @example Connect to the default database (`~/.local/share/ronin-db/default.sqlite3`):
+    #   DB.connect
+    #
+    # @example Connect to a specific database from the configuration file (`~/.config/ronin-db/databases.yml`):
+    #   DB.connect(:my_database)
+    #
+    # @example Connect to an arbitrary database:
+    #   Db.connect({adapter: 'sqlite3', database: '/path/to/database.sqlite3'})
     #
     # @api semipublic
     #
-    def self.connect(database=:default, migrate: nil, load_models: true)
+    def self.connect(database=:default, pool: nil,
+                                        migrate: nil,
+                                        load_models: true)
       config = case database
-               when Hash
-                 database
+               when Hash   then database
+               when String then {url: database}
                when Symbol
                  self.config.fetch(database) do
                    raise(UnknownDatabase,"unknown database: #{database.inspect}")
@@ -105,6 +119,9 @@ module Ronin
                  raise(ArgumentError,"#{self}.#{__method__} only accepts a Symbol or a Hash")
                end
 
+      # set/override the connection pool setting
+      config = config.merge(pool: pool) if pool
+
       # load activerecord
       require 'active_record'
 

data/man/ronin-db-add.1

@@ -1,130 +1,108 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-db-add 1 "2023-02-01" Ronin DB "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-db\-add \- Adds a pre\-existing database to ronin\-db
 .SH SYNOPSIS
-.LP
-.HP
-\fBronin-db add\fR \[lB]\fIoptions\fP\[rB] \fINAME\fP \[lB]\fIURI\fP\[rB]
-.LP
+.PP
+\fBronin\-db add\fR \[lB]\fIoptions\fP\[rB] \fINAME\fP \[lB]\fIURI\fP\[rB]
 .SH DESCRIPTION
-.LP
 .PP
-Adds a pre\-existing database to the \fB~/.config/ronin-db/database.yml\fR
+Adds a pre\-existing database to the \fB\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fR
 configuration file\.
-.LP
 .SH ARGUMENTS
-.LP
 .TP
 \fINAME\fP
 The name of the database to add\.
-.LP
 .TP
 \fIURI\fP
 The optional URI to the database to add\.
-.LP
 .SH OPTIONS
-.LP
 .TP
-\fB-A\fR, \fB--adapter\fR \fBsqlite3|mysql2|postgres|...\fR
+\fB\-A\fR, \fB\-\-adapter\fR \fBsqlite3\[or]mysql2\[or]postgres\[or]\.\.\.\fR
 The adapter of the database to add\.
-.LP
 .TP
-\fB--sqlite3\fR \fIFILE\fP
-Alias for \fB--adapter sqlite3 --database\fR \fIFILE\fP\.
-.LP
+\fB\-\-sqlite3\fR \fIFILE\fP
+Alias for \fB\-\-adapter sqlite3 \-\-database\fR \fIFILE\fP\.
 .TP
-\fB--mysql2\fR
-Alias for \fB--adapter mysql2\fR\.
-.LP
+\fB\-\-mysql2\fR
+Alias for \fB\-\-adapter mysql2\fR\.
 .TP
-\fB--postgresql\fR
-Alias for \fB--adapter postgresql\fR\.
-.LP
+\fB\-\-postgresql\fR
+Alias for \fB\-\-adapter postgresql\fR\.
 .TP
-\fB-H\fR, \fB--host\fR \fIHOST\fP
+\fB\-H\fR, \fB\-\-host\fR \fIHOST\fP
 The host of the database to add\.
-.LP
 .TP
-\fB-p\fR, \fB--port\fR \fIPORT\fP
+\fB\-p\fR, \fB\-\-port\fR \fIPORT\fP
 The port of the database to add\.
-.LP
 .TP
-\fB-u\fR, \fB--username\fR \fIUSER\fP
+\fB\-u\fR, \fB\-\-username\fR \fIUSER\fP
 The username to authenticate with for the database\.
-.LP
 .TP
-\fB-P\fR, \fB--password\fR \fIPASSWORD\fP
+\fB\-P\fR, \fB\-\-password\fR \fIPASSWORD\fP
 The password to authenticate with for the database\.
-.LP
 .TP
-\fB--read-password\fR
+\fB\-\-read\-password\fR
 Reads the database password from STDIN\.
-.LP
 .TP
-\fB-D\fR, \fB--database\fR \fINAME\fP\[or]\fIPATH\fP
-The database name to connect to\. If \fB--adapter sqlite3\fR is given then a path
+\fB\-D\fR, \fB\-\-database\fR \fINAME\fP\[or]\fIPATH\fP
+The database name to connect to\. If \fB\-\-adapter sqlite3\fR is given then a path
 may be given instead\.
-.LP
 .TP
-\fB-h\fR, \fB--help\fR
+\fB\-h\fR, \fB\-\-help\fR
 Print help information\.
-.LP
 .SH EXAMPLES
-.LP
 .PP
 Add a sqlite3 database file:
-.LP
-.nf
-    \[Do] ronin\-db add other\[ru]db \-\-sqlite3 path\[sl]to\[sl]db\.sqlite3
-.fi
-.LP
+.PP
+.RS 4
+.EX
+\[Do] ronin\-db add other\[ru]db \-\-sqlite3 path\[sl]to\[sl]db\.sqlite3
+.EE
+.RE
 .PP
 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
+.RS 4
+.EX
+\[Do] ronin\-db add other\[ru]db \-\-postgres \-\-host example\.com \-\-port 5432 \-\-username ronin \-\-password s3r3t \-\-database ronin\[ru]db
+.EE
+.RE
 .PP
 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
+.PP
+.RS 4
+.EX
+\[Do] ronin\-db add other\[ru]db \-\-mysql2 \-\-host example\.com \-\-port 3306 \-\-username ronin \-\-password s3r3t \-\-database ronin\[ru]db
+.EE
+.RE
 .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\-list(1) ronin\-db\-edit(1) ronin\-db\-remove(1)
+.BR ronin\-db (1)
+.BR ronin\-db\-list (1)
+.BR ronin\-db\-edit (1)
+.BR ronin\-db\-remove (1)