ronin-db 0.1.0.beta1

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

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+#
+# ronin-db - A common database library for managing and querying security data.
+#
+# Copyright (c) 2006-2022 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 'ronin/db/cli/model_command'
+require 'ronin/db/cli/modifiable'
+
+module Ronin
+  module DB
+    class CLI
+      module Commands
+        #
+        # Manages email addresses in the database.
+        #
+        # ## Usage
+        #
+        #     ronin-db emails [options]
+        #
+        # ## Options
+        #
+        #         --db NAME                    The database to connect to (Default: default)
+        #         --db-uri URI                 The database URI to connect to
+        #     -v, --verbose                    Enables verbose output
+        #         --add VALUE                  Adds a value to the database
+        #         --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
+        #     -H, --with-host [HOST [...]]
+        #     -I, --with-ip [IP [...]]
+        #     -u, --with-user [NAME [...]]
+        #
+        class Emails < ModelCommand
+
+          include Modifiable
+
+          model_file 'ronin/db/email_address'
+          model_name 'EmailAddress'
+
+          option :with_host, short: '-H',
+                             value: {
+                               type:  String,
+                               usage: 'HOST'
+                             },
+                             desc: 'Searches for the associated HOST(s)' do |host|
+                               @query_method_calls << [:with_host_name, [host]]
+                             end
+
+          option :with_ip, short: '-I',
+                           value: {
+                             type:  String,
+                             usage: 'IP'
+                           },
+                           desc: 'Searches for the associated IP(s)' do |ip|
+                             @query_method_calls << [:with_ip_address, [ip]]
+                           end
+
+          option :with_user, short: '-u',
+                             value: {
+                               type:  String,
+                               usage: 'USER'
+                             },
+                             desc: 'Searches for the associated user name' do |user|
+                               @query_method_calls << [:with_user_name, [user]]
+                             end
+
+          description 'Manages all email addresses in the database'
+
+          man_page 'ronin-db-emails.1'
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+#
+# ronin-db - A common database library for managing and querying security data.
+#
+# Copyright (c) 2006-2022 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 'ronin/db/cli/model_command'
+require 'ronin/db/cli/modifiable'
+
+module Ronin
+  module DB
+    class CLI
+      module Commands
+        #
+        # Manages all host names in the database.
+        #
+        # ## Usage
+        #
+        #     ronin-db hosts [options]
+        #
+        # ## Options
+        #
+        #         --db NAME                    The database to connect to (Default: default)
+        #         --db-uri URI                 The database URI to connect to
+        #     -v, --verbose                    Enables verbose output
+        #         --add VALUE                  Adds a value to the database
+        #         --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
+        #     -I, --with-ip [IP [...]]
+        #     -p, --with-port [PORT [...]]
+        #     -D, --domain [DOMAIN]
+        #     -T, --tld [TLD]
+        #
+        class Hosts < ModelCommand
+
+          include Modifiable
+
+          model_file 'ronin/db/host_name'
+          model_name 'HostName'
+
+          option :with_ip, short: '-I',
+                           value: {
+                             type:  String,
+                             usage: 'IP'
+                           },
+                           desc: 'Searches for the associated IP(s)' do |ip|
+                             @query_method_calls << [:with_ip_address, [ip]]
+                           end
+
+          option :with_port, short: '-p',
+                             value: {
+                               type:  Integer,
+                               usage: 'PORT'
+                             },
+                             desc: 'Searches for the associated PORT(s)' do |port|
+                               @query_method_calls << [:with_port_number, [port]]
+                             end
+
+          option :domain, short: '-D',
+                          value: {
+                            type:  String,
+                            usage: 'DOMAIN'
+                          },
+                          desc: 'Searches for the associated parent DOMAIN' do |domain|
+                            @query_method_calls << [:with_domain, [domain]]
+                          end
+
+          option :tld, short: '-T',
+                       value: {
+                         type:  String,
+                         usage: 'TLD'
+                       },
+                       desc: 'Searches for the associated TLD' do |tld|
+                         @query_method_calls << [:with_tld, [tld]]
+                       end
+
+          description 'Manages HostNames'
+
+          man_page 'ronin-db-hosts.1'
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+#
+# ronin-db - A common database library for managing and querying security data.
+#
+# Copyright (c) 2006-2022 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 'ronin/db/cli/model_command'
+require 'ronin/db/cli/modifiable'
+
+module Ronin
+  module DB
+    class CLI
+      module Commands
+        #
+        # Manages {IPAddress IPAddresses}.
+        #
+        # ## Usage
+        #
+        #     ronin ips [options]
+        #
+        # ## Options
+        #
+        #         --db NAME                    The database to connect to (Default: default)
+        #         --db-uri URI                 The database URI to connect to
+        #     -v, --verbose                    Enables verbose output
+        #         --add VALUE                  Adds a value to the database
+        #         --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
+        #     -4, --v4
+        #     -6, --v6
+        #     -p, --with-port PORT
+        #     -M, --with-mac-addr MAC
+        #     -H, --with-host HOST
+        #
+        class Ips < ModelCommand
+
+          include Modifiable
+
+          model_file 'ronin/db/ip_address'
+          model_name 'IPAddress'
+
+          option :v4, short: '-4',
+                      desc: 'Searches for IPv4 addresses' do
+                        @query_method_calls << :v4
+                      end
+
+          option :v6, short: '-6',
+                      desc: 'Searches for IPv6 addresses' do
+                        @query_method_calls << :v6
+                      end
+
+          option :with_port, short: '-p',
+                             value: {
+                               type: Integer,
+                               usage: 'PORT'
+                             },
+                             desc: 'Searches for the associated PORT(s)' do |port|
+                               @query_method_calls << [:with_port_number, [port]]
+                             end
+
+          option :with_mac_addr, short:  '-M',
+                                 value: {
+                                   type: String,
+                                   usage: 'MAC'
+                                 },
+                                 desc: 'Searches for the associated MAC address(es)' do |mac|
+                                   @query_method_calls << [:with_mac_address, [mac]]
+                                 end
+
+          option :with_host, short: '-H',
+                             value: {
+                               type: String,
+                               usage: 'HOST'
+                             },
+                             desc: 'Searches for the associated HOST(s)' do |host|
+                               @query_method_calls << [:with_host_name, [host]]
+                             end
+
+          description 'Manages IP addresses'
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+#
+# ronin-db - A common database library for managing and querying security data.
+#
+# Copyright (c) 2006-2022 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 'ronin/db/cli/database_command'
+require 'ronin/db/cli/ruby_shell'
+
+module Ronin
+  module DB
+    class CLI
+      module Commands
+        #
+        # Connects to a database and start an interactive Ruby shell.
+        #
+        # ## Usage
+        #
+        #     ronin-db irb [options]
+        #
+        # ## Options
+        #
+        #         --db NAME                    The database to connect to (Default: default)
+        #         --db-uri URI                 The database URI to connect to
+        #         --no-connect                 Do not connect to a database on startup
+        #     -h, --help                       Print help information
+        #
+        class Irb < DatabaseCommand
+
+          option :no_connect, desc: 'Do not connect to a database on startup'
+
+          description "Connects to a database and start an interactive Ruby shell"
+
+          man_page 'ronin-db-irb.1'
+
+          #
+          # Starts the `ronin-db irb` command.
+          #
+          def run
+            unless options[:no_connect]
+              connect
+              load_models
+            end
+
+            set_logger
+
+            CLI::RubyShell.start
+          end
+
+          def set_logger
+            require 'logger'
+            DB.logger = Logger.new(stderr,:debug)
+          end
+
+          #
+          # Loads all models.
+          #
+          def load_models
+            require 'ronin/db/models'
+            Ronin::DB::Models.connect
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+#
+# ronin-db - A common database library for managing and querying security data.
+#
+# Copyright (c) 2006-2022 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 'ronin/db/cli/command'
+require 'ronin/db/config_file'
+
+require 'command_kit/options/verbose'
+require 'command_kit/printing'
+require 'command_kit/printing/indent'
+require 'command_kit/printing/fields'
+
+module Ronin
+  module DB
+    class CLI
+      module Commands
+        #
+        # Lists entries in the `~/.config/ronin-db/database.yml` configuration
+        # file.
+        #
+        # ## Usage
+        #
+        #     ronin-db list [options] [NAME]
+        #
+        # ## Options
+        #
+        #     -v, --verbose                    Enables verbose output
+        #     -h, --help                       Print help information
+        #
+        # ## Arguments
+        #
+        #     [NAME]                           Optional DB name to list
+        #
+        class List < Command
+
+          include CommandKit::Options::Verbose
+          include CommandKit::Printing
+          include CommandKit::Printing::Indent
+          include CommandKit::Printing::Fields
+
+          usage '[options] [NAME]'
+
+          argument :name, required: false,
+                          desc:     'Optional DB name to list'
+
+          description 'List the configured database(s)'
+
+          man_page 'ronin-db-list.1'
+
+          #
+          # Runs the `ronin-db list` command.
+          #
+          # @param [String, nil] name
+          #   The optional database name to list.
+          #
+          def run(name=nil)
+            config = ConfigFile.load
+
+            if name
+              unless (hash = config[name.to_sym])
+                print_error "unknown database #{name.inspect}"
+                exit(1)
+              end
+
+              print_database(name,hash)
+            else
+              config.each do |name,hash|
+                if verbose?
+                  print_database(name,hash)
+                  puts
+                else
+                  puts name
+                end
+              end
+            end
+          end
+
+          # Default hidden password placeholder.
+          HIDDEN_PASSWORD = '*******'
+
+          #
+          # Prints a specific entry in the `database.yml` file.
+          #
+          # @param [Symbol] name
+          #   The database name.
+          #
+          # @param [Hash{Symbol => String,Integer}] hash
+          #   The configuration hash for the database.
+          #
+          def print_database(name,hash)
+            puts "[ #{name} ]"
+            puts
+
+            if hash[:password]
+              # blank out the password by default
+              hash = hash.merge(password: HIDDEN_PASSWORD)
+            end
+
+            indent(2) do
+              print_fields(hash)
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+#
+# ronin-db - A common database library for managing and querying security data.
+#
+# Copyright (c) 2006-2022 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 'ronin/db/cli/database_command'
+require 'ronin/db'
+
+module Ronin
+  module DB
+    class CLI
+      module Commands
+        #
+        # Runs database migrations.
+        #
+        # ## Usage
+        #
+        #     ronin-db migrate [options]
+        #
+        # ## Options
+        #
+        #         --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]'
+
+          description 'Runs database migrations'
+
+          man_page 'ronin-db-migrate.1'
+
+          #
+          # Runs the `ronin-db migrate` command.
+          #
+          def run
+            connect
+            migrate
+          end
+
+          #
+          # Connects to the database.
+          #
+          def connect
+            DB.connect(config, load_models: false)
+          end
+
+          #
+          # Runs migrations.
+          #
+          def migrate
+            DB.migrate!
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+#
+# ronin-db - A common database library for managing and querying security data.
+#
+# Copyright (c) 2006-2022 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 'ronin/db/cli/command'
+require 'ronin/db/config_file'
+
+module Ronin
+  module DB
+    class CLI
+      module Commands
+        #
+        # Removes an entry from the `database.yml` config file.
+        #
+        # ## Usage
+        #
+        #     ronin-db remove [options] NAME
+        #
+        # ## Options
+        #
+        #     -h, --help                       Print help information
+        #
+        # ## Arguments
+        #
+        #     NAME                             The DB name to remove
+        #
+        class Remove < Command
+
+          usage '[options] NAME'
+
+          argument :name, desc: 'The DB name to remove'
+
+          description 'Removed a database from the configuration file'
+
+          man_page 'ronin-db-remove.1'
+
+          #
+          # Runs the `ronin-db remove` command.
+          #
+          # @param [String] name
+          #   The database name to remove.
+          #
+          def run(name)
+            ConfigFile.edit do |config|
+              config.delete(name.to_sym)
+            end
+          end
+
+        end
+      end
+    end
+  end
+end