Merge pull request #6690 from julek-wolfssl/packaging

Init deb packaging

Author: JacobBarthelmeh

.github/workflows/main.yml

@@ -36,6 +36,8 @@ jobs:
         uses: ./.github/workflows/curl.yml
     krb5:
         uses: ./.github/workflows/krb5.yml
+    packaging:
+        uses: ./.github/workflows/packaging.yml
 # TODO: Currently this test fails. Enable it once it becomes passing.        
 #    haproxy:
 #        uses: ./.github/workflows/haproxy.yml

.github/workflows/os-check.yml

@@ -23,7 +23,7 @@ jobs:
     name: make check
     runs-on: ${{ matrix.os }}
     # This should be a safe limit for the tests to run.
-    timeout-minutes: 8
+    timeout-minutes: 14
     steps:
       - name: Build and test wolfSSL
         uses: wolfSSL/actions-build-autotools-project@v1
@@ -43,7 +43,7 @@ jobs:
     name: make user_setting.h
     runs-on: ${{ matrix.os }}
     # This should be a safe limit for the tests to run.
-    timeout-minutes: 8
+    timeout-minutes: 14
     steps:
       - name: Build and test wolfSSL
         uses: wolfSSL/actions-build-autotools-project@v1
@@ -66,7 +66,7 @@ jobs:
     name: make user_setting.h (testwolfcrypt only)
     runs-on: ${{ matrix.os }}
     # This should be a safe limit for the tests to run.
-    timeout-minutes: 8
+    timeout-minutes: 14
     steps:
       - name: Build and test wolfSSL
         uses: wolfSSL/actions-build-autotools-project@v1
@@ -87,7 +87,7 @@ jobs:
     name: make user_setting.h (with sed)
     runs-on: ${{ matrix.os }}
     # This should be a safe limit for the tests to run.
-    timeout-minutes: 8
+    timeout-minutes: 14
     steps:
     - uses: actions/checkout@v3
     - if: ${{ matrix.os == 'macos-latest' }}

.github/workflows/packaging.yml

@@ -0,0 +1,38 @@
+name: Packaging Tests
+
+on:
+  workflow_call:
+
+jobs:
+  build_wolfssl:
+    name: Package wolfSSL
+    runs-on: ubuntu-latest
+    # This should be a safe limit for the tests to run.
+    timeout-minutes: 10
+    steps:
+      - name: Checkout wolfSSL
+        uses: actions/checkout@v3
+
+      - name: Configure wolfSSL
+        run: |
+          autoreconf -ivf
+          ./configure --enable-distro --disable-examples --disable-silent-rules
+
+      - name: Build wolfSSL .deb
+        run: make deb-docker
+
+      - name: Build wolfSSL .rpm
+        run: make rpm-docker
+
+      - name: Confirm packages built
+        run: |
+          DEB_COUNT=$(find -name 'libwolfssl*.deb' | wc -l)
+          if [ "$DEB_COUNT" != "2" ]; then
+            echo Did not find exactly two deb packages!!!
+            exit 1
+          fi
+          RPM_COUNT=$(find -name 'wolfssl*.rpm' | wc -l)
+          if [ "$RPM_COUNT" != "4" ]; then
+            echo Did not find exactly four rpm packages!!!
+            exit 1
+          fi

.gitignore

@@ -424,3 +424,8 @@ user_settings_asm.h
 
 # MagicCrypto (ARIA Cipher)
 MagicCrypto
+
+# debian packaging
+debian/changelog
+debian/control
+*.deb

Docker/packaging/debian/Dockerfile

@@ -0,0 +1,6 @@
+FROM debian:latest
+
+RUN apt-get -y update
+RUN apt-get -y upgrade
+RUN apt-get install -y build-essential autoconf gawk debhelper lintian
+

Docker/packaging/fedora/Dockerfile

@@ -0,0 +1,3 @@
+FROM fedora:latest
+
+RUN dnf install -y make automake gcc rpmdevtools

INSTALL

@@ -309,3 +309,22 @@ We also have vcpkg ports for wolftpm, wolfmqtt and curl.
 
     Run the benchmark against LMS/HSS with:
     $ ./wolfcrypt/benchmark/benchmark -lms_hss
+
+18. Building for Debian, Ubuntu, Linux Mint, and derivatives
+
+    To generate a .deb package, configure wolfSSL with the desired
+    configuration. Then run `make deb` to generate a Debian package
+    with the current configuration. To build the package inside a
+    Docker container, use `make deb-docker`. In both cases the
+    resulting packages are placed in the root directory of the
+    project.
+
+18. Building for RHEL, Fedora, CentOS, SUSE, and openSUSE
+
+    To generate a .rpm package, configure wolfSSL with the desired
+    configuration. Then run `make rpm` to generate a .rpm package
+    with the current configuration. To build the package inside a
+    Docker container, use `make rpm-docker`. In both cases the
+    resulting packages are placed in the root directory of the
+    project.
+

Makefile.am

@@ -176,6 +176,7 @@ include examples/include.am
 include testsuite/include.am
 include tests/include.am
 include sslSniffer/sslSnifferTest/include.am
+include debian/include.am
 include rpm/include.am
 include linuxkm/include.am
 include zephyr/include.am

README

@@ -5,7 +5,7 @@ library written in ANSI C and targeted for embedded, RTOS, and
 resource-constrained environments - primarily because of its small size, speed,
 and feature set.  It is commonly used in standard operating environments as well
 because of its royalty-free pricing and excellent cross platform support.
-wolfSSL supports industry standards up to the current TLS 1.3 and DTLS 1.2
+wolfSSL supports industry standards up to the current TLS 1.3 and DTLS 1.3
 levels, is up to 20 times smaller than OpenSSL, and offers progressive ciphers
 such as ChaCha20, Curve25519, and Blake2b. User benchmarking and feedback
 reports dramatically better performance when using wolfSSL over OpenSSL.

configure.ac

@@ -71,6 +71,9 @@ AS_IF([ test -n "$CFLAG_VISIBILITY" ], [
        AM_CFLAGS="$AM_CFLAGS $CFLAG_VISIBILITY"
        ])
 
+WOLFSSL_BUILD_DATE=$(date -R)
+AC_SUBST([WOLFSSL_BUILD_DATE])
+
 
 # Moved these size of and type checks before the library checks.
 # The library checks add the library to subsequent test compiles
@@ -9048,6 +9051,8 @@ AC_CONFIG_FILES([Makefile
         wolfssl/version.h
         wolfssl/options.h
         support/wolfssl.pc
+        debian/control
+        debian/changelog
         rpm/spec
         wolfcrypt/test/test_paths.h
         ])