Skip to main content
Help the Python Software Foundation raise $60,000 USD by December 31st!  Building the PSF Q4 Fundraiser

Cincan wrapper for dockerized command-line tools

Project description

pipeline status coverage report

CinCan Command

CinCan is a command-line interface for running security analysis tools conveniently in Docker containers.

Complete documentation is available at CinCan Documentation.

Features

  • Install and update security analysis tools without dependency hell. CinCan collects the best security analysis tools around the web and provides them as containerized Docker images. You can use CinCan's tools as if they were installed locally because CinCan automates the process of installing and updating the tools and removes the need to manually maintain conflicting dependencies.

  • Repeatable command-line experience. Learn from our blog how CinCan improves the command-line experience by combining various tools for repeatable and high-quality security analysis.

  • Community support. If you know a tool that is not available in CinCan, please contribute to the project!

Supported platforms

The cincan command should run on all fairly modern Linux distributions. Partial support for macOS is available - tested to work with macOS Catalina. On Windows, cincan does not work, unfortunately, unless used with Windows Subsystem for Linux 2 (WSL2).

Installation

As a prerequisite, you must have Docker 18.09+ installed for running the tools, and Python 3.6+ and pip Python package manager to install the cincan command.

Install cincan via pip:

% pip install --user cincan-command

You can verify that the installation works by running:

% cincan list

If all goes well, you should get a list of the latest stable tools dockerized in the CinCan project. The first time running this may take a while as it will fetch information about the tools and cache it locally.

Tool images are currently hosted (mirrored) in:

Currently, default registry is quay.io, use full names to run CinCan images from certain registry - otherwise quay.io is used by default. For example name cincan/tshark will be converted into quay.io/cincan/tshark. This only applies to CinCan images. We are migrating away from Docker Hub due to newly introduced rate limits.

Use the installation instructions in the CinCan Documentation for additional help.

Using tools

A specific tool can be invoked with cincan run like this:

% cincan run [OPTIONS] TOOL[:TAG] [ARG...]

For example, invoke the tool cincan/pywhois with:

% cincan run cincan/pywhois 127.0.0.1

See more examples from cincan run reference in the CinCan documentation.

Project details


Download files

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

Files for cincan-command, version 0.2.11
Filename, size File type Python version Upload date Hashes
Filename, size cincan_command-0.2.11-py3-none-any.whl (28.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size cincan-command-0.2.11.tar.gz (28.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page