Harald Welte | 4029e8c | 2017-11-23 22:00:42 +0100 | [diff] [blame] | 1 | module MGCP_Templates { |
| 2 | |
Harald Welte | 35bb716 | 2018-01-03 21:07:52 +0100 | [diff] [blame] | 3 | /* MGCP Templates, building on top of MGCP_Types (Osmocom) and SDP_Types from Ericsson. |
| 4 | * |
| 5 | * (C) 2017 by Harald Welte <laforge@gnumonks.org> |
| 6 | * All rights reserved. |
| 7 | * |
| 8 | * Released under the terms of GNU General Public License, Version 2 or |
| 9 | * (at your option) any later version. |
| 10 | */ |
| 11 | |
| 12 | |
Harald Welte | 4029e8c | 2017-11-23 22:00:42 +0100 | [diff] [blame] | 13 | import from MGCP_Types all; |
| 14 | import from SDP_Types all; |
| 15 | |
| 16 | function f_mgcp_par_append(inout template MgcpParameterList list, template MgcpParameter par) { |
| 17 | var integer len := lengthof(list); |
| 18 | list[len] := par; |
| 19 | } |
| 20 | |
| 21 | /* 3.2.2.6 Connection Mode (sendonly, recvonly, sendrecv, confrnce, inactive, loopback, |
| 22 | * conttest, netwloop, netwtest) */ |
| 23 | template MgcpParameter t_MgcpParConnMode(template MgcpConnectionMode mode) := { "M", mode }; |
| 24 | |
| 25 | /* 3.2.2.2 CallId: maximum 32 hex chars */ |
| 26 | template MgcpParameter ts_MgcpParCallId(MgcpCallId cid) := { |
| 27 | code := "C", |
| 28 | val := hex2str(cid) |
| 29 | }; |
| 30 | |
| 31 | /* 3.2.2.18 RequestIdentifier: Maximum 32 hex chars */ |
| 32 | template MgcpParameter ts_MgcpParReqId(MgcpRequestId rid) := { |
| 33 | code := "X", |
| 34 | val := hex2str(rid) |
| 35 | }; |
| 36 | |
Harald Welte | 363cb0a | 2018-01-30 19:35:53 +0100 | [diff] [blame] | 37 | /* 3.2.1.3 SpecificEndpointId */ |
| 38 | template MgcpParameter ts_MgcpParSpecEP(MgcpEndpoint ep) := { |
| 39 | code := "Z", |
| 40 | val := ep |
| 41 | }; |
| 42 | |
Harald Welte | 4029e8c | 2017-11-23 22:00:42 +0100 | [diff] [blame] | 43 | /* 3.2.2.10: LocalConnectionOptions (codec, packetization, bandwidth, ToS, eco, gain, silence, ...) */ |
| 44 | template MgcpParameter t_MgcpParLocConnOpt(template charstring lco) := { "L", lco }; |
| 45 | |
| 46 | /* 3.2.2.5: ConnectionId: maximum 32 hex chars */ |
| 47 | template MgcpParameter ts_MgcpParConnectionId(MgcpConnectionId cid) := { |
| 48 | code := "I", |
| 49 | val := hex2str(cid) |
| 50 | }; |
| 51 | |
| 52 | /* osmo-bsc_mgcp implements L/C/M/X only, osmo-mgw adds 'I' */ |
| 53 | /* SDP: osmo-bsc_mgcp implements Tx of v,o,s,c,t,m,a */ |
| 54 | |
| 55 | template MgcpResponse tr_MgcpResp_Err(template MgcpResponseCode code) := { |
| 56 | line := { |
| 57 | code := code, |
| 58 | trans_id := ?, |
| 59 | string := ? |
| 60 | }, |
| 61 | params := {}, |
| 62 | sdp := omit |
| 63 | } |
| 64 | |
| 65 | template MgcpCommandLine t_MgcpCmdLine(template charstring verb, template MgcpTransId trans_id, template charstring ep) := { |
| 66 | verb := verb, |
| 67 | trans_id := trans_id, |
| 68 | ep := ep, |
| 69 | ver := "1.0" |
| 70 | }; |
| 71 | |
| 72 | template MgcpCommand ts_CRCX(MgcpTransId trans_id, charstring ep, MgcpConnectionMode mode, MgcpCallId call_id, template SDP_Message sdp := omit) := { |
| 73 | line := t_MgcpCmdLine("CRCX", trans_id, ep), |
| 74 | params := { |
| 75 | t_MgcpParConnMode(mode), |
| 76 | ts_MgcpParCallId(call_id), |
| 77 | //t_MgcpParReqId(omit), |
Daniel Willmann | fbef714 | 2017-11-30 13:16:14 +0100 | [diff] [blame] | 78 | t_MgcpParLocConnOpt("p:20, a:AMR") |
Harald Welte | 4029e8c | 2017-11-23 22:00:42 +0100 | [diff] [blame] | 79 | }, |
| 80 | sdp := sdp |
| 81 | } |
| 82 | |
Philipp Maier | 45635f4 | 2018-06-05 17:28:02 +0200 | [diff] [blame] | 83 | template MgcpCommand ts_CRCX_no_lco(MgcpTransId trans_id, charstring ep, MgcpConnectionMode mode, MgcpCallId call_id, template SDP_Message sdp := omit) := { |
| 84 | line := t_MgcpCmdLine("CRCX", trans_id, ep), |
| 85 | params := { |
| 86 | t_MgcpParConnMode(mode), |
| 87 | ts_MgcpParCallId(call_id) |
| 88 | }, |
| 89 | sdp := sdp |
| 90 | } |
| 91 | |
Harald Welte | 4017d55 | 2018-01-26 21:40:05 +0100 | [diff] [blame] | 92 | template MgcpCommand tr_CRCX(template MgcpEndpoint ep := ?) := { |
| 93 | line := t_MgcpCmdLine("CRCX", ?, ep), |
Harald Welte | 9002957 | 2017-11-24 23:39:50 +0100 | [diff] [blame] | 94 | params := *, |
| 95 | sdp := * |
| 96 | } |
| 97 | |
Harald Welte | 4029e8c | 2017-11-23 22:00:42 +0100 | [diff] [blame] | 98 | template MgcpResponse tr_CRCX_ACK := { |
| 99 | line := { |
| 100 | code := "200", |
Harald Welte | 51f34ad | 2017-11-24 20:40:43 +0100 | [diff] [blame] | 101 | trans_id := ?, |
Harald Welte | 4029e8c | 2017-11-23 22:00:42 +0100 | [diff] [blame] | 102 | string := "OK" |
| 103 | }, |
| 104 | params:= { { "I", ? }, *}, |
| 105 | sdp := ? |
| 106 | } |
| 107 | |
Harald Welte | 9002957 | 2017-11-24 23:39:50 +0100 | [diff] [blame] | 108 | template MgcpResponse ts_CRCX_ACK(MgcpTransId trans_id, MgcpConnectionId conn_id, template SDP_Message sdp := omit) := { |
| 109 | line := { |
| 110 | code := "200", |
| 111 | trans_id := trans_id, |
| 112 | string := "OK" |
| 113 | }, |
| 114 | params:= { ts_MgcpParConnectionId(conn_id) }, |
| 115 | sdp := sdp |
| 116 | } |
| 117 | |
Harald Welte | 4029e8c | 2017-11-23 22:00:42 +0100 | [diff] [blame] | 118 | template MgcpCommand ts_MDCX(MgcpTransId trans_id, charstring ep, MgcpConnectionMode mode, MgcpCallId call_id, MgcpConnectionId conn_id, template SDP_Message sdp := omit) := { |
| 119 | line := t_MgcpCmdLine("MDCX", trans_id, ep), |
| 120 | params := { |
| 121 | t_MgcpParConnMode(mode), |
| 122 | ts_MgcpParCallId(call_id), |
| 123 | ts_MgcpParConnectionId(conn_id), |
| 124 | //t_MgcpParReqId(omit), |
Daniel Willmann | fbef714 | 2017-11-30 13:16:14 +0100 | [diff] [blame] | 125 | t_MgcpParLocConnOpt("p:20, a:AMR") |
Harald Welte | 4029e8c | 2017-11-23 22:00:42 +0100 | [diff] [blame] | 126 | }, |
| 127 | sdp := sdp |
| 128 | } |
| 129 | |
Harald Welte | 9002957 | 2017-11-24 23:39:50 +0100 | [diff] [blame] | 130 | template MgcpCommand tr_MDCX := { |
| 131 | line := t_MgcpCmdLine("MDCX", ?, ?), |
| 132 | params := *, |
| 133 | sdp := * |
| 134 | } |
| 135 | |
Harald Welte | bb7523b | 2018-03-29 08:52:01 +0200 | [diff] [blame] | 136 | template MgcpResponse tr_MDCX_ACK := { |
| 137 | line := { |
| 138 | code := "200", |
| 139 | trans_id := ?, |
| 140 | string := "OK" |
| 141 | }, |
| 142 | params := *, |
| 143 | sdp := ? |
| 144 | } |
| 145 | |
Harald Welte | 9002957 | 2017-11-24 23:39:50 +0100 | [diff] [blame] | 146 | template MgcpResponse ts_MDCX_ACK(MgcpTransId trans_id, MgcpConnectionId conn_id, template SDP_Message sdp := omit) := ts_CRCX_ACK(trans_id, conn_id, sdp); |
| 147 | |
Harald Welte | 4029e8c | 2017-11-23 22:00:42 +0100 | [diff] [blame] | 148 | /* have a function that generates a template, rather than a template in order to handle |
| 149 | * optional parameters */ |
| 150 | function ts_DLCX(MgcpTransId trans_id, charstring ep, template MgcpCallId call_id := omit, |
| 151 | template MgcpConnectionId conn_id := omit) return template MgcpCommand { |
| 152 | var template MgcpCommand cmd; |
| 153 | cmd.line := t_MgcpCmdLine("DLCX", trans_id, ep); |
| 154 | cmd.params := {}; |
| 155 | cmd.sdp := omit; |
| 156 | if (isvalue(call_id)) { |
| 157 | f_mgcp_par_append(cmd.params, ts_MgcpParCallId(valueof(call_id))); |
| 158 | if (isvalue(conn_id)) { |
| 159 | f_mgcp_par_append(cmd.params, ts_MgcpParConnectionId(valueof(conn_id))); |
| 160 | } |
| 161 | } |
| 162 | return cmd; |
| 163 | } |
| 164 | |
Harald Welte | b71901a | 2018-01-26 19:16:05 +0100 | [diff] [blame] | 165 | template MgcpCommand tr_DLCX(template MgcpEndpoint ep := ?) := { |
| 166 | line := t_MgcpCmdLine("DLCX", ?, ep), |
Harald Welte | 9002957 | 2017-11-24 23:39:50 +0100 | [diff] [blame] | 167 | params := *, |
| 168 | sdp := * |
| 169 | } |
| 170 | |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 171 | template MgcpResponse tr_DLCX_ACK := { |
| 172 | line := { |
Daniel Willmann | 961e5c9 | 2017-11-30 16:37:40 +0100 | [diff] [blame] | 173 | code := ("200", "250"), |
Harald Welte | c82eef4 | 2017-11-24 20:40:12 +0100 | [diff] [blame] | 174 | trans_id := ?, |
| 175 | string := "OK" |
| 176 | }, |
| 177 | params:= *, |
| 178 | sdp := * |
| 179 | } |
| 180 | |
Harald Welte | b71901a | 2018-01-26 19:16:05 +0100 | [diff] [blame] | 181 | template MgcpResponse ts_DLCX_ACK2(MgcpTransId trans_id) := { |
| 182 | line := { |
| 183 | code := "250", |
| 184 | trans_id := trans_id, |
| 185 | string := "OK" |
| 186 | }, |
| 187 | params:= { /* list of ConnectionIDs */ }, |
| 188 | sdp := omit |
| 189 | } |
| 190 | |
| 191 | |
| 192 | |
Harald Welte | 9002957 | 2017-11-24 23:39:50 +0100 | [diff] [blame] | 193 | template MgcpResponse ts_DLCX_ACK(MgcpTransId trans_id, MgcpConnectionId conn_id, template SDP_Message sdp := omit) := ts_CRCX_ACK(trans_id, conn_id, sdp); |
| 194 | |
Harald Welte | e98bb2e | 2017-11-29 12:09:48 +0100 | [diff] [blame] | 195 | template MgcpCommand tr_RSIP := { |
| 196 | line := t_MgcpCmdLine("RSIP", ?, ?), |
| 197 | params := *, |
| 198 | sdp := * |
| 199 | } |
| 200 | |
Harald Welte | 4029e8c | 2017-11-23 22:00:42 +0100 | [diff] [blame] | 201 | /* SDP Templates */ |
| 202 | template SDP_Origin ts_SDP_origin(charstring addr, charstring session_id, |
| 203 | charstring session_version := "1", |
| 204 | charstring addr_type := "IP4", |
| 205 | charstring user_name := "-") := { |
| 206 | user_name := user_name, |
| 207 | session_id := session_id, |
| 208 | session_version := session_version, |
| 209 | net_type := "IN", |
| 210 | addr_type := addr_type, |
| 211 | addr := addr |
| 212 | } |
| 213 | |
| 214 | template SDP_connection ts_SDP_connection_IP(charstring addr, charstring addr_type := "IP4", |
| 215 | template integer ttl := omit, |
| 216 | template integer num_of_addr := omit) :={ |
| 217 | net_type := "IN", |
| 218 | addr_type := addr_type, |
| 219 | conn_addr := { |
| 220 | addr := addr, |
| 221 | ttl := ttl, |
| 222 | num_of_addr := num_of_addr |
| 223 | } |
| 224 | } |
| 225 | |
| 226 | template SDP_time ts_SDP_time(charstring beg, charstring end) := { |
| 227 | time_field := { |
| 228 | start_time := beg, |
| 229 | stop_time := end |
| 230 | }, |
| 231 | time_repeat := omit |
| 232 | } |
| 233 | |
| 234 | template SDP_media_desc ts_SDP_media_desc(integer port_number, SDP_fmt_list fmts, |
| 235 | SDP_attribute_list attributes) := { |
| 236 | media_field := { |
| 237 | media := "audio", |
| 238 | ports := { |
| 239 | port_number := port_number, |
| 240 | num_of_ports := omit |
| 241 | }, |
| 242 | transport := "RTP/AVP", |
| 243 | fmts := fmts |
| 244 | }, |
| 245 | information := omit, |
| 246 | connections := omit, |
| 247 | bandwidth := omit, |
| 248 | key := omit, |
| 249 | attributes := attributes |
| 250 | } |
| 251 | |
| 252 | /* master template for generating SDP based in template arguments */ |
| 253 | template SDP_Message ts_SDP(charstring local_addr, charstring remote_addr, |
| 254 | charstring session_id, charstring session_version, |
| 255 | integer rtp_port, SDP_fmt_list fmts, |
| 256 | SDP_attribute_list attributes) := { |
| 257 | protocol_version := 0, |
| 258 | origin := ts_SDP_origin(local_addr, session_id, session_version), |
| 259 | session_name := "-", |
| 260 | information := omit, |
| 261 | uri := omit, |
| 262 | emails := omit, |
| 263 | phone_numbers := omit, |
| 264 | connection := ts_SDP_connection_IP(remote_addr), |
| 265 | bandwidth := omit, |
| 266 | times := { ts_SDP_time("0","0") }, |
| 267 | timezone_adjustments := omit, |
| 268 | key := omit, |
| 269 | attributes := omit, |
| 270 | media_list := { ts_SDP_media_desc(rtp_port, fmts, attributes) } |
| 271 | } |
| 272 | |
| 273 | template SDP_attribute ts_SDP_rtpmap(integer fmt, charstring val) := { |
| 274 | rtpmap := { |
| 275 | attr_value := int2str(fmt) & " " & val |
| 276 | } |
| 277 | } |
| 278 | template SDP_attribute ts_SDP_ptime(integer p) := { |
| 279 | ptime := { |
| 280 | attr_value := int2str(p) |
| 281 | } |
| 282 | } |
Philipp Maier | c8c0b40 | 2019-03-07 10:48:45 +0100 | [diff] [blame] | 283 | template SDP_attribute ts_SDP_fmtp(integer fmt, charstring val) := { |
| 284 | fmtp := { |
| 285 | attr_value := int2str(fmt) & " " & val |
| 286 | } |
| 287 | } |
Harald Welte | 4029e8c | 2017-11-23 22:00:42 +0100 | [diff] [blame] | 288 | |
Neels Hofmeyr | 2ca1ab4 | 2019-03-08 03:45:43 +0100 | [diff] [blame^] | 289 | function f_mgcp_contains_par(MgcpMessage msg, MgcpInfoCode code) return boolean { |
| 290 | var MgcpParameterList pars; |
| 291 | if (ischosen(msg.command)) { |
| 292 | pars := msg.command.params; |
| 293 | } else { |
| 294 | pars := msg.response.params; |
| 295 | } |
| 296 | for (var integer i := 0; i < lengthof(pars); i := i + 1) { |
| 297 | var MgcpParameter par := pars[i]; |
| 298 | if (par.code == code) { |
| 299 | return true; |
| 300 | } |
| 301 | } |
| 302 | return false; |
| 303 | } |
| 304 | |
Harald Welte | b71901a | 2018-01-26 19:16:05 +0100 | [diff] [blame] | 305 | function f_mgcp_extract_par(MgcpMessage msg, MgcpInfoCode code) return charstring { |
| 306 | var MgcpParameterList pars; |
| 307 | if (ischosen(msg.command)) { |
| 308 | pars := msg.command.params; |
| 309 | } else { |
| 310 | pars := msg.response.params; |
| 311 | } |
| 312 | for (var integer i := 0; i < lengthof(pars); i := i + 1) { |
| 313 | var MgcpParameter par := pars[i]; |
| 314 | if (par.code == code) { |
| 315 | return par.val; |
Harald Welte | 4c11d56 | 2017-11-24 23:39:00 +0100 | [diff] [blame] | 316 | } |
| 317 | } |
Daniel Willmann | e4ff537 | 2018-07-05 17:35:03 +0200 | [diff] [blame] | 318 | setverdict(fail, "Could not extract parameters for code ", code); |
Harald Welte | b71901a | 2018-01-26 19:16:05 +0100 | [diff] [blame] | 319 | return ""; |
| 320 | } |
| 321 | |
Harald Welte | 1fe7481 | 2018-01-29 21:57:26 +0100 | [diff] [blame] | 322 | function f_MgcpResp_extract_par(MgcpResponse resp, MgcpInfoCode code) return charstring { |
Harald Welte | b71901a | 2018-01-26 19:16:05 +0100 | [diff] [blame] | 323 | var MgcpMessage msg := { |
| 324 | response := resp |
| 325 | } |
Harald Welte | 1fe7481 | 2018-01-29 21:57:26 +0100 | [diff] [blame] | 326 | return f_mgcp_extract_par(msg, code); |
Harald Welte | b71901a | 2018-01-26 19:16:05 +0100 | [diff] [blame] | 327 | } |
| 328 | |
Harald Welte | 1fe7481 | 2018-01-29 21:57:26 +0100 | [diff] [blame] | 329 | function f_MgcpCmd_extract_par(MgcpCommand cmd, MgcpInfoCode code) return charstring { |
Harald Welte | b71901a | 2018-01-26 19:16:05 +0100 | [diff] [blame] | 330 | var MgcpMessage msg := { |
| 331 | command := cmd |
| 332 | } |
Harald Welte | 1fe7481 | 2018-01-29 21:57:26 +0100 | [diff] [blame] | 333 | return f_mgcp_extract_par(msg, code); |
Harald Welte | 4c11d56 | 2017-11-24 23:39:00 +0100 | [diff] [blame] | 334 | } |
| 335 | |
Neels Hofmeyr | 2ca1ab4 | 2019-03-08 03:45:43 +0100 | [diff] [blame^] | 336 | function f_MgcpCmd_contains_par(MgcpCommand cmd, MgcpInfoCode code) return boolean { |
| 337 | var MgcpMessage msg := { |
| 338 | command := cmd |
| 339 | } |
| 340 | return f_mgcp_contains_par(msg, code); |
| 341 | } |
| 342 | |
Harald Welte | 1fe7481 | 2018-01-29 21:57:26 +0100 | [diff] [blame] | 343 | function f_MgcpResp_extract_conn_id(MgcpResponse resp) return MgcpConnectionId { |
| 344 | return str2hex(f_MgcpResp_extract_par(resp, "I")); |
| 345 | } |
| 346 | |
| 347 | function f_MgcpCmd_extract_call_id(MgcpCommand cmd) return MgcpCallId { |
| 348 | return str2hex(f_MgcpCmd_extract_par(cmd, "C")); |
| 349 | } |
| 350 | |
| 351 | function f_MgcpCmd_extract_conn_id(MgcpCommand cmd) return MgcpConnectionId { |
| 352 | return str2hex(f_MgcpCmd_extract_par(cmd, "I")); |
| 353 | } |
| 354 | |
| 355 | |
Harald Welte | 4c11d56 | 2017-11-24 23:39:00 +0100 | [diff] [blame] | 356 | function f_mgcp_alloc_tid() return MgcpTransId { |
| 357 | return int2str(float2int(rnd()*2147483647.0)); |
| 358 | } |
| 359 | |
| 360 | function f_mgcp_alloc_call_id() return MgcpCallId { |
| 361 | return int2hex(float2int(rnd()*2147483647.0), 8); |
| 362 | } |
| 363 | |
| 364 | function f_mgcp_alloc_conn_id() return MgcpConnectionId { |
| 365 | return int2hex(float2int(rnd()*2147483647.0), 8); |
| 366 | } |
| 367 | |
Harald Welte | bb5a121 | 2018-01-26 10:34:44 +0100 | [diff] [blame] | 368 | /* those verbs that related to a connection (and hence have ConnectionId) */ |
| 369 | template MgcpVerb tr_MgcpVerb_ConnectionOriented := ("CRCX", "MDCX", "DLCX", "AUCX"); |
| 370 | /* entire command template matching only connection oriented verbs */ |
| 371 | template MgcpCommand tr_MgcpCommand_CO := { |
| 372 | line := { |
| 373 | verb := tr_MgcpVerb_ConnectionOriented, |
| 374 | trans_id := ?, |
| 375 | ep := ?, |
| 376 | ver := ? |
| 377 | }, |
| 378 | params := *, |
| 379 | sdp := * |
| 380 | } |
| 381 | |
Harald Welte | 363cb0a | 2018-01-30 19:35:53 +0100 | [diff] [blame] | 382 | function f_mgcp_find_param(MgcpMessage msg, MgcpInfoCode code, out charstring ret) |
| 383 | return boolean { |
| 384 | var MgcpParameterList pars; |
| 385 | if (ischosen(msg.command)) { |
| 386 | pars := msg.command.params; |
| 387 | } else { |
| 388 | pars := msg.response.params; |
| 389 | } |
| 390 | for (var integer i := 0; i < sizeof(pars); i := i+1) { |
| 391 | if (pars[i].code == code) { |
| 392 | ret := pars[i].val; |
| 393 | return true; |
| 394 | } |
| 395 | } |
| 396 | return false; |
| 397 | } |
| 398 | |
| 399 | /* template to determine if a MGCP endpoint is a wildcard endpoint */ |
| 400 | template charstring t_MGCP_EP_wildcard := (pattern "\*@*", pattern "rtpbridge/\*@*"); |
| 401 | |
Harald Welte | b71901a | 2018-01-26 19:16:05 +0100 | [diff] [blame] | 402 | |
Harald Welte | 4029e8c | 2017-11-23 22:00:42 +0100 | [diff] [blame] | 403 | } |