Usage

This chapter explains how to use Cuckoo.

• Starting Cuckoo
• Submit an Analysis
  • Submission Utility
  • web.py
  • API
  • Distributed Cuckoo
  • Python Functions
• Web interface
  • Configuration
  • Usage
• REST API
  • Starting the API server
  • Resources
    • /tasks/create/file
    • /tasks/create/url
    • /tasks/list
    • /tasks/view
    • /tasks/delete
    • /tasks/report
    • /tasks/screenshots
    • /files/view
    • /files/get
    • /pcap/get
    • /machines/list
    • /machines/view
    • /cuckoo/status
• Distributed Cuckoo
  • Dependencies
  • Starting the Distributed REST API
    • Report Formats
    • Samples Directory
    • Reports Directory
  • RESTful resources
    • GET /node
    • POST /node
    • GET /node/<name>
    • PUT /node/<name>
    • DELETE /node/<name>
    • GET /task
    • POST /task
    • GET /task/<id>
    • DELETE /task/<id>
    • GET /report/<id>/<format>
  • Quick usage
  • Proposed setup
    • Configuration settings
      • conf/cuckoo.conf
      • conf/processing.conf
      • conf/reporting.conf
      • conf/virtualbox.conf
    • Setup Cuckoo
    • Setup Distributed Cuckoo
    • Register Cuckoo nodes
• Analysis Packages
• Analysis Results
  • analysis.conf
  • analysis.log
  • dump.pcap
  • memory.dmp
  • files/
  • logs/
  • reports/
  • shots/
• Clean all Tasks and Samples
• Utilities
  • Cleanup utility
  • Submission Utility
  • Web Utility
  • Processing Utility
  • Community Download Utility
  • Database migration utility
  • Stats utility
  • Machine utility