.github/workflows/ci.yml

   1 # Copyright 2021-2023 The OpenSSL Project Authors. All Rights Reserved.
   2 #
   3 # Licensed under the Apache License 2.0 (the "License").  You may not use
   4 # this file except in compliance with the License.  You can obtain a copy
   5 # in the file LICENSE in the source distribution or at
   6 # https://www.openssl.org/source/license.html
   7
   8 name: GitHub CI
   9
  10 on: [pull_request, push]
  11
  12 # for some reason, this does not work:
  13 # variables:
  14 #   BUILDOPTS: "-j4"
  15 #   HARNESS_JOBS: "${HARNESS_JOBS:-4}"
  16
  17 # for some reason, this does not work:
  18 # before_script:
  19 #     - make="make -s"
  20
  21 permissions:
  22   contents: read
  23
  24 jobs:
  25   check_update:
  26     runs-on: ubuntu-latest
  27     steps:
  28     - name: install unifdef
  29       run: |
  30         sudo apt-get update
  31         sudo apt-get -yq --no-install-suggests --no-install-recommends --force-yes install unifdef
  32     - uses: actions/checkout@v4
  33       with:
  34         fetch-depth: 0
  35     - name: config
  36       run: ./config --banner=Configured --strict-warnings enable-fips && perl configdata.pm --dump
  37     - name: make build_generated
  38       run: make -s build_generated
  39     - name: make update
  40       run: make update
  41     - name: git diff
  42       run: git diff --exit-code
  43
  44   check_docs:
  45     runs-on: ubuntu-latest
  46     steps:
  47     - uses: actions/checkout@v4
  48     - name: config
  49       run: ./config --banner=Configured --strict-warnings enable-fips && perl configdata.pm --dump
  50     - name: make build_generated
  51       run: make -s build_generated
  52     - name: make doc-nits
  53       run: make doc-nits
  54     - name: make help
  55       run: make help
  56     - name: make md-nits
  57       run: |
  58           sudo gem install mdl
  59           make md-nits
  60
  61   # This checks that we use ANSI C language syntax and semantics.
  62   # We are not as strict with libraries, but rather adapt to what's
  63   # expected to be available in a certain version of each platform.
  64   check-ansi:
  65     runs-on: ubuntu-latest
  66     steps:
  67     - uses: actions/checkout@v4
  68     - name: config
  69       run: CPPFLAGS=-ansi ./config --banner=Configured no-asm no-makedepend enable-buildtest-c++ enable-fips --strict-warnings -D_DEFAULT_SOURCE && perl configdata.pm --dump
  70     - name: make
  71       run: make -s -j4
  72
  73   basic_gcc:
  74     runs-on: ubuntu-latest
  75     steps:
  76     - uses: actions/checkout@v4
  77     - name: checkout fuzz/corpora submodule
  78       run: git submodule update --init --depth 1 fuzz/corpora
  79     - name: localegen
  80       run: sudo locale-gen tr_TR.UTF-8
  81     - name: config
  82       # enable-quic is on by default, but we leave it here to check we're testing the explicit enable somewhere
  83       run: CC=gcc ./config --banner=Configured enable-fips enable-quic --strict-warnings && perl configdata.pm --dump
  84     - name: make
  85       run: make -s -j4
  86     - name: get cpu info
  87       run: |
  88         cat /proc/cpuinfo
  89         ./util/opensslwrap.sh version -c
  90     - name: make test
  91       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4}
  92
  93   basic_clang:
  94     runs-on: ubuntu-latest
  95     steps:
  96     - uses: actions/checkout@v4
  97     - name: checkout fuzz/corpora submodule
  98       run: git submodule update --init --depth 1 fuzz/corpora
  99     - name: config
 100       run: CC=clang ./config --banner=Configured no-fips --strict-warnings && perl configdata.pm --dump
 101     - name: make
 102       run: make -s -j4
 103     - name: get cpu info
 104       run: |
 105         cat /proc/cpuinfo
 106         ./util/opensslwrap.sh version -c
 107     - name: make test
 108       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4}
 109
 110   minimal:
 111     runs-on: ubuntu-latest
 112     steps:
 113     - uses: actions/checkout@v4
 114     - name: checkout fuzz/corpora submodule
 115       run: git submodule update --init --depth 1 fuzz/corpora
 116     - name: config
 117       run: ./config --banner=Configured --strict-warnings no-bulk no-pic no-asm -DOPENSSL_NO_SECURE_MEMORY -DOPENSSL_SMALL_FOOTPRINT && perl configdata.pm --dump
 118     - name: make
 119       run: make -j4 # verbose, so no -s here
 120     - name: get cpu info
 121       run: |
 122         cat /proc/cpuinfo
 123         ./util/opensslwrap.sh version -c
 124     - name: make test
 125       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4}
 126
 127   no-deprecated:
 128     runs-on: ubuntu-latest
 129     steps:
 130     - uses: actions/checkout@v4
 131     - name: checkout fuzz/corpora submodule
 132       run: git submodule update --init --depth 1 fuzz/corpora
 133     - name: config
 134       run: ./config --banner=Configured --strict-warnings no-deprecated enable-fips && perl configdata.pm --dump
 135     - name: make
 136       run: make -s -j4
 137     - name: get cpu info
 138       run: |
 139         cat /proc/cpuinfo
 140         ./util/opensslwrap.sh version -c
 141     - name: make test
 142       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4}
 143
 144   no-shared:
 145     strategy:
 146       matrix:
 147         os: [ ubuntu-latest, macos-latest ]
 148     runs-on: ${{matrix.os}}
 149     steps:
 150     - uses: actions/checkout@v4
 151     - name: checkout fuzz/corpora submodule
 152       run: git submodule update --init --depth 1 fuzz/corpora
 153     - name: config
 154       run: ./config --banner=Configured --strict-warnings no-shared no-fips && perl configdata.pm --dump
 155     - name: make
 156       run: make -s -j4
 157     - name: get cpu info
 158       run: ./util/opensslwrap.sh version -c
 159     - name: make test
 160       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4}
 161
 162   non-caching:
 163     runs-on: ubuntu-latest
 164     steps:
 165     - uses: actions/checkout@v4
 166     - name: checkout fuzz/corpora submodule
 167       run: git submodule update --init --depth 1 fuzz/corpora
 168     - name: config
 169       run: ./config --banner=Configured --debug enable-asan enable-ubsan no-cached-fetch no-fips no-dtls no-tls1 no-tls1-method no-tls1_1 no-tls1_1-method no-async && perl configdata.pm --dump
 170     - name: make
 171       run: make -s -j4
 172     - name: get cpu info
 173       run: |
 174         cat /proc/cpuinfo
 175         ./util/opensslwrap.sh version -c
 176     - name: make test
 177       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4} OPENSSL_TEST_RAND_ORDER=0 TESTS="-test_fuzz* -test_ssl_* -test_sslapi -test_evp -test_cmp_http -test_verify -test_cms -test_store -test_enc -[01][0-9]"
 178
 179   address_ub_sanitizer:
 180     runs-on: ubuntu-latest
 181     steps:
 182     - uses: actions/checkout@v4
 183     - name: checkout fuzz/corpora submodule
 184       run: git submodule update --init --depth 1 fuzz/corpora
 185     - name: config
 186       run: ./config --banner=Configured --debug enable-asan enable-ubsan enable-rc5 enable-md2 enable-ec_nistp_64_gcc_128 enable-fips && perl configdata.pm --dump
 187     - name: make
 188       run: make -s -j4
 189     - name: get cpu info
 190       run: |
 191         cat /proc/cpuinfo
 192         ./util/opensslwrap.sh version -c
 193     - name: make test
 194       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4} OPENSSL_TEST_RAND_ORDER=0
 195
 196   fuzz_tests:
 197     runs-on: ubuntu-latest
 198     steps:
 199     - uses: actions/checkout@v4
 200     - name: checkout fuzz/corpora submodule
 201       run: git submodule update --init --depth 1 fuzz/corpora
 202     - name: config
 203       run: ./config --banner=Configured --debug -DPEDANTIC -DFUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION enable-asan enable-ubsan enable-rc5 enable-md2 enable-ec_nistp_64_gcc_128 enable-weak-ssl-ciphers enable-ssl3 enable-ssl3-method enable-nextprotoneg && perl configdata.pm --dump
 204     - name: make
 205       run: make -s -j4
 206     - name: get cpu info
 207       run: |
 208         cat /proc/cpuinfo
 209         ./util/opensslwrap.sh version -c
 210     - name: make test
 211       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4} OPENSSL_TEST_RAND_ORDER=0 TESTS="test_fuzz*"
 212
 213   memory_sanitizer:
 214     runs-on: ubuntu-latest
 215     steps:
 216     - uses: actions/checkout@v4
 217     - name: checkout fuzz/corpora submodule
 218       run: git submodule update --init --depth 1 fuzz/corpora
 219     - name: config
 220       # --debug -O1 is to produce a debug build that runs in a reasonable amount of time
 221       run: CC=clang ./config --banner=Configured --debug -O1 -fsanitize=memory -DOSSL_SANITIZE_MEMORY -fno-optimize-sibling-calls enable-rc5 enable-md2 enable-ec_nistp_64_gcc_128 enable-fips && perl configdata.pm --dump
 222     - name: make
 223       run: make -s -j4
 224     - name: get cpu info
 225       run: |
 226         cat /proc/cpuinfo
 227         ./util/opensslwrap.sh version -c
 228     - name: make test
 229       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4} OPENSSL_TEST_RAND_ORDER=0
 230
 231   threads_sanitizer:
 232     runs-on: ubuntu-latest
 233     steps:
 234     - uses: actions/checkout@v4
 235     - name: checkout fuzz/corpora submodule
 236       run: git submodule update --init --depth 1 fuzz/corpora
 237     - name: config
 238       run: CC=clang ./config --banner=Configured no-fips --strict-warnings -fsanitize=thread && perl configdata.pm --dump
 239     - name: make
 240       run: make -s -j4
 241     - name: get cpu info
 242       run: |
 243         cat /proc/cpuinfo
 244         ./util/opensslwrap.sh version -c
 245     - name: make test
 246       run: make V=1 TESTS="test_threads test_internal_provider test_provfetch test_provider test_pbe test_evp_kdf test_pkcs12 test_store test_evp test_quic*" test HARNESS_JOBS=${HARNESS_JOBS:-4}
 247
 248   enable_non-default_options:
 249     runs-on: ubuntu-latest
 250     steps:
 251     - uses: actions/checkout@v4
 252     - name: checkout fuzz/corpora submodule
 253       run: git submodule update --init --depth 1 fuzz/corpora
 254     - name: modprobe tls
 255       run: sudo modprobe tls
 256     - name: config
 257       run: ./config --banner=Configured --strict-warnings no-ec enable-ssl-trace enable-zlib enable-zlib-dynamic enable-crypto-mdebug enable-egd enable-ktls enable-fips no-threads && perl configdata.pm --dump
 258     - name: make
 259       run: make -s -j4
 260     - name: get cpu info
 261       run: |
 262         cat /proc/cpuinfo
 263         ./util/opensslwrap.sh version -c
 264     - name: make test
 265       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4}
 266
 267   fips_and_ktls:
 268     runs-on: ubuntu-latest
 269     steps:
 270     - uses: actions/checkout@v4
 271     - name: checkout fuzz/corpora submodule
 272       run: git submodule update --init --depth 1 fuzz/corpora
 273     - name: modprobe tls
 274       run: sudo modprobe tls
 275     - name: config
 276       run: ./config --banner=Configured --strict-warnings enable-ktls enable-fips && perl configdata.pm --dump
 277     - name: make
 278       run: make -s -j4
 279     - name: get cpu info
 280       run: |
 281         cat /proc/cpuinfo
 282         ./util/opensslwrap.sh version -c
 283     - name: make test
 284       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4}
 285
 286   enable_brotli_dynamic:
 287     runs-on: ubuntu-latest
 288     steps:
 289     - name: install brotli
 290       run: |
 291         sudo apt-get update
 292         sudo apt-get -yq --no-install-suggests --no-install-recommends --force-yes install brotli libbrotli1 libbrotli-dev
 293     - name: checkout openssl
 294       uses: actions/checkout@v4
 295     - name: checkout fuzz/corpora submodule
 296       run: git submodule update --init --depth 1 fuzz/corpora
 297     - name: config
 298       run: ./config enable-comp enable-brotli enable-brotli-dynamic && perl configdata.pm --dump
 299     - name: make
 300       run: make -s -j4
 301     - name: get cpu info
 302       run: |
 303         cat /proc/cpuinfo
 304         ./util/opensslwrap.sh version -c
 305     - name: make test
 306       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4}
 307
 308   enable_zstd_dynamic:
 309     runs-on: ubuntu-latest
 310     steps:
 311     - name: install zstd
 312       run: |
 313         sudo apt-get update
 314         sudo apt-get -yq --no-install-suggests --no-install-recommends --force-yes install zstd libzstd1 libzstd-dev
 315     - name: checkout openssl
 316       uses: actions/checkout@v4
 317     - name: checkout fuzz/corpora submodule
 318       run: git submodule update --init --depth 1 fuzz/corpora
 319     - name: config
 320       run: ./config enable-comp enable-zstd enable-zstd-dynamic && perl configdata.pm --dump
 321     - name: make
 322       run: make -s -j4
 323     - name: get cpu info
 324       run: |
 325         cat /proc/cpuinfo
 326         ./util/opensslwrap.sh version -c
 327     - name: make test
 328       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4}
 329
 330   enable_brotli_and_zstd_dynamic:
 331     runs-on: ubuntu-latest
 332     steps:
 333     - name: install brotli and zstd
 334       run: |
 335         sudo apt-get update
 336         sudo apt-get -yq --no-install-suggests --no-install-recommends --force-yes install brotli libbrotli1 libbrotli-dev
 337         sudo apt-get -yq --no-install-suggests --no-install-recommends --force-yes install zstd libzstd1 libzstd-dev
 338     - name: checkout openssl
 339       uses: actions/checkout@v4
 340     - name: checkout fuzz/corpora submodule
 341       run: git submodule update --init --depth 1 fuzz/corpora
 342     - name: config
 343       run: ./config enable-comp enable-brotli enable-brotli-dynamic enable-zstd enable-zstd-dynamic && perl configdata.pm --dump
 344     - name: make
 345       run: make -s -j4
 346     - name: get cpu info
 347       run: |
 348         cat /proc/cpuinfo
 349         ./util/opensslwrap.sh version -c
 350     - name: make test
 351       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4}
 352
 353   enable_brotli_and_asan_ubsan:
 354     runs-on: ubuntu-latest
 355     steps:
 356     - name: install brotli
 357       run: |
 358         sudo apt-get update
 359         sudo apt-get -yq --no-install-suggests --no-install-recommends --force-yes install brotli libbrotli1 libbrotli-dev
 360     - name: checkout openssl
 361       uses: actions/checkout@v4
 362     - name: checkout fuzz/corpora submodule
 363       run: git submodule update --init --depth 1 fuzz/corpora
 364     - name: config
 365       run: ./config --banner=Configured --debug enable-asan enable-ubsan enable-comp enable-brotli -DPEDANTIC && perl configdata.pm --dump
 366     - name: make
 367       run: make -s -j4
 368     - name: get cpu info
 369       run: |
 370         cat /proc/cpuinfo
 371         ./util/opensslwrap.sh version -c
 372     - name: make test
 373       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4} OPENSSL_TEST_RAND_ORDER=0
 374
 375   enable_zstd_and_asan_ubsan:
 376     runs-on: ubuntu-latest
 377     steps:
 378     - name: install zstd
 379       run: |
 380         sudo apt-get update
 381         sudo apt-get -yq --no-install-suggests --no-install-recommends --force-yes install zstd libzstd1 libzstd-dev
 382     - name: checkout openssl
 383       uses: actions/checkout@v4
 384     - name: checkout fuzz/corpora submodule
 385       run: git submodule update --init --depth 1 fuzz/corpora
 386     - name: config
 387       run: ./config --banner=Configured --debug enable-asan enable-ubsan enable-comp enable-zstd -DPEDANTIC && perl configdata.pm --dump
 388     - name: make
 389       run: make -s -j4
 390     - name: get cpu info
 391       run: |
 392         cat /proc/cpuinfo
 393         ./util/opensslwrap.sh version -c
 394     - name: make test
 395       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4} OPENSSL_TEST_RAND_ORDER=0
 396
 397   no-legacy:
 398     runs-on: ubuntu-latest
 399     steps:
 400     - uses: actions/checkout@v4
 401     - name: checkout fuzz/corpora submodule
 402       run: git submodule update --init --depth 1 fuzz/corpora
 403     - name: config
 404       run: ./config --banner=Configured --strict-warnings no-legacy enable-fips && perl configdata.pm --dump
 405     - name: make
 406       run: make -s -j4
 407     - name: get cpu info
 408       run: |
 409         cat /proc/cpuinfo
 410         ./util/opensslwrap.sh version -c
 411     - name: make test
 412       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4}
 413
 414   legacy:
 415     runs-on: ubuntu-latest
 416     steps:
 417     - uses: actions/checkout@v4
 418     - name: checkout fuzz/corpora submodule
 419       run: git submodule update --init --depth 1 fuzz/corpora
 420     - name: config
 421       run: ./config --banner=Configured -Werror --debug no-afalgeng no-shared enable-crypto-mdebug enable-rc5 enable-md2 enable-ssl3 enable-ssl3-method enable-weak-ssl-ciphers enable-zlib enable-ec_nistp_64_gcc_128 no-fips && perl configdata.pm --dump
 422     - name: make
 423       run: make -s -j4
 424     - name: get cpu info
 425       run: |
 426         cat /proc/cpuinfo
 427         ./util/opensslwrap.sh version -c
 428     - name: make test
 429       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4}
 430
 431   enable-tfo:
 432     strategy:
 433       matrix:
 434         os: [ ubuntu-latest, macos-latest ]
 435     runs-on: ${{matrix.os}}
 436     steps:
 437     - uses: actions/checkout@v4
 438     - name: checkout fuzz/corpora submodule
 439       run: git submodule update --init --depth 1 fuzz/corpora
 440     - name: config
 441       run: CC=gcc ./config --banner=Configured enable-tfo --strict-warnings && perl configdata.pm --dump
 442     - name: make
 443       run: make -s -j4
 444     - name: get cpu info
 445       run: ./util/opensslwrap.sh version -c
 446     - name: make test
 447       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4}
 448
 449   buildtest:
 450     runs-on: ubuntu-latest
 451     steps:
 452     - uses: actions/checkout@v4
 453     - name: checkout fuzz/corpora submodule
 454       run: git submodule update --init --depth 1 fuzz/corpora
 455     - name: config
 456       run: ./config --banner=Configured no-asm no-makedepend enable-buildtest-c++ enable-fips --strict-warnings -D_DEFAULT_SOURCE && perl configdata.pm --dump
 457     - name: make
 458       run: make -s -j4
 459     - name: get cpu info
 460       run: |
 461         cat /proc/cpuinfo
 462         ./util/opensslwrap.sh version -c
 463     - name: make test
 464       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4}
 465
 466   out-of-source-and-install:
 467     strategy:
 468       matrix:
 469         os: [ubuntu-latest, macos-latest ]
 470     runs-on: ${{matrix.os}}
 471     steps:
 472     - uses: actions/checkout@v4
 473     - name: checkout fuzz/corpora submodule
 474       run: git submodule update --init --depth 1 fuzz/corpora
 475     - name: extra preparations
 476       run: |
 477         mkdir ./build
 478         mkdir ./install
 479     - name: config
 480       run: ../config --banner=Configured enable-fips enable-acvp-tests --strict-warnings --prefix=$(cd ../install; pwd) && perl configdata.pm --dump
 481       working-directory: ./build
 482     - name: make
 483       run: make -s -j4
 484       working-directory: ./build
 485     - name: get cpu info
 486       run: ./util/opensslwrap.sh version -c
 487       working-directory: ./build
 488     - name: make test
 489       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4}
 490       working-directory: ./build
 491     - name: make install
 492       run: make install
 493       working-directory: ./build
 494
 495   external-tests:
 496     runs-on: ubuntu-latest
 497     steps:
 498     - uses: actions/checkout@v4
 499       with:
 500         submodules: recursive
 501     - name: package installs
 502       run: |
 503         sudo apt-get update
 504         sudo apt-get -yq install bison gettext keyutils ldap-utils libldap2-dev libkeyutils-dev python3 python3-paste python3-pyrad slapd tcsh python3-virtualenv virtualenv python3-kdcproxy
 505     - name: install cpanm and Test2::V0 for gost_engine testing
 506       uses: perl-actions/install-with-cpanm@v1
 507       with:
 508         install: Test2::V0
 509     - name: setup hostname workaround
 510       run: sudo hostname localhost
 511     - name: config
 512       run: ./config --banner=Configured --strict-warnings --debug no-afalgeng enable-rc5 enable-md2 enable-ssl3 enable-ssl3-method enable-weak-ssl-ciphers enable-zlib enable-ec_nistp_64_gcc_128 enable-external-tests no-fips && perl configdata.pm --dump
 513     - name: make
 514       run: make -s -j4
 515     - name: get cpu info
 516       run: |
 517         cat /proc/cpuinfo
 518         ./util/opensslwrap.sh version -c
 519     - name: test external gost-engine
 520       run: make test TESTS="test_external_gost_engine"
 521     - name: test external krb5
 522       run: make test TESTS="test_external_krb5"
 523     - name: test external_tlsfuzzer
 524       run: make test TESTS="test_external_tlsfuzzer"
 525     - name: test external oqs-provider
 526       run: make test TESTS="test_external_oqsprovider"
 527
 528   external-test-pyca:
 529     runs-on: ubuntu-latest
 530     strategy:
 531       matrix:
 532         RUST:
 533           - 1.51.0
 534         PYTHON:
 535           - 3.9
 536     steps:
 537     - uses: actions/checkout@v4
 538       with:
 539         submodules: recursive
 540     - name: Configure OpenSSL
 541       run: ./config --banner=Configured --strict-warnings --debug enable-external-tests && perl configdata.pm --dump
 542     - name: make
 543       run: make -s -j4
 544     - name: Setup Python
 545       uses: actions/setup-python@v4.7.1
 546       with:
 547         python-version: ${{ matrix.PYTHON }}
 548     - uses: actions-rs/toolchain@v1
 549       with:
 550         profile: minimal
 551         toolchain: ${{ matrix.RUST }}
 552         override: true
 553         default: true
 554     - name: get cpu info
 555       run: |
 556         cat /proc/cpuinfo
 557         ./util/opensslwrap.sh version -c
 558     - name: test external pyca
 559       run: make test TESTS="test_external_pyca" VERBOSE=1
 560
 561   external-test-cf-quiche:
 562     runs-on: ubuntu-latest
 563     steps:
 564     - uses: actions/checkout@v4
 565       with:
 566         submodules: recursive
 567     - name: Configure OpenSSL
 568       run: ./config --banner=Configured --strict-warnings enable-external-tests && perl configdata.pm --dump
 569     - name: make
 570       run: make -s -j4
 571     - uses: actions-rs/toolchain@v1
 572       with:
 573         profile: default
 574         toolchain: stable
 575         default: true
 576     - name: get cpu info
 577       run: |
 578         cat /proc/cpuinfo
 579         ./util/opensslwrap.sh version -c
 580     - name: test external Cloudflare quiche
 581       run: make test TESTS="test_external_cf_quiche" VERBOSE=1