facebookincubator / TTPForge

The TTPForge is a Cybersecurity Framework for developing, automating, and executing attacker Tactics, Techniques, and Procedures (TTPs).

MIT License

337 stars 33 forks source link

Proposed Changes

Introduce integration testing for ForgeArmory example TTPs, add debugging configuration, update docgen to include magefile support, pinned afero dependency, and refactor documentation.

Related Issue(s)

None.

Testing

Added integration tests for ForgeArmory example TTPs.
Implemented a new launch configuration in VSCode settings for debugging "mage RunIntegrationTests".
Validated enhancements made to the documentation and clarity of comments within magefiles/magefile.go.

Documentation

Updated comments within magefiles/magefile.go for better understanding and clarity.
Generate docs for magefile

Screenshots/GIFs (optional)

N/A

Checklist

[x] Ran mage runprecommit locally and fixed any issues that arose.
[x] Ran mage runtests locally and fixed any issues that arose.
[x] Curated your commits so they are legible and easy to read and understand.
[x] 🚀

A setup like this should probably depend on a "build TTPForge binary" target and then use the resulting binary to run the tests - right now it will use the version of ttpforge that is first in you $PATH, which may not match the version currently under development.

Depending on your workflow, ttpforge may not live in your $PATH at all - for example, I don't put it in $PATH on my dev machine, so I get this when I run it:
err: exec: "ttpforge": executable file not found in $PATH
Would recommend manipulating the path used during subcommand invocation to put the newly-built binary first and then run that.

That said, this doesn't need to block - stamping.

100% agree. Should have this done with the requested updates in a bit