Usage

Module

from hatsploit.lib.module.basic import *

class HatSploitModule(Module, Handler):
    ...

Payload

from hatsploit.lib.payload.basic import *

class HatSploitPayload(Payload, Handler):
    ...

Options

Module

• PAYLOAD - PayloadOption(None, "Payload to use.", True)
• BLINDER - BooleanOption('no', "Start blind command injection.", False)
• LHOST - IPv4Option(TCPTools.get_local_host(), "Local host.", True)
• LPORT - PortOption(8888, "Local port.", True)

Payload

• ENCODER - EncoderOption(None, "Encoder to use.", False)
• RHOST - IPv4Option(TCPTools.get_local_host(), "Remote host.", True)
• RPORT - PortOption(8888, "Remote port.", True)

Methods

• self.module_handle(...) - Handle session for current module and payload.

Required arguments

• sender - function that takes one argument and is used to exploit the vulnerability and send the payload.

sender is a complete exploit. This function should take command or payload and execute it on target. This function can easily be called an entry point for handler.

Optional arguments

• method - method to use, to send the payload (e.g. printf, bash_echo, echo, certutil, etc.)
• concat - concatenation operator (e.g. &&)
• linemax - maximum characters in the command.
• location - if payload is sent to the filesystem, you can specify custom path. (e.g. /tmp or %TEMP%)
• background - background operator (e.g. &)
• on_session - function that takes no arguments and executed right after session was opened.

Example

This example below is a part of module, which exploits RCE vulnerability and passes the exploit to handler.

def exploit(self, command):
    """ Exploit code that sends commands to target via the vulnerability.
    """

    pass

def run(self):
    """ Module body, code in this function executed when used hits run.
    """

    self.module_handle(
        sender=self.exploit,
    )

After this, if exploit works, session should be opened.