ronin-exploits 1.0.0.beta3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 850efd0369626bc57a83bf7d51ab1d8fc471bfe1472feee5720c80d7f064fdb5
-  data.tar.gz: b185d3383dc0549dd4aa9aa5e9df990a9554081028fb4cf2e49fd47332ffba7a
+  metadata.gz: f4fb437a6634a2eef3dae27f5d940718e94d1e5d7839113e9b02d849daeb2f81
+  data.tar.gz: 661bbae01973ba0ec2e367abef7fd137534dff1597b8486dde94e64afcc6e780
 SHA512:
-  metadata.gz: 958a1be608668de05fd28d2baeb44d1e7be1765cae684a4110a3183d92647582e6d51921ea24347a562685750717faf5e6e33d62102947f7f11afa3c9b8e7d3b
-  data.tar.gz: 8dbb0fc9782bced0ea57d49f9f65181ee752776c52ae31f437c368affecbb7a44e288c4e6568ea030d48ee1afde343b3c2cef56d9c9ad2e0c66af68519e216ab
+  metadata.gz: 9c40d3ba6b13842ddb66b762cac6aaa26a22f3feb03a8f68abf1fdc7d90696fb4cc03da0fd4472ea77af9e861eb92cf4a7165a5fc023b4ecb4e59f0ef13fa234
+  data.tar.gz: 8b81f266e3b256f028a01b1d10a85d0d1d09cfbcdfecab07e5bf25ebae0f96adee5b7881515eb4cfaccae5ae0e4807377315f50db9213ab5268b179db3e87640

data/README.md

@@ -18,7 +18,7 @@ ronin-exploits allows one to write exploits as plain old Ruby classes.
 ronin-exploits can be distributed as Ruby files or as git repositories that can
 be installed using [ronin-repos].
 
-**tl;dr** It's like a simpler version of
+**tl;dr** It's like a simpler and more modular version of
 [Metasploit](https://www.metasploit.com/).
 
 ronin-exploits is part of the [ronin-rb] project, a [Ruby] toolkit for security
@@ -26,22 +26,22 @@ research and development.
 
 ## Features
 
-* Provides a succinct syntax and API for writing exploits in as few lines as
-  possible.
-* Supports defining exploits as plain old Ruby classes.
+* Provides a succinct [syntax](#examples) and [API][docs-exploit] for writing
+  exploits in as few lines as possible.
+* Supports [defining exploits as plain old Ruby classes][docs-exploit].
 * Supports loading exploits from Ruby files or from installed 3rd-party
   git repositories.
 * Provides base classes and mixin modules for a variety of exploit types:
-  * Stack Overflows
-  * SEH Overflows
-  * Heap Overflows
-  * Use After Free (UAF)
-  * Open Redirect
-  * Local File Inclusions (LFI)
-  * Remote File Inclusions (RFI)
-  * SQL injections (SQLi)
-  * Cross-Site Scripting (XSS)
-  * Server-Side Template Injection (SSTI)
+  * [Stack Overflows][docs-stack-overflow]
+  * [SEH Overflows][docs-seh-overflow]
+  * [Heap Overflows][docs-heap-overflow]
+  * [Use After Free (UAF)][docs-use-after-free]
+  * [Open Redirect][docs-open-redirect]
+  * [Local File Inclusions (LFI)][docs-lfi]
+  * [Remote File Inclusions (RFI)][docs-rfi]
+  * [SQL injections (SQLi)][docs-sqli]
+  * [Cross-Site Scripting (XSS)][docs-xss]
+  * [Server-Side Template Injection (SSTI)][docs-ssti]
 * Uses the [ronin-payloads] library for exploit payloads.
 * Uses the [ronin-post_ex] library for post-exploitation.
 * Provides a simple CLI for listing, displaying, running, and generating new
@@ -50,6 +50,18 @@ research and development.
 * Has 86% documentation coverage.
 * Small memory footprint (~47Kb).
 
+[docs-exploit]: https://ronin-rb.dev/docs/ronin-exploits/Ronin/Exploits/Exploit.html
+[docs-stack-overflow]: https://ronin-rb.dev/docs/ronin-exploits/Ronin/Exploits/StackOverflow.html
+[docs-seh-overflow]: https://ronin-rb.dev/docs/ronin-exploits/Ronin/Exploits/SEHOverflow.html
+[docs-heap-overflow]: https://ronin-rb.dev/docs/ronin-exploits/Ronin/Exploits/HeapOverflow.html
+[docs-use-after-free]: https://ronin-rb.dev/docs/ronin-exploits/Ronin/Exploits/UseAfterFree.html
+[docs-open-redirect]: https://ronin-rb.dev/docs/ronin-exploits/Ronin/Exploits/OpenRedirect.html
+[docs-lfi]: https://ronin-rb.dev/docs/ronin-exploits/Ronin/Exploits/LFI.html
+[docs-rfi]: https://ronin-rb.dev/docs/ronin-exploits/Ronin/Exploits/RFI.html
+[docs-sqli]: https://ronin-rb.dev/docs/ronin-exploits/Ronin/Exploits/SQLI.html
+[docs-xss]: https://ronin-rb.dev/docs/ronin-exploits/Ronin/Exploits/XSS.html
+[docs-ssti]: https://ronin-rb.dev/docs/ronin-exploits/Ronin/Exploits/SSTI.html
+
 ## Anti-Features
 
 * No magic: exploits are defined as classes in files.

data/gemspec.yml

@@ -34,13 +34,13 @@ generated_files:
 dependencies:
   uri-query_params: ~> 0.6
   # Ronin dependencies:
-  ronin-support: ~> 1.0.0.beta1
-  ronin-code-sql: ~> 2.0.0.beta1
-  ronin-payloads: ~> 0.1.0.beta1
-  ronin-vulns: ~> 0.1.0.beta1
-  ronin-post_ex: ~> 0.1.0.beta1
-  ronin-core: ~> 0.1.0.beta1
-  ronin-repos: ~> 0.1.0.beta1
+  ronin-support: ~> 1.0
+  ronin-code-sql: ~> 2.0
+  ronin-payloads: ~> 0.1
+  ronin-vulns: ~> 0.1
+  ronin-post_ex: ~> 0.1
+  ronin-core: ~> 0.1
+  ronin-repos: ~> 0.1
 
 development_dependencies:
   bundler: ~> 2.0

data/lib/ronin/exploits/cli/commands/new.rb

@@ -252,7 +252,7 @@ module Ronin
           man_page 'ronin-exploits-new.1'
 
           #
-          # Initialies the `ronin-exploits new` command.
+          # Initializes the `ronin-exploits new` command.
           #
           # @param [Hash{Symbol => Object}] kwargs
           #   Additional keyword arguments.

data/lib/ronin/exploits/exploit.rb

@@ -52,7 +52,7 @@ module Ronin
     # The {Exploit} class defines six key parts:
     #
     # 1. Metadata - defines information about the exploit.
-    # 2. Params - user configurable parameters.
+    # 2. [Params] - user configurable parameters.
     # 3. {Exploit#test test} - optional method that tests whether the target is
     #    vulnerable or not.
     # 4. {Exploit#build build} - method which builds the exploit.
@@ -60,6 +60,8 @@ module Ronin
     # 6. {Exploit#cleanup cleanup} - optional Method which performs additional
     #    cleanup steps.
     #
+    # [Params]: https://ronin-rb.dev/docs/ronin-core/Ronin/Core/Params/Mixin.html
+    #
     # ## Example
     # 
     #     require 'ronin/exploits/exploit'
@@ -136,7 +138,7 @@ module Ronin
     #
     # ### description
     #
-    # Defines a longer multi-paragraph escription of the exploit.
+    # Defines a longer multi-paragraph description of the exploit.
     #
     #     description <<~EOS
     #       This is my first exploit.
@@ -313,7 +315,7 @@ module Ronin
       end
 
       #
-      # Determines whether the exploit has been publically released yet.
+      # Determines whether the exploit has been publicly released yet.
       #
       # @return [Boolean]
       #
@@ -526,7 +528,7 @@ module Ronin
       end
 
       #
-      # Builds the exploit and then launchs the exploit.
+      # Builds the exploit and then launches the exploit.
       #
       # @param [Boolean] dry_run
       #   If `true` performs a dry-run by only calling {#build} and **not**
@@ -633,7 +635,7 @@ module Ronin
       end
 
       #
-      # Place holder method for testing whether the targeet is vulnerable.
+      # Place holder method for testing whether the target is vulnerable.
       #
       # @return [Test::Vulnerable, Test::NotVulnerable, Test::Unknown]
       #

data/lib/ronin/exploits/lfi.rb

@@ -73,7 +73,7 @@ module Ronin
       # Gets or sets the directory traversal depth for the LFI vulnerability.
       #
       # @param [Integer, nil] new_depth
-      #   The optional new directory trasversal depth to set.
+      #   The optional new directory traversal depth to set.
       #
       # @return [Integer]
       #   The LFI vulnerability's directory traverse depth.

data/lib/ronin/exploits/metadata/arch.rb

@@ -40,7 +40,7 @@ module Ronin
 
         module ClassMethods
           #
-          # Gets or sets the exploits's targetted architecture.
+          # Gets or sets the exploit's targeted architecture.
           #
           # @param [:x86, :x86_64, :ia64, :amd64, :ppc, :ppc64, :mips, :mips_le, :mips_be, :mips64, :mips64_le, :mips64_be, :arm, :arm_le, :arm_be, :arm64, :arm64_le, :arm64_be, nil] new_arch
           #   The optional new architecture to set.

data/lib/ronin/exploits/metadata/default_filename.rb

@@ -40,7 +40,7 @@ module Ronin
 
         module ClassMethods
           #
-          # Gets or sets the exploits's default filename.
+          # Gets or sets the exploit's default filename.
           #
           # @param [Integer, nil] new_default_filename
           #   The optional new default filename to set.

data/lib/ronin/exploits/metadata/default_port.rb

@@ -40,7 +40,7 @@ module Ronin
 
         module ClassMethods
           #
-          # Gets or sets the exploits's default port.
+          # Gets or sets the exploit's default port.
           #
           # @param [Integer, nil] new_default_port
           #   The optional new default port number to set.

data/lib/ronin/exploits/mixins/file_builder.rb

@@ -24,8 +24,8 @@ module Ronin
   module Exploits
     module Mixins
       #
-      # Adds methods for building exploit files. Also adds a `filenam`
-      # param and a
+      # Adds methods for building exploit files. Also adds a `filename` param
+      # and a
       # {Metadata::DefaultFilename::ClassMethods#default_filename default_filename}
       # class method.
       #

data/lib/ronin/exploits/mixins/nops.rb

@@ -81,7 +81,7 @@ module Ronin
         end
 
         #
-        # An individual NOP instructure for the target architecture of the
+        # An individual NOP instruction for the target architecture of the
         # exploit.
         #
         # @return [String]

data/lib/ronin/exploits/params/base_url.rb

@@ -64,7 +64,7 @@ module Ronin
         end
 
         #
-        # Expands the URL or path into a fully qualitifed URL.
+        # Expands the URL or path into a fully qualified URL.
         #
         # @param [String] path
         #   The URL or path to expand.

data/lib/ronin/exploits/version.rb

@@ -21,6 +21,6 @@
 module Ronin
   module Exploits
     # ronin-exploits version
-    VERSION = '1.0.0.beta3'
+    VERSION = '1.0.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ronin-exploits
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta3
+  version: 1.0.0
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-16 00:00:00.000000000 Z
+date: 2023-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uri-query_params
@@ -30,98 +30,98 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta1
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta1
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: ronin-code-sql
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0.beta1
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0.beta1
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: ronin-payloads
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0.beta1
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0.beta1
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: ronin-vulns
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0.beta1
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0.beta1
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: ronin-post_ex
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0.beta1
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0.beta1
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: ronin-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0.beta1
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0.beta1
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: ronin-repos
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0.beta1
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0.beta1
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement