blob: f356dc4d6ac50139cb8d3ced8e4d6d71a59cc95b [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"
37
38/***********************************************************************
39 * core data structures expressing config from VTY
40 ***********************************************************************/
Harald Welte4956ae12018-06-15 22:04:28 +020041
42struct hlr_euse *euse_find(struct hlr *hlr, const char *name)
43{
44 struct hlr_euse *euse;
45
46 llist_for_each_entry(euse, &hlr->euse_list, list) {
47 if (!strcmp(euse->name, name))
48 return euse;
49 }
50 return NULL;
51}
52
53struct hlr_euse *euse_alloc(struct hlr *hlr, const char *name)
54{
55 struct hlr_euse *euse = euse_find(hlr, name);
56 if (euse)
57 return NULL;
58
59 euse = talloc_zero(hlr, struct hlr_euse);
60 euse->name = talloc_strdup(euse, name);
61 euse->hlr = hlr;
Harald Welte4956ae12018-06-15 22:04:28 +020062 llist_add_tail(&euse->list, &hlr->euse_list);
63
64 return euse;
65}
66
67void euse_del(struct hlr_euse *euse)
68{
69 llist_del(&euse->list);
70 talloc_free(euse);
71}
72
73
Harald Weltedab544e2018-07-29 16:14:48 +020074struct hlr_ussd_route *ussd_route_find_prefix(struct hlr *hlr, const char *prefix)
Harald Welte4956ae12018-06-15 22:04:28 +020075{
Harald Weltedab544e2018-07-29 16:14:48 +020076 struct hlr_ussd_route *rt;
Harald Welte4956ae12018-06-15 22:04:28 +020077
Harald Weltedab544e2018-07-29 16:14:48 +020078 llist_for_each_entry(rt, &hlr->ussd_routes, list) {
Harald Welte4956ae12018-06-15 22:04:28 +020079 if (!strcmp(rt->prefix, prefix))
80 return rt;
81 }
82 return NULL;
83}
84
Harald Weltedab544e2018-07-29 16:14:48 +020085struct hlr_ussd_route *ussd_route_prefix_alloc_int(struct hlr *hlr, const char *prefix,
86 const struct hlr_iuse *iuse)
Harald Welte4956ae12018-06-15 22:04:28 +020087{
Harald Weltedab544e2018-07-29 16:14:48 +020088 struct hlr_ussd_route *rt;
Harald Welte4956ae12018-06-15 22:04:28 +020089
Harald Weltedab544e2018-07-29 16:14:48 +020090 if (ussd_route_find_prefix(hlr, prefix))
Harald Welte4956ae12018-06-15 22:04:28 +020091 return NULL;
92
Harald Weltedab544e2018-07-29 16:14:48 +020093 rt = talloc_zero(hlr, struct hlr_ussd_route);
Harald Welte4956ae12018-06-15 22:04:28 +020094 rt->prefix = talloc_strdup(rt, prefix);
Harald Weltedab544e2018-07-29 16:14:48 +020095 rt->u.iuse = iuse;
96 llist_add_tail(&rt->list, &hlr->ussd_routes);
Harald Welte4956ae12018-06-15 22:04:28 +020097
98 return rt;
99}
100
Harald Weltedab544e2018-07-29 16:14:48 +0200101struct hlr_ussd_route *ussd_route_prefix_alloc_ext(struct hlr *hlr, const char *prefix,
102 struct hlr_euse *euse)
103{
104 struct hlr_ussd_route *rt;
105
106 if (ussd_route_find_prefix(hlr, prefix))
107 return NULL;
108
109 rt = talloc_zero(hlr, struct hlr_ussd_route);
110 rt->prefix = talloc_strdup(rt, prefix);
111 rt->is_external = true;
112 rt->u.euse = euse;
113 llist_add_tail(&rt->list, &hlr->ussd_routes);
114
115 return rt;
116}
117
118void ussd_route_del(struct hlr_ussd_route *rt)
Harald Welte4956ae12018-06-15 22:04:28 +0200119{
120 llist_del(&rt->list);
121 talloc_free(rt);
122}
Harald Weltebb779392018-06-16 20:21:10 +0200123
Harald Weltedab544e2018-07-29 16:14:48 +0200124static struct hlr_ussd_route *ussd_route_lookup_7bit(struct hlr *hlr, const char *ussd_code)
Harald Weltebb779392018-06-16 20:21:10 +0200125{
Harald Weltedab544e2018-07-29 16:14:48 +0200126 struct hlr_ussd_route *rt;
127 llist_for_each_entry(rt, &hlr->ussd_routes, list) {
128 if (!strncmp(ussd_code, rt->prefix, strlen(rt->prefix))) {
Vadim Yanitskiye6c839e2018-08-02 23:59:51 +0700129 LOGP(DSS, LOGL_DEBUG, "Found %s '%s' (prefix '%s') for USSD "
130 "Code '%s'\n", rt->is_external ? "EUSE" : "IUSE",
131 rt->is_external ? rt->u.euse->name : rt->u.iuse->name,
132 rt->prefix, ussd_code);
Harald Weltedab544e2018-07-29 16:14:48 +0200133 return rt;
Harald Weltebb779392018-06-16 20:21:10 +0200134 }
135 }
136
Harald Weltedab544e2018-07-29 16:14:48 +0200137 LOGP(DSS, LOGL_DEBUG, "Could not find Route for USSD Code '%s'\n", ussd_code);
Harald Weltebb779392018-06-16 20:21:10 +0200138 return NULL;
139}
140
141/***********************************************************************
142 * handling functions for individual GSUP messages
143 ***********************************************************************/
144
Harald Welte97bfb652018-07-29 12:28:11 +0200145#define LOGPSS(ss, lvl, fmt, args...) \
Harald Welte95b96d42018-07-29 12:47:39 +0200146 LOGP(DSS, lvl, "%s/0x%08x: " fmt, (ss)->imsi, (ss)->session_id, ## args)
Harald Welte97bfb652018-07-29 12:28:11 +0200147
Harald Weltebb779392018-06-16 20:21:10 +0200148struct ss_session {
149 /* link us to hlr->ss_sessions */
150 struct llist_head list;
151 /* imsi of this session */
152 char imsi[GSM23003_IMSI_MAX_DIGITS+2];
153 /* ID of this session (unique per IMSI) */
154 uint32_t session_id;
155 /* state of the session */
156 enum osmo_gsup_session_state state;
157 /* time-out when we will delete the session */
158 struct osmo_timer_list timeout;
159
Harald Weltedab544e2018-07-29 16:14:48 +0200160 /* is this USSD for an external handler (EUSE): true */
161 bool is_external;
162 union {
163 /* external USSD Entity responsible for this session */
164 struct hlr_euse *euse;
165 /* internal USSD Entity responsible for this session */
166 const struct hlr_iuse *iuse;
167 } u;
168
Harald Weltebb779392018-06-16 20:21:10 +0200169 /* we don't keep a pointer to the osmo_gsup_{route,conn} towards the MSC/VLR here,
170 * as this might change during inter-VLR hand-over, and we simply look-up the serving MSC/VLR
171 * every time we receive an USSD component from the EUSE */
172};
173
174struct ss_session *ss_session_find(struct hlr *hlr, const char *imsi, uint32_t session_id)
175{
176 struct ss_session *ss;
177 llist_for_each_entry(ss, &hlr->ss_sessions, list) {
178 if (!strcmp(ss->imsi, imsi) && ss->session_id == session_id)
179 return ss;
180 }
181 return NULL;
182}
183
184void ss_session_free(struct ss_session *ss)
185{
186 osmo_timer_del(&ss->timeout);
187 llist_del(&ss->list);
188 talloc_free(ss);
189}
190
191static void ss_session_timeout(void *data)
192{
193 struct ss_session *ss = data;
194
Harald Welte97bfb652018-07-29 12:28:11 +0200195 LOGPSS(ss, LOGL_NOTICE, "SS Session Timeout, destroying\n");
Harald Weltebb779392018-06-16 20:21:10 +0200196 /* FIXME: should we send a ReturnError component to the MS? */
197 ss_session_free(ss);
198}
199
200struct ss_session *ss_session_alloc(struct hlr *hlr, const char *imsi, uint32_t session_id)
201{
202 struct ss_session *ss;
203
204 OSMO_ASSERT(!ss_session_find(hlr, imsi, session_id));
205
206 ss = talloc_zero(hlr, struct ss_session);
207 OSMO_ASSERT(ss);
208
209 OSMO_STRLCPY_ARRAY(ss->imsi, imsi);
210 ss->session_id = session_id;
Vadim Yanitskiye6ce52b2018-12-01 00:16:44 +0700211
212 /* Schedule self-destruction timer */
Harald Weltebb779392018-06-16 20:21:10 +0200213 osmo_timer_setup(&ss->timeout, ss_session_timeout, ss);
Vadim Yanitskiyd157a562018-12-01 00:03:39 +0700214 if (g_hlr->ncss_guard_timeout > 0)
215 osmo_timer_schedule(&ss->timeout, g_hlr->ncss_guard_timeout, 0);
Harald Weltebb779392018-06-16 20:21:10 +0200216
217 llist_add_tail(&ss->list, &hlr->ss_sessions);
218 return ss;
219}
220
221/***********************************************************************
Harald Welte72667312018-07-29 12:38:09 +0200222 * handling functions for encoding SS messages + wrapping them in GSUP
223 ***********************************************************************/
224
225static int ss_tx_to_ms(struct ss_session *ss, enum osmo_gsup_message_type gsup_msg_type,
226 bool final, struct msgb *ss_msg)
227
228{
229 struct osmo_gsup_message resp = {0};
230 struct msgb *resp_msg;
231
232 resp.message_type = gsup_msg_type;
233 OSMO_STRLCPY_ARRAY(resp.imsi, ss->imsi);
234 if (final)
235 resp.session_state = OSMO_GSUP_SESSION_STATE_END;
236 else
237 resp.session_state = OSMO_GSUP_SESSION_STATE_CONTINUE;
238 resp.session_id = ss->session_id;
239 if (ss_msg) {
240 resp.ss_info = msgb_data(ss_msg);
241 resp.ss_info_len = msgb_length(ss_msg);
242 }
243
244 resp_msg = gsm0480_msgb_alloc_name(__func__);
245 OSMO_ASSERT(resp_msg);
246 osmo_gsup_encode(resp_msg, &resp);
247 msgb_free(ss_msg);
248
249 /* FIXME: resolve this based on the database vlr_addr */
250 return osmo_gsup_addr_send(g_hlr->gs, (uint8_t *)"MSC-00-00-00-00-00-00", 22, resp_msg);
251}
252
253#if 0
254static int ss_tx_reject(struct ss_session *ss, int invoke_id, uint8_t problem_tag,
255 uint8_t problem_code)
256{
257 struct msgb *msg = gsm0480_gen_reject(invoke_id, problem_tag, problem_code);
258 LOGPSS(ss, LOGL_NOTICE, "Tx Reject(%u, 0x%02x, 0x%02x)\n", invoke_id,
259 problem_tag, problem_code);
260 OSMO_ASSERT(msg);
261 return ss_tx_to_ms(ss, OSMO_GSUP_MSGT_PROC_SS_RESULT, true, msg);
262}
263#endif
264
265static int ss_tx_error(struct ss_session *ss, uint8_t invoke_id, uint8_t error_code)
266{
267 struct msgb *msg = gsm0480_gen_return_error(invoke_id, error_code);
268 LOGPSS(ss, LOGL_NOTICE, "Tx ReturnError(%u, 0x%02x)\n", invoke_id, error_code);
269 OSMO_ASSERT(msg);
270 return ss_tx_to_ms(ss, OSMO_GSUP_MSGT_PROC_SS_RESULT, true, msg);
271}
272
Harald Weltedab544e2018-07-29 16:14:48 +0200273static int ss_tx_ussd_7bit(struct ss_session *ss, bool final, uint8_t invoke_id, const char *text)
274{
275 struct msgb *msg = gsm0480_gen_ussd_resp_7bit(invoke_id, text);
276 LOGPSS(ss, LOGL_INFO, "Tx USSD '%s'\n", text);
277 OSMO_ASSERT(msg);
278 return ss_tx_to_ms(ss, OSMO_GSUP_MSGT_PROC_SS_RESULT, final, msg);
279}
280
281/***********************************************************************
282 * Internal USSD Handlers
283 ***********************************************************************/
284
285#include "db.h"
286
287static int handle_ussd_own_msisdn(struct osmo_gsup_conn *conn, struct ss_session *ss,
288 const struct osmo_gsup_message *gsup, const struct ss_request *req)
289{
290 struct hlr_subscriber subscr;
291 char buf[GSM0480_USSD_7BIT_STRING_LEN+1];
292 int rc;
293
294 rc = db_subscr_get_by_imsi(g_hlr->dbc, ss->imsi, &subscr);
295 switch (rc) {
296 case 0:
297 if (strlen(subscr.msisdn) == 0)
298 snprintf(buf, sizeof(buf), "You have no MSISDN!");
299 else
Vadim Yanitskiy3adb33d2018-08-03 00:07:54 +0700300 snprintf(buf, sizeof(buf), "Your extension is %s", subscr.msisdn);
Harald Weltedab544e2018-07-29 16:14:48 +0200301 ss_tx_ussd_7bit(ss, true, req->invoke_id, buf);
302 break;
303 case -ENOENT:
304 ss_tx_error(ss, true, GSM0480_ERR_CODE_UNKNOWN_SUBSCRIBER);
305 break;
306 case -EIO:
307 default:
308 ss_tx_error(ss, true, GSM0480_ERR_CODE_SYSTEM_FAILURE);
309 break;
310 }
311 return 0;
312}
313
314static int handle_ussd_own_imsi(struct osmo_gsup_conn *conn, struct ss_session *ss,
315 const struct osmo_gsup_message *gsup, const struct ss_request *req)
316{
317 char buf[GSM0480_USSD_7BIT_STRING_LEN+1];
Vadim Yanitskiy3adb33d2018-08-03 00:07:54 +0700318 snprintf(buf, sizeof(buf), "Your IMSI is %s", ss->imsi);
Harald Weltedab544e2018-07-29 16:14:48 +0200319 ss_tx_ussd_7bit(ss, true, req->invoke_id, buf);
320 return 0;
321}
322
Vadim Yanitskiya60ad0d2018-12-27 05:39:54 +0700323static int handle_ussd_get_ran(struct osmo_gsup_conn *conn, struct ss_session *ss,
324 const struct osmo_gsup_message *gsup,
325 const struct ss_request *req)
326{
327 struct hlr_subscriber subscr;
Neels Hofmeyr081af6b2018-12-29 04:10:35 +0100328 char response[512];
Vadim Yanitskiya60ad0d2018-12-27 05:39:54 +0700329 int rc;
Neels Hofmeyr081af6b2018-12-29 04:10:35 +0100330 const char *rat;
Vadim Yanitskiya60ad0d2018-12-27 05:39:54 +0700331
332 rc = db_subscr_get_by_imsi(g_hlr->dbc, ss->imsi, &subscr);
333 switch (rc) {
334 case 0:
Neels Hofmeyr081af6b2018-12-29 04:10:35 +0100335 if (!*subscr.last_lu_rat)
336 rat = "nothing, you don't exist";
337 else if (!strcmp(subscr.last_lu_rat, "GERAN-A"))
338 rat = "2G";
339 else if (!strcmp(subscr.last_lu_rat, "UTRAN-Iu"))
340 rat = "3G";
Vadim Yanitskiya60ad0d2018-12-27 05:39:54 +0700341 else
Neels Hofmeyr081af6b2018-12-29 04:10:35 +0100342 rat = subscr.last_lu_rat;
343
344 snprintf(response, sizeof(response),
345 "Now on %s. Available:%s%s."
Neels Hofmeyrc1322b52018-12-29 05:29:00 +0100346 " (2G on: *#201# off: *#200# -- 3G on: *#301# off: *#300#)", rat,
Neels Hofmeyr081af6b2018-12-29 04:10:35 +0100347 subscr.rat_types[OSMO_RAT_GERAN_A]? " 2G" : "",
348 subscr.rat_types[OSMO_RAT_UTRAN_IU]? " 3G" : "");
Vadim Yanitskiya60ad0d2018-12-27 05:39:54 +0700349
350 rc = ss_tx_ussd_7bit(ss, true, req->invoke_id, response);
351 break;
352 case -ENOENT:
353 rc = ss_tx_error(ss, true, GSM0480_ERR_CODE_UNKNOWN_SUBSCRIBER);
354 break;
355 case -EIO:
356 default:
357 rc = ss_tx_error(ss, true, GSM0480_ERR_CODE_SYSTEM_FAILURE);
358 break;
359 }
360
361 return rc;
362}
Harald Weltedab544e2018-07-29 16:14:48 +0200363
Neels Hofmeyrc1322b52018-12-29 05:29:00 +0100364static int handle_ussd_gsm_on(struct osmo_gsup_conn *conn, struct ss_session *ss,
365 const struct osmo_gsup_message *gsup,
366 const struct ss_request *req)
367{
368 struct hlr_subscriber subscr;
369 int rc;
370
371 rc = db_subscr_get_by_imsi(g_hlr->dbc, ss->imsi, &subscr);
372 switch (rc) {
373 case 0:
374 hlr_subscr_rat_flag(g_hlr, &subscr, OSMO_RAT_GERAN_A, true);
375 rc = ss_tx_ussd_7bit(ss, true, req->invoke_id,
376 "Enabled GERAN-A (2G)");
377 break;
378 case -ENOENT:
379 rc = ss_tx_error(ss, true, GSM0480_ERR_CODE_UNKNOWN_SUBSCRIBER);
380 break;
381 case -EIO:
382 default:
383 rc = ss_tx_error(ss, true, GSM0480_ERR_CODE_SYSTEM_FAILURE);
384 break;
385 }
386
387 return rc;
388}
389
390static int handle_ussd_gsm_off(struct osmo_gsup_conn *conn, struct ss_session *ss,
391 const struct osmo_gsup_message *gsup,
392 const struct ss_request *req)
393{
394 struct hlr_subscriber subscr;
395 int rc;
396
397 rc = db_subscr_get_by_imsi(g_hlr->dbc, ss->imsi, &subscr);
398 switch (rc) {
399 case 0:
400 hlr_subscr_rat_flag(g_hlr, &subscr, OSMO_RAT_GERAN_A, false);
401 rc = ss_tx_ussd_7bit(ss, true, req->invoke_id,
402 "Disabled GERAN-A (2G)");
403 break;
404 case -ENOENT:
405 rc = ss_tx_error(ss, true, GSM0480_ERR_CODE_UNKNOWN_SUBSCRIBER);
406 break;
407 case -EIO:
408 default:
409 rc = ss_tx_error(ss, true, GSM0480_ERR_CODE_SYSTEM_FAILURE);
410 break;
411 }
412
413 return rc;
414}
415
Vadim Yanitskiybe9fd432018-12-27 08:15:00 +0700416static int handle_ussd_umts_on(struct osmo_gsup_conn *conn, struct ss_session *ss,
417 const struct osmo_gsup_message *gsup,
418 const struct ss_request *req)
419{
420 struct hlr_subscriber subscr;
421 int rc;
422
423 rc = db_subscr_get_by_imsi(g_hlr->dbc, ss->imsi, &subscr);
424 switch (rc) {
425 case 0:
426 hlr_subscr_rat_flag(g_hlr, &subscr, OSMO_RAT_UTRAN_IU, true);
427 rc = ss_tx_ussd_7bit(ss, true, req->invoke_id,
428 "Enabled UTRAN-Iu (3G)");
429 break;
430 case -ENOENT:
431 rc = ss_tx_error(ss, true, GSM0480_ERR_CODE_UNKNOWN_SUBSCRIBER);
432 break;
433 case -EIO:
434 default:
435 rc = ss_tx_error(ss, true, GSM0480_ERR_CODE_SYSTEM_FAILURE);
436 break;
437 }
438
439 return rc;
440}
441
442static int handle_ussd_umts_off(struct osmo_gsup_conn *conn, struct ss_session *ss,
443 const struct osmo_gsup_message *gsup,
444 const struct ss_request *req)
445{
446 struct hlr_subscriber subscr;
447 int rc;
448
449 rc = db_subscr_get_by_imsi(g_hlr->dbc, ss->imsi, &subscr);
450 switch (rc) {
451 case 0:
452 hlr_subscr_rat_flag(g_hlr, &subscr, OSMO_RAT_UTRAN_IU, false);
453 rc = ss_tx_ussd_7bit(ss, true, req->invoke_id,
454 "Disabled UTRAN-Iu (3G)");
455 break;
456 case -ENOENT:
457 rc = ss_tx_error(ss, true, GSM0480_ERR_CODE_UNKNOWN_SUBSCRIBER);
458 break;
459 case -EIO:
460 default:
461 rc = ss_tx_error(ss, true, GSM0480_ERR_CODE_SYSTEM_FAILURE);
462 break;
463 }
464
465 return rc;
466}
467
Harald Weltedab544e2018-07-29 16:14:48 +0200468static const struct hlr_iuse hlr_iuses[] = {
469 {
470 .name = "own-msisdn",
471 .handle_ussd = handle_ussd_own_msisdn,
472 },
473 {
474 .name = "own-imsi",
475 .handle_ussd = handle_ussd_own_imsi,
476 },
Vadim Yanitskiya60ad0d2018-12-27 05:39:54 +0700477 {
478 .name = "get-ran",
479 .handle_ussd = handle_ussd_get_ran,
480 },
Vadim Yanitskiybe9fd432018-12-27 08:15:00 +0700481 {
Neels Hofmeyrc1322b52018-12-29 05:29:00 +0100482 .name = "gsm-on",
483 .handle_ussd = handle_ussd_gsm_on,
484 },
485 {
486 .name = "gsm-off",
487 .handle_ussd = handle_ussd_gsm_off,
488 },
489 {
Vadim Yanitskiybe9fd432018-12-27 08:15:00 +0700490 .name = "umts-on",
491 .handle_ussd = handle_ussd_umts_on,
492 },
493 {
494 .name = "umts-off",
495 .handle_ussd = handle_ussd_umts_off,
496 },
Harald Weltedab544e2018-07-29 16:14:48 +0200497};
498
499const struct hlr_iuse *iuse_find(const char *name)
500{
501 unsigned int i;
502
503 for (i = 0; i < ARRAY_SIZE(hlr_iuses); i++) {
504 const struct hlr_iuse *iuse = &hlr_iuses[i];
505 if (!strcmp(name, iuse->name))
506 return iuse;
507 }
508 return NULL;
509}
Harald Welte72667312018-07-29 12:38:09 +0200510
511
512/***********************************************************************
Harald Weltebb779392018-06-16 20:21:10 +0200513 * handling functions for individual GSUP messages
514 ***********************************************************************/
515
516static bool ss_op_is_ussd(uint8_t opcode)
517{
518 switch (opcode) {
519 case GSM0480_OP_CODE_PROCESS_USS_DATA:
520 case GSM0480_OP_CODE_PROCESS_USS_REQ:
521 case GSM0480_OP_CODE_USS_REQUEST:
522 case GSM0480_OP_CODE_USS_NOTIFY:
523 return true;
524 default:
525 return false;
526 }
527}
528
529/* is this GSUP connection an EUSE (true) or not (false)? */
530static bool conn_is_euse(struct osmo_gsup_conn *conn)
531{
532 int rc;
533 uint8_t *addr;
534
535 rc = osmo_gsup_conn_ccm_get(conn, &addr, IPAC_IDTAG_SERNR);
536 if (rc <= 5)
537 return false;
538 if (!strncmp((char *)addr, "EUSE-", 5))
539 return true;
540 else
541 return false;
542}
543
544static struct hlr_euse *euse_by_conn(struct osmo_gsup_conn *conn)
545{
546 int rc;
547 char *addr;
548 struct hlr *hlr = conn->server->priv;
549
550 rc = osmo_gsup_conn_ccm_get(conn, (uint8_t **) &addr, IPAC_IDTAG_SERNR);
551 if (rc <= 5)
552 return NULL;
553 if (strncmp(addr, "EUSE-", 5))
554 return NULL;
555
556 return euse_find(hlr, addr+5);
557}
558
559static int handle_ss(struct ss_session *ss, const struct osmo_gsup_message *gsup,
560 const struct ss_request *req)
561{
562 uint8_t comp_type = gsup->ss_info[0];
563
Harald Welte7f32f5f2018-07-29 12:43:49 +0200564 LOGPSS(ss, LOGL_INFO, "SS CompType=%s, OpCode=%s\n",
Harald Weltebb779392018-06-16 20:21:10 +0200565 gsm0480_comp_type_name(comp_type), gsm0480_op_code_name(req->opcode));
Vadim Yanitskiy4a4bdcd2018-10-12 21:44:07 +0200566
567 /**
568 * FIXME: As we don't store any SS related information
569 * (e.g. call forwarding preferences) in the database,
570 * we don't handle "structured" SS requests at all.
571 */
572 LOGPSS(ss, LOGL_NOTICE, "Structured SS requests are not supported, rejecting...\n");
573 ss_tx_error(ss, req->invoke_id, GSM0480_ERR_CODE_FACILITY_NOT_SUPPORTED);
574 return -ENOTSUP;
Harald Weltebb779392018-06-16 20:21:10 +0200575}
576
Harald Weltedab544e2018-07-29 16:14:48 +0200577/* Handle a USSD GSUP message for a given SS Session received from VLR or EUSE */
Harald Weltebb779392018-06-16 20:21:10 +0200578static int handle_ussd(struct osmo_gsup_conn *conn, struct ss_session *ss,
579 const struct osmo_gsup_message *gsup, const struct ss_request *req)
580{
581 uint8_t comp_type = gsup->ss_info[0];
582 struct msgb *msg_out;
583 bool is_euse_originated = conn_is_euse(conn);
584
Harald Welte7f32f5f2018-07-29 12:43:49 +0200585 LOGPSS(ss, LOGL_INFO, "USSD CompType=%s, OpCode=%s '%s'\n",
Harald Weltebb779392018-06-16 20:21:10 +0200586 gsm0480_comp_type_name(comp_type), gsm0480_op_code_name(req->opcode),
587 req->ussd_text);
588
Harald Weltedab544e2018-07-29 16:14:48 +0200589 if ((ss->is_external && !ss->u.euse) || !ss->u.iuse) {
Harald Welte7f32f5f2018-07-29 12:43:49 +0200590 LOGPSS(ss, LOGL_NOTICE, "USSD for unknown code '%s'\n", req->ussd_text);
Harald Welte72667312018-07-29 12:38:09 +0200591 ss_tx_error(ss, req->invoke_id, GSM0480_ERR_CODE_SS_NOT_AVAILABLE);
Harald Weltebb779392018-06-16 20:21:10 +0200592 return 0;
593 }
594
595 if (is_euse_originated) {
Harald Welte72667312018-07-29 12:38:09 +0200596 msg_out = msgb_alloc_headroom(1024+16, 16, "GSUP USSD FW");
597 OSMO_ASSERT(msg_out);
Harald Weltebb779392018-06-16 20:21:10 +0200598 /* Received from EUSE, Forward to VLR */
599 osmo_gsup_encode(msg_out, gsup);
600 /* FIXME: resolve this based on the database vlr_addr */
601 osmo_gsup_addr_send(conn->server, (uint8_t *)"MSC-00-00-00-00-00-00", 22, msg_out);
602 } else {
Harald Weltedab544e2018-07-29 16:14:48 +0200603 /* Received from VLR (MS) */
604 if (ss->is_external) {
605 /* Forward to EUSE */
606 char addr[128];
607 strcpy(addr, "EUSE-");
608 osmo_strlcpy(addr+5, ss->u.euse->name, sizeof(addr)-5);
609 conn = gsup_route_find(conn->server, (uint8_t *)addr, strlen(addr)+1);
610 if (!conn) {
611 LOGPSS(ss, LOGL_ERROR, "Cannot find conn for EUSE %s\n", addr);
612 ss_tx_error(ss, req->invoke_id, GSM0480_ERR_CODE_SYSTEM_FAILURE);
613 } else {
614 msg_out = msgb_alloc_headroom(1024+16, 16, "GSUP USSD FW");
615 OSMO_ASSERT(msg_out);
616 osmo_gsup_encode(msg_out, gsup);
617 osmo_gsup_conn_send(conn, msg_out);
618 }
Harald Welte72667312018-07-29 12:38:09 +0200619 } else {
Harald Weltedab544e2018-07-29 16:14:48 +0200620 /* Handle internally */
621 ss->u.iuse->handle_ussd(conn, ss, gsup, req);
Vadim Yanitskiy9c8806a2018-11-30 08:11:19 +0700622 /* Release session immediately */
623 ss_session_free(ss);
Harald Weltebb779392018-06-16 20:21:10 +0200624 }
Harald Weltebb779392018-06-16 20:21:10 +0200625 }
626
627 return 0;
628}
629
630
631/* this function is called for any SS_REQ/SS_RESP messages from both the MSC/VLR side as well
632 * as from the EUSE side */
633int rx_proc_ss_req(struct osmo_gsup_conn *conn, const struct osmo_gsup_message *gsup)
634{
635 struct hlr *hlr = conn->server->priv;
636 struct ss_session *ss;
637 struct ss_request req = {0};
638
Harald Welte95b96d42018-07-29 12:47:39 +0200639 LOGP(DSS, LOGL_DEBUG, "%s/0x%08x: Process SS (%s)\n", gsup->imsi, gsup->session_id,
Harald Weltebb779392018-06-16 20:21:10 +0200640 osmo_gsup_session_state_name(gsup->session_state));
641
642 /* decode and find out what kind of SS message it is */
643 if (gsup->ss_info && gsup->ss_info_len) {
644 if (gsm0480_parse_facility_ie(gsup->ss_info, gsup->ss_info_len, &req)) {
Harald Welte95b96d42018-07-29 12:47:39 +0200645 LOGP(DSS, LOGL_ERROR, "%s/0x%082x: Unable to parse SS request: %s\n",
Harald Weltebb779392018-06-16 20:21:10 +0200646 gsup->imsi, gsup->session_id,
647 osmo_hexdump(gsup->ss_info, gsup->ss_info_len));
Harald Welte72667312018-07-29 12:38:09 +0200648 /* FIXME: Send a Reject component? */
Harald Weltebb779392018-06-16 20:21:10 +0200649 goto out_err;
650 }
651 }
652
653 switch (gsup->session_state) {
654 case OSMO_GSUP_SESSION_STATE_BEGIN:
655 /* Check for overlapping Session ID usage */
656 if (ss_session_find(hlr, gsup->imsi, gsup->session_id)) {
Harald Welte95b96d42018-07-29 12:47:39 +0200657 LOGP(DSS, LOGL_ERROR, "%s/0x%08x: BEGIN with non-unique session ID!\n",
Harald Weltebb779392018-06-16 20:21:10 +0200658 gsup->imsi, gsup->session_id);
659 goto out_err;
660 }
661 ss = ss_session_alloc(hlr, gsup->imsi, gsup->session_id);
662 if (!ss) {
Harald Welte95b96d42018-07-29 12:47:39 +0200663 LOGP(DSS, LOGL_ERROR, "%s/0x%08x: Unable to allocate SS session\n",
Harald Weltebb779392018-06-16 20:21:10 +0200664 gsup->imsi, gsup->session_id);
665 goto out_err;
666 }
667 if (ss_op_is_ussd(req.opcode)) {
668 if (conn_is_euse(conn)) {
669 /* EUSE->VLR: MT USSD. EUSE is known ('conn'), VLR is to be resolved */
Harald Weltedab544e2018-07-29 16:14:48 +0200670 ss->u.euse = euse_by_conn(conn);
Harald Weltebb779392018-06-16 20:21:10 +0200671 } else {
672 /* VLR->EUSE: MO USSD. VLR is known ('conn'), EUSE is to be resolved */
Harald Weltedab544e2018-07-29 16:14:48 +0200673 struct hlr_ussd_route *rt;
674 rt = ussd_route_lookup_7bit(hlr, (const char *) req.ussd_text);
675 if (rt) {
676 if (rt->is_external) {
677 ss->is_external = true;
678 ss->u.euse = rt->u.euse;
679 } else if (rt) {
680 ss->is_external = false;
681 ss->u.iuse = rt->u.iuse;
682 }
Harald Welte1eb98692018-08-08 08:57:26 +0200683 } else {
684 if (hlr->euse_default) {
685 ss->is_external = true;
686 ss->u.euse = hlr->euse_default;
687 }
Harald Weltedab544e2018-07-29 16:14:48 +0200688 }
Harald Weltebb779392018-06-16 20:21:10 +0200689 }
690 /* dispatch unstructured SS to routing */
691 handle_ussd(conn, ss, gsup, &req);
692 } else {
693 /* dispatch non-call SS to internal code */
694 handle_ss(ss, gsup, &req);
695 }
696 break;
697 case OSMO_GSUP_SESSION_STATE_CONTINUE:
698 ss = ss_session_find(hlr, gsup->imsi, gsup->session_id);
699 if (!ss) {
Harald Welte95b96d42018-07-29 12:47:39 +0200700 LOGP(DSS, LOGL_ERROR, "%s/0x%08x: CONTINUE for unknown SS session\n",
Harald Weltebb779392018-06-16 20:21:10 +0200701 gsup->imsi, gsup->session_id);
702 goto out_err;
703 }
Vadim Yanitskiye6ce52b2018-12-01 00:16:44 +0700704
705 /* Reschedule self-destruction timer */
706 if (g_hlr->ncss_guard_timeout > 0)
707 osmo_timer_schedule(&ss->timeout, g_hlr->ncss_guard_timeout, 0);
708
Harald Weltebb779392018-06-16 20:21:10 +0200709 if (ss_op_is_ussd(req.opcode)) {
710 /* dispatch unstructured SS to routing */
711 handle_ussd(conn, ss, gsup, &req);
712 } else {
713 /* dispatch non-call SS to internal code */
714 handle_ss(ss, gsup, &req);
715 }
716 break;
717 case OSMO_GSUP_SESSION_STATE_END:
718 ss = ss_session_find(hlr, gsup->imsi, gsup->session_id);
719 if (!ss) {
Harald Welte95b96d42018-07-29 12:47:39 +0200720 LOGP(DSS, LOGL_ERROR, "%s/0x%08x: END for unknown SS session\n",
Harald Weltebb779392018-06-16 20:21:10 +0200721 gsup->imsi, gsup->session_id);
722 goto out_err;
723 }
724 if (ss_op_is_ussd(req.opcode)) {
725 /* dispatch unstructured SS to routing */
726 handle_ussd(conn, ss, gsup, &req);
727 } else {
728 /* dispatch non-call SS to internal code */
729 handle_ss(ss, gsup, &req);
730 }
731 ss_session_free(ss);
732 break;
733 default:
Harald Welte95b96d42018-07-29 12:47:39 +0200734 LOGP(DSS, LOGL_ERROR, "%s/0x%08x: Unknown SS State %d\n", gsup->imsi,
Harald Welte7f32f5f2018-07-29 12:43:49 +0200735 gsup->session_id, gsup->session_state);
Harald Weltebb779392018-06-16 20:21:10 +0200736 goto out_err;
737 }
738
739 return 0;
740
741out_err:
742 return 0;
743}
744
745int rx_proc_ss_error(struct osmo_gsup_conn *conn, const struct osmo_gsup_message *gsup)
746{
Harald Welte95b96d42018-07-29 12:47:39 +0200747 LOGP(DSS, LOGL_NOTICE, "%s/0x%08x: Process SS ERROR (%s)\n", gsup->imsi, gsup->session_id,
Harald Weltebb779392018-06-16 20:21:10 +0200748 osmo_gsup_session_state_name(gsup->session_state));
749 return 0;
750}