ronin-db 0.1.3 → 0.2.0

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

@@ -0,0 +1,103 @@
+# 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 Ports in the database.
+        #
+        # ## Usage
+        #
+        #     ronin-db 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 Ports associated with the PORT number
+        #     -P, --with-protocol tcp|udp      Searches for all Ports associated with the protocol
+        #     -S, --with-service SERVICE       Searches for all Ports associated with the SERVICE
+        #     -I, --with-ip IP                 Searches for all Ports associated with the IP
+        #     -h, --help                       Print help information
+        #
+        # @since 0.2.0
+        #
+        class Ports < ModelCommand
+
+          include Modifiable
+
+          model_file 'ronin/db/port'
+          model_name 'Port'
+
+          option :number, short: '-N',
+                          value: {
+                            type: Integer,
+                            usage: 'PORT'
+                          },
+                          desc: 'Searches for all Ports with the PORT number' do |port|
+                            @query_method_calls << [:with_number, [port]]
+                          end
+
+          option :with_protocol, short: '-P',
+                                 value: {
+                                   type: [:tcp, :udp]
+                                 },
+                                 desc: 'Searches for all Ports 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 Ports 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 Ports associated with the IP' do |ip|
+                             @query_method_calls << [:with_ip_address, [ip]]
+                           end
+
+          description 'Manages Ports'
+
+          man_page 'ronin-db-ports.1'
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/db/cli/commands/remove.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/commands/services.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'
+require 'ronin/db/cli/modifiable'
+
+module Ronin
+  module DB
+    class CLI
+      module Commands
+        #
+        # Manages all Services in the database.
+        #
+        # ## Usage
+        #
+        #     ronin-db services [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
+        #         --named NAME                 Searches for all Services containing the NAME
+        #     -p, --with-port PORT             Searches for all Services associated with the PORT
+        #     -P, --with-protocol tcp|udp      Searches for all Services associated with the protocol
+        #     -I, --with-ip IP                 Searches for all Services associated with the IP
+        #     -h, --help                       Print help information
+        #
+        # @since 0.2.0
+        #
+        class Services < ModelCommand
+
+          include Modifiable
+
+          model_file 'ronin/db/service'
+          model_name 'Service'
+
+          option :named, value: {
+                           type:  String,
+                           usage: 'NAME'
+                         },
+                         desc: 'Searches for all Services containing the NAME' do |name|
+                           @query_method_calls << [:named, [name]]
+                         end
+
+          option :with_port, short: '-p',
+                             value: {
+                               type: Integer,
+                               usage: 'PORT'
+                             },
+                             desc: 'Searches for all Services associated with the PORT' do |port|
+                               @query_method_calls << [:with_port_number, [port]]
+                             end
+
+          option :with_protocol, short: '-P',
+                                 value: {
+                                   type: [:tcp, :udp]
+                                 },
+                                 desc: 'Searches for all Services associated with the protocol' do |protocol|
+                                   @query_method_calls << [:with_protocol, [protocol]]
+                                 end
+
+          option :with_ip, short: '-I',
+                           value: {
+                             type:  String,
+                             usage: 'IP'
+                           },
+                           desc: 'Searches for all Services associated with the IP' do |ip|
+                             @query_method_calls << [:with_ip_address, [ip]]
+                           end
+
+          description 'Manages Services'
+
+          man_page 'ronin-db-services.1'
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/db/cli/commands/software.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 Software in the database.
+        #
+        # ## Usage
+        #
+        #     ronin-db software [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
+        #     -V, --version VERSION            Searches for all OSes with the VERSION
+        #         --vendor VENDOR              Searches for all Software with the vendor name
+        #     -h, --help                       Print help information
+        #
+        # @since 0.2.0
+        #
+        class Software < ModelCommand
+
+          model_file 'ronin/db/software'
+          model_name 'Software'
+
+          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 :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
+
+          option :vendor, value: {
+                            type:  String,
+                            usage: 'VENDOR'
+                          },
+                          desc: 'Searches for all Software with the vendor name' do |vendor|
+                            @query_method_calls << [:with_vendor_name, [vendor]]
+                          end
+
+          description 'Queries Software'
+
+          man_page 'ronin-db-software.1'
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,129 @@
+# 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 StreetAddresses in the database.
+        #
+        # ## Usage
+        #
+        #     ronin-db street-addresses [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
+        #     -P, --for-person FULL_NAME       Searches for street addresses associated with the person's full name
+        #     -O, --for-organization NAME      Searches for street addresses associated with the organization's name
+        #     -a, --with-address ADDRESS       Searches for street addresses with the matching address
+        #     -c, --with-city CITY             Searches for street addresses with the matching city
+        #     -s, --with-state STATE           Searches for street addresses with the matching state
+        #     -C, --with-country COUNTRY       Searches for street addresses with the matching country
+        #     -z, --with-zipcode ZIPCODE       Searches for street addresses with the matching zipcode
+        #     -h, --help                       Print help information
+        #
+        # @since 0.2.0
+        #
+        class StreetAddresses < ModelCommand
+
+          command_name 'street-addresses'
+
+          model_file 'ronin/db/street_address'
+          model_name 'StreetAddress'
+
+          option :for_person, short: '-P',
+                              value: {
+                                type:  String,
+                                usage: 'FULL_NAME'
+                              },
+                              desc: "Searches for street addresses 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 street addresses associated with the organization's name" do |name|
+                                      @query_method_calls << [:for_organization, [name]]
+                                    end
+
+          option :with_address, short: '-a',
+                                value: {
+                                  type:  String,
+                                  usage: 'ADDRESS'
+                                },
+                                desc: 'Searches for street addresses with the matching address' do |address|
+                                  @query_method_calls << [:with_address, [address]]
+                                end
+
+          option :with_city, short: '-c',
+                             value: {
+                               type:  String,
+                               usage: 'CITY'
+                             },
+                             desc: 'Searches for street addresses with the matching city' do |city|
+                               @query_method_calls << [:with_city, [city]]
+                             end
+
+          option :with_state, short: '-s',
+                              value: {
+                                type:  String,
+                                usage: 'STATE'
+                              },
+                              desc: 'Searches for street addresses with the matching state' do |state|
+                                @query_method_calls << [:with_state, [state]]
+                              end
+
+          option :with_country, short: '-C',
+                                value: {
+                                  type:  String,
+                                  usage: 'COUNTRY'
+                                },
+                                desc: 'Searches for street addresses with the matching country' do |country|
+                                  @query_method_calls << [:with_country, [country]]
+                                end
+
+          option :with_zipcode, short: '-z',
+                                value: {
+                                  type:  String,
+                                  usage: 'ZIPCODE'
+                                },
+                                desc: 'Searches for street addresses with the matching zipcode' do |zipcode|
+                                  @query_method_calls << [:with_zipcode, [zipcode]]
+                                end
+
+          description 'Queries StreetAddresses'
+
+          man_page 'ronin-db-street-addresses.1'
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/db/cli/commands/urls.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
@@ -36,6 +36,7 @@ module Ronin
         #
         #         --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