openssh.yml

name: openssh Tests


on:
  workflow_call:
    inputs:
      wolfssl_refs_json:
        description: "JSON array of wolfssl refs to test; empty = use discover_versions output"
        required: false
        type: string
        default: ""
  workflow_dispatch: {}

jobs:
  discover_versions:
    uses: ./.github/workflows/_discover-versions.yml

  build_wolfprovider:
    needs: discover_versions
    uses: ./.github/workflows/build-wolfprovider.yml
    with:
      wolfssl_ref: ${{ matrix.wolfssl_ref }}
      openssl_ref: ${{ matrix.openssl_ref }}
      fips_ref: ${{ matrix.fips_ref }}
      replace_default: ${{ matrix.replace_default }}
    strategy:
      fail-fast: false
      matrix:
        wolfssl_ref: ${{ inputs.wolfssl_refs_json != '' && fromJson(inputs.wolfssl_refs_json) || fromJson(needs.discover_versions.outputs.wolfssl_ref_array) }}
        openssl_ref: ${{ fromJson(needs.discover_versions.outputs.openssl_ref_array) }}
        fips_ref: [ 'FIPS', 'non-FIPS' ]
        replace_default: [ true ]

  test_openssh:
    runs-on: ubuntu-22.04
    needs: [build_wolfprovider, discover_versions]
    container:
      image: ghcr.io/wolfssl/wolfprovider-test-deps:bookworm
      # Extra permissions needed for Debian Bookworm
      options: >-
        --privileged
        --cap-add=SYS_ADMIN
        --device=/dev/mapper/control
        --device=/dev/loop-control
        --device=/dev/loop0
        --device=/dev/loop1
        --device=/dev/loop2
        -v /lib/modules:/lib/modules:ro
      env:
        DEBIAN_FRONTEND: noninteractive
    # This should be a safe limit for the tests to run.
    timeout-minutes: 60
    strategy:
      fail-fast: false
      matrix:
        openssh_ref: [ 'V_10_0_P2', 'V_9_9_P1' ]
        wolfssl_ref: ${{ inputs.wolfssl_refs_json != '' && fromJson(inputs.wolfssl_refs_json) || fromJson(needs.discover_versions.outputs.wolfssl_ref_array) }}
        openssl_ref: ${{ fromJson(needs.discover_versions.outputs.openssl_ref_array) }}
        fips_ref: [ 'non-FIPS' ] # FIPS is not yet supported for OpenSSH
        force_fail: ['WOLFPROV_FORCE_FAIL=1', '']
        replace_default: [ true ]
    env:
      WOLFSSL_PACKAGES_PATH: /tmp/wolfssl-packages
      OPENSSL_PACKAGES_PATH: /tmp/openssl-packages
      WOLFPROV_PACKAGES_PATH: /tmp/wolfprov-packages
    steps:
      - name: Checkout wolfProvider
        uses: actions/checkout@v4
        with:
          fetch-depth: 1

      - name: Download packages from build job
        uses: actions/download-artifact@v4
        with:
          name: debian-packages-${{ matrix.fips_ref }}${{ matrix.replace_default && '-replace-default' || '' }}-${{ matrix.wolfssl_ref }}-${{ matrix.openssl_ref }}
          path: /tmp

      - name: Install wolfSSL/OpenSSL/wolfprov packages
        run: |
          apt install --reinstall -y --allow-downgrades --allow-change-held-packages \
            ${{ env.WOLFSSL_PACKAGES_PATH }}/libwolfssl_*.deb

          apt install --reinstall -y --allow-downgrades --allow-change-held-packages \
            ${{ env.OPENSSL_PACKAGES_PATH }}/openssl_*.deb \
            ${{ env.OPENSSL_PACKAGES_PATH }}/libssl3_*.deb \
            ${{ env.OPENSSL_PACKAGES_PATH }}/libssl-dev_*.deb

          apt install --reinstall -y --allow-downgrades --allow-change-held-packages \
            ${{ env.WOLFPROV_PACKAGES_PATH }}/libwolfprov_*.deb

          # Prevent later 'apt-get install' of test dependencies from
          # replacing the wolfprov-patched libssl3, which breaks 
          # replace-default mode.
          apt-mark hold libssl3 libssl-dev openssl libwolfssl libwolfprov

      - name: Verify wolfProvider is properly installed
        run: |
          $GITHUB_WORKSPACE/scripts/verify-install.sh \
            ${{ matrix.replace_default && '--replace-default' || '' }} \
            ${{ matrix.fips_ref == 'FIPS' && '--fips' || '' }}

      - name: Ensure kernel modules are present
        run: |
          # loop + device-mapper (dm-crypt); scsi_debug is optional and may still be unavailable on the host kernel
          modprobe loop || true
          modprobe dm_mod || true
          modprobe dm_crypt || true
          modprobe scsi_debug || true
          losetup -f || true
          ls -l /dev/loop* /dev/mapper || true

      - name: Checkout openssh
        uses: actions/checkout@v4
        with:
          repository: openssh/openssh-portable
          path: openssh-portable
          ref: ${{ matrix.openssh_ref }}
          fetch-depth: 1

      - name: Checkout OSP
        uses: actions/checkout@v4
        with:
          repository: wolfssl/osp
          path: osp
          fetch-depth: 1
      - run: |
          # Apply the patch for the correct version of OpenSSH
          cd openssh-portable
          PATCH=$($GITHUB_WORKSPACE/scripts/resolve-osp-patch.sh $GITHUB_WORKSPACE/osp openssh ${{ matrix.openssh_ref }} ${{ matrix.wolfssl_ref }} ${{ matrix.fips_ref == 'FIPS' && '--fips' || '' }})
          patch -p1 < "$PATCH"

      - name: Build and Test openssh-portable
        working-directory: openssh-portable
        shell: bash
        run: |
          set +o pipefail # ignore errors from make check
          export ${{ matrix.force_fail }}

          # Enable unsafe permissions for testing
          export TEST_SSH_UNSAFE_PERMISSIONS=1

          # Priv-sep user/group (idempotent)
          getent group sshd >/dev/null || addgroup --system sshd
          id -u sshd >/dev/null 2>&1 || adduser --system --no-create-home \
            --ingroup sshd --home /nonexistent --shell /usr/sbin/nologin sshd

          # Priv-sep runtime dirs
          install -d -m 0755 /run/sshd

          # The required chroot for privilege separation
          # Must exist, be owned by root, and not be writable by group/world.
          install -d -o root -g root -m 0755 /var/empty

          # Ensure the privsep user/group exist (idempotent)
          if ! getent group sshd >/dev/null; then
            addgroup --system sshd
          fi
          if ! id -u sshd >/dev/null 2>&1; then
            adduser --system --no-create-home --ingroup sshd \
                    --home /nonexistent --shell /usr/sbin/nologin sshd
          fi

          autoreconf -ivf
          ./configure --with-prngd-socket=/tmp/prngd \
                     --with-ldflags=-Wl,--export-dynamic
          make -j

          export LD_LIBRARY_PATH=".:openbsd-compat:$LD_LIBRARY_PATH"  # Include build dirs for symbol resolution

          # Run all the tests except (t-exec) as it takes too long
          make file-tests interop-tests extra-tests unit 2>&1 | tee openssh-test.log
          TEST_RESULT=${PIPESTATUS[0]}
          $GITHUB_WORKSPACE/.github/scripts/check-workflow-result.sh $TEST_RESULT ${{ matrix.force_fail }} openssh