Reproducible Build

Gradle building

Setup instructions for gradle build in docker container.

This is a deterministic build process used to build RSK node JAR file. It provides a way to be reasonable sure that the JAR is built from GitHub RskJ repository. It also makes sure that the same tested dependencies are used and statically built into the executable.

It’s strongly suggested to follow the steps by yourself to avoid any kind of contamination in the process.

Table of Contents

Install Docker

Depending on your OS, you can install Docker following the official Docker guide:

Build Container

Create a Dockerfile to setup the build environment

  • Linux
    FROM ubuntu:16.04
    RUN apt-get update -y && \
      apt-get install -y git curl gnupg-curl openjdk-8-jdk && \
      rm -rf /var/lib/apt/lists/* && \
      apt-get autoremove -y && \
      apt-get clean
    RUN gpg --keyserver https://secchannel.rsk.co/release.asc --recv-keys 1A92D8942171AFA951A857365DECF4415E3B8FA4
    RUN gpg --finger 1A92D8942171AFA951A857365DECF4415E3B8FA4
    RUN git clone --single-branch --depth 1 --branch PAPYRUS-2.2.0 https://github.com/rsksmart/rskj.git /code/rskj
    RUN git clone https://github.com/rsksmart/reproducible-builds 
    RUN CP /Users/{$USER}/reproducible-builds/rskj/2.2.0-papyrus/Dockerfile  /Users/{$USER}/code/rskj
    WORKDIR /code/rskj
    RUN gpg --verify SHA256SUMS.asc
    RUN sha256sum --check SHA256SUMS.asc
    RUN ./configure.sh
    RUN ./gradlew clean build -x test
    
  • Mac OSX
    brew update && \
    brew install git gnupg openjdk@8 && \
      rm -rf /var/lib/apt/lists/* && \
      brew autoremove && \
      brew cleanup
    RUN gpg --keyserver https://secchannel.rsk.co/release.asc --recv-keys 1A92D8942171AFA951A857365DECF4415E3B8FA4
    RUN gpg --finger 1A92D8942171AFA951A857365DECF4415E3B8FA4
    RUN git clone --single-branch --depth 1 --branch PAPYRUS-2.2.0 https://github.com/rsksmart/rskj.git ./code/rskj
    RUN git clone https://github.com/rsksmart/reproducible-builds 
    RUN CP /Users/{$USER}/reproducible-builds/rskj/2.2.0-papyrus/Dockerfile  /Users/{$USER}/code/rskj
    RUN CD /code/rskj
    RUN gpg --verify SHA256SUMS.asc
    RUN sha256sum --check SHA256SUMS.asc
    RUN ./configure.sh
    RUN ./gradlew clean build -x test   
    

If you are not familiar with Docker or the Dockerfile format: what this does is use the Ubuntu 16.04 base image and install git, curl, gnupg-curl and openjdk-8-jdk, required for building RSK node.

Run build

To create a reproducible build, run:

sudo docker build -t rskj-papyrus-2.2.0-reproducible .

This may take several minutes to complete. What is done is:

  • Place in the RSKj repository root because we need Gradle and the project.
  • Runs the secure chain verification process.
  • Compile a reproducible RSKj node.
  • ./gradlew clean build -x test builds without running tests.

To obtain SHA-256 checksums, run the following command:

sudo docker run --rm rskj-papyrus-2.2.0-reproducible sha256sum /code/rskj/rskj-core/build/libs/rskj-core-2.2.0-PAPYRUS-all.jar /code/rskj/rskj-core/build/libs/rskj-core-2.2.0-PAPYRUS-sources.jar /code/rskj/rskj-core/build/libs/rskj-core-2.2.0-PAPYRUS.jar /code/rskj/rskj-core/build/libs/rskj-core-2.2.0-PAPYRUS.pom

Check Results

After running the build process, a JAR file will be created in /code/rskj-core/build/libs/, into the docker container.

You can check the SHA256 sum of the result file and compare it to the one published by RSK for that version.

f7cb1e6c5568332d047c602a5b2c464c41688336b824d92ef3a40b89a8f55b60  rskj-core/build/libs/rskj-core-2.2.0-PAPYRUS-all.jar
751d87b110205357478a9bd7909413bf80afacd51bd10eaa502bec50fda5a410  rskj-core/build/libs/rskj-core-2.2.0-PAPYRUS-sources.jar
d2f6594272748de21f70025e59525f2ffc6159ce21b6751590c3b535953c4d29  rskj-core/build/libs/rskj-core-2.2.0-PAPYRUS.jar
7204272b35891dca1d962af811dec92889d9564e5b200b5a50485101557e2f36  rskj-core/build/libs/rskj-core-2.2.0-PAPYRUS.pom

For SHA256 sum of older versions check the releases page.

If you check inside the JAR file, you will find that the dates of the files are the same as the version commit you are using.