blob: 8d615d5630c8e0d910131418a97022d41907b57a [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 Peskine17838702023-08-28 17:36:22 +020099PRESERVE_LOGS=0
Manuel Pégourié-Gonnarde4f6edc2015-01-22 16:43:54 +0000100PEERS="OpenSSL$PEER_GNUTLS mbedTLS"
Paul Bakkeraccd4eb2013-07-19 13:41:51 +0200101
Manuel Pégourié-Gonnard39e2ca92015-08-04 16:43:37 +0200102# hidden option: skip DTLS with OpenSSL
103# (travis CI has a version that doesn't work for us)
104: ${OSSL_NO_DTLS:=0}
105
Manuel Pégourié-Gonnard9dea8bd2014-02-26 18:21:02 +0100106print_usage() {
107 echo "Usage: $0"
Manuel Pégourié-Gonnardf46f1282014-12-11 11:51:28 +0100108 printf " -h|--help\tPrint this help.\n"
Gilles Peskine231befa2020-08-26 20:05:11 +0200109 printf " -f|--filter\tOnly matching ciphersuites are tested (Default: '%s')\n" "$FILTER"
110 printf " -e|--exclude\tMatching ciphersuites are excluded (Default: '%s')\n" "$EXCLUDE"
111 printf " -m|--modes\tWhich modes to perform (Default: '%s')\n" "$MODES"
112 printf " -t|--types\tWhich key exchange type to perform (Default: '%s')\n" "$TYPES"
113 printf " -V|--verify\tWhich verification modes to perform (Default: '%s')\n" "$VERIFIES"
114 printf " -p|--peers\tWhich peers to use (Default: '%s')\n" "$PEERS"
Manuel Pégourié-Gonnardf46f1282014-12-11 11:51:28 +0100115 printf " \tAlso available: GnuTLS (needs v3.2.15 or higher)\n"
116 printf " -M|--memcheck\tCheck memory leaks and errors.\n"
117 printf " -v|--verbose\tSet verbose output.\n"
Yanray Wangd8938372023-02-23 10:04:58 +0800118 printf " --list-test-case\tList all potential test cases (No Execution)\n"
Yanray Wangad470632023-02-20 14:58:03 +0800119 printf " --outcome-file\tFile where test outcomes are written\n"
120 printf " \t(default: \$MBEDTLS_TEST_OUTCOME_FILE, none if empty)\n"
Gilles Peskine17838702023-08-28 17:36:22 +0200121 printf " --preserve-logs\tPreserve logs of successful tests as well\n"
Yanray Wangd8938372023-02-23 10:04:58 +0800122}
123
Yanray Wangfb784b22023-03-02 11:55:55 +0800124# print_test_case <CLIENT> <SERVER> <STANDARD_CIPHER_SUITE>
125print_test_case() {
126 for i in $3; do
127 uniform_title $1 $2 $i
128 echo $TITLE
129 done
130}
131
Yanray Wangcdc07082023-03-03 17:12:29 +0800132# list_test_case lists all potential test cases in compat.sh without execution
Yanray Wangd8938372023-02-23 10:04:58 +0800133list_test_case() {
134 reset_ciphersuites
135 for TYPE in $TYPES; do
136 add_common_ciphersuites
137 add_openssl_ciphersuites
138 add_gnutls_ciphersuites
139 add_mbedtls_ciphersuites
140 done
141
142 for VERIFY in $VERIFIES; do
143 VERIF=$(echo $VERIFY | tr '[:upper:]' '[:lower:]')
144 for MODE in $MODES; do
Yanray Wangfb784b22023-03-02 11:55:55 +0800145 print_test_case m O "$O_CIPHERS"
146 print_test_case O m "$O_CIPHERS"
147 print_test_case m G "$G_CIPHERS"
148 print_test_case G m "$G_CIPHERS"
149 print_test_case m m "$M_CIPHERS"
Yanray Wangd8938372023-02-23 10:04:58 +0800150 done
151 done
Manuel Pégourié-Gonnard9dea8bd2014-02-26 18:21:02 +0100152}
153
154get_options() {
155 while [ $# -gt 0 ]; do
156 case "$1" in
157 -f|--filter)
158 shift; FILTER=$1
159 ;;
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +0100160 -e|--exclude)
161 shift; EXCLUDE=$1
162 ;;
Manuel Pégourié-Gonnard9dea8bd2014-02-26 18:21:02 +0100163 -m|--modes)
164 shift; MODES=$1
165 ;;
166 -t|--types)
167 shift; TYPES=$1
168 ;;
169 -V|--verify)
170 shift; VERIFIES=$1
171 ;;
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +0100172 -p|--peers)
173 shift; PEERS=$1
174 ;;
Manuel Pégourié-Gonnard9dea8bd2014-02-26 18:21:02 +0100175 -v|--verbose)
176 VERBOSE=1
177 ;;
Manuel Pégourié-Gonnard3eec6042014-02-27 15:37:24 +0100178 -M|--memcheck)
179 MEMCHECK=1
180 ;;
Yanray Wangcdc07082023-03-03 17:12:29 +0800181 # Please check scripts/check_test_cases.py correspondingly
182 # if you have to modify option, --list-test-case
Yanray Wangd8938372023-02-23 10:04:58 +0800183 --list-test-case)
184 list_test_case
Yanray Wang14e052f2023-03-06 19:37:07 +0800185 exit $?
Yanray Wangd8938372023-02-23 10:04:58 +0800186 ;;
Yanray Wangad470632023-02-20 14:58:03 +0800187 --outcome-file)
188 shift; MBEDTLS_TEST_OUTCOME_FILE=$1
189 ;;
Gilles Peskine17838702023-08-28 17:36:22 +0200190 --preserve-logs)
191 PRESERVE_LOGS=1
192 ;;
Manuel Pégourié-Gonnard9dea8bd2014-02-26 18:21:02 +0100193 -h|--help)
194 print_usage
195 exit 0
196 ;;
197 *)
198 echo "Unknown argument: '$1'"
199 print_usage
200 exit 1
201 ;;
202 esac
203 shift
204 done
Manuel Pégourié-Gonnard85a41782014-10-24 12:47:26 +0200205
206 # sanitize some options (modes checked later)
207 VERIFIES="$( echo $VERIFIES | tr [a-z] [A-Z] )"
208 TYPES="$( echo $TYPES | tr [a-z] [A-Z] )"
Manuel Pégourié-Gonnard9dea8bd2014-02-26 18:21:02 +0100209}
Paul Bakkeraccd4eb2013-07-19 13:41:51 +0200210
Manuel Pégourié-Gonnard95957712014-02-19 15:29:38 +0100211log() {
Paul Bakkeraccd4eb2013-07-19 13:41:51 +0200212 if [ "X" != "X$VERBOSE" ]; then
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100213 echo ""
Paul Bakkeraccd4eb2013-07-19 13:41:51 +0200214 echo "$@"
215 fi
216}
Paul Bakker10cd2252012-04-12 21:26:34 +0000217
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100218# is_dtls <mode>
219is_dtls()
220{
Xiaofei Bai8b5c3822021-12-02 08:43:35 +0000221 test "$1" = "dtls12"
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100222}
223
224# minor_ver <mode>
225minor_ver()
226{
227 case "$1" in
Xiaofei Bai8b5c3822021-12-02 08:43:35 +0000228 tls12|dtls12)
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100229 echo 3
230 ;;
231 *)
232 echo "error: invalid mode: $MODE" >&2
233 # exiting is no good here, typically called in a subshell
234 echo -1
235 esac
236}
237
Manuel Pégourié-Gonnarddfc8d5a2013-08-27 20:48:40 +0200238filter()
239{
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +0100240 LIST="$1"
Manuel Pégourié-Gonnarddfc8d5a2013-08-27 20:48:40 +0200241 NEW_LIST=""
242
Mateusz Starzyk5224e292021-02-22 14:36:29 +0100243 EXCLMODE="$EXCLUDE"
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100244
Manuel Pégourié-Gonnarddfc8d5a2013-08-27 20:48:40 +0200245 for i in $LIST;
246 do
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100247 NEW_LIST="$NEW_LIST $( echo "$i" | grep "$FILTER" | grep -v "$EXCLMODE" )"
Manuel Pégourié-Gonnarddfc8d5a2013-08-27 20:48:40 +0200248 done
249
Manuel Pégourié-Gonnard911622d2014-02-27 11:50:40 +0100250 # normalize whitespace
Manuel Pégourié-Gonnardf46f1282014-12-11 11:51:28 +0100251 echo "$NEW_LIST" | sed -e 's/[[:space:]][[:space:]]*/ /g' -e 's/^ //' -e 's/ $//'
Manuel Pégourié-Gonnarddfc8d5a2013-08-27 20:48:40 +0200252}
253
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100254filter_ciphersuites()
255{
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +0100256 if [ "X" != "X$FILTER" -o "X" != "X$EXCLUDE" ];
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100257 then
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200258 # Ciphersuite for Mbed TLS
Simon Butcherac22d112016-09-04 22:31:09 +0100259 M_CIPHERS=$( filter "$M_CIPHERS" )
260
261 # Ciphersuite for OpenSSL
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +0100262 O_CIPHERS=$( filter "$O_CIPHERS" )
Simon Butcherac22d112016-09-04 22:31:09 +0100263
264 # Ciphersuite for GnuTLS
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +0100265 G_CIPHERS=$( filter "$G_CIPHERS" )
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100266 fi
Manuel Pégourié-Gonnard29980b12014-07-10 20:12:56 +0200267
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200268 # For GnuTLS client -> Mbed TLS server,
Manuel Pégourié-Gonnardd1af1022014-07-11 17:01:06 +0200269 # we need to force IPv4 by connecting to 127.0.0.1 but then auth fails
Yanray Wang30382972023-02-08 12:38:31 +0800270 if is_dtls "$MODE" && [ "X$VERIFY" = "XYES" ]; then
Manuel Pégourié-Gonnard29980b12014-07-10 20:12:56 +0200271 G_CIPHERS=""
272 fi
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100273}
274
275reset_ciphersuites()
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100276{
Simon Butcherac22d112016-09-04 22:31:09 +0100277 M_CIPHERS=""
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100278 O_CIPHERS=""
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100279 G_CIPHERS=""
280}
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100281
Gilles Peskine47aab852023-01-26 21:16:34 +0100282# translate_ciphers {g|m|o} {STANDARD_CIPHER_SUITE_NAME...}
283# Set $ciphers to the cipher suite name translations for the specified
284# program (gnutls, mbedtls or openssl). $ciphers is a space-separated
285# list of entries of the form "STANDARD_NAME=PROGRAM_NAME".
286translate_ciphers()
Joe Subbianic3610ba2021-07-29 11:35:59 +0100287{
Gilles Peskine47aab852023-01-26 21:16:34 +0100288 ciphers=$(scripts/translate_ciphers.py "$@")
289 if [ $? -ne 0 ]; then
Joe Subbiani439a6962021-07-29 12:51:09 +0100290 echo "translate_ciphers.py failed with exit code $1" >&2
291 echo "$2" >&2
Joe Subbianic3610ba2021-07-29 11:35:59 +0100292 exit 1
293 fi
294}
295
Manuel Pégourié-Gonnard7299dfd2018-02-15 11:43:55 +0100296# Ciphersuites that can be used with all peers.
297# Since we currently have three possible peers, each ciphersuite should appear
298# three times: in each peer's list (with the name that this peer uses).
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +0100299add_common_ciphersuites()
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100300{
Joe Subbiani34d62622021-07-27 14:55:56 +0100301 CIPHERS=""
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100302 case $TYPE in
303
304 "ECDSA")
Joe Subbiani9f847612021-08-10 10:41:13 +0100305 CIPHERS="$CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800306 TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA \
307 TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 \
308 TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 \
309 TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA \
310 TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 \
311 TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 \
312 TLS_ECDHE_ECDSA_WITH_NULL_SHA \
Joe Subbiani9f847612021-08-10 10:41:13 +0100313 "
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100314 ;;
315
316 "RSA")
Joe Subbiani34d62622021-07-27 14:55:56 +0100317 CIPHERS="$CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800318 TLS_DHE_RSA_WITH_AES_128_CBC_SHA \
319 TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 \
320 TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 \
321 TLS_DHE_RSA_WITH_AES_256_CBC_SHA \
322 TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 \
323 TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 \
324 TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA \
325 TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA \
326 TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA \
327 TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 \
328 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 \
329 TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA \
330 TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 \
331 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 \
332 TLS_ECDHE_RSA_WITH_NULL_SHA \
333 TLS_RSA_WITH_AES_128_CBC_SHA \
334 TLS_RSA_WITH_AES_128_CBC_SHA256 \
335 TLS_RSA_WITH_AES_128_GCM_SHA256 \
336 TLS_RSA_WITH_AES_256_CBC_SHA \
337 TLS_RSA_WITH_AES_256_CBC_SHA256 \
338 TLS_RSA_WITH_AES_256_GCM_SHA384 \
339 TLS_RSA_WITH_CAMELLIA_128_CBC_SHA \
340 TLS_RSA_WITH_CAMELLIA_256_CBC_SHA \
341 TLS_RSA_WITH_NULL_MD5 \
342 TLS_RSA_WITH_NULL_SHA \
343 TLS_RSA_WITH_NULL_SHA256 \
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +0100344 "
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100345 ;;
346
347 "PSK")
Joe Subbiani34d62622021-07-27 14:55:56 +0100348 CIPHERS="$CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800349 TLS_PSK_WITH_AES_128_CBC_SHA \
350 TLS_PSK_WITH_AES_256_CBC_SHA \
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100351 "
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100352 ;;
353 esac
Joe Subbiani34d62622021-07-27 14:55:56 +0100354
Yanray Wang20fa2ae2023-01-13 18:00:10 +0800355 O_CIPHERS="$O_CIPHERS $CIPHERS"
356 G_CIPHERS="$G_CIPHERS $CIPHERS"
Joe Subbiani34d62622021-07-27 14:55:56 +0100357 M_CIPHERS="$M_CIPHERS $CIPHERS"
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100358}
359
Manuel Pégourié-Gonnard7299dfd2018-02-15 11:43:55 +0100360# Ciphersuites usable only with Mbed TLS and OpenSSL
Yanray Wang20fa2ae2023-01-13 18:00:10 +0800361# A list of ciphersuites in the standard naming convention is appended
362# to the list of Mbed TLS ciphersuites $M_CIPHERS and
363# to the list of OpenSSL ciphersuites $O_CIPHERS respectively.
364# Based on client's naming convention, all ciphersuite names will be
365# translated into another naming format before sent to the client.
Manuel Pégourié-Gonnard7299dfd2018-02-15 11:43:55 +0100366#
367# NOTE: for some reason RSA-PSK doesn't work with OpenSSL,
Manuel Pégourié-Gonnardce5673c2018-03-06 09:54:10 +0100368# so RSA-PSK ciphersuites need to go in other sections, see
Dave Rodgman017a1992022-03-31 14:07:01 +0100369# https://github.com/Mbed-TLS/mbedtls/issues/1419
Manuel Pégourié-Gonnard9fece7e2018-06-18 11:38:22 +0200370#
371# ChachaPoly suites are here rather than in "common", as they were added in
372# GnuTLS in 3.5.0 and the CI only has 3.4.x so far.
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +0100373add_openssl_ciphersuites()
374{
Joe Subbiani34d62622021-07-27 14:55:56 +0100375 CIPHERS=""
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +0100376 case $TYPE in
377
378 "ECDSA")
Joe Subbiani32df1452021-08-13 13:30:36 +0100379 CIPHERS="$CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800380 TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA \
381 TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 \
382 TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 \
383 TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA \
384 TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 \
385 TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 \
386 TLS_ECDH_ECDSA_WITH_NULL_SHA \
387 TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256 \
388 TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384 \
389 TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 \
Joe Subbiani9f847612021-08-10 10:41:13 +0100390 "
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +0100391 ;;
392
393 "RSA")
Joe Subbiani32df1452021-08-13 13:30:36 +0100394 CIPHERS="$CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800395 TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256 \
396 TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384 \
397 TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256 \
398 TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256 \
399 TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384 \
400 TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 \
401 TLS_RSA_WITH_ARIA_128_GCM_SHA256 \
402 TLS_RSA_WITH_ARIA_256_GCM_SHA384 \
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +0100403 "
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +0100404 ;;
405
406 "PSK")
Joe Subbiani9f847612021-08-10 10:41:13 +0100407 CIPHERS="$CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800408 TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256 \
409 TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384 \
410 TLS_DHE_PSK_WITH_CHACHA20_POLY1305_SHA256 \
411 TLS_ECDHE_PSK_WITH_CHACHA20_POLY1305_SHA256 \
412 TLS_PSK_WITH_ARIA_128_GCM_SHA256 \
413 TLS_PSK_WITH_ARIA_256_GCM_SHA384 \
414 TLS_PSK_WITH_CHACHA20_POLY1305_SHA256 \
Joe Subbiani9f847612021-08-10 10:41:13 +0100415 "
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +0100416 ;;
417 esac
Joe Subbiani34d62622021-07-27 14:55:56 +0100418
Yanray Wang20fa2ae2023-01-13 18:00:10 +0800419 O_CIPHERS="$O_CIPHERS $CIPHERS"
Joe Subbiani34d62622021-07-27 14:55:56 +0100420 M_CIPHERS="$M_CIPHERS $CIPHERS"
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +0100421}
422
Manuel Pégourié-Gonnard7299dfd2018-02-15 11:43:55 +0100423# Ciphersuites usable only with Mbed TLS and GnuTLS
Yanray Wang20fa2ae2023-01-13 18:00:10 +0800424# A list of ciphersuites in the standard naming convention is appended
425# to the list of Mbed TLS ciphersuites $M_CIPHERS and
426# to the list of GnuTLS ciphersuites $G_CIPHERS respectively.
427# Based on client's naming convention, all ciphersuite names will be
428# translated into another naming format before sent to the client.
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100429add_gnutls_ciphersuites()
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100430{
Joe Subbiani34d62622021-07-27 14:55:56 +0100431 CIPHERS=""
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100432 case $TYPE in
433
434 "ECDSA")
Joe Subbiani9f847612021-08-10 10:41:13 +0100435 CIPHERS="$CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800436 TLS_ECDHE_ECDSA_WITH_AES_128_CCM \
437 TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8 \
438 TLS_ECDHE_ECDSA_WITH_AES_256_CCM \
439 TLS_ECDHE_ECDSA_WITH_AES_256_CCM_8 \
440 TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256 \
441 TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256 \
442 TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384 \
443 TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384 \
Joe Subbiani9f847612021-08-10 10:41:13 +0100444 "
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100445 ;;
446
447 "RSA")
Joe Subbiani9f847612021-08-10 10:41:13 +0100448 CIPHERS="$CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800449 TLS_DHE_RSA_WITH_AES_128_CCM \
450 TLS_DHE_RSA_WITH_AES_128_CCM_8 \
451 TLS_DHE_RSA_WITH_AES_256_CCM \
452 TLS_DHE_RSA_WITH_AES_256_CCM_8 \
453 TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256 \
454 TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256 \
455 TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256 \
456 TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384 \
457 TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256 \
458 TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256 \
459 TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384 \
460 TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384 \
461 TLS_RSA_WITH_AES_128_CCM \
462 TLS_RSA_WITH_AES_128_CCM_8 \
463 TLS_RSA_WITH_AES_256_CCM \
464 TLS_RSA_WITH_AES_256_CCM_8 \
465 TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256 \
466 TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256 \
467 TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256 \
468 TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384 \
Joe Subbiani9f847612021-08-10 10:41:13 +0100469 "
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100470 ;;
471
472 "PSK")
Joe Subbiani9f847612021-08-10 10:41:13 +0100473 CIPHERS="$CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800474 TLS_DHE_PSK_WITH_AES_128_CBC_SHA \
475 TLS_DHE_PSK_WITH_AES_128_CBC_SHA256 \
476 TLS_DHE_PSK_WITH_AES_128_CCM \
477 TLS_DHE_PSK_WITH_AES_128_CCM_8 \
478 TLS_DHE_PSK_WITH_AES_128_GCM_SHA256 \
479 TLS_DHE_PSK_WITH_AES_256_CBC_SHA \
480 TLS_DHE_PSK_WITH_AES_256_CBC_SHA384 \
481 TLS_DHE_PSK_WITH_AES_256_CCM \
482 TLS_DHE_PSK_WITH_AES_256_CCM_8 \
483 TLS_DHE_PSK_WITH_AES_256_GCM_SHA384 \
484 TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256 \
485 TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256 \
486 TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384 \
487 TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384 \
488 TLS_DHE_PSK_WITH_NULL_SHA256 \
489 TLS_DHE_PSK_WITH_NULL_SHA384 \
490 TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA \
491 TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256 \
492 TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA \
493 TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384 \
494 TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256 \
495 TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384 \
496 TLS_ECDHE_PSK_WITH_NULL_SHA256 \
497 TLS_ECDHE_PSK_WITH_NULL_SHA384 \
498 TLS_PSK_WITH_AES_128_CBC_SHA256 \
499 TLS_PSK_WITH_AES_128_CCM \
500 TLS_PSK_WITH_AES_128_CCM_8 \
501 TLS_PSK_WITH_AES_128_GCM_SHA256 \
502 TLS_PSK_WITH_AES_256_CBC_SHA384 \
503 TLS_PSK_WITH_AES_256_CCM \
504 TLS_PSK_WITH_AES_256_CCM_8 \
505 TLS_PSK_WITH_AES_256_GCM_SHA384 \
506 TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256 \
507 TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256 \
508 TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384 \
509 TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384 \
510 TLS_PSK_WITH_NULL_SHA256 \
511 TLS_PSK_WITH_NULL_SHA384 \
512 TLS_RSA_PSK_WITH_AES_128_CBC_SHA \
513 TLS_RSA_PSK_WITH_AES_128_CBC_SHA256 \
514 TLS_RSA_PSK_WITH_AES_128_GCM_SHA256 \
515 TLS_RSA_PSK_WITH_AES_256_CBC_SHA \
516 TLS_RSA_PSK_WITH_AES_256_CBC_SHA384 \
517 TLS_RSA_PSK_WITH_AES_256_GCM_SHA384 \
518 TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256 \
519 TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256 \
520 TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384 \
521 TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384 \
522 TLS_RSA_PSK_WITH_NULL_SHA256 \
523 TLS_RSA_PSK_WITH_NULL_SHA384 \
Manuel Pégourié-Gonnarde46aa5e2014-07-13 15:44:19 +0200524 "
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100525 ;;
526 esac
Joe Subbiani43592bd2021-07-27 16:32:21 +0100527
Yanray Wang20fa2ae2023-01-13 18:00:10 +0800528 G_CIPHERS="$G_CIPHERS $CIPHERS"
Joe Subbiani34d62622021-07-27 14:55:56 +0100529 M_CIPHERS="$M_CIPHERS $CIPHERS"
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100530}
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100531
Manuel Pégourié-Gonnard7299dfd2018-02-15 11:43:55 +0100532# Ciphersuites usable only with Mbed TLS (not currently supported by another
Yanray Wang20fa2ae2023-01-13 18:00:10 +0800533# peer usable in this script). This provides only very rudimentaty testing, as
Manuel Pégourié-Gonnard7299dfd2018-02-15 11:43:55 +0100534# this is not interop testing, but it's better than nothing.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200535add_mbedtls_ciphersuites()
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100536{
537 case $TYPE in
538
539 "ECDSA")
Joe Subbiani9f847612021-08-10 10:41:13 +0100540 M_CIPHERS="$M_CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800541 TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256 \
542 TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256 \
543 TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384 \
544 TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384 \
545 TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256 \
546 TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256 \
547 TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384 \
548 TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384 \
549 TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256 \
550 TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384 \
Joe Subbiani9f847612021-08-10 10:41:13 +0100551 "
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100552 ;;
553
554 "RSA")
Joe Subbiani9f847612021-08-10 10:41:13 +0100555 M_CIPHERS="$M_CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800556 TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256 \
557 TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384 \
558 TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256 \
559 TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384 \
560 TLS_RSA_WITH_ARIA_128_CBC_SHA256 \
561 TLS_RSA_WITH_ARIA_256_CBC_SHA384 \
Joe Subbiani9f847612021-08-10 10:41:13 +0100562 "
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100563 ;;
564
565 "PSK")
Yanray Wangd5f99e42023-01-11 10:11:23 +0800566 # *PSK_NULL_SHA suites supported by GnuTLS 3.3.5 but not 3.2.15
Joe Subbiani9f847612021-08-10 10:41:13 +0100567 M_CIPHERS="$M_CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800568 TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256 \
569 TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384 \
570 TLS_DHE_PSK_WITH_NULL_SHA \
571 TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256 \
572 TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384 \
573 TLS_ECDHE_PSK_WITH_NULL_SHA \
574 TLS_PSK_WITH_ARIA_128_CBC_SHA256 \
575 TLS_PSK_WITH_ARIA_256_CBC_SHA384 \
576 TLS_PSK_WITH_NULL_SHA \
577 TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256 \
578 TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256 \
579 TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384 \
580 TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384 \
581 TLS_RSA_PSK_WITH_CHACHA20_POLY1305_SHA256 \
582 TLS_RSA_PSK_WITH_NULL_SHA \
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100583 "
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100584 ;;
585 esac
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100586}
587
Pengyu Lv1c0e4c02023-02-20 18:05:21 +0800588# o_check_ciphersuite STANDARD_CIPHER_SUITE
589o_check_ciphersuite()
590{
Pengyu Lva64c2772023-02-22 09:30:20 +0800591 if [ "${O_SUPPORT_ECDH}" = "NO" ]; then
592 case "$1" in
593 *ECDH_*) SKIP_NEXT="YES"
594 esac
Pengyu Lv1c0e4c02023-02-20 18:05:21 +0800595 fi
596}
597
Manuel Pégourié-Gonnardd941a792014-02-19 13:35:52 +0100598setup_arguments()
599{
Ronald Cron2c74ff62022-03-11 17:15:23 +0100600 O_MODE=""
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100601 G_MODE=""
602 case "$MODE" in
Xiaofei Bai8b5c3822021-12-02 08:43:35 +0000603 "tls12")
Ronald Cron2c74ff62022-03-11 17:15:23 +0100604 O_MODE="tls1_2"
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100605 G_PRIO_MODE="+VERS-TLS1.2"
Manuel Pégourié-Gonnard9ada01a2014-02-19 14:24:24 +0100606 ;;
Xiaofei Bai8b5c3822021-12-02 08:43:35 +0000607 "dtls12")
Ronald Cron2c74ff62022-03-11 17:15:23 +0100608 O_MODE="dtls1_2"
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100609 G_PRIO_MODE="+VERS-DTLS1.2"
Manuel Pégourié-Gonnard36795192014-09-26 16:33:45 +0200610 G_MODE="-u"
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100611 ;;
Manuel Pégourié-Gonnard9ada01a2014-02-19 14:24:24 +0100612 *)
613 echo "error: invalid mode: $MODE" >&2
614 exit 1;
615 esac
616
Manuel Pégourié-Gonnardc36b4322018-06-14 13:14:29 +0200617 # GnuTLS < 3.4 will choke if we try to allow CCM-8
618 if [ -z "${GNUTLS_MINOR_LT_FOUR-}" ]; then
619 G_PRIO_CCM="+AES-256-CCM-8:+AES-128-CCM-8:"
620 else
621 G_PRIO_CCM=""
622 fi
623
Mateusz Starzyk5224e292021-02-22 14:36:29 +0100624 M_SERVER_ARGS="server_port=$PORT server_addr=0.0.0.0 force_version=$MODE"
Gilles Peskine5f5e3882023-08-27 21:32:36 +0200625 O_SERVER_ARGS="-accept $PORT -cipher ALL,COMPLEMENTOFALL -$O_MODE"
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100626 G_SERVER_ARGS="-p $PORT --http $G_MODE"
Mateusz Starzyk5224e292021-02-22 14:36:29 +0100627 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 +0100628
Gilles Peskine96f5bae2021-04-01 14:00:11 +0200629 # The default prime for `openssl s_server` depends on the version:
630 # * OpenSSL <= 1.0.2a: 512-bit
631 # * OpenSSL 1.0.2b to 1.1.1b: 1024-bit
632 # * OpenSSL >= 1.1.1c: 2048-bit
633 # Mbed TLS wants >=1024, so force that for older versions. Don't force
634 # it for newer versions, which reject a 1024-bit prime. Indifferently
635 # force it or not for intermediate versions.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100636 case $($OPENSSL version) in
Gilles Peskine96f5bae2021-04-01 14:00:11 +0200637 "OpenSSL 1.0"*)
638 O_SERVER_ARGS="$O_SERVER_ARGS -dhparam data_files/dhparams.pem"
639 ;;
640 esac
641
Manuel Pégourié-Gonnardd1af1022014-07-11 17:01:06 +0200642 # with OpenSSL 1.0.1h, -www, -WWW and -HTTP break DTLS handshakes
643 if is_dtls "$MODE"; then
Manuel Pégourié-Gonnard36795192014-09-26 16:33:45 +0200644 O_SERVER_ARGS="$O_SERVER_ARGS"
Manuel Pégourié-Gonnardd1af1022014-07-11 17:01:06 +0200645 else
646 O_SERVER_ARGS="$O_SERVER_ARGS -www"
647 fi
648
Simon Butcherac22d112016-09-04 22:31:09 +0100649 M_CLIENT_ARGS="server_port=$PORT server_addr=127.0.0.1 force_version=$MODE"
Ronald Cron2c74ff62022-03-11 17:15:23 +0100650 O_CLIENT_ARGS="-connect localhost:$PORT -$O_MODE"
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100651 G_CLIENT_ARGS="-p $PORT --debug 3 $G_MODE"
Manuel Pégourié-Gonnard9ada01a2014-02-19 14:24:24 +0100652
Gilles Peskine4bdb9fb2022-11-24 22:21:15 +0100653 # Newer versions of OpenSSL have a syntax to enable all "ciphers", even
654 # low-security ones. This covers not just cipher suites but also protocol
655 # versions. It is necessary, for example, to use (D)TLS 1.0/1.1 on
656 # OpenSSL 1.1.1f from Ubuntu 20.04. The syntax was only introduced in
657 # OpenSSL 1.1.0 (21e0c1d23afff48601eb93135defddae51f7e2e3) and I can't find
658 # a way to discover it from -help, so check the openssl version.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100659 case $($OPENSSL version) in
Gilles Peskine4bdb9fb2022-11-24 22:21:15 +0100660 "OpenSSL 0"*|"OpenSSL 1.0"*) :;;
661 *)
662 O_CLIENT_ARGS="$O_CLIENT_ARGS -cipher ALL@SECLEVEL=0"
663 O_SERVER_ARGS="$O_SERVER_ARGS -cipher ALL@SECLEVEL=0"
664 ;;
665 esac
666
Pengyu Lv1c0e4c02023-02-20 18:05:21 +0800667 case $($OPENSSL ciphers ALL) in
Pengyu Lv9e7bb2a2023-02-23 15:24:47 +0800668 *ECDH-ECDSA*|*ECDH-RSA*) O_SUPPORT_ECDH="YES";;
Pengyu Lva64c2772023-02-22 09:30:20 +0800669 *) O_SUPPORT_ECDH="NO";;
Pengyu Lv1c0e4c02023-02-20 18:05:21 +0800670 esac
671
Yanray Wang30382972023-02-08 12:38:31 +0800672 if [ "X$VERIFY" = "XYES" ];
Manuel Pégourié-Gonnardd941a792014-02-19 13:35:52 +0100673 then
Simon Butcherac22d112016-09-04 22:31:09 +0100674 M_SERVER_ARGS="$M_SERVER_ARGS ca_file=data_files/test-ca_cat12.crt auth_mode=required"
Manuel Pégourié-Gonnard9ada01a2014-02-19 14:24:24 +0100675 O_SERVER_ARGS="$O_SERVER_ARGS -CAfile data_files/test-ca_cat12.crt -Verify 10"
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100676 G_SERVER_ARGS="$G_SERVER_ARGS --x509cafile data_files/test-ca_cat12.crt --require-client-cert"
677
Simon Butcherac22d112016-09-04 22:31:09 +0100678 M_CLIENT_ARGS="$M_CLIENT_ARGS ca_file=data_files/test-ca_cat12.crt auth_mode=required"
Manuel Pégourié-Gonnardda782c92014-02-21 10:10:20 +0100679 O_CLIENT_ARGS="$O_CLIENT_ARGS -CAfile data_files/test-ca_cat12.crt -verify 10"
Manuel Pégourié-Gonnarda4371442014-03-13 16:21:59 +0100680 G_CLIENT_ARGS="$G_CLIENT_ARGS --x509cafile data_files/test-ca_cat12.crt"
Manuel Pégourié-Gonnardda782c92014-02-21 10:10:20 +0100681 else
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100682 # don't request a client cert at all
Simon Butcherac22d112016-09-04 22:31:09 +0100683 M_SERVER_ARGS="$M_SERVER_ARGS ca_file=none auth_mode=none"
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100684 G_SERVER_ARGS="$G_SERVER_ARGS --disable-client-cert"
685
Simon Butcherac22d112016-09-04 22:31:09 +0100686 M_CLIENT_ARGS="$M_CLIENT_ARGS ca_file=none auth_mode=none"
Manuel Pégourié-Gonnard5de31ec2014-03-19 17:34:52 +0100687 O_CLIENT_ARGS="$O_CLIENT_ARGS"
688 G_CLIENT_ARGS="$G_CLIENT_ARGS --insecure"
Manuel Pégourié-Gonnardd941a792014-02-19 13:35:52 +0100689 fi
690
691 case $TYPE in
692 "ECDSA")
Simon Butcherac22d112016-09-04 22:31:09 +0100693 M_SERVER_ARGS="$M_SERVER_ARGS crt_file=data_files/server5.crt key_file=data_files/server5.key"
Manuel Pégourié-Gonnard9ada01a2014-02-19 14:24:24 +0100694 O_SERVER_ARGS="$O_SERVER_ARGS -cert data_files/server5.crt -key data_files/server5.key"
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100695 G_SERVER_ARGS="$G_SERVER_ARGS --x509certfile data_files/server5.crt --x509keyfile data_files/server5.key"
696
Manuel Pégourié-Gonnard1b149ef2014-02-27 14:38:29 +0100697 if [ "X$VERIFY" = "XYES" ]; then
Simon Butcherac22d112016-09-04 22:31:09 +0100698 M_CLIENT_ARGS="$M_CLIENT_ARGS crt_file=data_files/server6.crt key_file=data_files/server6.key"
Manuel Pégourié-Gonnard1b149ef2014-02-27 14:38:29 +0100699 O_CLIENT_ARGS="$O_CLIENT_ARGS -cert data_files/server6.crt -key data_files/server6.key"
Manuel Pégourié-Gonnarda4371442014-03-13 16:21:59 +0100700 G_CLIENT_ARGS="$G_CLIENT_ARGS --x509certfile data_files/server6.crt --x509keyfile data_files/server6.key"
Manuel Pégourié-Gonnard1b149ef2014-02-27 14:38:29 +0100701 else
Simon Butcherac22d112016-09-04 22:31:09 +0100702 M_CLIENT_ARGS="$M_CLIENT_ARGS crt_file=none key_file=none"
Manuel Pégourié-Gonnard1b149ef2014-02-27 14:38:29 +0100703 fi
Manuel Pégourié-Gonnardd941a792014-02-19 13:35:52 +0100704 ;;
705
706 "RSA")
Manuel Pégourié-Gonnard499bf4c2020-08-21 12:24:32 +0200707 M_SERVER_ARGS="$M_SERVER_ARGS crt_file=data_files/server2-sha256.crt key_file=data_files/server2.key"
708 O_SERVER_ARGS="$O_SERVER_ARGS -cert data_files/server2-sha256.crt -key data_files/server2.key"
709 G_SERVER_ARGS="$G_SERVER_ARGS --x509certfile data_files/server2-sha256.crt --x509keyfile data_files/server2.key"
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100710
Manuel Pégourié-Gonnard1b149ef2014-02-27 14:38:29 +0100711 if [ "X$VERIFY" = "XYES" ]; then
Manuel Pégourié-Gonnard499bf4c2020-08-21 12:24:32 +0200712 M_CLIENT_ARGS="$M_CLIENT_ARGS crt_file=data_files/cert_sha256.crt key_file=data_files/server1.key"
713 O_CLIENT_ARGS="$O_CLIENT_ARGS -cert data_files/cert_sha256.crt -key data_files/server1.key"
714 G_CLIENT_ARGS="$G_CLIENT_ARGS --x509certfile data_files/cert_sha256.crt --x509keyfile data_files/server1.key"
Manuel Pégourié-Gonnard1b149ef2014-02-27 14:38:29 +0100715 else
Simon Butcherac22d112016-09-04 22:31:09 +0100716 M_CLIENT_ARGS="$M_CLIENT_ARGS crt_file=none key_file=none"
Manuel Pégourié-Gonnard1b149ef2014-02-27 14:38:29 +0100717 fi
Manuel Pégourié-Gonnardd941a792014-02-19 13:35:52 +0100718 ;;
719
720 "PSK")
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100721 # give RSA-PSK-capable server a RSA cert
Manuel Pégourié-Gonnard1b149ef2014-02-27 14:38:29 +0100722 # (should be a separate type, but harder to close with openssl)
Manuel Pégourié-Gonnard499bf4c2020-08-21 12:24:32 +0200723 M_SERVER_ARGS="$M_SERVER_ARGS psk=6162636465666768696a6b6c6d6e6f70 ca_file=none crt_file=data_files/server2-sha256.crt key_file=data_files/server2.key"
Manuel Pégourié-Gonnard1b149ef2014-02-27 14:38:29 +0100724 O_SERVER_ARGS="$O_SERVER_ARGS -psk 6162636465666768696a6b6c6d6e6f70 -nocert"
Manuel Pégourié-Gonnard499bf4c2020-08-21 12:24:32 +0200725 G_SERVER_ARGS="$G_SERVER_ARGS --x509certfile data_files/server2-sha256.crt --x509keyfile data_files/server2.key --pskpasswd data_files/passwd.psk"
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100726
Simon Butcherac22d112016-09-04 22:31:09 +0100727 M_CLIENT_ARGS="$M_CLIENT_ARGS psk=6162636465666768696a6b6c6d6e6f70 crt_file=none key_file=none"
Manuel Pégourié-Gonnard9ada01a2014-02-19 14:24:24 +0100728 O_CLIENT_ARGS="$O_CLIENT_ARGS -psk 6162636465666768696a6b6c6d6e6f70"
Manuel Pégourié-Gonnarda4371442014-03-13 16:21:59 +0100729 G_CLIENT_ARGS="$G_CLIENT_ARGS --pskusername Client_identity --pskkey=6162636465666768696a6b6c6d6e6f70"
Manuel Pégourié-Gonnardd941a792014-02-19 13:35:52 +0100730 ;;
731 esac
732}
733
Simon Butcherac22d112016-09-04 22:31:09 +0100734# is_mbedtls <cmd_line>
735is_mbedtls() {
Gilles Peskineb20028b2023-01-26 21:34:01 +0100736 case $1 in
737 *ssl_client2*) true;;
738 *ssl_server2*) true;;
739 *) false;;
740 esac
Manuel Pégourié-Gonnard3eec6042014-02-27 15:37:24 +0100741}
742
743# has_mem_err <log_file_name>
744has_mem_err() {
745 if ( grep -F 'All heap blocks were freed -- no leaks are possible' "$1" &&
746 grep -F 'ERROR SUMMARY: 0 errors from 0 contexts' "$1" ) > /dev/null
747 then
748 return 1 # false: does not have errors
749 else
750 return 0 # true: has errors
751 fi
752}
753
Gilles Peskine12c49c72017-12-14 19:02:00 +0100754# Wait for process $2 to be listening on port $1
755if type lsof >/dev/null 2>/dev/null; then
756 wait_server_start() {
757 START_TIME=$(date +%s)
758 if is_dtls "$MODE"; then
759 proto=UDP
760 else
761 proto=TCP
762 fi
763 while ! lsof -a -n -b -i "$proto:$1" -p "$2" >/dev/null 2>/dev/null; do
764 if [ $(( $(date +%s) - $START_TIME )) -gt $DOG_DELAY ]; then
765 echo "SERVERSTART TIMEOUT"
766 echo "SERVERSTART TIMEOUT" >> $SRV_OUT
767 break
768 fi
769 # Linux and *BSD support decimal arguments to sleep. On other
770 # OSes this may be a tight loop.
771 sleep 0.1 2>/dev/null || true
772 done
773 }
774else
Gilles Peskine3c9e2b52018-01-08 12:38:15 +0100775 echo "Warning: lsof not available, wait_server_start = sleep"
Gilles Peskine12c49c72017-12-14 19:02:00 +0100776 wait_server_start() {
Manuel Pégourié-Gonnard0d225da2018-01-22 10:22:09 +0100777 sleep 2
Gilles Peskine12c49c72017-12-14 19:02:00 +0100778 }
779fi
780
781
Manuel Pégourié-Gonnard304beef2014-02-19 14:45:00 +0100782# start_server <name>
783# also saves name and command
784start_server() {
Manuel Pégourié-Gonnard304beef2014-02-19 14:45:00 +0100785 case $1 in
786 [Oo]pen*)
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100787 SERVER_CMD="$OPENSSL s_server $O_SERVER_ARGS"
Manuel Pégourié-Gonnard304beef2014-02-19 14:45:00 +0100788 ;;
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100789 [Gg]nu*)
Manuel Pégourié-Gonnard74faf3c2014-03-13 18:47:44 +0100790 SERVER_CMD="$GNUTLS_SERV $G_SERVER_ARGS --priority $G_SERVER_PRIO"
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100791 ;;
Manuel Pégourié-Gonnarda8f3b752015-01-22 17:05:05 +0000792 mbed*)
Simon Butcherac22d112016-09-04 22:31:09 +0100793 SERVER_CMD="$M_SRV $M_SERVER_ARGS"
Manuel Pégourié-Gonnard3eec6042014-02-27 15:37:24 +0100794 if [ "$MEMCHECK" -gt 0 ]; then
795 SERVER_CMD="valgrind --leak-check=full $SERVER_CMD"
796 fi
Manuel Pégourié-Gonnard304beef2014-02-19 14:45:00 +0100797 ;;
798 *)
799 echo "error: invalid server name: $1" >&2
800 exit 1
801 ;;
802 esac
803 SERVER_NAME=$1
804
805 log "$SERVER_CMD"
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +0200806 echo "$SERVER_CMD" > $SRV_OUT
Manuel Pégourié-Gonnardd1af1022014-07-11 17:01:06 +0200807 # for servers without -www or equivalent
Manuel Pégourié-Gonnard82cf0a12015-02-09 13:05:54 +0000808 while :; do echo bla; sleep 1; done | $SERVER_CMD >> $SRV_OUT 2>&1 &
Yanray Wang12885972023-01-13 11:42:11 +0800809 SRV_PID=$!
Manuel Pégourié-Gonnard304beef2014-02-19 14:45:00 +0100810
Yanray Wang12885972023-01-13 11:42:11 +0800811 wait_server_start "$PORT" "$SRV_PID"
Manuel Pégourié-Gonnard304beef2014-02-19 14:45:00 +0100812}
813
Manuel Pégourié-Gonnard16494492014-08-31 10:37:14 +0200814# terminate the running server
Manuel Pégourié-Gonnard95957712014-02-19 15:29:38 +0100815stop_server() {
Yanray Wang12885972023-01-13 11:42:11 +0800816 # For Ubuntu 22.04, `Terminated` message is outputed by wait command.
817 # To remove it from stdout, redirect stdout/stderr to SRV_OUT
818 kill $SRV_PID >/dev/null 2>&1
819 wait $SRV_PID >> $SRV_OUT 2>&1
Manuel Pégourié-Gonnard3eec6042014-02-27 15:37:24 +0100820
821 if [ "$MEMCHECK" -gt 0 ]; then
Simon Butcherac22d112016-09-04 22:31:09 +0100822 if is_mbedtls "$SERVER_CMD" && has_mem_err $SRV_OUT; then
Manuel Pégourié-Gonnard3eec6042014-02-27 15:37:24 +0100823 echo " ! Server had memory errors"
Manuel Pégourié-Gonnard72e51ee2014-08-31 10:22:11 +0200824 SRVMEM=$(( $SRVMEM + 1 ))
Manuel Pégourié-Gonnard3eec6042014-02-27 15:37:24 +0100825 return
826 fi
827 fi
828
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +0200829 rm -f $SRV_OUT
Manuel Pégourié-Gonnard95957712014-02-19 15:29:38 +0100830}
831
Manuel Pégourié-Gonnarda9062e92014-02-25 16:21:22 +0100832# kill the running server (used when killed by signal)
833cleanup() {
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +0200834 rm -f $SRV_OUT $CLI_OUT
Yanray Wang12885972023-01-13 11:42:11 +0800835 kill $SRV_PID >/dev/null 2>&1
Manuel Pégourié-Gonnard16494492014-08-31 10:37:14 +0200836 kill $WATCHDOG_PID >/dev/null 2>&1
Manuel Pégourié-Gonnarda9062e92014-02-25 16:21:22 +0100837 exit 1
838}
839
Manuel Pégourié-Gonnardc0f6a692014-08-30 22:41:47 +0200840# wait for client to terminate and set EXIT
841# must be called right after starting the client
842wait_client_done() {
843 CLI_PID=$!
844
845 ( sleep "$DOG_DELAY"; echo "TIMEOUT" >> $CLI_OUT; kill $CLI_PID ) &
846 WATCHDOG_PID=$!
847
Yanray Wang05f940b2023-01-13 10:52:41 +0800848 # For Ubuntu 22.04, `Terminated` message is outputed by wait command.
849 # To remove it from stdout, redirect stdout/stderr to CLI_OUT
850 wait $CLI_PID >> $CLI_OUT 2>&1
Manuel Pégourié-Gonnardc0f6a692014-08-30 22:41:47 +0200851 EXIT=$?
852
Yanray Wang05f940b2023-01-13 10:52:41 +0800853 kill $WATCHDOG_PID >/dev/null 2>&1
854 wait $WATCHDOG_PID >> $CLI_OUT 2>&1
Manuel Pégourié-Gonnardc0f6a692014-08-30 22:41:47 +0200855
856 echo "EXIT: $EXIT" >> $CLI_OUT
857}
858
Yanray Wangfb784b22023-03-02 11:55:55 +0800859# uniform_title <CLIENT> <SERVER> <STANDARD_CIPHER_SUITE>
860# $TITLE is considered as test case description for both --list-test-case and
861# MBEDTLS_TEST_OUTCOME_FILE. This function aims to control the format of
862# each test case description.
863uniform_title() {
864 TITLE="$1->$2 $MODE,$VERIF $3"
Yanray Wang3fcd3a72023-02-24 17:07:47 +0800865}
866
Yanray Wangad470632023-02-20 14:58:03 +0800867# record_outcome <outcome> [<failure-reason>]
868record_outcome() {
869 echo "$1"
870 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
871 # The test outcome file has the format (in single line):
872 # platform;configuration;
873 # test suite name;test case description;
874 # PASS/FAIL/SKIP;[failure cause]
875 printf '%s;%s;%s;%s;%s;%s\n' \
876 "$MBEDTLS_TEST_PLATFORM" "$MBEDTLS_TEST_CONFIGURATION" \
877 "compat" "$TITLE" \
878 "$1" "${2-}" \
879 >> "$MBEDTLS_TEST_OUTCOME_FILE"
880 fi
881}
882
Gilles Peskine17838702023-08-28 17:36:22 +0200883save_logs() {
884 cp $SRV_OUT c-srv-${TESTS}.log
885 cp $CLI_OUT c-cli-${TESTS}.log
886}
887
Yanray Wangf45a8ea2023-02-20 15:49:10 +0800888# display additional information if test case fails
889report_fail() {
Yanray Wangad470632023-02-20 14:58:03 +0800890 FAIL_PROMPT="outputs saved to c-srv-${TESTS}.log, c-cli-${TESTS}.log"
891 record_outcome "FAIL" "$FAIL_PROMPT"
Gilles Peskine17838702023-08-28 17:36:22 +0200892 save_logs
Yanray Wangad470632023-02-20 14:58:03 +0800893 echo " ! $FAIL_PROMPT"
Yanray Wangf45a8ea2023-02-20 15:49:10 +0800894
895 if [ "${LOG_FAILURE_ON_STDOUT:-0}" != 0 ]; then
896 echo " ! server output:"
897 cat c-srv-${TESTS}.log
898 echo " ! ==================================================="
899 echo " ! client output:"
900 cat c-cli-${TESTS}.log
901 fi
902}
903
Gilles Peskine47aab852023-01-26 21:16:34 +0100904# run_client PROGRAM_NAME STANDARD_CIPHER_SUITE PROGRAM_CIPHER_SUITE
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +0100905run_client() {
Manuel Pégourié-Gonnard87ae3032014-02-27 11:12:30 +0100906 # announce what we're going to do
Manuel Pégourié-Gonnard72e51ee2014-08-31 10:22:11 +0200907 TESTS=$(( $TESTS + 1 ))
Yanray Wangfb784b22023-03-02 11:55:55 +0800908 uniform_title "${1%"${1#?}"}" "${SERVER_NAME%"${SERVER_NAME#?}"}" $2
909 DOTS72="........................................................................"
910 printf "%s %.*s " "$TITLE" "$((71 - ${#TITLE}))" "$DOTS72"
Manuel Pégourié-Gonnard87ae3032014-02-27 11:12:30 +0100911
Manuel Pégourié-Gonnard53aef812014-07-11 17:41:24 +0200912 # should we skip?
913 if [ "X$SKIP_NEXT" = "XYES" ]; then
914 SKIP_NEXT="NO"
Yanray Wangad470632023-02-20 14:58:03 +0800915 record_outcome "SKIP"
Manuel Pégourié-Gonnard53aef812014-07-11 17:41:24 +0200916 SKIPPED=$(( $SKIPPED + 1 ))
917 return
918 fi
919
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +0100920 # run the command and interpret result
921 case $1 in
922 [Oo]pen*)
Gilles Peskine47aab852023-01-26 21:16:34 +0100923 CLIENT_CMD="$OPENSSL s_client $O_CLIENT_ARGS -cipher $3"
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +0100924 log "$CLIENT_CMD"
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +0200925 echo "$CLIENT_CMD" > $CLI_OUT
Manuel Pégourié-Gonnard9afdc832015-08-04 17:15:13 +0200926 printf 'GET HTTP/1.0\r\n\r\n' | $CLIENT_CMD >> $CLI_OUT 2>&1 &
Manuel Pégourié-Gonnardc0f6a692014-08-30 22:41:47 +0200927 wait_client_done
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +0100928
Manuel Pégourié-Gonnard72e51ee2014-08-31 10:22:11 +0200929 if [ $EXIT -eq 0 ]; then
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +0100930 RESULT=0
931 else
Pengyu Lv9e7bb2a2023-02-23 15:24:47 +0800932 # If it is NULL cipher ...
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +0200933 if grep 'Cipher is (NONE)' $CLI_OUT >/dev/null; then
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +0100934 RESULT=1
935 else
936 RESULT=2
937 fi
938 fi
939 ;;
940
Manuel Pégourié-Gonnarda4371442014-03-13 16:21:59 +0100941 [Gg]nu*)
Manuel Pégourié-Gonnard29980b12014-07-10 20:12:56 +0200942 # need to force IPv4 with UDP, but keep localhost for auth
943 if is_dtls "$MODE"; then
944 G_HOST="127.0.0.1"
945 else
946 G_HOST="localhost"
947 fi
Gilles Peskine47aab852023-01-26 21:16:34 +0100948 CLIENT_CMD="$GNUTLS_CLI $G_CLIENT_ARGS --priority $G_PRIO_MODE:$3 $G_HOST"
Manuel Pégourié-Gonnarda4371442014-03-13 16:21:59 +0100949 log "$CLIENT_CMD"
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +0200950 echo "$CLIENT_CMD" > $CLI_OUT
Manuel Pégourié-Gonnard9afdc832015-08-04 17:15:13 +0200951 printf 'GET HTTP/1.0\r\n\r\n' | $CLIENT_CMD >> $CLI_OUT 2>&1 &
Manuel Pégourié-Gonnardc0f6a692014-08-30 22:41:47 +0200952 wait_client_done
Manuel Pégourié-Gonnarda4371442014-03-13 16:21:59 +0100953
Manuel Pégourié-Gonnard72e51ee2014-08-31 10:22:11 +0200954 if [ $EXIT -eq 0 ]; then
Manuel Pégourié-Gonnarda4371442014-03-13 16:21:59 +0100955 RESULT=0
956 else
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +0100957 RESULT=2
958 # interpret early failure, with a handshake_failure alert
959 # before the server hello, as "no ciphersuite in common"
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +0200960 if grep -F 'Received alert [40]: Handshake failed' $CLI_OUT; then
961 if grep -i 'SERVER HELLO .* was received' $CLI_OUT; then :
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +0100962 else
963 RESULT=1
964 fi
965 fi >/dev/null
Manuel Pégourié-Gonnarda4371442014-03-13 16:21:59 +0100966 fi
967 ;;
968
Manuel Pégourié-Gonnarda8f3b752015-01-22 17:05:05 +0000969 mbed*)
Gilles Peskine47aab852023-01-26 21:16:34 +0100970 CLIENT_CMD="$M_CLI $M_CLIENT_ARGS force_ciphersuite=$3"
Manuel Pégourié-Gonnard3eec6042014-02-27 15:37:24 +0100971 if [ "$MEMCHECK" -gt 0 ]; then
972 CLIENT_CMD="valgrind --leak-check=full $CLIENT_CMD"
973 fi
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +0100974 log "$CLIENT_CMD"
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +0200975 echo "$CLIENT_CMD" > $CLI_OUT
Manuel Pégourié-Gonnardc0f6a692014-08-30 22:41:47 +0200976 $CLIENT_CMD >> $CLI_OUT 2>&1 &
977 wait_client_done
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +0100978
979 case $EXIT in
Simon Butcherac22d112016-09-04 22:31:09 +0100980 # Success
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +0100981 "0") RESULT=0 ;;
Simon Butcherac22d112016-09-04 22:31:09 +0100982
983 # Ciphersuite not supported
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +0100984 "2") RESULT=1 ;;
Simon Butcherac22d112016-09-04 22:31:09 +0100985
986 # Error
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +0100987 *) RESULT=2 ;;
988 esac
Manuel Pégourié-Gonnard3eec6042014-02-27 15:37:24 +0100989
990 if [ "$MEMCHECK" -gt 0 ]; then
Simon Butcherac22d112016-09-04 22:31:09 +0100991 if is_mbedtls "$CLIENT_CMD" && has_mem_err $CLI_OUT; then
Manuel Pégourié-Gonnard3eec6042014-02-27 15:37:24 +0100992 RESULT=2
993 fi
994 fi
995
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +0100996 ;;
997
998 *)
999 echo "error: invalid client name: $1" >&2
1000 exit 1
1001 ;;
1002 esac
1003
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +02001004 echo "EXIT: $EXIT" >> $CLI_OUT
Manuel Pégourié-Gonnarde01af4c2014-03-25 14:16:44 +01001005
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +01001006 # report and count result
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +01001007 case $RESULT in
1008 "0")
Yanray Wangad470632023-02-20 14:58:03 +08001009 record_outcome "PASS"
Gilles Peskine17838702023-08-28 17:36:22 +02001010 if [ "$PRESERVE_LOGS" -gt 0 ]; then
1011 save_logs
1012 fi
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +01001013 ;;
1014 "1")
Yanray Wangad470632023-02-20 14:58:03 +08001015 record_outcome "SKIP"
Manuel Pégourié-Gonnard72e51ee2014-08-31 10:22:11 +02001016 SKIPPED=$(( $SKIPPED + 1 ))
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +01001017 ;;
1018 "2")
Yanray Wangf45a8ea2023-02-20 15:49:10 +08001019 report_fail
Manuel Pégourié-Gonnard72e51ee2014-08-31 10:22:11 +02001020 FAILED=$(( $FAILED + 1 ))
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +01001021 ;;
1022 esac
Manuel Pégourié-Gonnard87ae3032014-02-27 11:12:30 +01001023
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +02001024 rm -f $CLI_OUT
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +01001025}
1026
Manuel Pégourié-Gonnard9dea8bd2014-02-26 18:21:02 +01001027#
1028# MAIN
1029#
1030
Manuel Pégourié-Gonnard3947d042014-03-14 18:13:53 +01001031get_options "$@"
1032
Yanray Wangad470632023-02-20 14:58:03 +08001033# Make the outcome file path relative to the original directory, not
1034# to .../tests
1035case "$MBEDTLS_TEST_OUTCOME_FILE" in
1036 [!/]*)
1037 MBEDTLS_TEST_OUTCOME_FILE="$ORIGINAL_PWD/$MBEDTLS_TEST_OUTCOME_FILE"
1038 ;;
1039esac
1040
Manuel Pégourié-Gonnardf7a26902014-02-27 12:25:54 +01001041# sanity checks, avoid an avalanche of errors
Simon Butcherac22d112016-09-04 22:31:09 +01001042if [ ! -x "$M_SRV" ]; then
1043 echo "Command '$M_SRV' is not an executable file" >&2
Manuel Pégourié-Gonnardf7a26902014-02-27 12:25:54 +01001044 exit 1
1045fi
Simon Butcherac22d112016-09-04 22:31:09 +01001046if [ ! -x "$M_CLI" ]; then
1047 echo "Command '$M_CLI' is not an executable file" >&2
Manuel Pégourié-Gonnardf7a26902014-02-27 12:25:54 +01001048 exit 1
1049fi
Manuel Pégourié-Gonnard3947d042014-03-14 18:13:53 +01001050
1051if echo "$PEERS" | grep -i openssl > /dev/null; then
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01001052 if which "$OPENSSL" >/dev/null 2>&1; then :; else
1053 echo "Command '$OPENSSL' not found" >&2
Manuel Pégourié-Gonnard74faf3c2014-03-13 18:47:44 +01001054 exit 1
1055 fi
Manuel Pégourié-Gonnard3947d042014-03-14 18:13:53 +01001056fi
Manuel Pégourié-Gonnardf7a26902014-02-27 12:25:54 +01001057
Manuel Pégourié-Gonnard3947d042014-03-14 18:13:53 +01001058if echo "$PEERS" | grep -i gnutls > /dev/null; then
1059 for CMD in "$GNUTLS_CLI" "$GNUTLS_SERV"; do
1060 if which "$CMD" >/dev/null 2>&1; then :; else
1061 echo "Command '$CMD' not found" >&2
1062 exit 1
1063 fi
1064 done
1065fi
1066
1067for PEER in $PEERS; do
1068 case "$PEER" in
Manuel Pégourié-Gonnarda8f3b752015-01-22 17:05:05 +00001069 mbed*|[Oo]pen*|[Gg]nu*)
Manuel Pégourié-Gonnard3947d042014-03-14 18:13:53 +01001070 ;;
1071 *)
1072 echo "Unknown peers: $PEER" >&2
1073 exit 1
1074 esac
1075done
Manuel Pégourié-Gonnard9dea8bd2014-02-26 18:21:02 +01001076
Manuel Pégourié-Gonnard8066b812014-05-28 22:59:30 +02001077# Pick a "unique" port in the range 10000-19999.
1078PORT="0000$$"
Manuel Pégourié-Gonnardfab2a3c2014-06-16 16:54:36 +02001079PORT="1$(echo $PORT | tail -c 5)"
Manuel Pégourié-Gonnard8066b812014-05-28 22:59:30 +02001080
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +02001081# Also pick a unique name for intermediate files
1082SRV_OUT="srv_out.$$"
1083CLI_OUT="cli_out.$$"
1084
Manuel Pégourié-Gonnardc0f6a692014-08-30 22:41:47 +02001085# client timeout delay: be more patient with valgrind
1086if [ "$MEMCHECK" -gt 0 ]; then
1087 DOG_DELAY=30
1088else
1089 DOG_DELAY=10
1090fi
1091
Manuel Pégourié-Gonnard53aef812014-07-11 17:41:24 +02001092SKIP_NEXT="NO"
1093
Manuel Pégourié-Gonnarda9062e92014-02-25 16:21:22 +01001094trap cleanup INT TERM HUP
1095
Yanray Wang35c0ead2023-02-07 10:41:04 +08001096for MODE in $MODES; do
Yanray Wang30382972023-02-08 12:38:31 +08001097 for TYPE in $TYPES; do
Yanray Wang35c0ead2023-02-07 10:41:04 +08001098
Yanray Wang30382972023-02-08 12:38:31 +08001099 # PSK cipher suites do not allow client certificate verification.
1100 # This means PSK test cases with VERIFY=YES should be replaced by
1101 # VERIFY=NO or be ignored. SUB_VERIFIES variable is used to constrain
1102 # verification option for PSK test cases.
1103 SUB_VERIFIES=$VERIFIES
1104 if [ "$TYPE" = "PSK" ]; then
1105 SUB_VERIFIES="NO"
1106 fi
Yanray Wang35c0ead2023-02-07 10:41:04 +08001107
Yanray Wang30382972023-02-08 12:38:31 +08001108 for VERIFY in $SUB_VERIFIES; do
1109 VERIF=$(echo $VERIFY | tr '[:upper:]' '[:lower:]')
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001110 for PEER in $PEERS; do
Paul Bakker7e5e7ca2013-04-17 19:27:58 +02001111
Manuel Pégourié-Gonnard95957712014-02-19 15:29:38 +01001112 setup_arguments
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +01001113
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001114 case "$PEER" in
Manuel Pégourié-Gonnardd3313192013-09-13 19:20:37 +02001115
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001116 [Oo]pen*)
Paul Bakker398cb512012-04-10 08:22:31 +00001117
Manuel Pégourié-Gonnard39e2ca92015-08-04 16:43:37 +02001118 if test "$OSSL_NO_DTLS" -gt 0 && is_dtls "$MODE"; then
1119 continue;
1120 fi
1121
Ronald Cron618955d2022-03-23 14:14:19 +01001122 # OpenSSL <1.0.2 doesn't support DTLS 1.2. Check if OpenSSL
1123 # supports $O_MODE from the s_server help. (The s_client
1124 # help isn't accurate as of 1.0.2g: it supports DTLS 1.2
1125 # but doesn't list it. But the s_server help seems to be
1126 # accurate.)
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01001127 if ! $OPENSSL s_server -help 2>&1 | grep -q "^ *-$O_MODE "; then
Ronald Cron618955d2022-03-23 14:14:19 +01001128 continue;
1129 fi
1130
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001131 reset_ciphersuites
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +01001132 add_common_ciphersuites
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001133 add_openssl_ciphersuites
1134 filter_ciphersuites
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +01001135
Simon Butcherac22d112016-09-04 22:31:09 +01001136 if [ "X" != "X$M_CIPHERS" ]; then
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001137 start_server "OpenSSL"
Gilles Peskine47aab852023-01-26 21:16:34 +01001138 translate_ciphers m $M_CIPHERS
1139 for i in $ciphers; do
Pengyu Lv5e780df2023-02-21 14:19:27 +08001140 o_check_ciphersuite "${i%%=*}"
Gilles Peskine47aab852023-01-26 21:16:34 +01001141 run_client mbedTLS ${i%%=*} ${i#*=}
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001142 done
1143 stop_server
1144 fi
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +01001145
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001146 if [ "X" != "X$O_CIPHERS" ]; then
Manuel Pégourié-Gonnarde4f6edc2015-01-22 16:43:54 +00001147 start_server "mbedTLS"
Gilles Peskine47aab852023-01-26 21:16:34 +01001148 translate_ciphers o $O_CIPHERS
1149 for i in $ciphers; do
Pengyu Lv07d50852023-02-22 12:17:26 +08001150 o_check_ciphersuite "${i%%=*}"
Gilles Peskine47aab852023-01-26 21:16:34 +01001151 run_client OpenSSL ${i%%=*} ${i#*=}
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001152 done
1153 stop_server
1154 fi
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +01001155
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001156 ;;
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +01001157
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001158 [Gg]nu*)
Paul Bakkerfab5c822012-02-06 16:45:10 +00001159
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001160 reset_ciphersuites
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +01001161 add_common_ciphersuites
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001162 add_gnutls_ciphersuites
1163 filter_ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +00001164
Simon Butcherac22d112016-09-04 22:31:09 +01001165 if [ "X" != "X$M_CIPHERS" ]; then
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001166 start_server "GnuTLS"
Gilles Peskine47aab852023-01-26 21:16:34 +01001167 translate_ciphers m $M_CIPHERS
1168 for i in $ciphers; do
1169 run_client mbedTLS ${i%%=*} ${i#*=}
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001170 done
1171 stop_server
1172 fi
1173
1174 if [ "X" != "X$G_CIPHERS" ]; then
Manuel Pégourié-Gonnarde4f6edc2015-01-22 16:43:54 +00001175 start_server "mbedTLS"
Gilles Peskine47aab852023-01-26 21:16:34 +01001176 translate_ciphers g $G_CIPHERS
1177 for i in $ciphers; do
1178 run_client GnuTLS ${i%%=*} ${i#*=}
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001179 done
1180 stop_server
1181 fi
1182
1183 ;;
1184
Manuel Pégourié-Gonnarda8f3b752015-01-22 17:05:05 +00001185 mbed*)
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001186
1187 reset_ciphersuites
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +01001188 add_common_ciphersuites
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001189 add_openssl_ciphersuites
1190 add_gnutls_ciphersuites
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001191 add_mbedtls_ciphersuites
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001192 filter_ciphersuites
1193
Simon Butcherac22d112016-09-04 22:31:09 +01001194 if [ "X" != "X$M_CIPHERS" ]; then
Manuel Pégourié-Gonnarde4f6edc2015-01-22 16:43:54 +00001195 start_server "mbedTLS"
Gilles Peskine47aab852023-01-26 21:16:34 +01001196 translate_ciphers m $M_CIPHERS
1197 for i in $ciphers; do
1198 run_client mbedTLS ${i%%=*} ${i#*=}
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001199 done
1200 stop_server
1201 fi
1202
1203 ;;
1204
Manuel Pégourié-Gonnarda1a9f9a2014-03-25 18:04:59 +01001205 *)
Paul Bakker1ebc0c52014-05-22 15:47:58 +02001206 echo "Unknown peer: $PEER" >&2
Manuel Pégourié-Gonnarda1a9f9a2014-03-25 18:04:59 +01001207 exit 1
1208 ;;
1209
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +01001210 esac
1211
1212 done
Manuel Pégourié-Gonnard95957712014-02-19 15:29:38 +01001213 done
1214 done
Manuel Pégourié-Gonnard9791a402013-08-27 19:57:15 +02001215done
Manuel Pégourié-Gonnard70064fd2013-08-27 22:00:47 +02001216
Manuel Pégourié-Gonnard4145b892014-02-24 13:20:14 +01001217echo "------------------------------------------------------------------------"
Manuel Pégourié-Gonnard70064fd2013-08-27 22:00:47 +02001218
Tom Cosgrovefc0e79e2023-01-13 12:13:41 +00001219if [ $FAILED -ne 0 -o $SRVMEM -ne 0 ]; then
Manuel Pégourié-Gonnardf46f1282014-12-11 11:51:28 +01001220 printf "FAILED"
Manuel Pégourié-Gonnard70064fd2013-08-27 22:00:47 +02001221else
Manuel Pégourié-Gonnardf46f1282014-12-11 11:51:28 +01001222 printf "PASSED"
Manuel Pégourié-Gonnard70064fd2013-08-27 22:00:47 +02001223fi
1224
Manuel Pégourié-Gonnardba0b8442014-03-13 17:57:45 +01001225if [ "$MEMCHECK" -gt 0 ]; then
Manuel Pégourié-Gonnard72e51ee2014-08-31 10:22:11 +02001226 MEMREPORT=", $SRVMEM server memory errors"
Manuel Pégourié-Gonnardba0b8442014-03-13 17:57:45 +01001227else
1228 MEMREPORT=""
1229fi
1230
Manuel Pégourié-Gonnard72e51ee2014-08-31 10:22:11 +02001231PASSED=$(( $TESTS - $FAILED ))
1232echo " ($PASSED / $TESTS tests ($SKIPPED skipped$MEMREPORT))"
Manuel Pégourié-Gonnard70064fd2013-08-27 22:00:47 +02001233
Manuel Pégourié-Gonnard72e51ee2014-08-31 10:22:11 +02001234FAILED=$(( $FAILED + $SRVMEM ))
Tom Cosgrovefc0e79e2023-01-13 12:13:41 +00001235if [ $FAILED -gt 255 ]; then
1236 # Clamp at 255 as caller gets exit code & 0xFF
1237 # (so 256 would be 0, or success, etc)
1238 FAILED=255
1239fi
Manuel Pégourié-Gonnard72e51ee2014-08-31 10:22:11 +02001240exit $FAILED