Harald Welte | 381a1aa | 2017-10-16 18:31:20 +0200 | [diff] [blame] | 1 | /*! \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 Hofmeyr | 17518fe | 2017-06-20 04:35:06 +0200 | [diff] [blame] | 18 | /* |
Harald Welte | e08da97 | 2017-11-13 01:00:26 +0900 | [diff] [blame] | 19 | * (C) 2014 by sysmocom - s.f.m.c. GmbH, Author: Jacob Erlbeck |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 20 | * (C) 2016 by Harald Welte <laforge@gnumonks.org> |
| 21 | * All Rights Reserved |
| 22 | * |
Harald Welte | e08da97 | 2017-11-13 01:00:26 +0900 | [diff] [blame] | 23 | * SPDX-License-Identifier: GPL-2.0+ |
| 24 | * |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 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/protocol/gsm_23_003.h> |
| 44 | #include <osmocom/gsm/protocol/gsm_04_08_gprs.h> |
| 45 | #include <osmocom/crypt/auth.h> |
| 46 | |
Neels Hofmeyr | b970e10 | 2017-07-21 15:55:28 +0200 | [diff] [blame] | 47 | #define OSMO_GSUP_PORT 4222 |
| 48 | |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 49 | /*! Maximum nubmer of PDP inside \ref osmo_gsup_message */ |
| 50 | #define OSMO_GSUP_MAX_NUM_PDP_INFO 10 /* GSM 09.02 limits this to 50 */ |
| 51 | /*! Maximum number of auth info inside \ref osmo_gsup_message */ |
| 52 | #define OSMO_GSUP_MAX_NUM_AUTH_INFO 5 |
| 53 | /*! Maximum number of octets encoding MSISDN in BCD format */ |
| 54 | #define OSMO_GSUP_MAX_MSISDN_LEN 9 |
Stefan Sperling | dda1d45 | 2018-05-03 11:50:32 +0200 | [diff] [blame] | 55 | #define OSMO_GSUP_MAX_CALLED_PARTY_BCD_LEN 43 /* TS 24.008 10.5.4.7 */ |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 56 | |
| 57 | #define OSMO_GSUP_PDP_TYPE_SIZE 2 |
| 58 | |
| 59 | /*! Information Element Identifiers for GSUP IEs */ |
| 60 | enum osmo_gsup_iei { |
| 61 | OSMO_GSUP_IMSI_IE = 0x01, |
| 62 | OSMO_GSUP_CAUSE_IE = 0x02, |
| 63 | OSMO_GSUP_AUTH_TUPLE_IE = 0x03, |
| 64 | OSMO_GSUP_PDP_INFO_COMPL_IE = 0x04, |
| 65 | OSMO_GSUP_PDP_INFO_IE = 0x05, |
| 66 | OSMO_GSUP_CANCEL_TYPE_IE = 0x06, |
| 67 | OSMO_GSUP_FREEZE_PTMSI_IE = 0x07, |
| 68 | OSMO_GSUP_MSISDN_IE = 0x08, |
| 69 | OSMO_GSUP_HLR_NUMBER_IE = 0x09, |
| 70 | OSMO_GSUP_PDP_CONTEXT_ID_IE = 0x10, |
| 71 | OSMO_GSUP_PDP_TYPE_IE = 0x11, |
| 72 | OSMO_GSUP_ACCESS_POINT_NAME_IE = 0x12, |
| 73 | OSMO_GSUP_PDP_QOS_IE = 0x13, |
Holger Hans Peter Freyther | eb55c0d | 2017-07-07 16:53:30 +0200 | [diff] [blame] | 74 | OSMO_GSUP_CHARG_CHAR_IE = 0x14, |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 75 | OSMO_GSUP_RAND_IE = 0x20, |
| 76 | OSMO_GSUP_SRES_IE = 0x21, |
| 77 | OSMO_GSUP_KC_IE = 0x22, |
| 78 | /* 3G support */ |
| 79 | OSMO_GSUP_IK_IE = 0x23, |
| 80 | OSMO_GSUP_CK_IE = 0x24, |
| 81 | OSMO_GSUP_AUTN_IE = 0x25, |
| 82 | OSMO_GSUP_AUTS_IE = 0x26, |
| 83 | OSMO_GSUP_RES_IE = 0x27, |
Harald Welte | 48dc1a5 | 2016-05-05 18:46:42 +0200 | [diff] [blame] | 84 | OSMO_GSUP_CN_DOMAIN_IE = 0x28, |
Vadim Yanitskiy | 7269604 | 2018-04-07 02:34:55 +0700 | [diff] [blame] | 85 | |
| 86 | OSMO_GSUP_SESSION_ID_IE = 0x30, |
| 87 | OSMO_GSUP_SESSION_STATE_IE = 0x31, |
Vadim Yanitskiy | 36c7b33 | 2018-03-31 05:23:09 +0700 | [diff] [blame] | 88 | |
| 89 | /*! Supplementary Services payload */ |
| 90 | OSMO_GSUP_SS_INFO_IE = 0x35, |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 91 | }; |
| 92 | |
| 93 | /*! GSUP message type */ |
| 94 | enum osmo_gsup_message_type { |
| 95 | OSMO_GSUP_MSGT_UPDATE_LOCATION_REQUEST = 0b00000100, |
| 96 | OSMO_GSUP_MSGT_UPDATE_LOCATION_ERROR = 0b00000101, |
| 97 | OSMO_GSUP_MSGT_UPDATE_LOCATION_RESULT = 0b00000110, |
| 98 | |
| 99 | OSMO_GSUP_MSGT_SEND_AUTH_INFO_REQUEST = 0b00001000, |
| 100 | OSMO_GSUP_MSGT_SEND_AUTH_INFO_ERROR = 0b00001001, |
| 101 | OSMO_GSUP_MSGT_SEND_AUTH_INFO_RESULT = 0b00001010, |
| 102 | |
Harald Welte | de960cb | 2016-06-16 22:57:09 +0200 | [diff] [blame] | 103 | OSMO_GSUP_MSGT_AUTH_FAIL_REPORT = 0b00001011, |
| 104 | |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 105 | OSMO_GSUP_MSGT_PURGE_MS_REQUEST = 0b00001100, |
| 106 | OSMO_GSUP_MSGT_PURGE_MS_ERROR = 0b00001101, |
| 107 | OSMO_GSUP_MSGT_PURGE_MS_RESULT = 0b00001110, |
| 108 | |
| 109 | OSMO_GSUP_MSGT_INSERT_DATA_REQUEST = 0b00010000, |
| 110 | OSMO_GSUP_MSGT_INSERT_DATA_ERROR = 0b00010001, |
| 111 | OSMO_GSUP_MSGT_INSERT_DATA_RESULT = 0b00010010, |
| 112 | |
| 113 | OSMO_GSUP_MSGT_DELETE_DATA_REQUEST = 0b00010100, |
| 114 | OSMO_GSUP_MSGT_DELETE_DATA_ERROR = 0b00010101, |
| 115 | OSMO_GSUP_MSGT_DELETE_DATA_RESULT = 0b00010110, |
| 116 | |
| 117 | OSMO_GSUP_MSGT_LOCATION_CANCEL_REQUEST = 0b00011100, |
| 118 | OSMO_GSUP_MSGT_LOCATION_CANCEL_ERROR = 0b00011101, |
| 119 | OSMO_GSUP_MSGT_LOCATION_CANCEL_RESULT = 0b00011110, |
Vadim Yanitskiy | 36c7b33 | 2018-03-31 05:23:09 +0700 | [diff] [blame] | 120 | |
| 121 | OSMO_GSUP_MSGT_PROC_SS_REQUEST = 0b00100000, |
| 122 | OSMO_GSUP_MSGT_PROC_SS_ERROR = 0b00100001, |
| 123 | OSMO_GSUP_MSGT_PROC_SS_RESULT = 0b00100010, |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 124 | }; |
| 125 | |
| 126 | #define OSMO_GSUP_IS_MSGT_REQUEST(msgt) (((msgt) & 0b00000011) == 0b00) |
| 127 | #define OSMO_GSUP_IS_MSGT_ERROR(msgt) (((msgt) & 0b00000011) == 0b01) |
| 128 | #define OSMO_GSUP_TO_MSGT_ERROR(msgt) (((msgt) & 0b11111100) | 0b01) |
| 129 | |
Neels Hofmeyr | 10f5fb4 | 2017-02-09 02:09:09 +0100 | [diff] [blame] | 130 | extern const struct value_string osmo_gsup_message_type_names[]; |
| 131 | static inline const char * |
| 132 | osmo_gsup_message_type_name(enum osmo_gsup_message_type val) |
| 133 | { return get_value_string(osmo_gsup_message_type_names, val); } |
| 134 | |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 135 | enum osmo_gsup_cancel_type { |
| 136 | OSMO_GSUP_CANCEL_TYPE_UPDATE = 1, /* on wire: 0 */ |
| 137 | OSMO_GSUP_CANCEL_TYPE_WITHDRAW = 2, /* on wire: 1 */ |
| 138 | }; |
| 139 | |
Harald Welte | 48dc1a5 | 2016-05-05 18:46:42 +0200 | [diff] [blame] | 140 | enum osmo_gsup_cn_domain { |
| 141 | OSMO_GSUP_CN_DOMAIN_PS = 1, |
| 142 | OSMO_GSUP_CN_DOMAIN_CS = 2, |
| 143 | }; |
| 144 | |
Vadim Yanitskiy | 7269604 | 2018-04-07 02:34:55 +0700 | [diff] [blame] | 145 | /*! TCAP-like session state */ |
| 146 | enum osmo_gsup_session_state { |
| 147 | /*! Undefined session state */ |
| 148 | OSMO_GSUP_SESSION_STATE_NONE = 0x00, |
| 149 | /*! Initiation of a new session */ |
| 150 | OSMO_GSUP_SESSION_STATE_BEGIN = 0x01, |
| 151 | /*! Communication of an existing session */ |
| 152 | OSMO_GSUP_SESSION_STATE_CONTINUE = 0x02, |
| 153 | /*! Indication of the session end */ |
| 154 | OSMO_GSUP_SESSION_STATE_END = 0x03, |
| 155 | }; |
| 156 | |
Harald Welte | 6a6a609 | 2018-06-16 11:10:12 +0200 | [diff] [blame] | 157 | extern const struct value_string osmo_gsup_session_state_names[]; |
| 158 | static inline const char * |
| 159 | osmo_gsup_session_state_name(enum osmo_gsup_session_state val) |
| 160 | { return get_value_string(osmo_gsup_session_state_names, val); } |
| 161 | |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 162 | /*! parsed/decoded PDP context information */ |
| 163 | struct osmo_gsup_pdp_info { |
| 164 | unsigned int context_id; |
| 165 | int have_info; |
| 166 | /*! Type of PDP context */ |
| 167 | uint16_t pdp_type; |
| 168 | /*! APN information, still in encoded form. Can be NULL if no |
| 169 | * APN information included */ |
| 170 | const uint8_t *apn_enc; |
| 171 | /*! length (in octets) of apn_enc */ |
| 172 | size_t apn_enc_len; |
| 173 | /*! QoS information, still in encoded form. Can be NULL if no |
| 174 | * QoS information included */ |
| 175 | const uint8_t *qos_enc; |
| 176 | /*! length (in octets) of qos_enc */ |
| 177 | size_t qos_enc_len; |
Holger Hans Peter Freyther | eb55c0d | 2017-07-07 16:53:30 +0200 | [diff] [blame] | 178 | /*! PDP Charging Characteristics, still in encoded form. Can be NULL if no |
| 179 | * PDP Charging Characteristics */ |
| 180 | const uint8_t *pdp_charg_enc; |
| 181 | /*! length (in octets) of pdp_charg_enc */ |
| 182 | size_t pdp_charg_enc_len; |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 183 | }; |
| 184 | |
| 185 | /*! parsed/decoded GSUP protocol message */ |
| 186 | struct osmo_gsup_message { |
| 187 | enum osmo_gsup_message_type message_type; |
| 188 | char imsi[GSM23003_IMSI_MAX_DIGITS+2]; |
| 189 | enum gsm48_gmm_cause cause; |
| 190 | enum osmo_gsup_cancel_type cancel_type; |
| 191 | int pdp_info_compl; |
| 192 | int freeze_ptmsi; |
| 193 | struct osmo_auth_vector auth_vectors[OSMO_GSUP_MAX_NUM_AUTH_INFO]; |
| 194 | size_t num_auth_vectors; |
| 195 | struct osmo_gsup_pdp_info pdp_infos[OSMO_GSUP_MAX_NUM_PDP_INFO]; |
| 196 | size_t num_pdp_infos; |
| 197 | const uint8_t *msisdn_enc; |
| 198 | size_t msisdn_enc_len; |
| 199 | const uint8_t *hlr_enc; |
| 200 | size_t hlr_enc_len; |
| 201 | const uint8_t *auts; |
Harald Welte | 766da86 | 2016-05-06 11:18:15 +0200 | [diff] [blame] | 202 | const uint8_t *rand; |
Harald Welte | 48dc1a5 | 2016-05-05 18:46:42 +0200 | [diff] [blame] | 203 | enum osmo_gsup_cn_domain cn_domain; |
Holger Hans Peter Freyther | eb55c0d | 2017-07-07 16:53:30 +0200 | [diff] [blame] | 204 | const uint8_t *pdp_charg_enc; |
| 205 | size_t pdp_charg_enc_len; |
Vadim Yanitskiy | 7269604 | 2018-04-07 02:34:55 +0700 | [diff] [blame] | 206 | |
| 207 | /*! Session state \ref osmo_gsup_session_state */ |
| 208 | enum osmo_gsup_session_state session_state; |
| 209 | /*! Unique session identifier and origination flag. |
| 210 | * Encoded only when \ref session_state != 0x00 */ |
| 211 | uint32_t session_id; |
Vadim Yanitskiy | 36c7b33 | 2018-03-31 05:23:09 +0700 | [diff] [blame] | 212 | |
| 213 | /*! ASN.1 encoded MAP payload for Supplementary Services */ |
| 214 | uint8_t *ss_info; |
| 215 | size_t ss_info_len; |
Harald Welte | 3b6fb08 | 2016-04-25 18:46:22 +0200 | [diff] [blame] | 216 | }; |
| 217 | |
| 218 | int osmo_gsup_decode(const uint8_t *data, size_t data_len, |
| 219 | struct osmo_gsup_message *gsup_msg); |
Max | 80f4c4e | 2018-01-24 12:33:05 +0100 | [diff] [blame] | 220 | int osmo_gsup_encode(struct msgb *msg, const struct osmo_gsup_message *gsup_msg); |
Harald Welte | 520ebc1 | 2018-06-11 20:27:27 +0200 | [diff] [blame] | 221 | int osmo_gsup_get_err_msg_type(enum osmo_gsup_message_type type_in); |
Harald Welte | 381a1aa | 2017-10-16 18:31:20 +0200 | [diff] [blame] | 222 | |
| 223 | /*! @} */ |