Skip to content

installation.adoc

Latest commit

 

History

History
267 lines (196 loc) · 7.6 KB

installation.adoc

File metadata and controls

267 lines (196 loc) · 7.6 KB
Raw

Installing RNP

Binaries that will be installed:

  • rnp

  • rnpkeys

For cross-compiling librnp to a target architecture (OpenHarmony, Android, MinGW, ARM Linux, etc.), see Cross-compiling librnp.

On NixOS or Nix package manager

We provide a Nix package for easy installation on NixOS and any OS with Nix installed (including Linux and macOS, even NixOS on WSL).

nix-env -iA nixpkgs.rnp

With Nix Flakes

We provide a Nix flake.

nix profile install github:rnpgp/rnp

On macOS using Homebrew

We provide a Homebrew tap for easy installation of RNP on macOS.

brew tap rnpgp/rnp
brew install rnp

On RHEL and CentOS via YUM

We provide pre-built packages for RHEL and CentOS at our YUM repository hosted at GitHub.

rpm --import https://github.com/riboseinc/yum/raw/master/ribose-packages.pub
rpm --import https://github.com/riboseinc/yum/raw/master/ribose-packages-next.pub
curl -L https://github.com/riboseinc/yum/raw/master/ribose.repo > /etc/yum.repos.d/ribose.repo
yum install -y rnp

On Ubuntu

Prerequisites: please ensure git is installed on the system

# Clone the repository by version tag (or omit it to get the latest sources)
git clone https://github.com/rnpgp/rnp.git -b v0.18.1

Please ensure that you clone with submodules if you use a version higher then 0.16.2
git clone https://github.com/rnpgp/rnp.git --recurse-submodules --shallow-submodules

# Install required packages
sudo apt install g++-8 cmake libbz2-dev zlib1g-dev build-essential python-minimal

# Download, build and install Botan2
wget -qO- https://botan.randombit.net/releases/Botan-3.10.0.tar.xz | tar xvJ
cd Botan-3.10.0
./configure.py --prefix=/usr
make
sudo make install
cd ..

# CMake encourages building outside of the source directory.
mkdir rnp-build
cd rnp-build

# Run CMake
cmake -DCMAKE_INSTALL_PREFIX=/usr -DBUILD_SHARED_LIBS=on -DBUILD_TESTING=off ../rnp/

# Compile
make

# Install
sudo make install

On Debian

Prerequisite: please ensure git is installed on the system.

# Clone the repository by version tag (or omit it to get the latest sources)
git clone https://github.com/rnpgp/rnp.git -b v0.18.1

Please ensure that you clone with submodules if you use a version higher then 0.16.2
git clone https://github.com/rnpgp/rnp.git --recurse-submodules --shallow-submodules

# Enable access to `testing` packages by editing /etc/apt/sources.list
# deb http://deb.debian.org/debian testing main

# Install required packages
sudo apt install g++-8 cmake libbz2-dev zlib1g-dev \
  libbotan-2-dev build-essential

# Cmake recommend out-of-source builds
mkdir rnp-build
cd rnp-build

# Cmake it
cmake -DCMAKE_INSTALL_PREFIX=/usr -DBUILD_SHARED_LIBS=on -DBUILD_TESTING=off ../rnp/

# Compile and install
sudo make install

On Gentoo Linux

RNP is present in the official Gentoo repository under the name dev-util/librnp.

emerge -av dev-util/librnp

Compile from source

Clone this repo, or download a release and expand it.

Enter the source folder and run the following commands:

cmake -DCMAKE_INSTALL_PREFIX=/usr/local -DBUILD_SHARED_LIBS=on -DBUILD_TESTING=off  .

make install
Note

When building against the Botan backend, avoid Botan 3.6.x on arm64: it has an upstream crash in the EC path (SIGBUS inside Botan::BigInt::is_equal) that breaks ordinary ECDSA/ECDH, and 3.6.0 additionally signs SLH-DSA with the wrong (non-FIPS-compliant) deterministic variant. Botan 3.7.0 or newer is required for PQC (-DENABLE_PQC=on) and recommended everywhere on arm64. Botan 3.0 - 3.5 works fine with PQC left off (the default).

On Windows

Using MSYS/MinGW

From a clean MSYS2 install, please first update pacman and install required packages via the msys console.

pacman -Syu --noconfirm --needed

# Most likely you'll need to close msys console and run it again:
pacman -Syu --noconfirm --needed

# Install packages
pacman --noconfirm -S --needed tar zlib-devel libbz2-devel git automake autoconf libtool automake-wrapper make pkg-config mingw64/mingw-w64-x86_64-cmake mingw64/mingw-w64-x86_64-gcc mingw64/mingw-w64-x86_64-libbotan mingw64/mingw-w64-x86_64-python3

Then clone the RNP repository and build it.

Please ensure that you clone with submodules if you use a version higher then 0.16.2 git clone https://github.com/rnpgp/rnp.git --recurse-submodules --shallow-submodules

# CMake encourages building outside of the source directory.
mkdir rnp-build
cd rnp-build

# Add paths to PATH so dependency dll/lib files can be found
export PATH="/c/msys64/mingw64/lib:/c/msys64/mingw64/bin:$PWD/bin:$PATH"

# Run CMake
cmake -DBUILD_SHARED_LIBS=yes -G "MSYS Makefiles" -DBUILD_TESTING=off ../rnp

# Compile and install
make && make install

Using Microsoft Visual Studio 2019 and vcpkg

Use appropriate command prompt for your target platform, for example "x64 Native Tools Command Prompt for VS 2019"

cmd /k "C:\Program Files (x86)\Microsoft Visual Studio\2019\BuildTools\VC\Auxiliary\Build\vcvars64.bat"

Install vcpkg according to these instructions:

Set the VCPKG_ROOT environment variable to the vcpkg root folder.

For botan backend:

vcpkg install --triplet x64-windows bzip2 zlib botan getopt dirent python3[core,enable-shared]

For openssl backend:

vcpkg install --triplet x64-windows bzip2 zlib botan getopt dirent python3[core,enable-shared]

If you need to target 32-bit platform you’ll need to to replace x64-windows with x86-windows.

  • The following steps will perform a console build for CMake using Visual Studio 2019 CMake generator:

    cmake -B build -G "Visual Studio 16 2019" -A x64 -DCMAKE_TOOLCHAIN_FILE=%VCPKG_ROOT%\scripts\buildsystems\vcpkg.cmake \
      -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTING=off -DCRYPTO_BACKEND="botan" .
cmake --build build --config Release
cmake --install build

    Replace CRYPTO_BACKEND parameter to "openssl" if you target this backend.

Ensure that the following dependencies are available on path:

  • librnp.dll

  • botan.dll or libcrypto.dll depending on target backend and architecture

  • bz2.dll

  • getopt.dll

  • zlib1.dll

Using Microsoft Visual Studio 2019 and pre-installed libraries

Use appropriate command prompt for your target platform, for example "x64 Native Tools Command Prompt for VS 2019"

cmd /k "C:\Program Files (x86)\Microsoft Visual Studio\2019\BuildTools\VC\Auxiliary\Build\vcvars64.bat"

Install dependencies and make them available either on PATH or using CMAKE_TARGET_PREFIX parameter:

  • Botan(2.14+) or Crypto (OpenSSL 1.1.1+) depending on target backend

  • BZip2 (optional, may be disabled with -DENABLE_BZIP2=Off)

  • GetOpt

  • ZLIB

If openssl backend is used note that your environment may have another ("default") openssl installation. In such case use OPENSSL_ROOT_DIR.

  • The following steps will perform a console build for CMake using Visual Studio 2019 CMake generator:

    cmake -B build -G "Visual Studio 16 2019" -A x64 -DOPENSSL_ROOT_DIR=<openssl root> -DCMAKE_TARGET_PREFIX=<target prefix> \
      -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTING=off -DCRYPTO_BACKEND="botan" .
cmake --build build --config Release
cmake --install build

    Replace CRYPTO_BACKEND parameter to "openssl" if you target this backend, use OPENSSL_ROOT_DIR and CMAKE_TARGET_PREFIX optionally as explained above