# Freedom Fighting Mode (FFM)

FFM is a hacking harness that you can use during the post-exploitation phase of a red-teaming
engagement. The idea of the tool was derived from a 
[2007 conference](https://conference.hitb.org/hitbsecconf2007kl/materials/D1T1%20-%20The%20Grugq%20-%20Meta%20Antiforensics%20-%20The%20HASH%20Hacking%20Harness.pdf) 
from @thegrugq.

It was presented at [SSTIC 2018](https://www.sstic.org/2018/) ([video](https://www.sstic.org/2018/presentation/hacking_harness_ffm/)) and the accompanying slide deck is 
available at [this url](http://manalyzer.org/static/talks/SSTIC2018.pptx). If you're not familiar
with this class of tools, it is strongly advised to have a look at them to understand what a
hacking harness' purpose is. All the comments are included in the slides.

This project is distributed under the terms of the 
[GPL v3 License](https://www.gnu.org/licenses/gpl.html).

## Documentation
The primary documentation lives in this README and the command modules under `commands/`.
The SSTIC talk links above remain the best high-level background for how the harness is meant to be used.
Additional walkthrough material is available at:
- https://ice-wzl.gitbook.io/hacknetics/c2-frameworks/ffm-documentation

## Contributors
- `ice-wzl` contributed commands, documentation, and refactors during the project history.

## Installation
### Docker Install
 - With the diversity of modern terminal prompts, we highly recommend using `docker` with this tool.
 - Utilizing the `Dockerfile` in this repository will drastically cut down on potential errors encountered.
 - Utilizing a container to interact with remote hosts is also more secure. If you were to get exploited while interacting with a remote host, they would be sitting in your container vice your actual host.  Lets still hope that does not happen.
 - Ensure you have `Docker` installed on your local system
 ````
 git clone https://github.com/JusticeRage/FFM.git
 cd /FFM

 docker build Docker_Install/ -t ffm:ffm
 
 docker image list 
 REPOSITORY                TAG         IMAGE ID      CREATED        SIZE
 localhost/ffm             ffm         fb6dd17e3b91  9 minutes ago  614 MB
 docker.io/library/ubuntu  22.04       3b418d7b466a  2 weeks ago    80.3 MB
 
 #run your new container and drop into a /bin/bash prompt as root
 docker run -it --entrypoint /bin/bash -u 0 fb6dd17e3b91
 ````
 - Once in your container set the `passwd` for `root` and `neo`
 - `su neo` and now you are all set 
### Non Docker Install
- Not recommended
````
 git clone https://github.com/JusticeRage/FFM.git
 cd /FFM
 pip install -r requirements.txt
````

## Usage

The goal of a hacking harness is to act as a helper that automates common tasks during the 
post-exploitation phase, but also safeguards the user against mistakes they may make.

It is an instrumentation of the shell. Run `./ffm.py` to activate it and you can start working
immediately. Commands are split across the small modules under `commands/`, with
`commands/command_manager.py` handling discovery and registration. The main groups are
enumeration, help, stealth, transfer, and execution.

There are two commands you need to know about:

- Type `!list` to display all the commands provided by the harness.
- Type `!list tags` to see the different tags that commands can be binned under
````
!list tags
List of commands available:
	 enumeration
	 execution
	 help
	 stealth
	 transfer
````
- You can now type `!list enumeration` (or one of the other tags) to see commands that fall into that category.
````
!list enumeration
List of commands available:
	!backup-hunter: Hunts for backup files
	!info: Returns CPU(s), Architecture, Memory, and Kernel Verison for the current machine.
	!log: Toggles logging the harness' input and output to a file.
	!mtime: Returns files modified in the last X minutes
	!os: Prints the distribution of the current machine.
	!db-hunter: Hunts for .sqlite, .sqlite3, and .db files
	!sshkeys: Hunts for Private and Public SSH keys on the current machine.
	!suid: Finds SUID, SGID binaries on the current machine.
	--snip--

````
- Type `SHIFT+TAB` to perform tab completion on the local machine. This may be useful if you're
ssh'd into a remote computer but need to reference a file that's located on your box.

## List of features

This hacking harness provides a few features that are described below. As they are described, 
the design philosophy behind the tool will also be introduced. It is not expected that all
the commands implemented in FFM will suit you. Everyone has their own way of doing things, and
tuning the harness to your specific need is likely to require you to modify some of the code
and/or write a few plugins. A lot of effort went into making sure this is a painless task.

## Commands

### Enumeration Commands
* `!os` is an extremely simple command that just runs `cat /etc/*release*` to show what OS
the current machine is running. It is probably most valuable as a demonstration that in the
context of a hacking harness, you can define aliases that work across machine boundaries.
SSH into any computer, type `!os` and the command will be run. The enumeration commands live in
`commands/enumeration_commands.py`, the help commands in `commands/help_commands.py`, and the
stealth-related commands are split across `commands/stealth_commands.py`,
`commands/notty_sudo.py`, and `commands/log_control.py`.
* `!backup-hunter` Hunts for backup files
* `!info` Returns CPU(s), Architecture, Memory, and Kernel Verison for the current machine.
* `!log` Toggles logging the harness' input and output to a file. Implemented in
`commands/log_control.py`.
* `!mtime` Returns files modified in the last X minutes. For example `!mtime 5` will get all files on the local machine (that you have rights to see) that have been modified in the last 5 minutes.
* `!db-hunter` Hunts for .sqlite, .sqlite3, and .db files and other database files
* `!sshkeys` Hunts for Private and Public SSH keys on the current machine.
* `!suid` Finds SUID, SGID binaries on the current machine.
* `!strange-dirs` Checks device starting at user specified path for strange directories on a host
* `!sudo-version` Checks for a vulnerable sudo version
* `!vm` Checks if device is a Virtual Machine

### Transfer Commands
- Commands that help you pull and push files, pretty straight forward.
* `!download [remote file] [local path]` gets a file from the remote machine and copies it
locally through the terminal. This command is a little more complex because more stringent
error checking is required but it's another command you can easily read to get started. It lives
in `commands/download_file.py`. Note that it requires `xxd` or `od` on the remote machine to
function properly.
* `!download-dir [remote directory] [local destination]` streams a tar archive of a remote
directory through the terminal and extracts it locally without touching the remote filesystem.
It lives in `commands/download_directory.py`. It requires `tar` and `base64` on the remote
machine, and uses `gzip` as well when available.
* `!upload [local file] [remote path]` works exactly the same as the previous command,
except that a local file is put on the remote machine. It lives in `commands/upload_file.py`.


### Execution Commands 

* `!sh [local script]` Runs a shell script from the local machine in memory. It lives in
`commands/remote_script.py`.
* `!py [local script]` executes a local Python script on the remote machine, and does so
*entirely in memory*. It lives in `commands/remote_script.py`. Check out my
[other repository](https://github.com/JusticeRage/freedomfighting) for scripts you might
want to use. This commands uses a multiline syntax with `<<`, which means that pseudo-shells
that don't support it (Weevely is a good example of that) will break this command quite badly.
* `!py3 [local script]` does the exact same thing except for systems with python3. It uses the same module, `commands/remote_script.py`.
* `!elf [local script]` Runs an executable from the local machine in memory using whatever compatible Python interpreter is available on the remote machine. It lives in `commands/remote_elf.py`.

### Stealth Commands 
- I am fully aware these two modules are the opposite of "stealthy" but it is where they are currently placed until an alternative location can be worked out.  This stealth category will more than likely contain commands that help you blend in better in addition to those commands that might make you stick out.
* `!pty` spawns a TTY, which is something you don't want in most cases because it tends to 
leave forensics evidence. However, some commands (`sudo`) or exploits require a TTY to run
in so this is provided as a convenience. `UNSET HISTFILE HISTFILESIZE HISTSIZE PROMPT_COMMAND` is passed to it as soon as it
spawns, along with `export TERM=xterm`
* `!sudo` Invoke sudo without a TTY. It lives in `commands/notty_sudo.py`.


Plugins can be further configured by editing `ffm.conf`.

### Processors

Conceptually, commands (as described above) are used to generate some bash which is forwarded
to the shell. They can perform more complex operations by capturing the shell's output and 
generating additional instructions based on what is returned.
Processors are a little different as they are rather used to rewrite data circulating between
the user and the underlying bash process. While it is true that any processor could be rewritten
as a command, it seemed a little cleaner to separate the two. Input processors work on whatever
is typed by the user once they press the `ENTER` key, and output processors can modify anything
returned by the shell.

* A good processor example can be found in `processors/ssh_command_line.py`. All it does is add
the `-T` option to any SSH command it sees if it is missing. Be sure to check out its simple 
code if you are interested in writing a processor.
* Another input processor present in the framework, `processors/assert_torify.py`, contains a
blacklist of networking commands (`ssh`, `nc`) and blocks them if they don't seem to be proxied
through a tool such as `torify`. The harness does its best to only bother the user if it seems
like the command is being run on the local machine. Obviously this should not be your only
safeguard against leaking your home IP address.
* Finally, `processors/sample_output_processor.py` is a very simple output processor that 
highlights in red any occurrence of the word "password". As it's quite useless, it's not enabled
in the framework but you can still use it as a starting point if you want to do something more 
sophisticated.

## Known issues

`CTRL+R` is not implemented yet and we all miss it dearly.

More problematic is the fact that the framework hangs from time to time. In 99% of the cases,
this happens when it fails to detect that a command it launched has finished running. Usually,
this means that the command prompt of the machine you're logged into could not be recognized
as such. In that case, you can try improving the regular expression located at the very
beginning of the file `ffm.py`, or log into that same machine with `ssh -T` as there won't be
any problematic prompt anymore. 
By default, FFM will give up on trying to read the output of a command after 5 minutes (some
plugins may implement different timeouts); so if the framework hangs, you'll need to wait
until you see an error message (though if the underlying process is still running, you may
still not be able to type in commands).

## Closing statement

I think I've covered everything about this tool. Again, it's a little different from what I
usually release as most people will probably need to modify it before it can be valuable to
them.

Many plugins have yet to be written, so be sure to share back any improvements you make to
FFM. Feel free to open issues not only for bugs, but also if you're trying to do something
and can't figure out how; this way I'll be able to improve the documentation for everyone.

### To Do
- Single file encryption module

### Contact
[![](https://manalyzer.org/static/mail.png)](justicerage@manalyzer[.]org)
[![](https://manalyzer.org/static/twitter.png)](https://twitter.com/JusticeRage)
[![](https://manalyzer.org/static/gpg.png)](https://pgp.mit.edu/pks/lookup?op=vindex&search=0x40E9F0A8F5EA8754)
