blob: 7a9f11f671ff1fe002678765d4bb79e5d3550e72 [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 Pedrol4d572062024-06-18 20:20:55 +020050const charstring IMS_COORD_CMD_CALL_TRYING := "IMS_COORD_CMD_CALL_TRYING";
51const charstring IMS_COORD_CMD_CALL_SESSION_PROGRESS := "IMS_COORD_CMD_CALL_SESSION_PROGRESS";
Pau Espin Pedrolac8a0542024-04-19 17:30:57 +020052
53type component IMS_ConnHdlr extends SIP_ConnHdlr {
54 var charstring g_name;
55 var IMS_ConnHdlrPars g_pars;
56 timer g_Tguard;
57 var PDU_SIP_Request g_rx_sip_req;
58 var PDU_SIP_Response g_rx_sip_resp;
59
60 port IMSCoord_PT COORD;
Pau Espin Pedrola674d612024-05-14 19:56:33 +020061 port PIPEasp_PT PIPE;
Pau Espin Pedrolac8a0542024-04-19 17:30:57 +020062}
63type record of IMS_ConnHdlr IMS_ConnHdlrList;
64
Pau Espin Pedrol80b981a2024-06-04 18:37:22 +020065type record IMS_AuthVector {
66 OCT16 rand,
67 OCT16 autn,
68 OCT8 res,
69 OCT16 ck,
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +020070 OCT16 ik,
71 OCT14 auts
Pau Espin Pedrol80b981a2024-06-04 18:37:22 +020072}
73
Pau Espin Pedrol901cede2024-05-30 13:03:42 +020074type record IMS_ConnHdlrSubscrPars {
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +020075 charstring remote_sip_host optional,
76 uint16_t remote_sip_port optional,
Pau Espin Pedrol901cede2024-05-30 13:03:42 +020077 charstring imsi,
Pau Espin Pedrola017f442024-06-20 16:04:51 +020078 charstring imei,
Pau Espin Pedrolac8a0542024-04-19 17:30:57 +020079 charstring display_name,
80 charstring password,
Pau Espin Pedrol4e6672c2024-05-22 17:03:53 +020081 charstring msisdn,
Pau Espin Pedrola017f442024-06-20 16:04:51 +020082 boolean support_video,
83 boolean support_smsip,
Pau Espin Pedrol0c5c6472024-05-21 13:13:49 +020084 /* Expected User-Location-Info in P-Access-Network-Info */
85 charstring uli_str,
Pau Espin Pedrol80b981a2024-06-04 18:37:22 +020086 IMS_AuthVector auth,
Pau Espin Pedrola674d612024-05-14 19:56:33 +020087 charstring ipsec_auth_key,
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +020088 integer ipsec_local_spi_c,
89 integer ipsec_local_spi_s,
90 integer ipsec_remote_spi_c optional,
91 integer ipsec_remote_spi_s optional,
Pau Espin Pedrola674d612024-05-14 19:56:33 +020092 uint16_t ipsec_remote_port_c optional,
93 uint16_t ipsec_remote_port_s optional,
Pau Espin Pedrolac8a0542024-04-19 17:30:57 +020094 SipAddr registrar_sip_record,
95 CallidString registrar_sip_call_id,
96 integer registrar_sip_seq_nr,
Pau Espin Pedrolac8a0542024-04-19 17:30:57 +020097 SipUrl local_sip_url_ext,
98 SipAddr local_sip_record,
Pau Espin Pedrol5acf7c62024-06-06 19:23:08 +020099 Contact registered_contact optional,
Pau Espin Pedrol586eec52024-06-04 19:07:33 +0200100 P_Associated_Uri p_associated_uri,
Pau Espin Pedrolac8a0542024-04-19 17:30:57 +0200101 IMS_CallPars cp optional
102}
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200103type record of IMS_ConnHdlrSubscrPars IMS_ConnHdlrSubscrParsList;
104
105
106type record IMS_ConnHdlrPars {
107 float t_guard,
108 charstring realm,
109 charstring local_sip_host,
110 uint16_t local_sip_port,
111 SipUrl registrar_sip_req_uri,
112 Via local_via,
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200113 Server server_name,
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200114 IMS_ConnHdlrSubscrPars subscr optional
115}
Pau Espin Pedrolac8a0542024-04-19 17:30:57 +0200116type record of IMS_ConnHdlrPars IMS_ConnHdlrParsList;
117
Pau Espin Pedrol4d572062024-06-18 20:20:55 +0200118type record IMS_CallParsMO {
119 /* Whether to COORD.send(IMS_COORD_CMD_CALL_TRYING) when receiving an INVITE from UE. */
120 boolean tx_coord_cmd_invite_trying
121}
122template (value) IMS_CallParsMO t_IMS_CallParsMO := {
123 tx_coord_cmd_invite_trying := false
124}
125
Pau Espin Pedrolac8a0542024-04-19 17:30:57 +0200126type record IMS_CallParsMT {
Pau Espin Pedrol4d572062024-06-18 20:20:55 +0200127 /* Whether to COORD.send(IMS_COORD_CMD_CALL_SESSION_PROGRESS) when receiving an 183 Session Progress from UE. */
128 boolean tx_coord_cmd_session_progress
Pau Espin Pedrolac8a0542024-04-19 17:30:57 +0200129}
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200130template (value) IMS_CallParsMT t_IMS_CallParsMT := {
Pau Espin Pedrol4d572062024-06-18 20:20:55 +0200131 tx_coord_cmd_session_progress := false
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200132}
Pau Espin Pedrolac8a0542024-04-19 17:30:57 +0200133
134type record IMS_CallPars {
135 SipAddr calling optional,
136 SipAddr called optional,
137
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200138 From from_addr optional,
139 To to_addr optional,
Pau Espin Pedrolac8a0542024-04-19 17:30:57 +0200140
141 CallidString sip_call_id,
142 integer sip_seq_nr,
143 charstring sip_body optional,
144
145 charstring local_rtp_addr,
146 uint16_t local_rtp_port,
147
Pau Espin Pedrolfaf21be2024-06-12 16:42:00 +0200148 boolean support_precondition_ext,
149 boolean require_precondition_ext,
Pau Espin Pedrolac8a0542024-04-19 17:30:57 +0200150 SDP_Message peer_sdp optional,
Pau Espin Pedrol4d572062024-06-18 20:20:55 +0200151 IMS_CallParsMO mo,
Pau Espin Pedrolac8a0542024-04-19 17:30:57 +0200152 IMS_CallParsMT mt
153}
154
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200155template (value) IMS_CallPars t_IMS_CallPars(charstring local_rtp_addr,
156 uint16_t local_rtp_port := 0,
157 template (omit) SipAddr calling := omit,
158 template (omit) SipAddr called := omit) := {
159 calling := calling,
160 called := called,
161 from_addr := omit,
162 to_addr := omit,
163 sip_call_id := hex2str(f_rnd_hexstring(15)),
164 sip_seq_nr := f_sip_rand_seq_nr(),
165 sip_body := omit,
166 local_rtp_addr := local_rtp_addr,
167 local_rtp_port := local_rtp_port,
Pau Espin Pedrolfaf21be2024-06-12 16:42:00 +0200168 support_precondition_ext := true,
169 require_precondition_ext := false,
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200170 peer_sdp := omit,
Pau Espin Pedrol4d572062024-06-18 20:20:55 +0200171 mo := t_IMS_CallParsMO,
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200172 mt := t_IMS_CallParsMT
173}
174
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200175template (value) IMS_ConnHdlrSubscrPars t_IMS_SubscrPars(charstring local_sip_host,
176 uint16_t local_sip_port,
Pau Espin Pedrolf46132e2024-06-04 17:11:59 +0200177 charstring domain,
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200178 charstring imsi,
Pau Espin Pedrola017f442024-06-20 16:04:51 +0200179 charstring imei,
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200180 charstring msisdn := "90828",
181 charstring display_name := "Anonymous",
182 charstring password := "secret",
183 template (omit) IMS_CallPars cp := omit) := {
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200184 remote_sip_host := omit,
185 remote_sip_port := omit,
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200186 imsi := imsi,
Pau Espin Pedrola017f442024-06-20 16:04:51 +0200187 imei := imei,
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200188 display_name := f_sip_str_quote(display_name),
189 password := password,
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200190 msisdn := msisdn,
Pau Espin Pedrola017f442024-06-20 16:04:51 +0200191 support_video := false,
192 support_smsip := false,
Pau Espin Pedrol0c5c6472024-05-21 13:13:49 +0200193 uli_str := "2380100010000101",
Pau Espin Pedrol80b981a2024-06-04 18:37:22 +0200194 auth := {
195 /* The Nonce field is the Base64 encoded version of the RAND value and concatenated with the AUTN: */
196 rand := 'd5d5de2bce418d7865ed7fa6956618a2'O,
197 autn := 'd42e61db5f15800067393a5b7691a227'O,
198 res := '6f2556bbe4366ab1'O,
199 ck := '0b389d08c833991734936bec55cac800'O,
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200200 ik := '17141862125bd30c81c4224391a0909a'O,
201 /* NOTE: AUTS value randomly crafted. It's fine since it's just forwarded
202 * AMI -> asterisk -> IMS and we blindly match and accept it. */
203 auts := 'd42e61db5f15800067393a5b7691'O
Pau Espin Pedrol80b981a2024-06-04 18:37:22 +0200204 },
205 ipsec_auth_key := "0x17141862125bd30c81c4224391a0909a00000000",
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200206 ipsec_local_spi_c := 4142,
207 ipsec_local_spi_s := 4143,
208 ipsec_remote_spi_c := omit,
209 ipsec_remote_spi_s := omit,
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200210 ipsec_remote_port_c := omit,
211 ipsec_remote_port_s := omit,
Pau Espin Pedrolf46132e2024-06-04 17:11:59 +0200212 registrar_sip_record := ts_SipAddr(ts_HostPort(domain),
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200213 ts_UserInfo(imsi),
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200214 f_sip_str_quote(display_name)),
Pau Espin Pedrolf46132e2024-06-04 17:11:59 +0200215 registrar_sip_call_id := hex2str(f_rnd_hexstring(15)) & "@" & domain,
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200216 registrar_sip_seq_nr := f_sip_rand_seq_nr(),
Pau Espin Pedrolf46132e2024-06-04 17:11:59 +0200217 local_sip_url_ext := ts_SipUrl(ts_HostPort(domain, local_sip_port),
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200218 ts_UserInfo(imsi)),
Pau Espin Pedrolf46132e2024-06-04 17:11:59 +0200219 local_sip_record := ts_SipAddr(ts_HostPort(domain),
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200220 ts_UserInfo(imsi)),
Pau Espin Pedrol5acf7c62024-06-06 19:23:08 +0200221 registered_contact := omit,
Pau Espin Pedrol586eec52024-06-04 19:07:33 +0200222 p_associated_uri := ts_P_Associated_Uri({}),
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200223 cp := cp
224}
225
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200226template (value) IMS_ConnHdlrPars t_IMS_Pars(charstring local_sip_host,
227 uint16_t local_sip_port,
Pau Espin Pedrolf46132e2024-06-04 17:11:59 +0200228 charstring domain,
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200229 charstring imsi,
Pau Espin Pedrola017f442024-06-20 16:04:51 +0200230 charstring imei,
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200231 template (omit) IMS_CallPars cp := omit) := {
Pau Espin Pedrol50db4c92024-06-11 18:02:52 +0200232 t_guard := 60.0,
Pau Espin Pedrolf46132e2024-06-04 17:11:59 +0200233 realm := domain,
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200234 local_sip_host := local_sip_host,
235 local_sip_port := local_sip_port,
Pau Espin Pedrolf46132e2024-06-04 17:11:59 +0200236 registrar_sip_req_uri := valueof(ts_SipUrlHost(domain)),
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200237 local_via := ts_Via_from(ts_HostPort(local_sip_host, local_sip_port)),
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200238 server_name := valueof(ts_Server({c_sip_server_name})),
Pau Espin Pedrola017f442024-06-20 16:04:51 +0200239 subscr := t_IMS_SubscrPars(local_sip_host, local_sip_port,
240 domain := domain, imsi := imsi,
241 imei := imei, cp := cp)
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200242}
243
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200244private altstep as_Tguard() runs on IMS_ConnHdlr {
245 [] g_Tguard.timeout {
246 setverdict(fail, "Tguard timeout");
247 mtc.stop;
248 }
249}
250
251type function ims_void_fn(charstring id) runs on IMS_ConnHdlr;
252function f_ims_handler_init(ims_void_fn fn, charstring id, IMS_ConnHdlrPars pars)
253runs on IMS_ConnHdlr {
254 g_name := id;
255 g_pars := pars;
256 g_Tguard.start(pars.t_guard);
257 activate(as_Tguard());
258
259 /* call the user-supied test case function */
260 fn.apply(id);
261}
262
Pau Espin Pedrol50db4c92024-06-11 18:02:52 +0200263altstep as_SIP_fail_req(charstring exp_msg_str := "") runs on IMS_ConnHdlr
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200264{
265 var PDU_SIP_Request sip_req;
266 [] SIP.receive(PDU_SIP_Request:?) -> value sip_req {
267 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
268 log2str(g_name & ": Received unexpected SIP Req message := ", sip_req, "\nvs exp := ", exp_msg_str));
269 }
270}
271
Pau Espin Pedrol50db4c92024-06-11 18:02:52 +0200272altstep as_SIP_fail_resp(charstring exp_msg_str := "") runs on IMS_ConnHdlr
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200273{
274 var PDU_SIP_Response sip_resp;
275 [] SIP.receive(PDU_SIP_Response:?) -> value sip_resp {
276 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
277 log2str(g_name & ": Received unexpected SIP Resp message := ", sip_resp, "\nvs exp := ", exp_msg_str));
278 }
279}
280
Pau Espin Pedrol5acf7c62024-06-06 19:23:08 +0200281altstep as_SIP_expect_resp(template (present) PDU_SIP_Response sip_expect, boolean fail_others := true) runs on IMS_ConnHdlr
282{
283 var charstring sip_expect_str := log2str(sip_expect);
284 [] SIP.receive(sip_expect) -> value g_rx_sip_resp;
285 [fail_others] as_SIP_fail_resp(sip_expect_str);
286 [fail_others] as_SIP_fail_req(sip_expect_str);
287}
288
289altstep as_SIP_ignore_resp(template PDU_SIP_Response sip_expect := ?) runs on IMS_ConnHdlr
290{
291 [] SIP.receive(sip_expect) -> value g_rx_sip_resp {
292 log("Ignoring ", g_rx_sip_resp);
293 repeat;
294 }
295}
296
Pau Espin Pedrol717379f2024-05-17 18:36:51 +0200297private function f_nonce_from_rand_autn(octetstring rand, octetstring autn) return charstring {
298 var octetstring concat := rand & autn;
299 var charstring nonce := enc_MIME_Base64(concat);
300 log("rand=", rand, " & autn=",autn, " => nonce=", nonce);
301 return nonce;
302}
303
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200304/* HTTP Digest Authentication Using AKA (AKAv1-MD5): RFC 3310 */
305function f_tr_Authorization_AKAv1MD5(WwwAuthenticate www_authenticate,
306 charstring username,
Pau Espin Pedrol80b981a2024-06-04 18:37:22 +0200307 charstring uri)
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200308return template (present) Authorization {
309 var CommaParam_List digestCln;
310 var template (present) Authorization authorization;
311 var template (present) Credentials cred;
312 var template (omit) GenericParam rx_param;
313
314 digestCln := www_authenticate.challenge[0].digestCln;
315
316 var charstring algorithm := f_sip_param_get_value_present_or_fail(digestCln, "algorithm");
317 var charstring realm := f_sip_param_get_value_present_or_fail(digestCln, "realm");
318 var charstring nonce := f_sip_param_get_value_present_or_fail(digestCln, "nonce");
319
320 var template (present) CommaParam_List digestResponse := superset(
321 tr_Param("username", f_sip_str_quote(username)),
322 tr_Param("realm", f_sip_str_quote(realm)),
323 tr_Param("nonce", f_sip_str_quote(nonce)),
324 tr_Param("uri", f_sip_str_quote(uri)),
325 tr_Param("response", ?),
326 tr_Param("algorithm", algorithm),
327 tr_Param("qop", "auth"),
328 tr_Param("cnonce", ?),
329 tr_Param("nc", ?)
330 );
331 cred := tr_Credentials_DigestResponse(digestResponse);
332 authorization := tr_Authorization(cred);
333 return authorization;
334}
335
Pau Espin Pedrol80b981a2024-06-04 18:37:22 +0200336private function f_ims_validate_Authorization_AKAv1MD5_Response(Authorization authorization, charstring method)
337runs on IMS_ConnHdlr {
338 f_sip_digest_validate_Authorization_AKAv1MD5(authorization, method, g_pars.subscr.auth.res);
339}
340
341
Pau Espin Pedrola017f442024-06-20 16:04:51 +0200342private function f_ims_validate_register_contact(Contact rx_contact) runs on IMS_ConnHdlr
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200343{
Pau Espin Pedrola017f442024-06-20 16:04:51 +0200344 /* IMS contact shows up like this:
345 * 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>"
346 */
347 if (ischosen(rx_contact.contactBody.wildcard)) {
348 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
349 log2str(g_name & ": Received unexpected Contact wildcard := ", rx_contact));
350 }
351 var ContactAddress_List caddrs := rx_contact.contactBody.contactAddresses;
352 if (lengthof(caddrs) == 0) {
353 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
354 log2str(g_name & ": Received unexpected empty Contact Address list"));
355 }
356 for (var integer i := 0; i < lengthof(caddrs); i := i + 1) {
357 var ContactAddress caddr := caddrs[i];
358 var template (omit) GenericParam param_tpl;
359 var boolean rx_supported;
360 if (not ispresent(caddr.contactParams)) {
361 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
362 log2str(g_name & ": Received unexpected empty Contact attributes (omit)"));
363 }
364 f_sip_param_match_value_or_fail(caddr.contactParams, "+g.3gpp.icsi-ref", "\"urn\\%3Aurn-7\\%3A3gpp-service.ims.icsi.mmtel\"");
365 f_sip_param_match_value_or_fail(caddr.contactParams, "+sip.instance", "\"<urn:gsma:imei:" & g_pars.subscr.imei & ">\"");
366 f_sip_param_match_value_or_fail(caddr.contactParams, "audio", omit);
367
368 /* Check video support */
369 param_tpl := f_sip_param_find(caddr.contactParams, "video");
370 rx_supported := not istemplatekind(param_tpl, "omit");
371 if (rx_supported) {
372 /* This attribute never has a value: */
373 if (not istemplatekind(param_tpl.paramValue, "omit")) {
374 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
375 log2str(g_name & ": Received Contact with 'video' attribute containing a value := ", rx_contact));
376 }
377 if (not g_pars.subscr.support_video) {
378 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
379 log2str(g_name & ": Received Contact with unexpected 'video' attribute := ", rx_contact));
380 }
381 } else if (g_pars.subscr.support_video) {
382 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
383 log2str(g_name & ": Received Contact with missing 'video' attribute := ", rx_contact));
384 }
385
386 /* Check smsip support */
387 param_tpl := f_sip_param_find(caddr.contactParams, "+g.3gpp.smsip");
388 rx_supported := not istemplatekind(param_tpl, "omit");
389 if (rx_supported) {
390 /* This attribute never has a value: */
391 if (not istemplatekind(param_tpl.paramValue, "omit")) {
392 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
393 log2str(g_name & ": Received Contact with '+g.3gpp.smsip' attribute containing a value := ", rx_contact));
394 }
395 if (not g_pars.subscr.support_smsip) {
396 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
397 log2str(g_name & ": Received Contact with unexpected '+g.3gpp.smsip' attribute := ", rx_contact));
398 }
399 } else if (g_pars.subscr.support_smsip) {
400 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
401 log2str(g_name & ": Received Contact with missing '+g.3gpp.smsip' attribute := ", rx_contact));
402 }
403 }
404
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200405}
406
Pau Espin Pedrol0c5c6472024-05-21 13:13:49 +0200407/* Validate P-Access-Network-Info: RFC7315 6.4 */
408private function f_ims_validate_register_P_Access_Network_info(PDU_SIP_Request req,
409 boolean exp_present := true) runs on IMS_ConnHdlr
410
411{
412 if (not exp_present) {
413 if (ispresent(g_rx_sip_req.msgHeader.p_access_network_info)) {
414 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
415 log2str(g_name & ": Received unexpected [rfc7315 6.4] P-Access-Info := ",
416 g_rx_sip_req.msgHeader.p_access_network_info));
417 }
418 return;
419 }
420
421 /* exp_present: */
422 var template (present) P_Access_Network_Info expl_tmpl :=
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200423 tr_P_Access_Network_Info({ tr_Access_net_spec_EUTRAN(g_pars.subscr.uli_str) });
Pau Espin Pedrol0c5c6472024-05-21 13:13:49 +0200424
425 if (not ispresent(g_rx_sip_req.msgHeader.p_access_network_info)) {
426 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
427 log2str(g_name & ": Received no P-Access-Info vs exp := ",
428 expl_tmpl));
429 }
430 if (not match(g_rx_sip_req.msgHeader.p_access_network_info, expl_tmpl)) {
431 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
432 log2str(g_name & ": Received unexpected P-Access-Info := ",
433 g_rx_sip_req.msgHeader.p_access_network_info,
434 "\nvs exp := ", expl_tmpl));
435 }
436}
437
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200438private function f_ims_parse_security_client(Security_client security_client) runs on IMS_ConnHdlr
439{
440 var boolean found := false;
441 for (var integer i := 0; i < lengthof(security_client.sec_mechanism_list); i := i + 1) {
442 var Security_mechanism sec_mec := security_client.sec_mechanism_list[i];
443 if (sec_mec.mechanism_name != "ipsec-3gpp") {
444 log("Skipping Security Mechansim: ", sec_mec.mechanism_name);
445 continue;
446 }
447 var SemicolonParam_List sec_pars := sec_mec.mechanism_params;
448 var charstring par_val;
449 par_val := f_sip_param_get_value_present_or_fail(sec_pars, "alg");
450 if (par_val != "hmac-sha-1-96") {
451 log("Skipping Security Mechansim Algo: ", par_val);
452 continue;
453 }
454 par_val := f_sip_param_get_value_present_or_fail(sec_pars, "spi-c");
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200455 g_pars.subscr.ipsec_remote_spi_c := str2int(par_val);
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200456 par_val := f_sip_param_get_value_present_or_fail(sec_pars, "spi-s");
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200457 g_pars.subscr.ipsec_remote_spi_s := str2int(par_val);
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200458 par_val := f_sip_param_get_value_present_or_fail(sec_pars, "port-c");
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200459 g_pars.subscr.ipsec_remote_port_c := str2int(par_val);
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200460 par_val := f_sip_param_get_value_present_or_fail(sec_pars, "port-s");
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200461 g_pars.subscr.ipsec_remote_port_s := str2int(par_val);
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200462 found := true;
463 break;
464 }
465
466 if (not found) {
467 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
468 log2str(g_name & "alg=hmac-sha-1-96 not found: ", security_client));
469 }
470
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200471 log("ipsec: remote_spi_c=", g_pars.subscr.ipsec_remote_spi_c, " remote_spi_s=", g_pars.subscr.ipsec_remote_spi_s,
472 "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 +0200473}
474
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200475private function f_ims_parse_register_contact(Contact contact) runs on IMS_ConnHdlr
476{
477 var HostPort hp := valueof(contact.contactBody.contactAddresses[0].addressField.nameAddr.addrSpec.hostPort);
478
479 g_pars.subscr.remote_sip_host := hp.host;
480 if (ispresent(hp.portField)) {
481 g_pars.subscr.remote_sip_port := hp.portField;
482 } else {
483 g_pars.subscr.remote_sip_port := 5060;
484 }
485}
486
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200487private function f_IMS_exec_sync(charstring cmdline, template (present) integer rc := 0)
488 runs on IMS_ConnHdlr return ASP_PResult {
489 var ASP_PResult res;
490
491 map(self:PIPE, system:PIPE);
492 res := f_PIPEasp_exec_sync_PResult(PIPE, cmdline, tr_PResult(?, ?, rc));
493 unmap(self:PIPE, system:PIPE);
494
495 return res;
496}
497
498private function f_ims_setup_ipsec() runs on IMS_ConnHdlr
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200499{
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200500 var ASP_PResult res;
501
502 var charstring cmd := mp_ipsec_setup_script_path & " " &
503 g_pars.local_sip_host & " " &
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200504 int2str(g_pars.local_sip_port) & " " & int2str(g_pars.subscr.ipsec_local_spi_c) & " " &
505 int2str(g_pars.local_sip_port) & " " & int2str(g_pars.subscr.ipsec_local_spi_s) & " " &
506 g_pars.subscr.remote_sip_host & " " &
507 int2str(g_pars.subscr.ipsec_remote_port_c) & " " & int2str(g_pars.subscr.ipsec_remote_spi_c) & " " &
508 int2str(g_pars.subscr.ipsec_remote_port_s) & " " & int2str(g_pars.subscr.ipsec_remote_spi_s) & " " &
509 g_pars.subscr.ipsec_auth_key;
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200510
511 res := f_IMS_exec_sync(cmd);
512
513 /* Debug applied rules: */
514 /*
515 res := f_IMS_exec_sync("ip xfrm state");
516 log("ip-xfrm-state Result-Stdout: " & res.stdout);
517
518 res := f_IMS_exec_sync("ip xfrm policy");
519 log("ip-xfrm-policy Result-Stdout: " & res.stdout);
520 */
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200521}
522
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200523private function f_tr_Via_response(Via via_req) return template (present) Via {
524 template (present) SemicolonParam_List via_resp_params := ?;
525
526 /*via_resp_params := {
527 { id := "rport", paramValue := int2str(g_pars.subscr.remote_sip_port.subscr.remote_sip_port) },
528 { id := "received", paramValue := g_pars.subscr.remote_sip_host }
529 }; */
530 return tr_Via_from(via_req.viaBody[0].sentBy,
531 via_req.viaBody[0].sentProtocol.transport,
532 via_resp_params);
533}
534
535private function f_tr_From(template (value) SipAddr from_req) return template (present) SipAddr {
536 return tr_SipAddr_from_val(from_req);
537}
538
539private altstep as_SIP_expect_req(template (present) PDU_SIP_Request sip_expect, boolean fail_others := true) runs on IMS_ConnHdlr
540{
541 var charstring sip_expect_str := log2str(sip_expect);
542 [] SIP.receive(sip_expect) -> value g_rx_sip_req;
543 [fail_others] as_SIP_fail_req(sip_expect_str);
544 [fail_others] as_SIP_fail_resp(sip_expect_str);
545}
546
547private function f_gen_sdp() runs on IMS_ConnHdlr return charstring {
548 var charstring sdp :=
549 "v=0\r\n" &
550 "o=0502 2390 1824 IN IP4 " & g_pars.subscr.cp.local_rtp_addr & "\r\n" &
551 "s=Talk\r\n" &
552 "c=IN IP4 " & g_pars.subscr.cp.local_rtp_addr & "\r\n" &
553 "t=0 0\r\n" &
554 "a=rtcp-xr:rcvr-rtt=all:10000 stat-summary=loss,dup,jitt,TTL voip-metrics\r\n" &
555 "a=record:off\r\n" &
556 "m=audio " & int2str(g_pars.subscr.cp.local_rtp_port) & " RTP/AVP 8 96 97 98 0 18 99 100 101\r\n" &
557 "a=rtpmap:8 PCMA/8000\r\n" &
558 "a=rtpmap:96 opus/48000/2\r\n" &
559 "a=fmtp:96 useinbandfec=1\r\n" &
560 "a=rtpmap:97 speex/16000\r\n" &
561 "a=fmtp:97 vbr=on\r\n" &
562 "a=rtpmap:98 speex/8000\r\n" &
563 "a=fmtp:98 vbr=on\r\n" &
564 "a=fmtp:18 annexb=yes\r\n" &
565 "a=rtpmap:99 telephone-event/48000\r\n" &
566 "a=rtpmap:100 telephone-event/16000\r\n" &
567 "a=rtpmap:101 telephone-event/8000\r\n" &
568 "a=rtcp:" & int2str(g_pars.subscr.cp.local_rtp_port + 1) & "\r\n" &
569 "a=rtcp-fb:* trr-int 1000\r\n" &
570 "a=rtcp-fb:* ccm tmmbr\r\n";
571 return sdp;
572}
573
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200574private function f_gen_Security_server() runs on IMS_ConnHdlr return Security_server {
575 var template (value) Security_server security_server;
576 /* 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 */
577 var template (value) SemicolonParam_List sec_params := {
578 ts_Param("q", "0.1"),
579 ts_Param("prot", "esp"),
580 ts_Param("mod", "trans"),
581 ts_Param("spi-c", int2str(g_pars.subscr.ipsec_local_spi_c)),
582 ts_Param("spi-s", int2str(g_pars.subscr.ipsec_local_spi_s)),
583 ts_Param("port-c", int2str(g_pars.local_sip_port)),
584 ts_Param("port-s", int2str(g_pars.local_sip_port)),
585 ts_Param("alg", "hmac-sha-1-96"),
586 ts_Param("ealg", "null")
587 };
588 security_server := ts_Security_server({
589 ts_Security_mechanism("ipsec-3gpp", sec_params)
590 });
591 return valueof(security_server);
592}
593
594private function f_gen_WwwAuthenticate() runs on IMS_ConnHdlr return WwwAuthenticate {
595 var template (value) WwwAuthenticate wwwAuthenticate;
596 var template (value) CommaParam_List digestCln;
597 digestCln := {
598 ts_Param("realm", f_sip_str_quote(g_pars.realm)),
599 ts_Param("qop", f_sip_str_quote("auth")),
600 ts_Param("algorithm", "AKAv1-MD5"),
601 ts_Param("nonce", f_sip_str_quote(f_nonce_from_rand_autn(g_pars.subscr.auth.rand,
602 g_pars.subscr.auth.autn)))
603 /* "opaque not needed in IMS "*/
604 };
605 wwwAuthenticate := ts_WwwAuthenticate( { ts_Challenge_digestCln(digestCln) } );
606 return valueof(wwwAuthenticate);
607}
608
Pau Espin Pedrol50db4c92024-06-11 18:02:52 +0200609type enumerated IMS_register_early_return {
610 IMS_REG_EARLY_RET_BEFORE_None,
611 IMS_REG_EARLY_RET_BEFORE_Initial_100Trying,
612 IMS_REG_EARLY_RET_BEFORE_Initial_401Unauthorized,
613 IMS_REG_EARLY_RET_BEFORE_Resync_401Unauthorized,
614 IMS_REG_EARLY_RET_BEFORE_Protected_100Trying,
615 IMS_REG_EARLY_RET_BEFORE_Protected_200OK
616}
617
Pau Espin Pedrol586eec52024-06-04 19:07:33 +0200618/* Peer is issuing 1st register, accept it: */
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200619altstep as_IMS_register(boolean exp_auth_resync := false,
Pau Espin Pedrol50db4c92024-06-11 18:02:52 +0200620 IMS_register_early_return early_ret := IMS_REG_EARLY_RET_BEFORE_None,
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200621 boolean fail_others := true) runs on IMS_ConnHdlr
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200622{
623 var template (present) PDU_SIP_Request exp_req :=
624 tr_SIP_REGISTER(g_pars.registrar_sip_req_uri,
625 ?,
Pau Espin Pedrol41b0e072024-05-29 18:25:51 +0200626 tr_From(),
627 tr_To(),
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200628 tr_Via_from(?),
Pau Espin Pedrolcb0dbf92024-06-06 20:40:30 +0200629 expires := tr_Expires(int2str(c_def_expires)),
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200630 require := tr_Require(superset("sec-agree")),
631 security_client := tr_Security_client(superset(tr_Security_mechanism("ipsec-3gpp",
632 superset(tr_Param("alg","hmac-sha-1-96"))))),
633 supported := tr_Supported(superset("path", "sec-agree")));
634 var charstring sip_expect_str := log2str(exp_req);
635
636 [] SIP.receive(exp_req) -> value g_rx_sip_req {
637 var template (value) PDU_SIP_Response tx_resp;
638 var Via via;
639 var CallidString sip_call_id;
Pau Espin Pedrol41b0e072024-05-29 18:25:51 +0200640 var template (value) From from_addr;
641 var template (value) To to_addr;
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200642 var WwwAuthenticate wwwAuthenticate;
643 var Security_server security_server;
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200644 var template (value) Require require := ts_Require({"sec-agree"});
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200645 var template (value) Supported supported := ts_Supported({"sec-agree"});
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200646 var integer sip_seq_nr;
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200647
Pau Espin Pedrol50db4c92024-06-11 18:02:52 +0200648 if (early_ret == IMS_REG_EARLY_RET_BEFORE_Initial_100Trying) {
649 return; /* Done */
650 }
651
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200652 sip_call_id := g_rx_sip_req.msgHeader.callId.callid;
653 via := g_rx_sip_req.msgHeader.via;
654 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 +0200655 from_addr := g_rx_sip_req.msgHeader.fromField;
656 to_addr := g_rx_sip_req.msgHeader.toField;
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200657 sip_seq_nr := g_rx_sip_req.msgHeader.cSeq.seqNumber;
658
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200659 /* Tx 100 Tyring */
660 tx_resp := ts_SIP_Response_Trying(sip_call_id,
661 from_addr,
662 to_addr,
663 via,
664 sip_seq_nr,
665 "REGISTER",
666 allow := omit,
667 server := g_pars.server_name,
668 userAgent := omit);
669 SIP.send(tx_resp);
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200670
Pau Espin Pedrol0c5c6472024-05-21 13:13:49 +0200671 /* Validate P-Access-Network-Info: rfc7315 6.4:
672 * "3GPP will use the P-Access-Network-Info header field to
673 * carry relatively sensitive information like the cell ID. Therefore,
674 * the information MUST NOT be sent outside of the 3GPP domain.""
675 * [...] "the sensitive information carried in the
676 * P-Access-Network-Info header field MUST NOT be sent in any initial
677 * unauthenticated and unprotected requests (e.g., REGISTER)."
678 */
679 f_ims_validate_register_P_Access_Network_info(g_rx_sip_req, exp_present := false);
680
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200681 f_ims_validate_register_contact(g_rx_sip_req.msgHeader.contact);
682 f_ims_parse_register_contact(g_rx_sip_req.msgHeader.contact);
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200683 f_ims_parse_security_client(g_rx_sip_req.msgHeader.security_client);
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200684
Pau Espin Pedrol50db4c92024-06-11 18:02:52 +0200685 if (early_ret == IMS_REG_EARLY_RET_BEFORE_Initial_401Unauthorized) {
686 return; /* Done */
687 }
688
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200689 if (not exp_auth_resync) {
690 /* Delay ipsec setup in ip xfrm, since there will be another
691 * 1st REGISTER with potentially new ports coming in later. */
692 f_ims_setup_ipsec();
693 }
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200694
Pau Espin Pedrol41b0e072024-05-29 18:25:51 +0200695 to_addr.toParams := f_sip_param_set(to_addr.toParams, "tag", f_sip_rand_tag());
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200696 wwwAuthenticate := f_gen_WwwAuthenticate();
697 security_server := f_gen_Security_server();
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200698
699 /* Tx 401 Unauthorized */
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200700 tx_resp := ts_SIP_Response_Unauthorized(sip_call_id,
701 from_addr,
702 to_addr,
703 via,
704 wwwAuthenticate,
705 sip_seq_nr,
706 "REGISTER",
Pau Espin Pedrol586eec52024-06-04 19:07:33 +0200707 p_associated_uri := g_pars.subscr.p_associated_uri,
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200708 security_server := security_server,
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200709 server := g_pars.server_name,
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200710 supported := supported,
711 userAgent := omit);
712 SIP.send(tx_resp);
713
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200714 if (exp_auth_resync) {
715 /* Now we should receive a new non-protected REGISTER
716 * with Authoritzation containing auts in base64: */
717 var template (present) Authorization authorization :=
718 f_tr_Authorization_AKAv1MD5(wwwAuthenticate,
719 g_pars.subscr.imsi & "@" & g_pars.realm,
720 f_sip_SipUrl_to_str(g_pars.registrar_sip_req_uri));
721 exp_req :=
722 tr_SIP_REGISTER(g_pars.registrar_sip_req_uri,
723 ?,
724 tr_From(),
725 tr_To(),
726 tr_Via_from(f_tr_HostPort(via.viaBody[0].sentBy.host, via.viaBody[0].sentBy.portField)),
727 authorization := authorization);
728 SIP.receive(exp_req) -> value g_rx_sip_req;
729
Pau Espin Pedrol50db4c92024-06-11 18:02:52 +0200730 if (early_ret == IMS_REG_EARLY_RET_BEFORE_Resync_401Unauthorized) {
731 return; /* Done */
732 }
733
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200734 via := g_rx_sip_req.msgHeader.via;
735 from_addr := g_rx_sip_req.msgHeader.fromField;
736 to_addr := g_rx_sip_req.msgHeader.toField;
737 sip_seq_nr := g_rx_sip_req.msgHeader.cSeq.seqNumber;
738
739 /* Tx 100 Tyring */
740 tx_resp := ts_SIP_Response_Trying(sip_call_id,
741 from_addr,
742 to_addr,
743 via,
744 sip_seq_nr,
745 "REGISTER",
746 allow := omit,
747 server := g_pars.server_name,
748 userAgent := omit);
749 SIP.send(tx_resp);
750
751 f_sip_param_match_value_or_fail(g_rx_sip_req.msgHeader.authorization.body.digestResponse,
752 "auts", f_sip_str_quote(enc_MIME_Base64(g_pars.subscr.auth.auts)));
753 f_ims_validate_register_P_Access_Network_info(g_rx_sip_req, exp_present := false);
754 f_ims_validate_register_contact(g_rx_sip_req.msgHeader.contact);
755 f_ims_parse_register_contact(g_rx_sip_req.msgHeader.contact);
756 f_ims_parse_security_client(g_rx_sip_req.msgHeader.security_client);
757 f_ims_setup_ipsec();
758
759 security_server := f_gen_Security_server();
760
761 /* Tx again 401 Unauthorized, this time our AMI interface will accept it: */
762 tx_resp := ts_SIP_Response_Unauthorized(sip_call_id,
763 from_addr,
764 to_addr,
765 via,
766 wwwAuthenticate,
767 sip_seq_nr,
768 "REGISTER",
769 p_associated_uri := g_pars.subscr.p_associated_uri,
770 security_server := security_server,
771 server := g_pars.server_name,
772 supported := supported,
773 userAgent := omit);
774 SIP.send(tx_resp);
775 }
776
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200777 /* Now we should receive a new REGISTER over ipsec: */
Pau Espin Pedrol50db4c92024-06-11 18:02:52 +0200778 as_IMS_2nd_register(wwwAuthenticate, early_ret := early_ret);
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200779 }
780 [fail_others] as_SIP_fail_resp(sip_expect_str);
781 [fail_others] as_SIP_fail_req(sip_expect_str);
782
783}
784
785/* Peer is issuing 2nd register, accept it: */
Pau Espin Pedrol50db4c92024-06-11 18:02:52 +0200786altstep as_IMS_2nd_register(WwwAuthenticate wwwAuthenticate,
787 IMS_register_early_return early_ret := IMS_REG_EARLY_RET_BEFORE_None,
788 boolean fail_others := true) runs on IMS_ConnHdlr
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200789{
790 var template (present) Authorization authorization :=
791 f_tr_Authorization_AKAv1MD5(wwwAuthenticate,
792 g_pars.subscr.imsi & "@" & g_pars.realm,
793 f_sip_SipUrl_to_str(g_pars.registrar_sip_req_uri));
794 var template (present) PDU_SIP_Request exp_req :=
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200795 tr_SIP_REGISTER(g_pars.registrar_sip_req_uri,
796 ?,
Pau Espin Pedrol41b0e072024-05-29 18:25:51 +0200797 tr_From(),
798 tr_To(),
Pau Espin Pedrol480b53c2024-06-07 19:49:02 +0200799 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 +0200800 authorization := authorization);
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200801 var charstring sip_expect_str := log2str(exp_req);
802
803 [] SIP.receive(exp_req) -> value g_rx_sip_req {
804 var template (value) PDU_SIP_Response tx_resp;
805 var Via via;
806 var CallidString sip_call_id;
807 var template (value) From from_addr;
808 var template (value) To to_addr;
809 var template (value) Require require := ts_Require({"sec-agree"});
810 var template (value) Supported supported := ts_Supported({"sec-agree"});
811 var integer sip_seq_nr;
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200812
Pau Espin Pedrol50db4c92024-06-11 18:02:52 +0200813 if (early_ret == IMS_REG_EARLY_RET_BEFORE_Protected_100Trying) {
814 return; /* Done */
815 }
816
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200817 sip_call_id := g_rx_sip_req.msgHeader.callId.callid;
818 via := g_rx_sip_req.msgHeader.via;
Pau Espin Pedrol41b0e072024-05-29 18:25:51 +0200819 from_addr := g_rx_sip_req.msgHeader.fromField;
820 to_addr := g_rx_sip_req.msgHeader.toField;
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200821 sip_seq_nr := g_rx_sip_req.msgHeader.cSeq.seqNumber;
822
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200823 /* Tx 100 Trying */
824 tx_resp := ts_SIP_Response_Trying(sip_call_id,
825 from_addr,
826 to_addr,
827 via,
828 sip_seq_nr,
829 "REGISTER",
830 allow := omit,
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200831 server := g_pars.server_name,
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200832 userAgent := omit);
833 SIP.send(tx_resp);
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200834
Pau Espin Pedrol80b981a2024-06-04 18:37:22 +0200835 /* Validate Digest Response: */
836 f_ims_validate_Authorization_AKAv1MD5_Response(g_rx_sip_req.msgHeader.authorization, "REGISTER");
837
Pau Espin Pedrol0c5c6472024-05-21 13:13:49 +0200838 /* Validate P-Access-Network-Info: */
839 f_ims_validate_register_P_Access_Network_info(g_rx_sip_req, exp_present := true);
840
Pau Espin Pedrol50db4c92024-06-11 18:02:52 +0200841 if (early_ret == IMS_REG_EARLY_RET_BEFORE_Protected_200OK) {
842 return; /* Done */
843 }
844
Pau Espin Pedrol586eec52024-06-04 19:07:33 +0200845 g_pars.subscr.p_associated_uri := valueof(ts_P_Associated_Uri({
Pau Espin Pedrol4e6672c2024-05-22 17:03:53 +0200846 ts_P_Assoc_uri_spec(ts_NameAddr(ts_SipUrl(ts_HostPort(g_pars.realm),
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200847 ts_UserInfo(g_pars.subscr.msisdn),
Pau Espin Pedrol4e6672c2024-05-22 17:03:53 +0200848 scheme := "sip"))),
Pau Espin Pedrol901cede2024-05-30 13:03:42 +0200849 ts_P_Assoc_uri_spec(ts_NameAddr(ts_SipUrl(ts_HostPort(g_pars.subscr.msisdn),
Pau Espin Pedrol4e6672c2024-05-22 17:03:53 +0200850 omit,
851 scheme := "tel"))),
852 ts_P_Assoc_uri_spec(g_rx_sip_req.msgHeader.toField.addressField.nameAddr)
Pau Espin Pedrol586eec52024-06-04 19:07:33 +0200853 }));
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200854 f_ims_validate_register_contact(g_rx_sip_req.msgHeader.contact);
855 f_ims_parse_register_contact(g_rx_sip_req.msgHeader.contact);
856 g_pars.subscr.registered_contact := g_rx_sip_req.msgHeader.contact;
Pau Espin Pedrol4e6672c2024-05-22 17:03:53 +0200857
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200858 /* Tx 200 OK */
Pau Espin Pedrol41b0e072024-05-29 18:25:51 +0200859 to_addr.toParams := f_sip_param_set(to_addr.toParams, "tag", f_sip_rand_tag());
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200860 tx_resp := ts_SIP_Response(sip_call_id,
861 from_addr,
862 to_addr,
863 "REGISTER", 200,
864 sip_seq_nr,
865 "OK",
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200866 via,
Pau Espin Pedrol586eec52024-06-04 19:07:33 +0200867 p_associated_uri := g_pars.subscr.p_associated_uri,
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200868 require := require,
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200869 server := g_pars.server_name,
Pau Espin Pedrola674d612024-05-14 19:56:33 +0200870 supported := supported,
871 userAgent := omit);
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200872 SIP.send(tx_resp);
873 }
874 [fail_others] as_SIP_fail_resp(sip_expect_str);
875 [fail_others] as_SIP_fail_req(sip_expect_str);
Pau Espin Pedrola2812ec2024-05-10 20:30:44 +0200876}
877
Pau Espin Pedrol586eec52024-06-04 19:07:33 +0200878/* Peer wants to unregister, accept it: */
879altstep as_IMS_unregister(boolean fail_others := true) runs on IMS_ConnHdlr
880{
881 var template (present) PDU_SIP_Request exp_req :=
882 tr_SIP_REGISTER(g_pars.registrar_sip_req_uri,
883 ?,
884 tr_From(),
885 tr_To(),
Pau Espin Pedrol480b53c2024-06-07 19:49:02 +0200886 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 +0200887 expires := tr_Expires(int2str(0)),
888 require := tr_Require(superset("sec-agree")),
889 security_client := tr_Security_client(superset(tr_Security_mechanism("ipsec-3gpp",
890 superset(tr_Param("alg","hmac-sha-1-96"))))),
891 supported := tr_Supported(superset("path", "sec-agree")));
892 var charstring sip_expect_str := log2str(exp_req);
893
894 [] SIP.receive(exp_req) -> value g_rx_sip_req {
895 var template (value) PDU_SIP_Response tx_resp;
896 var Via via;
897 var CallidString sip_call_id;
898 var Contact contact;
899 var template (value) From from_addr;
900 var template (value) To to_addr;
901 var template (value) CommaParam_List digestCln ;
902 var template (value) WwwAuthenticate wwwAuthenticate;
903 var template (value) Security_server security_server;
Pau Espin Pedrol586eec52024-06-04 19:07:33 +0200904 var template (value) Require require := ts_Require({"sec-agree"});
905 var template (value) Supported supported := ts_Supported({"sec-agree"});
906 var template (present) Authorization authorization;
907 var integer sip_seq_nr;
Pau Espin Pedrol586eec52024-06-04 19:07:33 +0200908
909 sip_call_id := g_rx_sip_req.msgHeader.callId.callid;
910 via := g_rx_sip_req.msgHeader.via;
911 via.viaBody[0].viaParams := f_sip_param_set(via.viaBody[0].viaParams, "rport", "1234"); /* TODO: set remote src port of the REGISTER */
912 from_addr := g_rx_sip_req.msgHeader.fromField;
913 to_addr := g_rx_sip_req.msgHeader.toField;
914 sip_seq_nr := g_rx_sip_req.msgHeader.cSeq.seqNumber;
915
916 contact := g_rx_sip_req.msgHeader.contact;
917 f_ims_validate_register_contact(contact);
918
Pau Espin Pedrolf1963b32024-06-07 17:07:16 +0200919 /* Validate P-Access-Network-Info: 3GPP TS 24.229 5.1.2A.1.1
920 * "If available to the UE (as defined in the access technology specific annexes for each access technology), the UE shall
921 * insert a P-Access-Network-Info header field into any request for a dialog, any subsequent request (except CANCEL
922 * requests) or response (except CANCEL responses) within a dialog or any request for a standalone method (see
923 * subclause 7.2A.4). Insertion of the P-Access-Network-Info header field into the ACK request is optional."
924 */
Pau Espin Pedrol586eec52024-06-04 19:07:33 +0200925 f_ims_validate_register_P_Access_Network_info(g_rx_sip_req, exp_present := true);
926
Pau Espin Pedrolf1963b32024-06-07 17:07:16 +0200927
Pau Espin Pedrol586eec52024-06-04 19:07:33 +0200928 /* Tx 100 Tyring */
929 tx_resp := ts_SIP_Response_Trying(sip_call_id,
930 from_addr,
931 to_addr,
932 via,
933 sip_seq_nr,
934 "REGISTER",
935 allow := omit,
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200936 server := g_pars.server_name,
Pau Espin Pedrol586eec52024-06-04 19:07:33 +0200937 userAgent := omit);
938 SIP.send(tx_resp);
939
940 /* Change all Contact parameters to expires=0: */
941 for (var integer i := 0; i < lengthof(contact.contactBody.contactAddresses); i := i + 1) {
942 contact.contactBody.contactAddresses[i].contactParams := valueof({ ts_Param("expires", "0") });
943 }
Pau Espin Pedrol5acf7c62024-06-06 19:23:08 +0200944 g_pars.subscr.registered_contact := omit;
Pau Espin Pedrol586eec52024-06-04 19:07:33 +0200945 /* Tx 200 OK */
946 to_addr.toParams := f_sip_param_set(to_addr.toParams, "tag", f_sip_rand_tag());
947 tx_resp := ts_SIP_Response(sip_call_id,
948 from_addr,
949 to_addr,
950 "REGISTER", 200,
951 sip_seq_nr,
952 "OK",
953 via,
954 contact := contact,
955 p_associated_uri := g_pars.subscr.p_associated_uri,
956 require := require,
Pau Espin Pedrol8e1bdd42024-06-10 20:13:48 +0200957 server := g_pars.server_name,
Pau Espin Pedrol586eec52024-06-04 19:07:33 +0200958 supported := supported,
959 userAgent := omit);
960 SIP.send(tx_resp);
961 }
962 [fail_others] as_SIP_fail_resp(sip_expect_str);
963 [fail_others] as_SIP_fail_req(sip_expect_str);
964}
965
Pau Espin Pedrolce370df2024-06-18 13:45:53 +0200966/* IMS Core starts a call towards the peer: 3GPP TS 24.229 5.1.3.1 */
Pau Espin Pedrol5acf7c62024-06-06 19:23:08 +0200967function f_IMS_mt_call_setup() runs on IMS_ConnHdlr
968{
969 var template (value) PDU_SIP_Request req;
970 var template (present) PDU_SIP_Response exp;
971 var template (present) From from_addr_exp;
972 var template (present) To to_addr_exp;
973 var Via via;
Pau Espin Pedrolce370df2024-06-18 13:45:53 +0200974 var template (omit) Require require := omit;
975 var template (omit) Supported supported := omit;
Pau Espin Pedrol5acf7c62024-06-06 19:23:08 +0200976 var charstring tx_sdp := f_gen_sdp();
977 var default d_trying, d_ringing;
978 var charstring branch_value;
979 var Contact calling_contact;
980
981 /* RFC 3261 8.1.1.3 From */
982 g_pars.subscr.cp.from_addr := valueof(ts_From(g_pars.subscr.cp.calling.addr, g_pars.subscr.cp.calling.params));
983 g_pars.subscr.cp.from_addr.fromParams := f_sip_param_set(g_pars.subscr.cp.from_addr.fromParams, "tag", f_sip_rand_tag());
984 g_pars.subscr.cp.to_addr := valueof(ts_To(g_pars.subscr.cp.called.addr, g_pars.subscr.cp.called.params));
985 from_addr_exp := tr_From(tr_Addr_Union_from_val(g_pars.subscr.cp.from_addr.addressField), *);
986 to_addr_exp := tr_To(tr_Addr_Union_from_val(g_pars.subscr.cp.to_addr.addressField), *);
987 branch_value := f_sip_gen_branch(f_sip_Addr_Union_to_str(g_pars.subscr.cp.from_addr.addressField),
988 f_sip_Addr_Union_to_str(valueof(g_pars.subscr.cp.to_addr.addressField)),
989 g_pars.subscr.cp.sip_call_id,
990 g_pars.subscr.cp.sip_seq_nr);
991 via := g_pars.local_via;
992 via.viaBody[0].viaParams := f_sip_param_set(via.viaBody[0].viaParams, "branch", branch_value);
993
994 calling_contact := valueof(ts_Contact({
995 ts_ContactAddress(g_pars.subscr.cp.calling.addr, omit)
996 }));
997
Pau Espin Pedrolce370df2024-06-18 13:45:53 +0200998 if (g_pars.subscr.cp.support_precondition_ext) {
999 /* indicate the support for "reliable provisional response"
1000 * and "preconditions mechanism" */
1001 supported := ts_Supported({ "100rel", "precondition" });
1002 }
1003
Pau Espin Pedrol5acf7c62024-06-06 19:23:08 +02001004 req := ts_SIP_INVITE(g_pars.subscr.cp.sip_call_id,
1005 g_pars.subscr.cp.from_addr,
1006 g_pars.subscr.cp.to_addr,
1007 via,
1008 calling_contact,
1009 g_pars.subscr.cp.sip_seq_nr,
Pau Espin Pedrolce370df2024-06-18 13:45:53 +02001010 supported := supported,
Pau Espin Pedrol5acf7c62024-06-06 19:23:08 +02001011 body := tx_sdp);
1012
1013 SIP.send(req);
1014
1015 /* Conditionally match and accept 100 Trying. */
1016 exp := tr_SIP_Response_Trying(g_pars.subscr.cp.sip_call_id,
1017 from_addr_exp,
1018 to_addr_exp,
1019 f_tr_Via_response(via),
1020 g_pars.subscr.cp.sip_seq_nr, "INVITE");
1021 d_trying := activate(as_SIP_ignore_resp(exp));
1022
Pau Espin Pedrolce370df2024-06-18 13:45:53 +02001023 if (g_pars.subscr.cp.require_precondition_ext) {
1024 /* Rx 183 Session Progress */
1025 exp := tr_SIP_Response_SessionProgress(
1026 g_pars.subscr.cp.sip_call_id,
1027 from_addr_exp,
1028 to_addr_exp,
1029 f_tr_Via_response(via),
1030 g_pars.subscr.cp.sip_seq_nr, "INVITE",
1031 require := tr_Require(superset("100rel", "precondition")),
1032 rseq := tr_RSeq(?));
1033 alt {
1034 [] SIP.receive(exp) -> value g_rx_sip_resp;
1035 [] SIP.receive(tr_SIP_Response_Ringing(?, ?, ?)) -> value g_rx_sip_resp {
1036 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
1037 log2str(g_name & ": Expected 183 Session Progress instead of 180 Ringing: ",
1038 g_rx_sip_resp));
1039 }
1040 }
1041
1042 /* Tx PRACK */
1043 req := ts_SIP_PRACK(g_pars.subscr.cp.to_addr.addressField.nameAddr.addrSpec,
1044 g_pars.subscr.cp.sip_call_id,
1045 g_pars.subscr.cp.from_addr,
1046 g_pars.subscr.cp.to_addr,
1047 via,
1048 g_rx_sip_resp.msgHeader.cSeq.seqNumber + 1,
1049 rack := ts_RAck(g_rx_sip_resp.msgHeader.rseq.response_num,
1050 g_rx_sip_resp.msgHeader.cSeq.seqNumber,
1051 "INVITE"),
1052 body := omit);
1053 SIP.send(req);
1054
Pau Espin Pedrol4d572062024-06-18 20:20:55 +02001055 if (g_pars.subscr.cp.mt.tx_coord_cmd_session_progress) {
1056 /* Signal used to inform that Dedicated bearer can be established: */
1057 COORD.send(IMS_COORD_CMD_CALL_SESSION_PROGRESS);
1058 }
1059
Pau Espin Pedrolce370df2024-06-18 13:45:53 +02001060 /* Rx 200 OK (PRACK) */
1061 exp := tr_SIP_Response(g_pars.subscr.cp.sip_call_id,
1062 from_addr_exp,
1063 to_addr_exp,
1064 f_tr_Via_response(via),
1065 omit,
1066 "PRACK", 200,
1067 g_rx_sip_resp.msgHeader.cSeq.seqNumber + 1, "OK",
1068 body := omit);
1069 as_SIP_expect_resp(exp, fail_others := false);
1070
1071 /* Tx UPDATE */
1072 req := ts_SIP_UPDATE(g_pars.subscr.cp.to_addr.addressField.nameAddr.addrSpec,
1073 g_pars.subscr.cp.sip_call_id,
1074 g_pars.subscr.cp.from_addr,
1075 g_pars.subscr.cp.to_addr,
1076 via,
1077 g_rx_sip_resp.msgHeader.cSeq.seqNumber + 1,
1078 contact := calling_contact,
1079 require := ts_Require({"sec-agree", "precondition"}),
1080 body := tx_sdp);
1081 SIP.send(req);
1082
1083 /* Rx 200 OK (UPDATE) */
1084 exp := tr_SIP_Response(g_pars.subscr.cp.sip_call_id,
1085 from_addr_exp,
1086 to_addr_exp,
1087 f_tr_Via_response(via),
1088 omit,
1089 "UPDATE", 200,
1090 g_rx_sip_resp.msgHeader.cSeq.seqNumber + 1, "OK",
1091 body := ?);
1092 as_SIP_expect_resp(exp, fail_others := false);
1093
1094 g_pars.subscr.cp.sip_seq_nr := g_rx_sip_resp.msgHeader.cSeq.seqNumber + 1;
1095 }
1096
Pau Espin Pedrol5acf7c62024-06-06 19:23:08 +02001097 /* Conditionally match and accept 180 Ringing */
1098 exp := tr_SIP_Response_Ringing(g_pars.subscr.cp.sip_call_id,
1099 from_addr_exp,
1100 to_addr_exp,
1101 f_tr_Via_response(via),
1102 g_pars.subscr.cp.sip_seq_nr, "INVITE");
1103 d_ringing := activate(as_SIP_ignore_resp(exp));
1104
1105 /* Wait for OK answer */
1106 exp := tr_SIP_Response(
1107 g_pars.subscr.cp.sip_call_id,
1108 from_addr_exp,
1109 to_addr_exp,
1110 f_tr_Via_response(via),
1111 *,
1112 "INVITE", 200,
1113 g_pars.subscr.cp.sip_seq_nr, "OK",
1114 body := ?);
1115 as_SIP_expect_resp(exp, fail_others := false);
1116
1117 deactivate(d_trying);
1118 deactivate(d_ringing);
1119
1120 /* Update To with the tags received from peer: */
1121 g_pars.subscr.cp.to_addr := g_rx_sip_resp.msgHeader.toField;
1122
1123 /* Transmit ACK */
1124 g_pars.subscr.cp.sip_seq_nr := g_pars.subscr.cp.sip_seq_nr + 1;
1125 req := ts_SIP_ACK(g_pars.subscr.cp.sip_call_id,
1126 g_pars.subscr.cp.from_addr,
1127 g_pars.subscr.cp.to_addr,
1128 via,
1129 g_pars.subscr.cp.sip_seq_nr,
1130 omit);
1131 SIP.send(req);
1132 g_pars.subscr.cp.sip_seq_nr := g_pars.subscr.cp.sip_seq_nr + 1;
1133}
1134
1135/* Tx BYE: */
1136function f_IMS_do_call_hangup() runs on IMS_ConnHdlr
1137{
1138 var template (value) PDU_SIP_Request req;
1139 var template (present) PDU_SIP_Response exp_resp;
1140 var Via via;
1141 var charstring branch_value;
1142
1143 branch_value := f_sip_gen_branch(f_sip_Addr_Union_to_str(g_pars.subscr.cp.from_addr.addressField),
1144 f_sip_Addr_Union_to_str(valueof(g_pars.subscr.cp.to_addr.addressField)),
1145 g_pars.subscr.cp.sip_call_id,
1146 g_pars.subscr.cp.sip_seq_nr);
1147
1148 via := g_pars.local_via;
1149 via.viaBody[0].viaParams := f_sip_param_set(via.viaBody[0].viaParams, "branch", branch_value);
1150
1151 /* Transmit ACK */
1152 req := ts_SIP_BYE(g_pars.subscr.cp.sip_call_id,
1153 g_pars.subscr.cp.from_addr,
1154 g_pars.subscr.cp.to_addr,
1155 via,
1156 g_pars.subscr.cp.sip_seq_nr,
1157 omit);
1158 SIP.send(req);
1159
1160 /* Wait for OK answer */
1161 exp_resp := tr_SIP_Response(
1162 g_pars.subscr.cp.sip_call_id,
1163 g_pars.subscr.cp.from_addr,
1164 tr_To(tr_Addr_Union_from_val(g_pars.subscr.cp.to_addr.addressField), *),
1165 f_tr_Via_response(via),
1166 *,
1167 "BYE", 200,
1168 g_pars.subscr.cp.sip_seq_nr, "OK");
1169 as_SIP_expect_resp(exp_resp);
1170
1171 g_pars.subscr.cp.sip_seq_nr := g_pars.subscr.cp.sip_seq_nr + 1;
1172}
1173
Pau Espin Pedrol901cede2024-05-30 13:03:42 +02001174private function f_ConnHdlr_parse_initial_SIP_INVITE(PDU_SIP_Request rx_sip_req) runs on IMS_ConnHdlr
1175{
1176 f_SDP_decodeMessage(rx_sip_req.messageBody, g_pars.subscr.cp.peer_sdp);
1177 log("Rx Initial MO INVITE decoded SDP: ", g_pars.subscr.cp.peer_sdp);
1178
1179 /* Obtain params: */
1180 g_pars.subscr.cp.sip_call_id := rx_sip_req.msgHeader.callId.callid;
1181 g_pars.subscr.cp.from_addr := rx_sip_req.msgHeader.fromField;
1182 g_pars.subscr.cp.to_addr := rx_sip_req.msgHeader.toField;
1183 g_pars.subscr.cp.to_addr.toParams := f_sip_param_set(g_pars.subscr.cp.to_addr.toParams, "tag", f_sip_rand_tag());
1184 g_pars.subscr.cp.sip_seq_nr := rx_sip_req.msgHeader.cSeq.seqNumber;
1185}
1186
1187/* Peer is calling us, accept it: */
1188altstep as_IMS_mo_call_accept(boolean exp_update_to_direct_rtp := false,
1189 boolean fail_others := true) runs on IMS_ConnHdlr
1190{
1191 var template (present) PDU_SIP_Request exp_req :=
1192 tr_SIP_INVITE(f_tr_SipUrl_opt_defport(ts_SipUrl_from_Addr_Union(g_pars.subscr.cp.called.addr)),
1193 ?,
Pau Espin Pedrol09087012024-06-04 18:07:48 +02001194 tr_From(tr_Addr_Union_from_val(g_pars.subscr.cp.calling.addr), *),
Pau Espin Pedrol901cede2024-05-30 13:03:42 +02001195 tr_To(tr_Addr_Union_from_val(g_pars.subscr.cp.called.addr), *),
Pau Espin Pedrol480b53c2024-06-07 19:49:02 +02001196 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 +02001197 ?, ?);
1198 var charstring sip_expect_str := log2str(exp_req);
1199
1200 [] SIP.receive(exp_req) -> value g_rx_sip_req {
1201 var template (value) PDU_SIP_Response tx_resp;
1202 var Via via;
1203 var charstring tx_sdp;
Pau Espin Pedrolfaf21be2024-06-12 16:42:00 +02001204 var boolean peer_support_precondition := match(g_rx_sip_req.msgHeader.supported.optionsTags,
1205 superset("100rel", "precondition"));
Pau Espin Pedrol901cede2024-05-30 13:03:42 +02001206
1207 /* Obtain params: */
1208 f_ConnHdlr_parse_initial_SIP_INVITE(g_rx_sip_req);
1209 via := g_rx_sip_req.msgHeader.via;
1210
Pau Espin Pedrolf1963b32024-06-07 17:07:16 +02001211 f_ims_validate_register_P_Access_Network_info(g_rx_sip_req, exp_present := true);
Pau Espin Pedrolfaf21be2024-06-12 16:42:00 +02001212 if (g_pars.subscr.cp.require_precondition_ext and not peer_support_precondition) {
1213 Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail,
1214 log2str(g_name & ": Missing '100rel,precondition' in INVITE Supported header: ",
1215 g_rx_sip_req.msgHeader.supported));
1216 }
Pau Espin Pedrolf1963b32024-06-07 17:07:16 +02001217
Pau Espin Pedrolfaf21be2024-06-12 16:42:00 +02001218 /* Tx 100 Tyring */
1219 tx_resp := ts_SIP_Response_Trying(g_pars.subscr.cp.sip_call_id,
Pau Espin Pedrol901cede2024-05-30 13:03:42 +02001220 g_pars.subscr.cp.from_addr,
1221 g_pars.subscr.cp.to_addr,
1222 via,
Pau Espin Pedrolfaf21be2024-06-12 16:42:00 +02001223 g_pars.subscr.cp.sip_seq_nr,
1224 "INVITE",
1225 allow := omit,
1226 server := g_pars.server_name,
1227 userAgent := omit);
Pau Espin Pedrol901cede2024-05-30 13:03:42 +02001228 SIP.send(tx_resp);
1229
Pau Espin Pedrol4d572062024-06-18 20:20:55 +02001230 if (g_pars.subscr.cp.mo.tx_coord_cmd_invite_trying) {
1231 /* Signal used to inform that Dedicated bearer can be established: */
1232 COORD.send(IMS_COORD_CMD_CALL_TRYING);
1233 }
1234
Pau Espin Pedrol901cede2024-05-30 13:03:42 +02001235 tx_sdp := f_gen_sdp();
Pau Espin Pedrolfaf21be2024-06-12 16:42:00 +02001236
1237 /* Use precondition ? */
1238 if (g_pars.subscr.cp.require_precondition_ext or
1239 (g_pars.subscr.cp.support_precondition_ext and peer_support_precondition)) {
1240 /* Tx 183 Session Progress */
1241 /* TODO: add a=curr:qos, a=des:qos and a=conf:qos fields to SDP */
1242 tx_resp := ts_SIP_Response_SessionProgress(g_pars.subscr.cp.sip_call_id,
1243 g_pars.subscr.cp.from_addr,
1244 g_pars.subscr.cp.to_addr,
1245 via,
1246 g_pars.subscr.cp.sip_seq_nr,
1247 rseq := ts_RSeq(1),
1248 body := tx_sdp);
1249 SIP.send(tx_resp);
1250
1251 /* Rx PRACK */
1252 exp_req := tr_SIP_PRACK(f_tr_SipUrl_opt_defport(ts_SipUrl_from_Addr_Union(g_pars.subscr.cp.called.addr)),
1253 g_pars.subscr.cp.sip_call_id,
1254 g_pars.subscr.cp.from_addr,
1255 g_pars.subscr.cp.to_addr,
1256 f_tr_Via_response(via),
1257 g_pars.subscr.cp.sip_seq_nr + 1,
1258 rack := tr_RAck(1, g_pars.subscr.cp.sip_seq_nr, "INVITE"),
1259 body := omit);
1260 as_SIP_expect_req(exp_req);
1261
1262 /* Tx 200 OK (PRACK) */
1263 tx_resp := ts_SIP_Response(g_pars.subscr.cp.sip_call_id,
1264 g_pars.subscr.cp.from_addr,
1265 g_pars.subscr.cp.to_addr,
1266 "PRACK", 200,
1267 g_pars.subscr.cp.sip_seq_nr,
1268 "OK",
1269 via,
1270 body := omit);
1271 SIP.send(tx_resp);
1272
1273 /* Rx UPDATE */
1274 exp_req := tr_SIP_UPDATE(f_tr_SipUrl_opt_defport(ts_SipUrl_from_Addr_Union(g_pars.subscr.cp.called.addr)),
1275 g_pars.subscr.cp.sip_call_id,
1276 g_pars.subscr.cp.from_addr,
1277 g_pars.subscr.cp.to_addr,
1278 f_tr_Via_response(via),
1279 g_pars.subscr.cp.sip_seq_nr + 1,
1280 require := tr_Require(superset("precondition")),
1281 body := ?);
1282 as_SIP_expect_req(exp_req);
1283
1284 /* Tx 200 OK (UPDATE) */
1285 /* TODO: add a=curr:qos, a=des:qos and a=conf:qos fields to SDP */
1286 tx_resp := ts_SIP_Response(g_pars.subscr.cp.sip_call_id,
1287 g_pars.subscr.cp.from_addr,
1288 g_pars.subscr.cp.to_addr,
1289 "UPDATE", 200,
1290 g_pars.subscr.cp.sip_seq_nr,
1291 "OK",
1292 via,
1293 body := tx_sdp);
1294 SIP.send(tx_resp);
1295
1296 g_pars.subscr.cp.sip_seq_nr := g_pars.subscr.cp.sip_seq_nr + 1;
1297 }
1298
1299 /* Tx 180 Ringing */
1300 tx_resp := ts_SIP_Response_Ringing(g_pars.subscr.cp.sip_call_id,
1301 g_pars.subscr.cp.from_addr,
1302 g_pars.subscr.cp.to_addr,
1303 via,
1304 g_pars.subscr.cp.sip_seq_nr);
1305 SIP.send(tx_resp);
1306
1307
1308 /* Tx 200 OK */
Pau Espin Pedrol901cede2024-05-30 13:03:42 +02001309 tx_resp := ts_SIP_Response(g_pars.subscr.cp.sip_call_id,
1310 g_pars.subscr.cp.from_addr,
1311 g_pars.subscr.cp.to_addr,
1312 "INVITE", 200,
1313 g_pars.subscr.cp.sip_seq_nr,
1314 "OK",
1315 via,
1316 body := tx_sdp);
1317 SIP.send(tx_resp);
1318
1319 /* Wait for ACK */
1320 exp_req := tr_SIP_ACK(f_tr_SipUrl_opt_defport(ts_SipUrl_from_Addr_Union(g_pars.subscr.cp.called.addr)),
1321 g_pars.subscr.cp.sip_call_id,
1322 g_pars.subscr.cp.from_addr,
1323 g_pars.subscr.cp.to_addr,
1324 f_tr_Via_response(via),
1325 g_pars.subscr.cp.sip_seq_nr, *);
1326 as_SIP_expect_req(exp_req);
1327 }
1328 [fail_others] as_SIP_fail_resp(sip_expect_str);
1329 [fail_others] as_SIP_fail_req(sip_expect_str);
1330
1331}
1332
1333/* Call is terminated by peer: */
1334altstep as_IMS_exp_call_hangup(template (present) integer exp_seq_nr := ?, boolean fail_others := true) runs on IMS_ConnHdlr
1335{
1336 var template (present) PDU_SIP_Request exp_req :=
1337 tr_SIP_BYE(f_tr_SipUrl_opt_defport(ts_SipUrl_from_Addr_Union(g_pars.subscr.cp.called.addr)),
1338 g_pars.subscr.cp.sip_call_id,
1339 g_pars.subscr.cp.from_addr,
1340 g_pars.subscr.cp.to_addr,
Pau Espin Pedrol480b53c2024-06-07 19:49:02 +02001341 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 +02001342 exp_seq_nr);
1343 var charstring sip_expect_str := log2str(exp_req);
1344
1345 [] SIP.receive(exp_req) -> value g_rx_sip_req {
1346 var template (value) PDU_SIP_Response tx_resp;
1347 var charstring tx_sdp;
1348 var Via via;
1349
1350 /* Update parameters: */
1351 g_pars.subscr.cp.sip_seq_nr := g_rx_sip_req.msgHeader.cSeq.seqNumber;
1352 /* "branch" has changed: */
1353 via := g_rx_sip_req.msgHeader.via;
1354
1355 /* Tx 200 OK */
1356 tx_sdp := f_gen_sdp();
1357 tx_resp := ts_SIP_Response(g_pars.subscr.cp.sip_call_id,
1358 g_pars.subscr.cp.from_addr,
1359 g_pars.subscr.cp.to_addr,
1360 "BYE", 200,
1361 g_pars.subscr.cp.sip_seq_nr,
1362 "OK",
1363 via,
1364 body := tx_sdp);
1365 SIP.send(tx_resp);
1366 }
1367 [fail_others] as_SIP_fail_resp(sip_expect_str);
1368 [fail_others] as_SIP_fail_req(sip_expect_str);
1369}
1370
Pau Espin Pedrolac8a0542024-04-19 17:30:57 +02001371}