Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 1 | /* Asterisk's AMI interface functions in TTCN-3 |
| 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 | */ |
| 11 | |
| 12 | /* |
| 13 | * https://docs.asterisk.org/Configuration/Interfaces/Asterisk-Manager-Interface-AMI/AMI-v2-Specification/ |
| 14 | */ |
| 15 | module AMI_Functions { |
| 16 | |
| 17 | import from Misc_Helpers all; |
| 18 | import from TELNETasp_PortType all; |
| 19 | import from Osmocom_Types all; |
| 20 | import from TCCConversion_Functions all; |
| 21 | import from Socket_API_Definitions all; |
| 22 | |
| 23 | modulepar { |
| 24 | float mp_ami_prompt_timeout := 10.0; |
| 25 | } |
| 26 | |
| 27 | const charstring AMI_FIELD_ACTION := "Action"; |
Pau Espin Pedrol | 4362dbd | 2024-04-26 19:31:27 +0200 | [diff] [blame] | 28 | const charstring AMI_FIELD_ACTION_ID := "ActionId"; |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 29 | const charstring AMI_FIELD_USERNAME := "Username"; |
| 30 | const charstring AMI_FIELD_SECRET := "Secret"; |
| 31 | const charstring AMI_FIELD_RESPONSE := "Response"; |
| 32 | |
Pau Espin Pedrol | 4362dbd | 2024-04-26 19:31:27 +0200 | [diff] [blame] | 33 | /* Extensions: */ |
| 34 | const charstring AMI_FIELD_REGISTRATION := "Registration"; |
| 35 | |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 36 | type record AMI_Field { |
| 37 | charstring key, |
| 38 | charstring val |
Pau Espin Pedrol | de7a485 | 2024-04-19 16:20:45 +0200 | [diff] [blame] | 39 | } with { |
| 40 | encode "TEXT" |
| 41 | variant "SEPARATOR(': ', ':\s+')" |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 42 | }; |
Pau Espin Pedrol | de7a485 | 2024-04-19 16:20:45 +0200 | [diff] [blame] | 43 | |
| 44 | type set of AMI_Field AMI_Msg with { |
| 45 | encode "TEXT" |
| 46 | variant "SEPARATOR('\r\n', '(\r\n)|[\n]')" |
| 47 | variant "END('\r\n', '(\r\n)|[\n]')" |
| 48 | }; |
| 49 | |
| 50 | external function enc_AMI_Msg(in AMI_Msg msg) return charstring |
| 51 | with { extension "prototype(convert) encode(TEXT)" } |
| 52 | external function dec_AMI_Msg(in charstring stream) return AMI_Msg |
| 53 | with { extension "prototype(convert) decode(TEXT)" } |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 54 | |
| 55 | template (value) AMI_Field |
| 56 | ts_AMI_Field(template (value) charstring key, |
| 57 | template (value) charstring val) := { |
| 58 | key := key, |
| 59 | val := val |
| 60 | }; |
| 61 | |
| 62 | template (present) AMI_Field |
| 63 | tr_AMI_Field(template (present) charstring key := ?, |
| 64 | template (present) charstring val := ?) := { |
| 65 | key := key, |
| 66 | val := val |
| 67 | }; |
| 68 | |
| 69 | /* |
| 70 | * Field Templates: |
| 71 | */ |
| 72 | |
| 73 | template (value) AMI_Field |
| 74 | ts_AMI_Field_Action(template (value) charstring val) := ts_AMI_Field(AMI_FIELD_ACTION, val); |
| 75 | template (value) AMI_Field |
Pau Espin Pedrol | 4362dbd | 2024-04-26 19:31:27 +0200 | [diff] [blame] | 76 | ts_AMI_Field_ActionId(template (value) charstring val) := ts_AMI_Field(AMI_FIELD_ACTION_ID, val); |
| 77 | template (value) AMI_Field |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 78 | ts_AMI_Field_Username(template (value) charstring val) := ts_AMI_Field(AMI_FIELD_USERNAME, val); |
| 79 | template (value) AMI_Field |
| 80 | ts_AMI_Field_Secret(template (value) charstring val) := ts_AMI_Field(AMI_FIELD_SECRET, val); |
Pau Espin Pedrol | 4362dbd | 2024-04-26 19:31:27 +0200 | [diff] [blame] | 81 | /* Extensions: */ |
| 82 | template (value) AMI_Field |
| 83 | ts_AMI_Field_Registration(template (value) charstring val) := ts_AMI_Field(AMI_FIELD_REGISTRATION, val); |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 84 | |
| 85 | template (present) AMI_Field |
| 86 | tr_AMI_Field_Action(template (present) charstring val := ?) := tr_AMI_Field(AMI_FIELD_ACTION, val); |
| 87 | template (present) AMI_Field |
Pau Espin Pedrol | 4362dbd | 2024-04-26 19:31:27 +0200 | [diff] [blame] | 88 | tr_AMI_Field_ActionId(template (present) charstring val := ?) := tr_AMI_Field(AMI_FIELD_ACTION_ID, val); |
| 89 | template (present) AMI_Field |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 90 | tr_AMI_Field_Username(template (present) charstring val := ?) := tr_AMI_Field(AMI_FIELD_USERNAME, val); |
| 91 | template (present) AMI_Field |
| 92 | tr_AMI_Field_Secret(template (present) charstring val := ?) := tr_AMI_Field(AMI_FIELD_SECRET, val); |
| 93 | template (present) AMI_Field |
| 94 | tr_AMI_Field_Response(template (present) charstring val := ?) := tr_AMI_Field(AMI_FIELD_RESPONSE, val); |
Pau Espin Pedrol | 4362dbd | 2024-04-26 19:31:27 +0200 | [diff] [blame] | 95 | /* Extensions: */ |
| 96 | template (present) AMI_Field |
| 97 | tr_AMI_Field_Registration(template (present) charstring val := ?) := tr_AMI_Field(AMI_FIELD_REGISTRATION, val); |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 98 | |
| 99 | |
| 100 | template (present) AMI_Field |
| 101 | tr_AMI_Field_ResponseSuccess := tr_AMI_Field(AMI_FIELD_RESPONSE, "Success"); |
| 102 | |
| 103 | |
Pau Espin Pedrol | 4362dbd | 2024-04-26 19:31:27 +0200 | [diff] [blame] | 104 | /*********************** |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 105 | * Message Templates: |
Pau Espin Pedrol | 4362dbd | 2024-04-26 19:31:27 +0200 | [diff] [blame] | 106 | ***********************/ |
| 107 | |
| 108 | /* |
| 109 | * ACTIONS |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 110 | */ |
| 111 | |
Pau Espin Pedrol | 4362dbd | 2024-04-26 19:31:27 +0200 | [diff] [blame] | 112 | /* Action: Login |
| 113 | * Username: <value> |
| 114 | * Secret: <value> |
| 115 | */ |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 116 | template (value) AMI_Msg |
| 117 | ts_AMI_Action_Login(charstring username, charstring secret) := { |
| 118 | ts_AMI_Field_Action("Login"), |
| 119 | ts_AMI_Field_Username(username), |
| 120 | ts_AMI_Field_Secret(secret) |
| 121 | }; |
| 122 | |
| 123 | template (present) AMI_Msg |
| 124 | tr_AMI_Action_Login(template(present) charstring username := ?, |
| 125 | template(present) charstring secret := ?) := superset( |
| 126 | tr_AMI_Field_Action("Login"), |
| 127 | tr_AMI_Field_Username(username), |
| 128 | tr_AMI_Field_Secret(secret) |
| 129 | ); |
| 130 | |
Pau Espin Pedrol | 4362dbd | 2024-04-26 19:31:27 +0200 | [diff] [blame] | 131 | /* Action: PJSIPRegister |
| 132 | * ActionID: <value> |
| 133 | * Registration: volte_ims |
| 134 | */ |
| 135 | template (value) AMI_Msg |
| 136 | ts_AMI_Action_PJSIPRegister(template (value) charstring registration := "volte_ims", |
| 137 | template (value) charstring action_id := "0001") := { |
| 138 | ts_AMI_Field_Action("PJSIPRegister"), |
| 139 | ts_AMI_Field_ActionId(action_id), |
| 140 | ts_AMI_Field_Registration(registration) |
| 141 | }; |
| 142 | template (present) AMI_Msg |
| 143 | tr_AMI_Action_PJSIPRegister(template (present) charstring registration := ?, |
| 144 | template (present) charstring action_id := ?) := { |
| 145 | tr_AMI_Field_Action("PJSIPRegister"), |
| 146 | tr_AMI_Field_ActionId(action_id), |
| 147 | tr_AMI_Field_Registration(registration) |
| 148 | }; |
| 149 | |
| 150 | /* |
| 151 | * RESPONSES |
| 152 | */ |
| 153 | |
| 154 | /* Response: Success |
| 155 | */ |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 156 | template (present) AMI_Msg |
| 157 | tr_AMI_Response_Success := superset( |
| 158 | tr_AMI_Field_ResponseSuccess |
| 159 | ); |
| 160 | |
Pau Espin Pedrol | 4362dbd | 2024-04-26 19:31:27 +0200 | [diff] [blame] | 161 | /* Response: Success |
| 162 | * ActionId: <value> |
| 163 | */ |
| 164 | template (present) AMI_Msg |
| 165 | tr_AMI_Response_Success_ActionId(template (present) charstring action_id := ?) := superset( |
| 166 | tr_AMI_Field_ResponseSuccess, |
| 167 | tr_AMI_Field_ActionId(action_id) |
| 168 | ); |
| 169 | |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame^] | 170 | |
| 171 | /*********************** |
| 172 | * Adapter: |
| 173 | ***********************/ |
| 174 | |
| 175 | type port AMI_Msg_PT message { |
| 176 | inout AMI_Msg; |
| 177 | } with { extension "internal" }; |
| 178 | |
| 179 | type component AMI_Adapter_CT { |
| 180 | port TELNETasp_PT AMI; |
| 181 | port AMI_Msg_PT CLIENT; |
| 182 | } |
| 183 | |
| 184 | function f_AMI_Adapter_main() runs on AMI_Adapter_CT { |
| 185 | var AMI_Msg msg; |
| 186 | |
| 187 | var charstring rx, buf := ""; |
| 188 | var integer fd; |
| 189 | |
| 190 | map(self:AMI, system:AMI); |
| 191 | |
| 192 | while (true) { |
| 193 | |
| 194 | alt { |
| 195 | [] AMI.receive(pattern "\n") { |
| 196 | buf := buf & "\n"; |
| 197 | msg := dec_AMI_Msg(buf); |
| 198 | buf := ""; |
| 199 | CLIENT.send(msg); |
| 200 | }; |
| 201 | [] AMI.receive(charstring:?) -> value rx { |
| 202 | buf := buf & rx; |
| 203 | }; |
| 204 | [] AMI.receive(integer:?) -> value fd { |
| 205 | if (fd == -1) { |
| 206 | Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, |
| 207 | "AMI Telnet Connection Failure: " & int2str(fd)); |
| 208 | } else { |
| 209 | /* telnet connection succeeded */ |
| 210 | } |
| 211 | } |
| 212 | [] CLIENT.receive(AMI_Msg:?) -> value msg { |
| 213 | /* TODO: in the future, queue Action if there's already one Action in transit, to fullfill AMI requirements. */ |
| 214 | var charstring tx_txt := enc_AMI_Msg(msg); |
| 215 | AMI.send(tx_txt); |
| 216 | } |
| 217 | } |
| 218 | } |
| 219 | } |
| 220 | |
| 221 | |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 222 | /* |
| 223 | * Functions: |
| 224 | */ |
| 225 | |
Pau Espin Pedrol | 4362dbd | 2024-04-26 19:31:27 +0200 | [diff] [blame] | 226 | /* Generate a random "ActionId" value: */ |
| 227 | function f_gen_action_id() return charstring { |
| 228 | return hex2str(f_rnd_hexstring(16)); |
| 229 | } |
| 230 | |
| 231 | function f_ami_msg_find(AMI_Msg msg, |
| 232 | template (present) charstring key := ?) |
| 233 | return template (omit) AMI_Field { |
| 234 | var integer i; |
| 235 | |
| 236 | for (i := 0; i < lengthof(msg); i := i + 1) { |
| 237 | if (not ispresent(msg[i])) { |
| 238 | continue; |
| 239 | } |
| 240 | if (match(msg[i].key, key)) { |
| 241 | return msg[i]; |
| 242 | } |
| 243 | } |
| 244 | return omit; |
| 245 | } |
| 246 | |
| 247 | function f_ami_msg_find_or_fail(AMI_Msg msg, |
| 248 | template (present) charstring key := ?) |
| 249 | return AMI_Field { |
| 250 | var template (omit) AMI_Field field; |
| 251 | field := f_ami_msg_find(msg, key); |
| 252 | if (istemplatekind(field, "omit")) { |
| 253 | Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, |
| 254 | log2str("Key ", key, " not found in ", msg)); |
| 255 | } |
| 256 | return valueof(field); |
| 257 | } |
| 258 | |
| 259 | function f_ami_msg_get_value(AMI_Msg msg, |
| 260 | template (present) charstring key := ?) |
| 261 | return template (omit) charstring { |
| 262 | var template (omit) AMI_Field field; |
| 263 | field := f_ami_msg_find(msg, key); |
| 264 | if (istemplatekind(field, "omit")) { |
| 265 | return omit; |
| 266 | } |
| 267 | return field.val; |
| 268 | } |
| 269 | |
| 270 | function f_ami_msg_get_value_or_fail(AMI_Msg msg, |
| 271 | template (present) charstring key := ?) |
| 272 | return template charstring { |
| 273 | var AMI_Field field; |
| 274 | field := f_ami_msg_find_or_fail(msg, key); |
| 275 | return field.val; |
| 276 | } |
| 277 | |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame^] | 278 | function f_ami_transceive_ret(AMI_Msg_PT pt, template (value) AMI_Msg tx_msg, float rx_timeout := 10.0) return AMI_Msg { |
| 279 | var AMI_Msg rx_msg; |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 280 | timer T; |
| 281 | |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame^] | 282 | T.start(rx_timeout); |
| 283 | pt.send(tx_msg); |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 284 | alt { |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame^] | 285 | [] pt.receive(AMI_Msg:?) -> value rx_msg; |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 286 | [] T.timeout { |
| 287 | Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame^] | 288 | log2str("AMI Response timeout: ", tx_msg)); |
| 289 | } |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 290 | } |
| 291 | T.stop; |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame^] | 292 | return rx_msg; |
| 293 | |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 294 | } |
| 295 | |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame^] | 296 | private altstep as_ami_rx_fail(AMI_Msg_PT pt, template AMI_Msg exp_msg := *) |
| 297 | { |
| 298 | var AMI_Msg msg; |
| 299 | [] pt.receive(AMI_Msg:?) -> value msg { |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 300 | Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame^] | 301 | log2str("Received unexpected AMI message := ", msg, "\nvs exp := ", exp_msg)); |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 302 | } |
| 303 | } |
| 304 | |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame^] | 305 | altstep as_ami_expect_msg(AMI_Msg_PT pt, template (present) AMI_Msg msg_expect, boolean fail_others := true) |
| 306 | { |
| 307 | [] pt.receive(msg_expect); |
| 308 | [fail_others] as_ami_rx_fail(pt, msg_expect); |
| 309 | } |
| 310 | |
| 311 | function f_ami_transceive_match(AMI_Msg_PT pt, |
| 312 | template (value) AMI_Msg tx_msg, |
| 313 | template (present) AMI_Msg exp_ret := ?, |
| 314 | boolean fail_others := true, |
| 315 | float rx_timeout := 10.0) return AMI_Msg { |
| 316 | var AMI_Msg rx_msg; |
| 317 | timer T; |
| 318 | |
| 319 | T.start(rx_timeout); |
| 320 | pt.send(tx_msg); |
| 321 | alt { |
| 322 | [] pt.receive(exp_ret) -> value rx_msg; |
| 323 | [not fail_others] pt.receive(AMI_Msg:?) -> value rx_msg { |
| 324 | log("AMI: Ignoring Rx msg ", rx_msg); |
| 325 | repeat; |
| 326 | } |
| 327 | [fail_others] as_ami_rx_fail(pt, exp_ret); |
| 328 | [] T.timeout { |
| 329 | Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, |
| 330 | log2str("AMI Response timeout: ", tx_msg)); |
| 331 | } |
| 332 | } |
| 333 | T.stop; |
| 334 | return rx_msg; |
| 335 | } |
| 336 | |
| 337 | function f_ami_transceive_match_response_success(AMI_Msg_PT pt, |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 338 | template (value) AMI_Msg tx_msg) { |
Pau Espin Pedrol | 4362dbd | 2024-04-26 19:31:27 +0200 | [diff] [blame] | 339 | var template (present) AMI_Msg exp_resp; |
| 340 | var template (omit) charstring action_id := f_ami_msg_get_value(valueof(tx_msg), AMI_FIELD_ACTION_ID); |
| 341 | if (isvalue(action_id)) { |
| 342 | exp_resp := tr_AMI_Response_Success_ActionId(action_id); |
| 343 | } else { |
| 344 | exp_resp := tr_AMI_Response_Success; |
| 345 | } |
| 346 | f_ami_transceive_match(pt, tx_msg, exp_resp); |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 347 | } |
| 348 | |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame^] | 349 | function f_ami_action_login(AMI_Msg_PT pt, charstring username, charstring secret) { |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 350 | f_ami_transceive_match_response_success(pt, ts_AMI_Action_Login(username, secret)); |
| 351 | } |
| 352 | |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame^] | 353 | function f_ami_action_PJSIPRegister(AMI_Msg_PT pt, charstring register) { |
Pau Espin Pedrol | 4362dbd | 2024-04-26 19:31:27 +0200 | [diff] [blame] | 354 | var charstring reg_action_id := f_gen_action_id(); |
| 355 | f_ami_transceive_match_response_success(pt, ts_AMI_Action_PJSIPRegister(register, reg_action_id)); |
| 356 | } |
| 357 | |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 358 | } |