Installation

You can installcryptography:

$pipinstallcryptography
$uvaddcryptography

If this does not work pleaseupgrade your pip first, as that is thesingle most common cause of installation problems.

Supported platforms

Currently we testcryptography on Python 3.8+ and PyPy3.11 on theseoperating systems.

  • x86-64 CentOS Stream 9, 10

  • x86-64 Fedora (latest)

  • x86-64 and ARM64 macOS 15 Sequoia

  • x86-64 Ubuntu 22.04, 24.04, and rolling

  • ARM64, ARMv7l, andppc64le Ubuntu rolling

  • x86-64 Debian Bookworm (12.x), Trixie (13.x), and Sid (unstable)

  • x86-64 and ARM64 Alpine (latest)

  • 32-bit and 64-bit Python on 64-bit Windows Server 2022

  • ARM64 Windows 11

We test compiling withclang as well asgcc and use the followingOpenSSL releases in addition to distribution provided releases from theabove supported platforms:

  • OpenSSL3.0-latest

  • OpenSSL3.2-latest

  • OpenSSL3.3-latest

  • OpenSSL3.4-latest

  • OpenSSL3.5-latest

We also test against the latest commit of BoringSSL, the latestaws-lc release,and versions of LibreSSL that are receiving security support at the time of agivencryptography release.

Building cryptography on Windows

The wheel package on Windows is a statically linked build (as of 0.5) so alldependencies are included. To installcryptography, you will typicallyjust run

$pipinstallcryptography

If you prefer to compile it yourself you’ll need to have OpenSSL installed.You can compile OpenSSL yourself as well or usea binary distribution.Be sure to download the proper version for your architecture and Python(VC2015 is required for 3.8 and above). Wherever you place your copy of OpenSSLyou’ll need to set theOPENSSL_DIR environment variable to include theproper location. For example:

C:\> \path\to\vcvarsall.bat x86_amd64C:\> set OPENSSL_DIR=C:\OpenSSL-win64C:\> pip install cryptography

You will also need to haveRust installed andavailable.

If you need to rebuildcryptography for any reason be sure to clear thelocalwheel cache.

Building cryptography on Linux

Note

You shouldupgrade pip and attempt to installcryptography againbefore following the instructions to compile it below. Most Linuxplatforms will receive a binary wheel and require no compiler if you havean updatedpip!

cryptography shipsmanylinux wheels (as of 2.0) so all dependenciesare included. For users onpip 19.3 or above running on amanylinux2014(or greater) compatible distribution (orpip 21.2.4 formusllinux) allyou should need to do is:

$pipinstallcryptography

If you want to compilecryptography yourself you’ll need a C compiler, aRust compiler, headers for Python (if you’re not usingpypy), and headersfor the OpenSSL andlibffi libraries available on your system.

On all Linux distributions you will need to haveRust installed andavailable.

Warning

The Rust available by default in Alpine < 3.21 is older than theminimum supported version. See theRust installation instructions for information about installing a newer Rust.

$sudoapkaddgccmusl-devpython3-devlibffi-devopenssl-devcargopkgconfig

If you get an error withopenssl-dev you may have to uselibressl-dev.

Warning

The Rust available in Debian versions prior to Trixie are older than theminimum supported version. See theRust installation instructions for information about installing a newer Rust.

$sudoapt-getinstallbuild-essentiallibssl-devlibffi-dev\python3-devcargopkg-config

Warning

For RHEL and CentOS you must be on version 9.6 or newer for the commandbelow to install a sufficiently new Rust. If your Rust is less than1.83.0 please see theRust installation instructions for information about installing a newer Rust.

$sudodnfinstallredhat-rpm-configgcclibffi-develpython3-devel\openssl-develcargopkg-config

Building

You should now be able to build and install cryptography. To avoid gettingthe pre-built wheel onmanylinux compatible distributions you’ll need touse--no-binary.

$pipinstallcryptography--no-binarycryptography

Using your own OpenSSL on Linux

Python links to OpenSSL for its own purposes and this can sometimes causeproblems when you wish to use a different version of OpenSSL with cryptography.If you want to use cryptography with your own build of OpenSSL you will need tomake sure that the build is configured correctly so that your version ofOpenSSL doesn’t conflict with Python’s.

The options you need to add allow the linker to identify every symbol correctlyeven when multiple versions of the library are linked into the same program. Ifyou are using your distribution’s source packages these will probably bepatched in for you already, otherwise you’ll need to use options something likethis when configuring OpenSSL:

$./config-Wl,-Bsymbolic-functions-fPICshared

Static Wheels

Cryptography ships statically-linked wheels for macOS, Windows, and Linux (viamanylinux andmusllinux). This allows compatible environments to usethe most recent OpenSSL, regardless of what is shipped by default on thoseplatforms.

If you are using a platform not covered by our wheels, you can build your ownstatically-linked wheels that will work on your own systems. This will allowyou to continue to use relatively old Linux distributions (such as LTSreleases), while making sure you have the most recent OpenSSL available toyour Python programs.

To do so, you should find yourself a machine that is as similar as possible toyour target environment (e.g. your production environment): for example, spinup a new cloud server running your target Linux distribution. On this machine,install the Cryptography dependencies as mentioned inBuilding cryptography on Linux.Please also make sure you havevirtualenv installed: this should beavailable from your system package manager.

Then, paste the following into a shell script. You’ll need to populate theOPENSSL_VERSION variable. To do that, visitopenssl.org and find thelatest non-FIPS release version number, then set the string appropriately. Forexample, for OpenSSL 3.0.9, useOPENSSL_VERSION="3.0.9".

When this shell script is complete, you’ll find a collection of wheel files ina directory calledwheelhouse. These wheels can be installed by asufficiently-recent version ofpip. The Cryptography wheel in thisdirectory contains a statically-linked OpenSSL binding, which ensures that youhave access to the most-recent OpenSSL releases without corrupting your systemdependencies.

set -eOPENSSL_VERSION="VERSIONGOESHERE"CWD=$(pwd)virtualenv env. env/bin/activatepip install -U setuptoolspip install -U wheel pipcurl -O https://www.openssl.org/source/openssl-${OPENSSL_VERSION}.tar.gztar xvf openssl-${OPENSSL_VERSION}.tar.gzcd openssl-${OPENSSL_VERSION}./config no-shared no-ssl2 no-ssl3 -fPIC --prefix=${CWD}/opensslmake && make installcd ..OPENSSL_DIR="${CWD}/openssl" pip wheel --no-cache-dir --no-binary cryptography cryptography

Building cryptography on macOS

Note

If installation gives afatalerror:'openssl/aes.h'filenotfoundsee theFAQ for information about how to fix this issue.

The wheel package on macOS is a statically linked build (as of 1.0.1) so forusers with pip 8 or above you only need one step:

$pipinstallcryptography

If you want to build cryptography yourself or are on an older macOS version,cryptography requires the presence of a C compiler, development headers, andthe proper libraries. On macOS much of this is provided by Apple’s Xcodedevelopment tools. To install the Xcode command line tools (on macOS 10.10+)open a terminal window and run:

$xcode-select--install

This will install a compiler (clang) along with (most of) the requireddevelopment headers.

You will also need to haveRust installed andavailable, which can be obtained fromHomebrew,MacPorts, or directly from the Rust website.

Finally you need OpenSSL, which you can obtain fromHomebrew orMacPorts.Cryptography doesnot support the OpenSSL/LibreSSL libraries Apple shipsin its base operating system.

To build cryptography and dynamically link it:

Homebrew

$brewinstallopenssl@3rust$pipinstall--no-binarycryptographycryptography

MacPorts:

$sudoportinstallopensslrust$envOPENSSL_DIR="-L/opt/local"pipinstall--no-binarycryptographycryptography

You can also build cryptography statically:

Homebrew

$brewinstallopenssl@3rust$envOPENSSL_STATIC=1pipinstall--no-binarycryptographycryptography

MacPorts:

$sudoportinstallopensslrust$envOPENSSL_STATIC=1OPENSSL_DIR="/opt/local"pipinstall--no-binarycryptographycryptography

If you need to rebuildcryptography for any reason be sure to clear thelocalwheel cache.

Building with BoringSSL, LibreSSL, or AWS-LC

To build against BoringSSL, LibreSSL, or AWS-LC instead of OpenSSL, you can set theOPENSSL_DIR environment variable to point to your BoringSSL, LibreSSL, or AWS-LCinstallation directory.

Rust

Note

If you are using Linux, then you shouldupgrade pip (ina virtual environment!) and attempt to installcryptography again beforetrying to install the Rust toolchain. On most Linux distributions, the latestversion ofpip will be able to install a binary wheel, so you won’t needa Rust toolchain.

Buildingcryptography requires having a working Rust toolchain. The currentminimum supported Rust version is 1.83.0.This is newer than the Rust somepackage managers ship, so users may need to install with theinstructions below.

Instructions for installing Rust can be found onthe Rust Project’s website.We recommend installing Rust withrustup (as documented by the RustProject) in order to ensure you have a recent version.

Rust is only required when buildingcryptography, meaning that you mayinstall it for the duration of yourpipinstall command and then remove itfrom a system. A Rust toolchain is not required tousecryptography. Indeployments such asdocker, you may use a multi-stageDockerfile whereyou install Rust during the build phase but do not install it in the runtimeimage. This is the same as the C compiler toolchain which is also required tobuildcryptography, but not afterwards.