ronin-payloads 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07561b5d1c24b065edf8f865ebfe2c68f0646ca7bdb64815f0208792a75cf930
-  data.tar.gz: 9168b42d9147d245dcc08d3125f7e84037c7d0cf306024e69e5c8cdd65ca3215
+  metadata.gz: d2ab679d7311dab9baaff45c264e2a651a09530b5790eed2611060b66e776585
+  data.tar.gz: 7058d3c5e5f25f947e46cc651f4d7de2e7e3878578be2b0cb778f35864f2fdfd
 SHA512:
-  metadata.gz: 50b73eaed5e5a285d369d330a7301979c715665c5e68a1fb7d0d6ad67adbc154922bbbb609fb3bc9583f643fd26293a9c21ce36bcc5071313029cfe47d808dbc
-  data.tar.gz: a9112a634a9de0c0adb4cd117ed63f2d2ee848ae7ea043cf91cb449824d932ba07e14c8a7f893d3b416de14923731db540ea61f58e069e1c614e66fc82a6a332
+  metadata.gz: d42c63a5fd2d02b157947de808e394fc60f052c22700b073cc632b9c32f40bec44570d09b0141bcfc97dfe28634869cf1e6c2367b62285ec38896b053d66444b
+  data.tar.gz: d87cfacd3e70ad04e553644d0956653ec6b9a6673645dddd14ac63c4699e9fe1f30b98224f0c665035950fe1578a7689e21650438f88eb8c15e1491a7ce704e2

data/.github/workflows/ruby.yml

@@ -12,7 +12,7 @@ jobs:
           - '3.0'
           - '3.1'
           - '3.2'
-          # - jruby
+          - jruby
           - truffleruby
     name: Ruby ${{ matrix.ruby }}
     steps:
@@ -30,3 +30,17 @@ jobs:
         run: bundle install --jobs 4 --retry 3
       - name: Run tests
         run: bundle exec rake test
+
+  # rubocop linting
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      - name: Run rubocop
+        run: bundle exec rubocop --parallel

data/.rubocop.yml

@@ -0,0 +1,42 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 3.1
+
+inherit_gem:
+  rubocop-ronin: rubocop.yml
+
+#
+# ronin-payload specific exceptions:
+#
+Layout/ArgumentAlignment: { Exclude: ['spec/rust_payload_spec.rb'] }
+
+# the placeholder API methods are meant to be empty
+Style/EmptyMethod:
+  Exclude:
+    - 'lib/ronin/payloads/payload.rb'
+    - 'spec/**/*'
+
+# rubocop does not support constants that contain multiple numbers
+Naming/ClassAndModuleCamelCase:
+  AllowedNames:
+    - X86_64
+
+# robucop mistakes :x86_64 for a "symbol number"
+Naming/VariableNumber:
+  AllowedIdentifiers:
+    - x86_64
+
+# this is a bug in rubocop
+Style/FormatStringToken:
+  Exclude:
+    - 'lib/ronin/payloads/builtin/cmd/powershell/reverse_shell.rb'
+    - 'spec/builtin/cmd/powershell/reverse_shell_spec.rb'
+
+# rubocop does not recognize empty-line continuations
+Style/RedundantLineContinuation:
+  Exclude:
+    - 'lib/ronin/payloads/builtin/shellcode/**/*.rb'
+Layout/LineContinuationSpacing:
+  Exclude:
+    - 'lib/ronin/payloads/builtin/shellcode/**/*.rb'

data/ChangeLog.md

@@ -1,4 +1,27 @@
-### 0.1.0 / 2023-XX-XX
+### 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
+  `0.0.0.0`.
+
+#### CLI
+
+* Fixed multiple bugs in the `--param` option of the `ronin-payloads encode`
+  comand.
+* Fixed multiple bugs in the `--encoder-param` option of
+  the `ronin-payloads build` command.
+
+### 0.1.0 / 2023-02-01
 
 * Initial release:
   * Require `ruby` >= 3.0.0.

data/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 gemspec
@@ -11,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
@@ -41,6 +42,8 @@ group :development do
   gem 'yard-spellcheck', require: false
 
   gem 'dead_end',        require: false
-  gem 'sord',            require: false
-  gem 'stackprof',       require: false
+  gem 'sord',            require: false, platform: :mri
+  gem 'stackprof',       require: false, platform: :mri
+  gem 'rubocop',         require: false, platform: :mri
+  gem 'rubocop-ronin',   require: false, platform: :mri
 end

data/Rakefile

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 begin
   require 'bundler'
 rescue LoadError => e
   warn e.message
   warn "Run `gem install bundler` to install Bundler"
-  exit -1
+  exit(-1)
 end
 
 begin

data/bin/ronin-payloads

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 #
 # ronin-payloads - A Ruby micro-framework for writing and running exploit
 # payloads.
@@ -22,13 +23,11 @@
 root = File.expand_path(File.join(File.dirname(__FILE__),'..'))
 if File.file?(File.join(root,'Gemfile.lock'))
   Dir.chdir(root) do
-    begin
-      require 'bundler/setup'
-    rescue LoadError => e
-      warn e.message
-      warn "Run `gem install bundler` to install Bundler"
-      exit -1
-    end
+    require 'bundler/setup'
+  rescue LoadError => e
+    warn e.message
+    warn "Run `gem install bundler` to install Bundler"
+    exit(-1)
   end
 end
 

data/data/templates/payload.rb.erb

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

data/examples/bin_sh.rb

@@ -1,9 +1,13 @@
 #!/usr/bin/env -S ronin-payloads build -f
+# frozen_string_literal: true
 
 require 'ronin/payloads/shellcode_payload'
 
 module Ronin
   module Payloads
+    #
+    # An example `execve()` `/bin/sh` shellcode payload.
+    #
     class BinSh < ShellcodePayload
 
       register 'examples/bin_sh'

data/lib/ronin/payloads/asm_payload.rb

@@ -61,7 +61,7 @@ module Ronin
       end
 
       param :assembler, required: true,
-                        default:  ->{ assembler },
+                        default:  -> { assembler },
                         desc:     'The assmebler command to use'
 
       #

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/builtin/php/cmd_exec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-payloads - A Ruby micro-framework for writing and running exploit
 # payloads.
@@ -32,9 +33,9 @@ module Ronin
 
         summary 'PHP command exec payload'
         description <<~DESC
-        A basic injectable PHP payload which executes a command passed in via a
-        URL query parameter. The output of the commend will be returned in the
-        response body wrapped in `<exec>...</exec>` tags.
+          A basic injectable PHP payload which executes a command passed in via a
+          URL query parameter. The output of the commend will be returned in the
+          response body wrapped in `<exec>...</exec>` tags.
         DESC
 
         param :query_param, String, default: 'cmd',

data/lib/ronin/payloads/builtin/shellcode/freebsd/x86/bind_shell.rb

@@ -40,7 +40,7 @@ module Ronin
 
             summary 'FreeBSD x86 bind shell shellcode'
             description <<~DESC
-            FreeBSD x86 shellcode that binds a shell to a port.
+              FreeBSD x86 shellcode that binds a shell to a port.
             DESC
 
             references [

data/lib/ronin/payloads/builtin/shellcode/freebsd/x86/exec_shell.rb

@@ -40,7 +40,7 @@ module Ronin
 
             summary 'FreeBSD x86 execve() shellcode'
             description <<~DESC
-            FreeBSD x86 shellcode that calls execve() with "/bin/sh".
+              FreeBSD x86 shellcode that calls execve() with "/bin/sh".
             DESC
 
             references [

data/lib/ronin/payloads/builtin/shellcode/freebsd/x86/reverse_shell.rb

@@ -40,7 +40,7 @@ module Ronin
 
             summary 'FreeBSD x86 reverse shell shellcode'
             description <<~DESC
-            FreeBSD x86 shellcode that spawns a connect back reverse shell.
+              FreeBSD x86 shellcode that spawns a connect back reverse shell.
             DESC
 
             references [

data/lib/ronin/payloads/builtin/shellcode/freebsd/x86_64/exec_shell.rb

@@ -40,7 +40,7 @@ module Ronin
 
             summary 'FreeBSD x86-64 execve() shellcode'
             description <<~DESC
-            FreeBSD x86-64 shellcode that calls execve() with "/bin/sh".
+              FreeBSD x86-64 shellcode that calls execve() with "/bin/sh".
             DESC
 
             references [

data/lib/ronin/payloads/builtin/shellcode/linux/arm/bind_shell.rb

@@ -40,7 +40,7 @@ module Ronin
 
             summary 'Linux ARM bind shell shellcode'
             description <<~DESC
-            Linux ARM shellcode that binds a shell to a port.
+              Linux ARM shellcode that binds a shell to a port.
             DESC
 
             references [

data/lib/ronin/payloads/builtin/shellcode/linux/arm/exec_shell.rb

@@ -41,7 +41,7 @@ module Ronin
 
             summary 'Linux ARM execve() shellcode'
             description <<~DESC
-            Linux ARM shellcode that calls execve() with "/bin/sh".
+              Linux ARM shellcode that calls execve() with "/bin/sh".
             DESC
 
             references [

data/lib/ronin/payloads/builtin/shellcode/linux/arm/reverse_shell.rb

@@ -40,7 +40,7 @@ module Ronin
 
             summary 'Linux ARM reverse shell shellcode'
             description <<~DESC
-            Linux ARM shellcode that spawns a connect back reverse shell.
+              Linux ARM shellcode that spawns a connect back reverse shell.
             DESC
 
             references [

data/lib/ronin/payloads/builtin/shellcode/linux/mips/bind_shell.rb

@@ -40,7 +40,7 @@ module Ronin
 
             summary 'Linux ARM bind shell shellcode'
             description <<~DESC
-            Linux ARM shellcode that binds a shell to a port.
+              Linux ARM shellcode that binds a shell to a port.
             DESC
 
             references [

data/lib/ronin/payloads/builtin/shellcode/linux/mips/exec_shell.rb

@@ -40,7 +40,7 @@ module Ronin
 
             summary 'Linux MIPS execve() shellcode'
             description <<~DESC
-            Linux MIPS shellcode that calls execve() with "/bin/sh".
+              Linux MIPS shellcode that calls execve() with "/bin/sh".
             DESC
 
             references [

data/lib/ronin/payloads/builtin/shellcode/linux/mips/reverse_shell.rb

@@ -40,7 +40,7 @@ module Ronin
 
             summary 'Linux MIPS reverse shell shellcode'
             description <<~DESC
-            Linux MIPS shellcode that spawns a connect back reverse shell.
+              Linux MIPS shellcode that spawns a connect back reverse shell.
             DESC
 
             references [

data/lib/ronin/payloads/builtin/shellcode/linux/ppc/exec_shell.rb

@@ -40,7 +40,7 @@ module Ronin
 
             summary 'Linux PPC execve() shellcode'
             description <<~DESC
-            Linux PPC shellcode that calls execve() with "/bin/sh".
+              Linux PPC shellcode that calls execve() with "/bin/sh".
             DESC
 
             references [

data/lib/ronin/payloads/builtin/shellcode/linux/ppc/reverse_shell.rb

@@ -40,9 +40,9 @@ module Ronin
 
             summary 'Linux PPC reverse shell shellcode'
             description <<~DESC
-            Linux PPC shellcode that spawns a connect back reverse shell.
+              Linux PPC shellcode that spawns a connect back reverse shell.
 
-            Note: disabling with_stderr will save 16 bytes, but lose stderr.
+              Note: disabling with_stderr will save 16 bytes, but lose stderr.
             DESC
 
             references [

data/lib/ronin/payloads/builtin/shellcode/linux/x86/bind_shell.rb

@@ -41,7 +41,7 @@ module Ronin
 
             summary 'Linux x86 bind shell shellcode'
             description <<~DESC
-            Linux x86 shellcode that binds a shell to a port.
+              Linux x86 shellcode that binds a shell to a port.
             DESC
 
             references [

data/lib/ronin/payloads/builtin/shellcode/linux/x86/exec_shell.rb

@@ -41,7 +41,7 @@ module Ronin
 
             summary 'Linux x86 execve() shellcode'
             description <<~DESC
-            Linux x86 shellcode that calls execve() with "/bin/sh".
+              Linux x86 shellcode that calls execve() with "/bin/sh".
             DESC
 
             references [

data/lib/ronin/payloads/builtin/shellcode/linux/x86/reverse_shell.rb

@@ -40,7 +40,7 @@ module Ronin
 
             summary 'Linux x86 reverse shell shellcode'
             description <<~DESC
-            Linux x86 shellcode that spawns a connect back reverse shell.
+              Linux x86 shellcode that spawns a connect back reverse shell.
             DESC
 
             references [

data/lib/ronin/payloads/builtin/shellcode/linux/x86_64/bind_shell.rb

@@ -40,7 +40,7 @@ module Ronin
 
             summary 'Linux x86-64 bind shell shellcode'
             description <<~DESC
-            Linux x86-64 shellcode that binds a shell to a port.
+              Linux x86-64 shellcode that binds a shell to a port.
             DESC
 
             references [

data/lib/ronin/payloads/builtin/shellcode/linux/x86_64/exec_shell.rb

@@ -40,7 +40,7 @@ module Ronin
 
             summary 'Linux x86-64 execve() shellcode'
             description <<~DESC
-            Linux x86-64 shellcode that calls execve() with "/bin/sh".
+              Linux x86-64 shellcode that calls execve() with "/bin/sh".
             DESC
 
             references [

data/lib/ronin/payloads/builtin/shellcode/linux/x86_64/reverse_shell.rb

@@ -40,7 +40,7 @@ module Ronin
 
             summary 'Linux x86-64 reverse shell shellcode'
             description <<~DESC
-            Linux x86-64 shellcode that spawns a connect back reverse shell.
+              Linux x86-64 shellcode that spawns a connect back reverse shell.
             DESC
 
             references [

data/lib/ronin/payloads/builtin/shellcode/macos/x86_64/exec_shell.rb

@@ -41,7 +41,7 @@ module Ronin
 
             summary 'macOS x86-64 execve() shellcode'
             description <<~DESC
-            macOS x86-64 shellcode that calls execve() with "/bin/sh".
+              macOS x86-64 shellcode that calls execve() with "/bin/sh".
             DESC
 
             references [

data/lib/ronin/payloads/builtin/shellcode/macos/x86_64/reverse_shell.rb

@@ -41,7 +41,7 @@ module Ronin
 
             summary 'macOS x86-64 reverse shell shellcode'
             description <<~DESC
-            macOS x86-64 shellcode that spawns a connect back reverse shell.
+              macOS x86-64 shellcode that spawns a connect back reverse shell.
             DESC
 
             references [

data/lib/ronin/payloads/builtin/shellcode/netbsd/x86/exec_shell.rb

@@ -40,7 +40,7 @@ module Ronin
 
             summary 'NetBSD x86 execve() shellcode'
             description <<~DESC
-            NetBSD x86 shellcode that calls execve() with "/bin/sh".
+              NetBSD x86 shellcode that calls execve() with "/bin/sh".
             DESC
 
             references [

data/lib/ronin/payloads/builtin/shellcode/netbsd/x86/reverse_shell.rb

@@ -41,7 +41,7 @@ module Ronin
 
             summary 'NetBSD x86 reverse shell shellcode'
             description <<~DESC
-            NetBSD x86 shellcode that spawns a connect back reverse shell.
+              NetBSD x86 shellcode that spawns a connect back reverse shell.
             DESC
 
             references [

data/lib/ronin/payloads/builtin/shellcode/openbsd/x86/bind_shell.rb

@@ -40,7 +40,7 @@ module Ronin
 
             summary 'OpenBSD x86 bind shell shellcode'
             description <<~DESC
-            OpenBSD x86 shellcode that binds a shell to a port.
+              OpenBSD x86 shellcode that binds a shell to a port.
             DESC
 
             references [

data/lib/ronin/payloads/builtin/shellcode/openbsd/x86/exec_shell.rb

@@ -41,7 +41,7 @@ module Ronin
 
             summary 'OpenBSD x86 execve() shellcode'
             description <<~DESC
-            OpenBSD x86 shellcode that calls execve() with "/bin/sh".
+              OpenBSD x86 shellcode that calls execve() with "/bin/sh".
             DESC
 
             references [

data/lib/ronin/payloads/builtin/shellcode/windows/x86_64/cmd.rb

@@ -37,11 +37,11 @@ module Ronin
             os :windows
             os_version '7'
 
-            author "agix" 
+            author "agix"
 
             summary 'Windows x86-64 cmd shellcode'
             description <<~DESC
-            Windows x86-64 shellcode that executes "cmd"
+              Windows x86-64 shellcode that executes "cmd"
             DESC
 
             references [