OQS-bind with Falcon, MAYO and SQISign support, packaged in a container

This repository contains the scripts to build a container with SIDN Labs' OQS-bind, which is a fork of deSEC's and Jason Goertzen's OQS-bind. Our fork supports the Falcon-512, MAYO-2 and SQISign-1 post-quantum algorithms.

Building the image

To build the image, run this (simplified) command:

podman build -f Dockerfile --tag=pqc-bind-oqs:latest

The tag is an example, just make sure you can find the image again for running the image as container.

Building for distribution

Be sure to use the correct bind-oqs version and check the patches/ directory for the corresponding patch.

To build the image for distribution, run the following commands:

podman build --platform linux/amd64,linux/arm64 -f Dockerfile --tag=pqc-bind-oqs:latest
# podman push

To distribute this container to Github, we do the following steps. First, Obtain a personal access token

export CR_PAT=YOUR_TOKEN

And login to Github using this token

echo $CR_PAT | podman login ghcr.io -u USERNAME --password-stdin
> Login Succeeded

Then, create a manifest, build the container, and push it, as in the example below. We build on separate machines for different architectures.

## ARM64 machine 1
# Build the image attaching them to the manifest
podman build --jobs=4 --platform linux/arm64 -t ghcr.io/sidn/oqs-bind-container:arm64 .
podman push ghcr.io/sidn/oqs-bind-container:arm64


## AMD64 machine 2
# Build the image attaching them to the manifest
podman build --jobs=4 --platform linux/amd64 -t ghcr.io/sidn/oqs-bind-container:amd64 .
podman push ghcr.io/sidn/oqs-bind-container:amd64

Then on some machine:

# First, initialise the manifest
podman manifest create ghcr.io/sidn/oqs-bind-container:v2

# Add individual builds
podman manifest add ghcr.io/sidn/oqs-bind-container:v2 ghcr.io/sidn/oqs-bind-container:amd64
podman manifest add ghcr.io/sidn/oqs-bind-container:v2 ghcr.io/sidn/oqs-bind-container:arm64
# Merge all files
podman manifest push ghcr.io/sidn/oqs-bind-container:v2
podman manifest push ghcr.io/sidn/oqs-bind-container:v2 ghcr.io/sidn/oqs-bind-container:latest

Please note that we had difficulties building images for other platforms. We obtained the best results by building ARM64 images on ARM platforms, and AMD64 on AMD64 platforms, after which we publish them.