Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 1 | /* |
Harald Welte | e08da97 | 2017-11-13 01:00:26 +0900 | [diff] [blame] | 2 | * (C) 2014 by sysmocom - s.f.m.c. GmbH |
| 3 | * Author: Jacob Erlbeck |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 4 | * (C) 2015 by Holger Hans Peter Freyther |
| 5 | * (C) 2016 by Harald Welte <laforge@gnumonks.org> |
| 6 | * All Rights Reserved |
| 7 | * |
Harald Welte | e08da97 | 2017-11-13 01:00:26 +0900 | [diff] [blame] | 8 | * SPDX-License-Identifier: GPL-2.0+ |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 9 | * |
| 10 | * This program is free software; you can redistribute it and/or modify |
Neels Hofmeyr | 5f460de | 2016-12-08 16:23:05 +0100 | [diff] [blame] | 11 | * it under the terms of the GNU General Public License as published by |
| 12 | * the Free Software Foundation; either version 2 of the License, or |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 13 | * (at your option) any later version. |
| 14 | * |
| 15 | * This program is distributed in the hope that it will be useful, |
| 16 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 17 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
Neels Hofmeyr | 5f460de | 2016-12-08 16:23:05 +0100 | [diff] [blame] | 18 | * GNU General Public License for more details. |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 19 | * |
Neels Hofmeyr | 5f460de | 2016-12-08 16:23:05 +0100 | [diff] [blame] | 20 | * You should have received a copy of the GNU General Public License |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 21 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 22 | * |
| 23 | */ |
| 24 | |
| 25 | #include <osmocom/gsm/tlv.h> |
| 26 | #include <osmocom/core/msgb.h> |
| 27 | #include <osmocom/core/logging.h> |
| 28 | #include <osmocom/gsm/gsm48_ie.h> |
| 29 | #include <osmocom/gsm/gsup.h> |
| 30 | |
| 31 | #include <stdint.h> |
| 32 | |
Harald Welte | 96e2a00 | 2017-06-12 21:44:18 +0200 | [diff] [blame] | 33 | /*! \addtogroup gsup |
| 34 | * @{ |
Harald Welte | 381a1aa | 2017-10-16 18:31:20 +0200 | [diff] [blame] | 35 | * \file gsup.c |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 36 | * Osmocom Generic Subscriber Update Protocol |
Harald Welte | 96e2a00 | 2017-06-12 21:44:18 +0200 | [diff] [blame] | 37 | */ |
| 38 | |
Neels Hofmeyr | 10f5fb4 | 2017-02-09 02:09:09 +0100 | [diff] [blame] | 39 | const struct value_string osmo_gsup_message_type_names[] = { |
| 40 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_UPDATE_LOCATION_REQUEST), |
| 41 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_UPDATE_LOCATION_ERROR), |
| 42 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_UPDATE_LOCATION_RESULT), |
| 43 | |
| 44 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_SEND_AUTH_INFO_REQUEST), |
| 45 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_SEND_AUTH_INFO_ERROR), |
| 46 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_SEND_AUTH_INFO_RESULT), |
| 47 | |
| 48 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_AUTH_FAIL_REPORT), |
| 49 | |
| 50 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_PURGE_MS_REQUEST), |
| 51 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_PURGE_MS_ERROR), |
| 52 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_PURGE_MS_RESULT), |
| 53 | |
| 54 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_INSERT_DATA_REQUEST), |
| 55 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_INSERT_DATA_ERROR), |
| 56 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_INSERT_DATA_RESULT), |
| 57 | |
| 58 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_DELETE_DATA_REQUEST), |
| 59 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_DELETE_DATA_ERROR), |
| 60 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_DELETE_DATA_RESULT), |
| 61 | |
| 62 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_LOCATION_CANCEL_REQUEST), |
| 63 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_LOCATION_CANCEL_ERROR), |
| 64 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_LOCATION_CANCEL_RESULT), |
Vadim Yanitskiy | 36c7b33 | 2018-03-31 05:23:09 +0700 | [diff] [blame] | 65 | |
| 66 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_PROC_SS_REQUEST), |
| 67 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_PROC_SS_ERROR), |
| 68 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_PROC_SS_RESULT), |
| 69 | |
Vadim Yanitskiy | c262831 | 2018-09-25 23:03:13 +0700 | [diff] [blame] | 70 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_MO_FORWARD_SM_REQUEST), |
| 71 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_MO_FORWARD_SM_ERROR), |
| 72 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_MO_FORWARD_SM_RESULT), |
| 73 | |
| 74 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_MT_FORWARD_SM_REQUEST), |
| 75 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_MT_FORWARD_SM_ERROR), |
| 76 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_MT_FORWARD_SM_RESULT), |
| 77 | |
Vadim Yanitskiy | f9ee8da | 2018-11-13 02:06:15 +0700 | [diff] [blame] | 78 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_READY_FOR_SM_REQUEST), |
| 79 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_READY_FOR_SM_ERROR), |
| 80 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_READY_FOR_SM_RESULT), |
| 81 | |
Oliver Smith | 10db281 | 2018-12-14 16:14:34 +0100 | [diff] [blame] | 82 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_CHECK_IMEI_REQUEST), |
| 83 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_CHECK_IMEI_ERROR), |
| 84 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_CHECK_IMEI_RESULT), |
| 85 | |
Oliver Smith | affbb20 | 2019-02-01 11:35:10 +0100 | [diff] [blame] | 86 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_E_PREPARE_HANDOVER_REQUEST), |
| 87 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_E_PREPARE_HANDOVER_ERROR), |
| 88 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_E_PREPARE_HANDOVER_RESULT), |
| 89 | |
| 90 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_E_PREPARE_SUBSEQUENT_HANDOVER_REQUEST), |
| 91 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_E_PREPARE_SUBSEQUENT_HANDOVER_ERROR), |
| 92 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_E_PREPARE_SUBSEQUENT_HANDOVER_RESULT), |
| 93 | |
| 94 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_E_SEND_END_SIGNAL_REQUEST), |
| 95 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_E_SEND_END_SIGNAL_ERROR), |
| 96 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_E_SEND_END_SIGNAL_RESULT), |
| 97 | |
| 98 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_E_PROCESS_ACCESS_SIGNALLING_REQUEST), |
| 99 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_E_FORWARD_ACCESS_SIGNALLING_REQUEST), |
| 100 | |
| 101 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_E_CLOSE), |
| 102 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_E_ABORT), |
| 103 | |
Neels Hofmeyr | 249e005 | 2019-11-20 21:28:47 +0100 | [diff] [blame] | 104 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_ROUTING_ERROR), |
Oliver Smith | affbb20 | 2019-02-01 11:35:10 +0100 | [diff] [blame] | 105 | |
Alexander Couzens | 505f705 | 2023-03-07 16:01:52 +0100 | [diff] [blame] | 106 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_EPDG_TUNNEL_REQUEST), |
| 107 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_EPDG_TUNNEL_RESULT), |
| 108 | OSMO_VALUE_STRING(OSMO_GSUP_MSGT_EPDG_TUNNEL_ERROR), |
| 109 | |
Neels Hofmeyr | 10f5fb4 | 2017-02-09 02:09:09 +0100 | [diff] [blame] | 110 | { 0, NULL } |
| 111 | }; |
| 112 | |
Harald Welte | 6a6a609 | 2018-06-16 11:10:12 +0200 | [diff] [blame] | 113 | const struct value_string osmo_gsup_session_state_names[] = { |
| 114 | { OSMO_GSUP_SESSION_STATE_NONE, "NONE" }, |
| 115 | { OSMO_GSUP_SESSION_STATE_BEGIN, "BEGIN" }, |
| 116 | { OSMO_GSUP_SESSION_STATE_CONTINUE, "CONTINUE" }, |
| 117 | { OSMO_GSUP_SESSION_STATE_END, "END" }, |
| 118 | { 0, NULL } |
| 119 | }; |
| 120 | |
Harald Welte | 520ebc1 | 2018-06-11 20:27:27 +0200 | [diff] [blame] | 121 | |
Oliver Smith | d6ff9c8 | 2019-02-01 15:21:25 +0100 | [diff] [blame] | 122 | /*! return the error message type corresponding to \a type_in. |
| 123 | * Deprecated, use OSMO_GSUP_TO_MSGT_ERROR() instead. */ |
Harald Welte | 520ebc1 | 2018-06-11 20:27:27 +0200 | [diff] [blame] | 124 | int osmo_gsup_get_err_msg_type(enum osmo_gsup_message_type type_in) |
| 125 | { |
Oliver Smith | d6ff9c8 | 2019-02-01 15:21:25 +0100 | [diff] [blame] | 126 | return OSMO_GSUP_TO_MSGT_ERROR(type_in); |
Harald Welte | 520ebc1 | 2018-06-11 20:27:27 +0200 | [diff] [blame] | 127 | } |
| 128 | |
Pau Espin Pedrol | 74ee024 | 2024-01-19 18:28:09 +0100 | [diff] [blame] | 129 | static int decode_pdp_address(const uint8_t *data, size_t data_len, struct osmo_gsup_pdp_info *pdp_info) |
| 130 | { |
| 131 | const struct gsm48_pdp_address *pdp_addr = (const struct gsm48_pdp_address *)data; |
| 132 | /* Explicitly pre-nitialize them to AF_UNSPEC to signal they are empty: */ |
| 133 | pdp_info->pdp_address[0].u.sa.sa_family = AF_UNSPEC; |
| 134 | pdp_info->pdp_address[1].u.sa.sa_family = AF_UNSPEC; |
| 135 | |
| 136 | if (data_len < 2) |
| 137 | return -GMM_CAUSE_PROTO_ERR_UNSPEC; |
| 138 | |
| 139 | pdp_info->pdp_type_org = pdp_addr->organization; |
| 140 | pdp_info->pdp_type_nr = pdp_addr->type; |
| 141 | |
| 142 | if (pdp_info->pdp_type_org != PDP_TYPE_ORG_IETF) |
| 143 | return -GMM_CAUSE_PROTO_ERR_UNSPEC; |
| 144 | |
| 145 | /* Skip type-org + type-nr for easy calculations below: */ |
| 146 | data_len -= 2; |
| 147 | |
| 148 | switch (pdp_info->pdp_type_nr) { |
| 149 | case PDP_TYPE_N_IETF_IPv4: |
| 150 | if (data_len == 0) |
| 151 | return 0; /* empty, marked as AF_UNSET. */ |
| 152 | if (data_len != sizeof(pdp_addr->ietf.v4)) |
| 153 | return -GMM_CAUSE_PROTO_ERR_UNSPEC; |
| 154 | pdp_info->pdp_address[0].u.sa.sa_family = AF_INET; |
| 155 | pdp_info->pdp_address[0].u.sin.sin_addr.s_addr = pdp_addr->ietf.v4; |
| 156 | return 0; |
| 157 | case PDP_TYPE_N_IETF_IPv6: |
| 158 | if (data_len == 0) |
| 159 | return 0; /* empty, marked as AF_UNSET. */ |
| 160 | if (data_len != sizeof(pdp_addr->ietf.v6)) |
| 161 | return -GMM_CAUSE_PROTO_ERR_UNSPEC; |
| 162 | pdp_info->pdp_address[0].u.sa.sa_family = AF_INET6; |
| 163 | memcpy(&pdp_info->pdp_address[0].u.sin6.sin6_addr, |
| 164 | pdp_addr->ietf.v6, |
| 165 | sizeof(pdp_addr->ietf.v6)); |
| 166 | return 0; |
| 167 | case PDP_TYPE_N_IETF_IPv4v6: |
| 168 | if (data_len == 0) |
| 169 | return 0; /* empty, marked as AF_UNSET. */ |
| 170 | if (data_len != sizeof(pdp_addr->ietf.v4v6)) |
| 171 | return -GMM_CAUSE_PROTO_ERR_UNSPEC; |
| 172 | pdp_info->pdp_address[0].u.sa.sa_family = AF_INET; |
| 173 | pdp_info->pdp_address[0].u.sin.sin_addr.s_addr = pdp_addr->ietf.v4v6.v4; |
| 174 | pdp_info->pdp_address[1].u.sa.sa_family = AF_INET6; |
| 175 | memcpy(&pdp_info->pdp_address[1].u.sin6.sin6_addr, |
| 176 | pdp_addr->ietf.v4v6.v6, |
| 177 | sizeof(pdp_addr->ietf.v4v6.v6)); |
| 178 | return 0; |
| 179 | default: |
| 180 | /* reserved, both pdp_info->pdp_address are preinitialied to AF_UNSET. */ |
| 181 | return 0; |
| 182 | } |
| 183 | } |
| 184 | |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 185 | static int decode_pdp_info(uint8_t *data, size_t data_len, |
| 186 | struct osmo_gsup_pdp_info *pdp_info) |
| 187 | { |
| 188 | int rc; |
| 189 | uint8_t tag; |
| 190 | uint8_t *value; |
| 191 | size_t value_len; |
| 192 | |
| 193 | /* specific parts */ |
| 194 | while (data_len > 0) { |
| 195 | enum osmo_gsup_iei iei; |
| 196 | |
| 197 | rc = osmo_shift_tlv(&data, &data_len, &tag, &value, &value_len); |
| 198 | if (rc < 0) |
| 199 | return -GMM_CAUSE_PROTO_ERR_UNSPEC; |
| 200 | |
| 201 | iei = tag; |
| 202 | |
| 203 | switch (iei) { |
| 204 | case OSMO_GSUP_PDP_CONTEXT_ID_IE: |
| 205 | pdp_info->context_id = osmo_decode_big_endian(value, value_len); |
| 206 | break; |
| 207 | |
Pau Espin Pedrol | 74ee024 | 2024-01-19 18:28:09 +0100 | [diff] [blame] | 208 | case OSMO_GSUP_PDP_ADDRESS_IE: |
| 209 | if ((rc = decode_pdp_address(value, value_len, pdp_info)) < 0) |
| 210 | return rc; |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 211 | break; |
| 212 | |
| 213 | case OSMO_GSUP_ACCESS_POINT_NAME_IE: |
| 214 | pdp_info->apn_enc = value; |
| 215 | pdp_info->apn_enc_len = value_len; |
| 216 | break; |
| 217 | |
| 218 | case OSMO_GSUP_PDP_QOS_IE: |
| 219 | pdp_info->qos_enc = value; |
| 220 | pdp_info->qos_enc_len = value_len; |
| 221 | break; |
| 222 | |
Holger Hans Peter Freyther | eb55c0d | 2017-07-07 16:53:30 +0200 | [diff] [blame] | 223 | case OSMO_GSUP_CHARG_CHAR_IE: |
| 224 | pdp_info->pdp_charg_enc = value; |
| 225 | pdp_info->pdp_charg_enc_len = value_len; |
| 226 | break; |
| 227 | |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 228 | default: |
| 229 | LOGP(DLGSUP, LOGL_ERROR, |
| 230 | "GSUP IE type %d not expected in PDP info\n", iei); |
| 231 | continue; |
| 232 | } |
| 233 | } |
| 234 | |
| 235 | return 0; |
| 236 | } |
| 237 | |
| 238 | static int decode_auth_info(uint8_t *data, size_t data_len, |
| 239 | struct osmo_auth_vector *auth_vector) |
| 240 | { |
| 241 | int rc; |
| 242 | uint8_t tag; |
| 243 | uint8_t *value; |
| 244 | size_t value_len; |
| 245 | enum osmo_gsup_iei iei; |
| 246 | uint8_t presence = 0; |
| 247 | |
| 248 | /* specific parts */ |
| 249 | while (data_len > 0) { |
| 250 | rc = osmo_shift_tlv(&data, &data_len, &tag, &value, &value_len); |
| 251 | if (rc < 0) |
| 252 | return -GMM_CAUSE_PROTO_ERR_UNSPEC; |
| 253 | |
| 254 | iei = tag; |
| 255 | |
| 256 | switch (iei) { |
| 257 | case OSMO_GSUP_RAND_IE: |
| 258 | if (value_len != sizeof(auth_vector->rand)) |
| 259 | goto parse_error; |
| 260 | |
| 261 | memcpy(auth_vector->rand, value, value_len); |
| 262 | presence |= (1 << 0); |
| 263 | break; |
| 264 | |
| 265 | case OSMO_GSUP_SRES_IE: |
| 266 | if (value_len != sizeof(auth_vector->sres)) |
| 267 | goto parse_error; |
| 268 | |
| 269 | memcpy(auth_vector->sres, value, value_len); |
| 270 | presence |= (1 << 1); |
| 271 | break; |
| 272 | |
| 273 | case OSMO_GSUP_KC_IE: |
| 274 | if (value_len != sizeof(auth_vector->kc)) |
| 275 | goto parse_error; |
| 276 | |
| 277 | memcpy(auth_vector->kc, value, value_len); |
| 278 | presence |= (1 << 2); |
| 279 | break; |
| 280 | |
| 281 | case OSMO_GSUP_IK_IE: |
| 282 | if (value_len != sizeof(auth_vector->ik)) |
| 283 | goto parse_error; |
| 284 | memcpy(auth_vector->ik, value, value_len); |
| 285 | presence |= (1 << 4); |
| 286 | break; |
| 287 | |
| 288 | case OSMO_GSUP_CK_IE: |
| 289 | if (value_len != sizeof(auth_vector->ck)) |
| 290 | goto parse_error; |
| 291 | memcpy(auth_vector->ck, value, value_len); |
| 292 | presence |= (1 << 5); |
| 293 | break; |
| 294 | |
| 295 | case OSMO_GSUP_AUTN_IE: |
| 296 | if (value_len != sizeof(auth_vector->autn)) |
| 297 | goto parse_error; |
| 298 | memcpy(auth_vector->autn, value, value_len); |
| 299 | presence |= (1 << 6); |
| 300 | break; |
| 301 | case OSMO_GSUP_RES_IE: |
| 302 | if (value_len > sizeof(auth_vector->res)) |
| 303 | goto parse_error; |
| 304 | memcpy(auth_vector->res, value, value_len); |
| 305 | auth_vector->res_len = value_len; |
| 306 | presence |= (1 << 7); |
| 307 | break; |
| 308 | |
| 309 | default: |
| 310 | LOGP(DLGSUP, LOGL_ERROR, |
| 311 | "GSUP IE type %d not expected in PDP info\n", iei); |
| 312 | continue; |
| 313 | } |
| 314 | } |
| 315 | |
| 316 | if (presence & 0x07) |
| 317 | auth_vector->auth_types |= OSMO_AUTH_TYPE_GSM; |
| 318 | if (presence & 0xf0) |
| 319 | auth_vector->auth_types |= OSMO_AUTH_TYPE_UMTS; |
| 320 | |
| 321 | return 0; |
| 322 | |
| 323 | parse_error: |
| 324 | LOGP(DLGSUP, LOGL_ERROR, |
Alexander Couzens | 75cc246 | 2023-12-05 18:36:25 +0000 | [diff] [blame] | 325 | "GSUP IE type %d, length %zu invalid in auth info\n", iei, value_len); |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 326 | |
| 327 | return -1; |
| 328 | } |
| 329 | |
Oliver Smith | affbb20 | 2019-02-01 11:35:10 +0100 | [diff] [blame] | 330 | /*! Decode AN-apdu (see 3GPP TS 29.002 7.6.9.1). |
| 331 | * \param[out] gsup_msg abstract GSUP message structure |
| 332 | * \param[in] data pointer to the raw IE payload |
| 333 | * \param[in] data_len length of IE pointed by \ref data |
| 334 | * \returns 0 in case of success, negative in case of error |
| 335 | */ |
| 336 | int osmo_gsup_decode_an_apdu(struct osmo_gsup_message *gsup_msg, const uint8_t *data, size_t data_len) |
| 337 | { |
| 338 | if (data_len < 1) { |
| 339 | LOGP(DLGSUP, LOGL_ERROR, "Corrupted an_apdu message (length must be >= 1)\n"); |
| 340 | return -EINVAL; |
| 341 | } |
| 342 | |
| 343 | gsup_msg->an_apdu.access_network_proto = data[0]; |
| 344 | gsup_msg->an_apdu.data_len = data_len -1; |
| 345 | gsup_msg->an_apdu.data = data + 1; |
| 346 | |
| 347 | return 0; |
| 348 | } |
| 349 | |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 350 | /*! Decode (parse) a GSUP message |
| 351 | * \param[in] const_data input data to be parsed |
| 352 | * \param[in] data_len length of input (\a const_data) |
| 353 | * \param[out] gsup_msg callee-allocated output data structure |
| 354 | * \returns 0 on success; negative otherwise |
| 355 | */ |
| 356 | int osmo_gsup_decode(const uint8_t *const_data, size_t data_len, |
| 357 | struct osmo_gsup_message *gsup_msg) |
| 358 | { |
| 359 | int rc; |
Neels Hofmeyr | 1b729ce | 2018-12-26 18:13:38 +0100 | [diff] [blame] | 360 | int i; |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 361 | uint8_t tag; |
| 362 | /* the shift/match functions expect non-const pointers, but we'll |
| 363 | * either copy the data or cast pointers back to const before returning |
| 364 | * them |
| 365 | */ |
| 366 | uint8_t *data = (uint8_t *)const_data; |
| 367 | uint8_t *value; |
| 368 | size_t value_len; |
| 369 | static const struct osmo_gsup_pdp_info empty_pdp_info = {0}; |
Neels Hofmeyr | 505adee | 2016-07-13 16:55:43 +0200 | [diff] [blame] | 370 | static const struct osmo_auth_vector empty_auth_info = {{0}}; |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 371 | static const struct osmo_gsup_message empty_gsup_message = {0}; |
| 372 | |
| 373 | *gsup_msg = empty_gsup_message; |
| 374 | |
| 375 | /* generic part */ |
| 376 | rc = osmo_shift_v_fixed(&data, &data_len, 1, &value); |
| 377 | if (rc < 0) |
| 378 | return -GMM_CAUSE_INV_MAND_INFO; |
| 379 | |
| 380 | gsup_msg->message_type = osmo_decode_big_endian(value, 1); |
| 381 | |
| 382 | rc = osmo_match_shift_tlv(&data, &data_len, OSMO_GSUP_IMSI_IE, |
| 383 | &value, &value_len); |
| 384 | |
| 385 | if (rc <= 0) |
| 386 | return -GMM_CAUSE_INV_MAND_INFO; |
| 387 | |
| 388 | if (value_len * 2 + 1 > sizeof(gsup_msg->imsi)) |
| 389 | return -GMM_CAUSE_INV_MAND_INFO; |
| 390 | |
| 391 | /* Note that gsm48_decode_bcd_number expects the number of encoded IMSI |
| 392 | * octets in the first octet. By coincidence (the TLV encoding) the byte |
| 393 | * before the value part already contains this length so we can use it |
| 394 | * here. |
| 395 | */ |
Neels Hofmeyr | cc26a8b | 2019-04-30 02:43:00 +0200 | [diff] [blame] | 396 | if (gsm48_decode_bcd_number2(gsup_msg->imsi, sizeof(gsup_msg->imsi), |
| 397 | value - 1, value_len + 1, 0)) { |
| 398 | LOGP(DLGSUP, LOGL_ERROR, "Cannot decode IMSI\n"); |
| 399 | return -GMM_CAUSE_INV_MAND_INFO; |
| 400 | } |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 401 | |
| 402 | /* specific parts */ |
| 403 | while (data_len > 0) { |
| 404 | enum osmo_gsup_iei iei; |
| 405 | struct osmo_gsup_pdp_info pdp_info; |
| 406 | struct osmo_auth_vector auth_info; |
| 407 | |
| 408 | rc = osmo_shift_tlv(&data, &data_len, &tag, &value, &value_len); |
| 409 | if (rc < 0) |
| 410 | return -GMM_CAUSE_PROTO_ERR_UNSPEC; |
| 411 | |
| 412 | iei = tag; |
| 413 | |
| 414 | switch (iei) { |
| 415 | case OSMO_GSUP_IMSI_IE: |
Pau Espin Pedrol | 74ee024 | 2024-01-19 18:28:09 +0100 | [diff] [blame] | 416 | case OSMO_GSUP_PDP_ADDRESS_IE: |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 417 | case OSMO_GSUP_ACCESS_POINT_NAME_IE: |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 418 | case OSMO_GSUP_SRES_IE: |
| 419 | case OSMO_GSUP_KC_IE: |
| 420 | LOGP(DLGSUP, LOGL_NOTICE, |
| 421 | "GSUP IE type %d not expected (ignored)\n", iei); |
| 422 | continue; |
| 423 | |
| 424 | case OSMO_GSUP_CAUSE_IE: |
| 425 | gsup_msg->cause = osmo_decode_big_endian(value, value_len); |
| 426 | break; |
| 427 | |
| 428 | case OSMO_GSUP_CANCEL_TYPE_IE: |
| 429 | gsup_msg->cancel_type = |
| 430 | osmo_decode_big_endian(value, value_len) + 1; |
| 431 | break; |
| 432 | |
| 433 | case OSMO_GSUP_PDP_INFO_COMPL_IE: |
| 434 | gsup_msg->pdp_info_compl = 1; |
| 435 | break; |
| 436 | |
| 437 | case OSMO_GSUP_FREEZE_PTMSI_IE: |
| 438 | gsup_msg->freeze_ptmsi = 1; |
| 439 | break; |
| 440 | |
| 441 | case OSMO_GSUP_PDP_CONTEXT_ID_IE: |
| 442 | /* When these IE appear in the top-level part of the |
| 443 | * message, they are used by Delete Subscr Info to delete |
| 444 | * single entries. We don't have an extra list for |
| 445 | * these but use the PDP info list instead */ |
| 446 | |
| 447 | /* fall through */ |
| 448 | |
| 449 | case OSMO_GSUP_PDP_INFO_IE: |
| 450 | if (gsup_msg->num_pdp_infos >= OSMO_GSUP_MAX_NUM_PDP_INFO) { |
| 451 | LOGP(DLGSUP, LOGL_ERROR, |
| 452 | "GSUP IE type %d (PDP_INFO) max exceeded\n", |
| 453 | iei); |
| 454 | return -GMM_CAUSE_COND_IE_ERR; |
| 455 | } |
| 456 | |
| 457 | pdp_info = empty_pdp_info; |
| 458 | |
| 459 | if (iei == OSMO_GSUP_PDP_INFO_IE) { |
| 460 | rc = decode_pdp_info(value, value_len, &pdp_info); |
| 461 | if (rc < 0) |
| 462 | return rc; |
| 463 | pdp_info.have_info = 1; |
| 464 | } else { |
| 465 | pdp_info.context_id = |
| 466 | osmo_decode_big_endian(value, value_len); |
| 467 | } |
| 468 | |
| 469 | gsup_msg->pdp_infos[gsup_msg->num_pdp_infos++] = |
| 470 | pdp_info; |
| 471 | break; |
| 472 | |
| 473 | case OSMO_GSUP_AUTH_TUPLE_IE: |
| 474 | if (gsup_msg->num_auth_vectors >= OSMO_GSUP_MAX_NUM_AUTH_INFO) { |
| 475 | LOGP(DLGSUP, LOGL_ERROR, |
| 476 | "GSUP IE type %d (AUTH_INFO) max exceeded\n", |
| 477 | iei); |
| 478 | return -GMM_CAUSE_INV_MAND_INFO; |
| 479 | } |
| 480 | |
| 481 | auth_info = empty_auth_info; |
| 482 | |
| 483 | rc = decode_auth_info(value, value_len, &auth_info); |
| 484 | if (rc < 0) |
| 485 | return rc; |
| 486 | |
| 487 | gsup_msg->auth_vectors[gsup_msg->num_auth_vectors++] = |
| 488 | auth_info; |
| 489 | break; |
| 490 | |
| 491 | case OSMO_GSUP_AUTS_IE: |
Neels Hofmeyr | 3a5ca64 | 2017-02-21 15:53:20 +0100 | [diff] [blame] | 492 | if (value_len != 14) { |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 493 | LOGP(DLGSUP, LOGL_ERROR, |
Neels Hofmeyr | 3a5ca64 | 2017-02-21 15:53:20 +0100 | [diff] [blame] | 494 | "AUTS length != 14 received\n"); |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 495 | return -GMM_CAUSE_COND_IE_ERR; |
| 496 | } |
| 497 | gsup_msg->auts = value; |
| 498 | break; |
| 499 | |
Harald Welte | 766da86 | 2016-05-06 11:18:15 +0200 | [diff] [blame] | 500 | case OSMO_GSUP_RAND_IE: |
| 501 | if (value_len != 16) { |
| 502 | LOGP(DLGSUP, LOGL_ERROR, |
| 503 | "RAND length != 16 received\n"); |
| 504 | return -GMM_CAUSE_COND_IE_ERR; |
| 505 | } |
| 506 | gsup_msg->rand = value; |
| 507 | break; |
| 508 | |
Alexander Couzens | 3938dfb | 2024-02-22 16:28:09 +0100 | [diff] [blame] | 509 | case OSMO_GSUP_PCO_IE: |
| 510 | gsup_msg->pco = value; |
| 511 | gsup_msg->pco_len = value_len; |
| 512 | break; |
| 513 | |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 514 | case OSMO_GSUP_MSISDN_IE: |
| 515 | gsup_msg->msisdn_enc = value; |
| 516 | gsup_msg->msisdn_enc_len = value_len; |
| 517 | break; |
| 518 | |
| 519 | case OSMO_GSUP_HLR_NUMBER_IE: |
| 520 | gsup_msg->hlr_enc = value; |
| 521 | gsup_msg->hlr_enc_len = value_len; |
| 522 | break; |
| 523 | |
Harald Welte | 48dc1a5 | 2016-05-05 18:46:42 +0200 | [diff] [blame] | 524 | case OSMO_GSUP_CN_DOMAIN_IE: |
| 525 | gsup_msg->cn_domain = *value; |
| 526 | break; |
| 527 | |
Neels Hofmeyr | 1b729ce | 2018-12-26 18:13:38 +0100 | [diff] [blame] | 528 | case OSMO_GSUP_SUPPORTED_RAT_TYPES_IE: |
| 529 | if (value_len > ARRAY_SIZE(gsup_msg->supported_rat_types)) { |
| 530 | LOGP(DLGSUP, LOGL_ERROR, "nr of supported RAT types %zu > %zu\n", |
| 531 | value_len, ARRAY_SIZE(gsup_msg->supported_rat_types)); |
| 532 | return -GMM_CAUSE_COND_IE_ERR; |
| 533 | } |
| 534 | for (i = 0; i < value_len; i++) |
| 535 | gsup_msg->supported_rat_types[i] = value[i]; |
| 536 | gsup_msg->supported_rat_types_len = value_len; |
| 537 | break; |
| 538 | |
| 539 | case OSMO_GSUP_CURRENT_RAT_TYPE_IE: |
| 540 | gsup_msg->current_rat_type = *value; |
| 541 | break; |
| 542 | |
Holger Hans Peter Freyther | eb55c0d | 2017-07-07 16:53:30 +0200 | [diff] [blame] | 543 | case OSMO_GSUP_CHARG_CHAR_IE: |
| 544 | gsup_msg->pdp_charg_enc = value; |
| 545 | gsup_msg->pdp_charg_enc_len = value_len; |
| 546 | break; |
| 547 | |
Vadim Yanitskiy | 7269604 | 2018-04-07 02:34:55 +0700 | [diff] [blame] | 548 | case OSMO_GSUP_SESSION_ID_IE: |
| 549 | gsup_msg->session_id = osmo_decode_big_endian(value, value_len); |
| 550 | break; |
| 551 | |
| 552 | case OSMO_GSUP_SESSION_STATE_IE: |
| 553 | gsup_msg->session_state = *value; |
| 554 | break; |
| 555 | |
Vadim Yanitskiy | 36c7b33 | 2018-03-31 05:23:09 +0700 | [diff] [blame] | 556 | case OSMO_GSUP_SS_INFO_IE: |
| 557 | gsup_msg->ss_info = value; |
| 558 | gsup_msg->ss_info_len = value_len; |
| 559 | break; |
| 560 | |
Vadim Yanitskiy | c262831 | 2018-09-25 23:03:13 +0700 | [diff] [blame] | 561 | case OSMO_GSUP_SM_RP_MR_IE: |
| 562 | gsup_msg->sm_rp_mr = value; |
| 563 | break; |
| 564 | |
| 565 | case OSMO_GSUP_SM_RP_DA_IE: |
| 566 | rc = osmo_gsup_sms_decode_sm_rp_da(gsup_msg, value, value_len); |
| 567 | if (rc) |
| 568 | return rc; |
| 569 | break; |
| 570 | |
| 571 | case OSMO_GSUP_SM_RP_OA_IE: |
| 572 | rc = osmo_gsup_sms_decode_sm_rp_oa(gsup_msg, value, value_len); |
| 573 | if (rc) |
| 574 | return rc; |
| 575 | break; |
| 576 | |
| 577 | case OSMO_GSUP_SM_RP_UI_IE: |
| 578 | gsup_msg->sm_rp_ui = value; |
| 579 | gsup_msg->sm_rp_ui_len = value_len; |
| 580 | break; |
| 581 | |
| 582 | case OSMO_GSUP_SM_RP_MMS_IE: |
| 583 | gsup_msg->sm_rp_mms = value; |
| 584 | break; |
| 585 | |
| 586 | case OSMO_GSUP_SM_RP_CAUSE_IE: |
| 587 | gsup_msg->sm_rp_cause = value; |
| 588 | break; |
| 589 | |
Vadim Yanitskiy | f9ee8da | 2018-11-13 02:06:15 +0700 | [diff] [blame] | 590 | case OSMO_GSUP_SM_ALERT_RSN_IE: |
| 591 | gsup_msg->sm_alert_rsn = *value; |
| 592 | break; |
| 593 | |
Oliver Smith | 10db281 | 2018-12-14 16:14:34 +0100 | [diff] [blame] | 594 | case OSMO_GSUP_IMEI_IE: |
| 595 | gsup_msg->imei_enc = value; |
| 596 | gsup_msg->imei_enc_len = value_len; |
| 597 | break; |
| 598 | |
| 599 | case OSMO_GSUP_IMEI_RESULT_IE: |
| 600 | gsup_msg->imei_result = osmo_decode_big_endian(value, value_len) + 1; |
| 601 | break; |
| 602 | |
Neels Hofmeyr | 9838c90 | 2019-04-01 22:24:33 +0200 | [diff] [blame] | 603 | case OSMO_GSUP_MESSAGE_CLASS_IE: |
| 604 | gsup_msg->message_class = value[0]; |
| 605 | break; |
| 606 | |
Oliver Smith | affbb20 | 2019-02-01 11:35:10 +0100 | [diff] [blame] | 607 | case OSMO_GSUP_SOURCE_NAME_IE: |
| 608 | gsup_msg->source_name = value; |
| 609 | gsup_msg->source_name_len = value_len; |
| 610 | break; |
| 611 | |
| 612 | case OSMO_GSUP_DESTINATION_NAME_IE: |
| 613 | gsup_msg->destination_name = value; |
| 614 | gsup_msg->destination_name_len = value_len; |
| 615 | break; |
| 616 | |
| 617 | case OSMO_GSUP_AN_APDU_IE: |
| 618 | rc = osmo_gsup_decode_an_apdu(gsup_msg, value, value_len); |
| 619 | if (rc) |
| 620 | return rc; |
| 621 | break; |
| 622 | |
| 623 | case OSMO_GSUP_CAUSE_RR_IE: |
| 624 | gsup_msg->cause_rr = value[0]; |
| 625 | gsup_msg->cause_rr_set = true; |
| 626 | break; |
| 627 | |
| 628 | case OSMO_GSUP_CAUSE_BSSAP_IE: |
| 629 | gsup_msg->cause_bssap = value[0]; |
| 630 | gsup_msg->cause_bssap_set = true; |
| 631 | break; |
| 632 | |
| 633 | case OSMO_GSUP_CAUSE_SM_IE: |
| 634 | gsup_msg->cause_sm = value[0]; |
| 635 | break; |
| 636 | |
Harald Welte | 49ddef6 | 2019-08-16 12:22:29 +0200 | [diff] [blame] | 637 | case OSMO_GSUP_NUM_VECTORS_REQ_IE: |
| 638 | if (gsup_msg->message_type == OSMO_GSUP_MSGT_SEND_AUTH_INFO_REQUEST) |
| 639 | gsup_msg->num_auth_vectors = value[0]; |
| 640 | break; |
| 641 | |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 642 | default: |
| 643 | LOGP(DLGSUP, LOGL_NOTICE, |
| 644 | "GSUP IE type %d unknown\n", iei); |
| 645 | continue; |
| 646 | } |
| 647 | } |
| 648 | |
| 649 | return 0; |
| 650 | } |
| 651 | |
| 652 | static void encode_pdp_info(struct msgb *msg, enum osmo_gsup_iei iei, |
| 653 | const struct osmo_gsup_pdp_info *pdp_info) |
| 654 | { |
| 655 | uint8_t *len_field; |
| 656 | size_t old_len; |
| 657 | uint8_t u8; |
| 658 | |
| 659 | len_field = msgb_tlv_put(msg, iei, 0, NULL) - 1; |
| 660 | old_len = msgb_length(msg); |
| 661 | |
| 662 | u8 = pdp_info->context_id; |
| 663 | msgb_tlv_put(msg, OSMO_GSUP_PDP_CONTEXT_ID_IE, sizeof(u8), &u8); |
| 664 | |
Pau Espin Pedrol | 68a04df | 2024-01-19 18:03:59 +0100 | [diff] [blame] | 665 | if (pdp_info->pdp_type_org == PDP_TYPE_ORG_IETF) { |
| 666 | struct gsm48_pdp_address pdp_addr; |
Pau Espin Pedrol | 74ee024 | 2024-01-19 18:28:09 +0100 | [diff] [blame] | 667 | uint8_t pdp_addr_len = 2; |
Pau Espin Pedrol | 68a04df | 2024-01-19 18:03:59 +0100 | [diff] [blame] | 668 | pdp_addr.spare = 0x0f; |
| 669 | pdp_addr.organization = pdp_info->pdp_type_org; |
| 670 | pdp_addr.type = pdp_info->pdp_type_nr; |
| 671 | |
Pau Espin Pedrol | 74ee024 | 2024-01-19 18:28:09 +0100 | [diff] [blame] | 672 | switch (pdp_info->pdp_type_nr) { |
| 673 | case PDP_TYPE_N_IETF_IPv4: |
| 674 | if (pdp_info->pdp_address[0].u.sa.sa_family == AF_INET) { |
| 675 | pdp_addr.ietf.v4 = pdp_info->pdp_address[0].u.sin.sin_addr.s_addr; |
| 676 | pdp_addr_len += sizeof(pdp_addr.ietf.v4); |
| 677 | } |
| 678 | break; |
| 679 | case PDP_TYPE_N_IETF_IPv6: |
| 680 | if (pdp_info->pdp_address[0].u.sa.sa_family == AF_INET6) { |
| 681 | memcpy(pdp_addr.ietf.v6, |
| 682 | &pdp_info->pdp_address[0].u.sin6.sin6_addr, |
| 683 | sizeof(pdp_addr.ietf.v6)); |
| 684 | pdp_addr_len += sizeof(pdp_addr.ietf.v6); |
| 685 | } |
| 686 | break; |
| 687 | case PDP_TYPE_N_IETF_IPv4v6: |
| 688 | if (pdp_info->pdp_address[0].u.sa.sa_family == AF_INET) { |
| 689 | pdp_addr.ietf.v4v6.v4 = pdp_info->pdp_address[0].u.sin.sin_addr.s_addr; |
| 690 | pdp_addr_len += sizeof(pdp_addr.ietf.v4v6.v4); |
| 691 | } |
| 692 | if (pdp_info->pdp_address[0].u.sa.sa_family == AF_INET6) { |
| 693 | memcpy(pdp_addr.ietf.v4v6.v6, |
| 694 | &pdp_info->pdp_address[1].u.sin6.sin6_addr, |
| 695 | sizeof(pdp_addr.ietf.v4v6.v6)); |
| 696 | pdp_addr_len += sizeof(pdp_addr.ietf.v4v6.v6); |
| 697 | } |
| 698 | break; |
| 699 | } |
| 700 | |
| 701 | msgb_tlv_put(msg, OSMO_GSUP_PDP_ADDRESS_IE, |
| 702 | pdp_addr_len, |
Pau Espin Pedrol | 68a04df | 2024-01-19 18:03:59 +0100 | [diff] [blame] | 703 | (const uint8_t *)&pdp_addr); |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 704 | } |
| 705 | |
| 706 | if (pdp_info->apn_enc) { |
| 707 | msgb_tlv_put(msg, OSMO_GSUP_ACCESS_POINT_NAME_IE, |
| 708 | pdp_info->apn_enc_len, pdp_info->apn_enc); |
| 709 | } |
| 710 | |
| 711 | if (pdp_info->qos_enc) { |
| 712 | msgb_tlv_put(msg, OSMO_GSUP_PDP_QOS_IE, |
| 713 | pdp_info->qos_enc_len, pdp_info->qos_enc); |
| 714 | } |
| 715 | |
Holger Hans Peter Freyther | eb55c0d | 2017-07-07 16:53:30 +0200 | [diff] [blame] | 716 | if (pdp_info->pdp_charg_enc) { |
| 717 | msgb_tlv_put(msg, OSMO_GSUP_CHARG_CHAR_IE, |
| 718 | pdp_info->pdp_charg_enc_len, pdp_info->pdp_charg_enc); |
| 719 | } |
| 720 | |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 721 | /* Update length field */ |
| 722 | *len_field = msgb_length(msg) - old_len; |
| 723 | } |
| 724 | |
| 725 | static void encode_auth_info(struct msgb *msg, enum osmo_gsup_iei iei, |
| 726 | const struct osmo_auth_vector *auth_vector) |
| 727 | { |
| 728 | uint8_t *len_field; |
| 729 | size_t old_len; |
| 730 | |
| 731 | len_field = msgb_tlv_put(msg, iei, 0, NULL) - 1; |
| 732 | old_len = msgb_length(msg); |
| 733 | |
Harald Welte | db78d21 | 2016-06-06 13:47:07 +0200 | [diff] [blame] | 734 | if (auth_vector->auth_types & OSMO_AUTH_TYPE_GSM) { |
| 735 | msgb_tlv_put(msg, OSMO_GSUP_RAND_IE, |
| 736 | sizeof(auth_vector->rand), auth_vector->rand); |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 737 | |
Harald Welte | db78d21 | 2016-06-06 13:47:07 +0200 | [diff] [blame] | 738 | msgb_tlv_put(msg, OSMO_GSUP_SRES_IE, |
| 739 | sizeof(auth_vector->sres), auth_vector->sres); |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 740 | |
Harald Welte | db78d21 | 2016-06-06 13:47:07 +0200 | [diff] [blame] | 741 | msgb_tlv_put(msg, OSMO_GSUP_KC_IE, |
| 742 | sizeof(auth_vector->kc), auth_vector->kc); |
| 743 | } |
| 744 | |
| 745 | if (auth_vector->auth_types & OSMO_AUTH_TYPE_UMTS) { |
| 746 | msgb_tlv_put(msg, OSMO_GSUP_IK_IE, |
| 747 | sizeof(auth_vector->ik), auth_vector->ik); |
| 748 | |
| 749 | msgb_tlv_put(msg, OSMO_GSUP_CK_IE, |
| 750 | sizeof(auth_vector->ck), auth_vector->ck); |
| 751 | |
| 752 | msgb_tlv_put(msg, OSMO_GSUP_AUTN_IE, |
| 753 | sizeof(auth_vector->autn), auth_vector->autn); |
| 754 | |
| 755 | msgb_tlv_put(msg, OSMO_GSUP_RES_IE, |
| 756 | auth_vector->res_len, auth_vector->res); |
| 757 | } |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 758 | |
| 759 | /* Update length field */ |
| 760 | *len_field = msgb_length(msg) - old_len; |
| 761 | } |
| 762 | |
Oliver Smith | affbb20 | 2019-02-01 11:35:10 +0100 | [diff] [blame] | 763 | /*! Encode AN-apdu (see 3GPP TS 29.002 7.6.9.1). |
| 764 | * \param[out] msg target message buffer (caller-allocated) |
| 765 | * \param[in] gsup_msg abstract GSUP message structure |
| 766 | * \returns 0 in case of success, negative in case of error |
| 767 | */ |
| 768 | int osmo_gsup_encode_an_apdu(struct msgb *msg, const struct osmo_gsup_message *gsup_msg) |
| 769 | { |
| 770 | const struct osmo_gsup_an_apdu an_apdu = gsup_msg->an_apdu; |
| 771 | |
| 772 | if (msgb_tailroom(msg) < 2 + an_apdu.data_len) { |
| 773 | LOGP(DLGSUP, LOGL_ERROR, "Not enough tailroom in msg to encode an_apdu:" |
| 774 | " IE header (2) + an_apdu.data_len (%zu) == %zu, msgb tailroom == %d\n", |
| 775 | an_apdu.data_len, an_apdu.data_len + 2, msgb_tailroom(msg)); |
| 776 | return -ENOMEM; |
| 777 | } |
| 778 | |
| 779 | /* Tag and total length */ |
| 780 | msgb_tv_put(msg, OSMO_GSUP_AN_APDU_IE, 1 + an_apdu.data_len); |
| 781 | |
| 782 | /* Put access_network_proto */ |
| 783 | msgb_v_put(msg, an_apdu.access_network_proto); |
| 784 | |
| 785 | /* Put data */ |
| 786 | uint8_t *buf = msgb_put(msg, an_apdu.data_len); |
| 787 | memcpy(buf, an_apdu.data, an_apdu.data_len); |
| 788 | |
| 789 | return 0; |
| 790 | } |
| 791 | |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 792 | /*! Encode a GSUP message |
| 793 | * \param[out] msg message buffer to which encoded message is written |
| 794 | * \param[in] gsup_msg \ref osmo_gsup_message data to be encoded |
Max | 80f4c4e | 2018-01-24 12:33:05 +0100 | [diff] [blame] | 795 | * \returns 0 on success; negative otherwise |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 796 | */ |
Max | 80f4c4e | 2018-01-24 12:33:05 +0100 | [diff] [blame] | 797 | int osmo_gsup_encode(struct msgb *msg, const struct osmo_gsup_message *gsup_msg) |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 798 | { |
| 799 | uint8_t u8; |
Vadim Yanitskiy | c262831 | 2018-09-25 23:03:13 +0700 | [diff] [blame] | 800 | int idx, rc; |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 801 | uint8_t bcd_buf[GSM48_MI_SIZE] = {0}; |
| 802 | size_t bcd_len; |
| 803 | |
| 804 | /* generic part */ |
Max | 80f4c4e | 2018-01-24 12:33:05 +0100 | [diff] [blame] | 805 | if(!gsup_msg->message_type) |
Vadim Yanitskiy | ee86b04 | 2018-09-25 18:09:01 +0700 | [diff] [blame] | 806 | return -EINVAL; |
Max | 80f4c4e | 2018-01-24 12:33:05 +0100 | [diff] [blame] | 807 | |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 808 | msgb_v_put(msg, gsup_msg->message_type); |
| 809 | |
| 810 | bcd_len = gsm48_encode_bcd_number(bcd_buf, sizeof(bcd_buf), 0, |
| 811 | gsup_msg->imsi); |
| 812 | |
Max | 80f4c4e | 2018-01-24 12:33:05 +0100 | [diff] [blame] | 813 | if (bcd_len <= 0 || bcd_len > sizeof(bcd_buf)) |
| 814 | return -EINVAL; |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 815 | |
| 816 | /* Note that gsm48_encode_bcd_number puts the length into the first |
| 817 | * octet. Since msgb_tlv_put will add this length byte, we'll have to |
| 818 | * skip it */ |
| 819 | msgb_tlv_put(msg, OSMO_GSUP_IMSI_IE, bcd_len - 1, &bcd_buf[1]); |
| 820 | |
| 821 | /* specific parts */ |
| 822 | if (gsup_msg->msisdn_enc) |
| 823 | msgb_tlv_put(msg, OSMO_GSUP_MSISDN_IE, |
| 824 | gsup_msg->msisdn_enc_len, gsup_msg->msisdn_enc); |
| 825 | if (gsup_msg->hlr_enc) |
| 826 | msgb_tlv_put(msg, OSMO_GSUP_HLR_NUMBER_IE, |
| 827 | gsup_msg->hlr_enc_len, gsup_msg->hlr_enc); |
| 828 | |
| 829 | if ((u8 = gsup_msg->cause)) |
| 830 | msgb_tlv_put(msg, OSMO_GSUP_CAUSE_IE, sizeof(u8), &u8); |
| 831 | |
| 832 | if ((u8 = gsup_msg->cancel_type)) { |
| 833 | u8 -= 1; |
| 834 | msgb_tlv_put(msg, OSMO_GSUP_CANCEL_TYPE_IE, sizeof(u8), &u8); |
| 835 | } |
| 836 | |
| 837 | if (gsup_msg->pdp_info_compl) |
| 838 | msgb_tlv_put(msg, OSMO_GSUP_PDP_INFO_COMPL_IE, 0, &u8); |
| 839 | |
| 840 | if (gsup_msg->freeze_ptmsi) |
| 841 | msgb_tlv_put(msg, OSMO_GSUP_FREEZE_PTMSI_IE, 0, &u8); |
| 842 | |
| 843 | for (idx = 0; idx < gsup_msg->num_pdp_infos; idx++) { |
| 844 | const struct osmo_gsup_pdp_info *pdp_info; |
| 845 | |
| 846 | pdp_info = &gsup_msg->pdp_infos[idx]; |
| 847 | |
| 848 | if (pdp_info->context_id == 0) |
| 849 | continue; |
| 850 | |
| 851 | if (pdp_info->have_info) { |
| 852 | encode_pdp_info(msg, OSMO_GSUP_PDP_INFO_IE, pdp_info); |
| 853 | } else { |
| 854 | u8 = pdp_info->context_id; |
| 855 | msgb_tlv_put(msg, OSMO_GSUP_PDP_CONTEXT_ID_IE, |
| 856 | sizeof(u8), &u8); |
| 857 | } |
| 858 | } |
| 859 | |
Harald Welte | 49ddef6 | 2019-08-16 12:22:29 +0200 | [diff] [blame] | 860 | if (gsup_msg->message_type == OSMO_GSUP_MSGT_SEND_AUTH_INFO_REQUEST) { |
| 861 | uint8_t num = gsup_msg->num_auth_vectors; |
| 862 | if (num != 0) |
| 863 | msgb_tlv_put(msg, OSMO_GSUP_NUM_VECTORS_REQ_IE, 1, &num); |
| 864 | } else { |
| 865 | for (idx = 0; idx < gsup_msg->num_auth_vectors; idx++) { |
| 866 | const struct osmo_auth_vector *auth_vector; |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 867 | |
Harald Welte | 49ddef6 | 2019-08-16 12:22:29 +0200 | [diff] [blame] | 868 | auth_vector = &gsup_msg->auth_vectors[idx]; |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 869 | |
Harald Welte | 49ddef6 | 2019-08-16 12:22:29 +0200 | [diff] [blame] | 870 | encode_auth_info(msg, OSMO_GSUP_AUTH_TUPLE_IE, auth_vector); |
| 871 | } |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 872 | } |
| 873 | |
| 874 | if (gsup_msg->auts) |
Neels Hofmeyr | 8352d31 | 2017-02-02 20:05:14 +0100 | [diff] [blame] | 875 | msgb_tlv_put(msg, OSMO_GSUP_AUTS_IE, 14, gsup_msg->auts); |
Harald Welte | 48dc1a5 | 2016-05-05 18:46:42 +0200 | [diff] [blame] | 876 | |
Harald Welte | 766da86 | 2016-05-06 11:18:15 +0200 | [diff] [blame] | 877 | if (gsup_msg->rand) |
| 878 | msgb_tlv_put(msg, OSMO_GSUP_RAND_IE, 16, gsup_msg->rand); |
| 879 | |
Alexander Couzens | 3938dfb | 2024-02-22 16:28:09 +0100 | [diff] [blame] | 880 | if (gsup_msg->pco && gsup_msg->pco_len > 0) { |
| 881 | if (gsup_msg->pco_len > OSMO_GSUP_MAX_PCO_LEN) |
| 882 | return -EINVAL; |
| 883 | msgb_tlv_put(msg, OSMO_GSUP_PCO_IE, gsup_msg->pco_len, gsup_msg->pco); |
| 884 | } |
Harald Welte | 48dc1a5 | 2016-05-05 18:46:42 +0200 | [diff] [blame] | 885 | if (gsup_msg->cn_domain) { |
| 886 | uint8_t dn = gsup_msg->cn_domain; |
| 887 | msgb_tlv_put(msg, OSMO_GSUP_CN_DOMAIN_IE, 1, &dn); |
| 888 | } |
Holger Hans Peter Freyther | eb55c0d | 2017-07-07 16:53:30 +0200 | [diff] [blame] | 889 | |
| 890 | if (gsup_msg->pdp_charg_enc) { |
| 891 | msgb_tlv_put(msg, OSMO_GSUP_CHARG_CHAR_IE, |
| 892 | gsup_msg->pdp_charg_enc_len, gsup_msg->pdp_charg_enc); |
| 893 | } |
Max | 80f4c4e | 2018-01-24 12:33:05 +0100 | [diff] [blame] | 894 | |
Vadim Yanitskiy | 7269604 | 2018-04-07 02:34:55 +0700 | [diff] [blame] | 895 | if ((u8 = gsup_msg->session_state)) { |
| 896 | size_t len = sizeof(gsup_msg->session_id); |
| 897 | uint8_t *sid = osmo_encode_big_endian(gsup_msg->session_id, len); |
| 898 | |
| 899 | msgb_tlv_put(msg, OSMO_GSUP_SESSION_ID_IE, len, sid); |
| 900 | msgb_tlv_put(msg, OSMO_GSUP_SESSION_STATE_IE, sizeof(u8), &u8); |
| 901 | } |
| 902 | |
Vadim Yanitskiy | 36c7b33 | 2018-03-31 05:23:09 +0700 | [diff] [blame] | 903 | if (gsup_msg->ss_info) { |
| 904 | msgb_tlv_put(msg, OSMO_GSUP_SS_INFO_IE, |
| 905 | gsup_msg->ss_info_len, gsup_msg->ss_info); |
| 906 | } |
| 907 | |
Vadim Yanitskiy | c262831 | 2018-09-25 23:03:13 +0700 | [diff] [blame] | 908 | if (gsup_msg->sm_rp_mr) { |
| 909 | msgb_tlv_put(msg, OSMO_GSUP_SM_RP_MR_IE, |
| 910 | sizeof(*gsup_msg->sm_rp_mr), gsup_msg->sm_rp_mr); |
| 911 | } |
| 912 | |
| 913 | if (gsup_msg->sm_rp_da_type) { |
| 914 | rc = osmo_gsup_sms_encode_sm_rp_da(msg, gsup_msg); |
| 915 | if (rc) { |
| 916 | LOGP(DLGSUP, LOGL_ERROR, "Failed to encode SM-RP-DA IE\n"); |
| 917 | return -EINVAL; |
| 918 | } |
| 919 | } |
| 920 | |
| 921 | if (gsup_msg->sm_rp_oa_type) { |
| 922 | rc = osmo_gsup_sms_encode_sm_rp_oa(msg, gsup_msg); |
| 923 | if (rc) { |
| 924 | LOGP(DLGSUP, LOGL_ERROR, "Failed to encode SM-RP-OA IE\n"); |
| 925 | return -EINVAL; |
| 926 | } |
| 927 | } |
| 928 | |
| 929 | if (gsup_msg->sm_rp_ui) { |
| 930 | msgb_tlv_put(msg, OSMO_GSUP_SM_RP_UI_IE, |
| 931 | gsup_msg->sm_rp_ui_len, gsup_msg->sm_rp_ui); |
| 932 | } |
| 933 | |
| 934 | if (gsup_msg->sm_rp_mms) { |
| 935 | msgb_tlv_put(msg, OSMO_GSUP_SM_RP_MMS_IE, |
| 936 | sizeof(*gsup_msg->sm_rp_mms), gsup_msg->sm_rp_mms); |
| 937 | } |
| 938 | |
| 939 | if (gsup_msg->sm_rp_cause) { |
| 940 | msgb_tlv_put(msg, OSMO_GSUP_SM_RP_CAUSE_IE, |
| 941 | sizeof(*gsup_msg->sm_rp_cause), gsup_msg->sm_rp_cause); |
| 942 | } |
| 943 | |
Vadim Yanitskiy | f9ee8da | 2018-11-13 02:06:15 +0700 | [diff] [blame] | 944 | if ((u8 = gsup_msg->sm_alert_rsn)) { |
| 945 | msgb_tlv_put(msg, OSMO_GSUP_SM_ALERT_RSN_IE, |
| 946 | sizeof(u8), &u8); |
| 947 | } |
| 948 | |
Oliver Smith | 10db281 | 2018-12-14 16:14:34 +0100 | [diff] [blame] | 949 | if (gsup_msg->imei_enc) |
| 950 | msgb_tlv_put(msg, OSMO_GSUP_IMEI_IE, gsup_msg->imei_enc_len, gsup_msg->imei_enc); |
| 951 | |
| 952 | if ((u8 = gsup_msg->imei_result)) { |
| 953 | u8 -= 1; |
| 954 | msgb_tlv_put(msg, OSMO_GSUP_IMEI_RESULT_IE, sizeof(u8), &u8); |
| 955 | } |
| 956 | |
Neels Hofmeyr | 9838c90 | 2019-04-01 22:24:33 +0200 | [diff] [blame] | 957 | if (gsup_msg->message_class != OSMO_GSUP_MESSAGE_CLASS_UNSET) { |
| 958 | u8 = gsup_msg->message_class; |
| 959 | msgb_tlv_put(msg, OSMO_GSUP_MESSAGE_CLASS_IE, sizeof(u8), &u8); |
| 960 | } |
| 961 | |
Oliver Smith | affbb20 | 2019-02-01 11:35:10 +0100 | [diff] [blame] | 962 | if (gsup_msg->source_name) |
| 963 | msgb_tlv_put(msg, OSMO_GSUP_SOURCE_NAME_IE, gsup_msg->source_name_len, gsup_msg->source_name); |
| 964 | |
| 965 | if (gsup_msg->destination_name) |
| 966 | msgb_tlv_put(msg, OSMO_GSUP_DESTINATION_NAME_IE, gsup_msg->destination_name_len, |
| 967 | gsup_msg->destination_name); |
| 968 | |
| 969 | if (gsup_msg->an_apdu.access_network_proto || gsup_msg->an_apdu.data_len) { |
| 970 | rc = osmo_gsup_encode_an_apdu(msg, gsup_msg); |
| 971 | if (rc) { |
| 972 | LOGP(DLGSUP, LOGL_ERROR, "Failed to encode AN-apdu IE \n"); |
| 973 | return -EINVAL; |
| 974 | } |
| 975 | } |
| 976 | |
| 977 | if (gsup_msg->cause_rr_set) { |
| 978 | u8 = gsup_msg->cause_rr; |
| 979 | msgb_tlv_put(msg, OSMO_GSUP_CAUSE_RR_IE, sizeof(u8), &u8); |
| 980 | } |
| 981 | |
| 982 | if (gsup_msg->cause_bssap_set) { |
| 983 | u8 = gsup_msg->cause_bssap; |
| 984 | msgb_tlv_put(msg, OSMO_GSUP_CAUSE_BSSAP_IE, sizeof(u8), &u8); |
| 985 | } |
| 986 | |
| 987 | if ((u8 = gsup_msg->cause_sm)) |
| 988 | msgb_tlv_put(msg, OSMO_GSUP_CAUSE_SM_IE, sizeof(u8), &u8); |
| 989 | |
Neels Hofmeyr | 1b729ce | 2018-12-26 18:13:38 +0100 | [diff] [blame] | 990 | if (gsup_msg->supported_rat_types_len) { |
| 991 | int i; |
| 992 | uint8_t *len = msgb_tl_put(msg, OSMO_GSUP_SUPPORTED_RAT_TYPES_IE); |
| 993 | *len = gsup_msg->supported_rat_types_len; |
| 994 | for (i = 0; i < gsup_msg->supported_rat_types_len; i++) { |
| 995 | if (!gsup_msg->supported_rat_types[i] || |
| 996 | gsup_msg->supported_rat_types[i] >= OSMO_RAT_COUNT) { |
| 997 | LOGP(DLGSUP, LOGL_ERROR, "Failed to encode RAT type %s (nr %d)\n", |
| 998 | osmo_rat_type_name(gsup_msg->supported_rat_types[i]), i); |
| 999 | return -EINVAL; |
| 1000 | } |
| 1001 | msgb_v_put(msg, gsup_msg->supported_rat_types[i]); |
| 1002 | } |
| 1003 | } |
| 1004 | if (gsup_msg->current_rat_type != OSMO_RAT_UNKNOWN) { |
| 1005 | u8 = gsup_msg->current_rat_type; |
| 1006 | msgb_tlv_put(msg, OSMO_GSUP_CURRENT_RAT_TYPE_IE, sizeof(u8), &u8); |
| 1007 | } |
| 1008 | |
Max | 80f4c4e | 2018-01-24 12:33:05 +0100 | [diff] [blame] | 1009 | return 0; |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 1010 | } |
Harald Welte | 96e2a00 | 2017-06-12 21:44:18 +0200 | [diff] [blame] | 1011 | |
Neels Hofmeyr | 9838c90 | 2019-04-01 22:24:33 +0200 | [diff] [blame] | 1012 | const struct value_string osmo_gsup_message_class_names[] = { |
| 1013 | { OSMO_GSUP_MESSAGE_CLASS_UNSET, "unset" }, |
| 1014 | { OSMO_GSUP_MESSAGE_CLASS_SUBSCRIBER_MANAGEMENT, "Subscriber-Management" }, |
| 1015 | { OSMO_GSUP_MESSAGE_CLASS_SMS, "SMS" }, |
| 1016 | { OSMO_GSUP_MESSAGE_CLASS_USSD, "USSD" }, |
| 1017 | { OSMO_GSUP_MESSAGE_CLASS_INTER_MSC, "Inter-MSC" }, |
Alexander Couzens | 505f705 | 2023-03-07 16:01:52 +0100 | [diff] [blame] | 1018 | { OSMO_GSUP_MESSAGE_CLASS_IPSEC_EPDG, "IPsec-ePDG" }, |
Neels Hofmeyr | 9838c90 | 2019-04-01 22:24:33 +0200 | [diff] [blame] | 1019 | {} |
| 1020 | }; |
| 1021 | |
Harald Welte | 96e2a00 | 2017-06-12 21:44:18 +0200 | [diff] [blame] | 1022 | /*! @} */ |