> For the complete documentation index, see [llms.txt](https://edu.noirchapeau.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://edu.noirchapeau.com/metasploit.md).

# Metasploit

## **What is Metasploit?**

Metasploit is a **Ruby-based modular penetration testing platform** designed for testing, creating, and executing exploits. It allows security professionals to identify and manage vulnerabilities through customizable scripts and a vast library of pre-built modules.

**Core Functionalities:**

* Security vulnerability testing
* Network enumeration
* Exploitation and evasion techniques
* Post-exploitation and persistent access

### **Metasploit Versions**

1. **Metasploit Framework (Free)**
   * Open-source and command-line-based.
   * Offers complete access to modules and functionalities for manual and semi-automated testing.
2. **Metasploit Pro (Paid)**\
   Enhanced with the following features:
   * **Automation:** Chains, replay functionality, and quick-start wizards.
   * **Vulnerability Validation:** Nexpose integration, credential management, and scanning.
   * **Social Engineering Tools:** Phishing campaigns and team collaboration.
   * **Reporting:** Web-based GUI with tagging and evidence collection.

## **Key Architecture Components**

* **Default Installation Path:**\
  `/usr/share/metasploit-framework`
* **Primary Directories:**
  * **Data, Documentation, and Lib:** Core operational files and references.
  * **Modules:** Contains scripts organized by category:

    ```
    /modules/
      - auxiliary
      - encoders
      - evasion
      - exploits
      - nops
      - payloads
      - post
    ```
  * **Plugins:** Extend functionality. Examples: `openvas.rb`, `sqlmap.rb`.
  * **Scripts:** Tools for Meterpreter, automation, and shell scripting, located in `/scripts/`.
  * **Tools:** Command-line utilities for specific tasks:

    ```
    /tools/
      - exploit
      - password
      - recon
    ```

## **Key Advantages**

* **Modularity:**\
  Switch seamlessly between exploits, payloads, and post-exploitation tools.
* **Automation:**\
  Automate repetitive tasks, reducing manual intervention.
* **Flexibility:**\
  Integrates with external tools like Nexpose and SQLMap.
* **User-Friendly:**\
  Features such as tab completion, command chaining, and organized modules enhance usability.

## **msfconsole: The Core Interface**

The `msfconsole` is the **centralized command-line interface** for Metasploit. It provides a stable, feature-rich environment to interact with the framework.

**Key Features:**

* Full access to modules, session management, and job control.
* Tab completion for commands and options.
* Silent mode for discrete operations:

  ```bash
  msfconsole -q
  ```

**Commands Overview:**

| Command                | Description                            |
| ---------------------- | -------------------------------------- |
| `search <term>`        | Search for modules.                    |
| `use <module_path>`    | Load a specific module.                |
| `show options`         | View required and optional parameters. |
| `set <option> <value>` | Configure a parameter.                 |
| `exploit` or `run`     | Execute the loaded module.             |
