Flask-Shell2HTTP 1.4.3

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

Flask-Shell2HTTP

A minimalist Flask extension that serves as a RESTful/HTTP 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 with dynamic arguments, file upload, callback function capabilities.
• Designed for binary to binary/HTTP communication, development, prototyping, remote control and more.

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 different binaries distributed in micro-containers. See real-life example.
• You can define a callback function/ use signals to listen for process completion. See Example code.
  • Maybe want to pass some additional context to the callback function ?
  • Maybe intercept on completion and update the result ? See Example code
• Currently, all commands run asynchronously (default timeout is 3600 seconds), so result is not available directly. An option may be provided for this in future releases for commands that return immediately.

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!

I highly recommend the Examples section.

Inspiration

This was initially made to integrate various command-line tools easily with Intel Owl, which I am working on as part of Google Summer of Code.

The name was inspired by the awesome folks over at msoap/shell2http.