ronin-payloads 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fddb2f659bbde5b22104a0199430583326dd28ff4183121da3e25e88a94fe8a
-  data.tar.gz: 5e2f20bca62fcd8d43f4bc82eb33c1098cac1e20269d49b847e793dcd186a978
+  metadata.gz: d2ab679d7311dab9baaff45c264e2a651a09530b5790eed2611060b66e776585
+  data.tar.gz: 7058d3c5e5f25f947e46cc651f4d7de2e7e3878578be2b0cb778f35864f2fdfd
 SHA512:
-  metadata.gz: 0d75e548fc4782f995dbba42e62f4a1a485d3fc2fbdf005c479fe6beda75b2006d9f8132fe98125586d5b4877604c251ad1fe284ea13dccb04476b4edecfc4e4
-  data.tar.gz: 36384af31fb5ba8e407c1b7ebe5777974b966a005c42ebe57a499fea46e450b82987ce3e117c07def7c515fe7f099caa1e760db1ca06ca077ccd2590a3cef8df
+  metadata.gz: d42c63a5fd2d02b157947de808e394fc60f052c22700b073cc632b9c32f40bec44570d09b0141bcfc97dfe28634869cf1e6c2367b62285ec38896b053d66444b
+  data.tar.gz: d87cfacd3e70ad04e553644d0956653ec6b9a6673645dddd14ac63c4699e9fe1f30b98224f0c665035950fe1578a7689e21650438f88eb8c15e1491a7ce704e2

data/.rubocop.yml

@@ -34,4 +34,9 @@ Style/FormatStringToken:
     - 'spec/builtin/cmd/powershell/reverse_shell_spec.rb'
 
 # rubocop does not recognize empty-line continuations
-Layout/LineContinuationSpacing: { Exclude: ['lib/ronin/payloads/builtin/shellcode/**/*.rb'] }
+Style/RedundantLineContinuation:
+  Exclude:
+    - 'lib/ronin/payloads/builtin/shellcode/**/*.rb'
+Layout/LineContinuationSpacing:
+  Exclude:
+    - 'lib/ronin/payloads/builtin/shellcode/**/*.rb'

data/ChangeLog.md

@@ -1,3 +1,14 @@
+### 0.1.2 / 2023-06-09
+
+* Add missing `require` for {Ronin::Payloads::Encoders::Encoder}.
+* Added missing descriptions to built-in payloads (@ervinismu).
+* Documentation fixes and improvements.
+
+#### CLI
+
+* Fixed the placeholder `references` URLs in the `ronin-payloads new` template.
+* Fixed `--format html` and `--format xml` to encode every character.
+
 ### 0.1.1 / 2023-03-01
 
 * Default the `host` param defined by {Ronin::Payloads::Mixins::BindShell} to

data/Gemfile

@@ -12,19 +12,19 @@ gem 'jruby-openssl',	'~> 0.7', platforms: :jruby
 #                              branch: 'main'
 
 # Ronin dependencies
-# gem 'ronin-support',  '~> 1.0', github: "ronin-rb/ronin-support",
+# gem 'ronin-support',  '~> 1.0', github: 'ronin-rb/ronin-support',
 #                                 branch: 'main'
 
-# gem 'ronin-code-asm', '~> 1.0', github: "ronin-rb/ronin-code-asm",
+# gem 'ronin-code-asm', '~> 1.0', github: 'ronin-rb/ronin-code-asm',
 #                                 branch: 'main'
 
-# gem 'ronin-post_ex',  '~> 0.1', github: "ronin-rb/ronin-post_ex",
+# gem 'ronin-post_ex',  '~> 0.1', github: 'ronin-rb/ronin-post_ex',
 #                                 branch: 'main'
 
-# gem 'ronin-core',     '~> 0.1', github: "ronin-rb/ronin-core",
+# gem 'ronin-core',     '~> 0.1', github: 'ronin-rb/ronin-core',
 #                                 branch: 'main'
 
-# gem 'ronin-repos',    '~> 0.1', github: "ronin-rb/ronin-repos",
+# gem 'ronin-repos',    '~> 0.1', github: 'ronin-rb/ronin-repos',
 #                                 branch: 'main'
 
 group :development do

data/data/templates/payload.rb.erb

@@ -35,8 +35,8 @@ module Ronin
       ]
       <%- else -%>
       # references [
-      #   "https:/...",
-      #   "https:/..."
+      #   "https://...",
+      #   "https://..."
       # ]
       <%- end -%>
 

data/lib/ronin/payloads/builtin/cmd/awk/reverse_shell.rb

@@ -34,6 +34,9 @@ module Ronin
           include Mixins::ReverseShell
 
           register 'cmd/awk/reverse_shell'
+          description <<~DESC
+            A basic `awk` reverse shell command.
+          DESC
 
           #
           # Builds the `awk` reverse shell command.

data/lib/ronin/payloads/builtin/cmd/bash/reverse_shell.rb

@@ -35,6 +35,10 @@ module Ronin
 
           register 'cmd/bash/reverse_shell'
 
+          description <<~DESC
+            A basic bash reverse shell command.
+          DESC
+
           #
           # Builds the bash reverse shell command.
           #

data/lib/ronin/payloads/builtin/cmd/lua/reverse_shell.rb

@@ -35,6 +35,10 @@ module Ronin
 
           register 'cmd/lua/reverse_shell'
 
+          description <<~DESC
+            A basic `lua` reverse shell command.
+          DESC
+
           #
           # Builds the `lua` reverse shell command.
           #

data/lib/ronin/payloads/builtin/cmd/node/reverse_shell.rb

@@ -35,6 +35,10 @@ module Ronin
 
           register 'cmd/node/reverse_shell'
 
+          description <<~DESC
+            A basic `node` (Node.js) reverse shell command.
+          DESC
+
           #
           # Builds the `node` reverse shell command.
           #

data/lib/ronin/payloads/builtin/cmd/openssl/reverse_shell.rb

@@ -35,6 +35,10 @@ module Ronin
 
           register 'cmd/openssl/reverse_shell'
 
+          description <<~DESC
+            A basic `openssl` reverse shell command.
+          DESC
+
           #
           # Builds the `openssl` reverse shell command.
           #

data/lib/ronin/payloads/builtin/cmd/perl/reverse_shell.rb

@@ -35,6 +35,10 @@ module Ronin
 
           register 'cmd/perl/reverse_shell'
 
+          description <<~DESC
+            A basic `perl` reverse shell command.
+          DESC
+
           #
           # Builds the `perl` reverse shell command.
           #

data/lib/ronin/payloads/builtin/cmd/php/reverse_shell.rb

@@ -35,6 +35,10 @@ module Ronin
 
           register 'cmd/php/reverse_shell'
 
+          description <<~DESC
+            A basic `php` reverse shell command.
+          DESC
+
           #
           # Builds the `php` reverse shell command.
           #

data/lib/ronin/payloads/builtin/cmd/powershell/reverse_shell.rb

@@ -35,6 +35,10 @@ module Ronin
 
           register 'cmd/powershell/reverse_shell'
 
+          description <<~DESC
+            A basic `powershell` reverse shell command.
+          DESC
+
           #
           # Builds the `powershell` reverse shell command.
           #

data/lib/ronin/payloads/builtin/cmd/python/reverse_shell.rb

@@ -36,6 +36,10 @@ module Ronin
 
           register 'cmd/python/reverse_shell'
 
+          description <<~DESC
+            A basic `python` reverse shell command.
+          DESC
+
           #
           # Builds the `python` reverse shell command.
           #

data/lib/ronin/payloads/builtin/cmd/ruby/reverse_shell.rb

@@ -35,6 +35,10 @@ module Ronin
 
           register 'cmd/ruby/reverse_shell'
 
+          description <<~DESC
+            A basic `ruby` reverse shell command.
+          DESC
+
           #
           # Builds the `ruby` reverse shell command.
           #

data/lib/ronin/payloads/builtin/java/reverse_shell.rb

@@ -40,6 +40,10 @@ module Ronin
 
         register 'java/reverse_shell'
 
+        description <<~DESC
+          A basic Java reverse shell.
+        DESC
+
         # Path to the `Payload.java.erb` ERB template file.
         TEMPLATE = File.join(__dir__,'reverse_shell','Payload.java.erb')
 

data/lib/ronin/payloads/cli/commands/list.rb

@@ -31,7 +31,7 @@ module Ronin
         #
         # ## Usage
         #
-        #     ronin-payloads list [options] [NAME]
+        #     ronin-payloads list [options] [DIR]
         #
         # ## Options
         #
@@ -39,14 +39,14 @@ module Ronin
         #
         # ## Arguments
         #
-        #     [NAME]                           The optional payload name to list
+        #     [DIR]                            The optional payload directory to list
         #
         class List < Command
 
-          usage '[options] [NAME]'
+          usage '[options] [DIR]'
 
-          argument :name, required: false,
-                          desc:     'The optional payload name to list'
+          argument :dir, required: false,
+                         desc:     'The optional payload directory to list'
 
           description 'Lists the available payloads'
 

data/lib/ronin/payloads/cli/commands/show.rb

@@ -103,7 +103,7 @@ module Ronin
                 end
               end
 
-              print_fields fields
+              print_fields(fields)
               puts
 
               print_authors(payload)

data/lib/ronin/payloads/cli/encoder_methods.rb

@@ -64,11 +64,11 @@ module Ronin
         def load_encoder(name)
           Payloads::Encoders.load_class(name)
         rescue Payloads::ClassNotFound => error
-          print_error error.message
+          print_error(error.message)
           exit(1)
         rescue => error
           print_exception(error)
-          print_error "an unhandled exception occurred while loading encoder #{name}"
+          print_error("an unhandled exception occurred while loading encoder #{name}")
           exit(-1)
         end
 
@@ -84,11 +84,11 @@ module Ronin
         def load_encoder_from(file)
           Payloads::Encoders.load_class_from_file(file)
         rescue Payloads::ClassNotFound => error
-          print_error error.message
+          print_error(error.message)
           exit(1)
         rescue => error
           print_exception(error)
-          print_error "an unhandled exception occurred while loading encoder from file #{file}"
+          print_error("an unhandled exception occurred while loading encoder from file #{file}")
           exit(-1)
         end
 
@@ -101,14 +101,17 @@ module Ronin
         # @param [Hash{Symbol => Object}] kwargs
         #   Additional keyword arguments for {Ronin::Payloads::Encoders::Encoder#initialize}.
         #
+        # @return [Encoders::Encoder]
+        #   The initialized encoder object.
+        #
         def initialize_encoder(encoder_class,**kwargs)
           encoder_class.new(**kwargs)
         rescue Core::Params::ParamError => error
-          print_error error.message
+          print_error(error.message)
           exit(1)
         rescue => error
           print_exception(error)
-          print_error "an unhandled exception occurred while initializing encoder #{encoder_class.id}"
+          print_error("an unhandled exception occurred while initializing encoder #{encoder_class.id}")
           exit(-1)
         end
 
@@ -127,11 +130,11 @@ module Ronin
         def validate_encoder(encoder)
           encoder.validate
         rescue Core::Params::ParamError, Encoders::ValidationError => error
-          print_error "failed to validate the encoder #{encoder.class_id}: #{error.message}"
+          print_error("failed to validate the encoder #{encoder.class_id}: #{error.message}")
           exit(1)
         rescue => error
           print_exception(error)
-          print_error "an unhandled exception occurred while validating the encoder #{encoder.class_id}"
+          print_error("an unhandled exception occurred while validating the encoder #{encoder.class_id}")
           exit(-1)
         end
       end

data/lib/ronin/payloads/cli/format_option.rb

@@ -50,12 +50,12 @@ module Ronin
 
           xml: -> {
             require 'ronin/support/encoding/xml'
-            Support::Encoding::XML.method(:escape)
+            Support::Encoding::XML.method(:encode)
           },
 
           html: -> {
             require 'ronin/support/encoding/html'
-            Support::Encoding::HTML.method(:escape)
+            Support::Encoding::HTML.method(:encode)
           },
 
           js: -> {

data/lib/ronin/payloads/cli/payload_methods.rb

@@ -42,11 +42,11 @@ module Ronin
         def load_payload(name)
           Payloads.load_class(name)
         rescue Payloads::ClassNotFound => error
-          print_error error.message
+          print_error(error.message)
           exit(1)
         rescue => error
           print_exception(error)
-          print_error "an unhandled exception occurred while loading payload #{name}"
+          print_error("an unhandled exception occurred while loading payload #{name}")
           exit(-1)
         end
 
@@ -62,11 +62,11 @@ module Ronin
         def load_payload_from(file)
           Payloads.load_class_from_file(file)
         rescue Payloads::ClassNotFound => error
-          print_error error.message
+          print_error(error.message)
           exit(1)
         rescue => error
           print_exception(error)
-          print_error "an unhandled exception occurred while loading payload from file #{file}"
+          print_error("an unhandled exception occurred while loading payload from file #{file}")
           exit(-1)
         end
 
@@ -79,14 +79,17 @@ module Ronin
         # @param [Hash{Symbol => Object}] kwargs
         #   Additional keyword arguments for {Payload#initialize}.
         #
+        # @return [Payload]
+        #   The initialized payload object.
+        #
         def initialize_payload(payload_class,**kwargs)
           payload_class.new(**kwargs)
         rescue Core::Params::ParamError => error
-          print_error error.message
+          print_error(error.message)
           exit(1)
         rescue => error
           print_exception(error)
-          print_error "an unhandled exception occurred while initializing payload #{payload_class.id}"
+          print_error("an unhandled exception occurred while initializing payload #{payload_class.id}")
           exit(-1)
         end
 
@@ -105,11 +108,11 @@ module Ronin
         def validate_payload(payload)
           payload.perform_validate
         rescue Core::Params::ParamError, ValidationError => error
-          print_error "failed to validate the payload #{payload.class_id}: #{error.message}"
+          print_error("failed to validate the payload #{payload.class_id}: #{error.message}")
           exit(1)
         rescue => error
           print_exception(error)
-          print_error "an unhandled exception occurred while validating the payload #{payload.class_id}"
+          print_error("an unhandled exception occurred while validating the payload #{payload.class_id}")
           exit(-1)
         end
       end

data/lib/ronin/payloads/mixins/tempfile.rb

@@ -25,7 +25,7 @@ module Ronin
   module Payloads
     module Mixins
       #
-      # Adds support for building files.
+      # Adds support for temporary files.
       #
       # @api public
       #

data/lib/ronin/payloads/payload.rb

@@ -21,6 +21,7 @@
 
 require 'ronin/payloads/registry'
 require 'ronin/payloads/exceptions'
+require 'ronin/payloads/encoders/encoder'
 require 'ronin/payloads/encoders/pipeline'
 
 require 'ronin/core/metadata/id'

data/lib/ronin/payloads/url_payload.rb

@@ -53,7 +53,7 @@ module Ronin
           @url = new_url
         else
           @url || if superclass < URLPayload
-                    superclass.url || \
+                    superclass.url ||
                       raise(NotImplementedError,"#{self} did not define a url")
                   end
         end

data/lib/ronin/payloads/version.rb

@@ -22,6 +22,6 @@
 module Ronin
   module Payloads
     # ronin-payloads version
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end
 end

data/man/ronin-payloads.1

@@ -27,31 +27,31 @@ Print help information
 .SH COMMANDS
 .LP
 .TP
-\fIbuild\fP
+\fBbuild\fR
 Builds a payload\.
 .LP
 .TP
-\fIencode\fP
+\fBencode\fR
 Encodes a payload with one or more payload encoders\.
 .LP
 .TP
-\fIencoders\fP
+\fBencoders\fR
 Lists available encoders\.
 .LP
 .TP
-\fIirb\fP
+\fBirb\fR
 Starts ronin\-payload\[cq]s interactive Ruby shell\.
 .LP
 .TP
-\fIlaunch\fP
+\fBlaunch\fR
 Launches a payload\.
 .LP
 .TP
-\fIlist\fP
+\fBlist\fR
 Lists available payloads\.
 .LP
 .TP
-\fIhelp\fP
+\fBhelp\fR
 Lists available commands or shows help about a specific command\.
 .LP
 .SH AUTHOR

data/man/ronin-payloads.1.md

@@ -20,25 +20,25 @@ Runs a `ronin-payloads` *COMMAND*.
 
 ## COMMANDS
 
-*build*
+`build`
   Builds a payload.
 
-*encode*
+`encode`
   Encodes a payload with one or more payload encoders.
 
-*encoders*
+`encoders`
   Lists available encoders.
 
-*irb*
+`irb`
   Starts ronin-payload's interactive Ruby shell.
 
-*launch*
+`launch`
   Launches a payload.
 
-*list*
+`list`
   Lists available payloads.
 
-*help*
+`help`
   Lists available commands or shows help about a specific command.
 
 ## AUTHOR

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ronin-payloads
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-02 00:00:00.000000000 Z
+date: 2023-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ronin-support