pwn REPL driver - implement welcome-banner command in REPL session to display example usage on demand

Author: ninp0

README.md

@@ -37,7 +37,7 @@ $ rvm use ruby-3.1.1@pwn
 $ rvm list gemsets
 $ gem install --verbose pwn
 $ pwn
-pwn[v0.4.403]:001 >>> PWN.help
+pwn[v0.4.404]:001 >>> PWN.help
 ```
 
 [![Installing the pwn Security Automation Framework](https://raw.githubusercontent.com/0dayInc/pwn/master/documentation/pwn_install.png)](https://youtu.be/G7iLUY4FzsI)
@@ -52,7 +52,7 @@ $ rvm use ruby-3.1.1@pwn
 $ gem uninstall --all --executables pwn
 $ gem install --verbose pwn
 $ pwn
-pwn[v0.4.403]:001 >>> PWN.help
+pwn[v0.4.404]:001 >>> PWN.help
 ```
 
 

bin/pwn

@@ -56,6 +56,14 @@ begin
   end
 
   # Define Custom REPL Commands
+  Pry::Commands.create_command 'welcome-banner' do
+    description 'Display the random welcome banner, including basic usage.'
+
+    def process
+      puts PWN::Banner.welcome
+    end
+  end
+
   Pry::Commands.create_command 'toggle-pager' do
     description 'Toggle less on returned objects surpassing the terminal.'
 
@@ -67,12 +75,7 @@ begin
 
   # Define REPL Hooks
   Pry.config.hooks.add_hook(:before_session, :welcome) do |output, _binding, _pry|
-    output.puts PWN::Banner.get
-    output.puts 'Use the #help command & methods for more options.'
-    output.puts 'e.g help'
-    output.puts 'e.g PWN.help'
-    output.puts 'e.g PWN::Plugins.help'
-    output.puts 'e.g PWN::Plugins::TransparentBrowser.help'
+    output.puts PWN::Banner.welcome
   end
 
   # Define PS1 Prompt

lib/pwn/banner.rb

@@ -39,6 +39,20 @@ module Banner
       banner
     end
 
+    # Supported Method Parameters::
+    # PWN::Banner.get(
+    #   index: 'optional - defaults to random banner index'
+    # )
+
+    public_class_method def self.welcome
+      banner = PWN::Banner.get
+      banner = "#{banner}\nUse the #help command & methods for more options.\n"
+      banner = "#{banner}e.g help\n"
+      banner = "#{banner}e.g PWN.help\n"
+      banner = "#{banner}e.g PWN::Plugins.help\n"
+      banner = "#{banner}e.g PWN::Plugins::TransparentBrowser.help\n"
+    end
+
     # Author(s):: 0day Inc. <[email protected]>
 
     public_class_method def self.authors
@@ -55,6 +69,8 @@ module Banner
           index: 'optional - defaults to random banner index'
         )
 
+        banner = #{self}.welcome
+
         #{self}.authors
       "
     end

lib/pwn/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PWN
-  VERSION = '0.4.403'
+  VERSION = '0.4.404'
 end