ronin-exploits 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5ed07e22075b4a85ab7b09942a6bfdf9481a3ac4fce42a5f5bd7184c5e9757f
-  data.tar.gz: 956a36865691124ef9547029072f96f737290490790ee92dd97b58c5dcd69e61
+  metadata.gz: 5cfd3c025753ca4049f2ec1f5a61aa9442e6fb39dab803aed575cfddcfadd0e8
+  data.tar.gz: 48651dbef77525c74e9fbcdea6a7688f4048e2be5ce696a1301b408fb8d30e2f
 SHA512:
-  metadata.gz: 1a84a745dbefea7175bac53d2d66207ff5439c4d39e38e6f05542479427e04010a94871bd0670082a3351a75162f64935c7fd908f9f997d007a6a99aaf5d38ba
-  data.tar.gz: f7e0ad4fe91a4ec17ddb4f6759c8fcf056731d34103d7829fdad9033b38b95e37a8264b1a72402baaa6bd736a5cd01200fd6be036214a1980624c74d0cd22b48
+  metadata.gz: 3c048f3293d44ec2c8615d56ee8c3ab363aa0393fa3fe50dc35b83875ab289b86f55fa28501a127138ee8eca3bc5bce077debee6b0992154294bcfbe825da840
+  data.tar.gz: 76486d06cf34785a94b867ca79cde13fe79da7a26e71896388fc5cd8c46ff0968e4484e8da854d99a7c02c084cd7e3edcae67f7dffec5fb014023e8e593d2f4a

data/.github/workflows/ruby.yml

@@ -16,7 +16,7 @@ jobs:
           - truffleruby
     name: Ruby ${{ matrix.ruby }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -35,7 +35,7 @@ jobs:
   rubocop:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:

data/ChangeLog.md

@@ -1,3 +1,21 @@
+### 1.0.4 / 2023-12-23
+
+* Documentation fixes.
+
+#### CLI
+
+* Fixed a bug in `ronin-exploits run` when the exploit does not accept a payload
+  and no payload is given.
+
+### 1.0.3 / 2023-09-19
+
+#### CLI
+
+* All newly generated exploit files using `ronin-exploit new` should have a
+  `summary` and a `description`.
+* Fixed a bug where the `ronin-exploits new` options `--author`,
+  `--author-email`, or `--summary` were not properly escaping given values.
+
 ### 1.0.2 / 2023-06-12
 
 * Corrected the `class_dir` for {Ronin::Exploits}; even though

data/README.md

@@ -8,7 +8,6 @@
 * [Issues](https://github.com/ronin-rb/ronin-exploits/issues)
 * [Documentation](https://rubydoc.info/github/ronin-rb/ronin-exploits/frames)
 * [Discord](https://discord.gg/6WAb3PsVX9) |
-  [Twitter](https://twitter.com/ronin_rb) |
   [Mastodon](https://infosec.exchange/@ronin_rb)
 
 ## Description
@@ -155,8 +154,8 @@ $ ronin-exploits run my_exploit --param host=example.com --param port=9999 \
 Generate a ronin repository of your own exploits (and/or payloads):
 
 ```shell
-$ ronin-repos new my-exploits
-$ cd my-exploits/
+$ ronin-repos new my-repo
+$ cd my-repo/
 $ mkdir exploits
 $ ronin-exploits new exploits/my_exploit.rb --type stack_overflow \
     --arch x86 --os linux --software ExampleWare --software-version 1.2.3 \

data/data/new/exploit.rb.erb

@@ -41,7 +41,7 @@ module Ronin
       # disclosure_date 'YYYY-MM-DD'
       <%- unless @advisories.empty? -%>
       <%-   @advisories.each do |advisory| -%>
-      advisory '<%= advisory -%>'
+      advisory <%= advisory.inspect -%>
       <%-   end -%>
       <%- else -%>
       # advisory 'CVE-YYYY-NNNN'
@@ -49,23 +49,23 @@ module Ronin
       <%- end -%>
 
       <%- if @author_email -%>
-      author '<%= @author_name %>', email: '<%= @author_email -%>'
+      author <%= @author_name.inspect %>, email: <%= @author_email.inspect %>
       <%- else -%>
-      author '<%= @author_name %>'
+      author <%= @author_name.inspect %>
       <%- end -%>
       <%- if @summary -%>
-      summary "<%= @summary %>"
+      summary <%= @summary.inspect %>
       <%- else -%>
-      # summary "FIX ME"
+      summary "FIX ME"
       <%- end -%>
       <%- if @description -%>
       description <<~DESC
         <%= @description %>
       DESC
       <%- else -%>
-      # description <<~DESC
-      #   FIX ME
-      # DESC
+      description <<~DESC
+        FIX ME
+      DESC
       <%- end -%>
       <%- unless @references.empty? -%>
       references [

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

@@ -29,7 +29,6 @@ require 'ronin/core/cli/generator/options/author'
 require 'ronin/core/cli/generator/options/summary'
 require 'ronin/core/cli/generator/options/description'
 require 'ronin/core/cli/generator/options/reference'
-require 'ronin/core/git'
 
 require 'command_kit/inflector'
 
@@ -78,6 +77,7 @@ module Ronin
           include Core::CLI::Generator
           include Payloads::CLI::Generator
 
+          # Mapping of exploit types and their file/class names.
           EXPLOIT_TYPES = {
             exploit: {
               file:  'exploit',
@@ -135,6 +135,7 @@ module Ronin
             }
           }
 
+          # Mapping of network mixins and their file/module names.
           NETWORKING_TYPES = {
             remote_tcp: {
               file:   'remote_tcp',

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

@@ -340,7 +340,7 @@ module Ronin
           # Validates the payload.
           #
           def validate_payload
-            super(@payload)
+            super(@payload) if @payload
           end
 
           #

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

@@ -160,13 +160,7 @@ module Ronin
         #   @option kwargs [Hash, String, nil] :form_data
         #     The form data that may be sent in the body of the request.
         #
-        #   @option kwargs [String, nil] :user (http_user)
-        #     The user to authenticate as.
-        #
-        #   @option kwargs [String, nil] :password (http_password)
-        #     The password to authenticate with.
-        #
-        #   @option kwargs [Hash{Symbol,String => String}, nil] :headers
+        #   @option kwargs [Hash{Symbol,String => String}, nil] :headers (http_headers)
         #     Additional HTTP headers to use for the request.
         #
 

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

@@ -31,6 +31,8 @@ module Ronin
       #
       # Adds TCP helper methods for communicating with a remote host.
       #
+      # @see https://ronin-rb.dev/docs/ronin-support/Ronin/Support/Network/TCP/Mixin.html
+      #
       # @api public
       #
       # @since 1.0.0
@@ -64,15 +66,15 @@ module Ronin
         # @param [Integer] port
         #   The port to connect to.
         #
-        # @param [Hash{Symbol => Object}] kwargs
-        #   Additional keyword arguments for {#tcp_connect}.
-        #
-        # @option kwargs [String, nil] bind_host
+        # @param [String, nil] bind_host
         #   The local host to bind to.
         #
-        # @option kwargs [Integer, nil] bind_port
+        # @param [Integer, nil] bind_port
         #   The local port to bind to.
         #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments for {#tcp_connect}.
+        #
         # @option kwargs [Integer] :timeout (5)
         #   The maximum time to attempt connecting.
         #

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

@@ -31,6 +31,8 @@ module Ronin
       #
       # Adds UDP helper methods for communicating with a remote host.
       #
+      # @see https://ronin-rb.dev/docs/ronin-support/Ronin/Support/Network/UDP/Mixin.html
+      #
       # @api public
       #
       # @since 1.0.0
@@ -64,15 +66,15 @@ module Ronin
         # @param [Integer] port
         #   The port to connect to.
         #
-        # @param [Hash{Symbol => Object}] kwargs
-        #   Additional keyword arguments for {#udp_connect}.
-        #
-        # @option kwargs [String, nil] :bind_host
+        # @param [String, nil] bind_host
         #   The local host to bind to.
         #
-        # @option kwargs [Integer, nil] :bind_port
+        # @param kwargs [Integer, nil] bind_port
         #   The local port to bind to.
         #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments for {#udp_connect}.
+        #
         # @option kwargs [Integer] :timeout (5)
         #   The maximum time to attempt connecting.
         #

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

@@ -36,6 +36,8 @@ module Ronin
       #     # ...
       #   end
       #
+      # @see https://ronin-rb.dev/docs/ronin-support/Ronin/Support/Text/Mixin.html
+      #
       # @api public
       #
       # @since 1.0.0

data/lib/ronin/exploits/version.rb

@@ -22,6 +22,6 @@
 module Ronin
   module Exploits
     # ronin-exploits version
-    VERSION = '1.0.2'
+    VERSION = '1.0.4'
   end
 end

data/man/ronin-exploits-irb.1

@@ -1,10 +1,10 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 0.1.9
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-exploits-irb 1 "2023-02-01" Ronin "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
-.HP
+.PP
 \fBronin-exploits irb\fR \[lB]\fIoptions\fP\[rB]
 .LP
 .SH DESCRIPTION

data/man/ronin-exploits-list.1

@@ -1,10 +1,10 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 0.1.9
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-exploits-list 1 "2023-02-01" Ronin "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
-.HP
+.PP
 \fBronin-exploits list\fR \[lB]\fIoptions\fP\[rB] \fIDIR\fP
 .LP
 .SH DESCRIPTION

data/man/ronin-exploits-new.1

@@ -1,11 +1,11 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 0.1.9
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-exploits-new 1 "2023-02-01" Ronin "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
-.HP
-\fBronin-exploits new\fR \[lB]\fIoptions\fP\[rB] \fIFILE\fP
+.PP
+\fBronin-exploits new\fR \[lB]\fIoptions\fP\[rB] \fIPATH\fP
 .LP
 .SH DESCRIPTION
 .LP
@@ -15,7 +15,7 @@ Creates a new exploit file\.
 .SH ARGUMENTS
 .LP
 .TP
-\fIFILE\fP
+\fIPATH\fP
 The path to the exploit file to generate\.
 .LP
 .SH OPTIONS

data/man/ronin-exploits-new.1.md

@@ -2,7 +2,7 @@
 
 ## SYNOPSIS
 
-`ronin-exploits new` [*options*] *FILE*
+`ronin-exploits new` [*options*] *PATH*
 
 ## DESCRIPTION
 
@@ -10,7 +10,7 @@ Creates a new exploit file.
 
 ## ARGUMENTS
 
-*FILE*
+*PATH*
   The path to the exploit file to generate.
 
 ## OPTIONS

data/man/ronin-exploits-run.1

@@ -1,10 +1,10 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 0.1.9
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-exploits-run 1 "2023-02-01" Ronin "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
-.HP
+.PP
 \fBronin-exploits run\fR \[lB]\fIoptions\fP\[rB] \[lC]\fINAME\fP \[or] \fB--file\fR \fIFILE\fP\[rC]
 .LP
 .SH DESCRIPTION

data/man/ronin-exploits-show.1

@@ -1,10 +1,10 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 0.1.9
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-exploits-show 1 "2023-02-01" Ronin "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
-.HP
+.PP
 \fBronin-exploits show\fR \[lB]\fIoptions\fP\[rB] \[lC]\fINAME\fP \[or] \-\-file \fIFILE\fP\[rC]
 .LP
 .SH DESCRIPTION

data/man/ronin-exploits.1

@@ -1,10 +1,10 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 0.1.9
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-exploits 1 "2023-02-01" Ronin "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
-.HP
+.PP
 \fBronin-exploits\fR \[lB]\fIoptions\fP\[rB] \[lB]\fICOMMAND\fP \[lB]\.\.\.\[rB]\[rB]
 .LP
 .SH DESCRIPTION

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ronin-exploits
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-12 00:00:00.000000000 Z
+date: 2023-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uri-query_params