New upstream version 3.1.1

.github/workflows/cmake.yml

@@ -0,0 +1,82 @@
+---
+name: CMake
+
+# yamllint disable-line rule:truthy
+on:
+  push:
+  pull_request:
+
+env:
+  # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
+  BUILD_TYPE: Release
+
+jobs:
+  build:
+    # The CMake configure and build commands are platform agnostic and should
+    # work equally well on Windows or Mac.  You can convert this to a matrix
+    # build if you need cross-platform coverage.
+    # yamllint disable-line rule:line-length
+    # See: https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        include:
+          - os: ubuntu-latest
+          - os: windows-latest
+          - os: macos-latest
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
+          fetch-depth: 0
+
+      - name: Fix Checkout
+        run: |
+          git fetch --force --tags
+
+      - name: Create Build Environment
+        # Some projects don't allow in-source building, so create a separate
+        # build directory. We'll use this as our working directory for all
+        # subsequent commands
+        run: cmake -E make_directory ${{github.workspace}}/build
+
+      - name: Configure CMake
+        # Use a bash shell so we can use the same syntax for environment
+        # variable access regardless of the host operating system
+        shell: bash
+        working-directory: ${{github.workspace}}/build
+        # Note the current convention is to use the -S and -B options here to
+        # specify source and build directories, but this is only available
+        # with CMake 3.13 and higher. The CMake binaries on the Github Actions
+        # machines are (as of this writing) 3.12
+        run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE
+
+      - name: Build
+        working-directory: ${{github.workspace}}/build
+        shell: bash
+        # Execute the build.  You can specify a specific target
+        # with "--target <NAME>"
+        run: cmake --build . --config $BUILD_TYPE
+
+      - name: Test
+        working-directory: ${{github.workspace}}/build
+        shell: bash
+        # Execute tests defined by the CMake configuration.
+        # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more
+        # detail
+        run: ctest -C $BUILD_TYPE
+
+      - if: ${{ failure() }}
+        name: Upload test data
+        uses: actions/upload-artifact@v2
+        with:
+          name: tests-out
+          path: tests
+
+      - if: ${{ failure() }}
+        name: Upload cmake test output
+        uses: actions/upload-artifact@v2
+        with:
+          name: tests-out
+          path: build/Testing

.github/workflows/debug.yml

@@ -0,0 +1,55 @@
+---
+name: Debug
+
+# yamllint disable-line rule:truthy
+on:
+  workflow_dispatch:
+
+jobs:
+
+  # Oh, github, for a company that is built around the git VCS, how is it
+  # that you have managed to break the repositories so much?
+  #
+  debug_github_repo:
+    name: Debug Github Repo
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Fix Checkout
+        run: |
+          git fetch --force --tags
+
+      - name: Debug data output
+        run: |
+          echo ==========
+          echo git status
+          git status
+          echo ==========
+          echo git tag
+          git tag
+          echo ==========
+          echo git describe
+          git describe || true
+          echo ==========
+          echo git for-each-ref refs/heads
+          git for-each-ref refs/heads
+          echo ==========
+          echo git for-each-ref refs/tags
+          git for-each-ref refs/tags
+          echo ==========
+          echo ls .git/refs/heads
+          ls .git/refs/heads
+          echo ==========
+          echo ls .git/refs/tags
+          ls .git/refs/tags
+          echo ==========
+          TYPE=$(git cat-file -t $GITHUB_REF)
+          echo REF=$GITHUB_REF
+          echo TAGTYPE=$TYPE
+          echo ==========
+          echo git cat-file $TYPE $GITHUB_REF
+          git cat-file $TYPE $GITHUB_REF

.github/workflows/openwrt.yml

@@ -0,0 +1,112 @@
+---
+name: Openwrt Build
+
+# yamllint disable-line rule:truthy
+on:
+  release:
+    types:
+      - published
+      - created
+      - edited
+  push:
+    branches:
+      - openwrt
+
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build ipkg
+    runs-on: ubuntu-latest
+
+    defaults:
+      run:
+        working-directory: openwrt
+
+    steps:
+      - name: Checkout openwrt
+        uses: actions/checkout@v2
+        with:
+          path: openwrt
+          repository: openwrt/openwrt
+
+      - name: Set openwrt ref
+        id: openwrt_ref
+        run: |
+          echo ::set-output name=REF::$(git rev-parse --short HEAD)
+          git rev-parse --short HEAD
+
+      - name: Checkout n2n
+        uses: actions/checkout@v2
+        with:
+          path: n2n
+          fetch-depth: 0
+
+      - name: Fix Checkout
+        run: |
+          git fetch --force --tags
+        working-directory: n2n
+
+      - name: Set n2n ref
+        id: n2n_ref
+        run: |
+          echo ::set-output name=REF::$(./scripts/version.sh)
+          ./scripts/version.sh
+        working-directory: n2n
+
+      - name: Copy n2n package definition into openwrt
+        run: |
+          cp -r n2n/packages/openwrt openwrt/package/n2n
+        working-directory: ./
+
+      - name: Cache openwrt source downloads
+        uses: actions/cache@v2
+        with:
+          path: openwrt/dl
+          key: openwrt-dl-${{ steps.openwrt_ref.outputs.REF }}
+
+      - name: Setup openwrt config and environment
+        run: |
+          echo "CONFIG_TARGET_x86=y" >.config
+          echo "CONFIG_TARGET_x86_64=y" >>.config
+
+      - name: Add n2n package to openwrt config
+        run: |
+          echo "CONFIG_PACKAGE_n2n-edge=m" >>.config
+          echo "CONFIG_PACKAGE_n2n-supernode=m" >>.config
+
+      - name: Build a full config from our stub file
+        run: |
+          make defconfig
+
+      - name: Download openwrt sources
+        run: |
+          make download
+
+      - name: Build openwrt build environment
+        run: |
+          make -j `nproc` tools/install toolchain/install
+
+      - name: Build n2n dependancies
+        run: |
+          make -j `nproc` package/libs/libpcap/compile
+
+      - name: Build n2n openwrt packages
+        env:
+          N2N_PKG_VERSION: ${{ steps.n2n_ref.outputs.REF }}
+        run: |
+          echo "Build for $N2N_PKG_VERSION"
+          export N2N_PKG_VERSION
+          make package/n2n/clean V=s
+          make package/n2n/prepare USE_SOURCE_DIR=$GITHUB_WORKSPACE/n2n V=s
+          make package/n2n/compile V=s
+
+# FIXME: add a way to run the test suite!
+#      - name: Run embedded tests
+#        run: make test
+
+      - name: Upload built artifacts
+        uses: actions/upload-artifact@v2
+        with:
+          name: built-ipkgs
+          path: openwrt/bin/packages/*/base/*.ipk

.github/workflows/tests.yml

@@ -0,0 +1,598 @@
+---
+name: Testing
+
+# yamllint disable-line rule:truthy
+on:
+  push:
+  pull_request:
+
+jobs:
+  smoketest:
+    name: Smoke test
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Fix Checkout
+        run: |
+          git fetch --force --tags
+
+      - name: Run minimal test set
+        run: |
+          ./autogen.sh
+          ./configure
+          make test
+
+  lint:
+    name: Code syntax
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Fix Checkout
+        run: |
+          git fetch --force --tags
+
+
+      - name: Make the makefiles
+        run: |
+          ./autogen.sh
+          ./configure
+
+      - name: Install essential
+        run: |
+          sudo apt update
+          make build-dep
+
+      - name: Run the lint tools
+        run: |
+          make lint
+
+  test_linux:
+    needs: smoketest
+    name: Test Linux
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      matrix:
+        os:
+          - ubuntu-20.04
+          - ubuntu-18.04
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Fix Checkout
+        run: |
+          git fetch --force --tags
+
+
+      - name: Install essential
+        run: |
+          sudo apt-get update
+          sudo apt-get install build-essential
+
+      - name: generate a makefile and use it to install more packages
+        run: |
+          ./autogen.sh
+          ./configure
+          make build-dep
+        shell: bash
+
+      - name: Run the real configure step
+        run: |
+          export CFLAGS="-fprofile-arcs -ftest-coverage"
+          export LDFLAGS="--coverage"
+          ./configure
+        shell: bash
+
+      - name: Run embedded unit tests
+        run: make test.units
+        shell: bash
+
+      - if: ${{ failure() }}
+        name: Move test outputs to an arch specific location
+        shell: bash
+        run: |
+          mkdir -p tests/${{ matrix.os }}
+          mv tests/*.out tests/${{ matrix.os }}
+
+      - if: ${{ failure() }}
+        name: Upload tests output
+        uses: actions/upload-artifact@v2
+        with:
+          name: tests-out
+          path: tests
+
+      - name: Generate coverage reports
+        run: |
+          make gcov
+          make cover COVERAGEDIR=coverage/${{ matrix.os }}
+        shell: bash
+
+      - name: Upload gcovr report artifact
+        uses: actions/upload-artifact@v2
+        with:
+          name: coverage
+          path: coverage
+
+      - name: Upload data to codecov
+        uses: codecov/codecov-action@v2
+
+  test_macos:
+    needs: smoketest
+    name: Test MacOS
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      matrix:
+        os:
+          - macos-10.15
+          - macos-11
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Fix Checkout
+        run: |
+          git fetch --force --tags
+
+
+      - name: Install packages
+        run: |
+          brew install automake
+
+      - name: generate a makefile and use it to install more packages
+        run: |
+          ./autogen.sh
+          ./configure
+          make build-dep
+        shell: bash
+
+      - name: Run the real configure step
+        run: |
+          export CFLAGS="-fprofile-arcs -ftest-coverage"
+          export LDFLAGS="--coverage"
+          ./configure
+        shell: bash
+
+      - name: Run embedded unit tests
+        run: make test.units
+        shell: bash
+
+      - if: ${{ failure() }}
+        name: Move test outputs to an arch specific location
+        shell: bash
+        run: |
+          mkdir -p tests/${{ matrix.os }}
+          mv tests/*.out tests/${{ matrix.os }}
+
+      - if: ${{ failure() }}
+        name: Upload tests output
+        uses: actions/upload-artifact@v2
+        with:
+          name: tests-out
+          path: tests
+
+      - name: Generate coverage reports
+        run: |
+          make gcov
+          # This was working fine for tens of jobs, up until
+          # 2021-10-19T18:53+0100 and it still works fine when run from my
+          # personal github actions. The next run at 2021-10-19T19:08+0100
+          # didnt work.
+          # Assume that they changed something on the runner - I cannot debug
+          # it as I do not have a Mac.
+          #
+          # make cover COVERAGEDIR=coverage/${{ matrix.os }}
+        shell: bash
+
+      # - name: Upload gcovr report artifact
+      #  uses: actions/upload-artifact@v2
+      #  with:
+      #    name: coverage
+      #    path: coverage
+
+      - name: Upload data to codecov
+        uses: codecov/codecov-action@v2
+
+  test_windows:
+    needs: smoketest
+    name: Test Windows
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      matrix:
+        os:
+          - windows-2019
+          - windows-2022
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Fix Checkout
+        run: |
+          git fetch --force --tags
+
+
+      - name: generate a makefile and use it to install more packages
+        run: |
+          # This is a pretty big hammer, but gets the windows compile moving
+          ./scripts/hack_fakeautoconf.sh
+          make build-dep
+        shell: bash
+
+      - name: Run a configure step
+        run: |
+          export CFLAGS="-fprofile-arcs -ftest-coverage"
+          export LDFLAGS="--coverage"
+          ./scripts/hack_fakeautoconf.sh
+        shell: bash
+
+      - name: Run embedded unit tests
+        run: make test.units
+        shell: bash
+
+      - if: ${{ failure() }}
+        name: Move test outputs to an arch specific location
+        shell: bash
+        run: |
+          mkdir -p tests/${{ matrix.os }}
+          mv tests/*.out tests/${{ matrix.os }}
+
+      - if: ${{ failure() }}
+        name: Upload tests output
+        uses: actions/upload-artifact@v2
+        with:
+          name: tests-out
+          path: tests
+
+      - name: Generate coverage data
+        run: |
+          make gcov
+        shell: bash
+
+      - name: Upload data to codecov
+        uses: codecov/codecov-action@v2
+
+  package_dpkg:
+    name: Package for Debian/Ubuntu
+    needs:
+      - test_linux
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+      matrix:
+        arch:
+          - amd64
+          - arm64
+          - armhf
+          - i386
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Fix Checkout
+        run: |
+          git fetch --force --tags
+
+      - name: Install packages needed for build
+        run: |
+          sudo apt-get update
+          sudo apt-get install debhelper build-essential \
+            crossbuild-essential-${{ matrix.arch }}
+
+      - name: Configure
+        # The HOST_TRIPLET line is not easily foldable
+        # yamllint disable rule:line-length
+        run: |
+          # This will warn about CC, but we cannot set CC until we run it :-S
+          HOST_TRIPLET=$(dpkg-architecture -a${{ matrix.arch }} -q DEB_HOST_GNU_TYPE)
+          export CC=$HOST_TRIPLET-gcc
+          export AR=$HOST_TRIPLET-ar
+          ./autogen.sh
+          ./configure --host $HOST_TRIPLET
+          cd packages/debian/
+          ./configure EXTN=${{ matrix.arch }}
+        # yamllint enable rule:line-length
+
+      - name: Build
+        run: |
+          cd packages/debian/
+          make
+
+      - name: Upload dpkg
+        uses: actions/upload-artifact@v2
+        with:
+          name: packages-dpkg
+          path: packages/debian/*.deb
+
+  package_rpm:
+    name: Package for Redhat/RPM
+    needs:
+      - test_linux
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Fix Checkout
+        run: |
+          git fetch --force --tags
+
+      - name: Install packages needed for build
+        run: |
+          sudo apt-get install rpm
+
+      - name: Configure
+        run: |
+          ./autogen.sh
+          ./configure
+          cd packages/rpm/
+          ./configure
+
+      - name: Build
+        run: |
+          make
+          HOME=$(pwd)/../
+          cd packages/rpm/
+          make
+          cd ../../
+          mv ../rpmbuild ./
+
+      - name: Upload rpm
+        uses: actions/upload-artifact@v2
+        with:
+          name: packages-rpm
+          path: rpmbuild/RPMS/x86_64/*.rpm
+
+  binaries_windows:
+    name: Binaries for Windows (x86_64-pc-mingw64)
+    needs:
+      - test_windows
+    runs-on: windows-latest
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Fix Checkout
+        run: |
+          git fetch --force --tags
+
+      - name: Configure and Build
+        shell: bash
+        run: |
+          ./scripts/hack_fakeautoconf.sh
+          make
+
+      - name: Create binary dir
+        shell: bash
+        run: |
+          make install DESTDIR=binaries/x86_64-pc-mingw64
+
+      - name: Upload binary artifacts
+        uses: actions/upload-artifact@v2
+        with:
+          name: binaries
+          path: binaries
+
+  binaries_macos:
+    name: Binaries for MacOS
+    needs:
+      - test_macos
+    runs-on: macos-latest
+    strategy:
+      fail-fast: true
+      matrix:
+        arch:
+          - x86_64-apple-macos
+          - arm64-apple-macos
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Fix Checkout
+        run: |
+          git fetch --force --tags
+
+      - name: Install packages needed for build
+        run: |
+          brew install automake
+
+      - name: Configure and Build
+        shell: bash
+        run: |
+          # this is a hack! it assumes the default SDK is the 'right' one
+          export SDKROOT=/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk
+          ./autogen.sh
+          export CC=clang
+          export CFLAGS="-target ${{ matrix.arch }}"
+          export LDFLAGS="-target ${{ matrix.arch }}"
+          ./configure --host=${{ matrix.arch }}
+          make
+
+      - if: ${{ failure() }}
+        name: Upload config.log output
+        uses: actions/upload-artifact@v2
+        with:
+          name: config-log-${{ matrix.arch }}
+          path: config.log
+
+      - name: Create binary dir
+        shell: bash
+        run: |
+          make install DESTDIR=binaries/${{ matrix.arch }}
+
+      - name: Upload binary artifacts
+        uses: actions/upload-artifact@v2
+        with:
+          name: binaries
+          path: binaries
+
+  binaries_macos_universal:
+    name: Binaries for MacOS (universal arch)
+    needs:
+      - test_macos
+    runs-on: macos-latest
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Fix Checkout
+        run: |
+          git fetch --force --tags
+
+      - name: Install packages needed for build
+        run: |
+          brew install automake
+
+      - name: Configure and Build
+        shell: bash
+        run: |
+          # this is a hack! it assumes the default SDK is the 'right' one
+          export SDKROOT=/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk
+          ./autogen.sh
+          export CC=clang
+          export CFLAGS="-arch x86_64 -arch arm64"
+          export LDFLAGS="-arch x86_64 -arch arm64"
+          ./configure
+          make
+
+      - name: Create binary dir
+        shell: bash
+        run: |
+          make install DESTDIR=binaries/universal-apple-darwin
+
+      - name: Upload binary artifacts
+        uses: actions/upload-artifact@v2
+        with:
+          name: binaries
+          path: binaries
+
+  binaries_linux_crosscompile:
+    name: Binaries for linux
+    needs:
+      - test_linux
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+      matrix:
+        arch:
+          - arm-linux-gnueabi
+
+          # I assume these architectures produce working code, but this has
+          # not been directly confirmed.
+          # They are compiled dynamically against normal libc, so will not
+          # work on openwrt.
+          - aarch64-linux-gnu
+          - mips-linux-gnu
+          - mipsel-linux-gnu
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Fix Checkout
+        run: |
+          git fetch --force --tags
+
+      - name: Install cross compiler
+        run: |
+          sudo apt-get update
+          sudo apt-get install \
+            binutils-${{ matrix.arch }} \
+            gcc-${{ matrix.arch }}
+
+      - name: Configure and Build
+        shell: bash
+        run: |
+          ./autogen.sh
+          export CC=${{ matrix.arch }}-gcc
+          export AR=${{ matrix.arch }}-ar
+          ./configure --host ${{ matrix.arch }}
+          make
+
+      - name: Create binary dir
+        shell: bash
+        run: |
+          make install DESTDIR=binaries/${{ matrix.arch }}
+
+      - name: Upload binary artifacts
+        uses: actions/upload-artifact@v2
+        with:
+          name: binaries
+          path: binaries
+
+  # Given the clearly documented use of annotated tags to signal releases,
+  # it seems strange that there is no simple way to trigger actions if the
+  # tag is annotated.  So we need to jump through some extra hoops.
+  #
+  # Looking at https://github.com/actions/checkout/issues/290 seems to show
+  # that github just doesnt care about how git expects annotated tags to be
+  # used.
+  #
+  # This workflow has added a `git fetch --force --tags` to every job that
+  # needs to have working tags
+
+  upload_release:
+    name: Upload Release Assets
+    if: startsWith(github.ref, 'refs/tags/')
+    needs:
+      - package_dpkg
+      - package_rpm
+      - binaries_windows
+      - binaries_macos
+      - binaries_macos_universal
+      - binaries_linux_crosscompile
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Fix Checkout
+        run: |
+          git fetch --force --tags
+
+      - name: Get Tag Type
+        id: get_tagtype
+        run: |
+          TYPE=$(git cat-file -t $GITHUB_REF)
+          echo "::set-output name=TAGTYPE::$TYPE"
+          echo ==========
+          echo REF=$GITHUB_REF
+          echo TAGTYPE=$TYPE
+
+      - name: Fetch all Artifacts
+        if: steps.get_tagtype.outputs.TAGTYPE == 'tag'
+        uses: actions/download-artifact@v2
+        with:
+          path: artifacts
+
+      - name: Upload Assets to Release
+        if: steps.get_tagtype.outputs.TAGTYPE == 'tag'
+        uses: softprops/action-gh-release@v1
+        with:
+          prerelease: true
+          files: |
+            artifacts/packages-dpkg/*.deb
+            artifacts/packages-rpm/*.rpm