blob: 52f75e0de389d8f5616927d28a88963e469dc926 [file] [log] [blame]
Manuel Pégourié-Gonnard72e51ee2014-08-31 10:22:11 +02001#!/bin/sh
Paul Bakkeraccd4eb2013-07-19 13:41:51 +02002
Simon Butcherac22d112016-09-04 22:31:09 +01003# compat.sh
4#
Bence Szépkúti1e148272020-08-07 13:07:28 +02005# Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00006# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Bence Szépkútic7da1fe2020-05-26 01:54:15 +02007#
Simon Butcherac22d112016-09-04 22:31:09 +01008# Purpose
9#
10# Test interoperbility with OpenSSL, GnuTLS as well as itself.
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +010011#
12# Check each common ciphersuite, with each version, both ways (client/server),
13# with and without client authentication.
Manuel Pégourié-Gonnardeaadc502014-02-20 11:01:30 +010014
Manuel Pégourié-Gonnard913030c2014-03-28 10:12:38 +010015set -u
16
Jaeden Amero6e70eb22019-07-03 13:51:04 +010017# Limit the size of each log to 10 GiB, in case of failures with this script
18# where it may output seemingly unlimited length error logs.
19ulimit -f 20971520
20
Yanray Wangad470632023-02-20 14:58:03 +080021ORIGINAL_PWD=$PWD
22if ! cd "$(dirname "$0")"; then
23 exit 125
24fi
25
Manuel Pégourié-Gonnarda1a9f9a2014-03-25 18:04:59 +010026# initialise counters
Manuel Pégourié-Gonnard72e51ee2014-08-31 10:22:11 +020027TESTS=0
28FAILED=0
29SKIPPED=0
30SRVMEM=0
Manuel Pégourié-Gonnard70064fd2013-08-27 22:00:47 +020031
Antonin Décimo36e89b52019-01-23 15:24:37 +010032# default commands, can be overridden by the environment
Simon Butcherac22d112016-09-04 22:31:09 +010033: ${M_SRV:=../programs/ssl/ssl_server2}
34: ${M_CLI:=../programs/ssl/ssl_client2}
Manuel Pégourié-Gonnard6e666c22023-01-10 09:38:58 +010035: ${OPENSSL:=openssl}
Manuel Pégourié-Gonnard74faf3c2014-03-13 18:47:44 +010036: ${GNUTLS_CLI:=gnutls-cli}
37: ${GNUTLS_SERV:=gnutls-serv}
Manuel Pégourié-Gonnardf7a26902014-02-27 12:25:54 +010038
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +010039# The OPENSSL variable used to be OPENSSL_CMD for historical reasons.
40# To help the migration, error out if the old variable is set,
41# but only if it has a different value than the new one.
42if [ "${OPENSSL_CMD+set}" = set ]; then
43 # the variable is set, we can now check its value
44 if [ "$OPENSSL_CMD" != "$OPENSSL" ]; then
45 echo "Please use OPENSSL instead of OPENSSL_CMD." >&2
46 exit 125
47 fi
48fi
49
Manuel Pégourié-Gonnard1287f112014-08-31 16:20:58 +020050# do we have a recent enough GnuTLS?
Manuel Pégourié-Gonnard03db6b02015-06-26 15:45:30 +020051if ( which $GNUTLS_CLI && which $GNUTLS_SERV ) >/dev/null 2>&1; then
Manuel Pégourié-Gonnarddd459272014-10-24 12:57:37 +020052 G_VER="$( $GNUTLS_CLI --version | head -n1 )"
53 if echo "$G_VER" | grep '@VERSION@' > /dev/null; then # git version
Manuel Pégourié-Gonnard1287f112014-08-31 16:20:58 +020054 PEER_GNUTLS=" GnuTLS"
Manuel Pégourié-Gonnarddd459272014-10-24 12:57:37 +020055 else
56 eval $( echo $G_VER | sed 's/.* \([0-9]*\)\.\([0-9]\)*\.\([0-9]*\)$/MAJOR="\1" MINOR="\2" PATCH="\3"/' )
57 if [ $MAJOR -lt 3 -o \
58 \( $MAJOR -eq 3 -a $MINOR -lt 2 \) -o \
59 \( $MAJOR -eq 3 -a $MINOR -eq 2 -a $PATCH -lt 15 \) ]
60 then
61 PEER_GNUTLS=""
62 else
63 PEER_GNUTLS=" GnuTLS"
Manuel Pégourié-Gonnardc36b4322018-06-14 13:14:29 +020064 if [ $MINOR -lt 4 ]; then
65 GNUTLS_MINOR_LT_FOUR='x'
66 fi
Manuel Pégourié-Gonnarddd459272014-10-24 12:57:37 +020067 fi
Manuel Pégourié-Gonnard1287f112014-08-31 16:20:58 +020068 fi
69else
70 PEER_GNUTLS=""
71fi
72
Yanray Wangad470632023-02-20 14:58:03 +080073guess_config_name() {
74 if git diff --quiet ../include/mbedtls/mbedtls_config.h 2>/dev/null; then
75 echo "default"
76 else
77 echo "unknown"
78 fi
79}
80: ${MBEDTLS_TEST_OUTCOME_FILE=}
81: ${MBEDTLS_TEST_CONFIGURATION:="$(guess_config_name)"}
82: ${MBEDTLS_TEST_PLATFORM:="$(uname -s | tr -c \\n0-9A-Za-z _)-$(uname -m | tr -c \\n0-9A-Za-z _)"}
83
Manuel Pégourié-Gonnarda1a9f9a2014-03-25 18:04:59 +010084# default values for options
Manuel Pégourié-Gonnard636b5f12022-04-14 09:21:56 +020085# /!\ keep this synchronised with:
86# - basic-build-test.sh
87# - all.sh (multiple components)
Xiaofei Bai8b5c3822021-12-02 08:43:35 +000088MODES="tls12 dtls12"
Paul Bakker1eeceae2012-11-23 14:25:34 +010089VERIFIES="NO YES"
Manuel Pégourié-Gonnard7ebaf372013-08-27 21:03:33 +020090TYPES="ECDSA RSA PSK"
Paul Bakkeraccd4eb2013-07-19 13:41:51 +020091FILTER=""
Manuel Pégourié-Gonnard636b5f12022-04-14 09:21:56 +020092# By default, exclude:
93# - NULL: excluded from our default config + requires OpenSSL legacy
Manuel Pégourié-Gonnard4111b732022-04-06 13:21:59 +020094# - ARIA: requires OpenSSL >= 1.1.1
Manuel Pégourié-Gonnard9fece7e2018-06-18 11:38:22 +020095# - ChachaPoly: requires OpenSSL >= 1.1.0
Yanray Wang20fa2ae2023-01-13 18:00:10 +080096EXCLUDE='NULL\|ARIA\|CHACHA20_POLY1305'
Paul Bakkeraccd4eb2013-07-19 13:41:51 +020097VERBOSE=""
Manuel Pégourié-Gonnard3eec6042014-02-27 15:37:24 +010098MEMCHECK=0
Gilles Peskinec75048c2024-05-17 11:55:15 +020099MIN_TESTS=1
Gilles Peskine17838702023-08-28 17:36:22 +0200100PRESERVE_LOGS=0
Manuel Pégourié-Gonnarde4f6edc2015-01-22 16:43:54 +0000101PEERS="OpenSSL$PEER_GNUTLS mbedTLS"
Paul Bakkeraccd4eb2013-07-19 13:41:51 +0200102
Manuel Pégourié-Gonnard39e2ca92015-08-04 16:43:37 +0200103# hidden option: skip DTLS with OpenSSL
104# (travis CI has a version that doesn't work for us)
105: ${OSSL_NO_DTLS:=0}
106
Manuel Pégourié-Gonnard9dea8bd2014-02-26 18:21:02 +0100107print_usage() {
108 echo "Usage: $0"
Manuel Pégourié-Gonnardf46f1282014-12-11 11:51:28 +0100109 printf " -h|--help\tPrint this help.\n"
Gilles Peskine231befa2020-08-26 20:05:11 +0200110 printf " -f|--filter\tOnly matching ciphersuites are tested (Default: '%s')\n" "$FILTER"
111 printf " -e|--exclude\tMatching ciphersuites are excluded (Default: '%s')\n" "$EXCLUDE"
112 printf " -m|--modes\tWhich modes to perform (Default: '%s')\n" "$MODES"
113 printf " -t|--types\tWhich key exchange type to perform (Default: '%s')\n" "$TYPES"
114 printf " -V|--verify\tWhich verification modes to perform (Default: '%s')\n" "$VERIFIES"
115 printf " -p|--peers\tWhich peers to use (Default: '%s')\n" "$PEERS"
Manuel Pégourié-Gonnardf46f1282014-12-11 11:51:28 +0100116 printf " \tAlso available: GnuTLS (needs v3.2.15 or higher)\n"
117 printf " -M|--memcheck\tCheck memory leaks and errors.\n"
118 printf " -v|--verbose\tSet verbose output.\n"
Tomás González12787c92023-09-04 10:26:00 +0100119 printf " --list-test-cases\tList all potential test cases (No Execution)\n"
Gilles Peskinec75048c2024-05-17 11:55:15 +0200120 printf " --min \tMinimum number of non-skipped tests (default 1)\n"
Yanray Wangad470632023-02-20 14:58:03 +0800121 printf " --outcome-file\tFile where test outcomes are written\n"
122 printf " \t(default: \$MBEDTLS_TEST_OUTCOME_FILE, none if empty)\n"
Gilles Peskine17838702023-08-28 17:36:22 +0200123 printf " --preserve-logs\tPreserve logs of successful tests as well\n"
Yanray Wangd8938372023-02-23 10:04:58 +0800124}
125
Yanray Wangfb784b22023-03-02 11:55:55 +0800126# print_test_case <CLIENT> <SERVER> <STANDARD_CIPHER_SUITE>
127print_test_case() {
128 for i in $3; do
129 uniform_title $1 $2 $i
Pengyu Lv3c170d32023-11-29 13:53:34 +0800130 echo "compat;$TITLE"
Yanray Wangfb784b22023-03-02 11:55:55 +0800131 done
132}
133
Tomás González4fc58242023-09-20 22:14:06 +0100134# list_test_cases lists all potential test cases in compat.sh without execution
135list_test_cases() {
Yanray Wangd8938372023-02-23 10:04:58 +0800136 for TYPE in $TYPES; do
Pengyu Lvd36bc982023-12-01 14:23:27 +0800137 reset_ciphersuites
Yanray Wangd8938372023-02-23 10:04:58 +0800138 add_common_ciphersuites
139 add_openssl_ciphersuites
140 add_gnutls_ciphersuites
141 add_mbedtls_ciphersuites
Yanray Wangd8938372023-02-23 10:04:58 +0800142
Pengyu Lvd36bc982023-12-01 14:23:27 +0800143 # PSK cipher suites do not allow client certificate verification.
144 SUB_VERIFIES=$VERIFIES
145 if [ "$TYPE" = "PSK" ]; then
146 SUB_VERIFIES="NO"
147 fi
148
149 for VERIFY in $SUB_VERIFIES; do
150 VERIF=$(echo $VERIFY | tr '[:upper:]' '[:lower:]')
151 for MODE in $MODES; do
Pengyu Lvd36bc982023-12-01 14:23:27 +0800152 print_test_case m O "$O_CIPHERS"
153 print_test_case O m "$O_CIPHERS"
154 print_test_case m G "$G_CIPHERS"
Pengyu Lva8342a72023-12-01 14:25:40 +0800155 print_test_case G m "$G_CIPHERS"
Pengyu Lvd36bc982023-12-01 14:23:27 +0800156 print_test_case m m "$M_CIPHERS"
157 done
Yanray Wangd8938372023-02-23 10:04:58 +0800158 done
159 done
Manuel Pégourié-Gonnard9dea8bd2014-02-26 18:21:02 +0100160}
161
162get_options() {
163 while [ $# -gt 0 ]; do
164 case "$1" in
165 -f|--filter)
166 shift; FILTER=$1
167 ;;
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +0100168 -e|--exclude)
169 shift; EXCLUDE=$1
170 ;;
Manuel Pégourié-Gonnard9dea8bd2014-02-26 18:21:02 +0100171 -m|--modes)
172 shift; MODES=$1
173 ;;
174 -t|--types)
175 shift; TYPES=$1
176 ;;
177 -V|--verify)
178 shift; VERIFIES=$1
179 ;;
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +0100180 -p|--peers)
181 shift; PEERS=$1
182 ;;
Manuel Pégourié-Gonnard9dea8bd2014-02-26 18:21:02 +0100183 -v|--verbose)
184 VERBOSE=1
185 ;;
Manuel Pégourié-Gonnard3eec6042014-02-27 15:37:24 +0100186 -M|--memcheck)
187 MEMCHECK=1
188 ;;
Yanray Wangcdc07082023-03-03 17:12:29 +0800189 # Please check scripts/check_test_cases.py correspondingly
Tomás González4a86da22023-09-01 17:41:16 +0100190 # if you have to modify option, --list-test-cases
191 --list-test-cases)
Tomás González4fc58242023-09-20 22:14:06 +0100192 list_test_cases
Yanray Wang14e052f2023-03-06 19:37:07 +0800193 exit $?
Yanray Wangd8938372023-02-23 10:04:58 +0800194 ;;
Gilles Peskinec75048c2024-05-17 11:55:15 +0200195 --min)
196 shift; MIN_TESTS=$1
197 ;;
Yanray Wangad470632023-02-20 14:58:03 +0800198 --outcome-file)
199 shift; MBEDTLS_TEST_OUTCOME_FILE=$1
200 ;;
Gilles Peskine17838702023-08-28 17:36:22 +0200201 --preserve-logs)
202 PRESERVE_LOGS=1
203 ;;
Manuel Pégourié-Gonnard9dea8bd2014-02-26 18:21:02 +0100204 -h|--help)
205 print_usage
206 exit 0
207 ;;
208 *)
209 echo "Unknown argument: '$1'"
210 print_usage
211 exit 1
212 ;;
213 esac
214 shift
215 done
Manuel Pégourié-Gonnard85a41782014-10-24 12:47:26 +0200216
217 # sanitize some options (modes checked later)
218 VERIFIES="$( echo $VERIFIES | tr [a-z] [A-Z] )"
219 TYPES="$( echo $TYPES | tr [a-z] [A-Z] )"
Manuel Pégourié-Gonnard9dea8bd2014-02-26 18:21:02 +0100220}
Paul Bakkeraccd4eb2013-07-19 13:41:51 +0200221
Manuel Pégourié-Gonnard95957712014-02-19 15:29:38 +0100222log() {
Paul Bakkeraccd4eb2013-07-19 13:41:51 +0200223 if [ "X" != "X$VERBOSE" ]; then
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100224 echo ""
Paul Bakkeraccd4eb2013-07-19 13:41:51 +0200225 echo "$@"
226 fi
227}
Paul Bakker10cd2252012-04-12 21:26:34 +0000228
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100229# is_dtls <mode>
230is_dtls()
231{
Xiaofei Bai8b5c3822021-12-02 08:43:35 +0000232 test "$1" = "dtls12"
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100233}
234
235# minor_ver <mode>
236minor_ver()
237{
238 case "$1" in
Xiaofei Bai8b5c3822021-12-02 08:43:35 +0000239 tls12|dtls12)
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100240 echo 3
241 ;;
242 *)
243 echo "error: invalid mode: $MODE" >&2
244 # exiting is no good here, typically called in a subshell
245 echo -1
246 esac
247}
248
Manuel Pégourié-Gonnarddfc8d5a2013-08-27 20:48:40 +0200249filter()
250{
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +0100251 LIST="$1"
Manuel Pégourié-Gonnarddfc8d5a2013-08-27 20:48:40 +0200252 NEW_LIST=""
253
Mateusz Starzyk5224e292021-02-22 14:36:29 +0100254 EXCLMODE="$EXCLUDE"
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100255
Manuel Pégourié-Gonnarddfc8d5a2013-08-27 20:48:40 +0200256 for i in $LIST;
257 do
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100258 NEW_LIST="$NEW_LIST $( echo "$i" | grep "$FILTER" | grep -v "$EXCLMODE" )"
Manuel Pégourié-Gonnarddfc8d5a2013-08-27 20:48:40 +0200259 done
260
Manuel Pégourié-Gonnard911622d2014-02-27 11:50:40 +0100261 # normalize whitespace
Manuel Pégourié-Gonnardf46f1282014-12-11 11:51:28 +0100262 echo "$NEW_LIST" | sed -e 's/[[:space:]][[:space:]]*/ /g' -e 's/^ //' -e 's/ $//'
Manuel Pégourié-Gonnarddfc8d5a2013-08-27 20:48:40 +0200263}
264
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100265filter_ciphersuites()
266{
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +0100267 if [ "X" != "X$FILTER" -o "X" != "X$EXCLUDE" ];
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100268 then
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200269 # Ciphersuite for Mbed TLS
Simon Butcherac22d112016-09-04 22:31:09 +0100270 M_CIPHERS=$( filter "$M_CIPHERS" )
271
272 # Ciphersuite for OpenSSL
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +0100273 O_CIPHERS=$( filter "$O_CIPHERS" )
Simon Butcherac22d112016-09-04 22:31:09 +0100274
275 # Ciphersuite for GnuTLS
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +0100276 G_CIPHERS=$( filter "$G_CIPHERS" )
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100277 fi
278}
279
280reset_ciphersuites()
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100281{
Simon Butcherac22d112016-09-04 22:31:09 +0100282 M_CIPHERS=""
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100283 O_CIPHERS=""
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100284 G_CIPHERS=""
285}
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100286
Gilles Peskine47aab852023-01-26 21:16:34 +0100287# translate_ciphers {g|m|o} {STANDARD_CIPHER_SUITE_NAME...}
288# Set $ciphers to the cipher suite name translations for the specified
289# program (gnutls, mbedtls or openssl). $ciphers is a space-separated
290# list of entries of the form "STANDARD_NAME=PROGRAM_NAME".
291translate_ciphers()
Joe Subbianic3610ba2021-07-29 11:35:59 +0100292{
Gilles Peskine47aab852023-01-26 21:16:34 +0100293 ciphers=$(scripts/translate_ciphers.py "$@")
294 if [ $? -ne 0 ]; then
Joe Subbiani439a6962021-07-29 12:51:09 +0100295 echo "translate_ciphers.py failed with exit code $1" >&2
296 echo "$2" >&2
Joe Subbianic3610ba2021-07-29 11:35:59 +0100297 exit 1
298 fi
299}
300
Manuel Pégourié-Gonnard7299dfd2018-02-15 11:43:55 +0100301# Ciphersuites that can be used with all peers.
302# Since we currently have three possible peers, each ciphersuite should appear
303# three times: in each peer's list (with the name that this peer uses).
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +0100304add_common_ciphersuites()
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100305{
Joe Subbiani34d62622021-07-27 14:55:56 +0100306 CIPHERS=""
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100307 case $TYPE in
308
309 "ECDSA")
Joe Subbiani9f847612021-08-10 10:41:13 +0100310 CIPHERS="$CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800311 TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA \
312 TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 \
313 TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 \
314 TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA \
315 TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 \
316 TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 \
317 TLS_ECDHE_ECDSA_WITH_NULL_SHA \
Joe Subbiani9f847612021-08-10 10:41:13 +0100318 "
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100319 ;;
320
321 "RSA")
Joe Subbiani34d62622021-07-27 14:55:56 +0100322 CIPHERS="$CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800323 TLS_DHE_RSA_WITH_AES_128_CBC_SHA \
324 TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 \
325 TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 \
326 TLS_DHE_RSA_WITH_AES_256_CBC_SHA \
327 TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 \
328 TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 \
329 TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA \
330 TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA \
331 TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA \
332 TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 \
333 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 \
334 TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA \
335 TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 \
336 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 \
337 TLS_ECDHE_RSA_WITH_NULL_SHA \
338 TLS_RSA_WITH_AES_128_CBC_SHA \
339 TLS_RSA_WITH_AES_128_CBC_SHA256 \
340 TLS_RSA_WITH_AES_128_GCM_SHA256 \
341 TLS_RSA_WITH_AES_256_CBC_SHA \
342 TLS_RSA_WITH_AES_256_CBC_SHA256 \
343 TLS_RSA_WITH_AES_256_GCM_SHA384 \
344 TLS_RSA_WITH_CAMELLIA_128_CBC_SHA \
345 TLS_RSA_WITH_CAMELLIA_256_CBC_SHA \
346 TLS_RSA_WITH_NULL_MD5 \
347 TLS_RSA_WITH_NULL_SHA \
348 TLS_RSA_WITH_NULL_SHA256 \
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +0100349 "
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100350 ;;
351
352 "PSK")
Joe Subbiani34d62622021-07-27 14:55:56 +0100353 CIPHERS="$CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800354 TLS_PSK_WITH_AES_128_CBC_SHA \
355 TLS_PSK_WITH_AES_256_CBC_SHA \
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100356 "
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100357 ;;
358 esac
Joe Subbiani34d62622021-07-27 14:55:56 +0100359
Yanray Wang20fa2ae2023-01-13 18:00:10 +0800360 O_CIPHERS="$O_CIPHERS $CIPHERS"
361 G_CIPHERS="$G_CIPHERS $CIPHERS"
Joe Subbiani34d62622021-07-27 14:55:56 +0100362 M_CIPHERS="$M_CIPHERS $CIPHERS"
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100363}
364
Manuel Pégourié-Gonnard7299dfd2018-02-15 11:43:55 +0100365# Ciphersuites usable only with Mbed TLS and OpenSSL
Yanray Wang20fa2ae2023-01-13 18:00:10 +0800366# A list of ciphersuites in the standard naming convention is appended
367# to the list of Mbed TLS ciphersuites $M_CIPHERS and
368# to the list of OpenSSL ciphersuites $O_CIPHERS respectively.
369# Based on client's naming convention, all ciphersuite names will be
370# translated into another naming format before sent to the client.
Manuel Pégourié-Gonnard7299dfd2018-02-15 11:43:55 +0100371#
372# NOTE: for some reason RSA-PSK doesn't work with OpenSSL,
Manuel Pégourié-Gonnardce5673c2018-03-06 09:54:10 +0100373# so RSA-PSK ciphersuites need to go in other sections, see
Dave Rodgman017a1992022-03-31 14:07:01 +0100374# https://github.com/Mbed-TLS/mbedtls/issues/1419
Manuel Pégourié-Gonnard9fece7e2018-06-18 11:38:22 +0200375#
376# ChachaPoly suites are here rather than in "common", as they were added in
377# GnuTLS in 3.5.0 and the CI only has 3.4.x so far.
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +0100378add_openssl_ciphersuites()
379{
Joe Subbiani34d62622021-07-27 14:55:56 +0100380 CIPHERS=""
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +0100381 case $TYPE in
382
383 "ECDSA")
Joe Subbiani32df1452021-08-13 13:30:36 +0100384 CIPHERS="$CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800385 TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA \
386 TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 \
387 TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 \
388 TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA \
389 TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 \
390 TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 \
391 TLS_ECDH_ECDSA_WITH_NULL_SHA \
392 TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256 \
393 TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384 \
394 TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 \
Joe Subbiani9f847612021-08-10 10:41:13 +0100395 "
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +0100396 ;;
397
398 "RSA")
Joe Subbiani32df1452021-08-13 13:30:36 +0100399 CIPHERS="$CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800400 TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256 \
401 TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384 \
402 TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256 \
403 TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256 \
404 TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384 \
405 TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 \
406 TLS_RSA_WITH_ARIA_128_GCM_SHA256 \
407 TLS_RSA_WITH_ARIA_256_GCM_SHA384 \
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +0100408 "
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +0100409 ;;
410
411 "PSK")
Joe Subbiani9f847612021-08-10 10:41:13 +0100412 CIPHERS="$CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800413 TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256 \
414 TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384 \
415 TLS_DHE_PSK_WITH_CHACHA20_POLY1305_SHA256 \
416 TLS_ECDHE_PSK_WITH_CHACHA20_POLY1305_SHA256 \
417 TLS_PSK_WITH_ARIA_128_GCM_SHA256 \
418 TLS_PSK_WITH_ARIA_256_GCM_SHA384 \
419 TLS_PSK_WITH_CHACHA20_POLY1305_SHA256 \
Joe Subbiani9f847612021-08-10 10:41:13 +0100420 "
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +0100421 ;;
422 esac
Joe Subbiani34d62622021-07-27 14:55:56 +0100423
Yanray Wang20fa2ae2023-01-13 18:00:10 +0800424 O_CIPHERS="$O_CIPHERS $CIPHERS"
Joe Subbiani34d62622021-07-27 14:55:56 +0100425 M_CIPHERS="$M_CIPHERS $CIPHERS"
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +0100426}
427
Manuel Pégourié-Gonnard7299dfd2018-02-15 11:43:55 +0100428# Ciphersuites usable only with Mbed TLS and GnuTLS
Yanray Wang20fa2ae2023-01-13 18:00:10 +0800429# A list of ciphersuites in the standard naming convention is appended
430# to the list of Mbed TLS ciphersuites $M_CIPHERS and
431# to the list of GnuTLS ciphersuites $G_CIPHERS respectively.
432# Based on client's naming convention, all ciphersuite names will be
433# translated into another naming format before sent to the client.
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100434add_gnutls_ciphersuites()
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100435{
Joe Subbiani34d62622021-07-27 14:55:56 +0100436 CIPHERS=""
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100437 case $TYPE in
438
439 "ECDSA")
Joe Subbiani9f847612021-08-10 10:41:13 +0100440 CIPHERS="$CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800441 TLS_ECDHE_ECDSA_WITH_AES_128_CCM \
442 TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8 \
443 TLS_ECDHE_ECDSA_WITH_AES_256_CCM \
444 TLS_ECDHE_ECDSA_WITH_AES_256_CCM_8 \
445 TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256 \
446 TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256 \
447 TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384 \
448 TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384 \
Joe Subbiani9f847612021-08-10 10:41:13 +0100449 "
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100450 ;;
451
452 "RSA")
Joe Subbiani9f847612021-08-10 10:41:13 +0100453 CIPHERS="$CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800454 TLS_DHE_RSA_WITH_AES_128_CCM \
455 TLS_DHE_RSA_WITH_AES_128_CCM_8 \
456 TLS_DHE_RSA_WITH_AES_256_CCM \
457 TLS_DHE_RSA_WITH_AES_256_CCM_8 \
458 TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256 \
459 TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256 \
460 TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256 \
461 TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384 \
462 TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256 \
463 TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256 \
464 TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384 \
465 TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384 \
466 TLS_RSA_WITH_AES_128_CCM \
467 TLS_RSA_WITH_AES_128_CCM_8 \
468 TLS_RSA_WITH_AES_256_CCM \
469 TLS_RSA_WITH_AES_256_CCM_8 \
470 TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256 \
471 TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256 \
472 TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256 \
473 TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384 \
Joe Subbiani9f847612021-08-10 10:41:13 +0100474 "
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100475 ;;
476
477 "PSK")
Joe Subbiani9f847612021-08-10 10:41:13 +0100478 CIPHERS="$CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800479 TLS_DHE_PSK_WITH_AES_128_CBC_SHA \
480 TLS_DHE_PSK_WITH_AES_128_CBC_SHA256 \
481 TLS_DHE_PSK_WITH_AES_128_CCM \
482 TLS_DHE_PSK_WITH_AES_128_CCM_8 \
483 TLS_DHE_PSK_WITH_AES_128_GCM_SHA256 \
484 TLS_DHE_PSK_WITH_AES_256_CBC_SHA \
485 TLS_DHE_PSK_WITH_AES_256_CBC_SHA384 \
486 TLS_DHE_PSK_WITH_AES_256_CCM \
487 TLS_DHE_PSK_WITH_AES_256_CCM_8 \
488 TLS_DHE_PSK_WITH_AES_256_GCM_SHA384 \
489 TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256 \
490 TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256 \
491 TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384 \
492 TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384 \
493 TLS_DHE_PSK_WITH_NULL_SHA256 \
494 TLS_DHE_PSK_WITH_NULL_SHA384 \
495 TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA \
496 TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256 \
497 TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA \
498 TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384 \
499 TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256 \
500 TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384 \
501 TLS_ECDHE_PSK_WITH_NULL_SHA256 \
502 TLS_ECDHE_PSK_WITH_NULL_SHA384 \
503 TLS_PSK_WITH_AES_128_CBC_SHA256 \
504 TLS_PSK_WITH_AES_128_CCM \
505 TLS_PSK_WITH_AES_128_CCM_8 \
506 TLS_PSK_WITH_AES_128_GCM_SHA256 \
507 TLS_PSK_WITH_AES_256_CBC_SHA384 \
508 TLS_PSK_WITH_AES_256_CCM \
509 TLS_PSK_WITH_AES_256_CCM_8 \
510 TLS_PSK_WITH_AES_256_GCM_SHA384 \
511 TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256 \
512 TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256 \
513 TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384 \
514 TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384 \
515 TLS_PSK_WITH_NULL_SHA256 \
516 TLS_PSK_WITH_NULL_SHA384 \
517 TLS_RSA_PSK_WITH_AES_128_CBC_SHA \
518 TLS_RSA_PSK_WITH_AES_128_CBC_SHA256 \
519 TLS_RSA_PSK_WITH_AES_128_GCM_SHA256 \
520 TLS_RSA_PSK_WITH_AES_256_CBC_SHA \
521 TLS_RSA_PSK_WITH_AES_256_CBC_SHA384 \
522 TLS_RSA_PSK_WITH_AES_256_GCM_SHA384 \
523 TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256 \
524 TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256 \
525 TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384 \
526 TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384 \
527 TLS_RSA_PSK_WITH_NULL_SHA256 \
528 TLS_RSA_PSK_WITH_NULL_SHA384 \
Manuel Pégourié-Gonnarde46aa5e2014-07-13 15:44:19 +0200529 "
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100530 ;;
531 esac
Joe Subbiani43592bd2021-07-27 16:32:21 +0100532
Yanray Wang20fa2ae2023-01-13 18:00:10 +0800533 G_CIPHERS="$G_CIPHERS $CIPHERS"
Joe Subbiani34d62622021-07-27 14:55:56 +0100534 M_CIPHERS="$M_CIPHERS $CIPHERS"
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100535}
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100536
Manuel Pégourié-Gonnard7299dfd2018-02-15 11:43:55 +0100537# Ciphersuites usable only with Mbed TLS (not currently supported by another
Yanray Wang20fa2ae2023-01-13 18:00:10 +0800538# peer usable in this script). This provides only very rudimentaty testing, as
Manuel Pégourié-Gonnard7299dfd2018-02-15 11:43:55 +0100539# this is not interop testing, but it's better than nothing.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200540add_mbedtls_ciphersuites()
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100541{
542 case $TYPE in
543
544 "ECDSA")
Joe Subbiani9f847612021-08-10 10:41:13 +0100545 M_CIPHERS="$M_CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800546 TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256 \
547 TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256 \
548 TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384 \
549 TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384 \
550 TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256 \
551 TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256 \
552 TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384 \
553 TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384 \
554 TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256 \
555 TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384 \
Joe Subbiani9f847612021-08-10 10:41:13 +0100556 "
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100557 ;;
558
559 "RSA")
Joe Subbiani9f847612021-08-10 10:41:13 +0100560 M_CIPHERS="$M_CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800561 TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256 \
562 TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384 \
563 TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256 \
564 TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384 \
565 TLS_RSA_WITH_ARIA_128_CBC_SHA256 \
566 TLS_RSA_WITH_ARIA_256_CBC_SHA384 \
Joe Subbiani9f847612021-08-10 10:41:13 +0100567 "
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100568 ;;
569
570 "PSK")
Yanray Wangd5f99e42023-01-11 10:11:23 +0800571 # *PSK_NULL_SHA suites supported by GnuTLS 3.3.5 but not 3.2.15
Joe Subbiani9f847612021-08-10 10:41:13 +0100572 M_CIPHERS="$M_CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800573 TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256 \
574 TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384 \
575 TLS_DHE_PSK_WITH_NULL_SHA \
576 TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256 \
577 TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384 \
578 TLS_ECDHE_PSK_WITH_NULL_SHA \
579 TLS_PSK_WITH_ARIA_128_CBC_SHA256 \
580 TLS_PSK_WITH_ARIA_256_CBC_SHA384 \
581 TLS_PSK_WITH_NULL_SHA \
582 TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256 \
583 TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256 \
584 TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384 \
585 TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384 \
586 TLS_RSA_PSK_WITH_CHACHA20_POLY1305_SHA256 \
587 TLS_RSA_PSK_WITH_NULL_SHA \
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100588 "
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100589 ;;
590 esac
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100591}
592
Pengyu Lv1c0e4c02023-02-20 18:05:21 +0800593# o_check_ciphersuite STANDARD_CIPHER_SUITE
594o_check_ciphersuite()
595{
Manuel Pégourié-Gonnard84882542024-04-10 12:26:24 +0200596 # skip DTLS when lack of support was declared
597 if test "$OSSL_NO_DTLS" -gt 0 && is_dtls "$MODE"; then
598 SKIP_NEXT_="YES"
599 fi
600
Manuel Pégourié-Gonnard48395bc2024-04-10 22:11:20 +0200601 # skip DTLS 1.2 is support was not detected
602 if [ "$O_SUPPORT_DTLS12" = "NO" -a "$MODE" = "dtls12" ]; then
603 SKIP_NEXT="YES"
Manuel Pégourié-Gonnard84882542024-04-10 12:26:24 +0200604 fi
605
606 # skip static ECDH when OpenSSL doesn't support it
607 if [ "${O_SUPPORT_STATIC_ECDH}" = "NO" ]; then
Pengyu Lva64c2772023-02-22 09:30:20 +0800608 case "$1" in
609 *ECDH_*) SKIP_NEXT="YES"
610 esac
Pengyu Lv1c0e4c02023-02-20 18:05:21 +0800611 fi
612}
613
Manuel Pégourié-Gonnardd941a792014-02-19 13:35:52 +0100614setup_arguments()
615{
David Horstmann79c8a652024-07-01 16:52:57 +0100616 DATA_FILES_PATH="../framework/data_files"
617
Ronald Cron2c74ff62022-03-11 17:15:23 +0100618 O_MODE=""
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100619 G_MODE=""
620 case "$MODE" in
Xiaofei Bai8b5c3822021-12-02 08:43:35 +0000621 "tls12")
Ronald Cron2c74ff62022-03-11 17:15:23 +0100622 O_MODE="tls1_2"
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100623 G_PRIO_MODE="+VERS-TLS1.2"
Manuel Pégourié-Gonnard9ada01a2014-02-19 14:24:24 +0100624 ;;
Xiaofei Bai8b5c3822021-12-02 08:43:35 +0000625 "dtls12")
Ronald Cron2c74ff62022-03-11 17:15:23 +0100626 O_MODE="dtls1_2"
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100627 G_PRIO_MODE="+VERS-DTLS1.2"
Manuel Pégourié-Gonnard36795192014-09-26 16:33:45 +0200628 G_MODE="-u"
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100629 ;;
Manuel Pégourié-Gonnard9ada01a2014-02-19 14:24:24 +0100630 *)
631 echo "error: invalid mode: $MODE" >&2
632 exit 1;
633 esac
634
Manuel Pégourié-Gonnardc36b4322018-06-14 13:14:29 +0200635 # GnuTLS < 3.4 will choke if we try to allow CCM-8
636 if [ -z "${GNUTLS_MINOR_LT_FOUR-}" ]; then
637 G_PRIO_CCM="+AES-256-CCM-8:+AES-128-CCM-8:"
638 else
639 G_PRIO_CCM=""
640 fi
641
Mateusz Starzyk5224e292021-02-22 14:36:29 +0100642 M_SERVER_ARGS="server_port=$PORT server_addr=0.0.0.0 force_version=$MODE"
Gilles Peskine5f5e3882023-08-27 21:32:36 +0200643 O_SERVER_ARGS="-accept $PORT -cipher ALL,COMPLEMENTOFALL -$O_MODE"
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100644 G_SERVER_ARGS="-p $PORT --http $G_MODE"
Mateusz Starzyk5224e292021-02-22 14:36:29 +0100645 G_SERVER_PRIO="NORMAL:${G_PRIO_CCM}+NULL:+MD5:+PSK:+DHE-PSK:+ECDHE-PSK:+SHA256:+SHA384:+RSA-PSK:-VERS-TLS-ALL:$G_PRIO_MODE"
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100646
Gilles Peskine96f5bae2021-04-01 14:00:11 +0200647 # The default prime for `openssl s_server` depends on the version:
648 # * OpenSSL <= 1.0.2a: 512-bit
649 # * OpenSSL 1.0.2b to 1.1.1b: 1024-bit
650 # * OpenSSL >= 1.1.1c: 2048-bit
651 # Mbed TLS wants >=1024, so force that for older versions. Don't force
652 # it for newer versions, which reject a 1024-bit prime. Indifferently
653 # force it or not for intermediate versions.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100654 case $($OPENSSL version) in
Gilles Peskine96f5bae2021-04-01 14:00:11 +0200655 "OpenSSL 1.0"*)
David Horstmann79c8a652024-07-01 16:52:57 +0100656 O_SERVER_ARGS="$O_SERVER_ARGS -dhparam $DATA_FILES_PATH/dhparams.pem"
Gilles Peskine96f5bae2021-04-01 14:00:11 +0200657 ;;
658 esac
659
Manuel Pégourié-Gonnardd1af1022014-07-11 17:01:06 +0200660 # with OpenSSL 1.0.1h, -www, -WWW and -HTTP break DTLS handshakes
661 if is_dtls "$MODE"; then
Manuel Pégourié-Gonnard36795192014-09-26 16:33:45 +0200662 O_SERVER_ARGS="$O_SERVER_ARGS"
Manuel Pégourié-Gonnardd1af1022014-07-11 17:01:06 +0200663 else
664 O_SERVER_ARGS="$O_SERVER_ARGS -www"
665 fi
666
Simon Butcherac22d112016-09-04 22:31:09 +0100667 M_CLIENT_ARGS="server_port=$PORT server_addr=127.0.0.1 force_version=$MODE"
Ronald Cron2c74ff62022-03-11 17:15:23 +0100668 O_CLIENT_ARGS="-connect localhost:$PORT -$O_MODE"
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100669 G_CLIENT_ARGS="-p $PORT --debug 3 $G_MODE"
Manuel Pégourié-Gonnard9ada01a2014-02-19 14:24:24 +0100670
Gilles Peskine4bdb9fb2022-11-24 22:21:15 +0100671 # Newer versions of OpenSSL have a syntax to enable all "ciphers", even
672 # low-security ones. This covers not just cipher suites but also protocol
673 # versions. It is necessary, for example, to use (D)TLS 1.0/1.1 on
674 # OpenSSL 1.1.1f from Ubuntu 20.04. The syntax was only introduced in
675 # OpenSSL 1.1.0 (21e0c1d23afff48601eb93135defddae51f7e2e3) and I can't find
676 # a way to discover it from -help, so check the openssl version.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100677 case $($OPENSSL version) in
Gilles Peskine4bdb9fb2022-11-24 22:21:15 +0100678 "OpenSSL 0"*|"OpenSSL 1.0"*) :;;
679 *)
680 O_CLIENT_ARGS="$O_CLIENT_ARGS -cipher ALL@SECLEVEL=0"
681 O_SERVER_ARGS="$O_SERVER_ARGS -cipher ALL@SECLEVEL=0"
682 ;;
683 esac
684
Pengyu Lv1c0e4c02023-02-20 18:05:21 +0800685 case $($OPENSSL ciphers ALL) in
Manuel Pégourié-Gonnard84882542024-04-10 12:26:24 +0200686 *ECDH-ECDSA*|*ECDH-RSA*) O_SUPPORT_STATIC_ECDH="YES";;
687 *) O_SUPPORT_STATIC_ECDH="NO";;
Pengyu Lv1c0e4c02023-02-20 18:05:21 +0800688 esac
689
Manuel Pégourié-Gonnard48395bc2024-04-10 22:11:20 +0200690 case $($OPENSSL ciphers ALL) in
691 *DES-CBC-*) O_SUPPORT_SINGLE_DES="YES";;
692 *) O_SUPPORT_SINGLE_DES="NO";;
693 esac
694
695 # OpenSSL <1.0.2 doesn't support DTLS 1.2. Check if OpenSSL
696 # supports -dtls1_2 from the s_server help. (The s_client
697 # help isn't accurate as of 1.0.2g: it supports DTLS 1.2
698 # but doesn't list it. But the s_server help seems to be
699 # accurate.)
700 O_SUPPORT_DTLS12="NO"
701 if $OPENSSL s_server -help 2>&1 | grep -q "^ *-dtls1_2 "; then
702 O_SUPPORT_DTLS12="YES"
703 fi
704
Yanray Wang30382972023-02-08 12:38:31 +0800705 if [ "X$VERIFY" = "XYES" ];
Manuel Pégourié-Gonnardd941a792014-02-19 13:35:52 +0100706 then
David Horstmann79c8a652024-07-01 16:52:57 +0100707 M_SERVER_ARGS="$M_SERVER_ARGS ca_file=$DATA_FILES_PATH/test-ca_cat12.crt auth_mode=required"
708 O_SERVER_ARGS="$O_SERVER_ARGS -CAfile $DATA_FILES_PATH/test-ca_cat12.crt -Verify 10"
709 G_SERVER_ARGS="$G_SERVER_ARGS --x509cafile $DATA_FILES_PATH/test-ca_cat12.crt --require-client-cert"
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100710
David Horstmann79c8a652024-07-01 16:52:57 +0100711 M_CLIENT_ARGS="$M_CLIENT_ARGS ca_file=$DATA_FILES_PATH/test-ca_cat12.crt auth_mode=required"
712 O_CLIENT_ARGS="$O_CLIENT_ARGS -CAfile $DATA_FILES_PATH/test-ca_cat12.crt -verify 10"
713 G_CLIENT_ARGS="$G_CLIENT_ARGS --x509cafile $DATA_FILES_PATH/test-ca_cat12.crt"
Manuel Pégourié-Gonnardda782c92014-02-21 10:10:20 +0100714 else
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100715 # don't request a client cert at all
Simon Butcherac22d112016-09-04 22:31:09 +0100716 M_SERVER_ARGS="$M_SERVER_ARGS ca_file=none auth_mode=none"
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100717 G_SERVER_ARGS="$G_SERVER_ARGS --disable-client-cert"
718
Simon Butcherac22d112016-09-04 22:31:09 +0100719 M_CLIENT_ARGS="$M_CLIENT_ARGS ca_file=none auth_mode=none"
Manuel Pégourié-Gonnard5de31ec2014-03-19 17:34:52 +0100720 O_CLIENT_ARGS="$O_CLIENT_ARGS"
721 G_CLIENT_ARGS="$G_CLIENT_ARGS --insecure"
Manuel Pégourié-Gonnardd941a792014-02-19 13:35:52 +0100722 fi
723
724 case $TYPE in
725 "ECDSA")
David Horstmann79c8a652024-07-01 16:52:57 +0100726 M_SERVER_ARGS="$M_SERVER_ARGS crt_file=$DATA_FILES_PATH/server5.crt key_file=$DATA_FILES_PATH/server5.key"
727 O_SERVER_ARGS="$O_SERVER_ARGS -cert $DATA_FILES_PATH/server5.crt -key $DATA_FILES_PATH/server5.key"
728 G_SERVER_ARGS="$G_SERVER_ARGS --x509certfile $DATA_FILES_PATH/server5.crt --x509keyfile $DATA_FILES_PATH/server5.key"
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100729
Manuel Pégourié-Gonnard1b149ef2014-02-27 14:38:29 +0100730 if [ "X$VERIFY" = "XYES" ]; then
David Horstmann79c8a652024-07-01 16:52:57 +0100731 M_CLIENT_ARGS="$M_CLIENT_ARGS crt_file=$DATA_FILES_PATH/server6.crt key_file=$DATA_FILES_PATH/server6.key"
732 O_CLIENT_ARGS="$O_CLIENT_ARGS -cert $DATA_FILES_PATH/server6.crt -key $DATA_FILES_PATH/server6.key"
733 G_CLIENT_ARGS="$G_CLIENT_ARGS --x509certfile $DATA_FILES_PATH/server6.crt --x509keyfile $DATA_FILES_PATH/server6.key"
Manuel Pégourié-Gonnard1b149ef2014-02-27 14:38:29 +0100734 else
Simon Butcherac22d112016-09-04 22:31:09 +0100735 M_CLIENT_ARGS="$M_CLIENT_ARGS crt_file=none key_file=none"
Manuel Pégourié-Gonnard1b149ef2014-02-27 14:38:29 +0100736 fi
Manuel Pégourié-Gonnardd941a792014-02-19 13:35:52 +0100737 ;;
738
739 "RSA")
David Horstmann79c8a652024-07-01 16:52:57 +0100740 M_SERVER_ARGS="$M_SERVER_ARGS crt_file=$DATA_FILES_PATH/server2-sha256.crt key_file=$DATA_FILES_PATH/server2.key"
741 O_SERVER_ARGS="$O_SERVER_ARGS -cert $DATA_FILES_PATH/server2-sha256.crt -key $DATA_FILES_PATH/server2.key"
742 G_SERVER_ARGS="$G_SERVER_ARGS --x509certfile $DATA_FILES_PATH/server2-sha256.crt --x509keyfile $DATA_FILES_PATH/server2.key"
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100743
Manuel Pégourié-Gonnard1b149ef2014-02-27 14:38:29 +0100744 if [ "X$VERIFY" = "XYES" ]; then
David Horstmann79c8a652024-07-01 16:52:57 +0100745 M_CLIENT_ARGS="$M_CLIENT_ARGS crt_file=$DATA_FILES_PATH/cert_sha256.crt key_file=$DATA_FILES_PATH/server1.key"
746 O_CLIENT_ARGS="$O_CLIENT_ARGS -cert $DATA_FILES_PATH/cert_sha256.crt -key $DATA_FILES_PATH/server1.key"
747 G_CLIENT_ARGS="$G_CLIENT_ARGS --x509certfile $DATA_FILES_PATH/cert_sha256.crt --x509keyfile $DATA_FILES_PATH/server1.key"
Manuel Pégourié-Gonnard1b149ef2014-02-27 14:38:29 +0100748 else
Simon Butcherac22d112016-09-04 22:31:09 +0100749 M_CLIENT_ARGS="$M_CLIENT_ARGS crt_file=none key_file=none"
Manuel Pégourié-Gonnard1b149ef2014-02-27 14:38:29 +0100750 fi
Manuel Pégourié-Gonnardd941a792014-02-19 13:35:52 +0100751 ;;
752
753 "PSK")
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100754 # give RSA-PSK-capable server a RSA cert
Manuel Pégourié-Gonnard1b149ef2014-02-27 14:38:29 +0100755 # (should be a separate type, but harder to close with openssl)
David Horstmann79c8a652024-07-01 16:52:57 +0100756 M_SERVER_ARGS="$M_SERVER_ARGS psk=6162636465666768696a6b6c6d6e6f70 ca_file=none crt_file=$DATA_FILES_PATH/server2-sha256.crt key_file=$DATA_FILES_PATH/server2.key"
Manuel Pégourié-Gonnard1b149ef2014-02-27 14:38:29 +0100757 O_SERVER_ARGS="$O_SERVER_ARGS -psk 6162636465666768696a6b6c6d6e6f70 -nocert"
David Horstmann79c8a652024-07-01 16:52:57 +0100758 G_SERVER_ARGS="$G_SERVER_ARGS --x509certfile $DATA_FILES_PATH/server2-sha256.crt --x509keyfile $DATA_FILES_PATH/server2.key --pskpasswd $DATA_FILES_PATH/passwd.psk"
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100759
Simon Butcherac22d112016-09-04 22:31:09 +0100760 M_CLIENT_ARGS="$M_CLIENT_ARGS psk=6162636465666768696a6b6c6d6e6f70 crt_file=none key_file=none"
Manuel Pégourié-Gonnard9ada01a2014-02-19 14:24:24 +0100761 O_CLIENT_ARGS="$O_CLIENT_ARGS -psk 6162636465666768696a6b6c6d6e6f70"
Manuel Pégourié-Gonnarda4371442014-03-13 16:21:59 +0100762 G_CLIENT_ARGS="$G_CLIENT_ARGS --pskusername Client_identity --pskkey=6162636465666768696a6b6c6d6e6f70"
Manuel Pégourié-Gonnardd941a792014-02-19 13:35:52 +0100763 ;;
764 esac
765}
766
Simon Butcherac22d112016-09-04 22:31:09 +0100767# is_mbedtls <cmd_line>
768is_mbedtls() {
Gilles Peskineb20028b2023-01-26 21:34:01 +0100769 case $1 in
770 *ssl_client2*) true;;
771 *ssl_server2*) true;;
772 *) false;;
773 esac
Manuel Pégourié-Gonnard3eec6042014-02-27 15:37:24 +0100774}
775
776# has_mem_err <log_file_name>
777has_mem_err() {
778 if ( grep -F 'All heap blocks were freed -- no leaks are possible' "$1" &&
779 grep -F 'ERROR SUMMARY: 0 errors from 0 contexts' "$1" ) > /dev/null
780 then
781 return 1 # false: does not have errors
782 else
783 return 0 # true: has errors
784 fi
785}
786
Gilles Peskine12c49c72017-12-14 19:02:00 +0100787# Wait for process $2 to be listening on port $1
788if type lsof >/dev/null 2>/dev/null; then
789 wait_server_start() {
790 START_TIME=$(date +%s)
791 if is_dtls "$MODE"; then
792 proto=UDP
793 else
794 proto=TCP
795 fi
796 while ! lsof -a -n -b -i "$proto:$1" -p "$2" >/dev/null 2>/dev/null; do
797 if [ $(( $(date +%s) - $START_TIME )) -gt $DOG_DELAY ]; then
798 echo "SERVERSTART TIMEOUT"
799 echo "SERVERSTART TIMEOUT" >> $SRV_OUT
800 break
801 fi
802 # Linux and *BSD support decimal arguments to sleep. On other
803 # OSes this may be a tight loop.
804 sleep 0.1 2>/dev/null || true
805 done
806 }
807else
Gilles Peskine3c9e2b52018-01-08 12:38:15 +0100808 echo "Warning: lsof not available, wait_server_start = sleep"
Gilles Peskine12c49c72017-12-14 19:02:00 +0100809 wait_server_start() {
Manuel Pégourié-Gonnard0d225da2018-01-22 10:22:09 +0100810 sleep 2
Gilles Peskine12c49c72017-12-14 19:02:00 +0100811 }
812fi
813
814
Manuel Pégourié-Gonnard304beef2014-02-19 14:45:00 +0100815# start_server <name>
816# also saves name and command
817start_server() {
Manuel Pégourié-Gonnard304beef2014-02-19 14:45:00 +0100818 case $1 in
819 [Oo]pen*)
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100820 SERVER_CMD="$OPENSSL s_server $O_SERVER_ARGS"
Manuel Pégourié-Gonnard304beef2014-02-19 14:45:00 +0100821 ;;
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100822 [Gg]nu*)
Manuel Pégourié-Gonnard74faf3c2014-03-13 18:47:44 +0100823 SERVER_CMD="$GNUTLS_SERV $G_SERVER_ARGS --priority $G_SERVER_PRIO"
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100824 ;;
Manuel Pégourié-Gonnarda8f3b752015-01-22 17:05:05 +0000825 mbed*)
Simon Butcherac22d112016-09-04 22:31:09 +0100826 SERVER_CMD="$M_SRV $M_SERVER_ARGS"
Manuel Pégourié-Gonnard3eec6042014-02-27 15:37:24 +0100827 if [ "$MEMCHECK" -gt 0 ]; then
828 SERVER_CMD="valgrind --leak-check=full $SERVER_CMD"
829 fi
Manuel Pégourié-Gonnard304beef2014-02-19 14:45:00 +0100830 ;;
831 *)
832 echo "error: invalid server name: $1" >&2
833 exit 1
834 ;;
835 esac
836 SERVER_NAME=$1
837
838 log "$SERVER_CMD"
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +0200839 echo "$SERVER_CMD" > $SRV_OUT
Manuel Pégourié-Gonnardd1af1022014-07-11 17:01:06 +0200840 # for servers without -www or equivalent
Manuel Pégourié-Gonnard82cf0a12015-02-09 13:05:54 +0000841 while :; do echo bla; sleep 1; done | $SERVER_CMD >> $SRV_OUT 2>&1 &
Yanray Wang12885972023-01-13 11:42:11 +0800842 SRV_PID=$!
Manuel Pégourié-Gonnard304beef2014-02-19 14:45:00 +0100843
Yanray Wang12885972023-01-13 11:42:11 +0800844 wait_server_start "$PORT" "$SRV_PID"
Manuel Pégourié-Gonnard304beef2014-02-19 14:45:00 +0100845}
846
Manuel Pégourié-Gonnard16494492014-08-31 10:37:14 +0200847# terminate the running server
Manuel Pégourié-Gonnard95957712014-02-19 15:29:38 +0100848stop_server() {
Yanray Wang12885972023-01-13 11:42:11 +0800849 # For Ubuntu 22.04, `Terminated` message is outputed by wait command.
850 # To remove it from stdout, redirect stdout/stderr to SRV_OUT
851 kill $SRV_PID >/dev/null 2>&1
852 wait $SRV_PID >> $SRV_OUT 2>&1
Manuel Pégourié-Gonnard3eec6042014-02-27 15:37:24 +0100853
854 if [ "$MEMCHECK" -gt 0 ]; then
Simon Butcherac22d112016-09-04 22:31:09 +0100855 if is_mbedtls "$SERVER_CMD" && has_mem_err $SRV_OUT; then
Manuel Pégourié-Gonnard3eec6042014-02-27 15:37:24 +0100856 echo " ! Server had memory errors"
Manuel Pégourié-Gonnard72e51ee2014-08-31 10:22:11 +0200857 SRVMEM=$(( $SRVMEM + 1 ))
Manuel Pégourié-Gonnard3eec6042014-02-27 15:37:24 +0100858 return
859 fi
860 fi
861
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +0200862 rm -f $SRV_OUT
Manuel Pégourié-Gonnard95957712014-02-19 15:29:38 +0100863}
864
Manuel Pégourié-Gonnarda9062e92014-02-25 16:21:22 +0100865# kill the running server (used when killed by signal)
866cleanup() {
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +0200867 rm -f $SRV_OUT $CLI_OUT
Yanray Wang12885972023-01-13 11:42:11 +0800868 kill $SRV_PID >/dev/null 2>&1
Manuel Pégourié-Gonnard16494492014-08-31 10:37:14 +0200869 kill $WATCHDOG_PID >/dev/null 2>&1
Manuel Pégourié-Gonnarda9062e92014-02-25 16:21:22 +0100870 exit 1
871}
872
Manuel Pégourié-Gonnardc0f6a692014-08-30 22:41:47 +0200873# wait for client to terminate and set EXIT
874# must be called right after starting the client
875wait_client_done() {
876 CLI_PID=$!
877
878 ( sleep "$DOG_DELAY"; echo "TIMEOUT" >> $CLI_OUT; kill $CLI_PID ) &
879 WATCHDOG_PID=$!
880
Yanray Wang05f940b2023-01-13 10:52:41 +0800881 # For Ubuntu 22.04, `Terminated` message is outputed by wait command.
882 # To remove it from stdout, redirect stdout/stderr to CLI_OUT
883 wait $CLI_PID >> $CLI_OUT 2>&1
Manuel Pégourié-Gonnardc0f6a692014-08-30 22:41:47 +0200884 EXIT=$?
885
Yanray Wang05f940b2023-01-13 10:52:41 +0800886 kill $WATCHDOG_PID >/dev/null 2>&1
887 wait $WATCHDOG_PID >> $CLI_OUT 2>&1
Manuel Pégourié-Gonnardc0f6a692014-08-30 22:41:47 +0200888
889 echo "EXIT: $EXIT" >> $CLI_OUT
890}
891
Yanray Wangfb784b22023-03-02 11:55:55 +0800892# uniform_title <CLIENT> <SERVER> <STANDARD_CIPHER_SUITE>
Tomás González4a86da22023-09-01 17:41:16 +0100893# $TITLE is considered as test case description for both --list-test-cases and
Yanray Wangfb784b22023-03-02 11:55:55 +0800894# MBEDTLS_TEST_OUTCOME_FILE. This function aims to control the format of
895# each test case description.
896uniform_title() {
897 TITLE="$1->$2 $MODE,$VERIF $3"
Yanray Wang3fcd3a72023-02-24 17:07:47 +0800898}
899
Yanray Wangad470632023-02-20 14:58:03 +0800900# record_outcome <outcome> [<failure-reason>]
901record_outcome() {
902 echo "$1"
903 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
904 # The test outcome file has the format (in single line):
905 # platform;configuration;
906 # test suite name;test case description;
907 # PASS/FAIL/SKIP;[failure cause]
908 printf '%s;%s;%s;%s;%s;%s\n' \
909 "$MBEDTLS_TEST_PLATFORM" "$MBEDTLS_TEST_CONFIGURATION" \
910 "compat" "$TITLE" \
911 "$1" "${2-}" \
912 >> "$MBEDTLS_TEST_OUTCOME_FILE"
913 fi
914}
915
Gilles Peskine17838702023-08-28 17:36:22 +0200916save_logs() {
917 cp $SRV_OUT c-srv-${TESTS}.log
918 cp $CLI_OUT c-cli-${TESTS}.log
919}
920
Yanray Wangf45a8ea2023-02-20 15:49:10 +0800921# display additional information if test case fails
922report_fail() {
Yanray Wangad470632023-02-20 14:58:03 +0800923 FAIL_PROMPT="outputs saved to c-srv-${TESTS}.log, c-cli-${TESTS}.log"
924 record_outcome "FAIL" "$FAIL_PROMPT"
Gilles Peskine17838702023-08-28 17:36:22 +0200925 save_logs
Yanray Wangad470632023-02-20 14:58:03 +0800926 echo " ! $FAIL_PROMPT"
Yanray Wangf45a8ea2023-02-20 15:49:10 +0800927
928 if [ "${LOG_FAILURE_ON_STDOUT:-0}" != 0 ]; then
929 echo " ! server output:"
930 cat c-srv-${TESTS}.log
931 echo " ! ==================================================="
932 echo " ! client output:"
933 cat c-cli-${TESTS}.log
934 fi
935}
936
Gilles Peskine47aab852023-01-26 21:16:34 +0100937# run_client PROGRAM_NAME STANDARD_CIPHER_SUITE PROGRAM_CIPHER_SUITE
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +0100938run_client() {
Manuel Pégourié-Gonnard87ae3032014-02-27 11:12:30 +0100939 # announce what we're going to do
Manuel Pégourié-Gonnard72e51ee2014-08-31 10:22:11 +0200940 TESTS=$(( $TESTS + 1 ))
Yanray Wangfb784b22023-03-02 11:55:55 +0800941 uniform_title "${1%"${1#?}"}" "${SERVER_NAME%"${SERVER_NAME#?}"}" $2
942 DOTS72="........................................................................"
943 printf "%s %.*s " "$TITLE" "$((71 - ${#TITLE}))" "$DOTS72"
Manuel Pégourié-Gonnard87ae3032014-02-27 11:12:30 +0100944
Manuel Pégourié-Gonnard53aef812014-07-11 17:41:24 +0200945 # should we skip?
946 if [ "X$SKIP_NEXT" = "XYES" ]; then
947 SKIP_NEXT="NO"
Yanray Wangad470632023-02-20 14:58:03 +0800948 record_outcome "SKIP"
Manuel Pégourié-Gonnard53aef812014-07-11 17:41:24 +0200949 SKIPPED=$(( $SKIPPED + 1 ))
950 return
951 fi
952
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +0100953 # run the command and interpret result
954 case $1 in
955 [Oo]pen*)
Gilles Peskine47aab852023-01-26 21:16:34 +0100956 CLIENT_CMD="$OPENSSL s_client $O_CLIENT_ARGS -cipher $3"
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +0100957 log "$CLIENT_CMD"
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +0200958 echo "$CLIENT_CMD" > $CLI_OUT
Manuel Pégourié-Gonnard9afdc832015-08-04 17:15:13 +0200959 printf 'GET HTTP/1.0\r\n\r\n' | $CLIENT_CMD >> $CLI_OUT 2>&1 &
Manuel Pégourié-Gonnardc0f6a692014-08-30 22:41:47 +0200960 wait_client_done
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +0100961
Manuel Pégourié-Gonnard72e51ee2014-08-31 10:22:11 +0200962 if [ $EXIT -eq 0 ]; then
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +0100963 RESULT=0
964 else
Pengyu Lv9e7bb2a2023-02-23 15:24:47 +0800965 # If it is NULL cipher ...
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +0200966 if grep 'Cipher is (NONE)' $CLI_OUT >/dev/null; then
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +0100967 RESULT=1
968 else
969 RESULT=2
970 fi
971 fi
972 ;;
973
Manuel Pégourié-Gonnarda4371442014-03-13 16:21:59 +0100974 [Gg]nu*)
Pengyu Lva8342a72023-12-01 14:25:40 +0800975 CLIENT_CMD="$GNUTLS_CLI $G_CLIENT_ARGS --priority $G_PRIO_MODE:$3 localhost"
Manuel Pégourié-Gonnarda4371442014-03-13 16:21:59 +0100976 log "$CLIENT_CMD"
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +0200977 echo "$CLIENT_CMD" > $CLI_OUT
Manuel Pégourié-Gonnard9afdc832015-08-04 17:15:13 +0200978 printf 'GET HTTP/1.0\r\n\r\n' | $CLIENT_CMD >> $CLI_OUT 2>&1 &
Manuel Pégourié-Gonnardc0f6a692014-08-30 22:41:47 +0200979 wait_client_done
Manuel Pégourié-Gonnarda4371442014-03-13 16:21:59 +0100980
Manuel Pégourié-Gonnard72e51ee2014-08-31 10:22:11 +0200981 if [ $EXIT -eq 0 ]; then
Manuel Pégourié-Gonnarda4371442014-03-13 16:21:59 +0100982 RESULT=0
983 else
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +0100984 RESULT=2
985 # interpret early failure, with a handshake_failure alert
986 # before the server hello, as "no ciphersuite in common"
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +0200987 if grep -F 'Received alert [40]: Handshake failed' $CLI_OUT; then
988 if grep -i 'SERVER HELLO .* was received' $CLI_OUT; then :
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +0100989 else
990 RESULT=1
991 fi
992 fi >/dev/null
Manuel Pégourié-Gonnarda4371442014-03-13 16:21:59 +0100993 fi
994 ;;
995
Manuel Pégourié-Gonnarda8f3b752015-01-22 17:05:05 +0000996 mbed*)
Gilles Peskine47aab852023-01-26 21:16:34 +0100997 CLIENT_CMD="$M_CLI $M_CLIENT_ARGS force_ciphersuite=$3"
Manuel Pégourié-Gonnard3eec6042014-02-27 15:37:24 +0100998 if [ "$MEMCHECK" -gt 0 ]; then
999 CLIENT_CMD="valgrind --leak-check=full $CLIENT_CMD"
1000 fi
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +01001001 log "$CLIENT_CMD"
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +02001002 echo "$CLIENT_CMD" > $CLI_OUT
Manuel Pégourié-Gonnardc0f6a692014-08-30 22:41:47 +02001003 $CLIENT_CMD >> $CLI_OUT 2>&1 &
1004 wait_client_done
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +01001005
1006 case $EXIT in
Simon Butcherac22d112016-09-04 22:31:09 +01001007 # Success
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +01001008 "0") RESULT=0 ;;
Simon Butcherac22d112016-09-04 22:31:09 +01001009
1010 # Ciphersuite not supported
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +01001011 "2") RESULT=1 ;;
Simon Butcherac22d112016-09-04 22:31:09 +01001012
1013 # Error
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +01001014 *) RESULT=2 ;;
1015 esac
Manuel Pégourié-Gonnard3eec6042014-02-27 15:37:24 +01001016
1017 if [ "$MEMCHECK" -gt 0 ]; then
Simon Butcherac22d112016-09-04 22:31:09 +01001018 if is_mbedtls "$CLIENT_CMD" && has_mem_err $CLI_OUT; then
Manuel Pégourié-Gonnard3eec6042014-02-27 15:37:24 +01001019 RESULT=2
1020 fi
1021 fi
1022
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +01001023 ;;
1024
1025 *)
1026 echo "error: invalid client name: $1" >&2
1027 exit 1
1028 ;;
1029 esac
1030
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +02001031 echo "EXIT: $EXIT" >> $CLI_OUT
Manuel Pégourié-Gonnarde01af4c2014-03-25 14:16:44 +01001032
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +01001033 # report and count result
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +01001034 case $RESULT in
1035 "0")
Yanray Wangad470632023-02-20 14:58:03 +08001036 record_outcome "PASS"
Gilles Peskine17838702023-08-28 17:36:22 +02001037 if [ "$PRESERVE_LOGS" -gt 0 ]; then
1038 save_logs
1039 fi
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +01001040 ;;
1041 "1")
Yanray Wangad470632023-02-20 14:58:03 +08001042 record_outcome "SKIP"
Manuel Pégourié-Gonnard72e51ee2014-08-31 10:22:11 +02001043 SKIPPED=$(( $SKIPPED + 1 ))
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +01001044 ;;
1045 "2")
Yanray Wangf45a8ea2023-02-20 15:49:10 +08001046 report_fail
Manuel Pégourié-Gonnard72e51ee2014-08-31 10:22:11 +02001047 FAILED=$(( $FAILED + 1 ))
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +01001048 ;;
1049 esac
Manuel Pégourié-Gonnard87ae3032014-02-27 11:12:30 +01001050
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +02001051 rm -f $CLI_OUT
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +01001052}
1053
Manuel Pégourié-Gonnard9dea8bd2014-02-26 18:21:02 +01001054#
1055# MAIN
1056#
1057
Manuel Pégourié-Gonnard3947d042014-03-14 18:13:53 +01001058get_options "$@"
1059
Yanray Wangad470632023-02-20 14:58:03 +08001060# Make the outcome file path relative to the original directory, not
1061# to .../tests
1062case "$MBEDTLS_TEST_OUTCOME_FILE" in
1063 [!/]*)
1064 MBEDTLS_TEST_OUTCOME_FILE="$ORIGINAL_PWD/$MBEDTLS_TEST_OUTCOME_FILE"
1065 ;;
1066esac
1067
Manuel Pégourié-Gonnardf7a26902014-02-27 12:25:54 +01001068# sanity checks, avoid an avalanche of errors
Simon Butcherac22d112016-09-04 22:31:09 +01001069if [ ! -x "$M_SRV" ]; then
1070 echo "Command '$M_SRV' is not an executable file" >&2
Manuel Pégourié-Gonnardf7a26902014-02-27 12:25:54 +01001071 exit 1
1072fi
Simon Butcherac22d112016-09-04 22:31:09 +01001073if [ ! -x "$M_CLI" ]; then
1074 echo "Command '$M_CLI' is not an executable file" >&2
Manuel Pégourié-Gonnardf7a26902014-02-27 12:25:54 +01001075 exit 1
1076fi
Manuel Pégourié-Gonnard3947d042014-03-14 18:13:53 +01001077
1078if echo "$PEERS" | grep -i openssl > /dev/null; then
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01001079 if which "$OPENSSL" >/dev/null 2>&1; then :; else
1080 echo "Command '$OPENSSL' not found" >&2
Manuel Pégourié-Gonnard74faf3c2014-03-13 18:47:44 +01001081 exit 1
1082 fi
Manuel Pégourié-Gonnard3947d042014-03-14 18:13:53 +01001083fi
Manuel Pégourié-Gonnardf7a26902014-02-27 12:25:54 +01001084
Manuel Pégourié-Gonnard3947d042014-03-14 18:13:53 +01001085if echo "$PEERS" | grep -i gnutls > /dev/null; then
1086 for CMD in "$GNUTLS_CLI" "$GNUTLS_SERV"; do
1087 if which "$CMD" >/dev/null 2>&1; then :; else
1088 echo "Command '$CMD' not found" >&2
1089 exit 1
1090 fi
1091 done
1092fi
1093
1094for PEER in $PEERS; do
1095 case "$PEER" in
Manuel Pégourié-Gonnarda8f3b752015-01-22 17:05:05 +00001096 mbed*|[Oo]pen*|[Gg]nu*)
Manuel Pégourié-Gonnard3947d042014-03-14 18:13:53 +01001097 ;;
1098 *)
1099 echo "Unknown peers: $PEER" >&2
1100 exit 1
1101 esac
1102done
Manuel Pégourié-Gonnard9dea8bd2014-02-26 18:21:02 +01001103
Manuel Pégourié-Gonnard8066b812014-05-28 22:59:30 +02001104# Pick a "unique" port in the range 10000-19999.
1105PORT="0000$$"
Manuel Pégourié-Gonnardfab2a3c2014-06-16 16:54:36 +02001106PORT="1$(echo $PORT | tail -c 5)"
Manuel Pégourié-Gonnard8066b812014-05-28 22:59:30 +02001107
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +02001108# Also pick a unique name for intermediate files
1109SRV_OUT="srv_out.$$"
1110CLI_OUT="cli_out.$$"
1111
Manuel Pégourié-Gonnardc0f6a692014-08-30 22:41:47 +02001112# client timeout delay: be more patient with valgrind
1113if [ "$MEMCHECK" -gt 0 ]; then
1114 DOG_DELAY=30
1115else
1116 DOG_DELAY=10
1117fi
1118
Manuel Pégourié-Gonnard53aef812014-07-11 17:41:24 +02001119SKIP_NEXT="NO"
1120
Manuel Pégourié-Gonnarda9062e92014-02-25 16:21:22 +01001121trap cleanup INT TERM HUP
1122
Yanray Wang35c0ead2023-02-07 10:41:04 +08001123for MODE in $MODES; do
Yanray Wang30382972023-02-08 12:38:31 +08001124 for TYPE in $TYPES; do
Yanray Wang35c0ead2023-02-07 10:41:04 +08001125
Yanray Wang30382972023-02-08 12:38:31 +08001126 # PSK cipher suites do not allow client certificate verification.
1127 # This means PSK test cases with VERIFY=YES should be replaced by
1128 # VERIFY=NO or be ignored. SUB_VERIFIES variable is used to constrain
1129 # verification option for PSK test cases.
1130 SUB_VERIFIES=$VERIFIES
1131 if [ "$TYPE" = "PSK" ]; then
1132 SUB_VERIFIES="NO"
1133 fi
Yanray Wang35c0ead2023-02-07 10:41:04 +08001134
Yanray Wang30382972023-02-08 12:38:31 +08001135 for VERIFY in $SUB_VERIFIES; do
1136 VERIF=$(echo $VERIFY | tr '[:upper:]' '[:lower:]')
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001137 for PEER in $PEERS; do
Paul Bakker7e5e7ca2013-04-17 19:27:58 +02001138
Manuel Pégourié-Gonnard95957712014-02-19 15:29:38 +01001139 setup_arguments
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +01001140
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001141 case "$PEER" in
Manuel Pégourié-Gonnardd3313192013-09-13 19:20:37 +02001142
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001143 [Oo]pen*)
Paul Bakker398cb512012-04-10 08:22:31 +00001144
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001145 reset_ciphersuites
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +01001146 add_common_ciphersuites
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001147 add_openssl_ciphersuites
1148 filter_ciphersuites
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +01001149
Simon Butcherac22d112016-09-04 22:31:09 +01001150 if [ "X" != "X$M_CIPHERS" ]; then
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001151 start_server "OpenSSL"
Gilles Peskine47aab852023-01-26 21:16:34 +01001152 translate_ciphers m $M_CIPHERS
1153 for i in $ciphers; do
Pengyu Lv5e780df2023-02-21 14:19:27 +08001154 o_check_ciphersuite "${i%%=*}"
Gilles Peskine47aab852023-01-26 21:16:34 +01001155 run_client mbedTLS ${i%%=*} ${i#*=}
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001156 done
1157 stop_server
1158 fi
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +01001159
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001160 if [ "X" != "X$O_CIPHERS" ]; then
Manuel Pégourié-Gonnarde4f6edc2015-01-22 16:43:54 +00001161 start_server "mbedTLS"
Gilles Peskine47aab852023-01-26 21:16:34 +01001162 translate_ciphers o $O_CIPHERS
1163 for i in $ciphers; do
Pengyu Lv07d50852023-02-22 12:17:26 +08001164 o_check_ciphersuite "${i%%=*}"
Gilles Peskine47aab852023-01-26 21:16:34 +01001165 run_client OpenSSL ${i%%=*} ${i#*=}
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001166 done
1167 stop_server
1168 fi
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +01001169
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001170 ;;
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +01001171
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001172 [Gg]nu*)
Paul Bakkerfab5c822012-02-06 16:45:10 +00001173
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001174 reset_ciphersuites
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +01001175 add_common_ciphersuites
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001176 add_gnutls_ciphersuites
1177 filter_ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +00001178
Simon Butcherac22d112016-09-04 22:31:09 +01001179 if [ "X" != "X$M_CIPHERS" ]; then
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001180 start_server "GnuTLS"
Gilles Peskine47aab852023-01-26 21:16:34 +01001181 translate_ciphers m $M_CIPHERS
1182 for i in $ciphers; do
1183 run_client mbedTLS ${i%%=*} ${i#*=}
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001184 done
1185 stop_server
1186 fi
1187
1188 if [ "X" != "X$G_CIPHERS" ]; then
Manuel Pégourié-Gonnarde4f6edc2015-01-22 16:43:54 +00001189 start_server "mbedTLS"
Gilles Peskine47aab852023-01-26 21:16:34 +01001190 translate_ciphers g $G_CIPHERS
1191 for i in $ciphers; do
1192 run_client GnuTLS ${i%%=*} ${i#*=}
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001193 done
1194 stop_server
1195 fi
1196
1197 ;;
1198
Manuel Pégourié-Gonnarda8f3b752015-01-22 17:05:05 +00001199 mbed*)
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001200
1201 reset_ciphersuites
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +01001202 add_common_ciphersuites
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001203 add_openssl_ciphersuites
1204 add_gnutls_ciphersuites
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001205 add_mbedtls_ciphersuites
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001206 filter_ciphersuites
1207
Simon Butcherac22d112016-09-04 22:31:09 +01001208 if [ "X" != "X$M_CIPHERS" ]; then
Manuel Pégourié-Gonnarde4f6edc2015-01-22 16:43:54 +00001209 start_server "mbedTLS"
Gilles Peskine47aab852023-01-26 21:16:34 +01001210 translate_ciphers m $M_CIPHERS
1211 for i in $ciphers; do
1212 run_client mbedTLS ${i%%=*} ${i#*=}
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001213 done
1214 stop_server
1215 fi
1216
1217 ;;
1218
Manuel Pégourié-Gonnarda1a9f9a2014-03-25 18:04:59 +01001219 *)
Paul Bakker1ebc0c52014-05-22 15:47:58 +02001220 echo "Unknown peer: $PEER" >&2
Manuel Pégourié-Gonnarda1a9f9a2014-03-25 18:04:59 +01001221 exit 1
1222 ;;
1223
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001224 esac
1225
1226 done
Manuel Pégourié-Gonnard95957712014-02-19 15:29:38 +01001227 done
1228 done
Manuel Pégourié-Gonnard9791a402013-08-27 19:57:15 +02001229done
Manuel Pégourié-Gonnard70064fd2013-08-27 22:00:47 +02001230
Manuel Pégourié-Gonnard4145b892014-02-24 13:20:14 +01001231echo "------------------------------------------------------------------------"
Manuel Pégourié-Gonnard70064fd2013-08-27 22:00:47 +02001232
Tom Cosgrovefc0e79e2023-01-13 12:13:41 +00001233if [ $FAILED -ne 0 -o $SRVMEM -ne 0 ]; then
Manuel Pégourié-Gonnardf46f1282014-12-11 11:51:28 +01001234 printf "FAILED"
Manuel Pégourié-Gonnard70064fd2013-08-27 22:00:47 +02001235else
Manuel Pégourié-Gonnardf46f1282014-12-11 11:51:28 +01001236 printf "PASSED"
Manuel Pégourié-Gonnard70064fd2013-08-27 22:00:47 +02001237fi
1238
Manuel Pégourié-Gonnardba0b8442014-03-13 17:57:45 +01001239if [ "$MEMCHECK" -gt 0 ]; then
Manuel Pégourié-Gonnard72e51ee2014-08-31 10:22:11 +02001240 MEMREPORT=", $SRVMEM server memory errors"
Manuel Pégourié-Gonnardba0b8442014-03-13 17:57:45 +01001241else
1242 MEMREPORT=""
1243fi
1244
Manuel Pégourié-Gonnard72e51ee2014-08-31 10:22:11 +02001245PASSED=$(( $TESTS - $FAILED ))
1246echo " ($PASSED / $TESTS tests ($SKIPPED skipped$MEMREPORT))"
Manuel Pégourié-Gonnard70064fd2013-08-27 22:00:47 +02001247
Gilles Peskinec75048c2024-05-17 11:55:15 +02001248if [ $((TESTS - SKIPPED)) -lt $MIN_TESTS ]; then
1249 cat <<EOF
1250Error: Expected to run at least $MIN_TESTS, but only ran $((TESTS - SKIPPED)).
1251Maybe a bad filter ('$FILTER' excluding '$EXCLUDE') or a bad configuration?
1252EOF
1253 if [ $FAILED -eq 0 ]; then
1254 FAILED=1
1255 fi
1256fi
1257
Manuel Pégourié-Gonnard72e51ee2014-08-31 10:22:11 +02001258FAILED=$(( $FAILED + $SRVMEM ))
Tom Cosgrovefc0e79e2023-01-13 12:13:41 +00001259if [ $FAILED -gt 255 ]; then
1260 # Clamp at 255 as caller gets exit code & 0xFF
1261 # (so 256 would be 0, or success, etc)
1262 FAILED=255
1263fi
Manuel Pégourié-Gonnard72e51ee2014-08-31 10:22:11 +02001264exit $FAILED