ronin-db 0.1.0.beta1-java

Sign up to get free protection for your applications and to get access to all the features.
Files changed (74) hide show
  1. checksums.yaml +7 -0
  2. data/.document +5 -0
  3. data/.github/workflows/ruby.yml +31 -0
  4. data/.gitignore +13 -0
  5. data/.rspec +1 -0
  6. data/.ruby-version +1 -0
  7. data/.yardopts +1 -0
  8. data/COPYING.txt +165 -0
  9. data/ChangeLog.md +12 -0
  10. data/Gemfile +39 -0
  11. data/README.md +272 -0
  12. data/Rakefile +76 -0
  13. data/bin/ronin-db +35 -0
  14. data/gemspec.yml +46 -0
  15. data/lib/ronin/db/cli/command.rb +37 -0
  16. data/lib/ronin/db/cli/commands/add.rb +206 -0
  17. data/lib/ronin/db/cli/commands/asn.rb +218 -0
  18. data/lib/ronin/db/cli/commands/creds.rb +80 -0
  19. data/lib/ronin/db/cli/commands/edit.rb +58 -0
  20. data/lib/ronin/db/cli/commands/emails.rb +90 -0
  21. data/lib/ronin/db/cli/commands/hosts.rb +100 -0
  22. data/lib/ronin/db/cli/commands/ips.rb +100 -0
  23. data/lib/ronin/db/cli/commands/irb.rb +81 -0
  24. data/lib/ronin/db/cli/commands/list.rb +124 -0
  25. data/lib/ronin/db/cli/commands/migrate.rb +75 -0
  26. data/lib/ronin/db/cli/commands/remove.rb +69 -0
  27. data/lib/ronin/db/cli/commands/urls.rb +170 -0
  28. data/lib/ronin/db/cli/database_command.rb +71 -0
  29. data/lib/ronin/db/cli/model_command.rb +202 -0
  30. data/lib/ronin/db/cli/modifiable.rb +141 -0
  31. data/lib/ronin/db/cli/resources_command.rb +120 -0
  32. data/lib/ronin/db/cli/ruby_shell.rb +51 -0
  33. data/lib/ronin/db/cli/uri_methods.rb +97 -0
  34. data/lib/ronin/db/cli.rb +38 -0
  35. data/lib/ronin/db/config_file.rb +132 -0
  36. data/lib/ronin/db/exceptions.rb +26 -0
  37. data/lib/ronin/db/home.rb +36 -0
  38. data/lib/ronin/db/root.rb +28 -0
  39. data/lib/ronin/db/version.rb +26 -0
  40. data/lib/ronin/db.rb +123 -0
  41. data/man/ronin-db-add.1 +99 -0
  42. data/man/ronin-db-add.1.md +75 -0
  43. data/man/ronin-db-asn.1 +79 -0
  44. data/man/ronin-db-asn.1.md +59 -0
  45. data/man/ronin-db-creds.1 +78 -0
  46. data/man/ronin-db-creds.1.md +58 -0
  47. data/man/ronin-db-edit.1 +48 -0
  48. data/man/ronin-db-edit.1.md +36 -0
  49. data/man/ronin-db-emails.1 +82 -0
  50. data/man/ronin-db-emails.1.md +61 -0
  51. data/man/ronin-db-hosts.1 +86 -0
  52. data/man/ronin-db-hosts.1.md +64 -0
  53. data/man/ronin-db-ips.1 +90 -0
  54. data/man/ronin-db-ips.1.md +67 -0
  55. data/man/ronin-db-irb.1 +61 -0
  56. data/man/ronin-db-irb.1.md +46 -0
  57. data/man/ronin-db-list.1 +58 -0
  58. data/man/ronin-db-list.1.md +44 -0
  59. data/man/ronin-db-migrate.1 +44 -0
  60. data/man/ronin-db-migrate.1.md +32 -0
  61. data/man/ronin-db-remove.1 +55 -0
  62. data/man/ronin-db-remove.1.md +42 -0
  63. data/man/ronin-db-urls.1 +98 -0
  64. data/man/ronin-db-urls.1.md +73 -0
  65. data/ronin-db.gemspec +78 -0
  66. data/spec/cli/commands/add_spec.rb +220 -0
  67. data/spec/cli/commands/edit_spec.rb +12 -0
  68. data/spec/cli/commands/irb_spec.rb +26 -0
  69. data/spec/cli/database_command_spec.rb +53 -0
  70. data/spec/cli/model_command_spec.rb +237 -0
  71. data/spec/cli/ruby_shell_spec.rb +14 -0
  72. data/spec/cli/uri_methods_spec.rb +190 -0
  73. data/spec/spec_helper.rb +15 -0
  74. metadata +200 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: fda62542d7e3cc84f8d6d835cdaca71db0a9e1f38bbee3022935b17039fc95fd
4
+ data.tar.gz: 271084207abc32d30e9a47f6cc39b371fbf81d5d3d43a4487c4a948da204bc9b
5
+ SHA512:
6
+ metadata.gz: 5a4e7262739d0115ab9dbf11e88e899ca71f0a4f266dd9c4e49f6fcad506cd3cd223d5f580cda07c6ec779dc00c9475a3774fd8d4a28554b99ad9287e1593ac0
7
+ data.tar.gz: 64016ad8d5be6b2a7d0b392ae3b976b88b629395c546570ce9c914dee465ff7353b846d5b4570ced210c98cb13da6f88e0ce1a5d44d153b08da76befddadce2a
data/.document ADDED
@@ -0,0 +1,5 @@
1
+ lib/**/*.rb
2
+ -
3
+ ChangeLog.md
4
+ COPYING.txt
5
+ man/*.md
@@ -0,0 +1,31 @@
1
+ name: CI
2
+
3
+ on: [ push, pull_request ]
4
+
5
+ jobs:
6
+ tests:
7
+ runs-on: ubuntu-latest
8
+ strategy:
9
+ fail-fast: false
10
+ matrix:
11
+ ruby:
12
+ - '3.0'
13
+ - '3.1'
14
+ - '3.2'
15
+ - jruby
16
+ - truffleruby
17
+ name: Ruby ${{ matrix.ruby }}
18
+ steps:
19
+ - uses: actions/checkout@v2
20
+ - name: Set up Ruby
21
+ uses: ruby/setup-ruby@v1
22
+ with:
23
+ ruby-version: ${{ matrix.ruby }}
24
+ - name: Install libsqlite3
25
+ run: |
26
+ sudo apt update -y && \
27
+ sudo apt install -y --no-install-recommends --no-install-suggests libsqlite3-dev
28
+ - name: Install dependencies
29
+ run: bundle install --jobs 4 --retry 3
30
+ - name: Run tests
31
+ run: bundle exec rake test
data/.gitignore ADDED
@@ -0,0 +1,13 @@
1
+ /coverage
2
+ /doc
3
+ /pkg
4
+ /man/*.[1-9]
5
+ /vendor/bundle
6
+ /Gemfile.lock
7
+ /.bundle
8
+ /.yardoc
9
+ .DS_Store
10
+ *.db
11
+ *.log
12
+ *.swp
13
+ *~
data/.rspec ADDED
@@ -0,0 +1 @@
1
+ --colour --format documentation
data/.ruby-version ADDED
@@ -0,0 +1 @@
1
+ ruby-3.1
data/.yardopts ADDED
@@ -0,0 +1 @@
1
+ --markup markdown --title 'Ronin DB Documentation' --protected
data/COPYING.txt ADDED
@@ -0,0 +1,165 @@
1
+ GNU LESSER GENERAL PUBLIC LICENSE
2
+ Version 3, 29 June 2007
3
+
4
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
5
+ Everyone is permitted to copy and distribute verbatim copies
6
+ of this license document, but changing it is not allowed.
7
+
8
+
9
+ This version of the GNU Lesser General Public License incorporates
10
+ the terms and conditions of version 3 of the GNU General Public
11
+ License, supplemented by the additional permissions listed below.
12
+
13
+ 0. Additional Definitions.
14
+
15
+ As used herein, "this License" refers to version 3 of the GNU Lesser
16
+ General Public License, and the "GNU GPL" refers to version 3 of the GNU
17
+ General Public License.
18
+
19
+ "The Library" refers to a covered work governed by this License,
20
+ other than an Application or a Combined Work as defined below.
21
+
22
+ An "Application" is any work that makes use of an interface provided
23
+ by the Library, but which is not otherwise based on the Library.
24
+ Defining a subclass of a class defined by the Library is deemed a mode
25
+ of using an interface provided by the Library.
26
+
27
+ A "Combined Work" is a work produced by combining or linking an
28
+ Application with the Library. The particular version of the Library
29
+ with which the Combined Work was made is also called the "Linked
30
+ Version".
31
+
32
+ The "Minimal Corresponding Source" for a Combined Work means the
33
+ Corresponding Source for the Combined Work, excluding any source code
34
+ for portions of the Combined Work that, considered in isolation, are
35
+ based on the Application, and not on the Linked Version.
36
+
37
+ The "Corresponding Application Code" for a Combined Work means the
38
+ object code and/or source code for the Application, including any data
39
+ and utility programs needed for reproducing the Combined Work from the
40
+ Application, but excluding the System Libraries of the Combined Work.
41
+
42
+ 1. Exception to Section 3 of the GNU GPL.
43
+
44
+ You may convey a covered work under sections 3 and 4 of this License
45
+ without being bound by section 3 of the GNU GPL.
46
+
47
+ 2. Conveying Modified Versions.
48
+
49
+ If you modify a copy of the Library, and, in your modifications, a
50
+ facility refers to a function or data to be supplied by an Application
51
+ that uses the facility (other than as an argument passed when the
52
+ facility is invoked), then you may convey a copy of the modified
53
+ version:
54
+
55
+ a) under this License, provided that you make a good faith effort to
56
+ ensure that, in the event an Application does not supply the
57
+ function or data, the facility still operates, and performs
58
+ whatever part of its purpose remains meaningful, or
59
+
60
+ b) under the GNU GPL, with none of the additional permissions of
61
+ this License applicable to that copy.
62
+
63
+ 3. Object Code Incorporating Material from Library Header Files.
64
+
65
+ The object code form of an Application may incorporate material from
66
+ a header file that is part of the Library. You may convey such object
67
+ code under terms of your choice, provided that, if the incorporated
68
+ material is not limited to numerical parameters, data structure
69
+ layouts and accessors, or small macros, inline functions and templates
70
+ (ten or fewer lines in length), you do both of the following:
71
+
72
+ a) Give prominent notice with each copy of the object code that the
73
+ Library is used in it and that the Library and its use are
74
+ covered by this License.
75
+
76
+ b) Accompany the object code with a copy of the GNU GPL and this license
77
+ document.
78
+
79
+ 4. Combined Works.
80
+
81
+ You may convey a Combined Work under terms of your choice that,
82
+ taken together, effectively do not restrict modification of the
83
+ portions of the Library contained in the Combined Work and reverse
84
+ engineering for debugging such modifications, if you also do each of
85
+ the following:
86
+
87
+ a) Give prominent notice with each copy of the Combined Work that
88
+ the Library is used in it and that the Library and its use are
89
+ covered by this License.
90
+
91
+ b) Accompany the Combined Work with a copy of the GNU GPL and this license
92
+ document.
93
+
94
+ c) For a Combined Work that displays copyright notices during
95
+ execution, include the copyright notice for the Library among
96
+ these notices, as well as a reference directing the user to the
97
+ copies of the GNU GPL and this license document.
98
+
99
+ d) Do one of the following:
100
+
101
+ 0) Convey the Minimal Corresponding Source under the terms of this
102
+ License, and the Corresponding Application Code in a form
103
+ suitable for, and under terms that permit, the user to
104
+ recombine or relink the Application with a modified version of
105
+ the Linked Version to produce a modified Combined Work, in the
106
+ manner specified by section 6 of the GNU GPL for conveying
107
+ Corresponding Source.
108
+
109
+ 1) Use a suitable shared library mechanism for linking with the
110
+ Library. A suitable mechanism is one that (a) uses at run time
111
+ a copy of the Library already present on the user's computer
112
+ system, and (b) will operate properly with a modified version
113
+ of the Library that is interface-compatible with the Linked
114
+ Version.
115
+
116
+ e) Provide Installation Information, but only if you would otherwise
117
+ be required to provide such information under section 6 of the
118
+ GNU GPL, and only to the extent that such information is
119
+ necessary to install and execute a modified version of the
120
+ Combined Work produced by recombining or relinking the
121
+ Application with a modified version of the Linked Version. (If
122
+ you use option 4d0, the Installation Information must accompany
123
+ the Minimal Corresponding Source and Corresponding Application
124
+ Code. If you use option 4d1, you must provide the Installation
125
+ Information in the manner specified by section 6 of the GNU GPL
126
+ for conveying Corresponding Source.)
127
+
128
+ 5. Combined Libraries.
129
+
130
+ You may place library facilities that are a work based on the
131
+ Library side by side in a single library together with other library
132
+ facilities that are not Applications and are not covered by this
133
+ License, and convey such a combined library under terms of your
134
+ choice, if you do both of the following:
135
+
136
+ a) Accompany the combined library with a copy of the same work based
137
+ on the Library, uncombined with any other library facilities,
138
+ conveyed under the terms of this License.
139
+
140
+ b) Give prominent notice with the combined library that part of it
141
+ is a work based on the Library, and explaining where to find the
142
+ accompanying uncombined form of the same work.
143
+
144
+ 6. Revised Versions of the GNU Lesser General Public License.
145
+
146
+ The Free Software Foundation may publish revised and/or new versions
147
+ of the GNU Lesser General Public License from time to time. Such new
148
+ versions will be similar in spirit to the present version, but may
149
+ differ in detail to address new problems or concerns.
150
+
151
+ Each version is given a distinguishing version number. If the
152
+ Library as you received it specifies that a certain numbered version
153
+ of the GNU Lesser General Public License "or any later version"
154
+ applies to it, you have the option of following the terms and
155
+ conditions either of that published version or of any later version
156
+ published by the Free Software Foundation. If the Library as you
157
+ received it does not specify a version number of the GNU Lesser
158
+ General Public License, you may choose any version of the GNU Lesser
159
+ General Public License ever published by the Free Software Foundation.
160
+
161
+ If the Library as you received it specifies that a proxy can decide
162
+ whether future versions of the GNU Lesser General Public License shall
163
+ apply, that proxy's public statement of acceptance of any version is
164
+ permanent authorization for you to choose that version for the
165
+ Library.
data/ChangeLog.md ADDED
@@ -0,0 +1,12 @@
1
+ ### 0.1.0 / 2023-XX-XX
2
+
3
+ * Initial release:
4
+ * Uses a [sqlite] database by default.
5
+ * Provides common [ActiveRecord models][ronin-db-activerecord] for interacting
6
+ with the database tables.
7
+ * Provides a `ronin-db` command for easy management of the database(s).
8
+ * Provides additional commands for querying, inserting, deleting entries from
9
+ various database tables.
10
+
11
+ [sqlite]: https://sqlite.org/
12
+ [ronin-db-activerecord]: https://github.com/ronin-rb/ronin-db-activerecord#readme
data/Gemfile ADDED
@@ -0,0 +1,39 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
4
+
5
+ gem 'sqlite3', '~> 1.0', platform: :mri
6
+
7
+ platform :jruby do
8
+ gem 'jruby-openssl', '~> 0.7'
9
+ gem 'activerecord-jdbcsqlite3-adapter', '~> 70.0.pre'
10
+ end
11
+
12
+ # gem 'command_kit', '0.4.0', github: 'postmodern/command_kit',
13
+ # branch: 'main'
14
+
15
+ # Library dependencies
16
+ # gem 'ronin-db-activerecord', '~> 0.1', github: "ronin-rb/ronin-db-activerecord",
17
+ # branch: 'main'
18
+ # gem 'ronin-support', '~> 1.0', github: "ronin-rb/ronin-support",
19
+ # branch: '1.0.0'
20
+ # gem 'ronin-core', '~> 0.1', github: "ronin-rb/ronin-core",
21
+ # branch: 'main'
22
+
23
+ group :development do
24
+ gem 'rake'
25
+ gem 'rubygems-tasks', '~> 0.1'
26
+ gem 'rspec', '~> 3.0'
27
+ gem 'simplecov', '~> 0.20'
28
+
29
+ gem 'kramdown', '~> 2.0'
30
+ gem 'kramdown-man', '~> 0.1'
31
+
32
+ gem 'redcarpet', platform: :mri
33
+ gem 'yard', '~> 0.9'
34
+ gem 'yard-spellcheck', require: false
35
+
36
+ gem 'dead_end', require: false
37
+ gem 'sord', require: false, platform: :mri
38
+ gem 'stackprof', require: false, platform: :mri
39
+ end
data/README.md ADDED
@@ -0,0 +1,272 @@
1
+ # ronin-db
2
+
3
+ [![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)
4
+ [![Code Climate](https://codeclimate.com/github/ronin-rb/ronin-db.svg)](https://codeclimate.com/github/ronin-rb/ronin-db)
5
+
6
+ * [Website](https://ronin-rb.dev)
7
+ * [Source](https://github.com/ronin-rb/ronin-db)
8
+ * [Issues](https://github.com/ronin-rb/ronin-db/issues)
9
+ * [Documentation](https://ronin-rb.dev/docs/ronin-db/frames)
10
+ * [Discord](https://discord.gg/6WAb3PsVX9) |
11
+ [Twitter](https://twitter.com/ronin_rb) |
12
+ [Mastodon](https://infosec.exchange/@ronin_rb)
13
+
14
+ ## Description
15
+
16
+ ronin-db is a common database library for managing and querying security data.
17
+ ronin-db provides common ORM models for interacting with the database's SQL
18
+ tables and inserting/querying security data, such as URLs, email addresses,
19
+ host names, IPs, ports, etc. ronin-db also provides CLI commands for managing
20
+ the database(s).
21
+
22
+ ronin-db is part of the [ronin-rb] project, a [Ruby] toolkit for security
23
+ research and development.
24
+
25
+ ## Features
26
+
27
+ * Uses a [sqlite] database by default.
28
+ * Provides common [ActiveRecord models][ronin-db-activerecord] for interacting
29
+ with the database tables.
30
+ * Provides a `ronin-db` command for easy management of the database(s).
31
+ * Provides additional commands for querying, inserting, deleting entries from
32
+ various database tables.
33
+
34
+ ## Synopsis
35
+
36
+ ```
37
+ Usage: ronin-db [options] [COMMAND [ARGS...]]
38
+
39
+ Options:
40
+ -h, --help Print help information
41
+
42
+ Arguments:
43
+ [COMMAND] The command name to run
44
+ [ARGS ...] Additional arguments for the command
45
+
46
+ Commands:
47
+ add
48
+ asn
49
+ creds
50
+ edit
51
+ emails
52
+ help
53
+ hosts
54
+ ips
55
+ irb
56
+ list
57
+ migrate
58
+ remove
59
+ urls
60
+ ```
61
+
62
+ List available Databases:
63
+
64
+ ```shell
65
+ $ ronin-db list
66
+ ```
67
+
68
+ Add a new Database:
69
+
70
+ ```shell
71
+ $ ronin-db add team-db --uri postgres://user:pass@vpn.example.com/db
72
+ ```
73
+
74
+ Remove a Database:
75
+
76
+ ```shell
77
+ $ ronin-db remove team-db
78
+ ```
79
+
80
+ Add a host name to the database:
81
+
82
+ ```shell
83
+ $ ronin-db hosts --add example.com
84
+ $ ronin-db hosts --add www.example.com
85
+ ```
86
+
87
+ List host names in the database:
88
+
89
+ ```shell
90
+ $ ronin-db hosts
91
+ example.com
92
+ www.example.com
93
+ ...
94
+ ```
95
+
96
+ Queries only certain host names:
97
+
98
+ ```shell
99
+ $ ronin-db hosts --domain example.com
100
+ example.com
101
+ www.example.com
102
+ ...
103
+ ```
104
+
105
+ Imports a file of host names:
106
+
107
+ ```shell
108
+ $ ronin-db hosts --import targets.txt
109
+ ```
110
+
111
+ ## Examples
112
+
113
+ Manually creating the database:
114
+
115
+ ```ruby
116
+ require 'ronin/db'
117
+
118
+ Ronin::DB.connect(migrate: true)
119
+ ```
120
+
121
+ Connecting to the default database:
122
+
123
+ ```ruby
124
+ require 'ronin/db'
125
+
126
+ Ronin::DB.connect
127
+ ```
128
+
129
+ Creating a custom database:
130
+
131
+ ```ruby
132
+ require 'ronin/db'
133
+
134
+ Ronin::DB.connect('sqlite3:path/to/db.sqlite3', migrate: true)
135
+ ```
136
+
137
+ Connecting to a custom database:
138
+
139
+ ```ruby
140
+ require 'ronin/db'
141
+
142
+ Ronin::DB.connect('sqlite3:path/to/db.sqlite3')
143
+ ```
144
+
145
+ Interacting with the [Ronin::DB][ronin-db-activerecord] models:
146
+
147
+ ```ruby
148
+ require 'ronin/db'
149
+
150
+ Ronin::DB.connect
151
+
152
+ Ronin::DB::HostName.create(name: 'www.example.com')
153
+ # =>
154
+ # #<Ronin::DB::HostName:0x00007f3275cc93f0
155
+ # id: 1,
156
+ # name: "www.example.com",
157
+ # last_scanned_at: nil,
158
+ # created_at: 2022-09-30 05:06:25.633087551 UTC>
159
+ Ronin::DB::HostName.create(name: 'www.example.org')
160
+ # =>
161
+ # #<Ronin::DB::HostName:0x00007f32768b60a0
162
+ # id: 2,
163
+ # name: "www.example.org",
164
+ # last_scanned_at: nil,
165
+ # created_at: 2022-09-30 05:07:00.996736126 UTC>
166
+
167
+ host_name = Ronin::DB::HostName.find(2)
168
+ # =>
169
+ # #<Ronin::DB::HostName:0x00007f32758072e0
170
+ # id: 2,
171
+ # name: "www.example.org",
172
+ # last_scanned_at: nil,
173
+ # created_at: 2000-01-01 05:07:00.996736 UTC>
174
+
175
+ host_name = Ronin::DB::HostName.first
176
+ # =>
177
+ # #<Ronin::DB::HostName:0x00007f3275cc93f0
178
+ # id: 1,
179
+ # name: "www.example.com",
180
+ # last_scanned_at: nil,
181
+ # created_at: 2022-09-30 05:06:25.633087551 UTC>
182
+
183
+ host_names = Ronin::DB::HostName.where(name: 'www.example.com')
184
+ # =>
185
+ # [#<Ronin::DB::HostName:0x00007f327597b4c8
186
+ # id: 1,
187
+ # name: "www.example.com",
188
+ # last_scanned_at: nil,
189
+ # created_at: 2000-01-01 05:06:25.633087 UTC>]
190
+
191
+ host_names = Ronin::DB::HostName.where(name: 'www.example.com')
192
+ # =>
193
+ # [#<Ronin::DB::HostName:0x00007f327597b4c8
194
+ # id: 1,
195
+ # name: "www.example.com",
196
+ # last_scanned_at: nil,
197
+ # created_at: 2000-01-01 05:06:25.633087 UTC>]
198
+ ```
199
+
200
+ For more information on how to query the database models, see [Active Record
201
+ Query Interface](https://guides.rubyonrails.org/active_record_querying.html)
202
+ and [ronin-db-activerecord].
203
+
204
+ ## Requirements
205
+
206
+ * [Ruby] >= 3.0.0
207
+ * [libsqlite3][sqlite] ~> 1.0
208
+ (or [activerecord-jdbcsqlite3-adapter] ~> 70.0.pre on JRuby)
209
+ * [ronin-db-activerecord] ~> 0.1
210
+ * [ronin-support] ~> 1.0
211
+ * [ronin-core] ~> 0.1
212
+
213
+ ## Install
214
+
215
+ ```shell
216
+ $ gem install ronin-db
217
+ ```
218
+
219
+ ### Gemfile
220
+
221
+ ```ruby
222
+ gem 'ronin-db', '~> 0.1'
223
+ ```
224
+
225
+ ### gemspec
226
+
227
+ ```ruby
228
+ gem.add_dependency 'ronin-db', '~> 0.1'
229
+ ```
230
+
231
+ ## Development
232
+
233
+ 1. [Fork It!](https://github.com/ronin-rb/ronin-db/fork)
234
+ 2. Clone It!
235
+ 3. `cd ronin-db`
236
+ 4. `bundle install`
237
+ 5. `git checkout -b my_feature`
238
+ 6. Code It!
239
+ 7. `bundle exec rake spec`
240
+ 8. `git push origin my_feature`
241
+
242
+ If you want to test your changes locally, run `rake db:console` to start a
243
+ local database console.
244
+
245
+ ## License
246
+
247
+ Copyright (c) 2006-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
248
+
249
+ ronin-db is free software: you can redistribute it and/or modify
250
+ it under the terms of the GNU Lesser General Public License as published
251
+ by the Free Software Foundation, either version 3 of the License, or
252
+ (at your option) any later version.
253
+
254
+ ronin-db is distributed in the hope that it will be useful,
255
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
256
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
257
+ GNU Lesser General Public License for more details.
258
+
259
+ You should have received a copy of the GNU Lesser General Public License
260
+ along with ronin-db. If not, see <https://www.gnu.org/licenses/>.
261
+
262
+ [ronin-rb]: https://ronin-rb.dev/
263
+ [Ruby]: https://www.ruby-lang.org
264
+
265
+ [sqlite]: https://sqlite.org/
266
+ [uri-query_params]: https://github.com/postmodern/uri-query_params#readme
267
+ [sqlite3]: https://github.com/sparklemotion/sqlite3-ruby#readme
268
+ [activerecord-jdbcsqlite3-adapter]: https://github.com/jruby/activerecord-jdbc-adapter#readme
269
+ [activerecord]: https://github.com/rails/rails/tree/main/activerecord#readme
270
+ [ronin-db-activerecord]: https://github.com/ronin-rb/ronin-db-activerecord#readme
271
+ [ronin-support]: https://github.com/ronin-rb/ronin-support#readme
272
+ [ronin-core]: https://github.com/ronin-rb/ronin-core#readme
data/Rakefile ADDED
@@ -0,0 +1,76 @@
1
+ require 'rubygems'
2
+
3
+ begin
4
+ require 'bundler'
5
+ rescue LoadError => e
6
+ warn e.message
7
+ warn "Run `gem install bundler` to install Bundler"
8
+ exit -1
9
+ end
10
+
11
+ begin
12
+ Bundler.setup(:development)
13
+ rescue Bundler::BundlerError => e
14
+ warn e.message
15
+ warn "Run `bundle install` to install missing gems"
16
+ exit e.status_code
17
+ end
18
+
19
+ require 'rake'
20
+
21
+ require 'rubygems/tasks'
22
+ Gem::Tasks.new(sign: {checksum: true, pgp: true})
23
+
24
+ require 'rspec/core/rake_task'
25
+ RSpec::Core::RakeTask.new
26
+ task :test => :spec
27
+ task :default => :spec
28
+
29
+ require 'yard'
30
+ YARD::Rake::YardocTask.new
31
+
32
+ desc "Generates all documentation"
33
+ task :docs => :yara
34
+
35
+ require 'kramdown/man/task'
36
+ Kramdown::Man::Task.new
37
+
38
+
39
+ directory 'db'
40
+ file 'db/dev.sqlite3' => %w[db db:migrate]
41
+
42
+ namespace :db do
43
+ task :connect do
44
+ require 'active_record'
45
+ ActiveRecord::Base.establish_connection(
46
+ adapter: 'sqlite3',
47
+ database: 'db/dev.sqlite3'
48
+ )
49
+ end
50
+
51
+ desc 'Migrates the development database'
52
+ task :migrate => :connect do
53
+ require 'ronin/db/migrations'
54
+ Ronin::DB::Migrations.up
55
+ end
56
+
57
+ desc 'Starts an interactive database console'
58
+ task :console => 'db/dev.sqlite3' do
59
+ require 'active_record'
60
+ ActiveRecord::Base.logger = Logger.new($stderr,:debug)
61
+
62
+ ActiveRecord::Base.establish_connection(
63
+ adapter: 'sqlite3',
64
+ database: 'db/dev.sqlite3'
65
+ )
66
+
67
+ require 'ronin/db/models'
68
+ Ronin::DB::Models.connect
69
+
70
+ lib_dir = File.expand_path('lib')
71
+ $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
72
+
73
+ require 'ronin/db/cli/ruby_shell'
74
+ Ronin::DB::CLI::RubyShell.start
75
+ end
76
+ end
data/bin/ronin-db ADDED
@@ -0,0 +1,35 @@
1
+ #!/usr/bin/env ruby
2
+ #
3
+ # Copyright (c) 2021 Hal Brodigan (postmodern.mod3 at gmail.com)
4
+ #
5
+ # This file is part of ronin-repos.
6
+ #
7
+ # ronin-repos is free software: you can redistribute it and/or modify
8
+ # it under the terms of the GNU Lesser General Public License as published
9
+ # by the Free Software Foundation, either version 3 of the License, or
10
+ # (at your option) any later version.
11
+ #
12
+ # ronin-repos is distributed in the hope that it will be useful,
13
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
14
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15
+ # GNU Lesser General Public License for more details.
16
+ #
17
+ # You should have received a copy of the GNU Lesser General Public License
18
+ # along with ronin-repos. If not, see <https://www.gnu.org/licenses/>.
19
+ #
20
+
21
+ root = File.expand_path(File.join(__dir__,'..'))
22
+ if File.file?(File.join(root,'Gemfile.lock'))
23
+ Dir.chdir(root) do
24
+ begin
25
+ require 'bundler/setup'
26
+ rescue LoadError => e
27
+ warn e.message
28
+ warn "Run `gem install bundler` to install Bundler"
29
+ exit -1
30
+ end
31
+ end
32
+ end
33
+
34
+ require 'ronin/db/cli'
35
+ Ronin::DB::CLI.start