Skip to main content

A command line utility for interacting with the Centrifuge Firmware Analysis Platform's REST API.

Project description

Centrifuge is an automated firmware analysis platform. It allows users to upload their firmware images to be analyzed for various security issues. This utility gives users the ability to interact and automate tasks via the Centrifuge RESTful API.

Features

  • Upload firmware

  • Delete firmware reports

  • Query firmware analysis results

  • Search for firmware uploads

Quick Start

To install the Centrifuge CLI, simply:

$ pip install centrifuge-cli

To query the list of available reports:

$ export CENTRIFUGE_API_KEY=xxxx
$ centrifuge reports list

Under the hood the Centrifuge CLI is using python Pandas data frames to report the results to the user. Since the API is json, which has heirarchical structure to it, we have chosen to flatten all the results into a column/row format for viewing inside of a terminal or for importing into spreadsheets, etc. However the cli can also output CSV, and the original json results. For example:

CSV:

$ centrifuge --outfmt=csv reports list

JSON:

$ centrifuge --outfmt=json reports list

When generating the human-readable Pandas output or when genering CSV you have the option of choosing which columns you wish to export. For example, to display only the original filename and model number of the firmware that was uploaded:

$ centrifuge -foriginalFilename -fdevice reports list

Uploading Firmware

Uploading firmware to centrifuge is quite simple. All you need to do is supply make/model/version and the file you want to upload:

$ centrifuge upload --make=Linksys --model=E1200 --version=1.0.04 /path/to/FW_E1200_v1.0.04.001_US_20120307.bin

Searching Through Firmware Uploads

Coming Soon

Querying Report Results

Coming Soon

Deleting Firmware Uploads

Coming Soon

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

centrifuge-cli-0.1.0.tar.gz (4.3 kB view hashes)

Uploaded Source

Built Distribution

centrifuge_cli-0.1.0-py3-none-any.whl (4.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page