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 | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 170 | /* |
| 171 | * Functions: |
| 172 | */ |
| 173 | |
Pau Espin Pedrol | 4362dbd | 2024-04-26 19:31:27 +0200 | [diff] [blame^] | 174 | /* Generate a random "ActionId" value: */ |
| 175 | function f_gen_action_id() return charstring { |
| 176 | return hex2str(f_rnd_hexstring(16)); |
| 177 | } |
| 178 | |
| 179 | function f_ami_msg_find(AMI_Msg msg, |
| 180 | template (present) charstring key := ?) |
| 181 | return template (omit) AMI_Field { |
| 182 | var integer i; |
| 183 | |
| 184 | for (i := 0; i < lengthof(msg); i := i + 1) { |
| 185 | if (not ispresent(msg[i])) { |
| 186 | continue; |
| 187 | } |
| 188 | if (match(msg[i].key, key)) { |
| 189 | return msg[i]; |
| 190 | } |
| 191 | } |
| 192 | return omit; |
| 193 | } |
| 194 | |
| 195 | function f_ami_msg_find_or_fail(AMI_Msg msg, |
| 196 | template (present) charstring key := ?) |
| 197 | return AMI_Field { |
| 198 | var template (omit) AMI_Field field; |
| 199 | field := f_ami_msg_find(msg, key); |
| 200 | if (istemplatekind(field, "omit")) { |
| 201 | Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, |
| 202 | log2str("Key ", key, " not found in ", msg)); |
| 203 | } |
| 204 | return valueof(field); |
| 205 | } |
| 206 | |
| 207 | function f_ami_msg_get_value(AMI_Msg msg, |
| 208 | template (present) charstring key := ?) |
| 209 | return template (omit) charstring { |
| 210 | var template (omit) AMI_Field field; |
| 211 | field := f_ami_msg_find(msg, key); |
| 212 | if (istemplatekind(field, "omit")) { |
| 213 | return omit; |
| 214 | } |
| 215 | return field.val; |
| 216 | } |
| 217 | |
| 218 | function f_ami_msg_get_value_or_fail(AMI_Msg msg, |
| 219 | template (present) charstring key := ?) |
| 220 | return template charstring { |
| 221 | var AMI_Field field; |
| 222 | field := f_ami_msg_find_or_fail(msg, key); |
| 223 | return field.val; |
| 224 | } |
| 225 | |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 226 | private function f_ami_wait_for_prompt_str(TELNETasp_PT pt, charstring log_label := "(?)") |
| 227 | return charstring { |
| 228 | var charstring rx, buf := ""; |
| 229 | var integer fd; |
| 230 | timer T; |
| 231 | |
| 232 | T.start(mp_ami_prompt_timeout); |
| 233 | alt { |
Pau Espin Pedrol | de7a485 | 2024-04-19 16:20:45 +0200 | [diff] [blame] | 234 | [] pt.receive(pattern "\n") { buf := buf & "\n" }; |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 235 | [] pt.receive(charstring:?) -> value rx { buf := buf & rx; repeat }; |
| 236 | [] pt.receive(integer:?) -> value fd { |
| 237 | if (fd == -1) { |
| 238 | Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, |
| 239 | "AMI Telnet Connection Failure: " & log_label); |
| 240 | } else { |
| 241 | repeat; /* telnet connection succeeded */ |
| 242 | } |
| 243 | } |
| 244 | [] T.timeout { |
| 245 | Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, |
| 246 | "AMI Timeout for prompt: " & log_label); |
| 247 | }; |
| 248 | } |
| 249 | T.stop; |
| 250 | return buf; |
| 251 | } |
| 252 | |
| 253 | function f_ami_wait_for_prompt(TELNETasp_PT pt, charstring log_label := "(?)") return AMI_Msg { |
| 254 | var charstring buf := f_ami_wait_for_prompt_str(pt, log_label); |
Pau Espin Pedrol | de7a485 | 2024-04-19 16:20:45 +0200 | [diff] [blame] | 255 | var AMI_Msg msg := dec_AMI_Msg(buf); |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 256 | return msg; |
| 257 | } |
| 258 | |
| 259 | /* send a AMI command and obtain response until prompt is received */ |
| 260 | private function f_ami_transceive_ret_str(TELNETasp_PT pt, charstring tx) return charstring { |
| 261 | pt.send(tx); |
| 262 | return f_ami_wait_for_prompt_str(pt, tx); |
| 263 | } |
| 264 | |
| 265 | function f_ami_transceive_ret(TELNETasp_PT pt, template (value) AMI_Msg tx_msg) return AMI_Msg { |
Pau Espin Pedrol | de7a485 | 2024-04-19 16:20:45 +0200 | [diff] [blame] | 266 | var charstring tx_txt := enc_AMI_Msg(valueof(tx_msg)); |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 267 | var charstring resp_txt := f_ami_transceive_ret_str(pt, tx_txt); |
Pau Espin Pedrol | de7a485 | 2024-04-19 16:20:45 +0200 | [diff] [blame] | 268 | return dec_AMI_Msg(resp_txt); |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 269 | } |
| 270 | |
| 271 | function f_ami_transceive_match(TELNETasp_PT pt, |
| 272 | template (value) AMI_Msg tx_msg, |
| 273 | template (present) AMI_Msg exp_ret := ?) { |
| 274 | var AMI_Msg ret := f_ami_transceive_ret(pt, tx_msg); |
| 275 | if (not match(ret, exp_ret)) { |
| 276 | Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, |
| 277 | log2str("Non-matching AMI response: ", ret, " vs exp: ", exp_ret)); |
| 278 | } |
| 279 | } |
| 280 | |
| 281 | function f_ami_transceive_match_response_success(TELNETasp_PT pt, |
| 282 | template (value) AMI_Msg tx_msg) { |
Pau Espin Pedrol | 4362dbd | 2024-04-26 19:31:27 +0200 | [diff] [blame^] | 283 | var template (present) AMI_Msg exp_resp; |
| 284 | var template (omit) charstring action_id := f_ami_msg_get_value(valueof(tx_msg), AMI_FIELD_ACTION_ID); |
| 285 | if (isvalue(action_id)) { |
| 286 | exp_resp := tr_AMI_Response_Success_ActionId(action_id); |
| 287 | } else { |
| 288 | exp_resp := tr_AMI_Response_Success; |
| 289 | } |
| 290 | f_ami_transceive_match(pt, tx_msg, exp_resp); |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 291 | } |
| 292 | |
| 293 | function f_ami_action_login(TELNETasp_PT pt, charstring username, charstring secret) { |
| 294 | f_ami_transceive_match_response_success(pt, ts_AMI_Action_Login(username, secret)); |
| 295 | } |
| 296 | |
Pau Espin Pedrol | 4362dbd | 2024-04-26 19:31:27 +0200 | [diff] [blame^] | 297 | function f_ami_action_PJSIPRegister(TELNETasp_PT pt, charstring register) { |
| 298 | var charstring reg_action_id := f_gen_action_id(); |
| 299 | f_ami_transceive_match_response_success(pt, ts_AMI_Action_PJSIPRegister(register, reg_action_id)); |
| 300 | } |
| 301 | |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 302 | } |