Skip to content

Commit 2cf520a

Browse files
postmodernpostmodern
committed
Initial commit.
0 parents  commit 2cf520a

31 files changed

+2365
-0
lines changed

‎.document

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
lib/**/*.rb
2+
-
3+
ChangeLog.md
4+
COPYING.txt
5+
man/*.md

‎.github/workflows/ruby.yml

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
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+
bundler-cache: true
25+
- name: Install libsqlite3
26+
run: |
27+
sudo apt update -y && \
28+
sudo apt install -y --no-install-recommends --no-install-suggests libsqlite3-dev
29+
- name: Install dependencies
30+
run: bundle install --jobs 4 --retry 3
31+
- name: Run tests
32+
run: bundle exec rake test
33+
34+
# rubocop linting
35+
rubocop:
36+
runs-on: ubuntu-latest
37+
steps:
38+
- uses: actions/checkout@v2
39+
- name: Set up Ruby
40+
uses: ruby/setup-ruby@v1
41+
with:
42+
ruby-version: 3.0
43+
- name: Install dependencies
44+
run: bundle install --jobs 4 --retry 3
45+
- name: Run rubocop
46+
run: bundle exec rubocop --parallel

‎.gitignore

+13
Original file line numberDiff line numberDiff line change
@@ -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+
*~

‎.rspec

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
--colour --format documentation

‎.rubocop.yml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
AllCops:
2+
NewCops: enable
3+
SuggestExtensions: false
4+
TargetRubyVersion: 3.1
5+
6+
7+
inherit_gem:
8+
rubocop-ronin: rubocop.yml
9+
10+
#
11+
# ronin-nmap specific exceptions
12+
#
13+
Style/ExplicitBlockArgument:
14+
Exclude:
15+
- 'lib/ronin/nmap/converters/csv.rb'

‎.ruby-version

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
ruby-3.1

‎.yardopts

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
--markup markdown --title 'Ronin::Nmap Documentation' --protected

‎COPYING.txt

+165
Original file line numberDiff line numberDiff line change
@@ -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.

‎ChangeLog.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
### 0.1.0 / 2023-03-XX
2+
3+
* Initial release:
4+

‎Gemfile

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# frozen_string_literal: true
2+
3+
source 'https://rubygems.org'
4+
5+
gemspec
6+
7+
platform :jruby do
8+
gem 'jruby-openssl', '~> 0.7'
9+
end
10+
11+
# gem 'ruby-nmap', '~> 1.0', github: 'postmodern/ruby-nmap'
12+
13+
# Ronin dependencies
14+
# gem 'ronin-core', '~> 0.1', github: "ronin-rb/ronin-core",
15+
# branch: 'main'
16+
# gem 'ronin-db', '~> 0.1', github: "ronin-rb/ronin-db",
17+
# branch: 'main'
18+
19+
group :development do
20+
gem 'rake'
21+
gem 'rubygems-tasks', '~> 0.2'
22+
23+
gem 'rspec', '~> 3.0'
24+
gem 'simplecov', '~> 0.20'
25+
26+
gem 'kramdown', '~> 2.0'
27+
gem 'kramdown-man', '~> 0.1'
28+
29+
gem 'redcarpet', platform: :mri
30+
gem 'yard', '~> 0.9'
31+
gem 'yard-spellcheck', require: false
32+
33+
gem 'dead_end', require: false
34+
gem 'sord', require: false, platform: :mri
35+
gem 'stackprof', require: false, platform: :mri
36+
gem 'rubocop', require: false, platform: :mri
37+
gem 'rubocop-ronin', require: false, platform: :mri
38+
end

0 commit comments

Comments
 (0)