From e0d2271b3a5542a94aaa7361646c95be827d4e2f Mon Sep 17 00:00:00 2001 From: yubiuser Date: Sun, 15 Sep 2024 17:54:14 +0200 Subject: [PATCH 1/5] Add CodeQL Signed-off-by: yubiuser --- .github/workflows/codeql.yml | 100 +++++++++++++++++++++++++++++++++++ 1 file changed, 100 insertions(+) create mode 100644 .github/workflows/codeql.yml diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml new file mode 100644 index 00000000..e5495478 --- /dev/null +++ b/.github/workflows/codeql.yml @@ -0,0 +1,100 @@ +# For most projects, this workflow file will not need changing; you simply need +# to commit it to your repository. +# +# You may wish to alter this file to override the set of languages analyzed, +# or to provide custom queries or build logic. +# +# ******** NOTE ******** +# We have attempted to detect the languages in your repository. Please check +# the `language` matrix defined below to confirm you have the correct set of +# supported CodeQL languages. +# +name: "CodeQL Advanced" + +on: + push: + branches: [ "master", "development", "special/CI*", "update/dnsmasq" ] + pull_request: + branches: [ "master", "development", "special/CI*", "update/dnsmasq" ] + schedule: + - cron: '45 10 * * 6' + +jobs: + analyze: + name: Analyze (${{ matrix.language }}) + # Runner size impacts CodeQL analysis time. To learn more, please see: + # - https://gh.io/recommended-hardware-resources-for-running-codeql + # - https://gh.io/supported-runners-and-hardware-resources + # - https://gh.io/using-larger-runners (GitHub.com only) + # Consider using larger runners or machines with greater resources for possible analysis time improvements. + runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }} + permissions: + # required for all workflows + security-events: write + + # required to fetch internal or private CodeQL packs + packages: read + + # only required for workflows in private repositories + actions: read + contents: read + + strategy: + fail-fast: false + matrix: + include: + - language: c-cpp + build-mode: autobuild + # CodeQL supports the following values keywords for 'language': 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift' + # Use `c-cpp` to analyze code written in C, C++ or both + # Use 'java-kotlin' to analyze code written in Java, Kotlin or both + # Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both + # To learn more about changing the languages that are analyzed or customizing the build mode for your analysis, + # see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning. + # If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how + # your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v3 + with: + languages: ${{ matrix.language }} + build-mode: ${{ matrix.build-mode }} + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. + + # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs + # queries: security-extended,security-and-quality + + # If the analyze step fails for one of the languages you are analyzing with + # "We were unable to automatically build your code", modify the matrix above + # to set the build mode to "manual" for that language. Then modify this step + # to build your code. + # ℹī¸ Command-line programs to run using the OS shell. + # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun + - if: matrix.build-mode == 'manual' + shell: bash + run: | + echo 'If you are using a "manual" build mode for one or more of the' \ + 'languages you are analyzing, replace this with the commands to build' \ + 'your code, for example:' + echo ' make bootstrap' + echo ' make release' + exit 1 + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v3 + with: + category: "/language:${{matrix.language}}" + + - name: Upload CodeQL results as an artifact + if: success() || failure() + uses: actions/upload-artifact@v4 + with: + name: codeql-results + path: ${{ steps.codeql_analysis.outputs.sarif-output }} + retention-days: 5 From bc5833d756a3c33d3180f84f8a6ba6163846cc2f Mon Sep 17 00:00:00 2001 From: yubiuser Date: Sun, 15 Sep 2024 19:05:11 +0200 Subject: [PATCH 2/5] Use build.sh Signed-off-by: yubiuser --- .github/workflows/codeql.yml | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index e5495478..ce224dd7 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -44,7 +44,7 @@ jobs: matrix: include: - language: c-cpp - build-mode: autobuild + build-mode: manual # CodeQL supports the following values keywords for 'language': 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift' # Use `c-cpp` to analyze code written in C, C++ or both # Use 'java-kotlin' to analyze code written in Java, Kotlin or both @@ -79,12 +79,7 @@ jobs: - if: matrix.build-mode == 'manual' shell: bash run: | - echo 'If you are using a "manual" build mode for one or more of the' \ - 'languages you are analyzing, replace this with the commands to build' \ - 'your code, for example:' - echo ' make bootstrap' - echo ' make release' - exit 1 + ./build.sh - name: Perform CodeQL Analysis uses: github/codeql-action/analyze@v3 From 39626b25ee0b937730843366cf113cd124290485 Mon Sep 17 00:00:00 2001 From: yubiuser Date: Sun, 15 Sep 2024 19:22:02 +0200 Subject: [PATCH 3/5] Install nettle and mbedTLS and dependencies Signed-off-by: yubiuser --- .github/workflows/codeql.yml | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index ce224dd7..bea263fc 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -10,6 +10,9 @@ # supported CodeQL languages. # name: "CodeQL Advanced" +env: + nettleversion: 3.9.1 + mbedtlsversion: 3.6.1 on: push: @@ -57,6 +60,29 @@ jobs: - name: Checkout repository uses: actions/checkout@v4 + - name: Install dependencies + run: | + sudo apt-get update + sudo apt-get install -y libidn2-0 libidn2-0-dev libunistring-dev + + - name: Install nettle + run: | + curl -sSL https://ftl.pi-hole.net/libraries/nettle-${nettleversion}.tar.gz | tar -xz + cd nettle-${nettleversion} + ./configure --enable-static --disable-shared --disable-openssl --disable-mini-gmp -disable-gcov --disable-documentation + sudo make -j $(nproc) install + + - name: Install mbedTLS + # Build static mbedTLS with pthread support + # Disable AESNI on linux/386 asit would possibly result in an incompatible + # binary in processors lacking the AESNI and SSE2 instruction sets + run: | + curl -sSL https://ftl.pi-hole.net/libraries/mbedtls-${mbedtlsversion}.tar.bz2 | tar -xj + cd mbedtls-${mbedtlsversion} + sed -i '/#define MBEDTLS_THREADING_C/s*^//**g' include/mbedtls/mbedtls_config.h + sed -i '/#define MBEDTLS_THREADING_PTHREAD/s*^//**g' include/mbedtls/mbedtls_config.h + sudo make -j $(nproc) install + # Initializes the CodeQL tools for scanning. - name: Initialize CodeQL uses: github/codeql-action/init@v3 @@ -85,6 +111,7 @@ jobs: uses: github/codeql-action/analyze@v3 with: category: "/language:${{matrix.language}}" + id: codeql_analysis - name: Upload CodeQL results as an artifact if: success() || failure() From 7a398aaa199801b6c78950269c7166b4e8a2e1b7 Mon Sep 17 00:00:00 2001 From: yubiuser Date: Sun, 15 Sep 2024 20:41:39 +0200 Subject: [PATCH 4/5] Enable security-and-quality query pack Signed-off-by: yubiuser --- .github/workflows/codeql.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index bea263fc..0bdd785e 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -94,7 +94,7 @@ jobs: # Prefix the list here with "+" to use these queries and those in the config file. # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs - # queries: security-extended,security-and-quality + queries: security-and-quality # If the analyze step fails for one of the languages you are analyzing with # "We were unable to automatically build your code", modify the matrix above From d88eabed6b54d1c4178971f76c0d9e411196065e Mon Sep 17 00:00:00 2001 From: yubiuser Date: Sun, 15 Sep 2024 22:03:40 +0200 Subject: [PATCH 5/5] Filter alerts from dependencies Signed-off-by: yubiuser --- .github/workflows/codeql.yml | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index 0bdd785e..a3878d25 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -111,12 +111,37 @@ jobs: uses: github/codeql-action/analyze@v3 with: category: "/language:${{matrix.language}}" - id: codeql_analysis + upload: failure-only # upload only in case of failure, otherwise upload later after filtering + output: codeql-results + + - name: Filter SARIF + uses: advanced-security/filter-sarif@v1 + with: + # filter out third-party dependencies + patterns: | + -src/dnsmasq/* + -src/webserver/civetweb/* + -src/webserver/cJSON/* + -src/tre-regex/* + -src/config/tomlc99/* + -src/database/shell.c + -src/database/sqlite3.c + -src/database/sqlite3.h + -src/zip/miniz/* + -src/lua/* + +src/lua/ftl_* + input: codeql-results/cpp.sarif + output: codeql-results/cpp.sarif + + - name: Upload SARIF + uses: github/codeql-action/upload-sarif@v3 + with: + sarif_file: codeql-results/cpp.sarif - name: Upload CodeQL results as an artifact if: success() || failure() uses: actions/upload-artifact@v4 with: name: codeql-results - path: ${{ steps.codeql_analysis.outputs.sarif-output }} + path: codeql-results retention-days: 5