Install

Docker

Cryptonice is now available as an executable Docker image for Linux systems, meaning it will create the container, run Cryptonice and then close down once it is complete. Using a container avoids the need to install Python, download dependencies or play around with virtual environments. It has been built on a Python 3.7 base image.

Requirements You must already have Docker installed on your system.

Download the Docker container

To grab the latest Docker image:

docker pull f5labs/cryptonice

To run Cryptonice in the container use the following command (the –rm remove the container once it’s completed, and -it makes it interactive so that you can see the output):

docker run --rm -it f5labs/cryptonice www.f5.com

If you want to output the JSON results to a folder on your local machine you must tell Docker to map a local path to a path within the container. The following example maps a folder in C:Scratch to a new folder called /results within the container):

docker run --rm -it --volume //c/scratch:/results f5labs/cryptonice www.f5.com --json_out --json_path /results

Once the scan is complete you should find the resulting www.f5.com.json file in your C:Scratch folder.

Windows

Requirements Cryptonice for Windows depends on Visual C++ Redistributable for Visual Studio 2015. Most people are likely to have this installed but if you receive an error about missing file vcruntime140.dll then make sure this is installed first.

Standalone executable

If you do not have Python installed, and can’t or won’t install it, you may be able to use the standalone Windows executable.

  1. Head over to the Cryptonice Releases section of the Github repo and download the latest version you find.
  2. Once the file has downloaded open it to begin installation (we recommend you install in to a folder that your user has write access to, e.g. C:/Cryptonice)
  3. After installation, open a terminal window and navigate in to the installation folder and the version folder found within (e.g. c:/Cryptonicecryptonice-1.0.6)

You may now use Cryptonice by entering the name of the executable and any parameters you need. For example:

c:\cryptonice\cryptonice-1.0.6\cryptonice.exe example.com

In order to run Cryptonice from any directory you may want to add the installation location to your path, for example:

set path=%path%;c:\cryptonice\cryptonice-1.0.6

Python app and Library

Installing Cryptonice via pip ensures that you can easily update the tool whenever new versions are released. The other advantage is that Cryptonice should be available to be executed from any directory that you are currently in without modifying your path.

For those that don’t yet have Python 3 installed, follow these simple steps.

  1. Download Python 3.7 or later (select Windows x86-64 executable installer)
  2. It is recommended that you leave installation options on default but (optionally) also select… * Select Install for All Users * Select Precompile standard library
  3. Open a command prompt and type ‘python’. This will send you in to a Python interpreter and also display the version you have installed. This should be 3.7 or later.

Now issue the ‘pip’ command to install Cryptonice:

pip install cryptonice

Mac

Python app and Library

Mac OS comes with Python 2 pre-installed. Since Cryptonice requires Python 3.7 or later and you will need to ensure that this is installed.

  1. Download Python 3.7 or later (select macOS 64-bit installer)
  2. Open the downloaded file and follow the installation prompts
  3. The install will pop open a file window. Double-click the file Install Certificates.command in order to install default root certificates
  4. Open up a new terminal window so that we can install Cryptonice

Finally, make sure to use ‘pip3’ so that the Python 3 version is used. If you issue the ‘pip’ command then Python 2 will be used and Cryptonice will fail:

pip3 install cryptonice

Ubuntu

Cryptonice currently supports Ubuntu 20.04. Since this distribution comes with Python 3.8.2 preinstalled we need only install PIP and one dependency manually:

sudo apt install python3-pip
sudo apt install python3-pycurl
pip3 install cryptonice

CentOS

With a little hand-holding Cryptonice will work on CentOS. It just requires a few manual steps. Currently, CentOS 8 is confirmed to be working. CentOS 8 comes bundled with Python 3.6.8 but we require 3.7 or newer.

Prerequisites

First off, we need to install required development libraries for Python:

sudo dnf install gcc openssl-devel bzip2-devel libffi-devel

Download Python 3.8

Once that’s complete, we’ll now download Python 3.8.5 (or any version of Python 3.7 or newer) to your machine:

cd /opt
wget https://www.python.org/ftp/python/3.8.5/Python-3.8.5.tgz

Extract it with the following command:

tar xzf Python-3.8.5.tgz

Building and installing

We’re now going to configure the source files based on your system and then compile Python on using the altinstall method so that we don’t overwrite your current version of Python:

cd Python-3.8.5
sudo ./configure --enable-optimizations
sudo make altinstall

You can now test that Python 3.8 is installed and working by issuing the following command:

python3.8 -V

# Python 3.8.5

Installing libcurl*

Installation of Cryptonice will still fail as it cannot find the required version of libcurl. Use yum to install libcurl:

sudo yum install libcurl-devel

Installing Cryptonice

Now we can finally use Python 3.8 to install Cryptonice:

pip3.8 install cryptonice