ronin-db 0.1.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c4f57bb04bf0c801058eac58f81ea47a012ae09fd436844aff792fbbc4a4d167
+  data.tar.gz: 95b54bb12c66525fb558ef99e4189ef3bf87a4cf55c70eab95aa75b082e73699
+SHA512:
+  metadata.gz: 16f1f97387b3b74a23c074d41fc0d91dfd5b4bc79d980666adb1b2f089904b471a777c5836abf729459cd2ef1664cf9fef2ab939fd6cb1ceccffe445535284ee
+  data.tar.gz: a0fc97bb5026c89cb3d81e850d3eac919f37cbb9b225b3437f4cc937e1c3d96f5152c1cd50fbd03501b5f9afd207f2d5e2ee2df1f3a90338440f8e6ddad8b9ac

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+- 
+ChangeLog.md
+COPYING.txt
+man/*.md

data/.github/workflows/ruby.yml

@@ -0,0 +1,31 @@
+name: CI
+
+on: [ push, pull_request ]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - jruby
+          - truffleruby
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install libsqlite3
+        run: |
+          sudo apt update -y && \
+          sudo apt install -y --no-install-recommends --no-install-suggests libsqlite3-dev
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      - name: Run tests
+        run: bundle exec rake test

data/.gitignore

@@ -0,0 +1,13 @@
+/coverage
+/doc
+/pkg
+/man/*.[1-9]
+/vendor/bundle
+/Gemfile.lock
+/.bundle
+/.yardoc
+.DS_Store
+*.db
+*.log
+*.swp
+*~

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.1

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title 'Ronin DB Documentation' --protected

data/COPYING.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/ChangeLog.md

@@ -0,0 +1,12 @@
+### 0.1.0 / 2023-XX-XX
+
+* Initial release:
+  * Uses a [sqlite] database by default.
+  * Provides common [ActiveRecord models][ronin-db-activerecord] for interacting
+    with the database tables.
+  * Provides a `ronin-db` command for easy management of the database(s).
+  * Provides additional commands for querying, inserting, deleting entries from
+    various database tables.
+
+[sqlite]: https://sqlite.org/
+[ronin-db-activerecord]: https://github.com/ronin-rb/ronin-db-activerecord#readme

data/Gemfile

@@ -0,0 +1,39 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'sqlite3', '~> 1.0', platform: :mri
+
+platform :jruby do
+  gem 'jruby-openssl',	'~> 0.7'
+  gem 'activerecord-jdbcsqlite3-adapter', '~> 70.0.pre'
+end
+
+# gem 'command_kit', '0.4.0', github: 'postmodern/command_kit',
+#                             branch: 'main'
+
+# Library dependencies
+# gem 'ronin-db-activerecord', '~> 0.1', github: "ronin-rb/ronin-db-activerecord",
+#                                        branch: 'main'
+# gem 'ronin-support',	       '~> 1.0', github: "ronin-rb/ronin-support",
+#                                        branch: '1.0.0'
+# gem 'ronin-core',	           '~> 0.1', github: "ronin-rb/ronin-core",
+#                                        branch: 'main'
+
+group :development do
+  gem 'rake'
+  gem 'rubygems-tasks',  '~> 0.1'
+  gem 'rspec',           '~> 3.0'
+  gem 'simplecov',       '~> 0.20'
+
+  gem 'kramdown',        '~> 2.0'
+  gem 'kramdown-man',    '~> 0.1'
+
+  gem 'redcarpet',       platform: :mri
+  gem 'yard',            '~> 0.9'
+  gem 'yard-spellcheck', require: false
+
+  gem 'dead_end',        require: false
+  gem 'sord',            require: false, platform: :mri
+  gem 'stackprof',       require: false, platform: :mri
+end

data/README.md

@@ -0,0 +1,272 @@
+# ronin-db
+
+[![CI](https://github.com/ronin-rb/ronin-db/actions/workflows/ruby.yml/badge.svg)](https://github.com/ronin-rb/ronin-db/actions/workflows/ruby.yml)
+[![Code Climate](https://codeclimate.com/github/ronin-rb/ronin-db.svg)](https://codeclimate.com/github/ronin-rb/ronin-db)
+
+* [Website](https://ronin-rb.dev)
+* [Source](https://github.com/ronin-rb/ronin-db)
+* [Issues](https://github.com/ronin-rb/ronin-db/issues)
+* [Documentation](https://ronin-rb.dev/docs/ronin-db/frames)
+* [Discord](https://discord.gg/6WAb3PsVX9) |
+  [Twitter](https://twitter.com/ronin_rb) |
+  [Mastodon](https://infosec.exchange/@ronin_rb)
+
+## Description
+
+ronin-db is a common database library for managing and querying security data.
+ronin-db provides common ORM models for interacting with the database's SQL
+tables and inserting/querying security data, such as URLs, email addresses,
+host names, IPs, ports, etc. ronin-db also provides CLI commands for managing
+the database(s).
+
+ronin-db is part of the [ronin-rb] project, a [Ruby] toolkit for security
+research and development.
+
+## Features
+
+* Uses a [sqlite] database by default.
+* Provides common [ActiveRecord models][ronin-db-activerecord] for interacting
+  with the database tables.
+* Provides a `ronin-db` command for easy management of the database(s).
+* Provides additional commands for querying, inserting, deleting entries from
+  various database tables.
+
+## Synopsis
+
+```
+Usage: ronin-db [options] [COMMAND [ARGS...]]
+
+Options:
+    -h, --help                       Print help information
+
+Arguments:
+    [COMMAND]                        The command name to run
+    [ARGS ...]                       Additional arguments for the command
+
+Commands:
+    add
+    asn
+    creds
+    edit
+    emails
+    help
+    hosts
+    ips
+    irb
+    list
+    migrate
+    remove
+    urls
+```
+
+List available Databases:
+
+```shell
+$ ronin-db list
+```
+
+Add a new Database:
+
+```shell
+$ ronin-db add team-db --uri postgres://user:pass@vpn.example.com/db
+```
+
+Remove a Database:
+
+```shell
+$ ronin-db remove team-db
+```
+
+Add a host name to the database:
+
+```shell
+$ ronin-db hosts --add example.com
+$ ronin-db hosts --add www.example.com
+```
+
+List host names in the database:
+
+```shell
+$ ronin-db hosts
+example.com
+www.example.com
+...
+```
+
+Queries only certain host names:
+
+```shell
+$ ronin-db hosts --domain example.com
+example.com
+www.example.com
+...
+```
+
+Imports a file of host names:
+
+```shell
+$ ronin-db hosts --import targets.txt
+```
+
+## Examples
+
+Manually creating the database:
+
+```ruby
+require 'ronin/db'
+
+Ronin::DB.connect(migrate: true)
+```
+
+Connecting to the default database:
+
+```ruby
+require 'ronin/db'
+
+Ronin::DB.connect
+```
+
+Creating a custom database:
+
+```ruby
+require 'ronin/db'
+
+Ronin::DB.connect('sqlite3:path/to/db.sqlite3', migrate: true)
+```
+
+Connecting to a custom database:
+
+```ruby
+require 'ronin/db'
+
+Ronin::DB.connect('sqlite3:path/to/db.sqlite3')
+```
+
+Interacting with the [Ronin::DB][ronin-db-activerecord] models:
+
+```ruby
+require 'ronin/db'
+
+Ronin::DB.connect
+
+Ronin::DB::HostName.create(name: 'www.example.com')
+# =>
+# #<Ronin::DB::HostName:0x00007f3275cc93f0
+#  id: 1,
+#  name: "www.example.com",
+#  last_scanned_at: nil,
+#  created_at: 2022-09-30 05:06:25.633087551 UTC>
+Ronin::DB::HostName.create(name: 'www.example.org')
+# =>
+# #<Ronin::DB::HostName:0x00007f32768b60a0
+#  id: 2,
+#  name: "www.example.org",
+#  last_scanned_at: nil,
+#  created_at: 2022-09-30 05:07:00.996736126 UTC>
+
+host_name = Ronin::DB::HostName.find(2)
+# =>
+# #<Ronin::DB::HostName:0x00007f32758072e0
+#  id: 2,
+#  name: "www.example.org",
+#  last_scanned_at: nil,
+#  created_at: 2000-01-01 05:07:00.996736 UTC>
+
+host_name = Ronin::DB::HostName.first
+# =>
+# #<Ronin::DB::HostName:0x00007f3275cc93f0
+#  id: 1,
+#  name: "www.example.com",
+#  last_scanned_at: nil,
+#  created_at: 2022-09-30 05:06:25.633087551 UTC>
+
+host_names = Ronin::DB::HostName.where(name: 'www.example.com')
+# =>
+# [#<Ronin::DB::HostName:0x00007f327597b4c8
+#   id: 1,
+#   name: "www.example.com",
+#   last_scanned_at: nil,
+#   created_at: 2000-01-01 05:06:25.633087 UTC>]
+
+host_names = Ronin::DB::HostName.where(name: 'www.example.com')
+# =>
+# [#<Ronin::DB::HostName:0x00007f327597b4c8
+#   id: 1,
+#   name: "www.example.com",
+#   last_scanned_at: nil,
+#   created_at: 2000-01-01 05:06:25.633087 UTC>]
+```
+
+For more information on how to query the database models, see [Active Record
+Query Interface](https://guides.rubyonrails.org/active_record_querying.html)
+and [ronin-db-activerecord].
+
+## Requirements
+
+* [Ruby] >= 3.0.0
+* [libsqlite3][sqlite] ~> 1.0
+  (or [activerecord-jdbcsqlite3-adapter] ~> 70.0.pre on JRuby)
+* [ronin-db-activerecord] ~> 0.1
+* [ronin-support] ~> 1.0
+* [ronin-core] ~> 0.1
+
+## Install
+
+```shell
+$ gem install ronin-db
+```
+
+### Gemfile
+
+```ruby
+gem 'ronin-db', '~> 0.1'
+```
+
+### gemspec
+
+```ruby
+gem.add_dependency 'ronin-db', '~> 0.1'
+```
+
+## Development
+
+1. [Fork It!](https://github.com/ronin-rb/ronin-db/fork)
+2. Clone It!
+3. `cd ronin-db`
+4. `bundle install`
+5. `git checkout -b my_feature`
+6. Code It!
+7. `bundle exec rake spec`
+8. `git push origin my_feature`
+
+If you want to test your changes locally, run `rake db:console` to start a
+local database console.
+
+## License
+
+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/>.
+
+[ronin-rb]: https://ronin-rb.dev/
+[Ruby]: https://www.ruby-lang.org
+
+[sqlite]: https://sqlite.org/
+[uri-query_params]: https://github.com/postmodern/uri-query_params#readme
+[sqlite3]: https://github.com/sparklemotion/sqlite3-ruby#readme
+[activerecord-jdbcsqlite3-adapter]: https://github.com/jruby/activerecord-jdbc-adapter#readme
+[activerecord]: https://github.com/rails/rails/tree/main/activerecord#readme
+[ronin-db-activerecord]: https://github.com/ronin-rb/ronin-db-activerecord#readme
+[ronin-support]: https://github.com/ronin-rb/ronin-support#readme
+[ronin-core]: https://github.com/ronin-rb/ronin-core#readme

data/Rakefile

@@ -0,0 +1,76 @@
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler"
+  exit -1
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'rubygems/tasks'
+Gem::Tasks.new(sign: {checksum: true, pgp: true})
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+task :test    => :spec
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new
+
+desc "Generates all documentation"
+task :docs => :yara
+
+require 'kramdown/man/task'
+Kramdown::Man::Task.new
+
+
+directory 'db'
+file 'db/dev.sqlite3' => %w[db db:migrate]
+
+namespace :db do
+  task :connect do
+    require 'active_record'
+    ActiveRecord::Base.establish_connection(
+      adapter:  'sqlite3',
+      database: 'db/dev.sqlite3'
+    )
+  end
+
+  desc 'Migrates the development database'
+  task :migrate => :connect do
+    require 'ronin/db/migrations'
+    Ronin::DB::Migrations.up
+  end
+
+  desc 'Starts an interactive database console'
+  task :console => 'db/dev.sqlite3' do
+    require 'active_record'
+    ActiveRecord::Base.logger = Logger.new($stderr,:debug)
+
+    ActiveRecord::Base.establish_connection(
+      adapter: 'sqlite3',
+      database: 'db/dev.sqlite3'
+    )
+
+    require 'ronin/db/models'
+    Ronin::DB::Models.connect
+
+    lib_dir = File.expand_path('lib')
+    $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+    require 'ronin/db/cli/ruby_shell'
+    Ronin::DB::CLI::RubyShell.start
+  end
+end

data/bin/ronin-db

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+#
+# Copyright (c) 2021 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of ronin-repos.
+#
+# ronin-repos 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-repos 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-repos.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+root = File.expand_path(File.join(__dir__,'..'))
+if File.file?(File.join(root,'Gemfile.lock'))
+  Dir.chdir(root) do
+    begin
+      require 'bundler/setup'
+    rescue LoadError => e
+      warn e.message
+      warn "Run `gem install bundler` to install Bundler"
+      exit -1
+    end
+  end
+end
+
+require 'ronin/db/cli'
+Ronin::DB::CLI.start