Skip to content

Getting Started

GoXploit is a Go library designed to allows developers to automate tasks such as session management, module execution, job handling, and communication with Metasploit’s framework.

How Was it Made?

GoXploit is built on top of Metasploit's RPC interface, utilizing its client-server communication model to interact with the framework programmatically. The library provides wrappers around Metasploit's RPC commands auto generated from Rapid7 Documentation

Programs That Use GoXploit

GoXploit can be integrated into various penetration testing tools or some possible use cases include:

  • Custom Metasploit Integrations: Build your own security automation tools based on Metasploit’s powerful capabilities.
  • Automated Vulnerability Exploitation Tools: Use GoXploit for automated vulnerability scanning and exploitation.
  • Security Monitoring: Integrate GoXploit into security monitoring platforms to automate certain tasks.

For more detailed examples of how to use GoXploit in real-world applications, please refer to the Usage Guide.

Installation Guide

To get started with GoXploit, follow the steps below to install the library and set up your environment.

Prerequisites

Before installing GoXploit, make sure you have the following:

  • Go (v1.24.1 or higher): Ensure that you have Go installed on your system. You can check your version by running:

    bash
    go version

If you don’t have Go installed, you can download it from here.

NOTE

Metasploit must be installed and running with the RPC server enabled.

Install GoXploit

Follow these steps to install GoXploit in your Go project:

Step 1: Install

First, clone the GoXploit repository from GitHub:

bash
go get github.com/arisinghackers/goxploit
go mod tidy

Step 2: Configure Metasploit RPC

Ensure that the Metasploit RPC server is running and configured to allow connections. You can set up the RPC server by creating or modifying the rpc.rc file in Metasploit:

bash
load msgrpc ServerHost=127.0.0.1 ServerPort=55553 User=msf Pass=password

Then, start Metasploit with the following command:

bash
msfconsole -r rpc.rc

You should now have a working installation of GoXploit, and you’re ready to start interacting with Metasploit programmatically.

For details on how to use the library, check out the Usage Guide.