ronin-db 0.1.2-java → 0.2.0-java

data/man/ronin-db.1

@@ -0,0 +1,118 @@
+.\" Generated by kramdown-man 1.0.1
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-db 1 "2023-02-01" Ronin DB "User Manuals"
+.SH NAME
+.PP
+ronin\-db \- manages ronin\[cq]s database(s)
+.SH SYNOPSIS
+.PP
+\fBronin\-db\fR \[lB]\fIoptions\fP\[rB] \[lB]\fICOMMAND\fP\[rB]
+.SH DESCRIPTION
+.PP
+The \fBronin\-db\fR provides commands for adding, removing, listing, databases,
+and querying, inserting, or deleting data from the various tables within a
+database\.
+.SH OPTIONS
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Prints help information\.
+.SH COMMANDS
+.TP
+\fBadd\fR
+Adds a pre\-existing database to ronin\-db\.
+.TP
+\fBasn\fR
+Queries and updates ASNs\.
+.TP
+\fBcerts\fR
+Queries or imports SSL\[sl]TLS certificates\.
+.TP
+\fBcompletion\fR
+Manages shell completion rules for the \fBronin\-db\fR command\.
+.TP
+\fBcreds\fR
+Manages all credentials in the database\.
+.TP
+\fBedit\fR
+Manually edits the \fBdatabase\.yml\fR configuration file\.
+.TP
+\fBemails\fR
+Manages all email addresses in the database\.
+.TP
+\fBhosts\fR
+Manages all host names in the database\.
+.TP
+\fBips\fR
+Manages IP addresses in the database\.
+.TP
+\fBirb\fR
+Connects to a database and start an interactive Ruby shell\.
+.TP
+\fBlist\fR
+List the configured database(s)\.
+.TP
+\fBmigrate\fR
+Runs database migrations\.
+.TP
+\fBopen\-ports\fR
+Queries open ports in the database\.
+.TP
+\fBoses\fR
+Queries OSes in the database
+.TP
+\fBpasswords\fR
+Manages all passwords in the database\.
+.TP
+\fBpeople\fR
+Queries people in the database\.
+.TP
+\fBphone\-numbers\fR
+Manages phone numbers in the database\.
+.TP
+\fBports\fR
+Manages port numbers in the database\.
+.TP
+\fBremove\fR
+Removes a database from the configuration file\.
+.TP
+\fBservices\fR
+Manages services in the database\.
+.TP
+\fBsoftware\fR
+Queries software in the database\.
+.TP
+\fBstreet\-addresses\fR
+Queries street addresses in the database\.
+.TP
+\fBurls\fR
+Manages URLs in the database\.
+.SH AUTHOR
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME
+.SH SEE ALSO
+.PP
+.BR ronin\-db\-add (1)
+.BR ronin\-db\-asn (1)
+.BR ronin\-db\-certs (1)
+.BR ronin\-db\-completion (1)
+.BR ronin\-db\-creds (1)
+.BR ronin\-db\-edit (1)
+.BR ronin\-db\-emails (1)
+.BR ronin\-db\-hosts (1)
+.BR ronin\-db\-ips (1)
+.BR ronin\-db\-irb (1)
+.BR ronin\-db\-list (1)
+.BR ronin\-db\-migrate (1)
+.BR ronin\-db\-open\-ports (1)
+.BR ronin\-db\-oses (1)
+.BR ronin\-db\-passwords (1)
+.BR ronin\-db\-people (1)
+.BR ronin\-db\-phone\-numbers (1)
+.BR ronin\-db\-ports (1)
+.BR ronin\-db\-remove (1)
+.BR ronin\-db\-services (1)
+.BR ronin\-db\-software (1)
+.BR ronin\-db\-street\-addresses (1)
+.BR ronin\-db\-urls (1)

data/man/ronin-db.1.md

@@ -0,0 +1,99 @@
+# ronin-db 1 "2023-02-01" Ronin DB "User Manuals"
+
+## NAME
+
+ronin-db - manages ronin's database(s)
+
+## SYNOPSIS
+
+`ronin-db` [*options*] [*COMMAND*]
+
+## DESCRIPTION
+
+The `ronin-db` provides commands for adding, removing, listing, databases,
+and querying, inserting, or deleting data from the various tables within a
+database.
+
+## OPTIONS
+
+`-h`, `--help`
+: Prints help information.
+
+## COMMANDS
+
+`add`
+: Adds a pre-existing database to ronin-db.
+
+`asn`
+: Queries and updates ASNs.
+
+`certs`
+: Queries or imports SSL/TLS certificates.
+
+`completion`
+: Manages shell completion rules for the `ronin-db` command.
+
+`creds`
+: Manages all credentials in the database.
+
+`edit`
+: Manually edits the `database.yml` configuration file.
+
+`emails`
+: Manages all email addresses in the database.
+
+`hosts`
+: Manages all host names in the database.
+
+`ips`
+: Manages IP addresses in the database.
+
+`irb`
+: Connects to a database and start an interactive Ruby shell.
+
+`list`
+: List the configured database(s).
+
+`migrate`
+: Runs database migrations.
+
+`open-ports`
+: Queries open ports in the database.
+
+`oses`
+: Queries OSes in the database
+
+`passwords`
+: Manages all passwords in the database.
+
+`people`
+: Queries people in the database.
+
+`phone-numbers`
+: Manages phone numbers in the database.
+
+`ports`
+: Manages port numbers in the database.
+
+`remove`
+: Removes a database from the configuration file.
+
+`services`
+: Manages services in the database.
+
+`software`
+: Queries software in the database.
+
+`street-addresses`
+: Queries street addresses in the database.
+
+`urls`
+: Manages URLs in the database.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+[ronin-db-add](ronin-db-add.1.md) [ronin-db-asn](ronin-db-asn.1.md) [ronin-db-certs](ronin-db-certs.1.md) [ronin-db-completion](ronin-db-completion.1.md) [ronin-db-creds](ronin-db-creds.1.md) [ronin-db-edit](ronin-db-edit.1.md) [ronin-db-emails](ronin-db-emails.1.md) [ronin-db-hosts](ronin-db-hosts.1.md) [ronin-db-ips](ronin-db-ips.1.md) [ronin-db-irb](ronin-db-irb.1.md) [ronin-db-list](ronin-db-list.1.md) [ronin-db-migrate](ronin-db-migrate.1.md) [ronin-db-open-ports](ronin-db-open-ports.1.md) [ronin-db-oses](ronin-db-oses.1.md) [ronin-db-passwords](ronin-db-passwords.1.md) [ronin-db-people](ronin-db-people.1.md) [ronin-db-phone-numbers](ronin-db-phone-numbers.1.md) [ronin-db-ports](ronin-db-ports.1.md) [ronin-db-remove](ronin-db-remove.1.md) [ronin-db-services](ronin-db-services.1.md) [ronin-db-software](ronin-db-software.1.md) [ronin-db-street-addresses](ronin-db-street-addresses.1.md) [ronin-db-urls](ronin-db-urls.1.md)

data/scripts/setup

@@ -0,0 +1,58 @@
+#!/usr/bin/env bash
+
+#
+# Prints a log message.
+#
+function log()
+{
+	if [[ -t 1 ]]; then
+		echo -e "\x1b[1m\x1b[32m>>>\x1b[0m \x1b[1m$1\x1b[0m"
+	else
+		echo ">>> $1"
+	fi
+}
+
+#
+# Prints a warn message.
+#
+function warn()
+{
+	if [[ -t 1 ]]; then
+		echo -e "\x1b[1m\x1b[33m***\x1b[0m \x1b[1m$1\x1b[0m" >&2
+	else
+		echo "*** $1" >&2
+	fi
+}
+
+#
+# Prints an error message.
+#
+function error()
+{
+	if [[ -t 1 ]]; then
+		echo -e "\x1b[1m\x1b[31m!!!\x1b[0m \x1b[1m$1\x1b[0m" >&2
+	else
+		echo "!!! $1" >&2
+	fi
+}
+
+#
+# Prints an error message and exists with -1.
+#
+function fail()
+{
+	error "$@"
+	exit -1
+}
+
+# default to installing gems into vendor/bundle
+if [[ ! -f .bundle/config ]]; then
+	bundle config set --local path vendor/bundle >/dev/null || \
+	  fail "Failed to run 'bundle config'"
+fi
+
+log "Installing gems ..."
+bundle install || fail "Failed to run 'bundle install'!"
+
+log "Setting up the project ..."
+bundle exec rake setup || "Failed to run 'rake setup'!"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ronin-db
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: java
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-19 00:00:00.000000000 Z
+date: 2024-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -17,27 +17,41 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '70.0'
   name: activerecord-jdbcsqlite3-adapter
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '70.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+  name: activerecord
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.1.0
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   name: ronin-db-activerecord
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -45,8 +59,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
   name: ronin-support
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -57,15 +71,15 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   name: ronin-core
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -73,8 +87,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
   name: bundler
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -108,12 +122,15 @@ files:
 - README.md
 - Rakefile
 - bin/ronin-db
+- data/completions/ronin-db
 - gemspec.yml
 - lib/ronin/db.rb
 - lib/ronin/db/cli.rb
 - lib/ronin/db/cli/command.rb
 - lib/ronin/db/cli/commands/add.rb
 - lib/ronin/db/cli/commands/asn.rb
+- lib/ronin/db/cli/commands/certs.rb
+- lib/ronin/db/cli/commands/completion.rb
 - lib/ronin/db/cli/commands/creds.rb
 - lib/ronin/db/cli/commands/edit.rb
 - lib/ronin/db/cli/commands/emails.rb
@@ -122,23 +139,40 @@ files:
 - lib/ronin/db/cli/commands/irb.rb
 - lib/ronin/db/cli/commands/list.rb
 - lib/ronin/db/cli/commands/migrate.rb
+- lib/ronin/db/cli/commands/open_ports.rb
+- lib/ronin/db/cli/commands/oses.rb
+- lib/ronin/db/cli/commands/passwords.rb
+- lib/ronin/db/cli/commands/people.rb
+- lib/ronin/db/cli/commands/phone_numbers.rb
+- lib/ronin/db/cli/commands/ports.rb
 - lib/ronin/db/cli/commands/remove.rb
+- lib/ronin/db/cli/commands/services.rb
+- lib/ronin/db/cli/commands/software.rb
+- lib/ronin/db/cli/commands/street_addresses.rb
 - lib/ronin/db/cli/commands/urls.rb
-- lib/ronin/db/cli/database_command.rb
+- lib/ronin/db/cli/commands/web_vulns.rb
+- lib/ronin/db/cli/database_options.rb
+- lib/ronin/db/cli/deletable.rb
+- lib/ronin/db/cli/importable.rb
 - lib/ronin/db/cli/model_command.rb
 - lib/ronin/db/cli/modifiable.rb
-- lib/ronin/db/cli/resources_command.rb
+- lib/ronin/db/cli/printing.rb
 - lib/ronin/db/cli/ruby_shell.rb
 - lib/ronin/db/cli/uri_methods.rb
 - lib/ronin/db/config_file.rb
 - lib/ronin/db/exceptions.rb
 - lib/ronin/db/home.rb
 - lib/ronin/db/root.rb
+- lib/ronin/db/tasks.rb
 - lib/ronin/db/version.rb
 - man/ronin-db-add.1
 - man/ronin-db-add.1.md
 - man/ronin-db-asn.1
 - man/ronin-db-asn.1.md
+- man/ronin-db-certs.1
+- man/ronin-db-certs.1.md
+- man/ronin-db-completion.1
+- man/ronin-db-completion.1.md
 - man/ronin-db-creds.1
 - man/ronin-db-creds.1.md
 - man/ronin-db-edit.1
@@ -155,11 +189,34 @@ files:
 - man/ronin-db-list.1.md
 - man/ronin-db-migrate.1
 - man/ronin-db-migrate.1.md
+- man/ronin-db-open-ports.1
+- man/ronin-db-open-ports.1.md
+- man/ronin-db-oses.1
+- man/ronin-db-oses.1.md
+- man/ronin-db-passwords.1
+- man/ronin-db-passwords.1.md
+- man/ronin-db-people.1
+- man/ronin-db-people.1.md
+- man/ronin-db-phone-numbers.1
+- man/ronin-db-phone-numbers.1.md
+- man/ronin-db-ports.1
+- man/ronin-db-ports.1.md
 - man/ronin-db-remove.1
 - man/ronin-db-remove.1.md
+- man/ronin-db-services.1
+- man/ronin-db-services.1.md
+- man/ronin-db-software.1
+- man/ronin-db-software.1.md
+- man/ronin-db-street-addresses.1
+- man/ronin-db-street-addresses.1.md
 - man/ronin-db-urls.1
 - man/ronin-db-urls.1.md
+- man/ronin-db-web-vulns.1
+- man/ronin-db-web-vulns.1.md
+- man/ronin-db.1
+- man/ronin-db.1.md
 - ronin-db.gemspec
+- scripts/setup
 homepage: https://ronin-rb.dev
 licenses:
 - LGPL-3.0

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

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-#
-# ronin-db - A common database library for managing and querying security data.
-#
-# Copyright (c) 2006-2023 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/cli/uri_methods'
-require 'ronin/db'
-
-module Ronin
-  module DB
-    class CLI
-      #
-      # Base class for all commands that access the database.
-      #
-      class DatabaseCommand < Command
-
-        include URIMethods
-
-        option :db, value: {
-                      type:    DB.config.keys,
-                      default: :default,
-                      usage:   'NAME'
-                    },
-                    desc: 'The database to connect to'
-
-        option :db_uri, value: {
-                          type:  String,
-                          usage: 'URI'
-                        },
-                        desc: 'The database URI to connect to'
-
-        #
-        # The database connection configuration.
-        #
-        # @return [Hash{Symbol => String,Integer}]
-        #
-        def config
-          if options[:db_uri]
-            parse_uri(options[:db_uri])
-          else
-            DB.config[options[:db]]
-          end
-        end
-
-        #
-        # Connects to the database.
-        #
-        def connect
-          DB.connect(config)
-        end
-
-      end
-    end
-  end
-end

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

@@ -1,118 +0,0 @@
-# frozen_string_literal: true
-#
-# ronin-db - A common database library for managing and querying security data.
-#
-# Copyright (c) 2006-2023 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/ui/cli/model_command'
-require 'ronin/db/model/importable'
-
-require 'dm-serializer'
-
-module Ronin
-  module DB
-    module CLI
-      #
-      # A base-command class for listing Database Resources.
-      #
-      class ResourcesCommand < ModelCommand
-
-        option :csv, type:        true,
-                     description: 'CSV output'
-
-        option :xml, type:        true,
-                     description: 'XML output'
-
-        option :yaml, type:        true,
-                      description: 'YAML output'
-
-        option :json, type:        true,
-                      description: 'JSON output'
-
-        #
-        # Default method performs the query and prints the found resources.
-        #
-        # @since 1.1.0
-        #
-        # @api semipublic
-        #
-        def execute
-          if @import
-            self.class.model.import(@import) do |resource|
-              print_info "Imported #{resource}"
-            end
-          else
-            print_resources(query)
-          end
-        end
-
-        #
-        # Sets the model used by the command.
-        #
-        # @see ModelCommand.model
-        #
-        # @since 1.3.0
-        #
-        def self.model(model=nil)
-          if (model && model < Model::Importable)
-            option :import, type:        String,
-                            flag:        '-i',
-                            usage:       'FILE',
-                            description: 'The file to import'
-          end
-
-          return super(model)
-        end
-
-        #
-        # Default method which will print every queried resource.
-        #
-        # @param [DataMapper::Resource] resource
-        #   A queried resource from the Database.
-        #
-        # @since 1.1.0
-        #
-        # @api semipublic
-        #
-        def print_resource(resource)
-          puts resource
-        end
-
-        #
-        # Prints multiple resources.
-        #
-        # @param [DataMapper::Collection] resources
-        #   The query to print.
-        #
-        # @since 1.1.0
-        #
-        # @api semipublic
-        #
-        def print_resources(resources)
-          if    csv?  then puts resources.to_csv
-          elsif xml?  then puts resources.to_xml
-          elsif yaml? then puts resources.to_yaml
-          elsif json? then puts resources.to_json
-          else
-            resources.each { |resource| print_resource(resource) }
-          end
-        end
-
-      end
-    end
-  end
-end