Harald Welte | f9d449e | 2018-06-24 22:27:47 +0200 | [diff] [blame] | 1 | /* Simple / General implementation of an External USSD Entity using OsmoHLR's GSUP Protocol |
| 2 | * |
| 3 | * The idea is that a test case can simply start an instance of this component in parallel to its |
| 4 | * normal test components. HLR_EUSE_CT will then connect via GSUP to the HLR as the specified EUSE |
| 5 | * name. Any USSD related GSUP message received will be passed to a user-provided call-back |
| 6 | * function, which will return whatever PDU to send in response back to the HLR. |
| 7 | */ |
| 8 | |
Harald Welte | 34b5a95 | 2019-05-27 11:54:11 +0200 | [diff] [blame] | 9 | |
| 10 | /* (C) 2018 Harald Welte <laforge@gnumonks.org> |
| 11 | * All rights reserved. |
| 12 | * |
| 13 | * Released under the terms of GNU General Public License, Version 2 or |
| 14 | * (at your option) any later version. |
| 15 | * |
| 16 | * SPDX-License-Identifier: GPL-2.0-or-later |
| 17 | */ |
Harald Welte | f9d449e | 2018-06-24 22:27:47 +0200 | [diff] [blame] | 18 | |
| 19 | module HLR_EUSE { |
| 20 | |
| 21 | import from GSUP_Types all; |
| 22 | import from IPA_Emulation all; |
| 23 | |
| 24 | import from General_Types all; |
| 25 | import from Osmocom_Types all; |
| 26 | import from SS_Types all; |
| 27 | import from SS_Templates all; |
| 28 | |
| 29 | /* emulating an external USSD Entity towards OsmoHLR */ |
| 30 | type component HLR_EUSE_CT { |
| 31 | /* Component reference + config of underlying IPA emulation */ |
| 32 | var IPA_Emulation_CT vc_IPA_EUSE; |
| 33 | var IPA_CCM_Parameters ccm_pars; |
| 34 | /* port towards the underlying IPA emulation */ |
| 35 | port IPA_GSUP_PT EUSE; |
| 36 | } |
| 37 | |
| 38 | private function f_init(charstring hlr_ip, uint16_t hlr_gsup_port, charstring name) runs on HLR_EUSE_CT { |
| 39 | var charstring id := "EUSE-" & name; |
| 40 | ccm_pars := c_IPA_default_ccm_pars; |
| 41 | ccm_pars.name := "Osmocom TTCN-3 EUSE Simulator"; |
| 42 | ccm_pars.ser_nr := id; |
| 43 | |
| 44 | vc_IPA_EUSE := IPA_Emulation_CT.create("IPA-" & id); |
| 45 | map(vc_IPA_EUSE:IPA_PORT, system:IPA_CODEC_PT); |
| 46 | connect(vc_IPA_EUSE:IPA_GSUP_PORT, self:EUSE); |
| 47 | vc_IPA_EUSE.start(IPA_Emulation.main_client(hlr_ip, hlr_gsup_port, "", 0, ccm_pars)); |
| 48 | |
| 49 | timer T := 10.0; |
| 50 | T.start; |
| 51 | alt { |
Vadim Yanitskiy | a2afacc | 2020-05-18 21:16:19 +0700 | [diff] [blame] | 52 | [] EUSE.receive(tr_ASP_IPA_EV(ASP_IPA_EVENT_UP)) { repeat; } |
| 53 | [] EUSE.receive(tr_ASP_IPA_EV(ASP_IPA_EVENT_ID_ACK)) { } |
Harald Welte | f9d449e | 2018-06-24 22:27:47 +0200 | [diff] [blame] | 54 | [] T.timeout { |
| 55 | setverdict(fail, "EUSE: Timeout waiting for GSUP IPA Link to come up"); |
| 56 | self.stop; |
| 57 | } |
| 58 | } |
| 59 | } |
| 60 | |
Vadim Yanitskiy | d686a8a | 2018-11-02 02:42:32 +0700 | [diff] [blame] | 61 | type function f_euse_cb(GSUP_PDU rx_pdu) return GSUP_PDU; |
Harald Welte | f9d449e | 2018-06-24 22:27:47 +0200 | [diff] [blame] | 62 | |
Vadim Yanitskiy | d686a8a | 2018-11-02 02:42:32 +0700 | [diff] [blame] | 63 | function f_ss_echo_continue(GSUP_PDU rx_pdu) return GSUP_PDU { |
Harald Welte | f9d449e | 2018-06-24 22:27:47 +0200 | [diff] [blame] | 64 | var GSUP_SessionState ss_next_state; |
Vadim Yanitskiy | d686a8a | 2018-11-02 02:42:32 +0700 | [diff] [blame] | 65 | var GSUP_IeValue ss_ie, state_ie; |
Harald Welte | f9d449e | 2018-06-24 22:27:47 +0200 | [diff] [blame] | 66 | var SS_FacilityInformation dec_fac, rsp_fac; |
| 67 | var octetstring ss_rsp; |
| 68 | |
Daniel Willmann | e2bd04a | 2018-11-06 16:31:27 +0100 | [diff] [blame] | 69 | f_gsup_find_ie(rx_pdu, OSMO_GSUP_SESSION_STATE_IE, state_ie); |
Vadim Yanitskiy | d686a8a | 2018-11-02 02:42:32 +0700 | [diff] [blame] | 70 | var GSUP_SessionState ss_state := state_ie.session_state; |
| 71 | |
Harald Welte | f9d449e | 2018-06-24 22:27:47 +0200 | [diff] [blame] | 72 | f_gsup_find_ie(rx_pdu, OSMO_GSUP_SS_INFO_IE, ss_ie); |
| 73 | dec_fac := dec_SS_FacilityInformation(ss_ie.ss_info); |
| 74 | log("dec_fac: ", dec_fac); |
| 75 | rsp_fac := valueof(ts_SS_USSD_FACILITY_RETURN_RESULT(dec_fac[0].invoke.invokeId.present_, |
| 76 | SS_OP_CODE_PROCESS_USS_REQ, |
| 77 | dec_fac[0].invoke.argument.uSSD_Arg.ussd_DataCodingScheme, |
| 78 | dec_fac[0].invoke.argument.uSSD_Arg.ussd_String)); |
| 79 | ss_rsp := enc_SS_FacilityInformation(rsp_fac); |
| 80 | select (ss_state) { |
| 81 | case (OSMO_GSUP_SESSION_STATE_BEGIN) { ss_next_state := OSMO_GSUP_SESSION_STATE_CONTINUE; } |
| 82 | case (OSMO_GSUP_SESSION_STATE_CONTINUE) { ss_next_state := OSMO_GSUP_SESSION_STATE_END; } |
| 83 | } |
| 84 | return valueof(ts_GSUP_PROC_SS_RES(rx_pdu.ies[0].val.imsi, rx_pdu.ies[1].val.session_id, |
| 85 | ss_next_state, ss_rsp)); |
| 86 | } |
| 87 | |
Vadim Yanitskiy | d686a8a | 2018-11-02 02:42:32 +0700 | [diff] [blame] | 88 | function f_ss_echo(GSUP_PDU rx_pdu) return GSUP_PDU { |
Harald Welte | f9d449e | 2018-06-24 22:27:47 +0200 | [diff] [blame] | 89 | var GSUP_IeValue ss_ie; |
| 90 | var SS_FacilityInformation dec_fac, rsp_fac; |
| 91 | var octetstring ss_rsp; |
| 92 | |
| 93 | f_gsup_find_ie(rx_pdu, OSMO_GSUP_SS_INFO_IE, ss_ie); |
| 94 | dec_fac := dec_SS_FacilityInformation(ss_ie.ss_info); |
| 95 | log("dec_fac: ", dec_fac); |
| 96 | rsp_fac := valueof(ts_SS_USSD_FACILITY_RETURN_RESULT(dec_fac[0].invoke.invokeId.present_, |
| 97 | SS_OP_CODE_PROCESS_USS_REQ, |
| 98 | dec_fac[0].invoke.argument.uSSD_Arg.ussd_DataCodingScheme, |
| 99 | dec_fac[0].invoke.argument.uSSD_Arg.ussd_String)); |
| 100 | ss_rsp := enc_SS_FacilityInformation(rsp_fac); |
| 101 | return valueof(ts_GSUP_PROC_SS_RES(rx_pdu.ies[0].val.imsi, rx_pdu.ies[1].val.session_id, |
| 102 | OSMO_GSUP_SESSION_STATE_END, ss_rsp)); |
| 103 | } |
| 104 | |
| 105 | /* main function for handling mobile-originated USSD via GSUP */ |
| 106 | function f_main_mo(charstring hlr_ip, uint16_t hlr_gsup_port, charstring name, f_euse_cb cb_fn) |
| 107 | runs on HLR_EUSE_CT { |
| 108 | var GSUP_PDU rx_pdu, tx_pdu; |
| 109 | |
| 110 | f_init(hlr_ip, hlr_gsup_port, name); |
| 111 | |
| 112 | while (true) { |
| 113 | alt { |
Vadim Yanitskiy | d686a8a | 2018-11-02 02:42:32 +0700 | [diff] [blame] | 114 | [] EUSE.receive(tr_GSUP_PROC_SS_REQ(?, ?, ?)) -> value rx_pdu { |
| 115 | EUSE.send(cb_fn.apply(rx_pdu)); |
Harald Welte | f9d449e | 2018-06-24 22:27:47 +0200 | [diff] [blame] | 116 | } |
| 117 | |
| 118 | |
| 119 | [] EUSE.receive { |
| 120 | setverdict(fail, "EUSE: Unexpected Rx from HLR"); |
| 121 | self.stop; |
| 122 | } |
| 123 | } |
| 124 | } |
| 125 | } |
| 126 | |
| 127 | |
| 128 | } |