OpenSSL usage in GitHub artifacts fixed (#1883)

Author: Paulchen-Panther

.github/workflows/windows.yml

@@ -74,12 +74,28 @@ jobs:
 
       - name: 📥 Install latest CMake and Ninja
         uses: lukka/get-cmake@latest
+        with:
+          cmakeVersion: latestrc
+          ninjaVersion: latest
 
       - name: 🛠️ Setup MSVC
         uses: ilammy/msvc-dev-cmd@v1
         with:
           arch: ${{ matrix.os.architecture }}
 
+      - name: 💾 Download OpenSSL 3.x
+        uses: ethanjli/[email protected]
+        with:
+          url: "https://slproweb.com/download/Win64${{ matrix.os.architecture == 'arm64' && 'ARM' || '' }}OpenSSL-3_5_0.exe"
+          destination: .\installer\openssl.exe
+          cache-key: OpenSSL
+
+      - name: 📥 Install OpenSSL 3.x
+        shell: powershell
+        run: |
+          Start-Process -FilePath ".\installer\openssl.exe" -ArgumentList "/silent", "/verysilent", "/sp-", "/suppressmsgboxes", "/DIR=C:\OpenSSL" -Wait
+          echo "OPENSSL_ROOT_DIR=C:\OpenSSL" >> $env:GITHUB_ENV
+
       - name: 💾 Download Pre-Build Dependencies
         id: dependencies
         uses: ./.github/actions/download-pre-built-deps

.version

@@ -1 +1 @@
-2.1.1
+2.1.2-beta.1

cmake/linux/BundleLinux.cmake.in

@@ -1,6 +1,7 @@
 set(PROJECT_NAME "@PROJECT_NAME@")
 set(QMAKE_EXECUTABLE "@QMAKE_EXECUTABLE@")
 set(OPENSSL_FOUND @OPENSSL_FOUND@)
+set(OPENSSL_LIBRARIES "@OPENSSL_LIBRARIES@")
 set(PYTHON_MODULES_DIR "@PYTHON_MODULES_DIR@")
 set(PYTHON_VERSION "@PYTHON_VERSION@")
 set(CMAKE_BINARY_DIR "@CMAKE_BINARY_DIR@")
@@ -54,6 +55,15 @@ foreach(PLUGIN "platforms" "sqldrivers" "imageformats" "tls" "wayland-shell-inte
 	endif()
 endforeach()
 
+# Append the OpenSSL library to the list
+if(OPENSSL_FOUND AND NOT OPENSSL_LIBRARIES STREQUAL "")
+	foreach(openssl_lib ${OPENSSL_LIBRARIES})
+		collect_dependencies(${openssl_lib} PREREQUISITE_LIBS)
+		gp_append_unique(PREREQUISITE_LIBS ${openssl_lib})
+		get_filename_component(file_canonical ${openssl_lib} REALPATH)
+		gp_append_unique(PREREQUISITE_LIBS ${file_canonical})
+	endforeach()
+endif()
 
 # Copy dependencies to 'share/hyperion/lib'
 file(INSTALL FILES ${PREREQUISITE_LIBS} DESTINATION "${CMAKE_INSTALL_PREFIX}/share/hyperion/lib")

cmake/windows/BundleWindows.cmake.in

@@ -60,6 +60,49 @@ if(EXISTS @CMAKE_BINARY_DIR@/bin/@PROJECT_NAME@@CMAKE_EXECUTABLE_SUFFIX@)
 		list(REMOVE_AT DEPENDENCIES 0 1)
 	endwhile()
 
+	# Copy libssl/libcrypto to 'hyperion'
+	if(OPENSSL_FOUND)
+		string(REGEX MATCHALL "[0-9]+" openssl_versions "@OPENSSL_VERSION@")
+		list(GET openssl_versions 0 openssl_version_major)
+		list(GET openssl_versions 1 openssl_version_minor)
+
+		set(open_ssl_version_suffix)
+		if(openssl_version_major VERSION_EQUAL 1 AND openssl_version_minor VERSION_EQUAL 1)
+			set(open_ssl_version_suffix "-1_1")
+		else()
+			set(open_ssl_version_suffix "-3")
+		endif()
+
+		if("@CMAKE_SYSTEM_PROCESSOR@" MATCHES "aarch64|ARM64|arm64")
+			string(APPEND open_ssl_version_suffix "-arm64")
+		elseif(@CMAKE_SIZEOF_VOID_P@ EQUAL 8)
+			string(APPEND open_ssl_version_suffix "-x64")
+		endif()
+
+		foreach(comp "ssl" "crypto")
+			find_file(lib${comp}
+				NAMES
+					"lib${comp}${open_ssl_version_suffix}.dll"
+				PATHS
+					"@_OPENSSL_ROOT_PATHS@"
+				HINTS
+					"@OPENSSL_ROOT_DIR@"
+					$ENV{OPENSSL_ROOT_DIR}
+				PATH_SUFFIXES
+					bin
+			)
+
+			if(lib${comp})
+				file(INSTALL
+					FILES
+						${lib${comp}}
+					DESTINATION
+						"${CMAKE_INSTALL_PREFIX}/bin"
+				)
+			endif()
+		endforeach()
+	endif()
+
 	# Create a qt.conf file in 'bin' to override hard-coded search paths in Qt plugins
 	file(WRITE "${CMAKE_INSTALL_PREFIX}/bin/qt.conf" "[Paths]\nPlugins=../lib/\n")
 
@@ -68,7 +111,12 @@ if(EXISTS @CMAKE_BINARY_DIR@/bin/@PROJECT_NAME@@CMAKE_EXECUTABLE_SUFFIX@)
 		get_filename_component(TURBOJPEG_DIR "${TurboJPEG_INCLUDE_DIR}" DIRECTORY)
 		find_file(TURBOJPEG_SHARED NAMES "turbojpeg.dll" PATHS ${TURBOJPEG_DIR} PATH_SUFFIXES bin)
 		if(TURBOJPEG_SHARED)
-			file(INSTALL FILES ${TURBOJPEG_SHARED} DESTINATION "${CMAKE_INSTALL_PREFIX}/bin")
+			file(INSTALL
+				FILES
+					${TURBOJPEG_SHARED}
+				DESTINATION
+					"${CMAKE_INSTALL_PREFIX}/bin"
+			)
 		endif()
 	endif()
 

doc/development/CompileHowto.md

@@ -61,14 +61,14 @@ cd $HYPERION_HOME
 
 ```console
 sudo apt-get update
-sudo apt-get install git cmake build-essential qtbase5-dev libqt5serialport5-dev libqt5websockets5-dev libqt5sql5-sqlite libqt5svg5-dev libqt5x11extras5-dev libusb-1.0-0-dev python3-dev libasound2-dev libturbojpeg0-dev libjpeg-dev libssl-dev libftdi1-dev
+sudo apt-get install git cmake build-essential ninja-build qtbase5-dev libqt5serialport5-dev libqt5websockets5-dev libqt5sql5-sqlite libqt5svg5-dev libqt5x11extras5-dev libusb-1.0-0-dev python3-dev libasound2-dev libturbojpeg0-dev libjpeg-dev libssl-dev libftdi1-dev
 ```
 
 **Ubuntu (22.04+) - Qt6 based**
 
 ```console
 sudo apt-get update
-sudo apt-get install git cmake build-essential qt6-base-dev libqt6serialport6-dev libqt6websockets6-dev libxkbcommon-dev libvulkan-dev libgl1-mesa-dev libusb-1.0-0-dev python3-dev libasound2-dev libturbojpeg0-dev libjpeg-dev libssl-dev pkg-config libftdi1-dev
+sudo apt-get install git cmake build-essential ninja-build qt6-base-dev libqt6serialport6-dev libqt6websockets6-dev libxkbcommon-dev libvulkan-dev libgl1-mesa-dev libusb-1.0-0-dev python3-dev libasound2-dev libturbojpeg0-dev libjpeg-dev libssl-dev pkg-config libftdi1-dev
 ```
 
 **For Linux X11/XCB grabber support**
@@ -110,43 +110,51 @@ See [AUR](https://aur.archlinux.org/packages/?O=0&SeB=nd&K=hyperion&outdated=&SB
 The following dependencies are needed to build hyperion.ng on fedora.
 ```console
 sudo dnf -y groupinstall "Development Tools"
-sudo dnf install python3-devel qt-devel qt6-qtbase-devel qt6-qtserialport-devel qt6-qtwebsockets-devel xrandr xcb-util-image-devel qt5-qtx11extras-devel alsa-lib-devel turbojpeg-devel libusb-devel xcb-util-devel dbus-devel openssl-devel fedora-packager rpmdevtools gcc libcec-devel libftdi1-dev
+sudo dnf install ninja-build python3-devel qt-devel qt6-qtbase-devel qt6-qtserialport-devel qt6-qtwebsockets-devel xrandr xcb-util-image-devel qt5-qtx11extras-devel alsa-lib-devel turbojpeg-devel libusb-devel xcb-util-devel dbus-devel openssl-devel fedora-packager rpmdevtools gcc libcec-devel libftdi1-dev
 ```
 After installing the dependencies, you can continue with the compile instructions later on this page (the more detailed way..).
 
 ## macOS
 To install on OS X you either need [Homebrew](https://brew.sh/) or [Macport](https://www.macports.org/) but Homebrew is the recommended way to install the packages. To use Homebrew, XCode is required as well, use `brew doctor` to check your install.
 
 First you need to install the dependencies for either the QT5 or QT6 build:
-####QT5
+#### QT5
 ```console
-brew install git qt@5 python3 cmake libusb [email protected] libftdi pkg-config
+brew install git qt@5 ninja python3 cmake libusb [email protected] libftdi pkg-config
 ```
-####QT6
+#### QT6
 ```console
-brew install git qt python3 cmake libusb openssl@1.1 libftdi pkg-config
+brew install git qt ninja python3 cmake libusb openssl@3 libftdi pkg-config
 ```
 
 ## Windows
-We assume a 64bit Windows 10. Install the following;
+> [!NOTE]
+> When downloading, please remember whether you have an x64 or an ARM64 architecture.
+
+We assume a 64bit Windows 11. Install the following:
 - [Git](https://git-scm.com/downloads) (Check: Add to PATH)
-- [CMake (Windows win64-x64 installer)](https://cmake.org/download/) (Check: Add to PATH)
+- [CMake (Windows Installer)](https://cmake.org/download/) (Check: Add to PATH)
 - [Visual Studio 2022 Community Edition](https://visualstudio.microsoft.com/downloads/#visual-studio-community-2022)
   - Select 'Desktop development with C++'
-  - On the right, just select `MSVC v143 VS 2022 C++ x64/x86-Buildtools`, `C++ ATL for latest v143 build tools (x86 & x64)` and latest `Windows 10 SDK`. Everything else is not needed.
-- [Win64 OpenSSL v1.1.1w](https://slproweb.com/products/Win32OpenSSL.html) ([direct link](https://slproweb.com/download/Win64OpenSSL-1_1_1w.exe))
-- [Python 3 (Windows x86-64 executable installer)](https://www.python.org/downloads/windows/) (Check: Add to PATH and Debug Symbols)
+  - On the right, just select:
+    - for x64 architecture: `MSVC v143 VS 2022 C++ x64/x86-Buildtools`, `C++ ATL for latest v143 build tools (x86 & x64)`
+    - for ARM64 architecture: `MSVC v143 VS 2022 C++ ARM64/ARM64EC-Buildtools`, `C++ ATL for latest v143 build tools (ARM64/ARM64EC)`
+    - and latest `Windows 11 SDK`.
+  - Everything else is not needed.
+- [Win64 OpenSSL](https://slproweb.com/products/Win32OpenSSL.html)
+  - [x64 direct link](https://slproweb.com/download/Win64OpenSSL-3_5_0.exe)
+  - [ARM64 direct link](https://slproweb.com/download/Win64ARMOpenSSL-3_5_0.exe)
+- [Python 3 Windows installer (64-bit or ARM64)](https://www.python.org/downloads/windows/) (Check: Add to PATH and Debug Symbols)
   - Open a console window and execute `pip install aqtinstall`.
-  - Now we can download Qt to _C:\Qt_ `mkdir c:\Qt && aqt install -O c:\Qt 5.15.2 windows desktop win64_msvc2019_64`
-  - QT6.2 requires the [Vulkan SDK](https://vulkan.lunarg.com/sdk/home) to be installed
+  - Now we can download Qt to _C:\Qt_:
+    - for x64 architecture: `mkdir c:\Qt && aqt install-qt -O c:\Qt windows desktop 6.8.3 win64_msvc2022_64 -m qtserialport qtwebsockets`
+    - for ARM64 architecture: `mkdir c:\Qt && aqt install-qt -O c:\Qt windows_arm64 desktop 6.8.3 win64_msvc2022_arm64 -m qtserialport qtwebsockets`
 - [libjpeg-turbo SDK for Visual C++](https://sourceforge.net/projects/libjpeg-turbo/files/)
   - Download the latest 64bit installer (currently `libjpeg-turbo-3.0.1-vc64.exe`) and install to its default location `C:\libjpeg-turbo64`.
 
 ###  Optional:
-- For DirectX9 grabber:
-  - [DirectX Software Development Kit](https://www.microsoft.com/en-us/download/details.aspx?id=6812) ([direct link](https://download.microsoft.com/download/A/E/7/AE743F1F-632B-4809-87A9-AA1BB3458E31/DXSDK_Jun10.exe))
 - For package creation:
-  - [NSIS 3.x](https://sourceforge.net/projects/nsis/files/NSIS%203/) ([direct link](https://sourceforge.net/projects/nsis/files/latest/download))
+  - [Inno Setup 6.x](https://jrsoftware.org/isinfo.php) ([direct link](https://jrsoftware.org/download.php/is.exe?site=1))
 
 # Compiling and installing Hyperion
 
@@ -165,14 +173,14 @@ git clone --recursive https://github.com/hyperion-project/hyperion.ng.git hyperi
 cd hyperion
 mkdir build
 cd build
-cmake -DCMAKE_BUILD_TYPE=Release ..
-make -j $(nproc)
+cmake -G Ninja -DCMAKE_BUILD_TYPE=Release ..
+cmake --build .
 if this get stucked and dmesg says out of memory try:
-make -j 2
+cmake --build . -j 2
 # optional: install into your system
-sudo make install/strip
+sudo cmake --build . --target install/strip
 # to uninstall (not very well tested, please keep that in mind)
-sudo make uninstall
+sudo cmake --build . --target uninstall
 # ... or run it from compile directory
 bin/hyperiond
 # webui is located on localhost:8090 or 8091
@@ -195,83 +203,54 @@ On Windows MSVC2022 set it via the CMakeSettings.json:
 
 ## The detailed way (with many comments)
 
-**Download:**
- Creates hyperion directory and checkout the code from github
+### 1. Download:
+ Checkout the code from GitHub
 ```console
-export HYPERION_DIR="hyperion"
-git clone --recursive --depth 1 https://github.com/hyperion-project/hyperion.ng.git "$HYPERION_DIR"
+git clone --recursive --depth 1 https://github.com/hyperion-project/hyperion.ng.git hyperion
 ```
 
-**Preparations:**
+### 2. Prepare:
 Change into hyperion folder and create a build folder
 ```console
-cd "$HYPERION_DIR"
+cd hyperion
 mkdir build
 cd build
 ```
 
-**Generate the make files:**
-To generate make files with automatic platform detection and default settings:
-This should fit to *RPI, x86, amlogic/wetek:
-```console
-cmake -DCMAKE_BUILD_TYPE=Release ..
-```
-
-*Developers on x86* linux should use:
-```console
-cmake -DPLATFORM=x11-dev -DCMAKE_BUILD_TYPE=Release ..
-```
-
-To use framebuffer instead of dispmanx (for example on the *cubox-i*):
-```console
-cmake -DENABLE_FB=ON -DCMAKE_BUILD_TYPE=Release ..
-```
+### 3. Configure:
 
-To generate make files on OS X:
+> [!IMPORTANT]
+> **Windows** developers may need to use the "x64" or "AMR64" native build tools. \
+An easy way to do that is to run the shortcut "Native Tools Command
+Prompt" for the architecture/version of Visual Studio that you have installed.
 
-Platform should be auto detected and refer to osx, you can also force osx:
+To generate the configuration files with automatic platform detection and default settings:
+This should fit to **RPI (arm), x64, Windows, macOS**:
 ```console
-cmake -DPLATFORM=osx -DCMAKE_BUILD_TYPE=Release ..
-```
-
-To generate files on Windows (Release+Debug capable):
-
-Platform should be auto detected and refer to windows, you can also force windows:
-
-```posh
-# You might need to setup MSVC env first
-call "C:\Program Files (x86)\Microsoft Visual Studio\2022\BuildTools\VC\Auxiliary\Build\vcvars64.bat"
-cmake -DPLATFORM=windows -G "Visual Studio 17 2022" ..
+cmake -G Ninja -DCMAKE_BUILD_TYPE=Release ..
 ```
 
-**Run make to build Hyperion:**
-The `-j $(nproc)` specifies the amount of CPU cores to use.
+**Developers** should use:
 ```console
-make -j $(nproc)
+cmake -G Ninja -DCMAKE_BUILD_TYPE=Debug ..
 ```
 
-On a mac you can use ``sysctl -n hw.ncpu`` to get the number of available CPU cores to use.
-
+### 4. Make it:
 ```console
-make -j $(sysctl -n hw.ncpu)
+ninja
 ```
 
-On Windows run:
-```posh
-cmake --build . --config Release -- -maxcpucount
-```
-Maintainer: To build installer, install [NSIS](https://nsis.sourceforge.io/Main_Page) and set env `VCINSTALLDIR="C:\Program Files (x86)\Microsoft Visual Studio\2022\BuildTools\VC"`
+### 5. Additionals (Linux)
 
-**Install hyperion into your system:**
-Copy all necessary files to ``/usr/local/share/hyperion``
+**Install hyperion into your system:** \
+Copies all required files to ``/usr/local/share/hyperion``
 ```console
-sudo make install/strip
+sudo cmake --build . --target install/strip
 ```
 
-If you want to install into another location call this before installing
-
+**If you want to install into another location call this before installing:**
 ```console
-cmake -DCMAKE_INSTALL_PREFIX=/home/pi/apps ..
+cmake -G Ninja -DCMAKE_INSTALL_PREFIX=/home/pi/apps ..
 ```
 This will install to ``/home/pi/apps/share/hyperion``
 

libsrc/webserver/CMakeLists.txt

@@ -45,14 +45,6 @@ if(ENABLE_MDNS)
 	target_link_libraries(webserver mdns)
 endif()
 
-find_package(OpenSSL QUIET)
-if(OPENSSL_FOUND AND TARGET OpenSSL::SSL AND TARGET OpenSSL::Crypto)
-	target_link_libraries(webserver
-		OpenSSL::SSL
-		OpenSSL::Crypto
-	)
-endif()
-
 if(NOT CMAKE_VERSION VERSION_LESS "3.15")
 	set_target_properties(webserver PROPERTIES
 		ADDITIONAL_CLEAN_FILES ${CMAKE_BINARY_DIR}/WebConfig.qrc

src/hyperiond/CMakeLists.txt

@@ -57,6 +57,7 @@ add_executable(${PROJECT_NAME} WIN32 MACOSX_BUNDLE
 	${MACOS_BUNDLE_RESOURCE_FILES}
 )
 
+find_package(OpenSSL QUIET)
 find_package(Qt${QT_VERSION_MAJOR} COMPONENTS DBus QUIET)
 target_link_libraries(${PROJECT_NAME}
 	commandline
@@ -214,23 +215,27 @@ if(WIN32 AND NOT DEFINED ENV{GITHUB_ACTIONS})
 			set(open_ssl_version_suffix "-3")
 		endif()
 
-		if(CMAKE_SIZEOF_VOID_P EQUAL 8)
+		if(${CMAKE_SYSTEM_PROCESSOR} MATCHES "aarch64|ARM64|arm64")
+			string(APPEND open_ssl_version_suffix "-arm64")
+		elseif(CMAKE_SIZEOF_VOID_P EQUAL 8)
 			string(APPEND open_ssl_version_suffix "-x64")
 		endif()
 
-		get_filename_component(OPENSSL_DIR "${OPENSSL_INCLUDE_DIR}" DIRECTORY)
 		foreach(comp "ssl" "crypto")
-			find_file(${comp}
+			find_file(lib${comp}
 				NAMES
 					"lib${comp}${open_ssl_version_suffix}.dll"
 				PATHS
-					${OPENSSL_DIR}
+					${_OPENSSL_ROOT_PATHS}
+				HINTS
+					${OPENSSL_ROOT_DIR}
+					$ENV{OPENSSL_ROOT_DIR}
 				PATH_SUFFIXES
 					bin
 			)
 
 			add_custom_command(TARGET ${PROJECT_NAME} POST_BUILD
-				COMMAND ${CMAKE_COMMAND} -E copy ${${comp}} $<TARGET_FILE_DIR:${PROJECT_NAME}>
+				COMMAND ${CMAKE_COMMAND} -E copy ${lib${comp}} $<TARGET_FILE_DIR:${PROJECT_NAME}>
 			)
 		endforeach()
 	endif()