libosmogsm  1.0.1.85-9f28
Osmocom GSM library
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
gsup.h
Go to the documentation of this file.
1 
18 /*
19  * (C) 2014 by sysmocom - s.f.m.c. GmbH, Author: Jacob Erlbeck
20  * (C) 2016 by Harald Welte <laforge@gnumonks.org>
21  * All Rights Reserved
22  *
23  * SPDX-License-Identifier: GPL-2.0+
24  *
25  * 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>
43 #include <osmocom/gsm/gsup_sms.h>
46 #include <osmocom/crypt/auth.h>
47 
48 #define OSMO_GSUP_PORT 4222
49 
51 #define OSMO_GSUP_MAX_NUM_PDP_INFO 10 /* GSM 09.02 limits this to 50 */
52 
53 #define OSMO_GSUP_MAX_NUM_AUTH_INFO 5
54 
55 #define OSMO_GSUP_MAX_MSISDN_LEN 9
56 #define OSMO_GSUP_MAX_CALLED_PARTY_BCD_LEN 43 /* TS 24.008 10.5.4.7 */
57 
58 #define OSMO_GSUP_PDP_TYPE_SIZE 2
59 
79  /* 3G support */
86 
89 
92 
93  /* SM related IEs (see 3GPP TS 29.002, section 7.6.8) */
101 
104 
106 };
107 
124 
128 
130 
134 
138 
142 
146 
150 
154 
158 
162 
166 };
167 
168 #define OSMO_GSUP_IS_MSGT_REQUEST(msgt) (((msgt) & 0b00000011) == 0b00)
169 #define OSMO_GSUP_IS_MSGT_ERROR(msgt) (((msgt) & 0b00000011) == 0b01)
170 #define OSMO_GSUP_TO_MSGT_ERROR(msgt) (((msgt) & 0b11111100) | 0b01)
171 
172 extern const struct value_string osmo_gsup_message_type_names[];
173 static inline const char *
176 
178  OSMO_GSUP_CANCEL_TYPE_UPDATE = 1, /* on wire: 0 */
179  OSMO_GSUP_CANCEL_TYPE_WITHDRAW = 2, /* on wire: 1 */
180 };
181 
185 };
186 
188  OSMO_GSUP_IMEI_RESULT_ACK = 1, /* on wire: 0 */
189  OSMO_GSUP_IMEI_RESULT_NACK = 2, /* on wire: 1 */
190 };
191 
202 };
203 
204 extern const struct value_string osmo_gsup_session_state_names[];
205 static inline const char *
208 
211  unsigned int context_id;
214  uint16_t pdp_type;
217  const uint8_t *apn_enc;
219  size_t apn_enc_len;
222  const uint8_t *qos_enc;
224  size_t qos_enc_len;
227  const uint8_t *pdp_charg_enc;
230 };
231 
244  const uint8_t *msisdn_enc;
246  const uint8_t *hlr_enc;
247  size_t hlr_enc_len;
248  const uint8_t *auts;
249  const uint8_t *rand;
251  const uint8_t *pdp_charg_enc;
253 
258  uint32_t session_id;
259 
261  uint8_t *ss_info;
262  size_t ss_info_len;
263 
267  const uint8_t *sm_rp_mr;
270  size_t sm_rp_da_len;
271  const uint8_t *sm_rp_da;
274  size_t sm_rp_oa_len;
275  const uint8_t *sm_rp_oa;
277  const uint8_t *sm_rp_ui;
278  size_t sm_rp_ui_len;
280  const uint8_t *sm_rp_cause;
282  const uint8_t *sm_rp_mms;
285 
286  const uint8_t *imei_enc;
287  size_t imei_enc_len;
289 };
290 
291 int osmo_gsup_decode(const uint8_t *data, size_t data_len,
292  struct osmo_gsup_message *gsup_msg);
293 int osmo_gsup_encode(struct msgb *msg, const struct osmo_gsup_message *gsup_msg);
295  OSMO_DEPRECATED("Use OSMO_GSUP_TO_MSGT_ERROR() instead");
296 
osmo_gsup_cancel_type
Definition: gsup.h:177
const uint8_t * auts
Definition: gsup.h:248
Definition: gsup.h:137
enum osmo_gsup_sms_sm_rp_oda_t sm_rp_da_type
SM-RP-DA (see 3GPP TS 29.002, 7.6.8.1), Destination Address.
Definition: gsup.h:269
Definition: gsup.h:97
Definition: gsup.h:78
size_t sm_rp_oa_len
Definition: gsup.h:274
Definition: gsup.h:178
Indication of the session end.
Definition: gsup.h:201
Definition: gsup.h:105
enum osmo_gsup_sms_sm_alert_rsn_t sm_alert_rsn
Alert reason (see 3GPP TS 29.002, 7.6.8.8)
Definition: gsup.h:284
#define OSMO_DEPRECATED(text)
Definition: gsup.h:184
const struct value_string osmo_gsup_message_type_names[]
Definition: gsup.c:39
const char * get_value_string(const struct value_string *vs, uint32_t val)
#define GSM23003_IMSI_MAX_DIGITS
Definition: gsm_23_003.h:6
Definition: gsup.h:98
Definition: gsup.h:63
Definition: gsup.h:70
Definition: gsup.h:62
const uint8_t * sm_rp_mms
SM-RP-MMS (More Messages to Send), section 7.6.8.7.
Definition: gsup.h:282
Definition: gsup.h:189
size_t num_pdp_infos
Definition: gsup.h:243
#define OSMO_GSUP_MAX_NUM_AUTH_INFO
Maximum number of auth info inside osmo_gsup_message.
Definition: gsup.h:53
uint16_t pdp_type
Type of PDP context.
Definition: gsup.h:214
Definition: gsup.h:76
const uint8_t * pdp_charg_enc
Definition: gsup.h:251
struct osmo_gsup_pdp_info pdp_infos[OSMO_GSUP_MAX_NUM_PDP_INFO]
Definition: gsup.h:242
int freeze_ptmsi
Definition: gsup.h:239
Definition: gsup.h:64
Definition: gsup.h:88
const uint8_t * sm_rp_oa
Definition: gsup.h:275
int have_info
Definition: gsup.h:212
enum gsm48_gmm_cause cause
Definition: gsup.h:236
int pdp_info_compl
Definition: gsup.h:238
Definition: gsup.h:83
const uint8_t * msisdn_enc
Definition: gsup.h:244
size_t hlr_enc_len
Definition: gsup.h:247
Initiation of a new session.
Definition: gsup.h:197
size_t ss_info_len
Definition: gsup.h:262
char imsi[GSM23003_IMSI_MAX_DIGITS+2]
Definition: gsup.h:235
const uint8_t * sm_rp_da
Definition: gsup.h:271
osmo_gsup_sms_sm_rp_oda_t
Possible identity types for SM-RP-{OA|DA}.
Definition: gsup_sms.h:16
unsigned int context_id
Definition: gsup.h:211
osmo_gsup_session_state
TCAP-like session state.
Definition: gsup.h:193
size_t sm_rp_ui_len
Definition: gsup.h:278
osmo_gsup_message_type
GSUP message type Make sure that new messages follow this scheme:
Definition: gsup.h:120
Definition: gsup.h:131
Definition: gsup.h:85
Definition: gsup.h:129
const uint8_t * sm_rp_cause
SM-RP-Cause value (1 oct.) as per GSM TS 04.11, section 8.2.5.4.
Definition: gsup.h:280
static const char * osmo_gsup_message_type_name(enum osmo_gsup_message_type val)
Definition: gsup.h:174
Definition: gsup.h:77
Definition: gsup.h:72
osmo_gsup_iei
Information Element Identifiers for GSUP IEs.
Definition: gsup.h:61
Definition: gsup.h:164
Definition: gsup.h:160
Definition: gsup.h:141
const uint8_t * hlr_enc
Definition: gsup.h:246
Definition: gsup.h:147
Definition: gsup.h:87
uint8_t * ss_info
ASN.1 encoded MAP payload for Supplementary Services.
Definition: gsup.h:261
size_t msisdn_enc_len
Definition: gsup.h:245
Definition: gsup.h:165
Definition: gsup.h:179
uint8_t data[0]
Definition: gsup.h:69
size_t qos_enc_len
length (in octets) of qos_enc
Definition: gsup.h:224
struct osmo_auth_vector auth_vectors[OSMO_GSUP_MAX_NUM_AUTH_INFO]
Definition: gsup.h:240
int osmo_gsup_decode(const uint8_t *data, size_t data_len, struct osmo_gsup_message *gsup_msg)
Decode (parse) a GSUP message.
Definition: gsup.c:256
Definition: gsup.h:71
Definition: gsup.h:68
enum osmo_gsup_cn_domain cn_domain
Definition: gsup.h:250
uint32_t session_id
Unique session identifier and origination flag.
Definition: gsup.h:258
Supplementary Services payload.
Definition: gsup.h:91
Definition: gsup.h:149
#define OSMO_GSUP_MAX_NUM_PDP_INFO
Maximum nubmer of PDP inside osmo_gsup_message.
Definition: gsup.h:51
Definition: gsup.h:75
parsed/decoded PDP context information
Definition: gsup.h:210
Definition: gsup.h:67
size_t pdp_charg_enc_len
Definition: gsup.h:252
gsm48_gmm_cause
Definition: gsm_04_08_gprs.h:206
Definition: gsup.h:65
const struct value_string osmo_gsup_session_state_names[]
Definition: gsup.c:89
enum osmo_gsup_sms_sm_rp_oda_t sm_rp_oa_type
SM-RP-OA (see 3GPP TS 29.002, 7.6.8.2), Originating Address.
Definition: gsup.h:273
Definition: gsup.h:140
const uint8_t * sm_rp_ui
SM-RP-UI (see 3GPP TS 29.002, 7.6.8.4), SMS TPDU.
Definition: gsup.h:277
Definition: gsup.h:96
static const char * osmo_gsup_session_state_name(enum osmo_gsup_session_state val)
Definition: gsup.h:206
Definition: gsup.h:188
Definition: gsup.h:94
Definition: gsup.h:132
Definition: gsup.h:163
parsed/decoded GSUP protocol message
Definition: gsup.h:233
Definition: gsup.h:100
const uint8_t * apn_enc
APN information, still in encoded form.
Definition: gsup.h:217
size_t pdp_charg_enc_len
length (in octets) of pdp_charg_enc
Definition: gsup.h:229
Definition: gsup.h:81
enum osmo_gsup_session_state session_state
Session state osmo_gsup_session_state.
Definition: gsup.h:255
Definition: gsup.h:183
Definition: gsup.h:103
Definition: gsup.h:66
const uint8_t * pdp_charg_enc
PDP Charging Characteristics, still in encoded form.
Definition: gsup.h:227
size_t sm_rp_da_len
Definition: gsup.h:270
const uint8_t * rand
Definition: gsup.h:249
Definition: gsup.h:148
Definition: gsup.h:84
Definition: gsup.h:80
enum osmo_gsup_cancel_type cancel_type
Definition: gsup.h:237
int osmo_gsup_encode(struct msgb *msg, const struct osmo_gsup_message *gsup_msg)
Encode a GSUP message.
Definition: gsup.c:572
const uint8_t * imei_enc
Definition: gsup.h:286
Definition: gsup.h:136
const uint8_t * qos_enc
QoS information, still in encoded form.
Definition: gsup.h:222
Definition: gsup.h:82
Definition: gsup.h:74
const uint8_t * sm_rp_mr
SM-RP-MR (see 3GPP TS 29.002, 7.6.1.1), Message Reference.
Definition: gsup.h:267
Definition: gsup.h:73
Undefined session state.
Definition: gsup.h:195
Definition: gsup.h:133
size_t imei_enc_len
Definition: gsup.h:287
size_t apn_enc_len
length (in octets) of apn_enc
Definition: gsup.h:219
Definition: gsup.h:95
osmo_gsup_imei_result
Definition: gsup.h:187
Communication of an existing session.
Definition: gsup.h:199
Definition: auth.h:60
Definition: gsup.h:99
Definition: gsup.h:102
int osmo_gsup_get_err_msg_type(enum osmo_gsup_message_type type_in) OSMO_DEPRECATED("Use OSMO_GSUP_TO_MSGT_ERROR() instead")
return the error message type corresponding to type_in.
Definition: gsup.c:100
enum osmo_gsup_imei_result imei_result
Definition: gsup.h:288
enum osmo_gsup_message_type message_type
Definition: gsup.h:234
SMS (Short Message Service) extensions for Osmocom GSUP.
osmo_gsup_sms_sm_alert_rsn_t
Alert reason values, see 7.6.8.8.
Definition: gsup_sms.h:26
osmo_gsup_cn_domain
Definition: gsup.h:182
size_t num_auth_vectors
Definition: gsup.h:241