Merge pull request #4511 from esl/bundle-openssl-for-older-systems

Bundle OpenSSL 3.x with packages for older systems

Author: chrzaszcz

doc/getting-started/Installation.md

@@ -25,17 +25,23 @@ The following sections describe the installation process for different operating
 === "CentOS compatible: AlmaLinux / Rocky Linux"
 
     An ODBC (RDBMS) driver must be installed on your machine to unpack and install from RPM packages. Enter the following command in a terminal window to install the latest unixODBC driver:
-    
+
     ```bash
     sudo yum install unixODBC
     ```
-    
+
     Once the RPM file is downloaded, open a terminal window and navigate to the directory containing the package. Use the following command to unpack and install MongooseIM:
-    
+
     ```bash
     sudo rpm -i mongooseim_[version here].rpm
     ```
 
+!!! info
+    Packages for older systems (Ubuntu Focal, Debian Bullseye, Debian Buster, AlmaLinux 8, Rocky Linux 8)
+    include a bundled OpenSSL 3.x, as this version is required for MongooseIM to function correctly,
+    but is not available in the official repositories for these distributions.
+    If your system already has OpenSSL 3.x installed, the package will detect and use the system version instead of the bundled one.
+
 ## Docker
 
 In order to install MongooseIM using Docker, simply run the following command:

tools/pkg/scripts/deb/build_package.sh

@@ -16,6 +16,26 @@ apt-get update
 
 rm -rf /usr/lib/erlang/man/man3/cerff.3.gz /usr/lib/erlang/man/man3/cerfl.3.gz /usr/lib/erlang/man/man3/cerfcl.3.gz /usr/lib/erlang/man/man3/cerfcf.3.gz /usr/lib/erlang/man/man3/cerfcf.3.gz /usr/lib/erlang/man/man1/x86_64-linux-gnu-gcov-tool.1.gz  /usr/lib/erlang/man/man1/ocamlbuild.native.1.gz  /usr/lib/erlang/man/man1/gcov-tool.1.gz /usr/lib/erlang/man/man1/ocamlbuild.byte.1.gz
 
+OS_ID=$(grep ^ID= /etc/os-release | cut -d= -f2 | tr -d '"')
+OS_VERSION=$(grep ^VERSION_ID= /etc/os-release | cut -d= -f2 | tr -d '"' | cut -d. -f1)
+if { [ "$OS_ID" = "ubuntu" ] && [ "$OS_VERSION" -lt 22 ]; } || \
+   { [ "$OS_ID" = "debian" ] && [ "$OS_VERSION" -lt 12 ]; }; then
+    export CFLAGS="-I/usr/local/ssl/include"
+
+    # Copy essential OpenSSL 3.x runtime files to bundle with the app
+    mkdir -p mongooseim/opt/mongooseim/openssl/etc
+    mkdir -p mongooseim/opt/mongooseim/openssl/include
+    cp -a /usr/local/ssl/include/openssl mongooseim/opt/mongooseim/openssl/include/
+
+    if [ -d /usr/local/ssl/lib64 ]; then
+        export LDFLAGS="-L/usr/local/ssl/lib64"
+        cp -a /usr/local/ssl/lib64 mongooseim/opt/mongooseim/openssl/
+    else
+        export LDFLAGS="-L/usr/local/ssl/lib"
+        cp -a /usr/local/ssl/lib mongooseim/opt/mongooseim/openssl/
+    fi
+fi
+
 make clean
 sed -i '1 s/^.*$/\#\!\/bin\/bash/' tools/install
 ./tools/configure with-all user=mongooseim prefix="" system=yes

tools/pkg/scripts/deb/debian/postinst

@@ -36,6 +36,21 @@ setup()
 		chown -R $NAME:$NAME $PKG_ROOT $MIM_CTL $ETC_DIR $VAR_LIB $VAR_LOCK $VAR_LOG
 	fi
 	#sed -i -e "s*\(RUNNER_SCRIPT_DIR=\).\**\1${PKG_ROOT}bin*" /usr/sbin/mongooseimctl
+
+    OS_ID=$(grep ^ID= /etc/os-release | cut -d= -f2 | tr -d '"')
+    OS_VERSION=$(grep ^VERSION_ID= /etc/os-release | cut -d= -f2 | tr -d '"' | cut -d. -f1)
+    if { [ "$OS_ID" = "ubuntu" ] && [ "$OS_VERSION" -lt 22 ]; } || \
+       { [ "$OS_ID" = "debian" ] && [ "$OS_VERSION" -lt 12 ]; }; then
+        SYSTEM_OPENSSL=$(ldconfig -p | grep "libssl.so.3" | awk '{print $NF}' | head -n 1)
+        if [ -z "$SYSTEM_OPENSSL" ]; then
+                if [ -d /opt/mongooseim/openssl/lib64 ]; then
+                    echo "/opt/mongooseim/openssl/lib64" > /etc/ld.so.conf.d/mongooseim-openssl.conf
+                else
+                    echo "/opt/mongooseim/openssl/lib" > /etc/ld.so.conf.d/mongooseim-openssl.conf
+                fi
+            ldconfig
+        fi
+    fi
 }
 
 case "$1" in

tools/pkg/scripts/rpm/build_package.sh

@@ -20,10 +20,27 @@ case "$arch" in
     ;;
 esac
 
+OS_ID=$(grep ^ID= /etc/os-release | cut -d= -f2 | tr -d '"')
+OS_VERSION=$(grep ^VERSION_ID= /etc/os-release | cut -d= -f2 | tr -d '"' | cut -d. -f1)
+if { [ "$OS_ID" = "rocky" ] && [ "$OS_VERSION" -lt 9 ]; } || \
+   { [ "$OS_ID" = "almalinux" ] && [ "$OS_VERSION" -lt 9 ]; }; then
+    if [ -d /usr/local/ssl/lib64 ]; then
+        export LDFLAGS="-L/usr/local/ssl/lib64"
+    else
+        export LDFLAGS="-L/usr/local/ssl/lib"
+    fi
+    export CFLAGS="-I/usr/local/ssl/include"
+
+    bundle_openssl=1
+else
+    bundle_openssl=0
+fi
+
 rpmbuild -bb \
     --define "version ${version}" \
     --define "release ${revision}" \
     --define "architecture ${arch}" \
+    --define "with_bundled_openssl ${bundle_openssl}" \
     ~/rpmbuild/SPECS/mongooseim.spec
 
 source /etc/os-release

tools/pkg/scripts/rpm/mongooseim.spec

@@ -36,6 +36,18 @@ scale in need of more capacity (by just adding a box/VM).
 cp %{SOURCE0} .
 
 %install
+%if %{with_bundled_openssl}
+# Copy essential OpenSSL 3.x runtime files to bundle with the app
+mkdir -p %{buildroot}/opt/mongooseim/openssl/etc
+mkdir -p %{buildroot}/opt/mongooseim/openssl/include
+cp -a /usr/local/ssl/include/openssl %{buildroot}/opt/mongooseim/openssl/include/
+if [ -d /usr/local/ssl/lib64 ]; then
+    cp -a /usr/local/ssl/lib64 %{buildroot}/opt/mongooseim/openssl/
+else
+    cp -a /usr/local/ssl/lib %{buildroot}/opt/mongooseim/openssl/
+fi
+%endif
+
 make clean
 ./tools/configure with-all user=root prefix=/ system=yes
 sed -i 's#PREFIX=\"/\"#PREFIX=\"%{buildroot}\"#' configure.out
@@ -58,12 +70,32 @@ getent passwd mongooseim >/dev/null || adduser -g mongooseim mongooseim
 exit 0
 
 %post
+%if %{with_bundled_openssl}
+SYSTEM_OPENSSL=$(ldconfig -p | grep "libssl.so.3" | awk '{print $NF}' | head -n 1)
+if [ -z "$SYSTEM_OPENSSL" ]; then
+    if [ -d /opt/mongooseim/openssl/lib64 ]; then
+        echo "/opt/mongooseim/openssl/lib64" > /etc/ld.so.conf.d/mongooseim-openssl.conf
+    else
+        echo "/opt/mongooseim/openssl/lib" > /etc/ld.so.conf.d/mongooseim-openssl.conf
+    fi
+    ldconfig
+fi
+%endif
 echo "MongooseIM %{version} installed"
 
 %clean
 rm -rf %{buildroot}
 
 %files
+%if %{with_bundled_openssl}
+%ifarch x86_64
+/opt/mongooseim/openssl/lib64/
+%endif
+%ifarch aarch64
+/opt/mongooseim/openssl/lib/
+%endif
+/opt/mongooseim/openssl/include/openssl/
+%endif
 
 %defattr(-, root, root, -)