Adding Simple Modules

You can install tools either before or after spinning up your fleet (monkey patching). If you already have a fleet, simply execute axiom-exec. This also works for updating. For example, to update Nuclei templates run axiom-exec "nuclei -update-templates". To install a package with apt-get, execute axiom-exec "sudo apt-get install [package-name] -y"

Adding tools to the packer build is only slightly more complicated. First, add the command(s) to install the tool(s) to one of the provisioner files (https://github.com/pry0cc/axiom/blob/master/images/provisioners/) under the inline object. The command(s) must be non-interactive, wrapped in double-quotes, and ending with a comma for all lines, except for the last line. If you require an additional set of double-quotes, make sure to escape them. Next run axiom-build to create the new packer image with your tools installed.

Creating a module is also easy. Let's use DNSX for example. DNSX is a prime choice being the easiest to work with. It's easy because it outputs to plaintext, which needs to be expressed here and the results are returned one line per target but don't need to be in any specific order, making it easy to merge.

[{
	"command":"cat input | /usr/bin/dnsx -silent -r /home/op/lists/resolvers.txt -o output",
	"ext":"txt"
}]

With axiom-scan, every instance executes the same command, which can be found in the module. axiom-scan splits the user-provided target list (a bunch of IPs for example) into equal parts per instance. Meaning if you have 5 instances, one target list is divided into 5 equal parts (the best it can) and uploads them to the appropriate instance. During this process, it renames all files to input. Each instance is leveraging its file called input, specified in the module, which is one portion of the total target list. This is important to know as all modules need to include input or else axiom-scan won't know where to find the target list.

When specifying the path(s) in a module, always add the full path, never use a relative path in the modules. To find the full path of a binary use which. For example, which dnsx shows /usr/bin/dnsx. If a binary takes a wordlist or a list of resolvers or any other file, providing the full path is still required.

Just as important as a file named input to be the module, we also have output, which you guessed, is the filename for the output file. To download results from each instance, axiom-scan uses rsync via SSH to download a file named output from each instance. The output files are then merged into one and finally renamed to a user-provided argument.

For tools that only output to STDOUT but not to a file, avoid using > to redirect the output. Instead, pipe the STDOUT to tee and save it to a file named output, tee output.

"cat input, which as we previously explained is a portion of the target list, is passed to the full path of the binary /usr/bin/dnsx with arguments and a full path to a list of resolvers -silent -r /home/op/lists/resolvers.txt and outputs the contents to a file named output -o output" as text "ext":"txt".