.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 -DFUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION && 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   memory_sanitizer:
 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       # --debug -O1 is to produce a debug build that runs in a reasonable amount of time
 204       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
 205     - name: make
 206       run: make -s -j4
 207     - name: get cpu info
 208       run: |
 209         cat /proc/cpuinfo
 210         ./util/opensslwrap.sh version -c
 211     - name: make test
 212       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4} OPENSSL_TEST_RAND_ORDER=0
 213
 214   threads_sanitizer:
 215     runs-on: ubuntu-latest
 216     steps:
 217     - uses: actions/checkout@v4
 218     - name: checkout fuzz/corpora submodule
 219       run: git submodule update --init --depth 1 fuzz/corpora
 220     - name: config
 221       run: CC=clang ./config --banner=Configured no-fips --strict-warnings -fsanitize=thread && 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 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}
 230
 231   enable_non-default_options:
 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: modprobe tls
 238       run: sudo modprobe tls
 239     - name: config
 240       run: ./config --banner=Configured --strict-warnings no-ec enable-ssl-trace enable-zlib enable-zlib-dynamic enable-crypto-mdebug enable-crypto-mdebug-backtrace enable-egd enable-ktls enable-fips no-threads && perl configdata.pm --dump
 241     - name: make
 242       run: make -s -j4
 243     - name: get cpu info
 244       run: |
 245         cat /proc/cpuinfo
 246         ./util/opensslwrap.sh version -c
 247     - name: make test
 248       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4}
 249
 250   fips_and_ktls:
 251     runs-on: ubuntu-latest
 252     steps:
 253     - uses: actions/checkout@v4
 254     - name: checkout fuzz/corpora submodule
 255       run: git submodule update --init --depth 1 fuzz/corpora
 256     - name: modprobe tls
 257       run: sudo modprobe tls
 258     - name: config
 259       run: ./config --banner=Configured --strict-warnings enable-ktls enable-fips && perl configdata.pm --dump
 260     - name: make
 261       run: make -s -j4
 262     - name: get cpu info
 263       run: |
 264         cat /proc/cpuinfo
 265         ./util/opensslwrap.sh version -c
 266     - name: make test
 267       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4}
 268
 269   enable_brotli_dynamic:
 270     runs-on: ubuntu-latest
 271     steps:
 272     - name: install brotli
 273       run: |
 274         sudo apt-get update
 275         sudo apt-get -yq --no-install-suggests --no-install-recommends --force-yes install brotli libbrotli1 libbrotli-dev
 276     - name: checkout openssl
 277       uses: actions/checkout@v4
 278     - name: checkout fuzz/corpora submodule
 279       run: git submodule update --init --depth 1 fuzz/corpora
 280     - name: config
 281       run: ./config enable-comp enable-brotli enable-brotli-dynamic && perl configdata.pm --dump
 282     - name: make
 283       run: make -s -j4
 284     - name: get cpu info
 285       run: |
 286         cat /proc/cpuinfo
 287         ./util/opensslwrap.sh version -c
 288     - name: make test
 289       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4}
 290
 291   enable_zstd_dynamic:
 292     runs-on: ubuntu-latest
 293     steps:
 294     - name: install zstd
 295       run: |
 296         sudo apt-get update
 297         sudo apt-get -yq --no-install-suggests --no-install-recommends --force-yes install zstd libzstd1 libzstd-dev
 298     - name: checkout openssl
 299       uses: actions/checkout@v4
 300     - name: checkout fuzz/corpora submodule
 301       run: git submodule update --init --depth 1 fuzz/corpora
 302     - name: config
 303       run: ./config enable-comp enable-zstd enable-zstd-dynamic && perl configdata.pm --dump
 304     - name: make
 305       run: make -s -j4
 306     - name: get cpu info
 307       run: |
 308         cat /proc/cpuinfo
 309         ./util/opensslwrap.sh version -c
 310     - name: make test
 311       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4}
 312
 313   enable_brotli_and_zstd_dynamic:
 314     runs-on: ubuntu-latest
 315     steps:
 316     - name: install brotli and zstd
 317       run: |
 318         sudo apt-get update
 319         sudo apt-get -yq --no-install-suggests --no-install-recommends --force-yes install brotli libbrotli1 libbrotli-dev
 320         sudo apt-get -yq --no-install-suggests --no-install-recommends --force-yes install zstd libzstd1 libzstd-dev
 321     - name: checkout openssl
 322       uses: actions/checkout@v4
 323     - name: checkout fuzz/corpora submodule
 324       run: git submodule update --init --depth 1 fuzz/corpora
 325     - name: config
 326       run: ./config enable-comp enable-brotli enable-brotli-dynamic enable-zstd enable-zstd-dynamic && perl configdata.pm --dump
 327     - name: make
 328       run: make -s -j4
 329     - name: get cpu info
 330       run: |
 331         cat /proc/cpuinfo
 332         ./util/opensslwrap.sh version -c
 333     - name: make test
 334       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4}
 335
 336   enable_brotli_and_asan_ubsan:
 337     runs-on: ubuntu-latest
 338     steps:
 339     - name: install brotli
 340       run: |
 341         sudo apt-get update
 342         sudo apt-get -yq --no-install-suggests --no-install-recommends --force-yes install brotli libbrotli1 libbrotli-dev
 343     - name: checkout openssl
 344       uses: actions/checkout@v4
 345     - name: checkout fuzz/corpora submodule
 346       run: git submodule update --init --depth 1 fuzz/corpora
 347     - name: config
 348       run: ./config --banner=Configured --debug enable-asan enable-ubsan enable-comp enable-brotli -DFUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION -DPEDANTIC && perl configdata.pm --dump
 349     - name: make
 350       run: make -s -j4
 351     - name: get cpu info
 352       run: |
 353         cat /proc/cpuinfo
 354         ./util/opensslwrap.sh version -c
 355     - name: make test
 356       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4} OPENSSL_TEST_RAND_ORDER=0
 357
 358   enable_zstd_and_asan_ubsan:
 359     runs-on: ubuntu-latest
 360     steps:
 361     - name: install zstd
 362       run: |
 363         sudo apt-get update
 364         sudo apt-get -yq --no-install-suggests --no-install-recommends --force-yes install zstd libzstd1 libzstd-dev
 365     - name: checkout openssl
 366       uses: actions/checkout@v4
 367     - name: checkout fuzz/corpora submodule
 368       run: git submodule update --init --depth 1 fuzz/corpora
 369     - name: config
 370       run: ./config --banner=Configured --debug enable-asan enable-ubsan enable-comp enable-zstd -DFUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION -DPEDANTIC && perl configdata.pm --dump
 371     - name: make
 372       run: make -s -j4
 373     - name: get cpu info
 374       run: |
 375         cat /proc/cpuinfo
 376         ./util/opensslwrap.sh version -c
 377     - name: make test
 378       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4} OPENSSL_TEST_RAND_ORDER=0
 379
 380   no-legacy:
 381     runs-on: ubuntu-latest
 382     steps:
 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 --strict-warnings no-legacy enable-fips && 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}
 396
 397   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 -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
 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   enable-tfo:
 415     strategy:
 416       matrix:
 417         os: [ ubuntu-latest, macos-latest ]
 418     runs-on: ${{matrix.os}}
 419     steps:
 420     - uses: actions/checkout@v4
 421     - name: checkout fuzz/corpora submodule
 422       run: git submodule update --init --depth 1 fuzz/corpora
 423     - name: config
 424       run: CC=gcc ./config --banner=Configured enable-tfo --strict-warnings && perl configdata.pm --dump
 425     - name: make
 426       run: make -s -j4
 427     - name: get cpu info
 428       run: ./util/opensslwrap.sh version -c
 429     - name: make test
 430       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4}
 431
 432   buildtest:
 433     runs-on: ubuntu-latest
 434     steps:
 435     - uses: actions/checkout@v4
 436     - name: checkout fuzz/corpora submodule
 437       run: git submodule update --init --depth 1 fuzz/corpora
 438     - name: config
 439       run: ./config --banner=Configured no-asm no-makedepend enable-buildtest-c++ enable-fips --strict-warnings -D_DEFAULT_SOURCE && perl configdata.pm --dump
 440     - name: make
 441       run: make -s -j4
 442     - name: get cpu info
 443       run: |
 444         cat /proc/cpuinfo
 445         ./util/opensslwrap.sh version -c
 446     - name: make test
 447       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4}
 448
 449   out-of-source-and-install:
 450     strategy:
 451       matrix:
 452         os: [ubuntu-latest, macos-latest ]
 453     runs-on: ${{matrix.os}}
 454     steps:
 455     - uses: actions/checkout@v4
 456     - name: checkout fuzz/corpora submodule
 457       run: git submodule update --init --depth 1 fuzz/corpora
 458     - name: extra preparations
 459       run: |
 460         mkdir ./build
 461         mkdir ./install
 462     - name: config
 463       run: ../config --banner=Configured enable-fips enable-acvp-tests --strict-warnings --prefix=$(cd ../install; pwd) && perl configdata.pm --dump
 464       working-directory: ./build
 465     - name: make
 466       run: make -s -j4
 467       working-directory: ./build
 468     - name: get cpu info
 469       run: ./util/opensslwrap.sh version -c
 470       working-directory: ./build
 471     - name: make test
 472       run: make test HARNESS_JOBS=${HARNESS_JOBS:-4}
 473       working-directory: ./build
 474     - name: make install
 475       run: make install
 476       working-directory: ./build
 477
 478   external-tests:
 479     runs-on: ubuntu-latest
 480     steps:
 481     - uses: actions/checkout@v4
 482       with:
 483         submodules: recursive
 484     - name: package installs
 485       run: |
 486         sudo apt-get update
 487         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
 488     - name: install cpanm and Test2::V0 for gost_engine testing
 489       uses: perl-actions/install-with-cpanm@v1
 490       with:
 491         install: Test2::V0
 492     - name: setup hostname workaround
 493       run: sudo hostname localhost
 494     - name: config
 495       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
 496     - name: make
 497       run: make -s -j4
 498     - name: get cpu info
 499       run: |
 500         cat /proc/cpuinfo
 501         ./util/opensslwrap.sh version -c
 502     - name: test external gost-engine
 503       run: make test TESTS="test_external_gost_engine"
 504     - name: test external krb5
 505       run: make test TESTS="test_external_krb5"
 506     - name: test external_tlsfuzzer
 507       run: make test TESTS="test_external_tlsfuzzer"
 508     - name: test external oqs-provider
 509       run: make test TESTS="test_external_oqsprovider"
 510
 511   external-test-pyca:
 512     runs-on: ubuntu-latest
 513     strategy:
 514       matrix:
 515         RUST:
 516           - 1.51.0
 517         PYTHON:
 518           - 3.9
 519     steps:
 520     - uses: actions/checkout@v4
 521       with:
 522         submodules: recursive
 523     - name: Configure OpenSSL
 524       run: ./config --banner=Configured --strict-warnings --debug enable-external-tests && perl configdata.pm --dump
 525     - name: make
 526       run: make -s -j4
 527     - name: Setup Python
 528       uses: actions/setup-python@v4.7.1
 529       with:
 530         python-version: ${{ matrix.PYTHON }}
 531     - uses: actions-rs/toolchain@v1
 532       with:
 533         profile: minimal
 534         toolchain: ${{ matrix.RUST }}
 535         override: true
 536         default: true
 537     - name: get cpu info
 538       run: |
 539         cat /proc/cpuinfo
 540         ./util/opensslwrap.sh version -c
 541     - name: test external pyca
 542       run: make test TESTS="test_external_pyca" VERBOSE=1
 543
 544   external-test-cf-quiche:
 545     runs-on: ubuntu-latest
 546     steps:
 547     - uses: actions/checkout@v4
 548       with:
 549         submodules: recursive
 550     - name: Configure OpenSSL
 551       run: ./config --banner=Configured --strict-warnings enable-external-tests && perl configdata.pm --dump
 552     - name: make
 553       run: make -s -j4
 554     - uses: actions-rs/toolchain@v1
 555       with:
 556         profile: default
 557         toolchain: stable
 558         default: true
 559     - name: get cpu info
 560       run: |
 561         cat /proc/cpuinfo
 562         ./util/opensslwrap.sh version -c
 563     - name: test external Cloudflare quiche
 564       run: make test TESTS="test_external_cf_quiche" VERBOSE=1