Flask-Shell2HTTP 1.2.0

A minimalist REST API wrapper for python's subprocess API.

Flask-Shell2HTTP

A minimalist Flask extension that serves as a REST API wrapper for python's subprocess API.

• Convert any command-line tool into a REST API service.
• Execute pre-defined shell commands asynchronously and securely via flask's endpoints.
• Designed for development, prototyping or remote control.

Inspired by the work of awesome folks over at msoap/shell2http.

Use Cases

• Set a script that runs on a succesful POST request to an endpoint of your choice. See Example code.
• Map a base command to an endpoint and pass dynamic arguments to it. See Example code.
• Can also process multiple uploaded files in one command. See Example code.
• This is useful for internal docker-to-docker communications if you have lots of different binaries. See real-life example.
• Currently, all commands are run asynchronously, so result is not available directly. An option would be provided for this in future release.

Note: This extension is primarily meant for executing long-running shell commands/scripts (like nmap, code-analysis' tools) in background from an HTTP request and getting the result at a later time.

Documentation / Quick Start

Read the Quickstart from the documentation to get started!

Why?

This was initially made to integrate various command-line tools easily with IntelOwl.