ronin-db 0.1.3 → 0.2.0

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

@@ -0,0 +1,102 @@
+# 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 'ronin/db/cli/model_command'
+
+module Ronin
+  module DB
+    class CLI
+      module Commands
+        #
+        # Manages all OpenPorts in the database.
+        #
+        # ## Usage
+        #
+        #     ronin-db open-ports [options]
+        #
+        # ## Options
+        #
+        #         --db NAME                    The database to connect to (Default: default)
+        #         --db-uri URI                 The database URI to connect to
+        #         --db-file PATH               The sqlite3 database file to use
+        #     -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
+        #     -p, --with-port PORT             Searches for all OpenPorts associated with the PORT number
+        #     -P, --with-protocol tcp|udp      Searches for all OpenPorts associated with the protocol
+        #     -S, --with-service SERVICE       Searches for all OpenPorts associated with the SERVICE
+        #     -I, --with-ip IP                 Searches for all OpenPorts associated with the IP
+        #     -h, --help                       Print help information
+        #
+        # @since 0.2.0
+        #
+        class OpenPorts < ModelCommand
+
+          command_name 'open-ports'
+
+          model_file 'ronin/db/open_port'
+          model_name 'OpenPort'
+
+          option :with_port, short: '-p',
+                             value: {
+                               type: Integer,
+                               usage: 'PORT'
+                             },
+                             desc: 'Searches for all OpenPorts with the PORT number' do |port|
+                               @query_method_calls << [:with_port_number, [port]]
+                             end
+
+          option :with_protocol, short: '-P',
+                                 value: {
+                                   type: [:tcp, :udp]
+                                 },
+                                 desc: 'Searches for all OpenPorts associated with the protocol' do |protocol|
+                                   @query_method_calls << [:with_protocol, [protocol]]
+                                 end
+
+          option :with_service, short: '-S',
+                                value: {
+                                  type:  String,
+                                  usage: 'SERVICE'
+                                },
+                                desc: 'Searches for all OpenPorts associated with the SERVICE' do |service|
+                                  @query_method_calls << [:with_service_name, [service]]
+                                end
+
+          option :with_ip, short: '-I',
+                           value: {
+                             type:  String,
+                             usage: 'IP'
+                           },
+                           desc: 'Searches for all OpenPorts associated with the IP' do |ip|
+                             @query_method_calls << [:with_ip_address, [ip]]
+                           end
+
+          description 'Queries OpenPorts'
+
+          man_page 'ronin-db-open-ports.1'
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+# 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 'ronin/db/cli/model_command'
+
+module Ronin
+  module DB
+    class CLI
+      module Commands
+        #
+        # Queries all OSes in the database.
+        #
+        # ## Usage
+        #
+        #     ronin-db oses [options]
+        #
+        # ## Options
+        #
+        #         --db NAME                    The database to connect to (Default: default)
+        #         --db-uri URI                 The database URI to connect to
+        #         --db-file PATH               The sqlite3 database file to use
+        #     -v, --verbose                    Enables verbose output
+        #     -N, --name NAME                  Searches for all OSes records with the matching name
+        #         --named NAME                 Searches for all OSes containing the NAME
+        #     -F, --flavor linux|bsd           Searches for all OSes with the flavor
+        #     -V, --version VERSION            Searches for all OSes with the VERSION
+        #     -h, --help                       Print help information
+        #
+        # @since 0.2.0
+        #
+        class Oses < ModelCommand
+
+          model_file 'ronin/db/os'
+          model_name 'OS'
+
+          option :name, short: '-N',
+                        value: {
+                          type:  String,
+                          usage: 'NAME'
+                        },
+                        desc: 'Searches for all OSes records with the matching name' do |name|
+                          @query_method_calls << [:with_name, [name]]
+                        end
+
+          option :named, value: {
+                           type:  String,
+                           usage: 'NAME'
+                         },
+                         desc: 'Searches for all OSes containing the NAME' do |name|
+                           @query_method_calls << [:named, [name]]
+                         end
+
+          option :flavor, short: '-F',
+                          value: {
+                            type: [:linux, :bsd]
+                          },
+                          desc: 'Searches for all OSes with the flavor' do |flavor|
+                            @query_method_calls << [:with_flavor, [flavor]]
+                          end
+
+          option :version, short: '-V',
+                           value: {
+                             type:  String,
+                             usage: 'VERSION'
+                           },
+                           desc: 'Searches for all OSes with the VERSION' do |version|
+                             @query_method_calls << [:with_version, [version]]
+                           end
+
+          description 'Queries OSes'
+
+          man_page 'ronin-db-oses.1'
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+# 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 'ronin/db/cli/model_command'
+require 'ronin/db/cli/modifiable'
+
+module Ronin
+  module DB
+    class CLI
+      module Commands
+        #
+        # Manages all Passwords in the database.
+        #
+        # ## Usage
+        #
+        #     ronin-db passwords [options]
+        #
+        # ## Options
+        #
+        #         --db NAME                    The database to connect to (Default: default)
+        #         --db-uri URI                 The database URI to connect to
+        #         --db-file PATH               The sqlite3 database file to use
+        #     -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
+        #     -u, --for-user USER              Searches for all Passwords associated with the USER name
+        #     -e, --with-email EMAIL           Searches for all Passwords associated with the EMAIL address
+        #
+        # @since 0.2.0
+        #
+        class Passwords < ModelCommand
+
+          include Modifiable
+
+          model_file 'ronin/db/password'
+          model_name 'Password'
+
+          option :for_user, short: '-u',
+                            value: {
+                              type:  String,
+                              usage: 'USER'
+                            },
+                            desc: 'Searches for all Passwords associated with the USER name' do |user|
+                              @query_method_calls << [:for_user, [user]]
+                            end
+
+          option :with_email, short: '-e',
+                              value: {
+                                type: String,
+                                usage: 'EMAIL'
+                              },
+                              desc: 'Searches for all Passwords associated with the EMAIL address' do |email|
+                                @query_method_calls << [:with_email_address, [email]]
+                              end
+
+          description 'Manages all Passwords in the database'
+
+          man_page 'ronin-db-passwords.1'
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,185 @@
+# 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 'ronin/db/cli/model_command'
+require 'ronin/db/cli/modifiable'
+
+module Ronin
+  module DB
+    class CLI
+      module Commands
+        #
+        # Manages all People in the database.
+        #
+        # ## Usage
+        #
+        #     ronin-db people [options]
+        #
+        # ## Options
+        #
+        #         --db NAME                    The database to connect to (Default: default)
+        #         --db-uri URI                 The database URI to connect to
+        #         --db-file PATH               The sqlite3 database file to use
+        #     -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
+        #     -a, --for-address ADDRESS        Searches for all People associated with the street address
+        #     -c, --for-city CITY              Searches for all People associated with the city
+        #     -s, --for-state STATE            Searches for all People associated with the state
+        #     -s, --for-province PROVINCE      Searches for all People associated with the province
+        #     -z, --for-zipcode ZIPCODE        Searches for all People associated with the zipcode
+        #     -C, --for-country COUNTRY        Searches for all People associated with the Country
+        #     -P, --with-prefix PREFIX         Searches for all People with the prefix
+        #     -f, --with-first-name NAME       Searches for all People with the first name
+        #     -m, --with-middle-name NAME      Searches for all People with the middle name
+        #     -M INITIAL,                      Searches for all People with the middle name
+        #         --with-middle-initial
+        #     -l, --with-last-name NAME        Searches for all People with the last name
+        #     -S, --with-suffix SUFFIX         Searches for all People with the suffix
+        #     -h, --help                       Print help information
+        #
+        # @since 0.2.0
+        #
+        class People < ModelCommand
+
+          include Modifiable
+
+          model_file 'ronin/db/person'
+          model_name 'Person'
+
+          option :for_address, short: '-a',
+                               value: {
+                                 type:  String,
+                                 usage: 'ADDRESS'
+                               },
+                               desc: 'Searches for all People associated with the street address' do |address|
+                                 @query_method_calls << [:for_address, [address]]
+                               end
+
+          option :for_city, short: '-c',
+                            value: {
+                              type:  String,
+                              usage: 'CITY'
+                            },
+                            desc: 'Searches for all People associated with the city' do |city|
+                              @query_method_calls << [:for_city, [city]]
+                            end
+
+          option :for_state, short: '-s',
+                             value: {
+                               type:  String,
+                               usage: 'STATE'
+                             },
+                             desc: 'Searches for all People associated with the state' do |state|
+                               @query_method_calls << [:for_state, [state]]
+                             end
+
+          option :for_province, short: '-p',
+                                value: {
+                                  type:  String,
+                                  usage: 'PROVINCE'
+                                },
+                                desc: 'Searches for all People associated with the province' do |province|
+                                  @query_method_calls << [:for_province, [province]]
+                                end
+
+          option :for_zipcode, short: '-z',
+                               value: {
+                                 type:  String,
+                                 usage: 'ZIPCODE'
+                               },
+                               desc: 'Searches for all People associated with the zipcode' do |zipcode|
+                                 @query_method_calls << [:for_zipcode, [zipcode]]
+                               end
+
+          option :for_country, short: '-C',
+                               value: {
+                                 type:  String,
+                                 usage: 'COUNTRY'
+                               },
+                               desc: 'Searches for all People associated with the Country' do |country|
+                                 @query_method_calls << [:for_country, [country]]
+                               end
+
+          option :with_prefix, short: '-P',
+                               value: {
+                                 type:  String,
+                                 usage: 'PREFIX'
+                               },
+                               desc: 'Searches for all People with the prefix' do |prefix|
+                                 @query_method_calls << [:with_prefix, [prefix]]
+                               end
+
+          option :with_first_name, short: '-f',
+                                   value: {
+                                     type:  String,
+                                     usage: 'NAME'
+                                   },
+                                   desc: 'Searches for all People with the first name' do |name|
+                                     @query_method_calls << [:with_first_name, [name]]
+                                   end
+
+          option :with_middle_name, short: '-m',
+                                    value: {
+                                      type:  String,
+                                      usage: 'NAME'
+                                    },
+                                    desc: 'Searches for all People with the middle name' do |name|
+                                      @query_method_calls << [:with_middle_name, [name]]
+                                    end
+
+          option :with_middle_initial, short: '-M',
+                                       value: {
+                                         type:  String,
+                                         usage: 'INITIAL'
+                                       },
+                                       desc: 'Searches for all People with the middle name' do |initial|
+                                         @query_method_calls << [:with_middle_initial, [initial]]
+                                       end
+
+          option :with_last_name, short: '-l',
+                                  value: {
+                                    type:  String,
+                                    usage: 'NAME'
+                                  },
+                                  desc: 'Searches for all People with the last name' do |name|
+                                    @query_method_calls << [:with_last_name, [name]]
+                                  end
+
+          option :with_suffix, short: '-S',
+                               value: {
+                                 type:  String,
+                                 usage: 'SUFFIX'
+                               },
+                               desc: 'Searches for all People with the suffix' do |suffix|
+                                 @query_method_calls << [:with_suffix, [suffix]]
+                               end
+
+          description 'Queries People'
+
+          man_page 'ronin-db-people.1'
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,136 @@
+# 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 'ronin/db/cli/model_command'
+require 'ronin/db/cli/modifiable'
+
+module Ronin
+  module DB
+    class CLI
+      module Commands
+        #
+        # Manages all PhoneNumbers in the database.
+        #
+        # ## Usage
+        #
+        #     ronin-db phone-numbers [options]
+        #
+        # ## Options
+        #
+        #         --db NAME                    The database to connect to (Default: default)
+        #         --db-uri URI                 The database URI to connect to
+        #         --db-file PATH               The sqlite3 database file to use
+        #     -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
+        #     -P, --for-person FULL_NAME       Searches for phone numbers associated with the person's full name
+        #     -O, --for-organization NAME      Searches for phone numbers associated with the organization's name
+        #     -c, --with-country-code NUM      Searches for phone numbers with the country code
+        #     -a, --with-area-code NUM         Searches for phone numbers with the area code
+        #     -p, --with-prefix NUM            Searches for phone numbers with the prefix
+        #     -l, --with-line-number NUM       Searches for phone numbers with the line number
+        #     -S, --similar-to PHONE_NUMBER    Searches for phone numbers similar to another phone number
+        #     -h, --help                       Print help information
+        #
+        # @since 0.2.0
+        #
+        class PhoneNumbers < ModelCommand
+
+          include Modifiable
+
+          command_name 'phone-numbers'
+
+          model_file 'ronin/db/phone_number'
+          model_name 'PhoneNumber'
+
+          option :for_person, short: '-P',
+                              value: {
+                                type:  String,
+                                usage: 'FULL_NAME'
+                              },
+                              desc: "Searches for phone numbers associated with the person's full name" do |full_name|
+                                @query_method_calls << [:for_person, [full_name]]
+                              end
+
+          option :for_organization, short: '-O',
+                                    value: {
+                                      type:  String,
+                                      usage: 'NAME'
+                                    },
+                                    desc: "Searches for phone numbers associated with the organization's name" do |name|
+                                      @query_method_calls << [:for_organization, [name]]
+                                    end
+
+          option :with_country_code, short: '-c',
+                                     value: {
+                                       type:  String,
+                                       usage: 'NUM'
+                                     },
+                                     desc: 'Searches for phone numbers with the country code' do |country_code|
+                                       @query_method_calls << [:with_country_code, country_code]
+                                     end
+
+          option :with_area_code, short: '-a',
+                                  value: {
+                                    type:  String,
+                                    usage: 'NUM'
+                                  },
+                                  desc: 'Searches for phone numbers with the area code' do |area_code|
+                                    @query_method_calls << [:with_area_code, area_code]
+                                  end
+
+          option :with_prefix, short: '-p',
+                               value: {
+                                 type:  String,
+                                 usage: 'NUM'
+                               },
+                               desc: 'Searches for phone numbers with the prefix' do |prefix|
+                                 @query_method_calls << [:with_prefix, prefix]
+                               end
+
+          option :with_line_number, short: '-l',
+                                    value: {
+                                      type:  String,
+                                      usage: 'NUM'
+                                    },
+                                    desc: 'Searches for phone numbers with the line number' do |line_number|
+                                      @query_method_calls << [:with_line_number, line_number]
+                                    end
+
+          option :similar_to, short: '-S',
+                              value: {
+                                type:  String,
+                                usage: 'PHONE_NUMBER'
+                              },
+                              desc: 'Searches for phone numbers similar to another phone number' do |number|
+                                @query_method_calls << [:similar_to, number]
+                              end
+
+          description 'Queries PhoneNumbers'
+
+          man_page 'ronin-db-phone-numbers.1'
+
+        end
+      end
+    end
+  end
+end