blob: 49d126489d12d5a4ec8a81b7252f2595b7d49cfe [file] [log] [blame]
Harald Welte381a1aa2017-10-16 18:31:20 +02001/*! \defgroup gsup Generic Subscriber Update Protocol
2 * @{
3 *
4 * The Generic Subscriber Update Protocol (GSUP) is an Osmocom-specific
5 * non-standard protocol replacing MAP as the protocol between
6 * MSC/VLR/SGSN and HLR in a 3GPP cellular communications network.
7 *
8 * It was designed around the same transactions and architecture as the
9 * MAP messages/operations, but without the complexity of TCAP and MAP,
10 * and without the need for ASN.1 encoding.
11 *
12 * The purpose is to keep protocol complexity out of OsmoSGSN and
13 * OsmoMSC, while providing a clean path to an external GSUP to MAP
14 * translator.
15 *
16 * \file gsup.h
17 * Osmocom Generic Subscriber Update Protocol message encoder/decoder. */
Neels Hofmeyr17518fe2017-06-20 04:35:06 +020018/*
Harald Weltee08da972017-11-13 01:00:26 +090019 * (C) 2014 by sysmocom - s.f.m.c. GmbH, Author: Jacob Erlbeck
Harald Welte3b6fb082016-04-25 18:46:22 +020020 * (C) 2016 by Harald Welte <laforge@gnumonks.org>
21 * All Rights Reserved
22 *
Harald Weltee08da972017-11-13 01:00:26 +090023 * SPDX-License-Identifier: GPL-2.0+
24 *
Harald Welte3b6fb082016-04-25 18:46:22 +020025 * This program is free software; you can redistribute it and/or modify
26 * it under the terms of the GNU General Public License as published by
27 * the Free Software Foundation; either version 2 of the License, or
28 * (at your option) any later version.
29 *
30 * This program is distributed in the hope that it will be useful,
31 * but WITHOUT ANY WARRANTY; without even the implied warranty of
32 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
33 * GNU General Public License for more details.
34 *
35 * You should have received a copy of the GNU General Public License
36 * along with this program. If not, see <http://www.gnu.org/licenses/>.
37 *
38 */
39#pragma once
40
41#include <stdint.h>
42#include <osmocom/core/msgb.h>
Pau Espin Pedrol68a04df2024-01-19 18:03:59 +010043#include <osmocom/core/defs.h>
44#include <osmocom/core/endian.h>
Vadim Yanitskiyc2628312018-09-25 23:03:13 +070045#include <osmocom/gsm/gsup_sms.h>
Harald Welte3b6fb082016-04-25 18:46:22 +020046#include <osmocom/gsm/protocol/gsm_23_003.h>
Oliver Smithaffbb202019-02-01 11:35:10 +010047#include <osmocom/gsm/protocol/gsm_03_40.h>
Harald Welte3b6fb082016-04-25 18:46:22 +020048#include <osmocom/gsm/protocol/gsm_04_08_gprs.h>
Oliver Smithaffbb202019-02-01 11:35:10 +010049#include <osmocom/gsm/protocol/gsm_08_08.h>
Neels Hofmeyr1b729ce2018-12-26 18:13:38 +010050#include <osmocom/gsm/gsm_utils.h>
Harald Welte3b6fb082016-04-25 18:46:22 +020051#include <osmocom/crypt/auth.h>
52
Neels Hofmeyrb970e102017-07-21 15:55:28 +020053#define OSMO_GSUP_PORT 4222
54
Harald Welte3b6fb082016-04-25 18:46:22 +020055/*! Maximum nubmer of PDP inside \ref osmo_gsup_message */
56#define OSMO_GSUP_MAX_NUM_PDP_INFO 10 /* GSM 09.02 limits this to 50 */
57/*! Maximum number of auth info inside \ref osmo_gsup_message */
58#define OSMO_GSUP_MAX_NUM_AUTH_INFO 5
59/*! Maximum number of octets encoding MSISDN in BCD format */
60#define OSMO_GSUP_MAX_MSISDN_LEN 9
Stefan Sperlingdda1d452018-05-03 11:50:32 +020061#define OSMO_GSUP_MAX_CALLED_PARTY_BCD_LEN 43 /* TS 24.008 10.5.4.7 */
Harald Welte3b6fb082016-04-25 18:46:22 +020062
63#define OSMO_GSUP_PDP_TYPE_SIZE 2
64
65/*! Information Element Identifiers for GSUP IEs */
66enum osmo_gsup_iei {
67 OSMO_GSUP_IMSI_IE = 0x01,
68 OSMO_GSUP_CAUSE_IE = 0x02,
69 OSMO_GSUP_AUTH_TUPLE_IE = 0x03,
70 OSMO_GSUP_PDP_INFO_COMPL_IE = 0x04,
71 OSMO_GSUP_PDP_INFO_IE = 0x05,
72 OSMO_GSUP_CANCEL_TYPE_IE = 0x06,
73 OSMO_GSUP_FREEZE_PTMSI_IE = 0x07,
74 OSMO_GSUP_MSISDN_IE = 0x08,
75 OSMO_GSUP_HLR_NUMBER_IE = 0x09,
Pau Espin Pedrol8dfdfc32024-01-18 16:32:35 +010076 OSMO_GSUP_MESSAGE_CLASS_IE = 0x0a,
Harald Welte3b6fb082016-04-25 18:46:22 +020077 OSMO_GSUP_PDP_CONTEXT_ID_IE = 0x10,
78 OSMO_GSUP_PDP_TYPE_IE = 0x11,
79 OSMO_GSUP_ACCESS_POINT_NAME_IE = 0x12,
80 OSMO_GSUP_PDP_QOS_IE = 0x13,
Holger Hans Peter Freythereb55c0d2017-07-07 16:53:30 +020081 OSMO_GSUP_CHARG_CHAR_IE = 0x14,
Harald Welte3b6fb082016-04-25 18:46:22 +020082 OSMO_GSUP_RAND_IE = 0x20,
83 OSMO_GSUP_SRES_IE = 0x21,
84 OSMO_GSUP_KC_IE = 0x22,
85 /* 3G support */
86 OSMO_GSUP_IK_IE = 0x23,
87 OSMO_GSUP_CK_IE = 0x24,
88 OSMO_GSUP_AUTN_IE = 0x25,
89 OSMO_GSUP_AUTS_IE = 0x26,
90 OSMO_GSUP_RES_IE = 0x27,
Harald Welte48dc1a52016-05-05 18:46:42 +020091 OSMO_GSUP_CN_DOMAIN_IE = 0x28,
Neels Hofmeyr1b729ce2018-12-26 18:13:38 +010092 OSMO_GSUP_SUPPORTED_RAT_TYPES_IE = 0x29, /* supported RAT types */
93 OSMO_GSUP_CURRENT_RAT_TYPE_IE = 0x2a, /* currently used RAT type */
Vadim Yanitskiy72696042018-04-07 02:34:55 +070094
95 OSMO_GSUP_SESSION_ID_IE = 0x30,
96 OSMO_GSUP_SESSION_STATE_IE = 0x31,
Vadim Yanitskiy36c7b332018-03-31 05:23:09 +070097
98 /*! Supplementary Services payload */
99 OSMO_GSUP_SS_INFO_IE = 0x35,
Vadim Yanitskiyc2628312018-09-25 23:03:13 +0700100
101 /* SM related IEs (see 3GPP TS 29.002, section 7.6.8) */
102 OSMO_GSUP_SM_RP_MR_IE = 0x40,
103 OSMO_GSUP_SM_RP_DA_IE = 0x41,
104 OSMO_GSUP_SM_RP_OA_IE = 0x42,
105 OSMO_GSUP_SM_RP_UI_IE = 0x43,
106 OSMO_GSUP_SM_RP_CAUSE_IE = 0x44,
107 OSMO_GSUP_SM_RP_MMS_IE = 0x45,
Vadim Yanitskiyf9ee8da2018-11-13 02:06:15 +0700108 OSMO_GSUP_SM_ALERT_RSN_IE = 0x46,
Oliver Smith19742402018-12-21 10:18:28 +0100109
Oliver Smith10db2812018-12-14 16:14:34 +0100110 OSMO_GSUP_IMEI_IE = 0x50,
111 OSMO_GSUP_IMEI_RESULT_IE = 0x51,
Harald Welte49ddef62019-08-16 12:22:29 +0200112 OSMO_GSUP_NUM_VECTORS_REQ_IE = 0x52,
Oliver Smith10db2812018-12-14 16:14:34 +0100113
Oliver Smithaffbb202019-02-01 11:35:10 +0100114 /* Inter-MSC handover related */
115 OSMO_GSUP_SOURCE_NAME_IE = 0x60,
116 OSMO_GSUP_DESTINATION_NAME_IE = 0x61,
117 OSMO_GSUP_AN_APDU_IE = 0x62,
118 OSMO_GSUP_CAUSE_RR_IE = 0x63,
119 OSMO_GSUP_CAUSE_BSSAP_IE = 0x64,
120 OSMO_GSUP_CAUSE_SM_IE = 0x65,
121
Oliver Smith19742402018-12-21 10:18:28 +0100122 _OSMO_GSUP_IEI_END_MARKER
Harald Welte3b6fb082016-04-25 18:46:22 +0200123};
124
Oliver Smithd6ff9c82019-02-01 15:21:25 +0100125/*! GSUP message type
126 * Make sure that new messages follow this scheme:
127 * .----------------------------.
128 * | Ending Bits | Category |
129 * |----------------------------|
130 * | 00 | Request |
131 * | 01 | Error |
132 * | 10 | Result |
133 * | 11 | Other |
134 * '----------------------------'
135 * Request, Error and Result messages must only differ in these last two bits.
136 */
Harald Welte3b6fb082016-04-25 18:46:22 +0200137enum osmo_gsup_message_type {
138 OSMO_GSUP_MSGT_UPDATE_LOCATION_REQUEST = 0b00000100,
139 OSMO_GSUP_MSGT_UPDATE_LOCATION_ERROR = 0b00000101,
140 OSMO_GSUP_MSGT_UPDATE_LOCATION_RESULT = 0b00000110,
141
142 OSMO_GSUP_MSGT_SEND_AUTH_INFO_REQUEST = 0b00001000,
143 OSMO_GSUP_MSGT_SEND_AUTH_INFO_ERROR = 0b00001001,
144 OSMO_GSUP_MSGT_SEND_AUTH_INFO_RESULT = 0b00001010,
145
Harald Weltede960cb2016-06-16 22:57:09 +0200146 OSMO_GSUP_MSGT_AUTH_FAIL_REPORT = 0b00001011,
147
Harald Welte3b6fb082016-04-25 18:46:22 +0200148 OSMO_GSUP_MSGT_PURGE_MS_REQUEST = 0b00001100,
149 OSMO_GSUP_MSGT_PURGE_MS_ERROR = 0b00001101,
150 OSMO_GSUP_MSGT_PURGE_MS_RESULT = 0b00001110,
151
152 OSMO_GSUP_MSGT_INSERT_DATA_REQUEST = 0b00010000,
153 OSMO_GSUP_MSGT_INSERT_DATA_ERROR = 0b00010001,
154 OSMO_GSUP_MSGT_INSERT_DATA_RESULT = 0b00010010,
155
156 OSMO_GSUP_MSGT_DELETE_DATA_REQUEST = 0b00010100,
157 OSMO_GSUP_MSGT_DELETE_DATA_ERROR = 0b00010101,
158 OSMO_GSUP_MSGT_DELETE_DATA_RESULT = 0b00010110,
159
160 OSMO_GSUP_MSGT_LOCATION_CANCEL_REQUEST = 0b00011100,
161 OSMO_GSUP_MSGT_LOCATION_CANCEL_ERROR = 0b00011101,
162 OSMO_GSUP_MSGT_LOCATION_CANCEL_RESULT = 0b00011110,
Vadim Yanitskiy36c7b332018-03-31 05:23:09 +0700163
164 OSMO_GSUP_MSGT_PROC_SS_REQUEST = 0b00100000,
165 OSMO_GSUP_MSGT_PROC_SS_ERROR = 0b00100001,
166 OSMO_GSUP_MSGT_PROC_SS_RESULT = 0b00100010,
Vadim Yanitskiyc2628312018-09-25 23:03:13 +0700167
168 OSMO_GSUP_MSGT_MO_FORWARD_SM_REQUEST = 0b00100100,
169 OSMO_GSUP_MSGT_MO_FORWARD_SM_ERROR = 0b00100101,
170 OSMO_GSUP_MSGT_MO_FORWARD_SM_RESULT = 0b00100110,
171
172 OSMO_GSUP_MSGT_MT_FORWARD_SM_REQUEST = 0b00101000,
173 OSMO_GSUP_MSGT_MT_FORWARD_SM_ERROR = 0b00101001,
174 OSMO_GSUP_MSGT_MT_FORWARD_SM_RESULT = 0b00101010,
Vadim Yanitskiyf9ee8da2018-11-13 02:06:15 +0700175
176 OSMO_GSUP_MSGT_READY_FOR_SM_REQUEST = 0b00101100,
177 OSMO_GSUP_MSGT_READY_FOR_SM_ERROR = 0b00101101,
178 OSMO_GSUP_MSGT_READY_FOR_SM_RESULT = 0b00101110,
Oliver Smith10db2812018-12-14 16:14:34 +0100179
180 OSMO_GSUP_MSGT_CHECK_IMEI_REQUEST = 0b00110000,
181 OSMO_GSUP_MSGT_CHECK_IMEI_ERROR = 0b00110001,
182 OSMO_GSUP_MSGT_CHECK_IMEI_RESULT = 0b00110010,
Oliver Smithaffbb202019-02-01 11:35:10 +0100183
184 OSMO_GSUP_MSGT_E_PREPARE_HANDOVER_REQUEST = 0b00110100,
185 OSMO_GSUP_MSGT_E_PREPARE_HANDOVER_ERROR = 0b00110101,
186 OSMO_GSUP_MSGT_E_PREPARE_HANDOVER_RESULT = 0b00110110,
187
188 OSMO_GSUP_MSGT_E_PREPARE_SUBSEQUENT_HANDOVER_REQUEST = 0b00111000,
189 OSMO_GSUP_MSGT_E_PREPARE_SUBSEQUENT_HANDOVER_ERROR = 0b00111001,
190 OSMO_GSUP_MSGT_E_PREPARE_SUBSEQUENT_HANDOVER_RESULT = 0b00111010,
191
192 OSMO_GSUP_MSGT_E_SEND_END_SIGNAL_REQUEST = 0b00111100,
193 OSMO_GSUP_MSGT_E_SEND_END_SIGNAL_ERROR = 0b00111101,
194 OSMO_GSUP_MSGT_E_SEND_END_SIGNAL_RESULT = 0b00111110,
195
196 OSMO_GSUP_MSGT_E_PROCESS_ACCESS_SIGNALLING_REQUEST = 0b01000000,
197 OSMO_GSUP_MSGT_E_FORWARD_ACCESS_SIGNALLING_REQUEST = 0b01000100,
198
199 OSMO_GSUP_MSGT_E_CLOSE = 0b01000111,
200 OSMO_GSUP_MSGT_E_ABORT = 0b01001011,
201
Neels Hofmeyr249e0052019-11-20 21:28:47 +0100202 OSMO_GSUP_MSGT_ROUTING_ERROR = 0b01001110,
Alexander Couzens505f7052023-03-07 16:01:52 +0100203
204 OSMO_GSUP_MSGT_EPDG_TUNNEL_REQUEST = 0b01010000,
205 OSMO_GSUP_MSGT_EPDG_TUNNEL_ERROR = 0b01010001,
206 OSMO_GSUP_MSGT_EPDG_TUNNEL_RESULT = 0b01010010,
Harald Welte3b6fb082016-04-25 18:46:22 +0200207};
208
Neels Hofmeyr249e0052019-11-20 21:28:47 +0100209#define OSMO_GSUP_MSGT_E_ROUTING_ERROR OSMO_GSUP_MSGT_ROUTING_ERROR
210
Harald Welte3b6fb082016-04-25 18:46:22 +0200211#define OSMO_GSUP_IS_MSGT_REQUEST(msgt) (((msgt) & 0b00000011) == 0b00)
212#define OSMO_GSUP_IS_MSGT_ERROR(msgt) (((msgt) & 0b00000011) == 0b01)
Neels Hofmeyr15364232019-11-07 08:25:24 +0100213#define OSMO_GSUP_IS_MSGT_RESULT(msgt) (((msgt) & 0b00000011) == 0b10)
214#define OSMO_GSUP_TO_MSGT_REQUEST(msgt) (((msgt) & 0b11111100))
Harald Welte3b6fb082016-04-25 18:46:22 +0200215#define OSMO_GSUP_TO_MSGT_ERROR(msgt) (((msgt) & 0b11111100) | 0b01)
Neels Hofmeyr15364232019-11-07 08:25:24 +0100216#define OSMO_GSUP_TO_MSGT_RESULT(msgt) (((msgt) & 0b11111100) | 0b10)
Harald Welte3b6fb082016-04-25 18:46:22 +0200217
Neels Hofmeyr10f5fb42017-02-09 02:09:09 +0100218extern const struct value_string osmo_gsup_message_type_names[];
219static inline const char *
220osmo_gsup_message_type_name(enum osmo_gsup_message_type val)
221{ return get_value_string(osmo_gsup_message_type_names, val); }
222
Harald Welte3b6fb082016-04-25 18:46:22 +0200223enum osmo_gsup_cancel_type {
224 OSMO_GSUP_CANCEL_TYPE_UPDATE = 1, /* on wire: 0 */
225 OSMO_GSUP_CANCEL_TYPE_WITHDRAW = 2, /* on wire: 1 */
226};
227
Harald Welte48dc1a52016-05-05 18:46:42 +0200228enum osmo_gsup_cn_domain {
229 OSMO_GSUP_CN_DOMAIN_PS = 1,
230 OSMO_GSUP_CN_DOMAIN_CS = 2,
231};
232
Oliver Smith10db2812018-12-14 16:14:34 +0100233enum osmo_gsup_imei_result {
Oliver Smithd621a1e2019-01-08 16:22:30 +0100234 OSMO_GSUP_IMEI_RESULT_ACK = 1, /* on wire: 0 */
235 OSMO_GSUP_IMEI_RESULT_NACK = 2, /* on wire: 1 */
Oliver Smith10db2812018-12-14 16:14:34 +0100236};
237
Oliver Smithaffbb202019-02-01 11:35:10 +0100238/* 3GPP 29.002 AccessNetworkProtocolId */
239enum osmo_gsup_access_network_protocol {
240 OSMO_GSUP_ACCESS_NETWORK_PROTOCOL_TS3G_48006 = 1,
241 OSMO_GSUP_ACCESS_NETWORK_PROTOCOL_TS3G_25413 = 2,
242};
243
Vadim Yanitskiy72696042018-04-07 02:34:55 +0700244/*! TCAP-like session state */
245enum osmo_gsup_session_state {
246 /*! Undefined session state */
247 OSMO_GSUP_SESSION_STATE_NONE = 0x00,
248 /*! Initiation of a new session */
249 OSMO_GSUP_SESSION_STATE_BEGIN = 0x01,
250 /*! Communication of an existing session */
251 OSMO_GSUP_SESSION_STATE_CONTINUE = 0x02,
252 /*! Indication of the session end */
253 OSMO_GSUP_SESSION_STATE_END = 0x03,
254};
255
Harald Welte6a6a6092018-06-16 11:10:12 +0200256extern const struct value_string osmo_gsup_session_state_names[];
257static inline const char *
258osmo_gsup_session_state_name(enum osmo_gsup_session_state val)
259{ return get_value_string(osmo_gsup_session_state_names, val); }
260
Harald Welte3b6fb082016-04-25 18:46:22 +0200261/*! parsed/decoded PDP context information */
262struct osmo_gsup_pdp_info {
263 unsigned int context_id;
264 int have_info;
Pau Espin Pedrol68a04df2024-01-19 18:03:59 +0100265 /*! Type of PDP context, 3GPP TS 29.060, 7.7.27 */
266 union {
267 uint16_t pdp_type OSMO_DEPRECATED("use pdp_type_org and pdp_type_nr instead");
268 struct {
269#if OSMO_IS_LITTLE_ENDIAN
270 uint8_t pdp_type_nr; /* enum gsm48_pdp_type_nr */
271 uint8_t pdp_type_org; /* enum gsm48_pdp_type_org */
272#elif OSMO_IS_BIG_ENDIAN
273 uint8_t pdp_type_org; /* enum gsm48_pdp_type_org */
274 uint8_t pdp_type_nr; /* enum gsm48_pdp_type_nr */
275#endif
276 };
277 };
Harald Welte3b6fb082016-04-25 18:46:22 +0200278 /*! APN information, still in encoded form. Can be NULL if no
279 * APN information included */
280 const uint8_t *apn_enc;
281 /*! length (in octets) of apn_enc */
282 size_t apn_enc_len;
283 /*! QoS information, still in encoded form. Can be NULL if no
284 * QoS information included */
285 const uint8_t *qos_enc;
286 /*! length (in octets) of qos_enc */
287 size_t qos_enc_len;
Holger Hans Peter Freythereb55c0d2017-07-07 16:53:30 +0200288 /*! PDP Charging Characteristics, still in encoded form. Can be NULL if no
289 * PDP Charging Characteristics */
290 const uint8_t *pdp_charg_enc;
291 /*! length (in octets) of pdp_charg_enc */
292 size_t pdp_charg_enc_len;
Harald Welte3b6fb082016-04-25 18:46:22 +0200293};
294
Neels Hofmeyr9838c902019-04-01 22:24:33 +0200295enum osmo_gsup_message_class {
296 OSMO_GSUP_MESSAGE_CLASS_UNSET = 0,
297 OSMO_GSUP_MESSAGE_CLASS_SUBSCRIBER_MANAGEMENT = 1,
298 OSMO_GSUP_MESSAGE_CLASS_SMS = 2,
299 OSMO_GSUP_MESSAGE_CLASS_USSD = 3,
300 OSMO_GSUP_MESSAGE_CLASS_INTER_MSC = 4,
Alexander Couzens505f7052023-03-07 16:01:52 +0100301 OSMO_GSUP_MESSAGE_CLASS_IPSEC_EPDG = 5,
Neels Hofmeyr9838c902019-04-01 22:24:33 +0200302 /* Keep this as last entry with a value of max(enum osmo_gsup_message_class) + 1.
303 * This value shall serve as the size for an array to aid de-muxing all known GSUP classes. */
304 OSMO_GSUP_MESSAGE_CLASS_ARRAYSIZE
305};
306
307extern const struct value_string osmo_gsup_message_class_names[];
308static inline const char *osmo_gsup_message_class_name(enum osmo_gsup_message_class val)
309{ return get_value_string(osmo_gsup_message_class_names, val); }
310
Oliver Smithaffbb202019-02-01 11:35:10 +0100311/*! AccessNetworkSignalInfo as in 3GPP TS 29.002. */
312struct osmo_gsup_an_apdu {
313 /* AccessNetworkProtocolId as in 3GPP TS 29.002. */
314 enum osmo_gsup_access_network_protocol access_network_proto;
315 const uint8_t *data;
316 size_t data_len;
317};
318
Harald Welte3b6fb082016-04-25 18:46:22 +0200319/*! parsed/decoded GSUP protocol message */
320struct osmo_gsup_message {
321 enum osmo_gsup_message_type message_type;
Neels Hofmeyr0ee798a2019-04-10 19:13:19 +0200322 char imsi[OSMO_IMSI_BUF_SIZE];
Harald Welte3b6fb082016-04-25 18:46:22 +0200323 enum gsm48_gmm_cause cause;
324 enum osmo_gsup_cancel_type cancel_type;
325 int pdp_info_compl;
326 int freeze_ptmsi;
327 struct osmo_auth_vector auth_vectors[OSMO_GSUP_MAX_NUM_AUTH_INFO];
328 size_t num_auth_vectors;
329 struct osmo_gsup_pdp_info pdp_infos[OSMO_GSUP_MAX_NUM_PDP_INFO];
330 size_t num_pdp_infos;
331 const uint8_t *msisdn_enc;
332 size_t msisdn_enc_len;
333 const uint8_t *hlr_enc;
334 size_t hlr_enc_len;
335 const uint8_t *auts;
Harald Welte766da862016-05-06 11:18:15 +0200336 const uint8_t *rand;
Harald Welte48dc1a52016-05-05 18:46:42 +0200337 enum osmo_gsup_cn_domain cn_domain;
Holger Hans Peter Freythereb55c0d2017-07-07 16:53:30 +0200338 const uint8_t *pdp_charg_enc;
339 size_t pdp_charg_enc_len;
Vadim Yanitskiy72696042018-04-07 02:34:55 +0700340
341 /*! Session state \ref osmo_gsup_session_state */
342 enum osmo_gsup_session_state session_state;
343 /*! Unique session identifier and origination flag.
Vadim Yanitskiy5a7b4652018-11-06 18:24:49 +0700344 * Encoded only when \ref session_state != 0x00 */
Vadim Yanitskiy72696042018-04-07 02:34:55 +0700345 uint32_t session_id;
Vadim Yanitskiy36c7b332018-03-31 05:23:09 +0700346
347 /*! ASN.1 encoded MAP payload for Supplementary Services */
348 uint8_t *ss_info;
349 size_t ss_info_len;
Vadim Yanitskiyc2628312018-09-25 23:03:13 +0700350
351 /*! SM-RP-MR (see 3GPP TS 29.002, 7.6.1.1), Message Reference.
352 * Please note that there is no SM-RP-MR in TCAP/MAP! SM-RP-MR
353 * is usually mapped to TCAP's InvokeID, but we don't need it. */
354 const uint8_t *sm_rp_mr;
355 /*! SM-RP-DA (see 3GPP TS 29.002, 7.6.8.1), Destination Address */
356 enum osmo_gsup_sms_sm_rp_oda_t sm_rp_da_type;
357 size_t sm_rp_da_len;
358 const uint8_t *sm_rp_da;
359 /*! SM-RP-OA (see 3GPP TS 29.002, 7.6.8.2), Originating Address */
360 enum osmo_gsup_sms_sm_rp_oda_t sm_rp_oa_type;
361 size_t sm_rp_oa_len;
362 const uint8_t *sm_rp_oa;
363 /*! SM-RP-UI (see 3GPP TS 29.002, 7.6.8.4), SMS TPDU */
364 const uint8_t *sm_rp_ui;
365 size_t sm_rp_ui_len;
366 /*! SM-RP-Cause value (1 oct.) as per GSM TS 04.11, section 8.2.5.4 */
367 const uint8_t *sm_rp_cause;
368 /*! SM-RP-MMS (More Messages to Send), section 7.6.8.7 */
369 const uint8_t *sm_rp_mms;
Vadim Yanitskiyf9ee8da2018-11-13 02:06:15 +0700370 /*! Alert reason (see 3GPP TS 29.002, 7.6.8.8) */
371 enum osmo_gsup_sms_sm_alert_rsn_t sm_alert_rsn;
Oliver Smith10db2812018-12-14 16:14:34 +0100372
373 const uint8_t *imei_enc;
374 size_t imei_enc_len;
375 enum osmo_gsup_imei_result imei_result;
Neels Hofmeyr9838c902019-04-01 22:24:33 +0200376
377 /*! Indicate the message class to trivially dispatch incoming GSUP messages to the right code paths.
Oliver Smithe0c5d702019-05-16 14:55:04 +0200378 * Inter-MSC messages are *required* to set a class = OSMO_GSUP_MESSAGE_CLASS_INTER_MSC. For older message
379 * classes, this may be omitted (for backwards compatibility only -- if in doubt, include it). */
Neels Hofmeyr9838c902019-04-01 22:24:33 +0200380 enum osmo_gsup_message_class message_class;
Oliver Smithaffbb202019-02-01 11:35:10 +0100381
382 /*! For messages routed via another GSUP entity (via HLR), the IPA name of the entity that sent this message. */
383 const uint8_t *source_name;
384 /*! Number of bytes in source_name. */
385 size_t source_name_len;
386 /*! For messages routed via another GSUP entity (via HLR), the IPA name of the entity that should ultimately
387 * receive this message. */
388 const uint8_t *destination_name;
389 /*! Number of bytes in destination_name. */
390 size_t destination_name_len;
391
392 /*! inter-MSC AN-APDU. */
393 struct osmo_gsup_an_apdu an_apdu;
394
395 uint8_t cause_rr; /*!< 0 is a valid cause */
396 bool cause_rr_set; /*!< whether cause_rr is set */
397
398 enum gsm0808_cause cause_bssap; /*!< 0 is a valid cause */
399 bool cause_bssap_set; /*!< whether cause_bssap is set */
400
401 /*! Session Management cause as of 3GPP TS 24.008 10.5.6.6 / Table 10.5.157. */
402 enum gsm48_gsm_cause cause_sm;
Neels Hofmeyr1b729ce2018-12-26 18:13:38 +0100403
404 enum osmo_rat_type current_rat_type;
405 enum osmo_rat_type supported_rat_types[8]; /*!< arbitrary choice */
406 size_t supported_rat_types_len;
Harald Welte3b6fb082016-04-25 18:46:22 +0200407};
408
409int osmo_gsup_decode(const uint8_t *data, size_t data_len,
410 struct osmo_gsup_message *gsup_msg);
Max80f4c4e2018-01-24 12:33:05 +0100411int osmo_gsup_encode(struct msgb *msg, const struct osmo_gsup_message *gsup_msg);
Oliver Smithd6ff9c82019-02-01 15:21:25 +0100412int osmo_gsup_get_err_msg_type(enum osmo_gsup_message_type type_in)
413 OSMO_DEPRECATED("Use OSMO_GSUP_TO_MSGT_ERROR() instead");
Harald Welte381a1aa2017-10-16 18:31:20 +0200414
415/*! @} */