Skip to content

Latest commit

 

History

History
34 lines (20 loc) · 4.11 KB

RATIONALE.md

File metadata and controls

34 lines (20 loc) · 4.11 KB

Existing Tools

In the web application security space it's common to set up a proxy server and self-sign a cert locally so that a pentester can intercept and edit HTTP requests as they go through a browser. There are several applications dedicated to doing this such as:

(not exhaustive)

The tools listed above are useful and quite popular in the pentesting community. But we'd prefer to have an HTTP proxy program that is completely open-source, command-line oriented, and is able to be integrated with other powerful tools.

Problems with existing tools

Burpsuite is closed source and proprietary. Certain features are locked behind a paywall, and in order to use the application a user must operate entirely within the ecosystem that PortSwigger provides. The application works well and has many useful features, but ultimately restricts the user to working within its own ecosystem. Additionally many common workflows involve navigating to multiple tabs, jumping around, hovering over nested submenus, and other time consuming or tedious workflows.

OWASP ZAP is one of the original proxy programs used for web application pentesting. Like BurpSuite it requires a lock in to a UI system and must be run as a desktop application. Unlike Burpsuite it is completely open source and does not limit its users with a requirement to pay for additional features. While the open source nature of the project is praiseworthy, the project is difficult to install on MacOS (due to some Apple security restrictions) and it operates on similar flows to BurpSuite.

MITMProxy is likely the closest to the program we'd like to build: It runs in the terminal, is open source, and has importable libraries that allow it to be fully scriptable. Where we depart from it philosophically is that we would like to be able to choose our own tools to integrate with it rather than being locked into its workflows. Without experience it can be difficult to set up, and its feature set is relatively limited compared to other tools. Being a TUI app, it is possible to work from the terminal, but we'd like a more powerful solution.

Our design philosophy

Most of the tools listed above have an extension system of some kind that allows adding to the program functionality. But we'd prefer something more in line with the original UNIX philosophy. The Jargon File quotes Doug McIlroy as saying:

Make each program do one thing well. To do a new job, build afresh rather than complicate old programs by adding new features.

While extensions are a neat and powerful tool, they ultimately create ecosystem lock rather than allowing users to define workflows with whatever tools they choose. Sometimes the trade off is worth it, but due to the ad hoc, exploratory nature of pentesting we believe this is not the case for this problem set. A powerful part of the UNIX philosophy is to treat each program as something that will inherently live as part of a pipeline, and has a common text interface. We would like our tool to support this approach while providing powerful defaults that are easy to pipe to other programs of the users choosing.

Rather than going through an options menu to edit every request, we'd like to be able to use $EDITOR to directly modify requests. We'd like to save requests/responses as serialized files and pipe them to other programs. Essentially, what we'd like to create eventually is a UNIX version of MITMProxy, and eventually integrate it with tools such as ripgrep, fuzzy-finder, your code editor of choice, and the ability to write complex (and real-time) queries in a language like nushell. We would also like the end user to have the freedom of serializing requests into formats that can be piped to other arbitrary programs (such as nuclei).

References: