gsup.h
Go to the documentation of this file.
/*
* (C) 2014 by sysmocom - s.f.m.c. GmbH, Author: Jacob Erlbeck
* (C) 2016 by Harald Welte <laforge@gnumonks.org>
* All Rights Reserved
*
* SPDX-License-Identifier: GPL-2.0+
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
#pragma once
#include <stdint.h>
#include <osmocom/core/msgb.h>
#include <osmocom/gsm/protocol/gsm_23_003.h>
#include <osmocom/gsm/protocol/gsm_04_08_gprs.h>
#include <osmocom/crypt/auth.h>
#define OSMO_GSUP_PORT 4222
#define OSMO_GSUP_MAX_NUM_PDP_INFO 10 /* GSM 09.02 limits this to 50 */
#define OSMO_GSUP_MAX_NUM_AUTH_INFO 5
#define OSMO_GSUP_MAX_MSISDN_LEN 9
#define OSMO_GSUP_MAX_CALLED_PARTY_BCD_LEN 43 /* TS 24.008 10.5.4.7 */
#define OSMO_GSUP_PDP_TYPE_SIZE 2
enum osmo_gsup_iei {
OSMO_GSUP_IMSI_IE = 0x01,
OSMO_GSUP_CAUSE_IE = 0x02,
OSMO_GSUP_AUTH_TUPLE_IE = 0x03,
OSMO_GSUP_PDP_INFO_COMPL_IE = 0x04,
OSMO_GSUP_PDP_INFO_IE = 0x05,
OSMO_GSUP_CANCEL_TYPE_IE = 0x06,
OSMO_GSUP_FREEZE_PTMSI_IE = 0x07,
OSMO_GSUP_MSISDN_IE = 0x08,
OSMO_GSUP_HLR_NUMBER_IE = 0x09,
OSMO_GSUP_PDP_CONTEXT_ID_IE = 0x10,
OSMO_GSUP_PDP_TYPE_IE = 0x11,
OSMO_GSUP_ACCESS_POINT_NAME_IE = 0x12,
OSMO_GSUP_PDP_QOS_IE = 0x13,
OSMO_GSUP_CHARG_CHAR_IE = 0x14,
OSMO_GSUP_RAND_IE = 0x20,
OSMO_GSUP_SRES_IE = 0x21,
OSMO_GSUP_KC_IE = 0x22,
/* 3G support */
OSMO_GSUP_IK_IE = 0x23,
OSMO_GSUP_CK_IE = 0x24,
OSMO_GSUP_AUTN_IE = 0x25,
OSMO_GSUP_AUTS_IE = 0x26,
OSMO_GSUP_RES_IE = 0x27,
OSMO_GSUP_CN_DOMAIN_IE = 0x28,
OSMO_GSUP_SESSION_ID_IE = 0x30,
OSMO_GSUP_SESSION_STATE_IE = 0x31,
OSMO_GSUP_SS_INFO_IE = 0x35,
};
enum osmo_gsup_message_type {
OSMO_GSUP_MSGT_UPDATE_LOCATION_REQUEST = 0b00000100,
OSMO_GSUP_MSGT_UPDATE_LOCATION_ERROR = 0b00000101,
OSMO_GSUP_MSGT_UPDATE_LOCATION_RESULT = 0b00000110,
OSMO_GSUP_MSGT_SEND_AUTH_INFO_REQUEST = 0b00001000,
OSMO_GSUP_MSGT_SEND_AUTH_INFO_ERROR = 0b00001001,
OSMO_GSUP_MSGT_SEND_AUTH_INFO_RESULT = 0b00001010,
OSMO_GSUP_MSGT_AUTH_FAIL_REPORT = 0b00001011,
OSMO_GSUP_MSGT_PURGE_MS_REQUEST = 0b00001100,
OSMO_GSUP_MSGT_PURGE_MS_ERROR = 0b00001101,
OSMO_GSUP_MSGT_PURGE_MS_RESULT = 0b00001110,
OSMO_GSUP_MSGT_INSERT_DATA_REQUEST = 0b00010000,
OSMO_GSUP_MSGT_INSERT_DATA_ERROR = 0b00010001,
OSMO_GSUP_MSGT_INSERT_DATA_RESULT = 0b00010010,
OSMO_GSUP_MSGT_DELETE_DATA_REQUEST = 0b00010100,
OSMO_GSUP_MSGT_DELETE_DATA_ERROR = 0b00010101,
OSMO_GSUP_MSGT_DELETE_DATA_RESULT = 0b00010110,
OSMO_GSUP_MSGT_LOCATION_CANCEL_REQUEST = 0b00011100,
OSMO_GSUP_MSGT_LOCATION_CANCEL_ERROR = 0b00011101,
OSMO_GSUP_MSGT_LOCATION_CANCEL_RESULT = 0b00011110,
OSMO_GSUP_MSGT_PROC_SS_REQUEST = 0b00100000,
OSMO_GSUP_MSGT_PROC_SS_ERROR = 0b00100001,
OSMO_GSUP_MSGT_PROC_SS_RESULT = 0b00100010,
};
#define OSMO_GSUP_IS_MSGT_REQUEST(msgt) (((msgt) & 0b00000011) == 0b00)
#define OSMO_GSUP_IS_MSGT_ERROR(msgt) (((msgt) & 0b00000011) == 0b01)
#define OSMO_GSUP_TO_MSGT_ERROR(msgt) (((msgt) & 0b11111100) | 0b01)
extern const struct value_string osmo_gsup_message_type_names[];
static inline const char *
osmo_gsup_message_type_name(enum osmo_gsup_message_type val)
{ return get_value_string(osmo_gsup_message_type_names, val); }
enum osmo_gsup_cancel_type {
OSMO_GSUP_CANCEL_TYPE_UPDATE = 1, /* on wire: 0 */
OSMO_GSUP_CANCEL_TYPE_WITHDRAW = 2, /* on wire: 1 */
};
enum osmo_gsup_cn_domain {
OSMO_GSUP_CN_DOMAIN_PS = 1,
OSMO_GSUP_CN_DOMAIN_CS = 2,
};
enum osmo_gsup_session_state {
OSMO_GSUP_SESSION_STATE_NONE = 0x00,
OSMO_GSUP_SESSION_STATE_BEGIN = 0x01,
OSMO_GSUP_SESSION_STATE_CONTINUE = 0x02,
OSMO_GSUP_SESSION_STATE_END = 0x03,
};
extern const struct value_string osmo_gsup_session_state_names[];
static inline const char *
osmo_gsup_session_state_name(enum osmo_gsup_session_state val)
{ return get_value_string(osmo_gsup_session_state_names, val); }
struct osmo_gsup_pdp_info {
unsigned int context_id;
int have_info;
uint16_t pdp_type;
const uint8_t *apn_enc;
size_t apn_enc_len;
const uint8_t *qos_enc;
size_t qos_enc_len;
const uint8_t *pdp_charg_enc;
size_t pdp_charg_enc_len;
};
struct osmo_gsup_message {
enum osmo_gsup_message_type message_type;
char imsi[GSM23003_IMSI_MAX_DIGITS+2];
enum gsm48_gmm_cause cause;
enum osmo_gsup_cancel_type cancel_type;
int pdp_info_compl;
int freeze_ptmsi;
struct osmo_auth_vector auth_vectors[OSMO_GSUP_MAX_NUM_AUTH_INFO];
size_t num_auth_vectors;
struct osmo_gsup_pdp_info pdp_infos[OSMO_GSUP_MAX_NUM_PDP_INFO];
size_t num_pdp_infos;
const uint8_t *msisdn_enc;
size_t msisdn_enc_len;
const uint8_t *hlr_enc;
size_t hlr_enc_len;
const uint8_t *auts;
const uint8_t *rand;
enum osmo_gsup_cn_domain cn_domain;
const uint8_t *pdp_charg_enc;
size_t pdp_charg_enc_len;
enum osmo_gsup_session_state session_state;
uint32_t session_id;
uint8_t *ss_info;
size_t ss_info_len;
};
int osmo_gsup_decode(const uint8_t *data, size_t data_len,
struct osmo_gsup_message *gsup_msg);
int osmo_gsup_encode(struct msgb *msg, const struct osmo_gsup_message *gsup_msg);
int osmo_gsup_get_err_msg_type(enum osmo_gsup_message_type type_in);
OSMO_GSUP_ACCESS_POINT_NAME_IE
@ OSMO_GSUP_ACCESS_POINT_NAME_IE
Definition: gsup.h:72
osmo_gsup_pdp_info::qos_enc_len
size_t qos_enc_len
length (in octets) of qos_enc
Definition: gsup.h:177
data
uint8_t data[0]
message payload data
Definition: gsm_03_41.h:34
OSMO_GSUP_AUTH_TUPLE_IE
@ OSMO_GSUP_AUTH_TUPLE_IE
Definition: gsup.h:63
osmo_gsup_message::cancel_type
enum osmo_gsup_cancel_type cancel_type
Definition: gsup.h:190
OSMO_GSUP_MSGT_PURGE_MS_RESULT
@ OSMO_GSUP_MSGT_PURGE_MS_RESULT
Definition: gsup.h:107
OSMO_GSUP_SESSION_STATE_NONE
@ OSMO_GSUP_SESSION_STATE_NONE
Undefined session state.
Definition: gsup.h:148
osmo_gsup_message::msisdn_enc_len
size_t msisdn_enc_len
Definition: gsup.h:198
OSMO_GSUP_IMSI_IE
@ OSMO_GSUP_IMSI_IE
Definition: gsup.h:61
osmo_gsup_session_state
osmo_gsup_session_state
TCAP-like session state.
Definition: gsup.h:146
OSMO_GSUP_SESSION_STATE_BEGIN
@ OSMO_GSUP_SESSION_STATE_BEGIN
Initiation of a new session.
Definition: gsup.h:150
OSMO_GSUP_MSGT_UPDATE_LOCATION_REQUEST
@ OSMO_GSUP_MSGT_UPDATE_LOCATION_REQUEST
Definition: gsup.h:95
OSMO_GSUP_MSGT_DELETE_DATA_REQUEST
@ OSMO_GSUP_MSGT_DELETE_DATA_REQUEST
Definition: gsup.h:113
OSMO_GSUP_MSGT_UPDATE_LOCATION_ERROR
@ OSMO_GSUP_MSGT_UPDATE_LOCATION_ERROR
Definition: gsup.h:96
OSMO_GSUP_SESSION_STATE_IE
@ OSMO_GSUP_SESSION_STATE_IE
Definition: gsup.h:87
OSMO_GSUP_MSGT_SEND_AUTH_INFO_REQUEST
@ OSMO_GSUP_MSGT_SEND_AUTH_INFO_REQUEST
Definition: gsup.h:99
OSMO_GSUP_MSGT_INSERT_DATA_RESULT
@ OSMO_GSUP_MSGT_INSERT_DATA_RESULT
Definition: gsup.h:111
OSMO_GSUP_CAUSE_IE
@ OSMO_GSUP_CAUSE_IE
Definition: gsup.h:62
OSMO_GSUP_HLR_NUMBER_IE
@ OSMO_GSUP_HLR_NUMBER_IE
Definition: gsup.h:69
gsm48_gmm_cause
gsm48_gmm_cause
Definition: gsm_04_08_gprs.h:197
OSMO_GSUP_RAND_IE
@ OSMO_GSUP_RAND_IE
Definition: gsup.h:75
OSMO_GSUP_SESSION_STATE_END
@ OSMO_GSUP_SESSION_STATE_END
Indication of the session end.
Definition: gsup.h:154
osmo_gsup_pdp_info::apn_enc
const uint8_t * apn_enc
APN information, still in encoded form.
Definition: gsup.h:170
OSMO_GSUP_CN_DOMAIN_IE
@ OSMO_GSUP_CN_DOMAIN_IE
Definition: gsup.h:84
osmo_gsup_pdp_info::pdp_charg_enc
const uint8_t * pdp_charg_enc
PDP Charging Characteristics, still in encoded form.
Definition: gsup.h:180
osmo_gsup_message::auts
const uint8_t * auts
Definition: gsup.h:201
osmo_gsup_cancel_type
osmo_gsup_cancel_type
Definition: gsup.h:135
osmo_gsup_message::auth_vectors
struct osmo_auth_vector auth_vectors[OSMO_GSUP_MAX_NUM_AUTH_INFO]
Definition: gsup.h:193
OSMO_GSUP_AUTS_IE
@ OSMO_GSUP_AUTS_IE
Definition: gsup.h:82
OSMO_GSUP_MSGT_DELETE_DATA_RESULT
@ OSMO_GSUP_MSGT_DELETE_DATA_RESULT
Definition: gsup.h:115
OSMO_GSUP_SESSION_ID_IE
@ OSMO_GSUP_SESSION_ID_IE
Definition: gsup.h:86
osmo_gsup_pdp_info::qos_enc
const uint8_t * qos_enc
QoS information, still in encoded form.
Definition: gsup.h:175
osmo_gsup_cn_domain
osmo_gsup_cn_domain
Definition: gsup.h:140
osmo_gsup_message::session_state
enum osmo_gsup_session_state session_state
Session state osmo_gsup_session_state.
Definition: gsup.h:208
osmo_gsup_pdp_info::pdp_charg_enc_len
size_t pdp_charg_enc_len
length (in octets) of pdp_charg_enc
Definition: gsup.h:182
osmo_gsup_encode
int osmo_gsup_encode(struct msgb *msg, const struct osmo_gsup_message *gsup_msg)
Encode a GSUP message.
Definition: gsup.c:529
osmo_gsup_message::hlr_enc_len
size_t hlr_enc_len
Definition: gsup.h:200
osmo_gsup_message::pdp_charg_enc
const uint8_t * pdp_charg_enc
Definition: gsup.h:204
OSMO_GSUP_PDP_TYPE_IE
@ OSMO_GSUP_PDP_TYPE_IE
Definition: gsup.h:71
GSM23003_IMSI_MAX_DIGITS
#define GSM23003_IMSI_MAX_DIGITS
Definition: gsm_23_003.h:6
osmo_gsup_message::pdp_infos
struct osmo_gsup_pdp_info pdp_infos[OSMO_GSUP_MAX_NUM_PDP_INFO]
Definition: gsup.h:195
osmo_gsup_pdp_info
parsed/decoded PDP context information
Definition: gsup.h:163
OSMO_GSUP_SRES_IE
@ OSMO_GSUP_SRES_IE
Definition: gsup.h:76
osmo_gsup_pdp_info::apn_enc_len
size_t apn_enc_len
length (in octets) of apn_enc
Definition: gsup.h:172
osmo_gsup_message_type
osmo_gsup_message_type
GSUP message type.
Definition: gsup.h:94
OSMO_GSUP_MSGT_LOCATION_CANCEL_ERROR
@ OSMO_GSUP_MSGT_LOCATION_CANCEL_ERROR
Definition: gsup.h:118
osmo_gsup_message::rand
const uint8_t * rand
Definition: gsup.h:202
OSMO_GSUP_MSGT_PROC_SS_REQUEST
@ OSMO_GSUP_MSGT_PROC_SS_REQUEST
Definition: gsup.h:121
OSMO_GSUP_MSGT_DELETE_DATA_ERROR
@ OSMO_GSUP_MSGT_DELETE_DATA_ERROR
Definition: gsup.h:114
osmo_auth_vector
Definition: auth.h:60
OSMO_GSUP_MSGT_SEND_AUTH_INFO_ERROR
@ OSMO_GSUP_MSGT_SEND_AUTH_INFO_ERROR
Definition: gsup.h:100
OSMO_GSUP_MSGT_PURGE_MS_REQUEST
@ OSMO_GSUP_MSGT_PURGE_MS_REQUEST
Definition: gsup.h:105
osmo_gsup_message::hlr_enc
const uint8_t * hlr_enc
Definition: gsup.h:199
osmo_gsup_message::ss_info
uint8_t * ss_info
ASN.1 encoded MAP payload for Supplementary Services.
Definition: gsup.h:214
OSMO_GSUP_MSGT_SEND_AUTH_INFO_RESULT
@ OSMO_GSUP_MSGT_SEND_AUTH_INFO_RESULT
Definition: gsup.h:101
OSMO_GSUP_CHARG_CHAR_IE
@ OSMO_GSUP_CHARG_CHAR_IE
Definition: gsup.h:74
OSMO_GSUP_PDP_CONTEXT_ID_IE
@ OSMO_GSUP_PDP_CONTEXT_ID_IE
Definition: gsup.h:70
OSMO_GSUP_MSGT_AUTH_FAIL_REPORT
@ OSMO_GSUP_MSGT_AUTH_FAIL_REPORT
Definition: gsup.h:103
OSMO_GSUP_CANCEL_TYPE_IE
@ OSMO_GSUP_CANCEL_TYPE_IE
Definition: gsup.h:66
osmo_gsup_iei
osmo_gsup_iei
Information Element Identifiers for GSUP IEs.
Definition: gsup.h:60
OSMO_GSUP_PDP_INFO_COMPL_IE
@ OSMO_GSUP_PDP_INFO_COMPL_IE
Definition: gsup.h:64
osmo_gsup_message
parsed/decoded GSUP protocol message
Definition: gsup.h:186
osmo_gsup_message::cn_domain
enum osmo_gsup_cn_domain cn_domain
Definition: gsup.h:203
OSMO_GSUP_MSGT_UPDATE_LOCATION_RESULT
@ OSMO_GSUP_MSGT_UPDATE_LOCATION_RESULT
Definition: gsup.h:97
OSMO_GSUP_CANCEL_TYPE_WITHDRAW
@ OSMO_GSUP_CANCEL_TYPE_WITHDRAW
Definition: gsup.h:137
OSMO_GSUP_CN_DOMAIN_PS
@ OSMO_GSUP_CN_DOMAIN_PS
Definition: gsup.h:141
osmo_gsup_session_state_name
static const char * osmo_gsup_session_state_name(enum osmo_gsup_session_state val)
Definition: gsup.h:159
OSMO_GSUP_MSGT_INSERT_DATA_REQUEST
@ OSMO_GSUP_MSGT_INSERT_DATA_REQUEST
Definition: gsup.h:109
OSMO_GSUP_MAX_NUM_PDP_INFO
#define OSMO_GSUP_MAX_NUM_PDP_INFO
Maximum nubmer of PDP inside osmo_gsup_message.
Definition: gsup.h:50
OSMO_GSUP_MSISDN_IE
@ OSMO_GSUP_MSISDN_IE
Definition: gsup.h:68
OSMO_GSUP_PDP_INFO_IE
@ OSMO_GSUP_PDP_INFO_IE
Definition: gsup.h:65
OSMO_GSUP_FREEZE_PTMSI_IE
@ OSMO_GSUP_FREEZE_PTMSI_IE
Definition: gsup.h:67
OSMO_GSUP_MAX_NUM_AUTH_INFO
#define OSMO_GSUP_MAX_NUM_AUTH_INFO
Maximum number of auth info inside osmo_gsup_message.
Definition: gsup.h:52
osmo_gsup_get_err_msg_type
int osmo_gsup_get_err_msg_type(enum osmo_gsup_message_type type_in)
return the error message type corresponding to type_in
Definition: gsup.c:84
OSMO_GSUP_SS_INFO_IE
@ OSMO_GSUP_SS_INFO_IE
Supplementary Services payload.
Definition: gsup.h:90
osmo_gsup_session_state_names
const struct value_string osmo_gsup_session_state_names[]
Definition: gsup.c:73
osmo_gsup_message::cause
enum gsm48_gmm_cause cause
Definition: gsup.h:189
osmo_gsup_message::num_auth_vectors
size_t num_auth_vectors
Definition: gsup.h:194
osmo_gsup_pdp_info::pdp_type
uint16_t pdp_type
Type of PDP context.
Definition: gsup.h:167
OSMO_GSUP_MSGT_LOCATION_CANCEL_REQUEST
@ OSMO_GSUP_MSGT_LOCATION_CANCEL_REQUEST
Definition: gsup.h:117
OSMO_GSUP_CK_IE
@ OSMO_GSUP_CK_IE
Definition: gsup.h:80
OSMO_GSUP_MSGT_PROC_SS_RESULT
@ OSMO_GSUP_MSGT_PROC_SS_RESULT
Definition: gsup.h:123
gsm_23_003.h
OSMO_GSUP_MSGT_PURGE_MS_ERROR
@ OSMO_GSUP_MSGT_PURGE_MS_ERROR
Definition: gsup.h:106
gsm_04_08_gprs.h
osmo_gsup_message::message_type
enum osmo_gsup_message_type message_type
Definition: gsup.h:187
osmo_gsup_message::num_pdp_infos
size_t num_pdp_infos
Definition: gsup.h:196
osmo_gsup_pdp_info::have_info
int have_info
Definition: gsup.h:165
OSMO_GSUP_IK_IE
@ OSMO_GSUP_IK_IE
Definition: gsup.h:79
auth.h
osmo_gsup_message_type_names
const struct value_string osmo_gsup_message_type_names[]
Definition: gsup.c:39
osmo_gsup_decode
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:255
osmo_gsup_message::ss_info_len
size_t ss_info_len
Definition: gsup.h:215
osmo_gsup_message::imsi
char imsi[GSM23003_IMSI_MAX_DIGITS+2]
Definition: gsup.h:188
OSMO_GSUP_MSGT_LOCATION_CANCEL_RESULT
@ OSMO_GSUP_MSGT_LOCATION_CANCEL_RESULT
Definition: gsup.h:119
osmo_gsup_pdp_info::context_id
unsigned int context_id
Definition: gsup.h:164
OSMO_GSUP_RES_IE
@ OSMO_GSUP_RES_IE
Definition: gsup.h:83
osmo_gsup_message_type_name
static const char * osmo_gsup_message_type_name(enum osmo_gsup_message_type val)
Definition: gsup.h:132
OSMO_GSUP_CANCEL_TYPE_UPDATE
@ OSMO_GSUP_CANCEL_TYPE_UPDATE
Definition: gsup.h:136
osmo_gsup_message::pdp_charg_enc_len
size_t pdp_charg_enc_len
Definition: gsup.h:205
osmo_gsup_message::pdp_info_compl
int pdp_info_compl
Definition: gsup.h:191
OSMO_GSUP_PDP_QOS_IE
@ OSMO_GSUP_PDP_QOS_IE
Definition: gsup.h:73
osmo_gsup_message::msisdn_enc
const uint8_t * msisdn_enc
Definition: gsup.h:197
OSMO_GSUP_CN_DOMAIN_CS
@ OSMO_GSUP_CN_DOMAIN_CS
Definition: gsup.h:142
osmo_gsup_message::freeze_ptmsi
int freeze_ptmsi
Definition: gsup.h:192
OSMO_GSUP_MSGT_PROC_SS_ERROR
@ OSMO_GSUP_MSGT_PROC_SS_ERROR
Definition: gsup.h:122
OSMO_GSUP_KC_IE
@ OSMO_GSUP_KC_IE
Definition: gsup.h:77
OSMO_GSUP_MSGT_INSERT_DATA_ERROR
@ OSMO_GSUP_MSGT_INSERT_DATA_ERROR
Definition: gsup.h:110
osmo_gsup_message::session_id
uint32_t session_id
Unique session identifier and origination flag.
Definition: gsup.h:211
OSMO_GSUP_SESSION_STATE_CONTINUE
@ OSMO_GSUP_SESSION_STATE_CONTINUE
Communication of an existing session.
Definition: gsup.h:152
OSMO_GSUP_AUTN_IE
@ OSMO_GSUP_AUTN_IE
Definition: gsup.h:81