ronin-db-activerecord 0.1.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dd392f2b9e53d8ff6b173b9cd94446c697f9599dbc2b0856be0573348b165f24
+  data.tar.gz: a9bf2c3f9514573d96051989add083a7b9cf21ffa6566291ed137ef18cc0f2e1
+SHA512:
+  metadata.gz: dd1e3a5d8de8cbf215ccdca2792e009a721d5c5e58ec7a51cb9544af6143db057db4ec0ebd2ea705d1a77163c2fc1e1f8cee19a62ca5acb22108074080283227
+  data.tar.gz: 24c12a357299f9644036bf0bf60514b154f08f747192dcb4b2a158e8dfd0a5454795f67664b6540a118c0fb51fced982d55a57b46f041383aabab2a54afa48d5

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-activerecord 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,39 @@
+### 0.1.0 / 2023-XX-XX
+
+* Initial release:
+  * Can be used both as a standalone library or in a web app.
+  * Provides common [ActiveRecord] models:
+    * {Ronin::DB::Advisory}
+    * {Ronin::DB::Arch}
+    * {Ronin::DB::ASN}
+    * {Ronin::DB::EmailAddress}
+    * {Ronin::DB::HostName}
+    * {Ronin::DB::HostNameIPAddress}
+    * {Ronin::DB::HTTPHeaderName}
+    * {Ronin::DB::HTTPQueryParam}
+    * {Ronin::DB::HTTPQueryParamName}
+    * {Ronin::DB::HTTPRequest}
+    * {Ronin::DB::HTTPRequestHeader}
+    * {Ronin::DB::HTTPResponse}
+    * {Ronin::DB::HTTPResponseHeader}
+    * {Ronin::DB::IPAddress}
+    * {Ronin::DB::IPAddressMACAddress}
+    * {Ronin::DB::MACAddress}
+    * {Ronin::DB::OpenPort}
+    * {Ronin::DB::Organization}
+    * {Ronin::DB::OS}
+    * {Ronin::DB::OSGuess}
+    * {Ronin::DB::Password}
+    * {Ronin::DB::Port}
+    * {Ronin::DB::Service}
+    * {Ronin::DB::ServiceCredential}
+    * {Ronin::DB::Software}
+    * {Ronin::DB::SoftwareVendor}
+    * {Ronin::DB::URL}
+    * {Ronin::DB::URLQueryParam}
+    * {Ronin::DB::URLQueryParamName}
+    * {Ronin::DB::URLScheme}
+    * {Ronin::DB::UserName}
+    * {Ronin::DB::Vulnerability}
+    * {Ronin::DB::WebCredential}
+

data/Gemfile

@@ -0,0 +1,27 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'sqlite3', '~> 1.0', platforms: [:mri, :truffleruby]
+
+platform :jruby do
+  gem 'jruby-openssl',	'~> 0.7'
+  gem 'activerecord-jdbcsqlite3-adapter', '~> 70.0.pre'
+end
+
+group :development do
+  gem 'rake'
+  gem 'rubygems-tasks',  '~> 0.2'
+
+  gem 'rspec',           '~> 3.0'
+  gem 'simplecov',       '~> 0.20'
+
+  gem 'kramdown',        '~> 2.0'
+  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,143 @@
+# ronin-db-activerecord
+
+[![CI](https://github.com/ronin-rb/ronin-db-activerecord/actions/workflows/ruby.yml/badge.svg)](https://github.com/ronin-rb/ronin-db-activerecord/actions/workflows/ruby.yml)
+[![Code Climate](https://codeclimate.com/github/ronin-rb/ronin-db-activerecord.svg)](https://codeclimate.com/github/ronin-rb/ronin-db-activerecord)
+
+* [Website](https://ronin-rb.dev/)
+* [Source](https://github.com/ronin-rb/ronin-db-activerecord)
+* [Issues](https://github.com/ronin-rb/ronin-db-activerecord/issues)
+* [Documentation](https://ronin-rb.dev/docs/ronin-db-activerecord/frames)
+* [Discord](https://discord.gg/6WAb3PsVX9) |
+  [Twitter](https://twitter.com/ronin_rb) |
+  [Mastodon](https://infosec.exchange/@ronin_rb)
+
+## Description
+
+ronin-db-activerecord contains [ActiveRecord] models and migrations for the
+[Ronin Database][ronin-db].
+
+## Features
+
+* Can be used both as a standalone library or in a web app.
+* Provides common [ActiveRecord] models:
+  * {Ronin::DB::Advisory}
+  * {Ronin::DB::Arch}
+  * {Ronin::DB::ASN}
+  * {Ronin::DB::EmailAddress}
+  * {Ronin::DB::HostName}
+  * {Ronin::DB::HostNameIPAddress}
+  * {Ronin::DB::HTTPHeaderName}
+  * {Ronin::DB::HTTPQueryParam}
+  * {Ronin::DB::HTTPQueryParamName}
+  * {Ronin::DB::HTTPRequest}
+  * {Ronin::DB::HTTPRequestHeader}
+  * {Ronin::DB::HTTPResponse}
+  * {Ronin::DB::HTTPResponseHeader}
+  * {Ronin::DB::IPAddress}
+  * {Ronin::DB::IPAddressMACAddress}
+  * {Ronin::DB::MACAddress}
+  * {Ronin::DB::OpenPort}
+  * {Ronin::DB::Organization}
+  * {Ronin::DB::OS}
+  * {Ronin::DB::OSGuess}
+  * {Ronin::DB::Password}
+  * {Ronin::DB::Port}
+  * {Ronin::DB::Service}
+  * {Ronin::DB::ServiceCredential}
+  * {Ronin::DB::Software}
+  * {Ronin::DB::SoftwareVendor}
+  * {Ronin::DB::URL}
+  * {Ronin::DB::URLQueryParam}
+  * {Ronin::DB::URLQueryParamName}
+  * {Ronin::DB::URLScheme}
+  * {Ronin::DB::UserName}
+  * {Ronin::DB::Vulnerability}
+  * {Ronin::DB::WebCredential}
+* Has 96% documentation coverage.
+* Has 99% test coverage.
+
+## Examples
+
+Create a database:
+
+```ruby
+require 'ronin/db/migrations'
+
+ActiveRecord::Base.establish_connection(
+  adapter: 'sqlite3',
+  database: 'path/to/db.sqlite3'
+)
+
+Ronin::DB::Migrations.up
+```
+
+Connect to the database:
+
+```ruby
+ActiveRecord::Base.establish_connection(
+  adapter: 'sqlite3',
+  database: 'path/to/db.sqlite3'
+)
+
+require 'ronin/db/models'
+Ronin::DB::Models.connect
+```
+
+## Requirements
+
+* [Ruby] >= 3.0.0
+* [activerecord] ~> 7.0
+
+## Install
+
+```shell
+$ gem install ronin-db-activerecord
+```
+
+### Gemfile
+
+```ruby
+gem 'ronin-db-activerecord', '~> 0.1'
+```
+
+### gemspec
+
+```ruby
+gem.add_dependency 'ronin-db-activerecord', '~> 0.1'
+```
+
+## Development
+
+1. [Fork It!](https://github.com/ronin-rb/ronin-db-activerecord/fork)
+2. Clone It!
+3. `cd ronin-db-activerecord/`
+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) 2022 Hal Brodigan (postmodern.mod3@gmail.com)
+
+ronin-db-activerecord 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-activerecord 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-activerecord.  If not, see <https://www.gnu.org/licenses/>.
+
+[Ruby]: https://www.ruby-lang.org
+[ActiveRecord]: https://guides.rubyonrails.org/active_record_basics.html
+[activerecord]: https://github.com/rails/rails/tree/main/activerecord#readme
+[ronin-db]: https://github.com/ronin-rb/ronin-db#readme

data/Rakefile

@@ -0,0 +1,72 @@
+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
+task :docs => :yard
+
+file 'db/dev.sqlite3' => '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
+    lib_dir = File.expand_path('lib')
+    $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+    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
+
+    require 'irb'
+    include Ronin::DB
+    ARGV.clear
+    IRB.start()
+  end
+end

data/db/migrate/0001_create_ronin_ip_address_mac_addresses_table.rb

@@ -0,0 +1,43 @@
+#
+# ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
+#
+# Copyright (c) 2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of ronin-db-activerecord.
+#
+# ronin-db-activerecord 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-activerecord 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-activerecord.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+class CreateRoninIpAddressMacAddressesTable < ActiveRecord::Migration[7.0]
+
+  def change
+    create_table :ronin_ip_address_mac_addresses, if_not_exists: true do |t|
+      t.references :ip_address, null: false,
+                                foreign_key: {
+                                  to_table: :ronin_ip_addresses
+                                }
+      t.references :mac_address, null: false,
+                                 foreign_key: {
+                                   to_table: :ronin_mac_addresses
+                                 }
+      t.datetime :created_at, null: false
+
+      t.index [:ip_address_id, :mac_address_id], unique: true,
+                                                 name: :index_ronin_ip_address_mac_addresses_unique
+      t.index :ip_address_id
+      t.index :mac_address_id
+    end
+  end
+
+end

data/db/migrate/0002_create_ronin_vulnerabilities_table.rb

@@ -0,0 +1,61 @@
+#
+# ronin-exploits - A Ruby library for ronin-rb that provides exploitation and
+# payload crafting functionality.
+#
+# Copyright (c) 2007-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of ronin-exploits.
+#
+# ronin-exploits is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-exploits 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with ronin-exploits.  If not, see <https://www.gnu.org/licenses/>
+#
+
+class CreateRoninVulnerabilitiesTable < ActiveRecord::Migration[7.0]
+
+  def change
+    create_table :ronin_vulnerabilities, if_not_exists: true do |t|
+      t.references :mac_address, null: true,
+                                foreign_key: {
+                                  to_table: :ronin_mac_addresses
+                                }
+      t.references :ip_address, null: true,
+                                foreign_key: {
+                                  to_table: :ronin_ip_addresses
+                                }
+      t.references :host_name, null: true,
+                               foreign_key: {
+                                 to_table: :ronin_host_names
+                               }
+      t.references :open_port, null: true,
+                              foreign_key: {
+                                to_table: :ronin_open_ports
+                              }
+      t.references :url, null: true,
+                         foreign_key: {
+                           to_table: :ronin_urls
+                         }
+      t.references :advisory, null: false,
+                              foreign_key: {
+                                to_table: :ronin_advisories
+                              }
+
+      t.index :mac_address_id
+      t.index :ip_address_id
+      t.index :host_name_id
+      t.index :open_port_id
+      t.index :url_id
+      t.index :advisory_id
+    end
+  end
+
+end

data/db/migrate/0003_create_ronin_url_schemes_table.rb

@@ -0,0 +1,32 @@
+#
+# ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
+#
+# Copyright (c) 2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of ronin-db-activerecord.
+#
+# ronin-db-activerecord 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-activerecord 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-activerecord.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+class CreateRoninUrlSchemesTable < ActiveRecord::Migration[7.0]
+
+  def change
+    create_table :ronin_url_schemes, if_not_exists: true do |t|
+      t.string :name, null: false
+
+      t.index :name, unique: true
+    end
+  end
+
+end