QUICKSTART-BUILD.md

Building this quickstart manually

The QryptSecurity SDK is intended to be run on an Ubuntu 22.04 system with an amd64 architecture, either natively or using an emulated platform.

Docker Container Build

A standardized Dockerfile is provided in ./devcontainer that installs dependencies and builds the quickstarts.

If a VSCode editor is being used, the containerized environment can be created using the "Dev Containers" extension.

Without VSCode, create the Docker container manually:

1. docker image build -t qrypt-quickstarts ./.devcontainer
2. docker container run -d --name qrypt-quickstarts qrypt-quickstarts tail -f /dev/null
3. docker exec -it qrypt-quickstarts /bin/bash
4. git clone https://github.com/QryptInc/qrypt-security-quickstarts-cpp.git
5. cd qrypt-security-quickstarts-cpp
6. ./.devcontainer/setup.sh
7. ./qrypt --help

Manual Build

The following commands assume an Ubuntu 22.04 system with an amd64 architecture configured with OpenSSL, CURL, CMake, and g++.

Prerequisites:

1. Install the recommended packages: apt-get -y install git cmake gcc g++ xxd libssl-dev libgtest-dev libcurl4-openssl-dev openssh-server ufw sshpass curl jq
2. Clone the quickstarts repo.

Steps:

1. Create a Qrypt account for free.
2. On the Qrypt portal, download the Qrypt SDK from "Products > Qrypt SDK" and save the .tgz to the repository root.
3. (Optional) On the Qrypt portal, register a personal access token for keygen.
4. tar -zxvf qrypt-security-0.11.23-ubuntu.tgz --strip-components=1 -C QryptSecurity
5. cmake . -B build
6. cmake --build build
7. ./qrypt --help

Testing

If googletest is installed on your system, you may add -DENABLE_TESTS=ON to your cmake command to enable an automated validation suite which can be run with ./qrypt test:

1. cmake -B build -DCMAKE_BUILD_TYPE=Release -DENABLE_TESTS=ON
2. cmake --build build --config Release