Neels Hofmeyr | 6a29d32 | 2017-01-25 15:04:16 +0100 | [diff] [blame] | 1 | /* Osmocom MSC+VLR end-to-end tests */ |
| 2 | |
| 3 | /* (C) 2017 by sysmocom s.f.m.c. GmbH <info@sysmocom.de> |
| 4 | * |
| 5 | * All Rights Reserved |
| 6 | * |
| 7 | * Author: Neels Hofmeyr <nhofmeyr@sysmocom.de> |
| 8 | * |
| 9 | * This program is free software; you can redistribute it and/or modify |
| 10 | * it under the terms of the GNU Affero General Public License as published by |
| 11 | * the Free Software Foundation; either version 3 of the License, or |
| 12 | * (at your option) any later version. |
| 13 | * |
| 14 | * This program is distributed in the hope that it will be useful, |
| 15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 17 | * GNU Affero General Public License for more details. |
| 18 | * |
| 19 | * You should have received a copy of the GNU Affero General Public License |
| 20 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 21 | * |
| 22 | */ |
| 23 | |
| 24 | #pragma once |
| 25 | |
| 26 | #include <stdbool.h> |
| 27 | #include <stdio.h> |
| 28 | |
Alexander Couzens | 8b7d785 | 2021-11-05 01:52:05 +0100 | [diff] [blame] | 29 | #include <osmocom/crypt/utran_cipher.h> |
Neels Hofmeyr | 9084396 | 2017-09-04 15:04:35 +0200 | [diff] [blame] | 30 | #include <osmocom/msc/gsm_data.h> |
Neels Hofmeyr | 9084396 | 2017-09-04 15:04:35 +0200 | [diff] [blame] | 31 | #include <osmocom/msc/vlr.h> |
Neels Hofmeyr | c4628a3 | 2018-12-07 14:47:34 +0100 | [diff] [blame] | 32 | #include <osmocom/msc/msub.h> |
| 33 | #include <osmocom/msc/msc_a.h> |
Neels Hofmeyr | a99b427 | 2017-11-21 17:13:23 +0100 | [diff] [blame] | 34 | #include <osmocom/msc/mncc.h> |
Neels Hofmeyr | 3f391dd | 2019-08-29 03:53:11 +0200 | [diff] [blame] | 35 | #include <osmocom/msc/call_leg.h> |
| 36 | #include <osmocom/msc/rtp_stream.h> |
Neels Hofmeyr | 6a29d32 | 2017-01-25 15:04:16 +0100 | [diff] [blame] | 37 | |
| 38 | extern bool _log_lines; |
Neels Hofmeyr | 35fb679 | 2019-10-21 06:06:27 +0200 | [diff] [blame] | 39 | #define LOG_COLOR "\033[1;33m" |
| 40 | #define LOG_COLOR_OFF "\033[0;m" |
| 41 | |
Neels Hofmeyr | 6a29d32 | 2017-01-25 15:04:16 +0100 | [diff] [blame] | 42 | #define _log(fmt, args...) do { \ |
| 43 | if (_log_lines) \ |
Neels Hofmeyr | 35fb679 | 2019-10-21 06:06:27 +0200 | [diff] [blame] | 44 | fprintf(stderr, LOG_COLOR " %4d:%s: " fmt LOG_COLOR_OFF "\n", \ |
Neels Hofmeyr | 6a29d32 | 2017-01-25 15:04:16 +0100 | [diff] [blame] | 45 | __LINE__, __FILE__, ## args ); \ |
| 46 | else \ |
| 47 | fprintf(stderr, fmt "\n", ## args ); \ |
| 48 | } while (false) |
| 49 | |
| 50 | /* btw means "by the way", the test tells the log what's happening. |
| 51 | * BTW() marks a larger section, btw() is the usual logging. */ |
Neels Hofmeyr | c4628a3 | 2018-12-07 14:47:34 +0100 | [diff] [blame] | 52 | #define BTW(fmt, args...) _log("\n\n- " fmt, ## args ) |
Neels Hofmeyr | 6a29d32 | 2017-01-25 15:04:16 +0100 | [diff] [blame] | 53 | #define btw(fmt, args...) _log("- " fmt, ## args ) |
| 54 | #define log(fmt, args...) _log(" " fmt, ## args ) |
| 55 | |
Neels Hofmeyr | dfdc61d | 2018-03-02 00:40:58 +0100 | [diff] [blame] | 56 | #define comment_start() fprintf(stderr, "===== %s\n", __func__); |
| 57 | #define comment_end() fprintf(stderr, "===== %s: SUCCESS\n\n", __func__); |
Neels Hofmeyr | 6a29d32 | 2017-01-25 15:04:16 +0100 | [diff] [blame] | 58 | |
Neels Hofmeyr | c4628a3 | 2018-12-07 14:47:34 +0100 | [diff] [blame] | 59 | extern struct msub *g_msub; |
Neels Hofmeyr | 6a29d32 | 2017-01-25 15:04:16 +0100 | [diff] [blame] | 60 | extern struct gsm_network *net; |
Neels Hofmeyr | 6a29d32 | 2017-01-25 15:04:16 +0100 | [diff] [blame] | 61 | extern void *msgb_ctx; |
| 62 | |
Neels Hofmeyr | 7814a83 | 2018-12-26 00:40:18 +0100 | [diff] [blame] | 63 | extern enum osmo_rat_type rx_from_ran; |
Neels Hofmeyr | 6a29d32 | 2017-01-25 15:04:16 +0100 | [diff] [blame] | 64 | |
| 65 | extern const char *gsup_tx_expected; |
| 66 | extern bool gsup_tx_confirmed; |
| 67 | |
| 68 | extern struct msgb *dtap_tx_expected; |
| 69 | extern bool dtap_tx_confirmed; |
| 70 | |
| 71 | enum result_sent { |
| 72 | RES_NONE = 0, |
| 73 | RES_ACCEPT = 1, |
| 74 | RES_REJECT = 2, |
| 75 | }; |
| 76 | extern enum result_sent lu_result_sent; |
| 77 | extern enum result_sent cm_service_result_sent; |
| 78 | |
| 79 | extern bool auth_request_sent; |
| 80 | extern const char *auth_request_expect_rand; |
| 81 | extern const char *auth_request_expect_autn; |
| 82 | |
| 83 | extern bool cipher_mode_cmd_sent; |
| 84 | extern bool cipher_mode_cmd_sent_with_imeisv; |
Neels Hofmeyr | dbabfd3 | 2018-03-10 02:06:47 +0100 | [diff] [blame] | 85 | extern const char *cipher_mode_expect_kc; |
| 86 | |
| 87 | extern bool security_mode_ctrl_sent; |
| 88 | extern const char *security_mode_expect_ck; |
| 89 | extern const char *security_mode_expect_ik; |
| 90 | |
| 91 | static inline void expect_cipher_mode_cmd(const char *kc) |
| 92 | { |
| 93 | cipher_mode_cmd_sent = false; |
| 94 | cipher_mode_expect_kc = kc; |
| 95 | /* make sure we don't mix up the two */ |
| 96 | security_mode_ctrl_sent = false; |
| 97 | } |
| 98 | |
| 99 | static inline void expect_security_mode_ctrl(const char *ck, const char *ik) |
| 100 | { |
| 101 | security_mode_ctrl_sent = false; |
| 102 | security_mode_expect_ck = ck; |
| 103 | security_mode_expect_ik = ik; |
| 104 | /* make sure we don't mix up the two */ |
| 105 | cipher_mode_cmd_sent = false; |
| 106 | } |
Neels Hofmeyr | 6a29d32 | 2017-01-25 15:04:16 +0100 | [diff] [blame] | 107 | |
| 108 | extern bool paging_sent; |
Neels Hofmeyr | 6a29d32 | 2017-01-25 15:04:16 +0100 | [diff] [blame] | 109 | |
Philipp Maier | fbf6610 | 2017-04-09 12:32:51 +0200 | [diff] [blame] | 110 | extern bool iu_release_expected; |
| 111 | extern bool iu_release_sent; |
| 112 | extern bool bssap_clear_expected; |
| 113 | extern bool bssap_clear_sent; |
| 114 | |
Neels Hofmeyr | a99b427 | 2017-11-21 17:13:23 +0100 | [diff] [blame] | 115 | extern uint32_t cc_to_mncc_tx_expected_msg_type; |
| 116 | extern const char *cc_to_mncc_tx_expected_imsi; |
| 117 | extern bool cc_to_mncc_tx_confirmed; |
| 118 | extern uint32_t cc_to_mncc_tx_got_callref; |
| 119 | |
Neels Hofmeyr | cbcf89c | 2018-03-13 17:52:07 +0100 | [diff] [blame] | 120 | extern struct gsm_mncc *on_call_release_mncc_sends_to_cc_data; |
| 121 | |
Philipp Maier | fbf6610 | 2017-04-09 12:32:51 +0200 | [diff] [blame] | 122 | static inline void expect_iu_release() |
| 123 | { |
| 124 | iu_release_expected = true; |
| 125 | iu_release_sent = false; |
| 126 | } |
| 127 | |
| 128 | static inline void expect_bssap_clear() |
| 129 | { |
| 130 | bssap_clear_expected = true; |
| 131 | bssap_clear_sent = false; |
| 132 | } |
| 133 | |
Neels Hofmeyr | 7814a83 | 2018-12-26 00:40:18 +0100 | [diff] [blame] | 134 | static inline void expect_release_clear(enum osmo_rat_type via_ran) |
Philipp Maier | fbf6610 | 2017-04-09 12:32:51 +0200 | [diff] [blame] | 135 | { |
| 136 | switch (via_ran) { |
Neels Hofmeyr | 7814a83 | 2018-12-26 00:40:18 +0100 | [diff] [blame] | 137 | case OSMO_RAT_GERAN_A: |
Philipp Maier | fbf6610 | 2017-04-09 12:32:51 +0200 | [diff] [blame] | 138 | expect_bssap_clear(); |
| 139 | return; |
Neels Hofmeyr | 7814a83 | 2018-12-26 00:40:18 +0100 | [diff] [blame] | 140 | case OSMO_RAT_UTRAN_IU: |
Philipp Maier | fbf6610 | 2017-04-09 12:32:51 +0200 | [diff] [blame] | 141 | expect_iu_release(); |
| 142 | return; |
| 143 | default: |
| 144 | OSMO_ASSERT(false); |
| 145 | break; |
| 146 | } |
| 147 | } |
| 148 | |
Neels Hofmeyr | 3f391dd | 2019-08-29 03:53:11 +0200 | [diff] [blame] | 149 | extern bool bssap_assignment_expected; |
| 150 | extern bool bssap_assignment_sent; |
| 151 | extern bool iu_rab_assignment_expected; |
| 152 | extern bool iu_rab_assignment_sent; |
| 153 | |
| 154 | static inline void expect_bssap_assignment() |
| 155 | { |
| 156 | bssap_assignment_expected = true; |
| 157 | bssap_assignment_sent = false; |
| 158 | } |
| 159 | |
| 160 | static inline void expect_iu_rab_assignment() |
| 161 | { |
| 162 | iu_rab_assignment_expected = true; |
| 163 | iu_rab_assignment_sent = false; |
| 164 | } |
| 165 | |
Neels Hofmeyr | 6a29d32 | 2017-01-25 15:04:16 +0100 | [diff] [blame] | 166 | struct msc_vlr_test_cmdline_opts { |
| 167 | bool verbose; |
| 168 | int run_test_nr; |
| 169 | }; |
| 170 | |
Neels Hofmeyr | dfdc61d | 2018-03-02 00:40:58 +0100 | [diff] [blame] | 171 | typedef void (* msc_vlr_test_func_t )(void); |
Neels Hofmeyr | 6a29d32 | 2017-01-25 15:04:16 +0100 | [diff] [blame] | 172 | extern msc_vlr_test_func_t msc_vlr_tests[]; |
| 173 | |
| 174 | struct msgb *msgb_from_hex(const char *label, uint16_t size, const char *hex); |
| 175 | |
| 176 | void clear_vlr(); |
Neels Hofmeyr | c4628a3 | 2018-12-07 14:47:34 +0100 | [diff] [blame] | 177 | bool conn_exists(const struct msub *msub); |
| 178 | void conn_conclude_cm_service_req(struct msub *msub, const char *cm_service_use); |
Neels Hofmeyr | 6a29d32 | 2017-01-25 15:04:16 +0100 | [diff] [blame] | 179 | |
| 180 | void dtap_expect_tx(const char *hex); |
| 181 | void dtap_expect_tx_ussd(char *ussd_text); |
| 182 | void paging_expect_imsi(const char *imsi); |
| 183 | void paging_expect_tmsi(uint32_t tmsi); |
| 184 | |
| 185 | void ms_sends_msg(const char *hex); |
Neels Hofmeyr | c4628a3 | 2018-12-07 14:47:34 +0100 | [diff] [blame] | 186 | void ms_sends_classmark_update(const struct osmo_gsm48_classmark *classmark); |
| 187 | void ms_sends_ciphering_mode_complete(const char *inner_nas_msg); |
Alexander Couzens | 2aaff75 | 2021-10-19 17:09:11 +0200 | [diff] [blame] | 188 | void ms_sends_security_mode_complete(uint8_t utran_encryption); |
Neels Hofmeyr | 3f391dd | 2019-08-29 03:53:11 +0200 | [diff] [blame] | 189 | void ms_sends_assignment_complete(enum mgcp_codecs assigned_codec); |
Neels Hofmeyr | 6a29d32 | 2017-01-25 15:04:16 +0100 | [diff] [blame] | 190 | void gsup_rx(const char *rx_hex, const char *expect_tx_hex); |
| 191 | void send_sms(struct vlr_subscr *receiver, |
| 192 | struct vlr_subscr *sender, |
| 193 | char *str); |
Neels Hofmeyr | 3f391dd | 2019-08-29 03:53:11 +0200 | [diff] [blame] | 194 | void crcx_ok(enum rtp_direction dir); |
Neels Hofmeyr | 6a29d32 | 2017-01-25 15:04:16 +0100 | [diff] [blame] | 195 | |
Neels Hofmeyr | c4628a3 | 2018-12-07 14:47:34 +0100 | [diff] [blame] | 196 | void ran_sends_clear_complete(); |
Neels Hofmeyr | 4068ab2 | 2018-04-01 20:55:54 +0200 | [diff] [blame] | 197 | |
Neels Hofmeyr | 6a29d32 | 2017-01-25 15:04:16 +0100 | [diff] [blame] | 198 | void thwart_rx_non_initial_requests(); |
| 199 | |
Neels Hofmeyr | 6a29d32 | 2017-01-25 15:04:16 +0100 | [diff] [blame] | 200 | #define EXPECT_ACCEPTED(expect_accepted) do { \ |
Neels Hofmeyr | c4628a3 | 2018-12-07 14:47:34 +0100 | [diff] [blame] | 201 | if (g_msub) \ |
| 202 | OSMO_ASSERT(conn_exists(g_msub)); \ |
| 203 | bool accepted = msc_a_is_accepted(msub_msc_a(g_msub)); \ |
| 204 | fprintf(stderr, "msc_a_is_accepted() == %s\n", \ |
Neels Hofmeyr | 6a29d32 | 2017-01-25 15:04:16 +0100 | [diff] [blame] | 205 | accepted ? "true" : "false"); \ |
| 206 | OSMO_ASSERT(accepted == expect_accepted); \ |
| 207 | } while (false) |
| 208 | |
Max | bb53a3f | 2018-12-17 17:09:17 +0100 | [diff] [blame] | 209 | #define VAL_ASSERT(desc, val, expect_op, fmt) \ |
Neels Hofmeyr | 6a29d32 | 2017-01-25 15:04:16 +0100 | [diff] [blame] | 210 | do { \ |
Max | bb53a3f | 2018-12-17 17:09:17 +0100 | [diff] [blame] | 211 | log(desc " == " fmt, (val)); \ |
Neels Hofmeyr | 6a29d32 | 2017-01-25 15:04:16 +0100 | [diff] [blame] | 212 | OSMO_ASSERT((val) expect_op); \ |
Max | bb53a3f | 2018-12-17 17:09:17 +0100 | [diff] [blame] | 213 | } while (0) |
| 214 | |
| 215 | #define VERBOSE_ASSERT(val, expect_op, fmt) VAL_ASSERT(#val, val, expect_op, fmt) |
Neels Hofmeyr | 6a29d32 | 2017-01-25 15:04:16 +0100 | [diff] [blame] | 216 | |
Neels Hofmeyr | c4628a3 | 2018-12-07 14:47:34 +0100 | [diff] [blame] | 217 | #define EXPECT_CONN_COUNT(N) VERBOSE_ASSERT(llist_count(&msub_list), == N, "%d") |
Neels Hofmeyr | 6a29d32 | 2017-01-25 15:04:16 +0100 | [diff] [blame] | 218 | |
| 219 | #define gsup_expect_tx(hex) do \ |
| 220 | { \ |
Neels Hofmeyr | 84da6b1 | 2016-05-20 21:59:55 +0200 | [diff] [blame] | 221 | if (gsup_tx_expected) { \ |
| 222 | log("Previous expected GSUP tx was not confirmed!"); \ |
| 223 | OSMO_ASSERT(!gsup_tx_expected); \ |
| 224 | } \ |
Neels Hofmeyr | 6a29d32 | 2017-01-25 15:04:16 +0100 | [diff] [blame] | 225 | if (!hex) \ |
| 226 | break; \ |
| 227 | gsup_tx_expected = hex; \ |
| 228 | gsup_tx_confirmed = false; \ |
| 229 | } while (0) |
| 230 | |
Neels Hofmeyr | a99b427 | 2017-11-21 17:13:23 +0100 | [diff] [blame] | 231 | #define cc_to_mncc_expect_tx(imsi, msg_type) do \ |
| 232 | { \ |
| 233 | if (cc_to_mncc_tx_expected_msg_type) { \ |
| 234 | log("Previous expected MNCC tx was not confirmed!"); \ |
| 235 | OSMO_ASSERT(!cc_to_mncc_tx_expected_msg_type); \ |
| 236 | } \ |
| 237 | cc_to_mncc_tx_expected_imsi = imsi; \ |
| 238 | cc_to_mncc_tx_expected_msg_type = msg_type; \ |
| 239 | cc_to_mncc_tx_confirmed = false; \ |
| 240 | } while (0) |
| 241 | |
Neels Hofmeyr | 6a29d32 | 2017-01-25 15:04:16 +0100 | [diff] [blame] | 242 | void fake_time_start(); |
| 243 | |
| 244 | /* as macro to get the test file's source line number */ |
| 245 | #define fake_time_passes(secs, usecs) do \ |
| 246 | { \ |
| 247 | struct timeval diff; \ |
| 248 | osmo_gettimeofday_override_add(secs, usecs); \ |
Stefan Sperling | defc3c8 | 2018-05-15 14:48:04 +0200 | [diff] [blame] | 249 | osmo_clock_override_add(CLOCK_MONOTONIC, secs, usecs * 1000); \ |
Neels Hofmeyr | 6a29d32 | 2017-01-25 15:04:16 +0100 | [diff] [blame] | 250 | timersub(&osmo_gettimeofday_override_time, &fake_time_start_time, &diff); \ |
| 251 | btw("Total time passed: %d.%06d s", \ |
| 252 | (int)diff.tv_sec, (int)diff.tv_usec); \ |
| 253 | osmo_timers_prepare(); \ |
| 254 | osmo_timers_update(); \ |
| 255 | } while (0) |
| 256 | |
| 257 | extern const struct timeval fake_time_start_time; |
Neels Hofmeyr | 4068ab2 | 2018-04-01 20:55:54 +0200 | [diff] [blame] | 258 | |
| 259 | #define ASSERT_RELEASE_CLEAR(via_ran) \ |
| 260 | switch (via_ran) { \ |
Neels Hofmeyr | 7814a83 | 2018-12-26 00:40:18 +0100 | [diff] [blame] | 261 | case OSMO_RAT_GERAN_A: \ |
Neels Hofmeyr | 4068ab2 | 2018-04-01 20:55:54 +0200 | [diff] [blame] | 262 | VERBOSE_ASSERT(bssap_clear_sent, == true, "%d"); \ |
| 263 | break; \ |
Neels Hofmeyr | 7814a83 | 2018-12-26 00:40:18 +0100 | [diff] [blame] | 264 | case OSMO_RAT_UTRAN_IU: \ |
Neels Hofmeyr | 4068ab2 | 2018-04-01 20:55:54 +0200 | [diff] [blame] | 265 | VERBOSE_ASSERT(iu_release_sent, == true, "%d"); \ |
| 266 | break; \ |
| 267 | default: \ |
| 268 | OSMO_ASSERT(false); \ |
| 269 | break; \ |
| 270 | } |
| 271 | |
Neels Hofmeyr | c4628a3 | 2018-12-07 14:47:34 +0100 | [diff] [blame] | 272 | #define HLR_TO_VLR "0a0101" |
| 273 | #define VLR_TO_HLR "0a0101" |
Neels Hofmeyr | 63b2464 | 2019-12-12 01:31:04 +0100 | [diff] [blame] | 274 | #define CN_DOMAIN "280102" |
Neels Hofmeyr | c4628a3 | 2018-12-07 14:47:34 +0100 | [diff] [blame] | 275 | #define EUSE_TO_MSC_USSD "0a0103" |
| 276 | #define MSC_USSD_TO_EUSE "0a0103" |
Neels Hofmeyr | 3f391dd | 2019-08-29 03:53:11 +0200 | [diff] [blame] | 277 | |
| 278 | extern bool got_crcx; |
| 279 | void expect_crcx(enum rtp_direction towards); |