Web interface

Cuckoo provides a web interface utility that you can use to submit files to be analyzed and view analysis reports.

Configuration

The web interface pulls data from Mongo database so have Mongo reporting module enabled in reports.conf is mandatory for web interface usage. If Mongo module is not enabled the web application wouldn’t start raising an exception.

Web interface settings can be configured edititing local_settings.py in web folder:

# If you want to customize your cuckoo path set it here.
# CUCKOO_PATH = "/where/cuckoo/is/placed/"

# If you want to customize your cuckoo temporary upload path set it here.
# CUCKOO_FILE_UPLOAD_TEMP_DIR = "/where/web/tmp/is/placed/"

# Maximum upload size.
MAX_UPLOAD_SIZE = 26214400

# Override default secret key stored in secret_key.py
# Make this unique, and don't share it with anybody.
# SECRET_KEY = "YOUR_RANDOM_KEY"

# Local time zone for this installation. Choices can be found here:
# http://en.wikipedia.org/wiki/List_of_tz_zones_by_name
# although not all choices may be available on all operating systems.
# On Unix systems, a value of None will cause Django to use the same
# timezone as the operating system.
# If running in a Windows environment this must be set to the same as your
# system time zone.
TIME_ZONE = "America/Chicago"

# Language code for this installation. All choices can be found here:
# http://www.i18nguy.com/unicode/language-identifiers.html
LANGUAGE_CODE = "en-us"

ADMINS = (
    # ("Your Name", "your_email@example.com"),
)

MANAGERS = ADMINS

# Allow verbose debug error message in case of application fault.
# It's strongly suggested to set it to False if you are serving the
# web application from a web server front-end (i.e. Apache).
DEBUG = True

# A list of strings representing the host/domain names that this Django site
# can serve.
# Values in this list can be fully qualified names (e.g. 'www.example.com').
# When DEBUG is True or when running tests, host validation is disabled; any
# host will be accepted. Thus it's usually only necessary to set it in production.
ALLOWED_HOSTS = ["*"]

Usage

You can find the folder at path web in the Cuckoo’s root and you can start it running the following command inside the web directory:

$ python manage.py runserver

By default it will create a webserver on localhost and port 8000. Open your browser at http://localhost:8000 and it will prompt you a simple form that allows you to upload a file, specify some options (with the same format as the submit.py utility) and submit it.

If you want to configure the web interface as listening for any IPs on a specified port, you run start it with the following command (replace PORT with the number of your desired port):

$ python manage.py runserver 0.0.0.0:PORT

You can serve Cuckoo’s web interface using WSGI interface with common web servers: Apache, Nginx, Unicorn and so on. Please refer to your web server documentation on how to deploy WSGI applications.