blob: 3b31d03c9ee072bdbf37384405dff3065cfc5d0d [file] [log] [blame]
Harald Welte3b6fb082016-04-25 18:46:22 +02001/*
Harald Weltee08da972017-11-13 01:00:26 +09002 * (C) 2014 by sysmocom - s.f.m.c. GmbH
3 * Author: Jacob Erlbeck
Harald Welte3b6fb082016-04-25 18:46:22 +02004 * (C) 2015 by Holger Hans Peter Freyther
5 * (C) 2016 by Harald Welte <laforge@gnumonks.org>
6 * All Rights Reserved
7 *
Harald Weltee08da972017-11-13 01:00:26 +09008 * SPDX-License-Identifier: GPL-2.0+
Harald Welte3b6fb082016-04-25 18:46:22 +02009 *
10 * This program is free software; you can redistribute it and/or modify
Neels Hofmeyr5f460de2016-12-08 16:23:05 +010011 * 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 Welte3b6fb082016-04-25 18:46:22 +020013 * (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 Hofmeyr5f460de2016-12-08 16:23:05 +010018 * GNU General Public License for more details.
Harald Welte3b6fb082016-04-25 18:46:22 +020019 *
Neels Hofmeyr5f460de2016-12-08 16:23:05 +010020 * You should have received a copy of the GNU General Public License
Harald Welte3b6fb082016-04-25 18:46:22 +020021 * 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 Welte96e2a002017-06-12 21:44:18 +020033/*! \addtogroup gsup
34 * @{
Harald Welte381a1aa2017-10-16 18:31:20 +020035 * \file gsup.c
Neels Hofmeyr87e45502017-06-20 00:17:59 +020036 * Osmocom Generic Subscriber Update Protocol
Harald Welte96e2a002017-06-12 21:44:18 +020037 */
38
Neels Hofmeyr10f5fb42017-02-09 02:09:09 +010039const 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 Yanitskiy36c7b332018-03-31 05:23:09 +070065
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 Yanitskiyc2628312018-09-25 23:03:13 +070070 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 Yanitskiyf9ee8da2018-11-13 02:06:15 +070078 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
Neels Hofmeyr10f5fb42017-02-09 02:09:09 +010082 { 0, NULL }
83};
84
Harald Welte6a6a6092018-06-16 11:10:12 +020085const struct value_string osmo_gsup_session_state_names[] = {
86 { OSMO_GSUP_SESSION_STATE_NONE, "NONE" },
87 { OSMO_GSUP_SESSION_STATE_BEGIN, "BEGIN" },
88 { OSMO_GSUP_SESSION_STATE_CONTINUE, "CONTINUE" },
89 { OSMO_GSUP_SESSION_STATE_END, "END" },
90 { 0, NULL }
91};
92
Harald Welte520ebc12018-06-11 20:27:27 +020093
94/*! return the error message type corresponding to \a type_in
95 * \returns matching error message type; -1 on error */
96int osmo_gsup_get_err_msg_type(enum osmo_gsup_message_type type_in)
97{
98 switch (type_in) {
99 case OSMO_GSUP_MSGT_UPDATE_LOCATION_REQUEST:
100 return OSMO_GSUP_MSGT_UPDATE_LOCATION_ERROR;
101 case OSMO_GSUP_MSGT_SEND_AUTH_INFO_REQUEST:
102 return OSMO_GSUP_MSGT_SEND_AUTH_INFO_ERROR;
103 case OSMO_GSUP_MSGT_PURGE_MS_REQUEST:
104 return OSMO_GSUP_MSGT_PURGE_MS_ERROR;
105 case OSMO_GSUP_MSGT_INSERT_DATA_REQUEST:
106 return OSMO_GSUP_MSGT_INSERT_DATA_ERROR;
107 case OSMO_GSUP_MSGT_DELETE_DATA_REQUEST:
108 return OSMO_GSUP_MSGT_DELETE_DATA_ERROR;
109 case OSMO_GSUP_MSGT_LOCATION_CANCEL_REQUEST:
110 return OSMO_GSUP_MSGT_LOCATION_CANCEL_ERROR;
Oliver Smithe8c3b1b2018-12-20 17:36:45 +0100111 case OSMO_GSUP_MSGT_PROC_SS_REQUEST:
112 return OSMO_GSUP_MSGT_PROC_SS_ERROR;
113 case OSMO_GSUP_MSGT_MO_FORWARD_SM_REQUEST:
114 return OSMO_GSUP_MSGT_MO_FORWARD_SM_ERROR;
115 case OSMO_GSUP_MSGT_MT_FORWARD_SM_REQUEST:
116 return OSMO_GSUP_MSGT_MT_FORWARD_SM_ERROR;
117 case OSMO_GSUP_MSGT_READY_FOR_SM_REQUEST:
118 return OSMO_GSUP_MSGT_READY_FOR_SM_ERROR;
Harald Welte520ebc12018-06-11 20:27:27 +0200119 default:
120 return -1;
121 }
122}
123
Harald Welte3b6fb082016-04-25 18:46:22 +0200124static int decode_pdp_info(uint8_t *data, size_t data_len,
125 struct osmo_gsup_pdp_info *pdp_info)
126{
127 int rc;
128 uint8_t tag;
129 uint8_t *value;
130 size_t value_len;
131
132 /* specific parts */
133 while (data_len > 0) {
134 enum osmo_gsup_iei iei;
135
136 rc = osmo_shift_tlv(&data, &data_len, &tag, &value, &value_len);
137 if (rc < 0)
138 return -GMM_CAUSE_PROTO_ERR_UNSPEC;
139
140 iei = tag;
141
142 switch (iei) {
143 case OSMO_GSUP_PDP_CONTEXT_ID_IE:
144 pdp_info->context_id = osmo_decode_big_endian(value, value_len);
145 break;
146
147 case OSMO_GSUP_PDP_TYPE_IE:
148 pdp_info->pdp_type =
149 osmo_decode_big_endian(value, value_len) & 0x0fff;
150 break;
151
152 case OSMO_GSUP_ACCESS_POINT_NAME_IE:
153 pdp_info->apn_enc = value;
154 pdp_info->apn_enc_len = value_len;
155 break;
156
157 case OSMO_GSUP_PDP_QOS_IE:
158 pdp_info->qos_enc = value;
159 pdp_info->qos_enc_len = value_len;
160 break;
161
Holger Hans Peter Freythereb55c0d2017-07-07 16:53:30 +0200162 case OSMO_GSUP_CHARG_CHAR_IE:
163 pdp_info->pdp_charg_enc = value;
164 pdp_info->pdp_charg_enc_len = value_len;
165 break;
166
Harald Welte3b6fb082016-04-25 18:46:22 +0200167 default:
168 LOGP(DLGSUP, LOGL_ERROR,
169 "GSUP IE type %d not expected in PDP info\n", iei);
170 continue;
171 }
172 }
173
174 return 0;
175}
176
177static int decode_auth_info(uint8_t *data, size_t data_len,
178 struct osmo_auth_vector *auth_vector)
179{
180 int rc;
181 uint8_t tag;
182 uint8_t *value;
183 size_t value_len;
184 enum osmo_gsup_iei iei;
185 uint8_t presence = 0;
186
187 /* specific parts */
188 while (data_len > 0) {
189 rc = osmo_shift_tlv(&data, &data_len, &tag, &value, &value_len);
190 if (rc < 0)
191 return -GMM_CAUSE_PROTO_ERR_UNSPEC;
192
193 iei = tag;
194
195 switch (iei) {
196 case OSMO_GSUP_RAND_IE:
197 if (value_len != sizeof(auth_vector->rand))
198 goto parse_error;
199
200 memcpy(auth_vector->rand, value, value_len);
201 presence |= (1 << 0);
202 break;
203
204 case OSMO_GSUP_SRES_IE:
205 if (value_len != sizeof(auth_vector->sres))
206 goto parse_error;
207
208 memcpy(auth_vector->sres, value, value_len);
209 presence |= (1 << 1);
210 break;
211
212 case OSMO_GSUP_KC_IE:
213 if (value_len != sizeof(auth_vector->kc))
214 goto parse_error;
215
216 memcpy(auth_vector->kc, value, value_len);
217 presence |= (1 << 2);
218 break;
219
220 case OSMO_GSUP_IK_IE:
221 if (value_len != sizeof(auth_vector->ik))
222 goto parse_error;
223 memcpy(auth_vector->ik, value, value_len);
224 presence |= (1 << 4);
225 break;
226
227 case OSMO_GSUP_CK_IE:
228 if (value_len != sizeof(auth_vector->ck))
229 goto parse_error;
230 memcpy(auth_vector->ck, value, value_len);
231 presence |= (1 << 5);
232 break;
233
234 case OSMO_GSUP_AUTN_IE:
235 if (value_len != sizeof(auth_vector->autn))
236 goto parse_error;
237 memcpy(auth_vector->autn, value, value_len);
238 presence |= (1 << 6);
239 break;
240 case OSMO_GSUP_RES_IE:
241 if (value_len > sizeof(auth_vector->res))
242 goto parse_error;
243 memcpy(auth_vector->res, value, value_len);
244 auth_vector->res_len = value_len;
245 presence |= (1 << 7);
246 break;
247
248 default:
249 LOGP(DLGSUP, LOGL_ERROR,
250 "GSUP IE type %d not expected in PDP info\n", iei);
251 continue;
252 }
253 }
254
255 if (presence & 0x07)
256 auth_vector->auth_types |= OSMO_AUTH_TYPE_GSM;
257 if (presence & 0xf0)
258 auth_vector->auth_types |= OSMO_AUTH_TYPE_UMTS;
259
260 return 0;
261
262parse_error:
263 LOGP(DLGSUP, LOGL_ERROR,
264 "GSUP IE type %d, length %zu invalid in PDP info\n", iei, value_len);
265
266 return -1;
267}
268
269/*! Decode (parse) a GSUP message
270 * \param[in] const_data input data to be parsed
271 * \param[in] data_len length of input (\a const_data)
272 * \param[out] gsup_msg callee-allocated output data structure
273 * \returns 0 on success; negative otherwise
274 */
275int osmo_gsup_decode(const uint8_t *const_data, size_t data_len,
276 struct osmo_gsup_message *gsup_msg)
277{
278 int rc;
279 uint8_t tag;
280 /* the shift/match functions expect non-const pointers, but we'll
281 * either copy the data or cast pointers back to const before returning
282 * them
283 */
284 uint8_t *data = (uint8_t *)const_data;
285 uint8_t *value;
286 size_t value_len;
287 static const struct osmo_gsup_pdp_info empty_pdp_info = {0};
Neels Hofmeyr505adee2016-07-13 16:55:43 +0200288 static const struct osmo_auth_vector empty_auth_info = {{0}};
Harald Welte3b6fb082016-04-25 18:46:22 +0200289 static const struct osmo_gsup_message empty_gsup_message = {0};
290
291 *gsup_msg = empty_gsup_message;
292
293 /* generic part */
294 rc = osmo_shift_v_fixed(&data, &data_len, 1, &value);
295 if (rc < 0)
296 return -GMM_CAUSE_INV_MAND_INFO;
297
298 gsup_msg->message_type = osmo_decode_big_endian(value, 1);
299
300 rc = osmo_match_shift_tlv(&data, &data_len, OSMO_GSUP_IMSI_IE,
301 &value, &value_len);
302
303 if (rc <= 0)
304 return -GMM_CAUSE_INV_MAND_INFO;
305
306 if (value_len * 2 + 1 > sizeof(gsup_msg->imsi))
307 return -GMM_CAUSE_INV_MAND_INFO;
308
309 /* Note that gsm48_decode_bcd_number expects the number of encoded IMSI
310 * octets in the first octet. By coincidence (the TLV encoding) the byte
311 * before the value part already contains this length so we can use it
312 * here.
313 */
314 OSMO_ASSERT(value[-1] == value_len);
315 gsm48_decode_bcd_number(gsup_msg->imsi, sizeof(gsup_msg->imsi),
316 value - 1, 0);
317
318 /* specific parts */
319 while (data_len > 0) {
320 enum osmo_gsup_iei iei;
321 struct osmo_gsup_pdp_info pdp_info;
322 struct osmo_auth_vector auth_info;
323
324 rc = osmo_shift_tlv(&data, &data_len, &tag, &value, &value_len);
325 if (rc < 0)
326 return -GMM_CAUSE_PROTO_ERR_UNSPEC;
327
328 iei = tag;
329
330 switch (iei) {
331 case OSMO_GSUP_IMSI_IE:
332 case OSMO_GSUP_PDP_TYPE_IE:
333 case OSMO_GSUP_ACCESS_POINT_NAME_IE:
Harald Welte3b6fb082016-04-25 18:46:22 +0200334 case OSMO_GSUP_SRES_IE:
335 case OSMO_GSUP_KC_IE:
336 LOGP(DLGSUP, LOGL_NOTICE,
337 "GSUP IE type %d not expected (ignored)\n", iei);
338 continue;
339
340 case OSMO_GSUP_CAUSE_IE:
341 gsup_msg->cause = osmo_decode_big_endian(value, value_len);
342 break;
343
344 case OSMO_GSUP_CANCEL_TYPE_IE:
345 gsup_msg->cancel_type =
346 osmo_decode_big_endian(value, value_len) + 1;
347 break;
348
349 case OSMO_GSUP_PDP_INFO_COMPL_IE:
350 gsup_msg->pdp_info_compl = 1;
351 break;
352
353 case OSMO_GSUP_FREEZE_PTMSI_IE:
354 gsup_msg->freeze_ptmsi = 1;
355 break;
356
357 case OSMO_GSUP_PDP_CONTEXT_ID_IE:
358 /* When these IE appear in the top-level part of the
359 * message, they are used by Delete Subscr Info to delete
360 * single entries. We don't have an extra list for
361 * these but use the PDP info list instead */
362
363 /* fall through */
364
365 case OSMO_GSUP_PDP_INFO_IE:
366 if (gsup_msg->num_pdp_infos >= OSMO_GSUP_MAX_NUM_PDP_INFO) {
367 LOGP(DLGSUP, LOGL_ERROR,
368 "GSUP IE type %d (PDP_INFO) max exceeded\n",
369 iei);
370 return -GMM_CAUSE_COND_IE_ERR;
371 }
372
373 pdp_info = empty_pdp_info;
374
375 if (iei == OSMO_GSUP_PDP_INFO_IE) {
376 rc = decode_pdp_info(value, value_len, &pdp_info);
377 if (rc < 0)
378 return rc;
379 pdp_info.have_info = 1;
380 } else {
381 pdp_info.context_id =
382 osmo_decode_big_endian(value, value_len);
383 }
384
385 gsup_msg->pdp_infos[gsup_msg->num_pdp_infos++] =
386 pdp_info;
387 break;
388
389 case OSMO_GSUP_AUTH_TUPLE_IE:
390 if (gsup_msg->num_auth_vectors >= OSMO_GSUP_MAX_NUM_AUTH_INFO) {
391 LOGP(DLGSUP, LOGL_ERROR,
392 "GSUP IE type %d (AUTH_INFO) max exceeded\n",
393 iei);
394 return -GMM_CAUSE_INV_MAND_INFO;
395 }
396
397 auth_info = empty_auth_info;
398
399 rc = decode_auth_info(value, value_len, &auth_info);
400 if (rc < 0)
401 return rc;
402
403 gsup_msg->auth_vectors[gsup_msg->num_auth_vectors++] =
404 auth_info;
405 break;
406
407 case OSMO_GSUP_AUTS_IE:
Neels Hofmeyr3a5ca642017-02-21 15:53:20 +0100408 if (value_len != 14) {
Harald Welte3b6fb082016-04-25 18:46:22 +0200409 LOGP(DLGSUP, LOGL_ERROR,
Neels Hofmeyr3a5ca642017-02-21 15:53:20 +0100410 "AUTS length != 14 received\n");
Harald Welte3b6fb082016-04-25 18:46:22 +0200411 return -GMM_CAUSE_COND_IE_ERR;
412 }
413 gsup_msg->auts = value;
414 break;
415
Harald Welte766da862016-05-06 11:18:15 +0200416 case OSMO_GSUP_RAND_IE:
417 if (value_len != 16) {
418 LOGP(DLGSUP, LOGL_ERROR,
419 "RAND length != 16 received\n");
420 return -GMM_CAUSE_COND_IE_ERR;
421 }
422 gsup_msg->rand = value;
423 break;
424
Harald Welte3b6fb082016-04-25 18:46:22 +0200425 case OSMO_GSUP_MSISDN_IE:
426 gsup_msg->msisdn_enc = value;
427 gsup_msg->msisdn_enc_len = value_len;
428 break;
429
430 case OSMO_GSUP_HLR_NUMBER_IE:
431 gsup_msg->hlr_enc = value;
432 gsup_msg->hlr_enc_len = value_len;
433 break;
434
Harald Welte48dc1a52016-05-05 18:46:42 +0200435 case OSMO_GSUP_CN_DOMAIN_IE:
436 gsup_msg->cn_domain = *value;
437 break;
438
Holger Hans Peter Freythereb55c0d2017-07-07 16:53:30 +0200439 case OSMO_GSUP_CHARG_CHAR_IE:
440 gsup_msg->pdp_charg_enc = value;
441 gsup_msg->pdp_charg_enc_len = value_len;
442 break;
443
Vadim Yanitskiy72696042018-04-07 02:34:55 +0700444 case OSMO_GSUP_SESSION_ID_IE:
445 gsup_msg->session_id = osmo_decode_big_endian(value, value_len);
446 break;
447
448 case OSMO_GSUP_SESSION_STATE_IE:
449 gsup_msg->session_state = *value;
450 break;
451
Vadim Yanitskiy36c7b332018-03-31 05:23:09 +0700452 case OSMO_GSUP_SS_INFO_IE:
453 gsup_msg->ss_info = value;
454 gsup_msg->ss_info_len = value_len;
455 break;
456
Vadim Yanitskiyc2628312018-09-25 23:03:13 +0700457 case OSMO_GSUP_SM_RP_MR_IE:
458 gsup_msg->sm_rp_mr = value;
459 break;
460
461 case OSMO_GSUP_SM_RP_DA_IE:
462 rc = osmo_gsup_sms_decode_sm_rp_da(gsup_msg, value, value_len);
463 if (rc)
464 return rc;
465 break;
466
467 case OSMO_GSUP_SM_RP_OA_IE:
468 rc = osmo_gsup_sms_decode_sm_rp_oa(gsup_msg, value, value_len);
469 if (rc)
470 return rc;
471 break;
472
473 case OSMO_GSUP_SM_RP_UI_IE:
474 gsup_msg->sm_rp_ui = value;
475 gsup_msg->sm_rp_ui_len = value_len;
476 break;
477
478 case OSMO_GSUP_SM_RP_MMS_IE:
479 gsup_msg->sm_rp_mms = value;
480 break;
481
482 case OSMO_GSUP_SM_RP_CAUSE_IE:
483 gsup_msg->sm_rp_cause = value;
484 break;
485
Vadim Yanitskiyf9ee8da2018-11-13 02:06:15 +0700486 case OSMO_GSUP_SM_ALERT_RSN_IE:
487 gsup_msg->sm_alert_rsn = *value;
488 break;
489
Harald Welte3b6fb082016-04-25 18:46:22 +0200490 default:
491 LOGP(DLGSUP, LOGL_NOTICE,
492 "GSUP IE type %d unknown\n", iei);
493 continue;
494 }
495 }
496
497 return 0;
498}
499
500static void encode_pdp_info(struct msgb *msg, enum osmo_gsup_iei iei,
501 const struct osmo_gsup_pdp_info *pdp_info)
502{
503 uint8_t *len_field;
504 size_t old_len;
505 uint8_t u8;
506
507 len_field = msgb_tlv_put(msg, iei, 0, NULL) - 1;
508 old_len = msgb_length(msg);
509
510 u8 = pdp_info->context_id;
511 msgb_tlv_put(msg, OSMO_GSUP_PDP_CONTEXT_ID_IE, sizeof(u8), &u8);
512
513 if (pdp_info->pdp_type) {
514 msgb_tlv_put(msg, OSMO_GSUP_PDP_TYPE_IE,
515 OSMO_GSUP_PDP_TYPE_SIZE,
516 osmo_encode_big_endian(pdp_info->pdp_type | 0xf000,
517 OSMO_GSUP_PDP_TYPE_SIZE));
518 }
519
520 if (pdp_info->apn_enc) {
521 msgb_tlv_put(msg, OSMO_GSUP_ACCESS_POINT_NAME_IE,
522 pdp_info->apn_enc_len, pdp_info->apn_enc);
523 }
524
525 if (pdp_info->qos_enc) {
526 msgb_tlv_put(msg, OSMO_GSUP_PDP_QOS_IE,
527 pdp_info->qos_enc_len, pdp_info->qos_enc);
528 }
529
Holger Hans Peter Freythereb55c0d2017-07-07 16:53:30 +0200530 if (pdp_info->pdp_charg_enc) {
531 msgb_tlv_put(msg, OSMO_GSUP_CHARG_CHAR_IE,
532 pdp_info->pdp_charg_enc_len, pdp_info->pdp_charg_enc);
533 }
534
Harald Welte3b6fb082016-04-25 18:46:22 +0200535 /* Update length field */
536 *len_field = msgb_length(msg) - old_len;
537}
538
539static void encode_auth_info(struct msgb *msg, enum osmo_gsup_iei iei,
540 const struct osmo_auth_vector *auth_vector)
541{
542 uint8_t *len_field;
543 size_t old_len;
544
545 len_field = msgb_tlv_put(msg, iei, 0, NULL) - 1;
546 old_len = msgb_length(msg);
547
Harald Weltedb78d212016-06-06 13:47:07 +0200548 if (auth_vector->auth_types & OSMO_AUTH_TYPE_GSM) {
549 msgb_tlv_put(msg, OSMO_GSUP_RAND_IE,
550 sizeof(auth_vector->rand), auth_vector->rand);
Harald Welte3b6fb082016-04-25 18:46:22 +0200551
Harald Weltedb78d212016-06-06 13:47:07 +0200552 msgb_tlv_put(msg, OSMO_GSUP_SRES_IE,
553 sizeof(auth_vector->sres), auth_vector->sres);
Harald Welte3b6fb082016-04-25 18:46:22 +0200554
Harald Weltedb78d212016-06-06 13:47:07 +0200555 msgb_tlv_put(msg, OSMO_GSUP_KC_IE,
556 sizeof(auth_vector->kc), auth_vector->kc);
557 }
558
559 if (auth_vector->auth_types & OSMO_AUTH_TYPE_UMTS) {
560 msgb_tlv_put(msg, OSMO_GSUP_IK_IE,
561 sizeof(auth_vector->ik), auth_vector->ik);
562
563 msgb_tlv_put(msg, OSMO_GSUP_CK_IE,
564 sizeof(auth_vector->ck), auth_vector->ck);
565
566 msgb_tlv_put(msg, OSMO_GSUP_AUTN_IE,
567 sizeof(auth_vector->autn), auth_vector->autn);
568
569 msgb_tlv_put(msg, OSMO_GSUP_RES_IE,
570 auth_vector->res_len, auth_vector->res);
571 }
Harald Welte3b6fb082016-04-25 18:46:22 +0200572
573 /* Update length field */
574 *len_field = msgb_length(msg) - old_len;
575}
576
577/*! Encode a GSUP message
578 * \param[out] msg message buffer to which encoded message is written
579 * \param[in] gsup_msg \ref osmo_gsup_message data to be encoded
Max80f4c4e2018-01-24 12:33:05 +0100580 * \returns 0 on success; negative otherwise
Harald Welte3b6fb082016-04-25 18:46:22 +0200581 */
Max80f4c4e2018-01-24 12:33:05 +0100582int osmo_gsup_encode(struct msgb *msg, const struct osmo_gsup_message *gsup_msg)
Harald Welte3b6fb082016-04-25 18:46:22 +0200583{
584 uint8_t u8;
Vadim Yanitskiyc2628312018-09-25 23:03:13 +0700585 int idx, rc;
Harald Welte3b6fb082016-04-25 18:46:22 +0200586 uint8_t bcd_buf[GSM48_MI_SIZE] = {0};
587 size_t bcd_len;
588
589 /* generic part */
Max80f4c4e2018-01-24 12:33:05 +0100590 if(!gsup_msg->message_type)
Vadim Yanitskiyee86b042018-09-25 18:09:01 +0700591 return -EINVAL;
Max80f4c4e2018-01-24 12:33:05 +0100592
Harald Welte3b6fb082016-04-25 18:46:22 +0200593 msgb_v_put(msg, gsup_msg->message_type);
594
595 bcd_len = gsm48_encode_bcd_number(bcd_buf, sizeof(bcd_buf), 0,
596 gsup_msg->imsi);
597
Max80f4c4e2018-01-24 12:33:05 +0100598 if (bcd_len <= 0 || bcd_len > sizeof(bcd_buf))
599 return -EINVAL;
Harald Welte3b6fb082016-04-25 18:46:22 +0200600
601 /* Note that gsm48_encode_bcd_number puts the length into the first
602 * octet. Since msgb_tlv_put will add this length byte, we'll have to
603 * skip it */
604 msgb_tlv_put(msg, OSMO_GSUP_IMSI_IE, bcd_len - 1, &bcd_buf[1]);
605
606 /* specific parts */
607 if (gsup_msg->msisdn_enc)
608 msgb_tlv_put(msg, OSMO_GSUP_MSISDN_IE,
609 gsup_msg->msisdn_enc_len, gsup_msg->msisdn_enc);
610 if (gsup_msg->hlr_enc)
611 msgb_tlv_put(msg, OSMO_GSUP_HLR_NUMBER_IE,
612 gsup_msg->hlr_enc_len, gsup_msg->hlr_enc);
613
614 if ((u8 = gsup_msg->cause))
615 msgb_tlv_put(msg, OSMO_GSUP_CAUSE_IE, sizeof(u8), &u8);
616
617 if ((u8 = gsup_msg->cancel_type)) {
618 u8 -= 1;
619 msgb_tlv_put(msg, OSMO_GSUP_CANCEL_TYPE_IE, sizeof(u8), &u8);
620 }
621
622 if (gsup_msg->pdp_info_compl)
623 msgb_tlv_put(msg, OSMO_GSUP_PDP_INFO_COMPL_IE, 0, &u8);
624
625 if (gsup_msg->freeze_ptmsi)
626 msgb_tlv_put(msg, OSMO_GSUP_FREEZE_PTMSI_IE, 0, &u8);
627
628 for (idx = 0; idx < gsup_msg->num_pdp_infos; idx++) {
629 const struct osmo_gsup_pdp_info *pdp_info;
630
631 pdp_info = &gsup_msg->pdp_infos[idx];
632
633 if (pdp_info->context_id == 0)
634 continue;
635
636 if (pdp_info->have_info) {
637 encode_pdp_info(msg, OSMO_GSUP_PDP_INFO_IE, pdp_info);
638 } else {
639 u8 = pdp_info->context_id;
640 msgb_tlv_put(msg, OSMO_GSUP_PDP_CONTEXT_ID_IE,
641 sizeof(u8), &u8);
642 }
643 }
644
645 for (idx = 0; idx < gsup_msg->num_auth_vectors; idx++) {
646 const struct osmo_auth_vector *auth_vector;
647
648 auth_vector = &gsup_msg->auth_vectors[idx];
649
650 encode_auth_info(msg, OSMO_GSUP_AUTH_TUPLE_IE, auth_vector);
651 }
652
653 if (gsup_msg->auts)
Neels Hofmeyr8352d312017-02-02 20:05:14 +0100654 msgb_tlv_put(msg, OSMO_GSUP_AUTS_IE, 14, gsup_msg->auts);
Harald Welte48dc1a52016-05-05 18:46:42 +0200655
Harald Welte766da862016-05-06 11:18:15 +0200656 if (gsup_msg->rand)
657 msgb_tlv_put(msg, OSMO_GSUP_RAND_IE, 16, gsup_msg->rand);
658
Harald Welte48dc1a52016-05-05 18:46:42 +0200659 if (gsup_msg->cn_domain) {
660 uint8_t dn = gsup_msg->cn_domain;
661 msgb_tlv_put(msg, OSMO_GSUP_CN_DOMAIN_IE, 1, &dn);
662 }
Holger Hans Peter Freythereb55c0d2017-07-07 16:53:30 +0200663
664 if (gsup_msg->pdp_charg_enc) {
665 msgb_tlv_put(msg, OSMO_GSUP_CHARG_CHAR_IE,
666 gsup_msg->pdp_charg_enc_len, gsup_msg->pdp_charg_enc);
667 }
Max80f4c4e2018-01-24 12:33:05 +0100668
Vadim Yanitskiy72696042018-04-07 02:34:55 +0700669 if ((u8 = gsup_msg->session_state)) {
670 size_t len = sizeof(gsup_msg->session_id);
671 uint8_t *sid = osmo_encode_big_endian(gsup_msg->session_id, len);
672
673 msgb_tlv_put(msg, OSMO_GSUP_SESSION_ID_IE, len, sid);
674 msgb_tlv_put(msg, OSMO_GSUP_SESSION_STATE_IE, sizeof(u8), &u8);
675 }
676
Vadim Yanitskiy36c7b332018-03-31 05:23:09 +0700677 if (gsup_msg->ss_info) {
678 msgb_tlv_put(msg, OSMO_GSUP_SS_INFO_IE,
679 gsup_msg->ss_info_len, gsup_msg->ss_info);
680 }
681
Vadim Yanitskiyc2628312018-09-25 23:03:13 +0700682 if (gsup_msg->sm_rp_mr) {
683 msgb_tlv_put(msg, OSMO_GSUP_SM_RP_MR_IE,
684 sizeof(*gsup_msg->sm_rp_mr), gsup_msg->sm_rp_mr);
685 }
686
687 if (gsup_msg->sm_rp_da_type) {
688 rc = osmo_gsup_sms_encode_sm_rp_da(msg, gsup_msg);
689 if (rc) {
690 LOGP(DLGSUP, LOGL_ERROR, "Failed to encode SM-RP-DA IE\n");
691 return -EINVAL;
692 }
693 }
694
695 if (gsup_msg->sm_rp_oa_type) {
696 rc = osmo_gsup_sms_encode_sm_rp_oa(msg, gsup_msg);
697 if (rc) {
698 LOGP(DLGSUP, LOGL_ERROR, "Failed to encode SM-RP-OA IE\n");
699 return -EINVAL;
700 }
701 }
702
703 if (gsup_msg->sm_rp_ui) {
704 msgb_tlv_put(msg, OSMO_GSUP_SM_RP_UI_IE,
705 gsup_msg->sm_rp_ui_len, gsup_msg->sm_rp_ui);
706 }
707
708 if (gsup_msg->sm_rp_mms) {
709 msgb_tlv_put(msg, OSMO_GSUP_SM_RP_MMS_IE,
710 sizeof(*gsup_msg->sm_rp_mms), gsup_msg->sm_rp_mms);
711 }
712
713 if (gsup_msg->sm_rp_cause) {
714 msgb_tlv_put(msg, OSMO_GSUP_SM_RP_CAUSE_IE,
715 sizeof(*gsup_msg->sm_rp_cause), gsup_msg->sm_rp_cause);
716 }
717
Vadim Yanitskiyf9ee8da2018-11-13 02:06:15 +0700718 if ((u8 = gsup_msg->sm_alert_rsn)) {
719 msgb_tlv_put(msg, OSMO_GSUP_SM_ALERT_RSN_IE,
720 sizeof(u8), &u8);
721 }
722
Max80f4c4e2018-01-24 12:33:05 +0100723 return 0;
Harald Welte3b6fb082016-04-25 18:46:22 +0200724}
Harald Welte96e2a002017-06-12 21:44:18 +0200725
726/*! @} */