A basic "Hello World" Metasploit module for learning the fundamental structure of Metasploit modules.
This repository contains a simple Metasploit auxiliary module that demonstrates the basic structure and components of a Metasploit module. It's designed as an educational example for understanding how Metasploit modules are organized and written.
The repository contains:
modules/auxiliary/example/hello_world.rb- A basic auxiliary module that prints a greeting message
The hello world module demonstrates:
- Module Class Definition - Inheriting from
Msf::Auxiliary - Module Metadata - Name, description, author, license, platform, and references
- Options Registration - Configurable options (MESSAGE parameter)
- Run Method - The main execution logic that prints formatted output
To use this module in Metasploit Framework:
-
Copy the
modulesdirectory to your Metasploit installation or workspace -
Start Metasploit console:
msfconsole
-
Load the module:
use auxiliary/example/hello_world -
View module information:
info -
(Optional) Set a custom message:
set MESSAGE "Your custom greeting here" -
Run the module:
run
When executed, the module will display:
[+] ==================================================
[+] Hello, World!
[+] ==================================================
[*] This is a basic Metasploit auxiliary module example.
[*] Module executed successfully!