blob: 252736bb256cc481f969885b51b160af0cc63b33 [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
Bence Szépkútic7da1fe2020-05-26 01:54:15 +02006# SPDX-License-Identifier: Apache-2.0
7#
8# Licensed under the Apache License, Version 2.0 (the "License"); you may
9# not use this file except in compliance with the License.
10# You may obtain a copy of the License at
11#
12# http://www.apache.org/licenses/LICENSE-2.0
13#
14# Unless required by applicable law or agreed to in writing, software
15# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17# See the License for the specific language governing permissions and
18# limitations under the License.
19#
Simon Butcherac22d112016-09-04 22:31:09 +010020# Purpose
21#
22# Test interoperbility with OpenSSL, GnuTLS as well as itself.
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +010023#
24# Check each common ciphersuite, with each version, both ways (client/server),
25# with and without client authentication.
Manuel Pégourié-Gonnardeaadc502014-02-20 11:01:30 +010026
Manuel Pégourié-Gonnard913030c2014-03-28 10:12:38 +010027set -u
28
Jaeden Amero6e70eb22019-07-03 13:51:04 +010029# Limit the size of each log to 10 GiB, in case of failures with this script
30# where it may output seemingly unlimited length error logs.
31ulimit -f 20971520
32
Yanray Wangad470632023-02-20 14:58:03 +080033ORIGINAL_PWD=$PWD
34if ! cd "$(dirname "$0")"; then
35 exit 125
36fi
37
Manuel Pégourié-Gonnarda1a9f9a2014-03-25 18:04:59 +010038# initialise counters
Manuel Pégourié-Gonnard72e51ee2014-08-31 10:22:11 +020039TESTS=0
40FAILED=0
41SKIPPED=0
42SRVMEM=0
Manuel Pégourié-Gonnard70064fd2013-08-27 22:00:47 +020043
Antonin Décimo36e89b52019-01-23 15:24:37 +010044# default commands, can be overridden by the environment
Simon Butcherac22d112016-09-04 22:31:09 +010045: ${M_SRV:=../programs/ssl/ssl_server2}
46: ${M_CLI:=../programs/ssl/ssl_client2}
Manuel Pégourié-Gonnard6e666c22023-01-10 09:38:58 +010047: ${OPENSSL:=openssl}
Manuel Pégourié-Gonnard74faf3c2014-03-13 18:47:44 +010048: ${GNUTLS_CLI:=gnutls-cli}
49: ${GNUTLS_SERV:=gnutls-serv}
Manuel Pégourié-Gonnardf7a26902014-02-27 12:25:54 +010050
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +010051# The OPENSSL variable used to be OPENSSL_CMD for historical reasons.
52# To help the migration, error out if the old variable is set,
53# but only if it has a different value than the new one.
54if [ "${OPENSSL_CMD+set}" = set ]; then
55 # the variable is set, we can now check its value
56 if [ "$OPENSSL_CMD" != "$OPENSSL" ]; then
57 echo "Please use OPENSSL instead of OPENSSL_CMD." >&2
58 exit 125
59 fi
60fi
61
Manuel Pégourié-Gonnard1287f112014-08-31 16:20:58 +020062# do we have a recent enough GnuTLS?
Manuel Pégourié-Gonnard03db6b02015-06-26 15:45:30 +020063if ( which $GNUTLS_CLI && which $GNUTLS_SERV ) >/dev/null 2>&1; then
Manuel Pégourié-Gonnarddd459272014-10-24 12:57:37 +020064 G_VER="$( $GNUTLS_CLI --version | head -n1 )"
65 if echo "$G_VER" | grep '@VERSION@' > /dev/null; then # git version
Manuel Pégourié-Gonnard1287f112014-08-31 16:20:58 +020066 PEER_GNUTLS=" GnuTLS"
Manuel Pégourié-Gonnarddd459272014-10-24 12:57:37 +020067 else
68 eval $( echo $G_VER | sed 's/.* \([0-9]*\)\.\([0-9]\)*\.\([0-9]*\)$/MAJOR="\1" MINOR="\2" PATCH="\3"/' )
69 if [ $MAJOR -lt 3 -o \
70 \( $MAJOR -eq 3 -a $MINOR -lt 2 \) -o \
71 \( $MAJOR -eq 3 -a $MINOR -eq 2 -a $PATCH -lt 15 \) ]
72 then
73 PEER_GNUTLS=""
74 else
75 PEER_GNUTLS=" GnuTLS"
Manuel Pégourié-Gonnardc36b4322018-06-14 13:14:29 +020076 if [ $MINOR -lt 4 ]; then
77 GNUTLS_MINOR_LT_FOUR='x'
78 fi
Manuel Pégourié-Gonnarddd459272014-10-24 12:57:37 +020079 fi
Manuel Pégourié-Gonnard1287f112014-08-31 16:20:58 +020080 fi
81else
82 PEER_GNUTLS=""
83fi
84
Yanray Wangad470632023-02-20 14:58:03 +080085guess_config_name() {
86 if git diff --quiet ../include/mbedtls/mbedtls_config.h 2>/dev/null; then
87 echo "default"
88 else
89 echo "unknown"
90 fi
91}
92: ${MBEDTLS_TEST_OUTCOME_FILE=}
93: ${MBEDTLS_TEST_CONFIGURATION:="$(guess_config_name)"}
94: ${MBEDTLS_TEST_PLATFORM:="$(uname -s | tr -c \\n0-9A-Za-z _)-$(uname -m | tr -c \\n0-9A-Za-z _)"}
95
Manuel Pégourié-Gonnarda1a9f9a2014-03-25 18:04:59 +010096# default values for options
Manuel Pégourié-Gonnard636b5f12022-04-14 09:21:56 +020097# /!\ keep this synchronised with:
98# - basic-build-test.sh
99# - all.sh (multiple components)
Xiaofei Bai8b5c3822021-12-02 08:43:35 +0000100MODES="tls12 dtls12"
Paul Bakker1eeceae2012-11-23 14:25:34 +0100101VERIFIES="NO YES"
Manuel Pégourié-Gonnard7ebaf372013-08-27 21:03:33 +0200102TYPES="ECDSA RSA PSK"
Paul Bakkeraccd4eb2013-07-19 13:41:51 +0200103FILTER=""
Manuel Pégourié-Gonnard636b5f12022-04-14 09:21:56 +0200104# By default, exclude:
105# - NULL: excluded from our default config + requires OpenSSL legacy
Manuel Pégourié-Gonnard4111b732022-04-06 13:21:59 +0200106# - ARIA: requires OpenSSL >= 1.1.1
Manuel Pégourié-Gonnard9fece7e2018-06-18 11:38:22 +0200107# - ChachaPoly: requires OpenSSL >= 1.1.0
Yanray Wang20fa2ae2023-01-13 18:00:10 +0800108EXCLUDE='NULL\|ARIA\|CHACHA20_POLY1305'
Paul Bakkeraccd4eb2013-07-19 13:41:51 +0200109VERBOSE=""
Manuel Pégourié-Gonnard3eec6042014-02-27 15:37:24 +0100110MEMCHECK=0
Manuel Pégourié-Gonnarde4f6edc2015-01-22 16:43:54 +0000111PEERS="OpenSSL$PEER_GNUTLS mbedTLS"
Paul Bakkeraccd4eb2013-07-19 13:41:51 +0200112
Manuel Pégourié-Gonnard39e2ca92015-08-04 16:43:37 +0200113# hidden option: skip DTLS with OpenSSL
114# (travis CI has a version that doesn't work for us)
115: ${OSSL_NO_DTLS:=0}
116
Manuel Pégourié-Gonnard9dea8bd2014-02-26 18:21:02 +0100117print_usage() {
118 echo "Usage: $0"
Manuel Pégourié-Gonnardf46f1282014-12-11 11:51:28 +0100119 printf " -h|--help\tPrint this help.\n"
Gilles Peskine231befa2020-08-26 20:05:11 +0200120 printf " -f|--filter\tOnly matching ciphersuites are tested (Default: '%s')\n" "$FILTER"
121 printf " -e|--exclude\tMatching ciphersuites are excluded (Default: '%s')\n" "$EXCLUDE"
122 printf " -m|--modes\tWhich modes to perform (Default: '%s')\n" "$MODES"
123 printf " -t|--types\tWhich key exchange type to perform (Default: '%s')\n" "$TYPES"
124 printf " -V|--verify\tWhich verification modes to perform (Default: '%s')\n" "$VERIFIES"
125 printf " -p|--peers\tWhich peers to use (Default: '%s')\n" "$PEERS"
Manuel Pégourié-Gonnardf46f1282014-12-11 11:51:28 +0100126 printf " \tAlso available: GnuTLS (needs v3.2.15 or higher)\n"
127 printf " -M|--memcheck\tCheck memory leaks and errors.\n"
128 printf " -v|--verbose\tSet verbose output.\n"
Yanray Wangd8938372023-02-23 10:04:58 +0800129 printf " --list-test-case\tList all potential test cases (No Execution)\n"
Yanray Wangad470632023-02-20 14:58:03 +0800130 printf " --outcome-file\tFile where test outcomes are written\n"
131 printf " \t(default: \$MBEDTLS_TEST_OUTCOME_FILE, none if empty)\n"
Yanray Wangd8938372023-02-23 10:04:58 +0800132}
133
Yanray Wangfb784b22023-03-02 11:55:55 +0800134# print_test_case <CLIENT> <SERVER> <STANDARD_CIPHER_SUITE>
135print_test_case() {
136 for i in $3; do
137 uniform_title $1 $2 $i
138 echo $TITLE
139 done
140}
141
Yanray Wangcdc07082023-03-03 17:12:29 +0800142# list_test_case lists all potential test cases in compat.sh without execution
Yanray Wangd8938372023-02-23 10:04:58 +0800143list_test_case() {
144 reset_ciphersuites
145 for TYPE in $TYPES; do
146 add_common_ciphersuites
147 add_openssl_ciphersuites
148 add_gnutls_ciphersuites
149 add_mbedtls_ciphersuites
150 done
151
152 for VERIFY in $VERIFIES; do
153 VERIF=$(echo $VERIFY | tr '[:upper:]' '[:lower:]')
154 for MODE in $MODES; do
Yanray Wangfb784b22023-03-02 11:55:55 +0800155 print_test_case m O "$O_CIPHERS"
156 print_test_case O m "$O_CIPHERS"
157 print_test_case m G "$G_CIPHERS"
158 print_test_case G m "$G_CIPHERS"
159 print_test_case m m "$M_CIPHERS"
Yanray Wangd8938372023-02-23 10:04:58 +0800160 done
161 done
Manuel Pégourié-Gonnard9dea8bd2014-02-26 18:21:02 +0100162}
163
164get_options() {
165 while [ $# -gt 0 ]; do
166 case "$1" in
167 -f|--filter)
168 shift; FILTER=$1
169 ;;
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +0100170 -e|--exclude)
171 shift; EXCLUDE=$1
172 ;;
Manuel Pégourié-Gonnard9dea8bd2014-02-26 18:21:02 +0100173 -m|--modes)
174 shift; MODES=$1
175 ;;
176 -t|--types)
177 shift; TYPES=$1
178 ;;
179 -V|--verify)
180 shift; VERIFIES=$1
181 ;;
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +0100182 -p|--peers)
183 shift; PEERS=$1
184 ;;
Manuel Pégourié-Gonnard9dea8bd2014-02-26 18:21:02 +0100185 -v|--verbose)
186 VERBOSE=1
187 ;;
Manuel Pégourié-Gonnard3eec6042014-02-27 15:37:24 +0100188 -M|--memcheck)
189 MEMCHECK=1
190 ;;
Yanray Wangcdc07082023-03-03 17:12:29 +0800191 # Please check scripts/check_test_cases.py correspondingly
192 # if you have to modify option, --list-test-case
Yanray Wangd8938372023-02-23 10:04:58 +0800193 --list-test-case)
194 list_test_case
Yanray Wang14e052f2023-03-06 19:37:07 +0800195 exit $?
Yanray Wangd8938372023-02-23 10:04:58 +0800196 ;;
Yanray Wangad470632023-02-20 14:58:03 +0800197 --outcome-file)
198 shift; MBEDTLS_TEST_OUTCOME_FILE=$1
199 ;;
Manuel Pégourié-Gonnard9dea8bd2014-02-26 18:21:02 +0100200 -h|--help)
201 print_usage
202 exit 0
203 ;;
204 *)
205 echo "Unknown argument: '$1'"
206 print_usage
207 exit 1
208 ;;
209 esac
210 shift
211 done
Manuel Pégourié-Gonnard85a41782014-10-24 12:47:26 +0200212
213 # sanitize some options (modes checked later)
214 VERIFIES="$( echo $VERIFIES | tr [a-z] [A-Z] )"
215 TYPES="$( echo $TYPES | tr [a-z] [A-Z] )"
Manuel Pégourié-Gonnard9dea8bd2014-02-26 18:21:02 +0100216}
Paul Bakkeraccd4eb2013-07-19 13:41:51 +0200217
Manuel Pégourié-Gonnard95957712014-02-19 15:29:38 +0100218log() {
Paul Bakkeraccd4eb2013-07-19 13:41:51 +0200219 if [ "X" != "X$VERBOSE" ]; then
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100220 echo ""
Paul Bakkeraccd4eb2013-07-19 13:41:51 +0200221 echo "$@"
222 fi
223}
Paul Bakker10cd2252012-04-12 21:26:34 +0000224
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100225# is_dtls <mode>
226is_dtls()
227{
Xiaofei Bai8b5c3822021-12-02 08:43:35 +0000228 test "$1" = "dtls12"
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100229}
230
231# minor_ver <mode>
232minor_ver()
233{
234 case "$1" in
Xiaofei Bai8b5c3822021-12-02 08:43:35 +0000235 tls12|dtls12)
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100236 echo 3
237 ;;
238 *)
239 echo "error: invalid mode: $MODE" >&2
240 # exiting is no good here, typically called in a subshell
241 echo -1
242 esac
243}
244
Manuel Pégourié-Gonnarddfc8d5a2013-08-27 20:48:40 +0200245filter()
246{
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +0100247 LIST="$1"
Manuel Pégourié-Gonnarddfc8d5a2013-08-27 20:48:40 +0200248 NEW_LIST=""
249
Mateusz Starzyk5224e292021-02-22 14:36:29 +0100250 EXCLMODE="$EXCLUDE"
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100251
Manuel Pégourié-Gonnarddfc8d5a2013-08-27 20:48:40 +0200252 for i in $LIST;
253 do
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100254 NEW_LIST="$NEW_LIST $( echo "$i" | grep "$FILTER" | grep -v "$EXCLMODE" )"
Manuel Pégourié-Gonnarddfc8d5a2013-08-27 20:48:40 +0200255 done
256
Manuel Pégourié-Gonnard911622d2014-02-27 11:50:40 +0100257 # normalize whitespace
Manuel Pégourié-Gonnardf46f1282014-12-11 11:51:28 +0100258 echo "$NEW_LIST" | sed -e 's/[[:space:]][[:space:]]*/ /g' -e 's/^ //' -e 's/ $//'
Manuel Pégourié-Gonnarddfc8d5a2013-08-27 20:48:40 +0200259}
260
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100261filter_ciphersuites()
262{
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +0100263 if [ "X" != "X$FILTER" -o "X" != "X$EXCLUDE" ];
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100264 then
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200265 # Ciphersuite for Mbed TLS
Simon Butcherac22d112016-09-04 22:31:09 +0100266 M_CIPHERS=$( filter "$M_CIPHERS" )
267
268 # Ciphersuite for OpenSSL
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +0100269 O_CIPHERS=$( filter "$O_CIPHERS" )
Simon Butcherac22d112016-09-04 22:31:09 +0100270
271 # Ciphersuite for GnuTLS
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +0100272 G_CIPHERS=$( filter "$G_CIPHERS" )
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100273 fi
Manuel Pégourié-Gonnard29980b12014-07-10 20:12:56 +0200274
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200275 # For GnuTLS client -> Mbed TLS server,
Manuel Pégourié-Gonnardd1af1022014-07-11 17:01:06 +0200276 # we need to force IPv4 by connecting to 127.0.0.1 but then auth fails
Yanray Wang30382972023-02-08 12:38:31 +0800277 if is_dtls "$MODE" && [ "X$VERIFY" = "XYES" ]; then
Manuel Pégourié-Gonnard29980b12014-07-10 20:12:56 +0200278 G_CIPHERS=""
279 fi
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100280}
281
282reset_ciphersuites()
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100283{
Simon Butcherac22d112016-09-04 22:31:09 +0100284 M_CIPHERS=""
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100285 O_CIPHERS=""
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100286 G_CIPHERS=""
287}
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100288
Gilles Peskine47aab852023-01-26 21:16:34 +0100289# translate_ciphers {g|m|o} {STANDARD_CIPHER_SUITE_NAME...}
290# Set $ciphers to the cipher suite name translations for the specified
291# program (gnutls, mbedtls or openssl). $ciphers is a space-separated
292# list of entries of the form "STANDARD_NAME=PROGRAM_NAME".
293translate_ciphers()
Joe Subbianic3610ba2021-07-29 11:35:59 +0100294{
Gilles Peskine47aab852023-01-26 21:16:34 +0100295 ciphers=$(scripts/translate_ciphers.py "$@")
296 if [ $? -ne 0 ]; then
Joe Subbiani439a6962021-07-29 12:51:09 +0100297 echo "translate_ciphers.py failed with exit code $1" >&2
298 echo "$2" >&2
Joe Subbianic3610ba2021-07-29 11:35:59 +0100299 exit 1
300 fi
301}
302
Manuel Pégourié-Gonnard7299dfd2018-02-15 11:43:55 +0100303# Ciphersuites that can be used with all peers.
304# Since we currently have three possible peers, each ciphersuite should appear
305# three times: in each peer's list (with the name that this peer uses).
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +0100306add_common_ciphersuites()
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100307{
Joe Subbiani34d62622021-07-27 14:55:56 +0100308 CIPHERS=""
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100309 case $TYPE in
310
311 "ECDSA")
Joe Subbiani9f847612021-08-10 10:41:13 +0100312 CIPHERS="$CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800313 TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA \
314 TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 \
315 TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 \
316 TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA \
317 TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 \
318 TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 \
319 TLS_ECDHE_ECDSA_WITH_NULL_SHA \
Joe Subbiani9f847612021-08-10 10:41:13 +0100320 "
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100321 ;;
322
323 "RSA")
Joe Subbiani34d62622021-07-27 14:55:56 +0100324 CIPHERS="$CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800325 TLS_DHE_RSA_WITH_AES_128_CBC_SHA \
326 TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 \
327 TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 \
328 TLS_DHE_RSA_WITH_AES_256_CBC_SHA \
329 TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 \
330 TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 \
331 TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA \
332 TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA \
333 TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA \
334 TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 \
335 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 \
336 TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA \
337 TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 \
338 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 \
339 TLS_ECDHE_RSA_WITH_NULL_SHA \
340 TLS_RSA_WITH_AES_128_CBC_SHA \
341 TLS_RSA_WITH_AES_128_CBC_SHA256 \
342 TLS_RSA_WITH_AES_128_GCM_SHA256 \
343 TLS_RSA_WITH_AES_256_CBC_SHA \
344 TLS_RSA_WITH_AES_256_CBC_SHA256 \
345 TLS_RSA_WITH_AES_256_GCM_SHA384 \
346 TLS_RSA_WITH_CAMELLIA_128_CBC_SHA \
347 TLS_RSA_WITH_CAMELLIA_256_CBC_SHA \
348 TLS_RSA_WITH_NULL_MD5 \
349 TLS_RSA_WITH_NULL_SHA \
350 TLS_RSA_WITH_NULL_SHA256 \
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +0100351 "
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100352 ;;
353
354 "PSK")
Joe Subbiani34d62622021-07-27 14:55:56 +0100355 CIPHERS="$CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800356 TLS_PSK_WITH_AES_128_CBC_SHA \
357 TLS_PSK_WITH_AES_256_CBC_SHA \
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100358 "
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100359 ;;
360 esac
Joe Subbiani34d62622021-07-27 14:55:56 +0100361
Yanray Wang20fa2ae2023-01-13 18:00:10 +0800362 O_CIPHERS="$O_CIPHERS $CIPHERS"
363 G_CIPHERS="$G_CIPHERS $CIPHERS"
Joe Subbiani34d62622021-07-27 14:55:56 +0100364 M_CIPHERS="$M_CIPHERS $CIPHERS"
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100365}
366
Manuel Pégourié-Gonnard7299dfd2018-02-15 11:43:55 +0100367# Ciphersuites usable only with Mbed TLS and OpenSSL
Yanray Wang20fa2ae2023-01-13 18:00:10 +0800368# A list of ciphersuites in the standard naming convention is appended
369# to the list of Mbed TLS ciphersuites $M_CIPHERS and
370# to the list of OpenSSL ciphersuites $O_CIPHERS respectively.
371# Based on client's naming convention, all ciphersuite names will be
372# translated into another naming format before sent to the client.
Manuel Pégourié-Gonnard7299dfd2018-02-15 11:43:55 +0100373#
374# NOTE: for some reason RSA-PSK doesn't work with OpenSSL,
Manuel Pégourié-Gonnardce5673c2018-03-06 09:54:10 +0100375# so RSA-PSK ciphersuites need to go in other sections, see
Dave Rodgman017a1992022-03-31 14:07:01 +0100376# https://github.com/Mbed-TLS/mbedtls/issues/1419
Manuel Pégourié-Gonnard9fece7e2018-06-18 11:38:22 +0200377#
378# ChachaPoly suites are here rather than in "common", as they were added in
379# GnuTLS in 3.5.0 and the CI only has 3.4.x so far.
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +0100380add_openssl_ciphersuites()
381{
Joe Subbiani34d62622021-07-27 14:55:56 +0100382 CIPHERS=""
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +0100383 case $TYPE in
384
385 "ECDSA")
Joe Subbiani32df1452021-08-13 13:30:36 +0100386 CIPHERS="$CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800387 TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA \
388 TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 \
389 TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 \
390 TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA \
391 TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 \
392 TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 \
393 TLS_ECDH_ECDSA_WITH_NULL_SHA \
394 TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256 \
395 TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384 \
396 TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 \
Joe Subbiani9f847612021-08-10 10:41:13 +0100397 "
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +0100398 ;;
399
400 "RSA")
Joe Subbiani32df1452021-08-13 13:30:36 +0100401 CIPHERS="$CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800402 TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256 \
403 TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384 \
404 TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256 \
405 TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256 \
406 TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384 \
407 TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 \
408 TLS_RSA_WITH_ARIA_128_GCM_SHA256 \
409 TLS_RSA_WITH_ARIA_256_GCM_SHA384 \
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +0100410 "
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +0100411 ;;
412
413 "PSK")
Joe Subbiani9f847612021-08-10 10:41:13 +0100414 CIPHERS="$CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800415 TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256 \
416 TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384 \
417 TLS_DHE_PSK_WITH_CHACHA20_POLY1305_SHA256 \
418 TLS_ECDHE_PSK_WITH_CHACHA20_POLY1305_SHA256 \
419 TLS_PSK_WITH_ARIA_128_GCM_SHA256 \
420 TLS_PSK_WITH_ARIA_256_GCM_SHA384 \
421 TLS_PSK_WITH_CHACHA20_POLY1305_SHA256 \
Joe Subbiani9f847612021-08-10 10:41:13 +0100422 "
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +0100423 ;;
424 esac
Joe Subbiani34d62622021-07-27 14:55:56 +0100425
Yanray Wang20fa2ae2023-01-13 18:00:10 +0800426 O_CIPHERS="$O_CIPHERS $CIPHERS"
Joe Subbiani34d62622021-07-27 14:55:56 +0100427 M_CIPHERS="$M_CIPHERS $CIPHERS"
Manuel Pégourié-Gonnard12b84722014-03-25 19:07:28 +0100428}
429
Manuel Pégourié-Gonnard7299dfd2018-02-15 11:43:55 +0100430# Ciphersuites usable only with Mbed TLS and GnuTLS
Yanray Wang20fa2ae2023-01-13 18:00:10 +0800431# A list of ciphersuites in the standard naming convention is appended
432# to the list of Mbed TLS ciphersuites $M_CIPHERS and
433# to the list of GnuTLS ciphersuites $G_CIPHERS respectively.
434# Based on client's naming convention, all ciphersuite names will be
435# translated into another naming format before sent to the client.
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100436add_gnutls_ciphersuites()
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100437{
Joe Subbiani34d62622021-07-27 14:55:56 +0100438 CIPHERS=""
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100439 case $TYPE in
440
441 "ECDSA")
Joe Subbiani9f847612021-08-10 10:41:13 +0100442 CIPHERS="$CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800443 TLS_ECDHE_ECDSA_WITH_AES_128_CCM \
444 TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8 \
445 TLS_ECDHE_ECDSA_WITH_AES_256_CCM \
446 TLS_ECDHE_ECDSA_WITH_AES_256_CCM_8 \
447 TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256 \
448 TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256 \
449 TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384 \
450 TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384 \
Joe Subbiani9f847612021-08-10 10:41:13 +0100451 "
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100452 ;;
453
454 "RSA")
Joe Subbiani9f847612021-08-10 10:41:13 +0100455 CIPHERS="$CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800456 TLS_DHE_RSA_WITH_AES_128_CCM \
457 TLS_DHE_RSA_WITH_AES_128_CCM_8 \
458 TLS_DHE_RSA_WITH_AES_256_CCM \
459 TLS_DHE_RSA_WITH_AES_256_CCM_8 \
460 TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256 \
461 TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256 \
462 TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256 \
463 TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384 \
464 TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256 \
465 TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256 \
466 TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384 \
467 TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384 \
468 TLS_RSA_WITH_AES_128_CCM \
469 TLS_RSA_WITH_AES_128_CCM_8 \
470 TLS_RSA_WITH_AES_256_CCM \
471 TLS_RSA_WITH_AES_256_CCM_8 \
472 TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256 \
473 TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256 \
474 TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256 \
475 TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384 \
Joe Subbiani9f847612021-08-10 10:41:13 +0100476 "
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100477 ;;
478
479 "PSK")
Joe Subbiani9f847612021-08-10 10:41:13 +0100480 CIPHERS="$CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800481 TLS_DHE_PSK_WITH_AES_128_CBC_SHA \
482 TLS_DHE_PSK_WITH_AES_128_CBC_SHA256 \
483 TLS_DHE_PSK_WITH_AES_128_CCM \
484 TLS_DHE_PSK_WITH_AES_128_CCM_8 \
485 TLS_DHE_PSK_WITH_AES_128_GCM_SHA256 \
486 TLS_DHE_PSK_WITH_AES_256_CBC_SHA \
487 TLS_DHE_PSK_WITH_AES_256_CBC_SHA384 \
488 TLS_DHE_PSK_WITH_AES_256_CCM \
489 TLS_DHE_PSK_WITH_AES_256_CCM_8 \
490 TLS_DHE_PSK_WITH_AES_256_GCM_SHA384 \
491 TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256 \
492 TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256 \
493 TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384 \
494 TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384 \
495 TLS_DHE_PSK_WITH_NULL_SHA256 \
496 TLS_DHE_PSK_WITH_NULL_SHA384 \
497 TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA \
498 TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256 \
499 TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA \
500 TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384 \
501 TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256 \
502 TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384 \
503 TLS_ECDHE_PSK_WITH_NULL_SHA256 \
504 TLS_ECDHE_PSK_WITH_NULL_SHA384 \
505 TLS_PSK_WITH_AES_128_CBC_SHA256 \
506 TLS_PSK_WITH_AES_128_CCM \
507 TLS_PSK_WITH_AES_128_CCM_8 \
508 TLS_PSK_WITH_AES_128_GCM_SHA256 \
509 TLS_PSK_WITH_AES_256_CBC_SHA384 \
510 TLS_PSK_WITH_AES_256_CCM \
511 TLS_PSK_WITH_AES_256_CCM_8 \
512 TLS_PSK_WITH_AES_256_GCM_SHA384 \
513 TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256 \
514 TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256 \
515 TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384 \
516 TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384 \
517 TLS_PSK_WITH_NULL_SHA256 \
518 TLS_PSK_WITH_NULL_SHA384 \
519 TLS_RSA_PSK_WITH_AES_128_CBC_SHA \
520 TLS_RSA_PSK_WITH_AES_128_CBC_SHA256 \
521 TLS_RSA_PSK_WITH_AES_128_GCM_SHA256 \
522 TLS_RSA_PSK_WITH_AES_256_CBC_SHA \
523 TLS_RSA_PSK_WITH_AES_256_CBC_SHA384 \
524 TLS_RSA_PSK_WITH_AES_256_GCM_SHA384 \
525 TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256 \
526 TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256 \
527 TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384 \
528 TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384 \
529 TLS_RSA_PSK_WITH_NULL_SHA256 \
530 TLS_RSA_PSK_WITH_NULL_SHA384 \
Manuel Pégourié-Gonnarde46aa5e2014-07-13 15:44:19 +0200531 "
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100532 ;;
533 esac
Joe Subbiani43592bd2021-07-27 16:32:21 +0100534
Yanray Wang20fa2ae2023-01-13 18:00:10 +0800535 G_CIPHERS="$G_CIPHERS $CIPHERS"
Joe Subbiani34d62622021-07-27 14:55:56 +0100536 M_CIPHERS="$M_CIPHERS $CIPHERS"
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100537}
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100538
Manuel Pégourié-Gonnard7299dfd2018-02-15 11:43:55 +0100539# Ciphersuites usable only with Mbed TLS (not currently supported by another
Yanray Wang20fa2ae2023-01-13 18:00:10 +0800540# peer usable in this script). This provides only very rudimentaty testing, as
Manuel Pégourié-Gonnard7299dfd2018-02-15 11:43:55 +0100541# this is not interop testing, but it's better than nothing.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200542add_mbedtls_ciphersuites()
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100543{
544 case $TYPE in
545
546 "ECDSA")
Joe Subbiani9f847612021-08-10 10:41:13 +0100547 M_CIPHERS="$M_CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800548 TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256 \
549 TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256 \
550 TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384 \
551 TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384 \
552 TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256 \
553 TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256 \
554 TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384 \
555 TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384 \
556 TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256 \
557 TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384 \
Joe Subbiani9f847612021-08-10 10:41:13 +0100558 "
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100559 ;;
560
561 "RSA")
Joe Subbiani9f847612021-08-10 10:41:13 +0100562 M_CIPHERS="$M_CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800563 TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256 \
564 TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384 \
565 TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256 \
566 TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384 \
567 TLS_RSA_WITH_ARIA_128_CBC_SHA256 \
568 TLS_RSA_WITH_ARIA_256_CBC_SHA384 \
Joe Subbiani9f847612021-08-10 10:41:13 +0100569 "
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100570 ;;
571
572 "PSK")
Yanray Wangd5f99e42023-01-11 10:11:23 +0800573 # *PSK_NULL_SHA suites supported by GnuTLS 3.3.5 but not 3.2.15
Joe Subbiani9f847612021-08-10 10:41:13 +0100574 M_CIPHERS="$M_CIPHERS \
Yanray Wangd5f99e42023-01-11 10:11:23 +0800575 TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256 \
576 TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384 \
577 TLS_DHE_PSK_WITH_NULL_SHA \
578 TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256 \
579 TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384 \
580 TLS_ECDHE_PSK_WITH_NULL_SHA \
581 TLS_PSK_WITH_ARIA_128_CBC_SHA256 \
582 TLS_PSK_WITH_ARIA_256_CBC_SHA384 \
583 TLS_PSK_WITH_NULL_SHA \
584 TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256 \
585 TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256 \
586 TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384 \
587 TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384 \
588 TLS_RSA_PSK_WITH_CHACHA20_POLY1305_SHA256 \
589 TLS_RSA_PSK_WITH_NULL_SHA \
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100590 "
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100591 ;;
592 esac
Manuel Pégourié-Gonnard48f196c2014-02-19 13:51:58 +0100593}
594
Pengyu Lv1c0e4c02023-02-20 18:05:21 +0800595# o_check_ciphersuite STANDARD_CIPHER_SUITE
596o_check_ciphersuite()
597{
Pengyu Lva64c2772023-02-22 09:30:20 +0800598 if [ "${O_SUPPORT_ECDH}" = "NO" ]; then
599 case "$1" in
600 *ECDH_*) SKIP_NEXT="YES"
601 esac
Pengyu Lv1c0e4c02023-02-20 18:05:21 +0800602 fi
603}
604
Manuel Pégourié-Gonnardd941a792014-02-19 13:35:52 +0100605setup_arguments()
606{
Ronald Cron2c74ff62022-03-11 17:15:23 +0100607 O_MODE=""
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100608 G_MODE=""
609 case "$MODE" in
Xiaofei Bai8b5c3822021-12-02 08:43:35 +0000610 "tls12")
Ronald Cron2c74ff62022-03-11 17:15:23 +0100611 O_MODE="tls1_2"
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100612 G_PRIO_MODE="+VERS-TLS1.2"
Manuel Pégourié-Gonnard9ada01a2014-02-19 14:24:24 +0100613 ;;
Xiaofei Bai8b5c3822021-12-02 08:43:35 +0000614 "dtls12")
Ronald Cron2c74ff62022-03-11 17:15:23 +0100615 O_MODE="dtls1_2"
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100616 G_PRIO_MODE="+VERS-DTLS1.2"
Manuel Pégourié-Gonnard36795192014-09-26 16:33:45 +0200617 G_MODE="-u"
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100618 ;;
Manuel Pégourié-Gonnard9ada01a2014-02-19 14:24:24 +0100619 *)
620 echo "error: invalid mode: $MODE" >&2
621 exit 1;
622 esac
623
Manuel Pégourié-Gonnardc36b4322018-06-14 13:14:29 +0200624 # GnuTLS < 3.4 will choke if we try to allow CCM-8
625 if [ -z "${GNUTLS_MINOR_LT_FOUR-}" ]; then
626 G_PRIO_CCM="+AES-256-CCM-8:+AES-128-CCM-8:"
627 else
628 G_PRIO_CCM=""
629 fi
630
Mateusz Starzyk5224e292021-02-22 14:36:29 +0100631 M_SERVER_ARGS="server_port=$PORT server_addr=0.0.0.0 force_version=$MODE"
Ronald Cron2c74ff62022-03-11 17:15:23 +0100632 O_SERVER_ARGS="-accept $PORT -cipher NULL,ALL -$O_MODE"
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100633 G_SERVER_ARGS="-p $PORT --http $G_MODE"
Mateusz Starzyk5224e292021-02-22 14:36:29 +0100634 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 +0100635
Gilles Peskine96f5bae2021-04-01 14:00:11 +0200636 # The default prime for `openssl s_server` depends on the version:
637 # * OpenSSL <= 1.0.2a: 512-bit
638 # * OpenSSL 1.0.2b to 1.1.1b: 1024-bit
639 # * OpenSSL >= 1.1.1c: 2048-bit
640 # Mbed TLS wants >=1024, so force that for older versions. Don't force
641 # it for newer versions, which reject a 1024-bit prime. Indifferently
642 # force it or not for intermediate versions.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100643 case $($OPENSSL version) in
Gilles Peskine96f5bae2021-04-01 14:00:11 +0200644 "OpenSSL 1.0"*)
645 O_SERVER_ARGS="$O_SERVER_ARGS -dhparam data_files/dhparams.pem"
646 ;;
647 esac
648
Manuel Pégourié-Gonnardd1af1022014-07-11 17:01:06 +0200649 # with OpenSSL 1.0.1h, -www, -WWW and -HTTP break DTLS handshakes
650 if is_dtls "$MODE"; then
Manuel Pégourié-Gonnard36795192014-09-26 16:33:45 +0200651 O_SERVER_ARGS="$O_SERVER_ARGS"
Manuel Pégourié-Gonnardd1af1022014-07-11 17:01:06 +0200652 else
653 O_SERVER_ARGS="$O_SERVER_ARGS -www"
654 fi
655
Simon Butcherac22d112016-09-04 22:31:09 +0100656 M_CLIENT_ARGS="server_port=$PORT server_addr=127.0.0.1 force_version=$MODE"
Ronald Cron2c74ff62022-03-11 17:15:23 +0100657 O_CLIENT_ARGS="-connect localhost:$PORT -$O_MODE"
Manuel Pégourié-Gonnard3025b6c2014-03-26 15:30:16 +0100658 G_CLIENT_ARGS="-p $PORT --debug 3 $G_MODE"
Manuel Pégourié-Gonnard9ada01a2014-02-19 14:24:24 +0100659
Gilles Peskine4bdb9fb2022-11-24 22:21:15 +0100660 # Newer versions of OpenSSL have a syntax to enable all "ciphers", even
661 # low-security ones. This covers not just cipher suites but also protocol
662 # versions. It is necessary, for example, to use (D)TLS 1.0/1.1 on
663 # OpenSSL 1.1.1f from Ubuntu 20.04. The syntax was only introduced in
664 # OpenSSL 1.1.0 (21e0c1d23afff48601eb93135defddae51f7e2e3) and I can't find
665 # a way to discover it from -help, so check the openssl version.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100666 case $($OPENSSL version) in
Gilles Peskine4bdb9fb2022-11-24 22:21:15 +0100667 "OpenSSL 0"*|"OpenSSL 1.0"*) :;;
668 *)
669 O_CLIENT_ARGS="$O_CLIENT_ARGS -cipher ALL@SECLEVEL=0"
670 O_SERVER_ARGS="$O_SERVER_ARGS -cipher ALL@SECLEVEL=0"
671 ;;
672 esac
673
Pengyu Lv1c0e4c02023-02-20 18:05:21 +0800674 case $($OPENSSL ciphers ALL) in
Pengyu Lv9e7bb2a2023-02-23 15:24:47 +0800675 *ECDH-ECDSA*|*ECDH-RSA*) O_SUPPORT_ECDH="YES";;
Pengyu Lva64c2772023-02-22 09:30:20 +0800676 *) O_SUPPORT_ECDH="NO";;
Pengyu Lv1c0e4c02023-02-20 18:05:21 +0800677 esac
678
Yanray Wang30382972023-02-08 12:38:31 +0800679 if [ "X$VERIFY" = "XYES" ];
Manuel Pégourié-Gonnardd941a792014-02-19 13:35:52 +0100680 then
Simon Butcherac22d112016-09-04 22:31:09 +0100681 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 +0100682 O_SERVER_ARGS="$O_SERVER_ARGS -CAfile data_files/test-ca_cat12.crt -Verify 10"
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100683 G_SERVER_ARGS="$G_SERVER_ARGS --x509cafile data_files/test-ca_cat12.crt --require-client-cert"
684
Simon Butcherac22d112016-09-04 22:31:09 +0100685 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 +0100686 O_CLIENT_ARGS="$O_CLIENT_ARGS -CAfile data_files/test-ca_cat12.crt -verify 10"
Manuel Pégourié-Gonnarda4371442014-03-13 16:21:59 +0100687 G_CLIENT_ARGS="$G_CLIENT_ARGS --x509cafile data_files/test-ca_cat12.crt"
Manuel Pégourié-Gonnardda782c92014-02-21 10:10:20 +0100688 else
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100689 # don't request a client cert at all
Simon Butcherac22d112016-09-04 22:31:09 +0100690 M_SERVER_ARGS="$M_SERVER_ARGS ca_file=none auth_mode=none"
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100691 G_SERVER_ARGS="$G_SERVER_ARGS --disable-client-cert"
692
Simon Butcherac22d112016-09-04 22:31:09 +0100693 M_CLIENT_ARGS="$M_CLIENT_ARGS ca_file=none auth_mode=none"
Manuel Pégourié-Gonnard5de31ec2014-03-19 17:34:52 +0100694 O_CLIENT_ARGS="$O_CLIENT_ARGS"
695 G_CLIENT_ARGS="$G_CLIENT_ARGS --insecure"
Manuel Pégourié-Gonnardd941a792014-02-19 13:35:52 +0100696 fi
697
698 case $TYPE in
699 "ECDSA")
Simon Butcherac22d112016-09-04 22:31:09 +0100700 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 +0100701 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 +0100702 G_SERVER_ARGS="$G_SERVER_ARGS --x509certfile data_files/server5.crt --x509keyfile data_files/server5.key"
703
Manuel Pégourié-Gonnard1b149ef2014-02-27 14:38:29 +0100704 if [ "X$VERIFY" = "XYES" ]; then
Simon Butcherac22d112016-09-04 22:31:09 +0100705 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 +0100706 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 +0100707 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 +0100708 else
Simon Butcherac22d112016-09-04 22:31:09 +0100709 M_CLIENT_ARGS="$M_CLIENT_ARGS crt_file=none key_file=none"
Manuel Pégourié-Gonnard1b149ef2014-02-27 14:38:29 +0100710 fi
Manuel Pégourié-Gonnardd941a792014-02-19 13:35:52 +0100711 ;;
712
713 "RSA")
Manuel Pégourié-Gonnard499bf4c2020-08-21 12:24:32 +0200714 M_SERVER_ARGS="$M_SERVER_ARGS crt_file=data_files/server2-sha256.crt key_file=data_files/server2.key"
715 O_SERVER_ARGS="$O_SERVER_ARGS -cert data_files/server2-sha256.crt -key data_files/server2.key"
716 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 +0100717
Manuel Pégourié-Gonnard1b149ef2014-02-27 14:38:29 +0100718 if [ "X$VERIFY" = "XYES" ]; then
Manuel Pégourié-Gonnard499bf4c2020-08-21 12:24:32 +0200719 M_CLIENT_ARGS="$M_CLIENT_ARGS crt_file=data_files/cert_sha256.crt key_file=data_files/server1.key"
720 O_CLIENT_ARGS="$O_CLIENT_ARGS -cert data_files/cert_sha256.crt -key data_files/server1.key"
721 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 +0100722 else
Simon Butcherac22d112016-09-04 22:31:09 +0100723 M_CLIENT_ARGS="$M_CLIENT_ARGS crt_file=none key_file=none"
Manuel Pégourié-Gonnard1b149ef2014-02-27 14:38:29 +0100724 fi
Manuel Pégourié-Gonnardd941a792014-02-19 13:35:52 +0100725 ;;
726
727 "PSK")
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100728 # give RSA-PSK-capable server a RSA cert
Manuel Pégourié-Gonnard1b149ef2014-02-27 14:38:29 +0100729 # (should be a separate type, but harder to close with openssl)
Manuel Pégourié-Gonnard499bf4c2020-08-21 12:24:32 +0200730 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 +0100731 O_SERVER_ARGS="$O_SERVER_ARGS -psk 6162636465666768696a6b6c6d6e6f70 -nocert"
Manuel Pégourié-Gonnard499bf4c2020-08-21 12:24:32 +0200732 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 +0100733
Simon Butcherac22d112016-09-04 22:31:09 +0100734 M_CLIENT_ARGS="$M_CLIENT_ARGS psk=6162636465666768696a6b6c6d6e6f70 crt_file=none key_file=none"
Manuel Pégourié-Gonnard9ada01a2014-02-19 14:24:24 +0100735 O_CLIENT_ARGS="$O_CLIENT_ARGS -psk 6162636465666768696a6b6c6d6e6f70"
Manuel Pégourié-Gonnarda4371442014-03-13 16:21:59 +0100736 G_CLIENT_ARGS="$G_CLIENT_ARGS --pskusername Client_identity --pskkey=6162636465666768696a6b6c6d6e6f70"
Manuel Pégourié-Gonnardd941a792014-02-19 13:35:52 +0100737 ;;
738 esac
739}
740
Simon Butcherac22d112016-09-04 22:31:09 +0100741# is_mbedtls <cmd_line>
742is_mbedtls() {
Gilles Peskineb20028b2023-01-26 21:34:01 +0100743 case $1 in
744 *ssl_client2*) true;;
745 *ssl_server2*) true;;
746 *) false;;
747 esac
Manuel Pégourié-Gonnard3eec6042014-02-27 15:37:24 +0100748}
749
750# has_mem_err <log_file_name>
751has_mem_err() {
752 if ( grep -F 'All heap blocks were freed -- no leaks are possible' "$1" &&
753 grep -F 'ERROR SUMMARY: 0 errors from 0 contexts' "$1" ) > /dev/null
754 then
755 return 1 # false: does not have errors
756 else
757 return 0 # true: has errors
758 fi
759}
760
Gilles Peskine12c49c72017-12-14 19:02:00 +0100761# Wait for process $2 to be listening on port $1
762if type lsof >/dev/null 2>/dev/null; then
763 wait_server_start() {
764 START_TIME=$(date +%s)
765 if is_dtls "$MODE"; then
766 proto=UDP
767 else
768 proto=TCP
769 fi
770 while ! lsof -a -n -b -i "$proto:$1" -p "$2" >/dev/null 2>/dev/null; do
771 if [ $(( $(date +%s) - $START_TIME )) -gt $DOG_DELAY ]; then
772 echo "SERVERSTART TIMEOUT"
773 echo "SERVERSTART TIMEOUT" >> $SRV_OUT
774 break
775 fi
776 # Linux and *BSD support decimal arguments to sleep. On other
777 # OSes this may be a tight loop.
778 sleep 0.1 2>/dev/null || true
779 done
780 }
781else
Gilles Peskine3c9e2b52018-01-08 12:38:15 +0100782 echo "Warning: lsof not available, wait_server_start = sleep"
Gilles Peskine12c49c72017-12-14 19:02:00 +0100783 wait_server_start() {
Manuel Pégourié-Gonnard0d225da2018-01-22 10:22:09 +0100784 sleep 2
Gilles Peskine12c49c72017-12-14 19:02:00 +0100785 }
786fi
787
788
Manuel Pégourié-Gonnard304beef2014-02-19 14:45:00 +0100789# start_server <name>
790# also saves name and command
791start_server() {
Manuel Pégourié-Gonnard304beef2014-02-19 14:45:00 +0100792 case $1 in
793 [Oo]pen*)
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100794 SERVER_CMD="$OPENSSL s_server $O_SERVER_ARGS"
Manuel Pégourié-Gonnard304beef2014-02-19 14:45:00 +0100795 ;;
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100796 [Gg]nu*)
Manuel Pégourié-Gonnard74faf3c2014-03-13 18:47:44 +0100797 SERVER_CMD="$GNUTLS_SERV $G_SERVER_ARGS --priority $G_SERVER_PRIO"
Manuel Pégourié-Gonnard5b2d7762014-02-28 12:42:57 +0100798 ;;
Manuel Pégourié-Gonnarda8f3b752015-01-22 17:05:05 +0000799 mbed*)
Simon Butcherac22d112016-09-04 22:31:09 +0100800 SERVER_CMD="$M_SRV $M_SERVER_ARGS"
Manuel Pégourié-Gonnard3eec6042014-02-27 15:37:24 +0100801 if [ "$MEMCHECK" -gt 0 ]; then
802 SERVER_CMD="valgrind --leak-check=full $SERVER_CMD"
803 fi
Manuel Pégourié-Gonnard304beef2014-02-19 14:45:00 +0100804 ;;
805 *)
806 echo "error: invalid server name: $1" >&2
807 exit 1
808 ;;
809 esac
810 SERVER_NAME=$1
811
812 log "$SERVER_CMD"
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +0200813 echo "$SERVER_CMD" > $SRV_OUT
Manuel Pégourié-Gonnardd1af1022014-07-11 17:01:06 +0200814 # for servers without -www or equivalent
Manuel Pégourié-Gonnard82cf0a12015-02-09 13:05:54 +0000815 while :; do echo bla; sleep 1; done | $SERVER_CMD >> $SRV_OUT 2>&1 &
Yanray Wang12885972023-01-13 11:42:11 +0800816 SRV_PID=$!
Manuel Pégourié-Gonnard304beef2014-02-19 14:45:00 +0100817
Yanray Wang12885972023-01-13 11:42:11 +0800818 wait_server_start "$PORT" "$SRV_PID"
Manuel Pégourié-Gonnard304beef2014-02-19 14:45:00 +0100819}
820
Manuel Pégourié-Gonnard16494492014-08-31 10:37:14 +0200821# terminate the running server
Manuel Pégourié-Gonnard95957712014-02-19 15:29:38 +0100822stop_server() {
Yanray Wang12885972023-01-13 11:42:11 +0800823 # For Ubuntu 22.04, `Terminated` message is outputed by wait command.
824 # To remove it from stdout, redirect stdout/stderr to SRV_OUT
825 kill $SRV_PID >/dev/null 2>&1
826 wait $SRV_PID >> $SRV_OUT 2>&1
Manuel Pégourié-Gonnard3eec6042014-02-27 15:37:24 +0100827
828 if [ "$MEMCHECK" -gt 0 ]; then
Simon Butcherac22d112016-09-04 22:31:09 +0100829 if is_mbedtls "$SERVER_CMD" && has_mem_err $SRV_OUT; then
Manuel Pégourié-Gonnard3eec6042014-02-27 15:37:24 +0100830 echo " ! Server had memory errors"
Manuel Pégourié-Gonnard72e51ee2014-08-31 10:22:11 +0200831 SRVMEM=$(( $SRVMEM + 1 ))
Manuel Pégourié-Gonnard3eec6042014-02-27 15:37:24 +0100832 return
833 fi
834 fi
835
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +0200836 rm -f $SRV_OUT
Manuel Pégourié-Gonnard95957712014-02-19 15:29:38 +0100837}
838
Manuel Pégourié-Gonnarda9062e92014-02-25 16:21:22 +0100839# kill the running server (used when killed by signal)
840cleanup() {
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +0200841 rm -f $SRV_OUT $CLI_OUT
Yanray Wang12885972023-01-13 11:42:11 +0800842 kill $SRV_PID >/dev/null 2>&1
Manuel Pégourié-Gonnard16494492014-08-31 10:37:14 +0200843 kill $WATCHDOG_PID >/dev/null 2>&1
Manuel Pégourié-Gonnarda9062e92014-02-25 16:21:22 +0100844 exit 1
845}
846
Manuel Pégourié-Gonnardc0f6a692014-08-30 22:41:47 +0200847# wait for client to terminate and set EXIT
848# must be called right after starting the client
849wait_client_done() {
850 CLI_PID=$!
851
852 ( sleep "$DOG_DELAY"; echo "TIMEOUT" >> $CLI_OUT; kill $CLI_PID ) &
853 WATCHDOG_PID=$!
854
Yanray Wang05f940b2023-01-13 10:52:41 +0800855 # For Ubuntu 22.04, `Terminated` message is outputed by wait command.
856 # To remove it from stdout, redirect stdout/stderr to CLI_OUT
857 wait $CLI_PID >> $CLI_OUT 2>&1
Manuel Pégourié-Gonnardc0f6a692014-08-30 22:41:47 +0200858 EXIT=$?
859
Yanray Wang05f940b2023-01-13 10:52:41 +0800860 kill $WATCHDOG_PID >/dev/null 2>&1
861 wait $WATCHDOG_PID >> $CLI_OUT 2>&1
Manuel Pégourié-Gonnardc0f6a692014-08-30 22:41:47 +0200862
863 echo "EXIT: $EXIT" >> $CLI_OUT
864}
865
Yanray Wangfb784b22023-03-02 11:55:55 +0800866# uniform_title <CLIENT> <SERVER> <STANDARD_CIPHER_SUITE>
867# $TITLE is considered as test case description for both --list-test-case and
868# MBEDTLS_TEST_OUTCOME_FILE. This function aims to control the format of
869# each test case description.
870uniform_title() {
871 TITLE="$1->$2 $MODE,$VERIF $3"
Yanray Wang3fcd3a72023-02-24 17:07:47 +0800872}
873
Yanray Wangad470632023-02-20 14:58:03 +0800874# record_outcome <outcome> [<failure-reason>]
875record_outcome() {
876 echo "$1"
877 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
878 # The test outcome file has the format (in single line):
879 # platform;configuration;
880 # test suite name;test case description;
881 # PASS/FAIL/SKIP;[failure cause]
882 printf '%s;%s;%s;%s;%s;%s\n' \
883 "$MBEDTLS_TEST_PLATFORM" "$MBEDTLS_TEST_CONFIGURATION" \
884 "compat" "$TITLE" \
885 "$1" "${2-}" \
886 >> "$MBEDTLS_TEST_OUTCOME_FILE"
887 fi
888}
889
Yanray Wangf45a8ea2023-02-20 15:49:10 +0800890# display additional information if test case fails
891report_fail() {
Yanray Wangad470632023-02-20 14:58:03 +0800892 FAIL_PROMPT="outputs saved to c-srv-${TESTS}.log, c-cli-${TESTS}.log"
893 record_outcome "FAIL" "$FAIL_PROMPT"
Yanray Wangf45a8ea2023-02-20 15:49:10 +0800894 cp $SRV_OUT c-srv-${TESTS}.log
895 cp $CLI_OUT c-cli-${TESTS}.log
Yanray Wangad470632023-02-20 14:58:03 +0800896 echo " ! $FAIL_PROMPT"
Yanray Wangf45a8ea2023-02-20 15:49:10 +0800897
898 if [ "${LOG_FAILURE_ON_STDOUT:-0}" != 0 ]; then
899 echo " ! server output:"
900 cat c-srv-${TESTS}.log
901 echo " ! ==================================================="
902 echo " ! client output:"
903 cat c-cli-${TESTS}.log
904 fi
905}
906
Gilles Peskine47aab852023-01-26 21:16:34 +0100907# run_client PROGRAM_NAME STANDARD_CIPHER_SUITE PROGRAM_CIPHER_SUITE
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +0100908run_client() {
Manuel Pégourié-Gonnard87ae3032014-02-27 11:12:30 +0100909 # announce what we're going to do
Manuel Pégourié-Gonnard72e51ee2014-08-31 10:22:11 +0200910 TESTS=$(( $TESTS + 1 ))
Yanray Wangfb784b22023-03-02 11:55:55 +0800911 uniform_title "${1%"${1#?}"}" "${SERVER_NAME%"${SERVER_NAME#?}"}" $2
912 DOTS72="........................................................................"
913 printf "%s %.*s " "$TITLE" "$((71 - ${#TITLE}))" "$DOTS72"
Manuel Pégourié-Gonnard87ae3032014-02-27 11:12:30 +0100914
Manuel Pégourié-Gonnard53aef812014-07-11 17:41:24 +0200915 # should we skip?
916 if [ "X$SKIP_NEXT" = "XYES" ]; then
917 SKIP_NEXT="NO"
Yanray Wangad470632023-02-20 14:58:03 +0800918 record_outcome "SKIP"
Manuel Pégourié-Gonnard53aef812014-07-11 17:41:24 +0200919 SKIPPED=$(( $SKIPPED + 1 ))
920 return
921 fi
922
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +0100923 # run the command and interpret result
924 case $1 in
925 [Oo]pen*)
Gilles Peskine47aab852023-01-26 21:16:34 +0100926 CLIENT_CMD="$OPENSSL s_client $O_CLIENT_ARGS -cipher $3"
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +0100927 log "$CLIENT_CMD"
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +0200928 echo "$CLIENT_CMD" > $CLI_OUT
Manuel Pégourié-Gonnard9afdc832015-08-04 17:15:13 +0200929 printf 'GET HTTP/1.0\r\n\r\n' | $CLIENT_CMD >> $CLI_OUT 2>&1 &
Manuel Pégourié-Gonnardc0f6a692014-08-30 22:41:47 +0200930 wait_client_done
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +0100931
Manuel Pégourié-Gonnard72e51ee2014-08-31 10:22:11 +0200932 if [ $EXIT -eq 0 ]; then
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +0100933 RESULT=0
934 else
Pengyu Lv9e7bb2a2023-02-23 15:24:47 +0800935 # If it is NULL cipher ...
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +0200936 if grep 'Cipher is (NONE)' $CLI_OUT >/dev/null; then
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +0100937 RESULT=1
938 else
939 RESULT=2
940 fi
941 fi
942 ;;
943
Manuel Pégourié-Gonnarda4371442014-03-13 16:21:59 +0100944 [Gg]nu*)
Manuel Pégourié-Gonnard29980b12014-07-10 20:12:56 +0200945 # need to force IPv4 with UDP, but keep localhost for auth
946 if is_dtls "$MODE"; then
947 G_HOST="127.0.0.1"
948 else
949 G_HOST="localhost"
950 fi
Gilles Peskine47aab852023-01-26 21:16:34 +0100951 CLIENT_CMD="$GNUTLS_CLI $G_CLIENT_ARGS --priority $G_PRIO_MODE:$3 $G_HOST"
Manuel Pégourié-Gonnarda4371442014-03-13 16:21:59 +0100952 log "$CLIENT_CMD"
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +0200953 echo "$CLIENT_CMD" > $CLI_OUT
Manuel Pégourié-Gonnard9afdc832015-08-04 17:15:13 +0200954 printf 'GET HTTP/1.0\r\n\r\n' | $CLIENT_CMD >> $CLI_OUT 2>&1 &
Manuel Pégourié-Gonnardc0f6a692014-08-30 22:41:47 +0200955 wait_client_done
Manuel Pégourié-Gonnarda4371442014-03-13 16:21:59 +0100956
Manuel Pégourié-Gonnard72e51ee2014-08-31 10:22:11 +0200957 if [ $EXIT -eq 0 ]; then
Manuel Pégourié-Gonnarda4371442014-03-13 16:21:59 +0100958 RESULT=0
959 else
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +0100960 RESULT=2
961 # interpret early failure, with a handshake_failure alert
962 # before the server hello, as "no ciphersuite in common"
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +0200963 if grep -F 'Received alert [40]: Handshake failed' $CLI_OUT; then
964 if grep -i 'SERVER HELLO .* was received' $CLI_OUT; then :
Manuel Pégourié-Gonnard9edba772014-03-13 17:45:35 +0100965 else
966 RESULT=1
967 fi
968 fi >/dev/null
Manuel Pégourié-Gonnarda4371442014-03-13 16:21:59 +0100969 fi
970 ;;
971
Manuel Pégourié-Gonnarda8f3b752015-01-22 17:05:05 +0000972 mbed*)
Gilles Peskine47aab852023-01-26 21:16:34 +0100973 CLIENT_CMD="$M_CLI $M_CLIENT_ARGS force_ciphersuite=$3"
Manuel Pégourié-Gonnard3eec6042014-02-27 15:37:24 +0100974 if [ "$MEMCHECK" -gt 0 ]; then
975 CLIENT_CMD="valgrind --leak-check=full $CLIENT_CMD"
976 fi
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +0100977 log "$CLIENT_CMD"
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +0200978 echo "$CLIENT_CMD" > $CLI_OUT
Manuel Pégourié-Gonnardc0f6a692014-08-30 22:41:47 +0200979 $CLIENT_CMD >> $CLI_OUT 2>&1 &
980 wait_client_done
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +0100981
982 case $EXIT in
Simon Butcherac22d112016-09-04 22:31:09 +0100983 # Success
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +0100984 "0") RESULT=0 ;;
Simon Butcherac22d112016-09-04 22:31:09 +0100985
986 # Ciphersuite not supported
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +0100987 "2") RESULT=1 ;;
Simon Butcherac22d112016-09-04 22:31:09 +0100988
989 # Error
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +0100990 *) RESULT=2 ;;
991 esac
Manuel Pégourié-Gonnard3eec6042014-02-27 15:37:24 +0100992
993 if [ "$MEMCHECK" -gt 0 ]; then
Simon Butcherac22d112016-09-04 22:31:09 +0100994 if is_mbedtls "$CLIENT_CMD" && has_mem_err $CLI_OUT; then
Manuel Pégourié-Gonnard3eec6042014-02-27 15:37:24 +0100995 RESULT=2
996 fi
997 fi
998
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +0100999 ;;
1000
1001 *)
1002 echo "error: invalid client name: $1" >&2
1003 exit 1
1004 ;;
1005 esac
1006
Manuel Pégourié-Gonnardbc3b16c2014-05-28 23:06:50 +02001007 echo "EXIT: $EXIT" >> $CLI_OUT
Manuel Pégourié-Gonnarde01af4c2014-03-25 14:16:44 +01001008
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +01001009 # report and count result
Manuel Pégourié-Gonnard330e4112014-02-19 15:23:21 +01001010 case $RESULT in
1011 "0")
Yanray Wangad470632023-02-20 14:58:03 +08001012 record_outcome "PASS"
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