CRYPTO-172: Add support for Linux-riscv64

.github/workflows/maven.yml

@@ -114,3 +114,23 @@ jobs:
         OPENSSL_HOME: "C:\\Miniconda\\Library"
       run: |
         mvn --show-version --batch-mode --no-transfer-progress clean test-compile -Pbenchmark
+
+  build-cross:
+    strategy:
+      matrix:
+        include:
+          - platform: aarch64
+          - platform: riscv64
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+        with:
+          persist-credentials: false
+      - uses: docker/setup-qemu-action@2b82ce82d56a2a04d2637cd93a637ae1b359c0a7 # v2
+        with:
+            platforms: ${{ matrix.platform }}
+      - run: |
+          # Build package
+          docker compose -f src/docker/docker-compose.yaml run crypto src/docker/build.sh
+          # Run on platform
+          docker compose -f src/docker/docker-compose.yaml run crypto-${{ matrix.platform }}-test

Makefile

@@ -120,6 +120,10 @@ linux-armhf:
 linux-aarch64:
 	$(MAKE) native CROSS_PREFIX=aarch64-linux-gnu- OS_NAME=Linux OS_ARCH=aarch64
 
+# for cross-compilation on Ubuntu, install the g++-riscv64-linux-gnu
+linux-riscv64:
+	$(MAKE) native CROSS_PREFIX=riscv64-linux-gnu- OS_NAME=Linux OS_ARCH=riscv64
+
 clean-native-linux32:
 	$(MAKE) clean-native OS_NAME=Linux OS_ARCH=x86
 

Makefile.common

@@ -53,7 +53,7 @@ endif
 
 # os=Default is meant to be generic Unix/Linux
 # The following list must include all OS entries beloe (apart from Default)
-known_os_archs := Linux-x86 Linux-x86_64 Linux-aarch64 Linux-arm Linux-armhf Linux-ppc Linux-ppc64 Mac-x86 Mac-x86_64 Mac-arm64 Mac-aarch64 FreeBSD-x86_64 Windows-x86 Windows-x86_64 SunOS-x86 SunOS-sparc SunOS-x86_64 AIX-ppc64
+known_os_archs := Linux-x86 Linux-x86_64 Linux-aarch64 Linux-arm Linux-armhf Linux-ppc Linux-ppc64 Linux-riscv64 Mac-x86 Mac-x86_64 Mac-arm64 Mac-aarch64 FreeBSD-x86_64 Windows-x86 Windows-x86_64 SunOS-x86 SunOS-sparc SunOS-x86_64 AIX-ppc64
 os_arch := $(OS_NAME)-$(OS_ARCH)
 
 ifeq (,$(findstring $(strip $(os_arch)),$(known_os_archs)))
@@ -190,6 +190,16 @@ Linux-aarch64_LIBNAME   := libcommons-crypto.so
 Linux-aarch64_LIBNAME_OSSL3 := libcommons-crypto-ossl3.so
 Linux-aarch64_COMMONS_CRYPTO_FLAGS  :=
 
+Linux-riscv64_CC        := $(CROSS_PREFIX)gcc
+Linux-riscv64_CXX       := $(CROSS_PREFIX)g++
+Linux-riscv64_STRIP     := $(CROSS_PREFIX)strip
+Linux-riscv64_CXXFLAGS  := -Ilib/inc_linux -I"$(JAVA_HOME)/include" -Ilib/inc_mac -O2 -fPIC -fvisibility=hidden -Wall -Werror
+Linux-riscv64_CFLAGS    := -Ilib/inc_linux -I"$(JAVA_HOME)/include" -Ilib/inc_mac -O2 -fPIC -fvisibility=hidden -Wall -Werror
+Linux-riscv64_LINKFLAGS := -shared -static-libgcc
+Linux-riscv64_LIBNAME   := libcommons-crypto.so
+Linux-riscv64_LIBNAME_OSSL3 := libcommons-crypto-ossl3.so
+Linux-riscv64_COMMONS_CRYPTO_FLAGS  :=
+
 ifndef Mac_INC_OPENSSL
 Mac_INC_OPENSSL   := /usr/local/opt/openssl/include
 endif

RELEASE-NOTES.txt

@@ -197,6 +197,7 @@ Testing:
 - Linux x86_64; OpenSSL 1.1.1; thanks to Alex Remily.
 - Windows 64 (mingw64); OpenSSL 1.1.1d; thanks to Alex Remily.
 - linux-aarch64; OpenSSL 1.0.2k-fips; thanks to Geoffrey Blake.
+- linux-riscv64; OpenSSL 1.1.1f; thanks to Ludovic Henry.
 - debian-arm64; OpenSSL 1.1.1f; thanks to Geoffrey Blake.
 
 Historical list of changes: https://commons.apache.org/proper/commons-crypto/changes-report.html

pom.xml

@@ -133,7 +133,7 @@ The following provides more details on the included cryptographic software:
     <japicmp.skip>false</japicmp.skip>
 
     <commons.release.isDistModule>true</commons.release.isDistModule>
-    <jna.version>5.13.0</jna.version>
+    <jna.version>5.12.0</jna.version>
 
     <!-- The property "target.name" is used to specify the ant target, The "all" target will use
     OsInfo.java to detect the OS info and arch to generate the native binary for detected platform.
@@ -206,6 +206,12 @@ The following provides more details on the included cryptographic software:
         <target.name>linux-aarch64</target.name>
       </properties>
     </profile>
+    <profile>
+      <id>linux-riscv64</id>
+      <properties>
+        <target.name>linux-riscv64</target.name>
+      </properties>
+    </profile>
     <profile>
       <id>jacoco</id>
       <activation>

src/docker/Dockerfile

@@ -23,30 +23,32 @@ ENV JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64
 ENV MAVEN_HOME=/opt/maven
 ENV PATH=${MAVEN_HOME}/bin:${PATH}
 # Install 64-bit dependencies and tooling.
-RUN apt-get update && apt-get --assume-yes install software-properties-common \
+RUN apt-get update && apt-get -y -qq install software-properties-common \
       && add-apt-repository ppa:openjdk-r/ppa && apt-get update \
-      && apt-get --assume-yes install openjdk-8-jdk \
-      && apt-get --assume-yes install build-essential \
-      && apt-get --assume-yes install libssl-dev \
-      && apt-get --assume-yes install gcc-aarch64-linux-gnu \
-      && apt-get --assume-yes install g++-aarch64-linux-gnu \
-      && apt-get --assume-yes install mingw-w64 \
-      && apt-get --assume-yes install wget \
-      && apt-get --assume-yes install dos2unix \
+      && apt-get -y -qq install openjdk-8-jdk \
+                                build-essential \
+                                libssl-dev \
+                                gcc-aarch64-linux-gnu \
+                                g++-aarch64-linux-gnu \
+                                gcc-riscv64-linux-gnu \
+                                g++-riscv64-linux-gnu \
+                                mingw-w64 \
+                                curl \
+                                dos2unix \
 # Bug workaround see https://github.com/docker-library/openjdk/issues/19.
       && /var/lib/dpkg/info/ca-certificates-java.postinst configure
 
 # Install 32-bit dependencies and tooling.
 RUN dpkg --add-architecture i386 && apt-get update \
-      && apt-get --assume-yes install libssl-dev:i386 \
-      && apt-get --assume-yes install gcc-arm-linux-gnueabi \
-      && apt-get --assume-yes install g++-arm-linux-gnueabi \
-      && apt-get --assume-yes install gcc-arm-linux-gnueabihf \
-      && apt-get --assume-yes install g++-arm-linux-gnueabihf
+      && apt-get -y -qq install libssl-dev:i386 \
+                                gcc-arm-linux-gnueabi \
+                                g++-arm-linux-gnueabi \
+                                gcc-arm-linux-gnueabihf \
+                                g++-arm-linux-gnueabihf
 
 # Do this separately to make upgrades easier
-RUN wget https://dlcdn.apache.org/maven/maven-3/3.8.8/binaries/apache-maven-3.8.8-bin.tar.gz \
-&& tar xf apache-maven-*.tar.gz -C /opt && ln -s /opt/apache-maven-3.8.8 /opt/maven
+RUN curl -L https://dlcdn.apache.org/maven/maven-3/3.8.8/binaries/apache-maven-3.8.8-bin.tar.gz \
+      | tar xzf - -C /opt && ln -s /opt/apache-maven-3.8.8 /opt/maven
 
 # Ensure we are in the correct directory (this will be overlaid by the virtual mount)
 WORKDIR /home/crypto

src/docker/Dockerfile.aarch64

@@ -0,0 +1,41 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This file creates a Docker image for use in building various native binaries
+# for Linux 64-bit and 32-bit, and Windows 64-bit and 32-bit.
+# See the README for further details.
+
+FROM ubuntu:20.04
+
+ENV JAVA_HOME=/usr/lib/jvm/java-21-openjdk-arm64
+ENV MAVEN_HOME=/opt/maven
+ENV PATH=${MAVEN_HOME}/bin:${PATH}
+# Install 64-bit dependencies and tooling.
+RUN apt-get update && apt-get -y -qq install software-properties-common \
+      && add-apt-repository ppa:openjdk-r/ppa && apt-get update \
+      && apt-get -y -qq install openjdk-21-jdk \
+                                libssl-dev \
+                                curl \
+# Bug workaround see https://github.com/docker-library/openjdk/issues/19.
+      && /var/lib/dpkg/info/ca-certificates-java.postinst configure
+
+# Do this separately to make upgrades easier
+RUN curl -L https://dlcdn.apache.org/maven/maven-3/3.8.8/binaries/apache-maven-3.8.8-bin.tar.gz \
+        | tar xzf - -C /opt && ln -s /opt/apache-maven-3.8.8 /opt/maven
+
+# Ensure we are in the correct directory (this will be overlaid by the virtual mount)
+WORKDIR /home/crypto
+
+CMD /bin/bash

src/docker/Dockerfile.riscv64

@@ -0,0 +1,41 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This file creates a Docker image for use in building various native binaries
+# for Linux 64-bit and 32-bit, and Windows 64-bit and 32-bit.
+# See the README for further details.
+
+FROM riscv64/ubuntu:20.04
+
+ENV JAVA_HOME=/usr/lib/jvm/java-21-openjdk-riscv64
+ENV MAVEN_HOME=/opt/maven
+ENV PATH=${MAVEN_HOME}/bin:${PATH}
+# Install 64-bit dependencies and tooling.
+RUN apt-get update && apt-get -y -qq install software-properties-common \
+      && add-apt-repository ppa:openjdk-r/ppa && apt-get update \
+      && apt-get -y -qq install openjdk-21-jdk \
+                                libssl-dev \
+                                curl \
+# Bug workaround see https://github.com/docker-library/openjdk/issues/19.
+      && /var/lib/dpkg/info/ca-certificates-java.postinst configure
+
+# Do this separately to make upgrades easier
+RUN curl -L https://dlcdn.apache.org/maven/maven-3/3.8.8/binaries/apache-maven-3.8.8-bin.tar.gz \
+        | tar xzf - -C /opt && ln -s /opt/apache-maven-3.8.8 /opt/maven
+
+# Ensure we are in the correct directory (this will be overlaid by the virtual mount)
+WORKDIR /home/crypto
+
+CMD /bin/bash

src/docker/build.sh

@@ -25,10 +25,11 @@ cd /home/crypto # must agree with virtual mount in docker-compose.yaml
 cp /usr/include/x86_64-linux-gnu/openssl/opensslconf.h /usr/include/openssl
 
 # Run the 64-bit builds.
-mvn -V package -Drat.skip
+mvn -V -B -ntp clean package -Drat.skip
 
 # use process-classes rather than package to speed up builds
 mvn -DskipTests -Drat.skip process-classes -P linux-aarch64
+mvn -DskipTests -Drat.skip process-classes -P linux-riscv64
 mvn -DskipTests -Drat.skip process-classes -P win64
 mvn -DskipTests -Drat.skip process-classes -P linux64
 

src/docker/docker-compose.yaml

@@ -17,8 +17,41 @@ version: '3'
 services:
   crypto:
     image: commons-crypto
-    build: .
+    build:
+      context: .
+      dockerfile: Dockerfile
     # mount the source and Maven repo
     volumes:
       - ../..:/home/crypto
       - ~/.m2/repository:/root/.m2/repository
+
+  crypto-aarch64: &crypto-aarch64
+    image: commons-crypto:aarch64
+    platform: linux/arm64/v8
+    build:
+      context: .
+      dockerfile: Dockerfile.aarch64
+    # mount the source and Maven repo
+    volumes:
+      - ../..:/home/crypto
+      - ~/.m2/repository:/root/.m2/repository
+
+  crypto-aarch64-test:
+    <<: *crypto-aarch64
+    command: bash -xc "mvn -V -B -ntp surefire:test"
+
+  crypto-riscv64: &crypto-riscv64
+    image: commons-crypto:riscv64
+    platform: linux/riscv64
+    build:
+      context: .
+      dockerfile: Dockerfile.riscv64
+    # mount the source and Maven repo
+    volumes:
+      - ../..:/home/crypto
+      - ~/.m2/repository:/root/.m2/repository
+
+  crypto-riscv64-test:
+    <<: *crypto-riscv64
+    command: bash -xc "mvn -V -B -ntp surefire:test"
+

src/site/xdoc/index.xml

@@ -84,6 +84,7 @@ limitations under the License.
       <li>debian-amd64; OpenSSL 1.1.1g</li>
       <li>debian-arm64; OpenSSL 1.1.1f</li>
       <li>linux-aarch64; OpenSSL 1.0.2k-fips</li>
+      <li>linux-riscv64; OpenSSL 1.1.1f</li>
       <li>Linux x86_64; OpenSSL 1.1.1</li>
       <li>Windows 64 (mingw64); OpenSSL 1.1.1d</li>
     </ul>