blob: c88c1cd7d17edc12d11d78819fab33bc1f89f5ae [file] [log] [blame]
Harald Weltebb779392018-06-16 20:21:10 +02001/* OsmoHLR SS/USSD implementation */
Harald Welte4956ae12018-06-15 22:04:28 +02002
3/* (C) 2018 Harald Welte <laforge@gnumonks.org>
4 *
5 * All Rights Reserved
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as published by
9 * the Free Software Foundation; either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
16 *
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 *
20 */
21
22
23#include <osmocom/core/talloc.h>
Harald Weltebb779392018-06-16 20:21:10 +020024#include <osmocom/core/timer.h>
25#include <osmocom/gsm/gsup.h>
26#include <osmocom/gsm/gsm0480.h>
27#include <osmocom/gsm/protocol/gsm_04_80.h>
Harald Welte4956ae12018-06-15 22:04:28 +020028#include <stdint.h>
29#include <string.h>
Harald Weltedab544e2018-07-29 16:14:48 +020030#include <errno.h>
Harald Welte4956ae12018-06-15 22:04:28 +020031
32#include "hlr.h"
33#include "hlr_ussd.h"
Harald Weltebb779392018-06-16 20:21:10 +020034#include "gsup_server.h"
35#include "gsup_router.h"
36#include "logging.h"
Neels Hofmeyrf1fe94c2019-04-02 04:26:55 +020037#include "db.h"
Harald Weltebb779392018-06-16 20:21:10 +020038
39/***********************************************************************
40 * core data structures expressing config from VTY
41 ***********************************************************************/
Harald Welte4956ae12018-06-15 22:04:28 +020042
43struct hlr_euse *euse_find(struct hlr *hlr, const char *name)
44{
45 struct hlr_euse *euse;
46
47 llist_for_each_entry(euse, &hlr->euse_list, list) {
48 if (!strcmp(euse->name, name))
49 return euse;
50 }
51 return NULL;
52}
53
54struct hlr_euse *euse_alloc(struct hlr *hlr, const char *name)
55{
56 struct hlr_euse *euse = euse_find(hlr, name);
57 if (euse)
58 return NULL;
59
60 euse = talloc_zero(hlr, struct hlr_euse);
61 euse->name = talloc_strdup(euse, name);
62 euse->hlr = hlr;
Harald Welte4956ae12018-06-15 22:04:28 +020063 llist_add_tail(&euse->list, &hlr->euse_list);
64
65 return euse;
66}
67
68void euse_del(struct hlr_euse *euse)
69{
70 llist_del(&euse->list);
71 talloc_free(euse);
72}
73
74
Harald Weltedab544e2018-07-29 16:14:48 +020075struct hlr_ussd_route *ussd_route_find_prefix(struct hlr *hlr, const char *prefix)
Harald Welte4956ae12018-06-15 22:04:28 +020076{
Harald Weltedab544e2018-07-29 16:14:48 +020077 struct hlr_ussd_route *rt;
Harald Welte4956ae12018-06-15 22:04:28 +020078
Harald Weltedab544e2018-07-29 16:14:48 +020079 llist_for_each_entry(rt, &hlr->ussd_routes, list) {
Harald Welte4956ae12018-06-15 22:04:28 +020080 if (!strcmp(rt->prefix, prefix))
81 return rt;
82 }
83 return NULL;
84}
85
Harald Weltedab544e2018-07-29 16:14:48 +020086struct hlr_ussd_route *ussd_route_prefix_alloc_int(struct hlr *hlr, const char *prefix,
87 const struct hlr_iuse *iuse)
Harald Welte4956ae12018-06-15 22:04:28 +020088{
Harald Weltedab544e2018-07-29 16:14:48 +020089 struct hlr_ussd_route *rt;
Harald Welte4956ae12018-06-15 22:04:28 +020090
Harald Weltedab544e2018-07-29 16:14:48 +020091 if (ussd_route_find_prefix(hlr, prefix))
Harald Welte4956ae12018-06-15 22:04:28 +020092 return NULL;
93
Harald Weltedab544e2018-07-29 16:14:48 +020094 rt = talloc_zero(hlr, struct hlr_ussd_route);
Harald Welte4956ae12018-06-15 22:04:28 +020095 rt->prefix = talloc_strdup(rt, prefix);
Harald Weltedab544e2018-07-29 16:14:48 +020096 rt->u.iuse = iuse;
97 llist_add_tail(&rt->list, &hlr->ussd_routes);
Harald Welte4956ae12018-06-15 22:04:28 +020098
99 return rt;
100}
101
Harald Weltedab544e2018-07-29 16:14:48 +0200102struct hlr_ussd_route *ussd_route_prefix_alloc_ext(struct hlr *hlr, const char *prefix,
103 struct hlr_euse *euse)
104{
105 struct hlr_ussd_route *rt;
106
107 if (ussd_route_find_prefix(hlr, prefix))
108 return NULL;
109
110 rt = talloc_zero(hlr, struct hlr_ussd_route);
111 rt->prefix = talloc_strdup(rt, prefix);
112 rt->is_external = true;
113 rt->u.euse = euse;
114 llist_add_tail(&rt->list, &hlr->ussd_routes);
115
116 return rt;
117}
118
119void ussd_route_del(struct hlr_ussd_route *rt)
Harald Welte4956ae12018-06-15 22:04:28 +0200120{
121 llist_del(&rt->list);
122 talloc_free(rt);
123}
Harald Weltebb779392018-06-16 20:21:10 +0200124
Harald Weltedab544e2018-07-29 16:14:48 +0200125static struct hlr_ussd_route *ussd_route_lookup_7bit(struct hlr *hlr, const char *ussd_code)
Harald Weltebb779392018-06-16 20:21:10 +0200126{
Harald Weltedab544e2018-07-29 16:14:48 +0200127 struct hlr_ussd_route *rt;
128 llist_for_each_entry(rt, &hlr->ussd_routes, list) {
129 if (!strncmp(ussd_code, rt->prefix, strlen(rt->prefix))) {
Vadim Yanitskiye6c839e2018-08-02 23:59:51 +0700130 LOGP(DSS, LOGL_DEBUG, "Found %s '%s' (prefix '%s') for USSD "
131 "Code '%s'\n", rt->is_external ? "EUSE" : "IUSE",
132 rt->is_external ? rt->u.euse->name : rt->u.iuse->name,
133 rt->prefix, ussd_code);
Harald Weltedab544e2018-07-29 16:14:48 +0200134 return rt;
Harald Weltebb779392018-06-16 20:21:10 +0200135 }
136 }
137
Harald Weltedab544e2018-07-29 16:14:48 +0200138 LOGP(DSS, LOGL_DEBUG, "Could not find Route for USSD Code '%s'\n", ussd_code);
Harald Weltebb779392018-06-16 20:21:10 +0200139 return NULL;
140}
141
142/***********************************************************************
143 * handling functions for individual GSUP messages
144 ***********************************************************************/
145
Harald Welte97bfb652018-07-29 12:28:11 +0200146#define LOGPSS(ss, lvl, fmt, args...) \
Harald Welte95b96d42018-07-29 12:47:39 +0200147 LOGP(DSS, lvl, "%s/0x%08x: " fmt, (ss)->imsi, (ss)->session_id, ## args)
Harald Welte97bfb652018-07-29 12:28:11 +0200148
Harald Weltebb779392018-06-16 20:21:10 +0200149struct ss_session {
150 /* link us to hlr->ss_sessions */
151 struct llist_head list;
152 /* imsi of this session */
Neels Hofmeyre21b45a2019-03-18 21:04:23 +0100153 char imsi[OSMO_IMSI_BUF_SIZE];
Harald Weltebb779392018-06-16 20:21:10 +0200154 /* ID of this session (unique per IMSI) */
155 uint32_t session_id;
156 /* state of the session */
157 enum osmo_gsup_session_state state;
158 /* time-out when we will delete the session */
159 struct osmo_timer_list timeout;
160
Harald Weltedab544e2018-07-29 16:14:48 +0200161 /* is this USSD for an external handler (EUSE): true */
162 bool is_external;
163 union {
164 /* external USSD Entity responsible for this session */
165 struct hlr_euse *euse;
166 /* internal USSD Entity responsible for this session */
167 const struct hlr_iuse *iuse;
168 } u;
169
Oliver Smith95abc2b2019-04-04 12:00:24 +0200170 /* subscriber's vlr_number
171 * MO USSD: originating MSC's vlr_number
172 * MT USSD: looked up once per session and cached here */
173 uint8_t *vlr_number;
174 size_t vlr_number_len;
Neels Hofmeyrf1fe94c2019-04-02 04:26:55 +0200175
Harald Weltebb779392018-06-16 20:21:10 +0200176 /* we don't keep a pointer to the osmo_gsup_{route,conn} towards the MSC/VLR here,
177 * as this might change during inter-VLR hand-over, and we simply look-up the serving MSC/VLR
178 * every time we receive an USSD component from the EUSE */
179};
180
181struct ss_session *ss_session_find(struct hlr *hlr, const char *imsi, uint32_t session_id)
182{
183 struct ss_session *ss;
184 llist_for_each_entry(ss, &hlr->ss_sessions, list) {
185 if (!strcmp(ss->imsi, imsi) && ss->session_id == session_id)
186 return ss;
187 }
188 return NULL;
189}
190
191void ss_session_free(struct ss_session *ss)
192{
193 osmo_timer_del(&ss->timeout);
194 llist_del(&ss->list);
195 talloc_free(ss);
196}
197
198static void ss_session_timeout(void *data)
199{
200 struct ss_session *ss = data;
201
Harald Welte97bfb652018-07-29 12:28:11 +0200202 LOGPSS(ss, LOGL_NOTICE, "SS Session Timeout, destroying\n");
Harald Weltebb779392018-06-16 20:21:10 +0200203 /* FIXME: should we send a ReturnError component to the MS? */
204 ss_session_free(ss);
205}
206
207struct ss_session *ss_session_alloc(struct hlr *hlr, const char *imsi, uint32_t session_id)
208{
209 struct ss_session *ss;
210
211 OSMO_ASSERT(!ss_session_find(hlr, imsi, session_id));
212
213 ss = talloc_zero(hlr, struct ss_session);
214 OSMO_ASSERT(ss);
215
216 OSMO_STRLCPY_ARRAY(ss->imsi, imsi);
217 ss->session_id = session_id;
Vadim Yanitskiye6ce52b2018-12-01 00:16:44 +0700218
219 /* Schedule self-destruction timer */
Harald Weltebb779392018-06-16 20:21:10 +0200220 osmo_timer_setup(&ss->timeout, ss_session_timeout, ss);
Vadim Yanitskiyd157a562018-12-01 00:03:39 +0700221 if (g_hlr->ncss_guard_timeout > 0)
222 osmo_timer_schedule(&ss->timeout, g_hlr->ncss_guard_timeout, 0);
Harald Weltebb779392018-06-16 20:21:10 +0200223
224 llist_add_tail(&ss->list, &hlr->ss_sessions);
225 return ss;
226}
227
228/***********************************************************************
Harald Welte72667312018-07-29 12:38:09 +0200229 * handling functions for encoding SS messages + wrapping them in GSUP
230 ***********************************************************************/
231
Neels Hofmeyrf1fe94c2019-04-02 04:26:55 +0200232/* Resolve the target MSC by ss->imsi and send GSUP message. */
233static int ss_gsup_send(struct ss_session *ss, struct osmo_gsup_server *gs, struct msgb *msg)
234{
235 struct hlr_subscriber subscr = {};
236 int rc;
237
238 /* Use vlr_number as looked up by the caller, or look up now. */
Oliver Smith95abc2b2019-04-04 12:00:24 +0200239 if (!ss->vlr_number) {
Neels Hofmeyrf1fe94c2019-04-02 04:26:55 +0200240 rc = db_subscr_get_by_imsi(g_hlr->dbc, ss->imsi, &subscr);
241 if (rc < 0) {
242 LOGPSS(ss, LOGL_ERROR, "Cannot find subscriber, cannot route GSUP message\n");
243 msgb_free(msg);
244 return -EINVAL;
245 }
Oliver Smith95abc2b2019-04-04 12:00:24 +0200246 ss->vlr_number = (uint8_t *)talloc_strdup(ss, subscr.vlr_number);
247 ss->vlr_number_len = strlen(subscr.vlr_number) + 1;
Neels Hofmeyrf1fe94c2019-04-02 04:26:55 +0200248 }
249
Oliver Smith95abc2b2019-04-04 12:00:24 +0200250 /* Check for empty string (all vlr_number strings end in "\0", because otherwise gsup_route_find() fails) */
251 if (ss->vlr_number_len == 1) {
Neels Hofmeyrf1fe94c2019-04-02 04:26:55 +0200252 LOGPSS(ss, LOGL_ERROR, "Cannot send GSUP message, no VLR number stored for subscriber\n");
253 msgb_free(msg);
254 return -EINVAL;
255 }
256
Oliver Smith95abc2b2019-04-04 12:00:24 +0200257 LOGPSS(ss, LOGL_DEBUG, "Tx SS/USSD to VLR %s\n", osmo_quote_str((char *)ss->vlr_number, ss->vlr_number_len));
258 return osmo_gsup_addr_send(gs, ss->vlr_number, ss->vlr_number_len, msg);
Neels Hofmeyrf1fe94c2019-04-02 04:26:55 +0200259}
260
Harald Welte72667312018-07-29 12:38:09 +0200261static int ss_tx_to_ms(struct ss_session *ss, enum osmo_gsup_message_type gsup_msg_type,
262 bool final, struct msgb *ss_msg)
263
264{
265 struct osmo_gsup_message resp = {0};
266 struct msgb *resp_msg;
267
268 resp.message_type = gsup_msg_type;
269 OSMO_STRLCPY_ARRAY(resp.imsi, ss->imsi);
270 if (final)
271 resp.session_state = OSMO_GSUP_SESSION_STATE_END;
272 else
273 resp.session_state = OSMO_GSUP_SESSION_STATE_CONTINUE;
274 resp.session_id = ss->session_id;
275 if (ss_msg) {
276 resp.ss_info = msgb_data(ss_msg);
277 resp.ss_info_len = msgb_length(ss_msg);
278 }
279
Oliver Smith7d53ae12019-04-08 14:35:30 +0200280 resp_msg = msgb_alloc_headroom(4000, 64, __func__);
Harald Welte72667312018-07-29 12:38:09 +0200281 OSMO_ASSERT(resp_msg);
282 osmo_gsup_encode(resp_msg, &resp);
283 msgb_free(ss_msg);
284
Neels Hofmeyrf1fe94c2019-04-02 04:26:55 +0200285 return ss_gsup_send(ss, g_hlr->gs, resp_msg);
Harald Welte72667312018-07-29 12:38:09 +0200286}
287
288#if 0
289static int ss_tx_reject(struct ss_session *ss, int invoke_id, uint8_t problem_tag,
290 uint8_t problem_code)
291{
292 struct msgb *msg = gsm0480_gen_reject(invoke_id, problem_tag, problem_code);
293 LOGPSS(ss, LOGL_NOTICE, "Tx Reject(%u, 0x%02x, 0x%02x)\n", invoke_id,
294 problem_tag, problem_code);
295 OSMO_ASSERT(msg);
296 return ss_tx_to_ms(ss, OSMO_GSUP_MSGT_PROC_SS_RESULT, true, msg);
297}
298#endif
299
300static int ss_tx_error(struct ss_session *ss, uint8_t invoke_id, uint8_t error_code)
301{
302 struct msgb *msg = gsm0480_gen_return_error(invoke_id, error_code);
303 LOGPSS(ss, LOGL_NOTICE, "Tx ReturnError(%u, 0x%02x)\n", invoke_id, error_code);
304 OSMO_ASSERT(msg);
305 return ss_tx_to_ms(ss, OSMO_GSUP_MSGT_PROC_SS_RESULT, true, msg);
306}
307
Harald Weltedab544e2018-07-29 16:14:48 +0200308static int ss_tx_ussd_7bit(struct ss_session *ss, bool final, uint8_t invoke_id, const char *text)
309{
310 struct msgb *msg = gsm0480_gen_ussd_resp_7bit(invoke_id, text);
311 LOGPSS(ss, LOGL_INFO, "Tx USSD '%s'\n", text);
312 OSMO_ASSERT(msg);
313 return ss_tx_to_ms(ss, OSMO_GSUP_MSGT_PROC_SS_RESULT, final, msg);
314}
315
316/***********************************************************************
317 * Internal USSD Handlers
318 ***********************************************************************/
319
320#include "db.h"
321
322static int handle_ussd_own_msisdn(struct osmo_gsup_conn *conn, struct ss_session *ss,
323 const struct osmo_gsup_message *gsup, const struct ss_request *req)
324{
325 struct hlr_subscriber subscr;
326 char buf[GSM0480_USSD_7BIT_STRING_LEN+1];
327 int rc;
328
329 rc = db_subscr_get_by_imsi(g_hlr->dbc, ss->imsi, &subscr);
330 switch (rc) {
331 case 0:
332 if (strlen(subscr.msisdn) == 0)
333 snprintf(buf, sizeof(buf), "You have no MSISDN!");
334 else
Vadim Yanitskiy3adb33d2018-08-03 00:07:54 +0700335 snprintf(buf, sizeof(buf), "Your extension is %s", subscr.msisdn);
Harald Weltedab544e2018-07-29 16:14:48 +0200336 ss_tx_ussd_7bit(ss, true, req->invoke_id, buf);
337 break;
338 case -ENOENT:
Vadim Yanitskiy4ca7f6a2019-07-23 15:36:23 +0700339 ss_tx_error(ss, req->invoke_id, GSM0480_ERR_CODE_UNKNOWN_SUBSCRIBER);
Harald Weltedab544e2018-07-29 16:14:48 +0200340 break;
341 case -EIO:
342 default:
Vadim Yanitskiy4ca7f6a2019-07-23 15:36:23 +0700343 ss_tx_error(ss, req->invoke_id, GSM0480_ERR_CODE_SYSTEM_FAILURE);
Harald Weltedab544e2018-07-29 16:14:48 +0200344 break;
345 }
346 return 0;
347}
348
349static int handle_ussd_own_imsi(struct osmo_gsup_conn *conn, struct ss_session *ss,
350 const struct osmo_gsup_message *gsup, const struct ss_request *req)
351{
352 char buf[GSM0480_USSD_7BIT_STRING_LEN+1];
Vadim Yanitskiy3adb33d2018-08-03 00:07:54 +0700353 snprintf(buf, sizeof(buf), "Your IMSI is %s", ss->imsi);
Harald Weltedab544e2018-07-29 16:14:48 +0200354 ss_tx_ussd_7bit(ss, true, req->invoke_id, buf);
355 return 0;
356}
357
Vadim Yanitskiy277b2d62018-12-27 05:39:54 +0700358static int handle_ussd_get_ran(struct osmo_gsup_conn *conn, struct ss_session *ss,
359 const struct osmo_gsup_message *gsup,
360 const struct ss_request *req)
361{
362 struct hlr_subscriber subscr;
Neels Hofmeyrd2d9f352018-12-29 04:10:35 +0100363 char response[512];
Vadim Yanitskiy277b2d62018-12-27 05:39:54 +0700364 int rc;
Neels Hofmeyrd2d9f352018-12-29 04:10:35 +0100365 const char *rat;
Vadim Yanitskiy277b2d62018-12-27 05:39:54 +0700366
367 rc = db_subscr_get_by_imsi(g_hlr->dbc, ss->imsi, &subscr);
368 switch (rc) {
369 case 0:
Neels Hofmeyrd2d9f352018-12-29 04:10:35 +0100370 if (!*subscr.last_lu_rat)
371 rat = "nothing, you don't exist";
372 else if (!strcmp(subscr.last_lu_rat, "GERAN-A"))
373 rat = "2G";
374 else if (!strcmp(subscr.last_lu_rat, "UTRAN-Iu"))
375 rat = "3G";
Vadim Yanitskiy277b2d62018-12-27 05:39:54 +0700376 else
Neels Hofmeyrd2d9f352018-12-29 04:10:35 +0100377 rat = subscr.last_lu_rat;
378
379 snprintf(response, sizeof(response),
380 "Now on %s. Available:%s%s.",
381 rat,
382 subscr.rat_types[OSMO_RAT_GERAN_A]? " 2G" : "",
383 subscr.rat_types[OSMO_RAT_UTRAN_IU]? " 3G" : "");
Vadim Yanitskiy277b2d62018-12-27 05:39:54 +0700384
385 rc = ss_tx_ussd_7bit(ss, true, req->invoke_id, response);
386 break;
387 case -ENOENT:
388 rc = ss_tx_error(ss, true, GSM0480_ERR_CODE_UNKNOWN_SUBSCRIBER);
389 break;
390 case -EIO:
391 default:
392 rc = ss_tx_error(ss, true, GSM0480_ERR_CODE_SYSTEM_FAILURE);
393 break;
394 }
395
396 return rc;
397}
Harald Weltedab544e2018-07-29 16:14:48 +0200398
Vadim Yanitskiye9dd9c62018-12-27 08:15:00 +0700399static int handle_ussd_umts_on(struct osmo_gsup_conn *conn, struct ss_session *ss,
400 const struct osmo_gsup_message *gsup,
401 const struct ss_request *req)
402{
403 struct hlr_subscriber subscr;
404 int rc;
405
406 rc = db_subscr_get_by_imsi(g_hlr->dbc, ss->imsi, &subscr);
407 switch (rc) {
408 case 0:
409 hlr_subscr_rat_flag(g_hlr, &subscr, OSMO_RAT_UTRAN_IU, true);
410 rc = ss_tx_ussd_7bit(ss, true, req->invoke_id,
411 "Enabled UTRAN-Iu (3G)");
412 break;
413 case -ENOENT:
414 rc = ss_tx_error(ss, true, GSM0480_ERR_CODE_UNKNOWN_SUBSCRIBER);
415 break;
416 case -EIO:
417 default:
418 rc = ss_tx_error(ss, true, GSM0480_ERR_CODE_SYSTEM_FAILURE);
419 break;
420 }
421
422 return rc;
423}
424
425static int handle_ussd_umts_off(struct osmo_gsup_conn *conn, struct ss_session *ss,
426 const struct osmo_gsup_message *gsup,
427 const struct ss_request *req)
428{
429 struct hlr_subscriber subscr;
430 int rc;
431
432 rc = db_subscr_get_by_imsi(g_hlr->dbc, ss->imsi, &subscr);
433 switch (rc) {
434 case 0:
435 hlr_subscr_rat_flag(g_hlr, &subscr, OSMO_RAT_UTRAN_IU, false);
436 rc = ss_tx_ussd_7bit(ss, true, req->invoke_id,
437 "Disabled UTRAN-Iu (3G)");
438 break;
439 case -ENOENT:
440 rc = ss_tx_error(ss, true, GSM0480_ERR_CODE_UNKNOWN_SUBSCRIBER);
441 break;
442 case -EIO:
443 default:
444 rc = ss_tx_error(ss, true, GSM0480_ERR_CODE_SYSTEM_FAILURE);
445 break;
446 }
447
448 return rc;
449}
450
Harald Weltedab544e2018-07-29 16:14:48 +0200451static const struct hlr_iuse hlr_iuses[] = {
452 {
453 .name = "own-msisdn",
454 .handle_ussd = handle_ussd_own_msisdn,
455 },
456 {
457 .name = "own-imsi",
458 .handle_ussd = handle_ussd_own_imsi,
459 },
Vadim Yanitskiy277b2d62018-12-27 05:39:54 +0700460 {
461 .name = "get-ran",
462 .handle_ussd = handle_ussd_get_ran,
463 },
Vadim Yanitskiye9dd9c62018-12-27 08:15:00 +0700464 {
465 .name = "umts-on",
466 .handle_ussd = handle_ussd_umts_on,
467 },
468 {
469 .name = "umts-off",
470 .handle_ussd = handle_ussd_umts_off,
471 },
Harald Weltedab544e2018-07-29 16:14:48 +0200472};
473
474const struct hlr_iuse *iuse_find(const char *name)
475{
476 unsigned int i;
477
478 for (i = 0; i < ARRAY_SIZE(hlr_iuses); i++) {
479 const struct hlr_iuse *iuse = &hlr_iuses[i];
480 if (!strcmp(name, iuse->name))
481 return iuse;
482 }
483 return NULL;
484}
Harald Welte72667312018-07-29 12:38:09 +0200485
486
487/***********************************************************************
Harald Weltebb779392018-06-16 20:21:10 +0200488 * handling functions for individual GSUP messages
489 ***********************************************************************/
490
491static bool ss_op_is_ussd(uint8_t opcode)
492{
493 switch (opcode) {
494 case GSM0480_OP_CODE_PROCESS_USS_DATA:
495 case GSM0480_OP_CODE_PROCESS_USS_REQ:
496 case GSM0480_OP_CODE_USS_REQUEST:
497 case GSM0480_OP_CODE_USS_NOTIFY:
498 return true;
499 default:
500 return false;
501 }
502}
503
504/* is this GSUP connection an EUSE (true) or not (false)? */
505static bool conn_is_euse(struct osmo_gsup_conn *conn)
506{
507 int rc;
508 uint8_t *addr;
509
510 rc = osmo_gsup_conn_ccm_get(conn, &addr, IPAC_IDTAG_SERNR);
511 if (rc <= 5)
512 return false;
513 if (!strncmp((char *)addr, "EUSE-", 5))
514 return true;
515 else
516 return false;
517}
518
519static struct hlr_euse *euse_by_conn(struct osmo_gsup_conn *conn)
520{
521 int rc;
522 char *addr;
523 struct hlr *hlr = conn->server->priv;
524
525 rc = osmo_gsup_conn_ccm_get(conn, (uint8_t **) &addr, IPAC_IDTAG_SERNR);
526 if (rc <= 5)
527 return NULL;
528 if (strncmp(addr, "EUSE-", 5))
529 return NULL;
530
531 return euse_find(hlr, addr+5);
532}
533
534static int handle_ss(struct ss_session *ss, const struct osmo_gsup_message *gsup,
535 const struct ss_request *req)
536{
537 uint8_t comp_type = gsup->ss_info[0];
538
Harald Welte7f32f5f2018-07-29 12:43:49 +0200539 LOGPSS(ss, LOGL_INFO, "SS CompType=%s, OpCode=%s\n",
Harald Weltebb779392018-06-16 20:21:10 +0200540 gsm0480_comp_type_name(comp_type), gsm0480_op_code_name(req->opcode));
Vadim Yanitskiy4a4bdcd2018-10-12 21:44:07 +0200541
542 /**
543 * FIXME: As we don't store any SS related information
544 * (e.g. call forwarding preferences) in the database,
545 * we don't handle "structured" SS requests at all.
546 */
547 LOGPSS(ss, LOGL_NOTICE, "Structured SS requests are not supported, rejecting...\n");
548 ss_tx_error(ss, req->invoke_id, GSM0480_ERR_CODE_FACILITY_NOT_SUPPORTED);
549 return -ENOTSUP;
Harald Weltebb779392018-06-16 20:21:10 +0200550}
551
Harald Weltedab544e2018-07-29 16:14:48 +0200552/* Handle a USSD GSUP message for a given SS Session received from VLR or EUSE */
Harald Weltebb779392018-06-16 20:21:10 +0200553static int handle_ussd(struct osmo_gsup_conn *conn, struct ss_session *ss,
554 const struct osmo_gsup_message *gsup, const struct ss_request *req)
555{
556 uint8_t comp_type = gsup->ss_info[0];
557 struct msgb *msg_out;
558 bool is_euse_originated = conn_is_euse(conn);
559
Harald Welte7f32f5f2018-07-29 12:43:49 +0200560 LOGPSS(ss, LOGL_INFO, "USSD CompType=%s, OpCode=%s '%s'\n",
Harald Weltebb779392018-06-16 20:21:10 +0200561 gsm0480_comp_type_name(comp_type), gsm0480_op_code_name(req->opcode),
562 req->ussd_text);
563
Harald Weltedab544e2018-07-29 16:14:48 +0200564 if ((ss->is_external && !ss->u.euse) || !ss->u.iuse) {
Harald Welte7f32f5f2018-07-29 12:43:49 +0200565 LOGPSS(ss, LOGL_NOTICE, "USSD for unknown code '%s'\n", req->ussd_text);
Harald Welte72667312018-07-29 12:38:09 +0200566 ss_tx_error(ss, req->invoke_id, GSM0480_ERR_CODE_SS_NOT_AVAILABLE);
Harald Weltebb779392018-06-16 20:21:10 +0200567 return 0;
568 }
569
570 if (is_euse_originated) {
Harald Welte72667312018-07-29 12:38:09 +0200571 msg_out = msgb_alloc_headroom(1024+16, 16, "GSUP USSD FW");
572 OSMO_ASSERT(msg_out);
Harald Weltebb779392018-06-16 20:21:10 +0200573 /* Received from EUSE, Forward to VLR */
574 osmo_gsup_encode(msg_out, gsup);
Neels Hofmeyrf1fe94c2019-04-02 04:26:55 +0200575 ss_gsup_send(ss, conn->server, msg_out);
Harald Weltebb779392018-06-16 20:21:10 +0200576 } else {
Harald Weltedab544e2018-07-29 16:14:48 +0200577 /* Received from VLR (MS) */
578 if (ss->is_external) {
579 /* Forward to EUSE */
580 char addr[128];
581 strcpy(addr, "EUSE-");
582 osmo_strlcpy(addr+5, ss->u.euse->name, sizeof(addr)-5);
583 conn = gsup_route_find(conn->server, (uint8_t *)addr, strlen(addr)+1);
584 if (!conn) {
585 LOGPSS(ss, LOGL_ERROR, "Cannot find conn for EUSE %s\n", addr);
586 ss_tx_error(ss, req->invoke_id, GSM0480_ERR_CODE_SYSTEM_FAILURE);
587 } else {
588 msg_out = msgb_alloc_headroom(1024+16, 16, "GSUP USSD FW");
589 OSMO_ASSERT(msg_out);
590 osmo_gsup_encode(msg_out, gsup);
591 osmo_gsup_conn_send(conn, msg_out);
592 }
Harald Welte72667312018-07-29 12:38:09 +0200593 } else {
Harald Weltedab544e2018-07-29 16:14:48 +0200594 /* Handle internally */
595 ss->u.iuse->handle_ussd(conn, ss, gsup, req);
Vadim Yanitskiy9c8806a2018-11-30 08:11:19 +0700596 /* Release session immediately */
597 ss_session_free(ss);
Harald Weltebb779392018-06-16 20:21:10 +0200598 }
Harald Weltebb779392018-06-16 20:21:10 +0200599 }
600
601 return 0;
602}
603
604
605/* this function is called for any SS_REQ/SS_RESP messages from both the MSC/VLR side as well
606 * as from the EUSE side */
607int rx_proc_ss_req(struct osmo_gsup_conn *conn, const struct osmo_gsup_message *gsup)
608{
609 struct hlr *hlr = conn->server->priv;
610 struct ss_session *ss;
611 struct ss_request req = {0};
Oliver Smith95abc2b2019-04-04 12:00:24 +0200612 struct gsup_route *gsup_rt;
Harald Weltebb779392018-06-16 20:21:10 +0200613
Harald Welte95b96d42018-07-29 12:47:39 +0200614 LOGP(DSS, LOGL_DEBUG, "%s/0x%08x: Process SS (%s)\n", gsup->imsi, gsup->session_id,
Harald Weltebb779392018-06-16 20:21:10 +0200615 osmo_gsup_session_state_name(gsup->session_state));
616
617 /* decode and find out what kind of SS message it is */
618 if (gsup->ss_info && gsup->ss_info_len) {
619 if (gsm0480_parse_facility_ie(gsup->ss_info, gsup->ss_info_len, &req)) {
Harald Welte95b96d42018-07-29 12:47:39 +0200620 LOGP(DSS, LOGL_ERROR, "%s/0x%082x: Unable to parse SS request: %s\n",
Harald Weltebb779392018-06-16 20:21:10 +0200621 gsup->imsi, gsup->session_id,
622 osmo_hexdump(gsup->ss_info, gsup->ss_info_len));
Harald Welte72667312018-07-29 12:38:09 +0200623 /* FIXME: Send a Reject component? */
Harald Weltebb779392018-06-16 20:21:10 +0200624 goto out_err;
625 }
Vadim Yanitskiy937f5832019-07-24 19:14:32 +0700626 } else if (gsup->session_state != OSMO_GSUP_SESSION_STATE_END) {
627 LOGP(DSS, LOGL_ERROR, "%s/0x%082x: Missing SS payload for '%s'\n",
628 gsup->imsi, gsup->session_id,
629 osmo_gsup_session_state_name(gsup->session_state));
630 goto out_err;
Harald Weltebb779392018-06-16 20:21:10 +0200631 }
632
633 switch (gsup->session_state) {
634 case OSMO_GSUP_SESSION_STATE_BEGIN:
635 /* Check for overlapping Session ID usage */
636 if (ss_session_find(hlr, gsup->imsi, gsup->session_id)) {
Harald Welte95b96d42018-07-29 12:47:39 +0200637 LOGP(DSS, LOGL_ERROR, "%s/0x%08x: BEGIN with non-unique session ID!\n",
Harald Weltebb779392018-06-16 20:21:10 +0200638 gsup->imsi, gsup->session_id);
639 goto out_err;
640 }
641 ss = ss_session_alloc(hlr, gsup->imsi, gsup->session_id);
642 if (!ss) {
Harald Welte95b96d42018-07-29 12:47:39 +0200643 LOGP(DSS, LOGL_ERROR, "%s/0x%08x: Unable to allocate SS session\n",
Harald Weltebb779392018-06-16 20:21:10 +0200644 gsup->imsi, gsup->session_id);
645 goto out_err;
646 }
Oliver Smith95abc2b2019-04-04 12:00:24 +0200647 /* Get IPA name from VLR conn and save as ss->vlr_number */
648 if (!conn_is_euse(conn)) {
649 gsup_rt = gsup_route_find_by_conn(conn);
650 if (gsup_rt) {
651 ss->vlr_number = (uint8_t *)talloc_strdup(ss, (const char *)gsup_rt->addr);
652 ss->vlr_number_len = strlen((const char *)gsup_rt->addr) + 1;
653 LOGPSS(ss, LOGL_DEBUG, "Destination IPA name retrieved from GSUP route: %s\n",
654 osmo_quote_str((const char *)ss->vlr_number, ss->vlr_number_len));
655 } else {
656 LOGPSS(ss, LOGL_NOTICE, "Could not find GSUP route, therefore can't set the destination"
657 " IPA name. We'll try to look it up later, but this should not"
658 " have happened.\n");
659 }
660 }
Harald Weltebb779392018-06-16 20:21:10 +0200661 if (ss_op_is_ussd(req.opcode)) {
662 if (conn_is_euse(conn)) {
663 /* EUSE->VLR: MT USSD. EUSE is known ('conn'), VLR is to be resolved */
Harald Weltedab544e2018-07-29 16:14:48 +0200664 ss->u.euse = euse_by_conn(conn);
Harald Weltebb779392018-06-16 20:21:10 +0200665 } else {
666 /* VLR->EUSE: MO USSD. VLR is known ('conn'), EUSE is to be resolved */
Harald Weltedab544e2018-07-29 16:14:48 +0200667 struct hlr_ussd_route *rt;
668 rt = ussd_route_lookup_7bit(hlr, (const char *) req.ussd_text);
669 if (rt) {
670 if (rt->is_external) {
671 ss->is_external = true;
672 ss->u.euse = rt->u.euse;
673 } else if (rt) {
674 ss->is_external = false;
675 ss->u.iuse = rt->u.iuse;
676 }
Harald Welte1eb98692018-08-08 08:57:26 +0200677 } else {
678 if (hlr->euse_default) {
679 ss->is_external = true;
680 ss->u.euse = hlr->euse_default;
681 }
Harald Weltedab544e2018-07-29 16:14:48 +0200682 }
Harald Weltebb779392018-06-16 20:21:10 +0200683 }
684 /* dispatch unstructured SS to routing */
685 handle_ussd(conn, ss, gsup, &req);
686 } else {
687 /* dispatch non-call SS to internal code */
688 handle_ss(ss, gsup, &req);
689 }
690 break;
691 case OSMO_GSUP_SESSION_STATE_CONTINUE:
692 ss = ss_session_find(hlr, gsup->imsi, gsup->session_id);
693 if (!ss) {
Harald Welte95b96d42018-07-29 12:47:39 +0200694 LOGP(DSS, LOGL_ERROR, "%s/0x%08x: CONTINUE for unknown SS session\n",
Harald Weltebb779392018-06-16 20:21:10 +0200695 gsup->imsi, gsup->session_id);
696 goto out_err;
697 }
Vadim Yanitskiye6ce52b2018-12-01 00:16:44 +0700698
699 /* Reschedule self-destruction timer */
700 if (g_hlr->ncss_guard_timeout > 0)
701 osmo_timer_schedule(&ss->timeout, g_hlr->ncss_guard_timeout, 0);
702
Harald Weltebb779392018-06-16 20:21:10 +0200703 if (ss_op_is_ussd(req.opcode)) {
704 /* dispatch unstructured SS to routing */
705 handle_ussd(conn, ss, gsup, &req);
706 } else {
707 /* dispatch non-call SS to internal code */
708 handle_ss(ss, gsup, &req);
709 }
710 break;
711 case OSMO_GSUP_SESSION_STATE_END:
712 ss = ss_session_find(hlr, gsup->imsi, gsup->session_id);
713 if (!ss) {
Harald Welte95b96d42018-07-29 12:47:39 +0200714 LOGP(DSS, LOGL_ERROR, "%s/0x%08x: END for unknown SS session\n",
Harald Weltebb779392018-06-16 20:21:10 +0200715 gsup->imsi, gsup->session_id);
716 goto out_err;
717 }
Vadim Yanitskiy937f5832019-07-24 19:14:32 +0700718
719 /* SS payload is optional for END */
720 if (gsup->ss_info && gsup->ss_info_len) {
721 if (ss_op_is_ussd(req.opcode)) {
722 /* dispatch unstructured SS to routing */
723 handle_ussd(conn, ss, gsup, &req);
724 } else {
725 /* dispatch non-call SS to internal code */
726 handle_ss(ss, gsup, &req);
727 }
Harald Weltebb779392018-06-16 20:21:10 +0200728 }
Vadim Yanitskiy937f5832019-07-24 19:14:32 +0700729
Harald Weltebb779392018-06-16 20:21:10 +0200730 ss_session_free(ss);
731 break;
732 default:
Harald Welte95b96d42018-07-29 12:47:39 +0200733 LOGP(DSS, LOGL_ERROR, "%s/0x%08x: Unknown SS State %d\n", gsup->imsi,
Harald Welte7f32f5f2018-07-29 12:43:49 +0200734 gsup->session_id, gsup->session_state);
Harald Weltebb779392018-06-16 20:21:10 +0200735 goto out_err;
736 }
737
738 return 0;
739
740out_err:
741 return 0;
742}
743
744int rx_proc_ss_error(struct osmo_gsup_conn *conn, const struct osmo_gsup_message *gsup)
745{
Harald Welte95b96d42018-07-29 12:47:39 +0200746 LOGP(DSS, LOGL_NOTICE, "%s/0x%08x: Process SS ERROR (%s)\n", gsup->imsi, gsup->session_id,
Harald Weltebb779392018-06-16 20:21:10 +0200747 osmo_gsup_session_state_name(gsup->session_state));
748 return 0;
749}