Holger Hans Peter Freyther | daa653f | 2010-10-11 07:56:06 +0200 | [diff] [blame] | 1 | /* |
| 2 | * (C) 2010 by Holger Hans Peter Freyther |
| 3 | * (C) 2010 by On-Waves |
| 4 | * All Rights Reserved |
| 5 | * |
| 6 | * This program is free software; you can redistribute it and/or modify |
| 7 | * it under the terms of the GNU General Public License as published by |
| 8 | * the Free Software Foundation; either version 2 of the License, or |
| 9 | * (at your option) any later version. |
| 10 | * |
| 11 | * This program is distributed in the hope that it will be useful, |
| 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 | * GNU General Public License for more details. |
| 15 | * |
Holger Hans Peter Freyther | daa653f | 2010-10-11 07:56:06 +0200 | [diff] [blame] | 16 | */ |
| 17 | |
Holger Hans Peter Freyther | bf12800 | 2011-11-13 22:48:37 +0100 | [diff] [blame] | 18 | #include <osmocom/core/application.h> |
| 19 | #include <osmocom/core/logging.h> |
Pablo Neira Ayuso | 8341934 | 2011-03-22 16:36:13 +0100 | [diff] [blame] | 20 | #include <osmocom/gsm/gsm0480.h> |
Andreas Eversberg | 9597555 | 2013-08-08 12:38:53 +0200 | [diff] [blame] | 21 | #include <osmocom/gsm/gsm_utils.h> |
Holger Hans Peter Freyther | daa653f | 2010-10-11 07:56:06 +0200 | [diff] [blame] | 22 | #include <stdio.h> |
| 23 | #include <stdlib.h> |
| 24 | #include <string.h> |
| 25 | |
| 26 | static const uint8_t ussd_request[] = { |
| 27 | 0x0b, 0x7b, 0x1c, 0x15, 0xa1, 0x13, 0x02, 0x01, |
| 28 | 0x03, 0x02, 0x01, 0x3b, 0x30, 0x0b, 0x04, 0x01, |
| 29 | 0x0f, 0x04, 0x06, 0x2a, 0xd5, 0x4c, 0x16, 0x1b, |
| 30 | 0x01, 0x7f, 0x01, 0x00 |
| 31 | }; |
| 32 | |
Vadim Yanitskiy | 52e4412 | 2018-06-11 03:51:11 +0700 | [diff] [blame] | 33 | static const uint8_t ussd_facility[] = { |
| 34 | 0x1b, 0x3a, 0x12, 0xa2, 0x10, 0x02, 0x01, 0x01, |
| 35 | 0x30, 0x0b, 0x02, 0x01, 0x3c, 0x30, 0x06, 0x04, |
| 36 | 0x01, 0x0f, 0x04, 0x01, 0x32 |
| 37 | }; |
| 38 | |
| 39 | static const uint8_t ussd_release[] = { |
| 40 | 0x8b, 0x2a, 0x1c, 0x08, 0xa3, 0x06, 0x02, 0x01, |
| 41 | 0x05, 0x02, 0x01, 0x24 |
| 42 | }; |
| 43 | |
Holger Hans Peter Freyther | 4a62dbb | 2016-07-12 17:45:34 +0200 | [diff] [blame] | 44 | static const uint8_t interrogate_ss[] = { |
| 45 | 0x0b, 0x7b, 0x1c, 0x0d, 0xa1, 0x0b, 0x02, 0x01, |
| 46 | 0x03, 0x02, 0x01, 0x0e, 0x30, 0x03, 0x04, 0x01, |
| 47 | 0x21, 0x7f, 0x01, 0x00 |
| 48 | }; |
| 49 | |
Holger Hans Peter Freyther | daa653f | 2010-10-11 07:56:06 +0200 | [diff] [blame] | 50 | static int parse_ussd(const uint8_t *_data, int len) |
| 51 | { |
| 52 | uint8_t *data; |
| 53 | int rc; |
Tobias Engel | 419684e | 2012-03-08 13:31:52 +0100 | [diff] [blame] | 54 | struct ss_request req; |
Holger Hans Peter Freyther | daa653f | 2010-10-11 07:56:06 +0200 | [diff] [blame] | 55 | struct gsm48_hdr *hdr; |
| 56 | |
| 57 | data = malloc(len); |
| 58 | memcpy(data, _data, len); |
| 59 | hdr = (struct gsm48_hdr *) &data[0]; |
Tobias Engel | 419684e | 2012-03-08 13:31:52 +0100 | [diff] [blame] | 60 | rc = gsm0480_decode_ss_request(hdr, len, &req); |
Holger Hans Peter Freyther | daa653f | 2010-10-11 07:56:06 +0200 | [diff] [blame] | 61 | free(data); |
| 62 | |
| 63 | return rc; |
| 64 | } |
| 65 | |
Holger Hans Peter Freyther | c88a44f | 2010-10-11 08:21:00 +0200 | [diff] [blame] | 66 | static int parse_mangle_ussd(const uint8_t *_data, int len) |
| 67 | { |
| 68 | uint8_t *data; |
| 69 | int rc; |
Tobias Engel | 419684e | 2012-03-08 13:31:52 +0100 | [diff] [blame] | 70 | struct ss_request req; |
Holger Hans Peter Freyther | c88a44f | 2010-10-11 08:21:00 +0200 | [diff] [blame] | 71 | struct gsm48_hdr *hdr; |
| 72 | |
| 73 | data = malloc(len); |
| 74 | memcpy(data, _data, len); |
| 75 | hdr = (struct gsm48_hdr *) &data[0]; |
| 76 | hdr->data[1] = len - sizeof(*hdr) - 2; |
Tobias Engel | 419684e | 2012-03-08 13:31:52 +0100 | [diff] [blame] | 77 | rc = gsm0480_decode_ss_request(hdr, len, &req); |
Holger Hans Peter Freyther | c88a44f | 2010-10-11 08:21:00 +0200 | [diff] [blame] | 78 | free(data); |
| 79 | |
| 80 | return rc; |
| 81 | } |
| 82 | |
Holger Hans Peter Freyther | bf12800 | 2011-11-13 22:48:37 +0100 | [diff] [blame] | 83 | struct log_info info = {}; |
| 84 | |
Jacob Erlbeck | 8a1666b | 2013-08-08 12:38:54 +0200 | [diff] [blame] | 85 | static void test_7bit_ussd(const char *text, const char *encoded_hex, const char *appended_after_decode) |
Andreas Eversberg | 9597555 | 2013-08-08 12:38:53 +0200 | [diff] [blame] | 86 | { |
| 87 | uint8_t coded[256]; |
| 88 | char decoded[256]; |
Jacob Erlbeck | 1d7f3b5 | 2013-08-12 17:07:53 +0200 | [diff] [blame] | 89 | int octets_written; |
| 90 | int buffer_size; |
| 91 | int nchars; |
Andreas Eversberg | 9597555 | 2013-08-08 12:38:53 +0200 | [diff] [blame] | 92 | |
| 93 | printf("original = %s\n", osmo_hexdump((uint8_t *)text, strlen(text))); |
Jacob Erlbeck | 1d7f3b5 | 2013-08-12 17:07:53 +0200 | [diff] [blame] | 94 | gsm_7bit_encode_n_ussd(coded, sizeof(coded), text, &octets_written); |
| 95 | printf("encoded = %s\n", osmo_hexdump(coded, octets_written)); |
Jacob Erlbeck | 8a1666b | 2013-08-08 12:38:54 +0200 | [diff] [blame] | 96 | |
Jacob Erlbeck | 1d7f3b5 | 2013-08-12 17:07:53 +0200 | [diff] [blame] | 97 | OSMO_ASSERT(strcmp(encoded_hex, osmo_hexdump_nospc(coded, octets_written)) == 0); |
Jacob Erlbeck | 8a1666b | 2013-08-08 12:38:54 +0200 | [diff] [blame] | 98 | |
Jacob Erlbeck | 1d7f3b5 | 2013-08-12 17:07:53 +0200 | [diff] [blame] | 99 | gsm_7bit_decode_n_ussd(decoded, sizeof(decoded), coded, octets_written * 8 / 7); |
Vadim Yanitskiy | bd33a95 | 2018-01-20 04:52:43 +0600 | [diff] [blame] | 100 | printf("decoded = %s\n\n", osmo_hexdump((uint8_t *)decoded, strlen(decoded))); |
Jacob Erlbeck | 8a1666b | 2013-08-08 12:38:54 +0200 | [diff] [blame] | 101 | |
| 102 | OSMO_ASSERT(strncmp(text, decoded, strlen(text)) == 0); |
| 103 | OSMO_ASSERT(strcmp(appended_after_decode, decoded + strlen(text)) == 0); |
Jacob Erlbeck | 1d7f3b5 | 2013-08-12 17:07:53 +0200 | [diff] [blame] | 104 | |
| 105 | /* check buffer limiting */ |
| 106 | memset(decoded, 0xaa, sizeof(decoded)); |
| 107 | |
| 108 | for (buffer_size = 1; buffer_size < sizeof(decoded) - 1; ++buffer_size) |
| 109 | { |
| 110 | nchars = gsm_7bit_decode_n_ussd(decoded, buffer_size, coded, octets_written * 8 / 7); |
| 111 | OSMO_ASSERT(nchars <= buffer_size); |
| 112 | OSMO_ASSERT(decoded[buffer_size] == (char)0xaa); |
| 113 | OSMO_ASSERT(decoded[nchars] == '\0'); |
| 114 | } |
| 115 | |
| 116 | memset(coded, 0xaa, sizeof(coded)); |
| 117 | |
| 118 | for (buffer_size = 0; buffer_size < sizeof(coded) - 1; ++buffer_size) |
| 119 | { |
| 120 | gsm_7bit_encode_n_ussd(coded, buffer_size, text, &octets_written); |
| 121 | OSMO_ASSERT(octets_written <= buffer_size); |
| 122 | OSMO_ASSERT(coded[buffer_size] == 0xaa); |
| 123 | } |
Andreas Eversberg | 9597555 | 2013-08-08 12:38:53 +0200 | [diff] [blame] | 124 | } |
| 125 | |
Vadim Yanitskiy | 52e4412 | 2018-06-11 03:51:11 +0700 | [diff] [blame] | 126 | static void test_extract_ie_by_tag(void) |
| 127 | { |
| 128 | uint16_t ie_len; |
| 129 | uint8_t *ie; |
| 130 | int rc; |
| 131 | |
| 132 | printf("[i] Testing gsm0480_extract_ie_by_tag()\n"); |
| 133 | |
| 134 | /* REGISTER message with Facility IE */ |
| 135 | rc = gsm0480_extract_ie_by_tag((struct gsm48_hdr *) ussd_request, |
| 136 | sizeof(ussd_request), &ie, &ie_len, GSM0480_IE_FACILITY); |
| 137 | OSMO_ASSERT(rc == 0); |
| 138 | OSMO_ASSERT(ie != NULL && ie_len > 0); |
| 139 | printf("[?] REGISTER message with Facility IE " |
| 140 | "(len=%u): %s\n", ie_len, osmo_hexdump(ie, ie_len)); |
| 141 | |
| 142 | /* REGISTER message with SS version IE */ |
| 143 | rc = gsm0480_extract_ie_by_tag((struct gsm48_hdr *) ussd_request, |
| 144 | sizeof(ussd_request), &ie, &ie_len, GSM0480_IE_SS_VERSION); |
| 145 | OSMO_ASSERT(rc == 0); |
| 146 | OSMO_ASSERT(ie != NULL && ie_len > 0); |
| 147 | printf("[?] REGISTER message with SS version IE " |
| 148 | "(len=%u): %s\n", ie_len, osmo_hexdump(ie, ie_len)); |
| 149 | |
| 150 | /* REGISTER message with unknown IE */ |
| 151 | rc = gsm0480_extract_ie_by_tag((struct gsm48_hdr *) ussd_request, |
| 152 | sizeof(ussd_request), &ie, &ie_len, 0xff); |
| 153 | OSMO_ASSERT(rc == 0); |
| 154 | OSMO_ASSERT(ie == NULL && ie_len == 0); |
| 155 | |
| 156 | /* FACILITY message with Facility IE */ |
| 157 | rc = gsm0480_extract_ie_by_tag((struct gsm48_hdr *) ussd_facility, |
| 158 | sizeof(ussd_facility), &ie, &ie_len, GSM0480_IE_FACILITY); |
| 159 | OSMO_ASSERT(rc == 0); |
| 160 | OSMO_ASSERT(ie != NULL && ie_len > 0); |
| 161 | printf("[?] FACILITY message with Facility IE " |
| 162 | "(len=%u): %s\n", ie_len, osmo_hexdump(ie, ie_len)); |
| 163 | |
| 164 | /* FACILITY message with unknown IE */ |
| 165 | rc = gsm0480_extract_ie_by_tag((struct gsm48_hdr *) ussd_facility, |
| 166 | sizeof(ussd_facility), &ie, &ie_len, 0xff); |
| 167 | OSMO_ASSERT(rc == 0); |
| 168 | OSMO_ASSERT(ie == NULL && ie_len == 0); |
| 169 | |
| 170 | /* RELEASE COMPLETE message with Facility IE */ |
| 171 | rc = gsm0480_extract_ie_by_tag((struct gsm48_hdr *) ussd_release, |
| 172 | sizeof(ussd_release), &ie, &ie_len, GSM0480_IE_FACILITY); |
| 173 | OSMO_ASSERT(rc == 0); |
| 174 | OSMO_ASSERT(ie != NULL && ie_len > 0); |
| 175 | printf("[?] RELEASE COMPLETE message with Facility IE " |
| 176 | "(len=%u): %s\n", ie_len, osmo_hexdump(ie, ie_len)); |
| 177 | |
| 178 | /* RELEASE COMPLETE message without Facility IE */ |
| 179 | rc = gsm0480_extract_ie_by_tag((struct gsm48_hdr *) ussd_release, |
| 180 | sizeof(struct gsm48_hdr), &ie, &ie_len, GSM0480_IE_FACILITY); |
| 181 | OSMO_ASSERT(rc == 0); |
| 182 | OSMO_ASSERT(ie == NULL && ie_len == 0); |
| 183 | |
| 184 | printf("\n"); |
| 185 | } |
| 186 | |
Vadim Yanitskiy | 5a09f75 | 2018-06-11 04:58:53 +0700 | [diff] [blame] | 187 | static void test_parse_facility_ie(void) |
| 188 | { |
| 189 | struct ss_request req; |
| 190 | uint16_t ie_len; |
| 191 | uint8_t *ie; |
| 192 | int rc; |
| 193 | |
| 194 | printf("[i] Testing gsm0480_parse_facility_ie()\n"); |
| 195 | |
| 196 | /* Extract Facility IE from FACILITY message */ |
| 197 | rc = gsm0480_extract_ie_by_tag((struct gsm48_hdr *) ussd_facility, |
| 198 | sizeof(ussd_facility), &ie, &ie_len, GSM0480_IE_FACILITY); |
| 199 | OSMO_ASSERT(rc == 0); |
| 200 | OSMO_ASSERT(ie != NULL && ie_len > 0); |
| 201 | printf("[?] FACILITY message with Facility IE " |
| 202 | "(len=%u): %s\n", ie_len, osmo_hexdump(ie, ie_len)); |
| 203 | |
| 204 | /* Attempt to decode */ |
| 205 | memset(&req, 0x00, sizeof(req)); |
| 206 | rc = gsm0480_parse_facility_ie(ie, ie_len, &req); |
| 207 | OSMO_ASSERT(rc == 0); |
| 208 | |
| 209 | /* Verify expected vs decoded data */ |
| 210 | printf("[?] InvokeID: expected 0x%02x, decoded 0x%02x\n", |
| 211 | 0x01, req.invoke_id); |
| 212 | printf("[?] Operation code: expected 0x%02x, decoded 0x%02x\n", |
| 213 | 0x3c, req.opcode); |
| 214 | printf("[?] Data Coding Scheme: expected 0x%02x, decoded 0x%02x\n", |
| 215 | 0x0f, req.ussd_data_dcs); |
| 216 | printf("[?] Data length: expected 0x%02x, decoded 0x%02x\n", |
| 217 | 0x01, req.ussd_data_len); |
| 218 | printf("[?] Data: expected %s, decoded %s\n", "32", |
| 219 | osmo_hexdump_nospc(req.ussd_data, req.ussd_data_len)); |
| 220 | |
| 221 | printf("\n"); |
| 222 | } |
| 223 | |
Holger Hans Peter Freyther | daa653f | 2010-10-11 07:56:06 +0200 | [diff] [blame] | 224 | int main(int argc, char **argv) |
| 225 | { |
Tobias Engel | 419684e | 2012-03-08 13:31:52 +0100 | [diff] [blame] | 226 | struct ss_request req; |
Vadim Yanitskiy | ac3b6ac | 2018-01-17 15:03:32 +0600 | [diff] [blame] | 227 | uint16_t size; |
Holger Hans Peter Freyther | daa653f | 2010-10-11 07:56:06 +0200 | [diff] [blame] | 228 | int i; |
Jacob Erlbeck | 1d7f3b5 | 2013-08-12 17:07:53 +0200 | [diff] [blame] | 229 | struct msgb *msg; |
Neels Hofmeyr | a829b45 | 2018-04-05 03:02:35 +0200 | [diff] [blame] | 230 | void *ctx = talloc_named_const(NULL, 0, "ussd_test"); |
Holger Hans Peter Freyther | daa653f | 2010-10-11 07:56:06 +0200 | [diff] [blame] | 231 | |
Neels Hofmeyr | a829b45 | 2018-04-05 03:02:35 +0200 | [diff] [blame] | 232 | osmo_init_logging2(ctx, &info); |
Holger Hans Peter Freyther | bf12800 | 2011-11-13 22:48:37 +0100 | [diff] [blame] | 233 | |
Vadim Yanitskiy | 52e4412 | 2018-06-11 03:51:11 +0700 | [diff] [blame] | 234 | /* Test gsm0480_extract_ie_by_tag() */ |
| 235 | test_extract_ie_by_tag(); |
| 236 | |
Vadim Yanitskiy | 5a09f75 | 2018-06-11 04:58:53 +0700 | [diff] [blame] | 237 | /* Test gsm0480_parse_facility_ie() */ |
| 238 | test_parse_facility_ie(); |
| 239 | |
Holger Hans Peter Freyther | 4a62dbb | 2016-07-12 17:45:34 +0200 | [diff] [blame] | 240 | memset(&req, 0, sizeof(req)); |
Vadim Yanitskiy | ac3b6ac | 2018-01-17 15:03:32 +0600 | [diff] [blame] | 241 | gsm0480_decode_ss_request((struct gsm48_hdr *) ussd_request, |
| 242 | sizeof(ussd_request), &req); |
Tobias Engel | 419684e | 2012-03-08 13:31:52 +0100 | [diff] [blame] | 243 | printf("Tested if it still works. Text was: %s\n", req.ussd_text); |
Holger Hans Peter Freyther | f632371 | 2010-10-11 08:49:27 +0200 | [diff] [blame] | 244 | |
Holger Hans Peter Freyther | 4a62dbb | 2016-07-12 17:45:34 +0200 | [diff] [blame] | 245 | memset(&req, 0, sizeof(req)); |
Vadim Yanitskiy | ac3b6ac | 2018-01-17 15:03:32 +0600 | [diff] [blame] | 246 | gsm0480_decode_ss_request((struct gsm48_hdr *) interrogate_ss, |
| 247 | sizeof(interrogate_ss), &req); |
Holger Hans Peter Freyther | 4a62dbb | 2016-07-12 17:45:34 +0200 | [diff] [blame] | 248 | OSMO_ASSERT(strlen((char *) req.ussd_text) == 0); |
| 249 | OSMO_ASSERT(req.ss_code == 33); |
| 250 | printf("interrogateSS CFU text..'%s' code %d\n", req.ussd_text, req.ss_code); |
Holger Hans Peter Freyther | f632371 | 2010-10-11 08:49:27 +0200 | [diff] [blame] | 251 | |
Holger Hans Peter Freyther | daa653f | 2010-10-11 07:56:06 +0200 | [diff] [blame] | 252 | printf("Testing parsing a USSD request and truncated versions\n"); |
| 253 | |
Vadim Yanitskiy | ac3b6ac | 2018-01-17 15:03:32 +0600 | [diff] [blame] | 254 | size = sizeof(ussd_request); |
| 255 | |
Holger Hans Peter Freyther | daa653f | 2010-10-11 07:56:06 +0200 | [diff] [blame] | 256 | for (i = size; i > sizeof(struct gsm48_hdr); --i) { |
| 257 | int rc = parse_ussd(&ussd_request[0], i); |
Vadim Yanitskiy | c0771d6 | 2018-01-10 23:42:19 +0600 | [diff] [blame] | 258 | printf("Result for len=%d is %d\n", i, rc); |
Holger Hans Peter Freyther | daa653f | 2010-10-11 07:56:06 +0200 | [diff] [blame] | 259 | } |
| 260 | |
Holger Hans Peter Freyther | c88a44f | 2010-10-11 08:21:00 +0200 | [diff] [blame] | 261 | printf("Mangling the container now\n"); |
| 262 | for (i = size; i > sizeof(struct gsm48_hdr) + 2; --i) { |
| 263 | int rc = parse_mangle_ussd(&ussd_request[0], i); |
Vadim Yanitskiy | c0771d6 | 2018-01-10 23:42:19 +0600 | [diff] [blame] | 264 | printf("Result for len=%d is %d\n", i, rc); |
Holger Hans Peter Freyther | c88a44f | 2010-10-11 08:21:00 +0200 | [diff] [blame] | 265 | } |
| 266 | |
Andreas Eversberg | 9597555 | 2013-08-08 12:38:53 +0200 | [diff] [blame] | 267 | printf("<CR> case test for 7 bit encode\n"); |
Jacob Erlbeck | 8a1666b | 2013-08-08 12:38:54 +0200 | [diff] [blame] | 268 | test_7bit_ussd("01234567", "b0986c46abd96e", ""); |
| 269 | test_7bit_ussd("0123456", "b0986c46abd91a", ""); |
| 270 | test_7bit_ussd("01234567\r", "b0986c46abd96e0d", ""); |
| 271 | /* The appended \r is compliant to GSM 03.38 section 6.1.2.3.1: */ |
| 272 | test_7bit_ussd("0123456\r", "b0986c46abd91a0d", "\r"); |
| 273 | test_7bit_ussd("012345\r", "b0986c46ab351a", ""); |
Andreas Eversberg | 9597555 | 2013-08-08 12:38:53 +0200 | [diff] [blame] | 274 | |
Jacob Erlbeck | 1d7f3b5 | 2013-08-12 17:07:53 +0200 | [diff] [blame] | 275 | printf("Checking GSM 04.80 USSD message generation.\n"); |
| 276 | |
| 277 | test_7bit_ussd("", "", ""); |
| 278 | msg = gsm0480_create_unstructuredSS_Notify (0x00, ""); |
| 279 | printf ("Created unstructuredSS_Notify (0x00): %s\n", |
| 280 | osmo_hexdump(msgb_data(msg), msgb_length(msg))); |
| 281 | msgb_free (msg); |
| 282 | |
| 283 | test_7bit_ussd("forty-two", "e6b79c9e6fd1ef6f", ""); |
| 284 | msg = gsm0480_create_unstructuredSS_Notify (0x42, "forty-two"); |
| 285 | printf ("Created unstructuredSS_Notify (0x42): %s\n", |
| 286 | osmo_hexdump(msgb_data(msg), msgb_length(msg))); |
| 287 | msgb_free (msg); |
Holger Hans Peter Freyther | daa653f | 2010-10-11 07:56:06 +0200 | [diff] [blame] | 288 | return 0; |
| 289 | } |