The first step is to copy the /Mythic/Example_Payload_Type
folder into the /Mythic/Payload_Types/
folder and rename it to match the name of your new agent. For the purposes here, let's assume your new agent is called MyNewAgent
. So you'd copy that directory as /Mythic/Payload_Types/MyNewAgent
.
The next thing you need to do is edit the builder file (https://github.com/its-a-feature/Mythic/blob/master/Example_Payload_Type/mythic/agent_functions/builder.py) to reflect the information for your new agent. Specifically, you'll want to edit it like:
from PayloadBuilder import *import asyncioimport osfrom distutils.dir_util import copy_treeimport tempfile​# define your payload type class here, it must extend the PayloadType class thoughclass MyNewAgent(PayloadType):​name = "MyNewAgent" # name that would show up in the UIfile_extension = "exe" # default file extension to use when creating payloadsauthor = "@YourHandleHere" # author of the payload typesupported_os = [ # supported OS and architecture combosSupportedOS.Windows, SupportedOS.Linux # update this list with all the OSes your agent supports]wrapper = False # does this payload type act as a wrapper for another payloads inside of it?# if the payload supports any wrapper payloads, list those herewrapped_payloads = [] # ex: "service_wrapper"note = "Any note you want to show up about your payload type in the UI"supports_dynamic_loading = False # setting this to True allows users to only select a subset of commands when generating a payloadbuild_parameters = {# these are all the build parameters that will be presented to the user when creating your payload# we'll leave this blank for now}# the names of the c2 profiles that your agent supportsc2_profiles = ["HTTP"]# after your class has been instantiated by the mythic_service in this docker container and all required build parameters have values# then this function is called to actually build the payloadasync def build(self) -> BuildResponse:# this function gets called to create an instance of your payloadresp = BuildResponse(status=BuildStatus.Error)return resp
More information on each component in the file can be found in Payload Type Info. Now you can run sudo ./start_payload_types.sh MyNewAgent
and you'll see the container build, start, and you'll see it sync with the Mythic server (more about that process at Container Syncing).
Congratulations! You now have a payload type that Mythic recognizes!
Now you'll want to actually configure your Docker Container, look into building your agent, how to declare new commands, how to process tasking to these commands, and finally hooking your agent into all the cool features of Mythic.