blob: 860b799fd03b61327359d902b2a91e222939ffa3 [file] [log] [blame]
Pau Espin Pedrolac8a0542024-04-19 17:30:57 +02001/* Component implementing a IMS server towards Asterisk's IMS UE
2 * (C) 2024 by sysmocom - s.f.m.c. GmbH <info@sysmocom.de>
3 * Author: Pau Espin Pedrol <pespin@sysmocom.de>
4 * All rights reserved.
5 *
6 * Released under the terms of GNU General Public License, Version 2 or
7 * (at your option) any later version.
8 *
9 * SPDX-License-Identifier: GPL-2.0-or-later
10 */
11module IMS_ConnectionHandler {
12
Pau Espin Pedrol717379f2024-05-17 18:36:51 +020013import from TCCEncoding_Functions all;
Pau Espin Pedrolac8a0542024-04-19 17:30:57 +020014import from TCCOpenSecurity_Functions all;
15import from General_Types all;
16import from Osmocom_Types all;
17import from Native_Functions all;
18import from Misc_Helpers all;
19
Pau Espin Pedrola674d612024-05-14 19:56:33 +020020/* the PIPE asp port allows us to interact with ip xfrm via stdin/stdout */
21import from PIPEasp_PortType all;
22import from PIPEasp_Types all;
23import from PIPEasp_Templates all;
24
Pau Espin Pedrolac8a0542024-04-19 17:30:57 +020025import from SDP_Types all;
26import from SDP_Templates all;
27
28import from SIP_Emulation all;
29import from SIPmsg_Types all;
30import from SIP_Templates all;
31
Pau Espin Pedrola674d612024-05-14 19:56:33 +020032
33modulepar {
34 charstring mp_ipsec_setup_script_path := "./IMS_ipsec_setup.sh";
35}
36
Pau Espin Pedrolcb0dbf92024-06-06 20:40:30 +020037const integer c_def_expires := 600000; /* 3GPP TS 24.229 5.1.1.2.1 e) */
Pau Espin Pedrola2424b22024-06-10 20:23:13 +020038const charstring c_sip_server_name := "osmo-ttcn3-hacks/0.23";
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +020039
40
Pau Espin Pedrolac8a0542024-04-19 17:30:57 +020041type port IMSCoord_PT message
42{
43 inout charstring;
44} with { extension "internal" };
45
Pau Espin Pedrol5acf7c62024-06-06 19:23:08 +020046const charstring IMS_COORD_CMD_REGISTERED := "IMS_COORD_CMD_REGISTERED";
47const charstring IMS_COORD_CMD_START := "IMS_COORD_CMD_START";
48const charstring IMS_COORD_CMD_CALL_ESTABLISHED := "IMS_COORD_CMD_CALL_ESTABLISHED";
49const charstring IMS_COORD_CMD_HANGUP := "IMS_COORD_CMD_HANGUP";
Pau Espin Pedrolac8a0542024-04-19 17:30:57 +020050
51type component IMS_ConnHdlr extends SIP_ConnHdlr {
52 var charstring g_name;
53 var IMS_ConnHdlrPars g_pars;
54 timer g_Tguard;
55 var PDU_SIP_Request g_rx_sip_req;
56 var PDU_SIP_Response g_rx_sip_resp;
57
58 port IMSCoord_PT COORD;
Pau Espin Pedrola674d612024-05-14 19:56:33 +020059 port PIPEasp_PT PIPE;
Pau Espin Pedrolac8a0542024-04-19 17:30:57 +020060}
61type record of IMS_ConnHdlr IMS_ConnHdlrList;
62
Pau Espin Pedrol80b981a2024-06-04 18:37:22 +020063type record IMS_AuthVector {
64 OCT16 rand,
65 OCT16 autn,
66 OCT8 res,
67 OCT16 ck,
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +020068 OCT16 ik,
69 OCT14 auts
Pau Espin Pedrol80b981a2024-06-04 18:37:22 +020070}
71
Pau Espin Pedrol901cede2024-05-30 13:03:42 +020072type record IMS_ConnHdlrSubscrPars {
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +020073 charstring remote_sip_host optional,
74 uint16_t remote_sip_port optional,
Pau Espin Pedrol901cede2024-05-30 13:03:42 +020075 charstring imsi,
Pau Espin Pedrola017f442024-06-20 16:04:51 +020076 charstring imei,
Pau Espin Pedrolac8a0542024-04-19 17:30:57 +020077 charstring display_name,
78 charstring password,
Pau Espin Pedrol4e6672c2024-05-22 17:03:53 +020079 charstring msisdn,
Pau Espin Pedrola017f442024-06-20 16:04:51 +020080 boolean support_video,
81 boolean support_smsip,
Pau Espin Pedrol0c5c6472024-05-21 13:13:49 +020082 /* Expected User-Location-Info in P-Access-Network-Info */
83 charstring uli_str,
Pau Espin Pedrol80b981a2024-06-04 18:37:22 +020084 IMS_AuthVector auth,
Pau Espin Pedrola674d612024-05-14 19:56:33 +020085 charstring ipsec_auth_key,
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +020086 integer ipsec_local_spi_c,
87 integer ipsec_local_spi_s,
88 integer ipsec_remote_spi_c optional,
89 integer ipsec_remote_spi_s optional,
Pau Espin Pedrola674d612024-05-14 19:56:33 +020090 uint16_t ipsec_remote_port_c optional,
91 uint16_t ipsec_remote_port_s optional,
Pau Espin Pedrolac8a0542024-04-19 17:30:57 +020092 SipAddr registrar_sip_record,
93 CallidString registrar_sip_call_id,
94 integer registrar_sip_seq_nr,
Pau Espin Pedrolac8a0542024-04-19 17:30:57 +020095 SipUrl local_sip_url_ext,
96 SipAddr local_sip_record,
Pau Espin Pedrol5acf7c62024-06-06 19:23:08 +020097 Contact registered_contact optional,
Pau Espin Pedrol586eec52024-06-04 19:07:33 +020098 P_Associated_Uri p_associated_uri,
Pau Espin Pedrolac8a0542024-04-19 17:30:57 +020099 IMS_CallPars cp optional
100}
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200101type record of IMS_ConnHdlrSubscrPars IMS_ConnHdlrSubscrParsList;
102
103
104type record IMS_ConnHdlrPars {
105 float t_guard,
106 charstring realm,
107 charstring local_sip_host,
108 uint16_t local_sip_port,
109 SipUrl registrar_sip_req_uri,
110 Via local_via,
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200111 Server server_name,
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200112 IMS_ConnHdlrSubscrPars subscr optional
113}
Pau Espin Pedrolac8a0542024-04-19 17:30:57 +0200114type record of IMS_ConnHdlrPars IMS_ConnHdlrParsList;
115
116type record IMS_CallParsMT {
117 /* Whether to wait for COORD.receive(COORD_CMD_PICKUP) before accepting the call. */
118 boolean wait_coord_cmd_pickup,
119 /* Whether to expect CANCEL instead of ACK as answer to our OK */
120 boolean exp_cancel
121}
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200122template (value) IMS_CallParsMT t_IMS_CallParsMT := {
123 wait_coord_cmd_pickup := false,
124 exp_cancel := false
125}
Pau Espin Pedrolac8a0542024-04-19 17:30:57 +0200126
127type record IMS_CallPars {
128 SipAddr calling optional,
129 SipAddr called optional,
130
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200131 From from_addr optional,
132 To to_addr optional,
Pau Espin Pedrolac8a0542024-04-19 17:30:57 +0200133
134 CallidString sip_call_id,
135 integer sip_seq_nr,
136 charstring sip_body optional,
137
138 charstring local_rtp_addr,
139 uint16_t local_rtp_port,
140
Pau Espin Pedrolfaf21be2024-06-12 16:42:00 +0200141 boolean support_precondition_ext,
142 boolean require_precondition_ext,
Pau Espin Pedrolac8a0542024-04-19 17:30:57 +0200143 SDP_Message peer_sdp optional,
144 IMS_CallParsMT mt
145}
146
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200147template (value) IMS_CallPars t_IMS_CallPars(charstring local_rtp_addr,
148 uint16_t local_rtp_port := 0,
149 template (omit) SipAddr calling := omit,
150 template (omit) SipAddr called := omit) := {
151 calling := calling,
152 called := called,
153 from_addr := omit,
154 to_addr := omit,
155 sip_call_id := hex2str(f_rnd_hexstring(15)),
156 sip_seq_nr := f_sip_rand_seq_nr(),
157 sip_body := omit,
158 local_rtp_addr := local_rtp_addr,
159 local_rtp_port := local_rtp_port,
Pau Espin Pedrolfaf21be2024-06-12 16:42:00 +0200160 support_precondition_ext := true,
161 require_precondition_ext := false,
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200162 peer_sdp := omit,
163 mt := t_IMS_CallParsMT
164}
165
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200166template (value) IMS_ConnHdlrSubscrPars t_IMS_SubscrPars(charstring local_sip_host,
167 uint16_t local_sip_port,
Pau Espin Pedrolf46132e2024-06-04 17:11:59 +0200168 charstring domain,
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200169 charstring imsi,
Pau Espin Pedrola017f442024-06-20 16:04:51 +0200170 charstring imei,
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200171 charstring msisdn := "90828",
172 charstring display_name := "Anonymous",
173 charstring password := "secret",
174 template (omit) IMS_CallPars cp := omit) := {
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200175 remote_sip_host := omit,
176 remote_sip_port := omit,
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200177 imsi := imsi,
Pau Espin Pedrola017f442024-06-20 16:04:51 +0200178 imei := imei,
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200179 display_name := f_sip_str_quote(display_name),
180 password := password,
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200181 msisdn := msisdn,
Pau Espin Pedrola017f442024-06-20 16:04:51 +0200182 support_video := false,
183 support_smsip := false,
Pau Espin Pedrol0c5c6472024-05-21 13:13:49 +0200184 uli_str := "2380100010000101",
Pau Espin Pedrol80b981a2024-06-04 18:37:22 +0200185 auth := {
186 /* The Nonce field is the Base64 encoded version of the RAND value and concatenated with the AUTN: */
187 rand := 'd5d5de2bce418d7865ed7fa6956618a2'O,
188 autn := 'd42e61db5f15800067393a5b7691a227'O,
189 res := '6f2556bbe4366ab1'O,
190 ck := '0b389d08c833991734936bec55cac800'O,
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200191 ik := '17141862125bd30c81c4224391a0909a'O,
192 /* NOTE: AUTS value randomly crafted. It's fine since it's just forwarded
193 * AMI -> asterisk -> IMS and we blindly match and accept it. */
194 auts := 'd42e61db5f15800067393a5b7691'O
Pau Espin Pedrol80b981a2024-06-04 18:37:22 +0200195 },
196 ipsec_auth_key := "0x17141862125bd30c81c4224391a0909a00000000",
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200197 ipsec_local_spi_c := 4142,
198 ipsec_local_spi_s := 4143,
199 ipsec_remote_spi_c := omit,
200 ipsec_remote_spi_s := omit,
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200201 ipsec_remote_port_c := omit,
202 ipsec_remote_port_s := omit,
Pau Espin Pedrolf46132e2024-06-04 17:11:59 +0200203 registrar_sip_record := ts_SipAddr(ts_HostPort(domain),
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200204 ts_UserInfo(imsi),
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200205 f_sip_str_quote(display_name)),
Pau Espin Pedrolf46132e2024-06-04 17:11:59 +0200206 registrar_sip_call_id := hex2str(f_rnd_hexstring(15)) & "@" & domain,
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200207 registrar_sip_seq_nr := f_sip_rand_seq_nr(),
Pau Espin Pedrolf46132e2024-06-04 17:11:59 +0200208 local_sip_url_ext := ts_SipUrl(ts_HostPort(domain, local_sip_port),
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200209 ts_UserInfo(imsi)),
Pau Espin Pedrolf46132e2024-06-04 17:11:59 +0200210 local_sip_record := ts_SipAddr(ts_HostPort(domain),
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200211 ts_UserInfo(imsi)),
Pau Espin Pedrol5acf7c62024-06-06 19:23:08 +0200212 registered_contact := omit,
Pau Espin Pedrol586eec52024-06-04 19:07:33 +0200213 p_associated_uri := ts_P_Associated_Uri({}),
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200214 cp := cp
215}
216
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200217template (value) IMS_ConnHdlrPars t_IMS_Pars(charstring local_sip_host,
218 uint16_t local_sip_port,
Pau Espin Pedrolf46132e2024-06-04 17:11:59 +0200219 charstring domain,
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200220 charstring imsi,
Pau Espin Pedrola017f442024-06-20 16:04:51 +0200221 charstring imei,
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200222 template (omit) IMS_CallPars cp := omit) := {
Pau Espin Pedrol50db4c92024-06-11 18:02:52 +0200223 t_guard := 60.0,
Pau Espin Pedrolf46132e2024-06-04 17:11:59 +0200224 realm := domain,
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200225 local_sip_host := local_sip_host,
226 local_sip_port := local_sip_port,
Pau Espin Pedrolf46132e2024-06-04 17:11:59 +0200227 registrar_sip_req_uri := valueof(ts_SipUrlHost(domain)),
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200228 local_via := ts_Via_from(ts_HostPort(local_sip_host, local_sip_port)),
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200229 server_name := valueof(ts_Server({c_sip_server_name})),
Pau Espin Pedrola017f442024-06-20 16:04:51 +0200230 subscr := t_IMS_SubscrPars(local_sip_host, local_sip_port,
231 domain := domain, imsi := imsi,
232 imei := imei, cp := cp)
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200233}
234
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200235private altstep as_Tguard() runs on IMS_ConnHdlr {
236 [] g_Tguard.timeout {
237 setverdict(fail, "Tguard timeout");
238 mtc.stop;
239 }
240}
241
242type function ims_void_fn(charstring id) runs on IMS_ConnHdlr;
243function f_ims_handler_init(ims_void_fn fn, charstring id, IMS_ConnHdlrPars pars)
244runs on IMS_ConnHdlr {
245 g_name := id;
246 g_pars := pars;
247 g_Tguard.start(pars.t_guard);
248 activate(as_Tguard());
249
250 /* call the user-supied test case function */
251 fn.apply(id);
252}
253
Pau Espin Pedrol50db4c92024-06-11 18:02:52 +0200254altstep as_SIP_fail_req(charstring exp_msg_str := "") runs on IMS_ConnHdlr
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200255{
256 var PDU_SIP_Request sip_req;
257 [] SIP.receive(PDU_SIP_Request:?) -> value sip_req {
258 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
259 log2str(g_name & ": Received unexpected SIP Req message := ", sip_req, "\nvs exp := ", exp_msg_str));
260 }
261}
262
Pau Espin Pedrol50db4c92024-06-11 18:02:52 +0200263altstep as_SIP_fail_resp(charstring exp_msg_str := "") runs on IMS_ConnHdlr
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200264{
265 var PDU_SIP_Response sip_resp;
266 [] SIP.receive(PDU_SIP_Response:?) -> value sip_resp {
267 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
268 log2str(g_name & ": Received unexpected SIP Resp message := ", sip_resp, "\nvs exp := ", exp_msg_str));
269 }
270}
271
Pau Espin Pedrol5acf7c62024-06-06 19:23:08 +0200272altstep as_SIP_expect_resp(template (present) PDU_SIP_Response sip_expect, boolean fail_others := true) runs on IMS_ConnHdlr
273{
274 var charstring sip_expect_str := log2str(sip_expect);
275 [] SIP.receive(sip_expect) -> value g_rx_sip_resp;
276 [fail_others] as_SIP_fail_resp(sip_expect_str);
277 [fail_others] as_SIP_fail_req(sip_expect_str);
278}
279
280altstep as_SIP_ignore_resp(template PDU_SIP_Response sip_expect := ?) runs on IMS_ConnHdlr
281{
282 [] SIP.receive(sip_expect) -> value g_rx_sip_resp {
283 log("Ignoring ", g_rx_sip_resp);
284 repeat;
285 }
286}
287
Pau Espin Pedrol717379f2024-05-17 18:36:51 +0200288private function f_nonce_from_rand_autn(octetstring rand, octetstring autn) return charstring {
289 var octetstring concat := rand & autn;
290 var charstring nonce := enc_MIME_Base64(concat);
291 log("rand=", rand, " & autn=",autn, " => nonce=", nonce);
292 return nonce;
293}
294
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200295/* HTTP Digest Authentication Using AKA (AKAv1-MD5): RFC 3310 */
296function f_tr_Authorization_AKAv1MD5(WwwAuthenticate www_authenticate,
297 charstring username,
Pau Espin Pedrol80b981a2024-06-04 18:37:22 +0200298 charstring uri)
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200299return template (present) Authorization {
300 var CommaParam_List digestCln;
301 var template (present) Authorization authorization;
302 var template (present) Credentials cred;
303 var template (omit) GenericParam rx_param;
304
305 digestCln := www_authenticate.challenge[0].digestCln;
306
307 var charstring algorithm := f_sip_param_get_value_present_or_fail(digestCln, "algorithm");
308 var charstring realm := f_sip_param_get_value_present_or_fail(digestCln, "realm");
309 var charstring nonce := f_sip_param_get_value_present_or_fail(digestCln, "nonce");
310
311 var template (present) CommaParam_List digestResponse := superset(
312 tr_Param("username", f_sip_str_quote(username)),
313 tr_Param("realm", f_sip_str_quote(realm)),
314 tr_Param("nonce", f_sip_str_quote(nonce)),
315 tr_Param("uri", f_sip_str_quote(uri)),
316 tr_Param("response", ?),
317 tr_Param("algorithm", algorithm),
318 tr_Param("qop", "auth"),
319 tr_Param("cnonce", ?),
320 tr_Param("nc", ?)
321 );
322 cred := tr_Credentials_DigestResponse(digestResponse);
323 authorization := tr_Authorization(cred);
324 return authorization;
325}
326
Pau Espin Pedrol80b981a2024-06-04 18:37:22 +0200327private function f_ims_validate_Authorization_AKAv1MD5_Response(Authorization authorization, charstring method)
328runs on IMS_ConnHdlr {
329 f_sip_digest_validate_Authorization_AKAv1MD5(authorization, method, g_pars.subscr.auth.res);
330}
331
332
Pau Espin Pedrola017f442024-06-20 16:04:51 +0200333private function f_ims_validate_register_contact(Contact rx_contact) runs on IMS_ConnHdlr
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200334{
Pau Espin Pedrola017f442024-06-20 16:04:51 +0200335 /* IMS contact shows up like this:
336 * Contact: <sip:8adf9f3d-9342-4060-aa4f-a909f37fd6f6@192.168.101.2:5060>;+g.3gpp.accesstype="cellular2";video;audio;+g.3gpp.smsip;+g.3gpp.nw-init-ussi;+g.3gpp.icsi-ref="urn%3Aurn-7%3A3gpp-service.ims.icsi.mmtel";+sip.instance="<urn:gsma:imei:35589811-338445-0>"
337 */
338 if (ischosen(rx_contact.contactBody.wildcard)) {
339 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
340 log2str(g_name & ": Received unexpected Contact wildcard := ", rx_contact));
341 }
342 var ContactAddress_List caddrs := rx_contact.contactBody.contactAddresses;
343 if (lengthof(caddrs) == 0) {
344 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
345 log2str(g_name & ": Received unexpected empty Contact Address list"));
346 }
347 for (var integer i := 0; i < lengthof(caddrs); i := i + 1) {
348 var ContactAddress caddr := caddrs[i];
349 var template (omit) GenericParam param_tpl;
350 var boolean rx_supported;
351 if (not ispresent(caddr.contactParams)) {
352 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
353 log2str(g_name & ": Received unexpected empty Contact attributes (omit)"));
354 }
355 f_sip_param_match_value_or_fail(caddr.contactParams, "+g.3gpp.icsi-ref", "\"urn\\%3Aurn-7\\%3A3gpp-service.ims.icsi.mmtel\"");
356 f_sip_param_match_value_or_fail(caddr.contactParams, "+sip.instance", "\"<urn:gsma:imei:" & g_pars.subscr.imei & ">\"");
357 f_sip_param_match_value_or_fail(caddr.contactParams, "audio", omit);
358
359 /* Check video support */
360 param_tpl := f_sip_param_find(caddr.contactParams, "video");
361 rx_supported := not istemplatekind(param_tpl, "omit");
362 if (rx_supported) {
363 /* This attribute never has a value: */
364 if (not istemplatekind(param_tpl.paramValue, "omit")) {
365 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
366 log2str(g_name & ": Received Contact with 'video' attribute containing a value := ", rx_contact));
367 }
368 if (not g_pars.subscr.support_video) {
369 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
370 log2str(g_name & ": Received Contact with unexpected 'video' attribute := ", rx_contact));
371 }
372 } else if (g_pars.subscr.support_video) {
373 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
374 log2str(g_name & ": Received Contact with missing 'video' attribute := ", rx_contact));
375 }
376
377 /* Check smsip support */
378 param_tpl := f_sip_param_find(caddr.contactParams, "+g.3gpp.smsip");
379 rx_supported := not istemplatekind(param_tpl, "omit");
380 if (rx_supported) {
381 /* This attribute never has a value: */
382 if (not istemplatekind(param_tpl.paramValue, "omit")) {
383 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
384 log2str(g_name & ": Received Contact with '+g.3gpp.smsip' attribute containing a value := ", rx_contact));
385 }
386 if (not g_pars.subscr.support_smsip) {
387 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
388 log2str(g_name & ": Received Contact with unexpected '+g.3gpp.smsip' attribute := ", rx_contact));
389 }
390 } else if (g_pars.subscr.support_smsip) {
391 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
392 log2str(g_name & ": Received Contact with missing '+g.3gpp.smsip' attribute := ", rx_contact));
393 }
394 }
395
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200396}
397
Pau Espin Pedrol0c5c6472024-05-21 13:13:49 +0200398/* Validate P-Access-Network-Info: RFC7315 6.4 */
399private function f_ims_validate_register_P_Access_Network_info(PDU_SIP_Request req,
400 boolean exp_present := true) runs on IMS_ConnHdlr
401
402{
403 if (not exp_present) {
404 if (ispresent(g_rx_sip_req.msgHeader.p_access_network_info)) {
405 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
406 log2str(g_name & ": Received unexpected [rfc7315 6.4] P-Access-Info := ",
407 g_rx_sip_req.msgHeader.p_access_network_info));
408 }
409 return;
410 }
411
412 /* exp_present: */
413 var template (present) P_Access_Network_Info expl_tmpl :=
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200414 tr_P_Access_Network_Info({ tr_Access_net_spec_EUTRAN(g_pars.subscr.uli_str) });
Pau Espin Pedrol0c5c6472024-05-21 13:13:49 +0200415
416 if (not ispresent(g_rx_sip_req.msgHeader.p_access_network_info)) {
417 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
418 log2str(g_name & ": Received no P-Access-Info vs exp := ",
419 expl_tmpl));
420 }
421 if (not match(g_rx_sip_req.msgHeader.p_access_network_info, expl_tmpl)) {
422 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
423 log2str(g_name & ": Received unexpected P-Access-Info := ",
424 g_rx_sip_req.msgHeader.p_access_network_info,
425 "\nvs exp := ", expl_tmpl));
426 }
427}
428
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200429private function f_ims_parse_security_client(Security_client security_client) runs on IMS_ConnHdlr
430{
431 var boolean found := false;
432 for (var integer i := 0; i < lengthof(security_client.sec_mechanism_list); i := i + 1) {
433 var Security_mechanism sec_mec := security_client.sec_mechanism_list[i];
434 if (sec_mec.mechanism_name != "ipsec-3gpp") {
435 log("Skipping Security Mechansim: ", sec_mec.mechanism_name);
436 continue;
437 }
438 var SemicolonParam_List sec_pars := sec_mec.mechanism_params;
439 var charstring par_val;
440 par_val := f_sip_param_get_value_present_or_fail(sec_pars, "alg");
441 if (par_val != "hmac-sha-1-96") {
442 log("Skipping Security Mechansim Algo: ", par_val);
443 continue;
444 }
445 par_val := f_sip_param_get_value_present_or_fail(sec_pars, "spi-c");
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200446 g_pars.subscr.ipsec_remote_spi_c := str2int(par_val);
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200447 par_val := f_sip_param_get_value_present_or_fail(sec_pars, "spi-s");
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200448 g_pars.subscr.ipsec_remote_spi_s := str2int(par_val);
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200449 par_val := f_sip_param_get_value_present_or_fail(sec_pars, "port-c");
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200450 g_pars.subscr.ipsec_remote_port_c := str2int(par_val);
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200451 par_val := f_sip_param_get_value_present_or_fail(sec_pars, "port-s");
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200452 g_pars.subscr.ipsec_remote_port_s := str2int(par_val);
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200453 found := true;
454 break;
455 }
456
457 if (not found) {
458 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
459 log2str(g_name & "alg=hmac-sha-1-96 not found: ", security_client));
460 }
461
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200462 log("ipsec: remote_spi_c=", g_pars.subscr.ipsec_remote_spi_c, " remote_spi_s=", g_pars.subscr.ipsec_remote_spi_s,
463 "local_spi_c=", g_pars.subscr.ipsec_local_spi_c, " local_spi_s=", g_pars.subscr.ipsec_local_spi_s);
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200464}
465
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200466private function f_ims_parse_register_contact(Contact contact) runs on IMS_ConnHdlr
467{
468 var HostPort hp := valueof(contact.contactBody.contactAddresses[0].addressField.nameAddr.addrSpec.hostPort);
469
470 g_pars.subscr.remote_sip_host := hp.host;
471 if (ispresent(hp.portField)) {
472 g_pars.subscr.remote_sip_port := hp.portField;
473 } else {
474 g_pars.subscr.remote_sip_port := 5060;
475 }
476}
477
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200478private function f_IMS_exec_sync(charstring cmdline, template (present) integer rc := 0)
479 runs on IMS_ConnHdlr return ASP_PResult {
480 var ASP_PResult res;
481
482 map(self:PIPE, system:PIPE);
483 res := f_PIPEasp_exec_sync_PResult(PIPE, cmdline, tr_PResult(?, ?, rc));
484 unmap(self:PIPE, system:PIPE);
485
486 return res;
487}
488
489private function f_ims_setup_ipsec() runs on IMS_ConnHdlr
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200490{
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200491 var ASP_PResult res;
492
493 var charstring cmd := mp_ipsec_setup_script_path & " " &
494 g_pars.local_sip_host & " " &
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200495 int2str(g_pars.local_sip_port) & " " & int2str(g_pars.subscr.ipsec_local_spi_c) & " " &
496 int2str(g_pars.local_sip_port) & " " & int2str(g_pars.subscr.ipsec_local_spi_s) & " " &
497 g_pars.subscr.remote_sip_host & " " &
498 int2str(g_pars.subscr.ipsec_remote_port_c) & " " & int2str(g_pars.subscr.ipsec_remote_spi_c) & " " &
499 int2str(g_pars.subscr.ipsec_remote_port_s) & " " & int2str(g_pars.subscr.ipsec_remote_spi_s) & " " &
500 g_pars.subscr.ipsec_auth_key;
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200501
502 res := f_IMS_exec_sync(cmd);
503
504 /* Debug applied rules: */
505 /*
506 res := f_IMS_exec_sync("ip xfrm state");
507 log("ip-xfrm-state Result-Stdout: " & res.stdout);
508
509 res := f_IMS_exec_sync("ip xfrm policy");
510 log("ip-xfrm-policy Result-Stdout: " & res.stdout);
511 */
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200512}
513
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200514private function f_tr_Via_response(Via via_req) return template (present) Via {
515 template (present) SemicolonParam_List via_resp_params := ?;
516
517 /*via_resp_params := {
518 { id := "rport", paramValue := int2str(g_pars.subscr.remote_sip_port.subscr.remote_sip_port) },
519 { id := "received", paramValue := g_pars.subscr.remote_sip_host }
520 }; */
521 return tr_Via_from(via_req.viaBody[0].sentBy,
522 via_req.viaBody[0].sentProtocol.transport,
523 via_resp_params);
524}
525
526private function f_tr_From(template (value) SipAddr from_req) return template (present) SipAddr {
527 return tr_SipAddr_from_val(from_req);
528}
529
530private altstep as_SIP_expect_req(template (present) PDU_SIP_Request sip_expect, boolean fail_others := true) runs on IMS_ConnHdlr
531{
532 var charstring sip_expect_str := log2str(sip_expect);
533 [] SIP.receive(sip_expect) -> value g_rx_sip_req;
534 [fail_others] as_SIP_fail_req(sip_expect_str);
535 [fail_others] as_SIP_fail_resp(sip_expect_str);
536}
537
538private function f_gen_sdp() runs on IMS_ConnHdlr return charstring {
539 var charstring sdp :=
540 "v=0\r\n" &
541 "o=0502 2390 1824 IN IP4 " & g_pars.subscr.cp.local_rtp_addr & "\r\n" &
542 "s=Talk\r\n" &
543 "c=IN IP4 " & g_pars.subscr.cp.local_rtp_addr & "\r\n" &
544 "t=0 0\r\n" &
545 "a=rtcp-xr:rcvr-rtt=all:10000 stat-summary=loss,dup,jitt,TTL voip-metrics\r\n" &
546 "a=record:off\r\n" &
547 "m=audio " & int2str(g_pars.subscr.cp.local_rtp_port) & " RTP/AVP 8 96 97 98 0 18 99 100 101\r\n" &
548 "a=rtpmap:8 PCMA/8000\r\n" &
549 "a=rtpmap:96 opus/48000/2\r\n" &
550 "a=fmtp:96 useinbandfec=1\r\n" &
551 "a=rtpmap:97 speex/16000\r\n" &
552 "a=fmtp:97 vbr=on\r\n" &
553 "a=rtpmap:98 speex/8000\r\n" &
554 "a=fmtp:98 vbr=on\r\n" &
555 "a=fmtp:18 annexb=yes\r\n" &
556 "a=rtpmap:99 telephone-event/48000\r\n" &
557 "a=rtpmap:100 telephone-event/16000\r\n" &
558 "a=rtpmap:101 telephone-event/8000\r\n" &
559 "a=rtcp:" & int2str(g_pars.subscr.cp.local_rtp_port + 1) & "\r\n" &
560 "a=rtcp-fb:* trr-int 1000\r\n" &
561 "a=rtcp-fb:* ccm tmmbr\r\n";
562 return sdp;
563}
564
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200565private function f_gen_Security_server() runs on IMS_ConnHdlr return Security_server {
566 var template (value) Security_server security_server;
567 /* Security-Server: ipsec-3gpp;q=0.1;prot=esp;mod=trans;spi-c=4096;spi-s=4097;port-c=5104;port-s=6104;alg=hmac-sha-1-96;ealg=null */
568 var template (value) SemicolonParam_List sec_params := {
569 ts_Param("q", "0.1"),
570 ts_Param("prot", "esp"),
571 ts_Param("mod", "trans"),
572 ts_Param("spi-c", int2str(g_pars.subscr.ipsec_local_spi_c)),
573 ts_Param("spi-s", int2str(g_pars.subscr.ipsec_local_spi_s)),
574 ts_Param("port-c", int2str(g_pars.local_sip_port)),
575 ts_Param("port-s", int2str(g_pars.local_sip_port)),
576 ts_Param("alg", "hmac-sha-1-96"),
577 ts_Param("ealg", "null")
578 };
579 security_server := ts_Security_server({
580 ts_Security_mechanism("ipsec-3gpp", sec_params)
581 });
582 return valueof(security_server);
583}
584
585private function f_gen_WwwAuthenticate() runs on IMS_ConnHdlr return WwwAuthenticate {
586 var template (value) WwwAuthenticate wwwAuthenticate;
587 var template (value) CommaParam_List digestCln;
588 digestCln := {
589 ts_Param("realm", f_sip_str_quote(g_pars.realm)),
590 ts_Param("qop", f_sip_str_quote("auth")),
591 ts_Param("algorithm", "AKAv1-MD5"),
592 ts_Param("nonce", f_sip_str_quote(f_nonce_from_rand_autn(g_pars.subscr.auth.rand,
593 g_pars.subscr.auth.autn)))
594 /* "opaque not needed in IMS "*/
595 };
596 wwwAuthenticate := ts_WwwAuthenticate( { ts_Challenge_digestCln(digestCln) } );
597 return valueof(wwwAuthenticate);
598}
599
Pau Espin Pedrol50db4c92024-06-11 18:02:52 +0200600type enumerated IMS_register_early_return {
601 IMS_REG_EARLY_RET_BEFORE_None,
602 IMS_REG_EARLY_RET_BEFORE_Initial_100Trying,
603 IMS_REG_EARLY_RET_BEFORE_Initial_401Unauthorized,
604 IMS_REG_EARLY_RET_BEFORE_Resync_401Unauthorized,
605 IMS_REG_EARLY_RET_BEFORE_Protected_100Trying,
606 IMS_REG_EARLY_RET_BEFORE_Protected_200OK
607}
608
Pau Espin Pedrol586eec52024-06-04 19:07:33 +0200609/* Peer is issuing 1st register, accept it: */
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200610altstep as_IMS_register(boolean exp_auth_resync := false,
Pau Espin Pedrol50db4c92024-06-11 18:02:52 +0200611 IMS_register_early_return early_ret := IMS_REG_EARLY_RET_BEFORE_None,
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200612 boolean fail_others := true) runs on IMS_ConnHdlr
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200613{
614 var template (present) PDU_SIP_Request exp_req :=
615 tr_SIP_REGISTER(g_pars.registrar_sip_req_uri,
616 ?,
Pau Espin Pedrol41b0e072024-05-29 18:25:51 +0200617 tr_From(),
618 tr_To(),
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200619 tr_Via_from(?),
Pau Espin Pedrolcb0dbf92024-06-06 20:40:30 +0200620 expires := tr_Expires(int2str(c_def_expires)),
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200621 require := tr_Require(superset("sec-agree")),
622 security_client := tr_Security_client(superset(tr_Security_mechanism("ipsec-3gpp",
623 superset(tr_Param("alg","hmac-sha-1-96"))))),
624 supported := tr_Supported(superset("path", "sec-agree")));
625 var charstring sip_expect_str := log2str(exp_req);
626
627 [] SIP.receive(exp_req) -> value g_rx_sip_req {
628 var template (value) PDU_SIP_Response tx_resp;
629 var Via via;
630 var CallidString sip_call_id;
Pau Espin Pedrol41b0e072024-05-29 18:25:51 +0200631 var template (value) From from_addr;
632 var template (value) To to_addr;
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200633 var WwwAuthenticate wwwAuthenticate;
634 var Security_server security_server;
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200635 var template (value) Require require := ts_Require({"sec-agree"});
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200636 var template (value) Supported supported := ts_Supported({"sec-agree"});
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200637 var integer sip_seq_nr;
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200638
Pau Espin Pedrol50db4c92024-06-11 18:02:52 +0200639 if (early_ret == IMS_REG_EARLY_RET_BEFORE_Initial_100Trying) {
640 return; /* Done */
641 }
642
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200643 sip_call_id := g_rx_sip_req.msgHeader.callId.callid;
644 via := g_rx_sip_req.msgHeader.via;
645 via.viaBody[0].viaParams := f_sip_param_set(via.viaBody[0].viaParams, "rport", "1234"); /* TODO: set remote src port of the REGISTER */
Pau Espin Pedrol41b0e072024-05-29 18:25:51 +0200646 from_addr := g_rx_sip_req.msgHeader.fromField;
647 to_addr := g_rx_sip_req.msgHeader.toField;
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200648 sip_seq_nr := g_rx_sip_req.msgHeader.cSeq.seqNumber;
649
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200650 /* Tx 100 Tyring */
651 tx_resp := ts_SIP_Response_Trying(sip_call_id,
652 from_addr,
653 to_addr,
654 via,
655 sip_seq_nr,
656 "REGISTER",
657 allow := omit,
658 server := g_pars.server_name,
659 userAgent := omit);
660 SIP.send(tx_resp);
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200661
Pau Espin Pedrol0c5c6472024-05-21 13:13:49 +0200662 /* Validate P-Access-Network-Info: rfc7315 6.4:
663 * "3GPP will use the P-Access-Network-Info header field to
664 * carry relatively sensitive information like the cell ID. Therefore,
665 * the information MUST NOT be sent outside of the 3GPP domain.""
666 * [...] "the sensitive information carried in the
667 * P-Access-Network-Info header field MUST NOT be sent in any initial
668 * unauthenticated and unprotected requests (e.g., REGISTER)."
669 */
670 f_ims_validate_register_P_Access_Network_info(g_rx_sip_req, exp_present := false);
671
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200672 f_ims_validate_register_contact(g_rx_sip_req.msgHeader.contact);
673 f_ims_parse_register_contact(g_rx_sip_req.msgHeader.contact);
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200674 f_ims_parse_security_client(g_rx_sip_req.msgHeader.security_client);
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200675
Pau Espin Pedrol50db4c92024-06-11 18:02:52 +0200676 if (early_ret == IMS_REG_EARLY_RET_BEFORE_Initial_401Unauthorized) {
677 return; /* Done */
678 }
679
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200680 if (not exp_auth_resync) {
681 /* Delay ipsec setup in ip xfrm, since there will be another
682 * 1st REGISTER with potentially new ports coming in later. */
683 f_ims_setup_ipsec();
684 }
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200685
Pau Espin Pedrol41b0e072024-05-29 18:25:51 +0200686 to_addr.toParams := f_sip_param_set(to_addr.toParams, "tag", f_sip_rand_tag());
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200687 wwwAuthenticate := f_gen_WwwAuthenticate();
688 security_server := f_gen_Security_server();
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200689
690 /* Tx 401 Unauthorized */
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200691 tx_resp := ts_SIP_Response_Unauthorized(sip_call_id,
692 from_addr,
693 to_addr,
694 via,
695 wwwAuthenticate,
696 sip_seq_nr,
697 "REGISTER",
Pau Espin Pedrol586eec52024-06-04 19:07:33 +0200698 p_associated_uri := g_pars.subscr.p_associated_uri,
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200699 security_server := security_server,
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200700 server := g_pars.server_name,
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200701 supported := supported,
702 userAgent := omit);
703 SIP.send(tx_resp);
704
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200705 if (exp_auth_resync) {
706 /* Now we should receive a new non-protected REGISTER
707 * with Authoritzation containing auts in base64: */
708 var template (present) Authorization authorization :=
709 f_tr_Authorization_AKAv1MD5(wwwAuthenticate,
710 g_pars.subscr.imsi & "@" & g_pars.realm,
711 f_sip_SipUrl_to_str(g_pars.registrar_sip_req_uri));
712 exp_req :=
713 tr_SIP_REGISTER(g_pars.registrar_sip_req_uri,
714 ?,
715 tr_From(),
716 tr_To(),
717 tr_Via_from(f_tr_HostPort(via.viaBody[0].sentBy.host, via.viaBody[0].sentBy.portField)),
718 authorization := authorization);
719 SIP.receive(exp_req) -> value g_rx_sip_req;
720
Pau Espin Pedrol50db4c92024-06-11 18:02:52 +0200721 if (early_ret == IMS_REG_EARLY_RET_BEFORE_Resync_401Unauthorized) {
722 return; /* Done */
723 }
724
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200725 via := g_rx_sip_req.msgHeader.via;
726 from_addr := g_rx_sip_req.msgHeader.fromField;
727 to_addr := g_rx_sip_req.msgHeader.toField;
728 sip_seq_nr := g_rx_sip_req.msgHeader.cSeq.seqNumber;
729
730 /* Tx 100 Tyring */
731 tx_resp := ts_SIP_Response_Trying(sip_call_id,
732 from_addr,
733 to_addr,
734 via,
735 sip_seq_nr,
736 "REGISTER",
737 allow := omit,
738 server := g_pars.server_name,
739 userAgent := omit);
740 SIP.send(tx_resp);
741
742 f_sip_param_match_value_or_fail(g_rx_sip_req.msgHeader.authorization.body.digestResponse,
743 "auts", f_sip_str_quote(enc_MIME_Base64(g_pars.subscr.auth.auts)));
744 f_ims_validate_register_P_Access_Network_info(g_rx_sip_req, exp_present := false);
745 f_ims_validate_register_contact(g_rx_sip_req.msgHeader.contact);
746 f_ims_parse_register_contact(g_rx_sip_req.msgHeader.contact);
747 f_ims_parse_security_client(g_rx_sip_req.msgHeader.security_client);
748 f_ims_setup_ipsec();
749
750 security_server := f_gen_Security_server();
751
752 /* Tx again 401 Unauthorized, this time our AMI interface will accept it: */
753 tx_resp := ts_SIP_Response_Unauthorized(sip_call_id,
754 from_addr,
755 to_addr,
756 via,
757 wwwAuthenticate,
758 sip_seq_nr,
759 "REGISTER",
760 p_associated_uri := g_pars.subscr.p_associated_uri,
761 security_server := security_server,
762 server := g_pars.server_name,
763 supported := supported,
764 userAgent := omit);
765 SIP.send(tx_resp);
766 }
767
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200768 /* Now we should receive a new REGISTER over ipsec: */
Pau Espin Pedrol50db4c92024-06-11 18:02:52 +0200769 as_IMS_2nd_register(wwwAuthenticate, early_ret := early_ret);
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200770 }
771 [fail_others] as_SIP_fail_resp(sip_expect_str);
772 [fail_others] as_SIP_fail_req(sip_expect_str);
773
774}
775
776/* Peer is issuing 2nd register, accept it: */
Pau Espin Pedrol50db4c92024-06-11 18:02:52 +0200777altstep as_IMS_2nd_register(WwwAuthenticate wwwAuthenticate,
778 IMS_register_early_return early_ret := IMS_REG_EARLY_RET_BEFORE_None,
779 boolean fail_others := true) runs on IMS_ConnHdlr
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200780{
781 var template (present) Authorization authorization :=
782 f_tr_Authorization_AKAv1MD5(wwwAuthenticate,
783 g_pars.subscr.imsi & "@" & g_pars.realm,
784 f_sip_SipUrl_to_str(g_pars.registrar_sip_req_uri));
785 var template (present) PDU_SIP_Request exp_req :=
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200786 tr_SIP_REGISTER(g_pars.registrar_sip_req_uri,
787 ?,
Pau Espin Pedrol41b0e072024-05-29 18:25:51 +0200788 tr_From(),
789 tr_To(),
Pau Espin Pedrol480b53c2024-06-07 19:49:02 +0200790 tr_Via_from(f_tr_HostPort(g_pars.subscr.remote_sip_host, g_pars.subscr.ipsec_remote_port_s)),
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200791 authorization := authorization);
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200792 var charstring sip_expect_str := log2str(exp_req);
793
794 [] SIP.receive(exp_req) -> value g_rx_sip_req {
795 var template (value) PDU_SIP_Response tx_resp;
796 var Via via;
797 var CallidString sip_call_id;
798 var template (value) From from_addr;
799 var template (value) To to_addr;
800 var template (value) Require require := ts_Require({"sec-agree"});
801 var template (value) Supported supported := ts_Supported({"sec-agree"});
802 var integer sip_seq_nr;
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200803
Pau Espin Pedrol50db4c92024-06-11 18:02:52 +0200804 if (early_ret == IMS_REG_EARLY_RET_BEFORE_Protected_100Trying) {
805 return; /* Done */
806 }
807
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200808 sip_call_id := g_rx_sip_req.msgHeader.callId.callid;
809 via := g_rx_sip_req.msgHeader.via;
Pau Espin Pedrol41b0e072024-05-29 18:25:51 +0200810 from_addr := g_rx_sip_req.msgHeader.fromField;
811 to_addr := g_rx_sip_req.msgHeader.toField;
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200812 sip_seq_nr := g_rx_sip_req.msgHeader.cSeq.seqNumber;
813
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200814 /* Tx 100 Trying */
815 tx_resp := ts_SIP_Response_Trying(sip_call_id,
816 from_addr,
817 to_addr,
818 via,
819 sip_seq_nr,
820 "REGISTER",
821 allow := omit,
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200822 server := g_pars.server_name,
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200823 userAgent := omit);
824 SIP.send(tx_resp);
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200825
Pau Espin Pedrol80b981a2024-06-04 18:37:22 +0200826 /* Validate Digest Response: */
827 f_ims_validate_Authorization_AKAv1MD5_Response(g_rx_sip_req.msgHeader.authorization, "REGISTER");
828
Pau Espin Pedrol0c5c6472024-05-21 13:13:49 +0200829 /* Validate P-Access-Network-Info: */
830 f_ims_validate_register_P_Access_Network_info(g_rx_sip_req, exp_present := true);
831
Pau Espin Pedrol50db4c92024-06-11 18:02:52 +0200832 if (early_ret == IMS_REG_EARLY_RET_BEFORE_Protected_200OK) {
833 return; /* Done */
834 }
835
Pau Espin Pedrol586eec52024-06-04 19:07:33 +0200836 g_pars.subscr.p_associated_uri := valueof(ts_P_Associated_Uri({
Pau Espin Pedrol4e6672c2024-05-22 17:03:53 +0200837 ts_P_Assoc_uri_spec(ts_NameAddr(ts_SipUrl(ts_HostPort(g_pars.realm),
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200838 ts_UserInfo(g_pars.subscr.msisdn),
Pau Espin Pedrol4e6672c2024-05-22 17:03:53 +0200839 scheme := "sip"))),
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200840 ts_P_Assoc_uri_spec(ts_NameAddr(ts_SipUrl(ts_HostPort(g_pars.subscr.msisdn),
Pau Espin Pedrol4e6672c2024-05-22 17:03:53 +0200841 omit,
842 scheme := "tel"))),
843 ts_P_Assoc_uri_spec(g_rx_sip_req.msgHeader.toField.addressField.nameAddr)
Pau Espin Pedrol586eec52024-06-04 19:07:33 +0200844 }));
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200845 f_ims_validate_register_contact(g_rx_sip_req.msgHeader.contact);
846 f_ims_parse_register_contact(g_rx_sip_req.msgHeader.contact);
847 g_pars.subscr.registered_contact := g_rx_sip_req.msgHeader.contact;
Pau Espin Pedrol4e6672c2024-05-22 17:03:53 +0200848
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200849 /* Tx 200 OK */
Pau Espin Pedrol41b0e072024-05-29 18:25:51 +0200850 to_addr.toParams := f_sip_param_set(to_addr.toParams, "tag", f_sip_rand_tag());
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200851 tx_resp := ts_SIP_Response(sip_call_id,
852 from_addr,
853 to_addr,
854 "REGISTER", 200,
855 sip_seq_nr,
856 "OK",
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200857 via,
Pau Espin Pedrol586eec52024-06-04 19:07:33 +0200858 p_associated_uri := g_pars.subscr.p_associated_uri,
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200859 require := require,
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200860 server := g_pars.server_name,
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200861 supported := supported,
862 userAgent := omit);
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200863 SIP.send(tx_resp);
864 }
865 [fail_others] as_SIP_fail_resp(sip_expect_str);
866 [fail_others] as_SIP_fail_req(sip_expect_str);
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200867}
868
Pau Espin Pedrol586eec52024-06-04 19:07:33 +0200869/* Peer wants to unregister, accept it: */
870altstep as_IMS_unregister(boolean fail_others := true) runs on IMS_ConnHdlr
871{
872 var template (present) PDU_SIP_Request exp_req :=
873 tr_SIP_REGISTER(g_pars.registrar_sip_req_uri,
874 ?,
875 tr_From(),
876 tr_To(),
Pau Espin Pedrol480b53c2024-06-07 19:49:02 +0200877 tr_Via_from(f_tr_HostPort(g_pars.subscr.remote_sip_host, g_pars.subscr.ipsec_remote_port_s)),
Pau Espin Pedrol586eec52024-06-04 19:07:33 +0200878 expires := tr_Expires(int2str(0)),
879 require := tr_Require(superset("sec-agree")),
880 security_client := tr_Security_client(superset(tr_Security_mechanism("ipsec-3gpp",
881 superset(tr_Param("alg","hmac-sha-1-96"))))),
882 supported := tr_Supported(superset("path", "sec-agree")));
883 var charstring sip_expect_str := log2str(exp_req);
884
885 [] SIP.receive(exp_req) -> value g_rx_sip_req {
886 var template (value) PDU_SIP_Response tx_resp;
887 var Via via;
888 var CallidString sip_call_id;
889 var Contact contact;
890 var template (value) From from_addr;
891 var template (value) To to_addr;
892 var template (value) CommaParam_List digestCln ;
893 var template (value) WwwAuthenticate wwwAuthenticate;
894 var template (value) Security_server security_server;
Pau Espin Pedrol586eec52024-06-04 19:07:33 +0200895 var template (value) Require require := ts_Require({"sec-agree"});
896 var template (value) Supported supported := ts_Supported({"sec-agree"});
897 var template (present) Authorization authorization;
898 var integer sip_seq_nr;
Pau Espin Pedrol586eec52024-06-04 19:07:33 +0200899
900 sip_call_id := g_rx_sip_req.msgHeader.callId.callid;
901 via := g_rx_sip_req.msgHeader.via;
902 via.viaBody[0].viaParams := f_sip_param_set(via.viaBody[0].viaParams, "rport", "1234"); /* TODO: set remote src port of the REGISTER */
903 from_addr := g_rx_sip_req.msgHeader.fromField;
904 to_addr := g_rx_sip_req.msgHeader.toField;
905 sip_seq_nr := g_rx_sip_req.msgHeader.cSeq.seqNumber;
906
907 contact := g_rx_sip_req.msgHeader.contact;
908 f_ims_validate_register_contact(contact);
909
Pau Espin Pedrolf1963b32024-06-07 17:07:16 +0200910 /* Validate P-Access-Network-Info: 3GPP TS 24.229 5.1.2A.1.1
911 * "If available to the UE (as defined in the access technology specific annexes for each access technology), the UE shall
912 * insert a P-Access-Network-Info header field into any request for a dialog, any subsequent request (except CANCEL
913 * requests) or response (except CANCEL responses) within a dialog or any request for a standalone method (see
914 * subclause 7.2A.4). Insertion of the P-Access-Network-Info header field into the ACK request is optional."
915 */
Pau Espin Pedrol586eec52024-06-04 19:07:33 +0200916 f_ims_validate_register_P_Access_Network_info(g_rx_sip_req, exp_present := true);
917
Pau Espin Pedrolf1963b32024-06-07 17:07:16 +0200918
Pau Espin Pedrol586eec52024-06-04 19:07:33 +0200919 /* Tx 100 Tyring */
920 tx_resp := ts_SIP_Response_Trying(sip_call_id,
921 from_addr,
922 to_addr,
923 via,
924 sip_seq_nr,
925 "REGISTER",
926 allow := omit,
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200927 server := g_pars.server_name,
Pau Espin Pedrol586eec52024-06-04 19:07:33 +0200928 userAgent := omit);
929 SIP.send(tx_resp);
930
931 /* Change all Contact parameters to expires=0: */
932 for (var integer i := 0; i < lengthof(contact.contactBody.contactAddresses); i := i + 1) {
933 contact.contactBody.contactAddresses[i].contactParams := valueof({ ts_Param("expires", "0") });
934 }
Pau Espin Pedrol5acf7c62024-06-06 19:23:08 +0200935 g_pars.subscr.registered_contact := omit;
Pau Espin Pedrol586eec52024-06-04 19:07:33 +0200936 /* Tx 200 OK */
937 to_addr.toParams := f_sip_param_set(to_addr.toParams, "tag", f_sip_rand_tag());
938 tx_resp := ts_SIP_Response(sip_call_id,
939 from_addr,
940 to_addr,
941 "REGISTER", 200,
942 sip_seq_nr,
943 "OK",
944 via,
945 contact := contact,
946 p_associated_uri := g_pars.subscr.p_associated_uri,
947 require := require,
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200948 server := g_pars.server_name,
Pau Espin Pedrol586eec52024-06-04 19:07:33 +0200949 supported := supported,
950 userAgent := omit);
951 SIP.send(tx_resp);
952 }
953 [fail_others] as_SIP_fail_resp(sip_expect_str);
954 [fail_others] as_SIP_fail_req(sip_expect_str);
955}
956
Pau Espin Pedrol5acf7c62024-06-06 19:23:08 +0200957function f_IMS_mt_call_setup() runs on IMS_ConnHdlr
958{
959 var template (value) PDU_SIP_Request req;
960 var template (present) PDU_SIP_Response exp;
961 var template (present) From from_addr_exp;
962 var template (present) To to_addr_exp;
963 var Via via;
964 var charstring tx_sdp := f_gen_sdp();
965 var default d_trying, d_ringing;
966 var charstring branch_value;
967 var Contact calling_contact;
968
969 /* RFC 3261 8.1.1.3 From */
970 g_pars.subscr.cp.from_addr := valueof(ts_From(g_pars.subscr.cp.calling.addr, g_pars.subscr.cp.calling.params));
971 g_pars.subscr.cp.from_addr.fromParams := f_sip_param_set(g_pars.subscr.cp.from_addr.fromParams, "tag", f_sip_rand_tag());
972 g_pars.subscr.cp.to_addr := valueof(ts_To(g_pars.subscr.cp.called.addr, g_pars.subscr.cp.called.params));
973 from_addr_exp := tr_From(tr_Addr_Union_from_val(g_pars.subscr.cp.from_addr.addressField), *);
974 to_addr_exp := tr_To(tr_Addr_Union_from_val(g_pars.subscr.cp.to_addr.addressField), *);
975 branch_value := f_sip_gen_branch(f_sip_Addr_Union_to_str(g_pars.subscr.cp.from_addr.addressField),
976 f_sip_Addr_Union_to_str(valueof(g_pars.subscr.cp.to_addr.addressField)),
977 g_pars.subscr.cp.sip_call_id,
978 g_pars.subscr.cp.sip_seq_nr);
979 via := g_pars.local_via;
980 via.viaBody[0].viaParams := f_sip_param_set(via.viaBody[0].viaParams, "branch", branch_value);
981
982 calling_contact := valueof(ts_Contact({
983 ts_ContactAddress(g_pars.subscr.cp.calling.addr, omit)
984 }));
985
986 req := ts_SIP_INVITE(g_pars.subscr.cp.sip_call_id,
987 g_pars.subscr.cp.from_addr,
988 g_pars.subscr.cp.to_addr,
989 via,
990 calling_contact,
991 g_pars.subscr.cp.sip_seq_nr,
992 body := tx_sdp);
993
994 SIP.send(req);
995
996 /* Conditionally match and accept 100 Trying. */
997 exp := tr_SIP_Response_Trying(g_pars.subscr.cp.sip_call_id,
998 from_addr_exp,
999 to_addr_exp,
1000 f_tr_Via_response(via),
1001 g_pars.subscr.cp.sip_seq_nr, "INVITE");
1002 d_trying := activate(as_SIP_ignore_resp(exp));
1003
1004 /* Conditionally match and accept 180 Ringing */
1005 exp := tr_SIP_Response_Ringing(g_pars.subscr.cp.sip_call_id,
1006 from_addr_exp,
1007 to_addr_exp,
1008 f_tr_Via_response(via),
1009 g_pars.subscr.cp.sip_seq_nr, "INVITE");
1010 d_ringing := activate(as_SIP_ignore_resp(exp));
1011
1012 /* Wait for OK answer */
1013 exp := tr_SIP_Response(
1014 g_pars.subscr.cp.sip_call_id,
1015 from_addr_exp,
1016 to_addr_exp,
1017 f_tr_Via_response(via),
1018 *,
1019 "INVITE", 200,
1020 g_pars.subscr.cp.sip_seq_nr, "OK",
1021 body := ?);
1022 as_SIP_expect_resp(exp, fail_others := false);
1023
1024 deactivate(d_trying);
1025 deactivate(d_ringing);
1026
1027 /* Update To with the tags received from peer: */
1028 g_pars.subscr.cp.to_addr := g_rx_sip_resp.msgHeader.toField;
1029
1030 /* Transmit ACK */
1031 g_pars.subscr.cp.sip_seq_nr := g_pars.subscr.cp.sip_seq_nr + 1;
1032 req := ts_SIP_ACK(g_pars.subscr.cp.sip_call_id,
1033 g_pars.subscr.cp.from_addr,
1034 g_pars.subscr.cp.to_addr,
1035 via,
1036 g_pars.subscr.cp.sip_seq_nr,
1037 omit);
1038 SIP.send(req);
1039 g_pars.subscr.cp.sip_seq_nr := g_pars.subscr.cp.sip_seq_nr + 1;
1040}
1041
1042/* Tx BYE: */
1043function f_IMS_do_call_hangup() runs on IMS_ConnHdlr
1044{
1045 var template (value) PDU_SIP_Request req;
1046 var template (present) PDU_SIP_Response exp_resp;
1047 var Via via;
1048 var charstring branch_value;
1049
1050 branch_value := f_sip_gen_branch(f_sip_Addr_Union_to_str(g_pars.subscr.cp.from_addr.addressField),
1051 f_sip_Addr_Union_to_str(valueof(g_pars.subscr.cp.to_addr.addressField)),
1052 g_pars.subscr.cp.sip_call_id,
1053 g_pars.subscr.cp.sip_seq_nr);
1054
1055 via := g_pars.local_via;
1056 via.viaBody[0].viaParams := f_sip_param_set(via.viaBody[0].viaParams, "branch", branch_value);
1057
1058 /* Transmit ACK */
1059 req := ts_SIP_BYE(g_pars.subscr.cp.sip_call_id,
1060 g_pars.subscr.cp.from_addr,
1061 g_pars.subscr.cp.to_addr,
1062 via,
1063 g_pars.subscr.cp.sip_seq_nr,
1064 omit);
1065 SIP.send(req);
1066
1067 /* Wait for OK answer */
1068 exp_resp := tr_SIP_Response(
1069 g_pars.subscr.cp.sip_call_id,
1070 g_pars.subscr.cp.from_addr,
1071 tr_To(tr_Addr_Union_from_val(g_pars.subscr.cp.to_addr.addressField), *),
1072 f_tr_Via_response(via),
1073 *,
1074 "BYE", 200,
1075 g_pars.subscr.cp.sip_seq_nr, "OK");
1076 as_SIP_expect_resp(exp_resp);
1077
1078 g_pars.subscr.cp.sip_seq_nr := g_pars.subscr.cp.sip_seq_nr + 1;
1079}
1080
Pau Espin Pedrol901cede2024-05-30 13:03:42 +02001081private function f_ConnHdlr_parse_initial_SIP_INVITE(PDU_SIP_Request rx_sip_req) runs on IMS_ConnHdlr
1082{
1083 f_SDP_decodeMessage(rx_sip_req.messageBody, g_pars.subscr.cp.peer_sdp);
1084 log("Rx Initial MO INVITE decoded SDP: ", g_pars.subscr.cp.peer_sdp);
1085
1086 /* Obtain params: */
1087 g_pars.subscr.cp.sip_call_id := rx_sip_req.msgHeader.callId.callid;
1088 g_pars.subscr.cp.from_addr := rx_sip_req.msgHeader.fromField;
1089 g_pars.subscr.cp.to_addr := rx_sip_req.msgHeader.toField;
1090 g_pars.subscr.cp.to_addr.toParams := f_sip_param_set(g_pars.subscr.cp.to_addr.toParams, "tag", f_sip_rand_tag());
1091 g_pars.subscr.cp.sip_seq_nr := rx_sip_req.msgHeader.cSeq.seqNumber;
1092}
1093
1094/* Peer is calling us, accept it: */
1095altstep as_IMS_mo_call_accept(boolean exp_update_to_direct_rtp := false,
1096 boolean fail_others := true) runs on IMS_ConnHdlr
1097{
1098 var template (present) PDU_SIP_Request exp_req :=
1099 tr_SIP_INVITE(f_tr_SipUrl_opt_defport(ts_SipUrl_from_Addr_Union(g_pars.subscr.cp.called.addr)),
1100 ?,
Pau Espin Pedrol09087012024-06-04 18:07:48 +02001101 tr_From(tr_Addr_Union_from_val(g_pars.subscr.cp.calling.addr), *),
Pau Espin Pedrol901cede2024-05-30 13:03:42 +02001102 tr_To(tr_Addr_Union_from_val(g_pars.subscr.cp.called.addr), *),
Pau Espin Pedrol480b53c2024-06-07 19:49:02 +02001103 tr_Via_from(f_tr_HostPort(g_pars.subscr.remote_sip_host, g_pars.subscr.ipsec_remote_port_s)),
Pau Espin Pedrol901cede2024-05-30 13:03:42 +02001104 ?, ?);
1105 var charstring sip_expect_str := log2str(exp_req);
1106
1107 [] SIP.receive(exp_req) -> value g_rx_sip_req {
1108 var template (value) PDU_SIP_Response tx_resp;
1109 var Via via;
1110 var charstring tx_sdp;
Pau Espin Pedrolfaf21be2024-06-12 16:42:00 +02001111 var boolean peer_support_precondition := match(g_rx_sip_req.msgHeader.supported.optionsTags,
1112 superset("100rel", "precondition"));
Pau Espin Pedrol901cede2024-05-30 13:03:42 +02001113
1114 /* Obtain params: */
1115 f_ConnHdlr_parse_initial_SIP_INVITE(g_rx_sip_req);
1116 via := g_rx_sip_req.msgHeader.via;
1117
Pau Espin Pedrolf1963b32024-06-07 17:07:16 +02001118 f_ims_validate_register_P_Access_Network_info(g_rx_sip_req, exp_present := true);
Pau Espin Pedrolfaf21be2024-06-12 16:42:00 +02001119 if (g_pars.subscr.cp.require_precondition_ext and not peer_support_precondition) {
1120 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
1121 log2str(g_name & ": Missing '100rel,precondition' in INVITE Supported header: ",
1122 g_rx_sip_req.msgHeader.supported));
1123 }
Pau Espin Pedrolf1963b32024-06-07 17:07:16 +02001124
Pau Espin Pedrolfaf21be2024-06-12 16:42:00 +02001125 /* Tx 100 Tyring */
1126 tx_resp := ts_SIP_Response_Trying(g_pars.subscr.cp.sip_call_id,
Pau Espin Pedrol901cede2024-05-30 13:03:42 +02001127 g_pars.subscr.cp.from_addr,
1128 g_pars.subscr.cp.to_addr,
1129 via,
Pau Espin Pedrolfaf21be2024-06-12 16:42:00 +02001130 g_pars.subscr.cp.sip_seq_nr,
1131 "INVITE",
1132 allow := omit,
1133 server := g_pars.server_name,
1134 userAgent := omit);
Pau Espin Pedrol901cede2024-05-30 13:03:42 +02001135 SIP.send(tx_resp);
1136
Pau Espin Pedrol901cede2024-05-30 13:03:42 +02001137 tx_sdp := f_gen_sdp();
Pau Espin Pedrolfaf21be2024-06-12 16:42:00 +02001138
1139 /* Use precondition ? */
1140 if (g_pars.subscr.cp.require_precondition_ext or
1141 (g_pars.subscr.cp.support_precondition_ext and peer_support_precondition)) {
1142 /* Tx 183 Session Progress */
1143 /* TODO: add a=curr:qos, a=des:qos and a=conf:qos fields to SDP */
1144 tx_resp := ts_SIP_Response_SessionProgress(g_pars.subscr.cp.sip_call_id,
1145 g_pars.subscr.cp.from_addr,
1146 g_pars.subscr.cp.to_addr,
1147 via,
1148 g_pars.subscr.cp.sip_seq_nr,
1149 rseq := ts_RSeq(1),
1150 body := tx_sdp);
1151 SIP.send(tx_resp);
1152
1153 /* Rx PRACK */
1154 exp_req := tr_SIP_PRACK(f_tr_SipUrl_opt_defport(ts_SipUrl_from_Addr_Union(g_pars.subscr.cp.called.addr)),
1155 g_pars.subscr.cp.sip_call_id,
1156 g_pars.subscr.cp.from_addr,
1157 g_pars.subscr.cp.to_addr,
1158 f_tr_Via_response(via),
1159 g_pars.subscr.cp.sip_seq_nr + 1,
1160 rack := tr_RAck(1, g_pars.subscr.cp.sip_seq_nr, "INVITE"),
1161 body := omit);
1162 as_SIP_expect_req(exp_req);
1163
1164 /* Tx 200 OK (PRACK) */
1165 tx_resp := ts_SIP_Response(g_pars.subscr.cp.sip_call_id,
1166 g_pars.subscr.cp.from_addr,
1167 g_pars.subscr.cp.to_addr,
1168 "PRACK", 200,
1169 g_pars.subscr.cp.sip_seq_nr,
1170 "OK",
1171 via,
1172 body := omit);
1173 SIP.send(tx_resp);
1174
1175 /* Rx UPDATE */
1176 exp_req := tr_SIP_UPDATE(f_tr_SipUrl_opt_defport(ts_SipUrl_from_Addr_Union(g_pars.subscr.cp.called.addr)),
1177 g_pars.subscr.cp.sip_call_id,
1178 g_pars.subscr.cp.from_addr,
1179 g_pars.subscr.cp.to_addr,
1180 f_tr_Via_response(via),
1181 g_pars.subscr.cp.sip_seq_nr + 1,
1182 require := tr_Require(superset("precondition")),
1183 body := ?);
1184 as_SIP_expect_req(exp_req);
1185
1186 /* Tx 200 OK (UPDATE) */
1187 /* TODO: add a=curr:qos, a=des:qos and a=conf:qos fields to SDP */
1188 tx_resp := ts_SIP_Response(g_pars.subscr.cp.sip_call_id,
1189 g_pars.subscr.cp.from_addr,
1190 g_pars.subscr.cp.to_addr,
1191 "UPDATE", 200,
1192 g_pars.subscr.cp.sip_seq_nr,
1193 "OK",
1194 via,
1195 body := tx_sdp);
1196 SIP.send(tx_resp);
1197
1198 g_pars.subscr.cp.sip_seq_nr := g_pars.subscr.cp.sip_seq_nr + 1;
1199 }
1200
1201 /* Tx 180 Ringing */
1202 tx_resp := ts_SIP_Response_Ringing(g_pars.subscr.cp.sip_call_id,
1203 g_pars.subscr.cp.from_addr,
1204 g_pars.subscr.cp.to_addr,
1205 via,
1206 g_pars.subscr.cp.sip_seq_nr);
1207 SIP.send(tx_resp);
1208
1209
1210 /* Tx 200 OK */
Pau Espin Pedrol901cede2024-05-30 13:03:42 +02001211 tx_resp := ts_SIP_Response(g_pars.subscr.cp.sip_call_id,
1212 g_pars.subscr.cp.from_addr,
1213 g_pars.subscr.cp.to_addr,
1214 "INVITE", 200,
1215 g_pars.subscr.cp.sip_seq_nr,
1216 "OK",
1217 via,
1218 body := tx_sdp);
1219 SIP.send(tx_resp);
1220
1221 /* Wait for ACK */
1222 exp_req := tr_SIP_ACK(f_tr_SipUrl_opt_defport(ts_SipUrl_from_Addr_Union(g_pars.subscr.cp.called.addr)),
1223 g_pars.subscr.cp.sip_call_id,
1224 g_pars.subscr.cp.from_addr,
1225 g_pars.subscr.cp.to_addr,
1226 f_tr_Via_response(via),
1227 g_pars.subscr.cp.sip_seq_nr, *);
1228 as_SIP_expect_req(exp_req);
1229 }
1230 [fail_others] as_SIP_fail_resp(sip_expect_str);
1231 [fail_others] as_SIP_fail_req(sip_expect_str);
1232
1233}
1234
1235/* Call is terminated by peer: */
1236altstep as_IMS_exp_call_hangup(template (present) integer exp_seq_nr := ?, boolean fail_others := true) runs on IMS_ConnHdlr
1237{
1238 var template (present) PDU_SIP_Request exp_req :=
1239 tr_SIP_BYE(f_tr_SipUrl_opt_defport(ts_SipUrl_from_Addr_Union(g_pars.subscr.cp.called.addr)),
1240 g_pars.subscr.cp.sip_call_id,
1241 g_pars.subscr.cp.from_addr,
1242 g_pars.subscr.cp.to_addr,
Pau Espin Pedrol480b53c2024-06-07 19:49:02 +02001243 tr_Via_from(f_tr_HostPort(g_pars.subscr.remote_sip_host, g_pars.subscr.ipsec_remote_port_s)),
Pau Espin Pedrol901cede2024-05-30 13:03:42 +02001244 exp_seq_nr);
1245 var charstring sip_expect_str := log2str(exp_req);
1246
1247 [] SIP.receive(exp_req) -> value g_rx_sip_req {
1248 var template (value) PDU_SIP_Response tx_resp;
1249 var charstring tx_sdp;
1250 var Via via;
1251
1252 /* Update parameters: */
1253 g_pars.subscr.cp.sip_seq_nr := g_rx_sip_req.msgHeader.cSeq.seqNumber;
1254 /* "branch" has changed: */
1255 via := g_rx_sip_req.msgHeader.via;
1256
1257 /* Tx 200 OK */
1258 tx_sdp := f_gen_sdp();
1259 tx_resp := ts_SIP_Response(g_pars.subscr.cp.sip_call_id,
1260 g_pars.subscr.cp.from_addr,
1261 g_pars.subscr.cp.to_addr,
1262 "BYE", 200,
1263 g_pars.subscr.cp.sip_seq_nr,
1264 "OK",
1265 via,
1266 body := tx_sdp);
1267 SIP.send(tx_resp);
1268 }
1269 [fail_others] as_SIP_fail_resp(sip_expect_str);
1270 [fail_others] as_SIP_fail_req(sip_expect_str);
1271}
1272
Pau Espin Pedrolac8a0542024-04-19 17:30:57 +02001273}