1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
|
/**
* @file ctrl_tcp.c TCP control interface using JSON payload
*
* Copyright (C) 2018 46 Labs LLC
*/
#include <re.h>
#include <baresip.h>
#include "tcp_netstring.h"
/**
* @defgroup ctrl_tcp ctrl_tcp
*
* Communication channel to control and monitor Baresip via JSON messages.
*
* It receives commands to be executed, sends back command responses and
* notifies about events.
*
* Command message parameters:
*
* - command : Command to be executed.
* - params : Command parameters.
* - token : Optional. Included in the response if present.
*
* Command message example:
*
\verbatim
{
"command" : "dial",
"params" : "sip:alice@atlanta.com",
"token" : "qwerasdf"
}
\endverbatim
*
*
* Response message parameters:
*
* - response : true. Identifies the message type.
* - ok: : true/false. Indicates whether the command execution succeeded.
* - data : Baresip response to the related command execution.
* - token : Present if it was included in the related command request.
*
* Response message example:
*
\verbatim
{
"response" : true,
"ok" : true,
"data" : "",
"token" : "qwerasdf"
}
\endverbatim
*
*
* Event message parameters:
*
* - event : true. Identifies the message type.
* - class : Event class.
* - type : Event ID.
* - param : Specific event information.
*
* Apart from the above, events may contain aditional parameters.
*
* Event message example:
*
\verbatim
{
"event" : "true",
"class" : "call",
"type" : "CALL_CLOSED",
"param" : "Connection reset by peer",
"accountaor" : "sip:alice@atlanta.com",
"direction" : "incoming",
"peeruri" : "sip:bob@biloxy.com",
"id" : "73a12546589651f8"
}
\endverbatim
*
*
* Sample config:
*
\verbatim
ctrl_tcp_listen 0.0.0.0:4444 # IP-address and port to listen on
\endverbatim
*/
enum {CTRL_PORT = 4444};
struct ctrl_st {
struct tcp_sock *ts;
struct tcp_conn *tc;
struct netstring *ns;
};
static struct ctrl_st *ctrl = NULL; /* allow only one instance */
static int print_handler(const char *p, size_t size, void *arg)
{
struct mbuf *mb = arg;
return mbuf_write_mem(mb, (uint8_t *)p, size);
}
static int encode_response(int cmd_error, struct mbuf *resp, const char *token)
{
struct re_printf pf = {print_handler, resp};
struct odict *od = NULL;
char *buf = NULL;
char m[256];
int err;
/* Empty response. */
if (resp->pos == NETSTRING_HEADER_SIZE)
{
buf = mem_alloc(1, NULL);
buf[0] = '\0';
}
else
{
resp->pos = NETSTRING_HEADER_SIZE;
err = mbuf_strdup(resp, &buf,
resp->end - NETSTRING_HEADER_SIZE);
if (err)
return err;
}
err = odict_alloc(&od, 8);
if (err)
return err;
err |= odict_entry_add(od, "response", ODICT_BOOL, true);
err |= odict_entry_add(od, "ok", ODICT_BOOL, (bool)!cmd_error);
if (cmd_error && str_len(buf) == 0)
err |= odict_entry_add(od, "data", ODICT_STRING,
str_error(cmd_error, m, sizeof(m)));
else
err |= odict_entry_add(od, "data", ODICT_STRING, buf);
if (token)
err |= odict_entry_add(od, "token", ODICT_STRING, token);
if (err)
goto out;
mbuf_reset(resp);
mbuf_init(resp);
resp->pos = NETSTRING_HEADER_SIZE;
err = json_encode_odict(&pf, od);
if (err)
warning("ctrl_tcp: failed to encode response JSON (%m)\n",
err);
out:
mem_deref(buf);
mem_deref(od);
return err;
}
static bool command_handler(struct mbuf *mb, void *arg)
{
struct ctrl_st *st = arg;
struct mbuf *resp = mbuf_alloc(2048);
struct re_printf pf = {print_handler, resp};
struct odict *od = NULL;
const struct odict_entry *oe_cmd, *oe_prm, *oe_tok;
char buf[1024];
int err;
err = json_decode_odict(&od, 32, (const char*)mb->buf, mb->end, 16);
if (err) {
warning("ctrl_tcp: failed to decode JSON (%m)\n", err);
goto out;
}
oe_cmd = odict_lookup(od, "command");
oe_prm = odict_lookup(od, "params");
oe_tok = odict_lookup(od, "token");
if (!oe_cmd) {
warning("ctrl_tcp: missing json entries\n");
goto out;
}
debug("ctrl_tcp: handle_command: cmd='%s', params:'%s', token='%s'\n",
oe_cmd ? oe_cmd->u.str : "",
oe_prm ? oe_prm->u.str : "",
oe_tok ? oe_tok->u.str : "");
re_snprintf(buf, sizeof(buf), "%s%s%s",
oe_cmd->u.str,
oe_prm ? " " : "",
oe_prm ? oe_prm->u.str : "");
resp->pos = NETSTRING_HEADER_SIZE;
/* Relay message to long commands */
err = cmd_process_long(baresip_commands(),
buf,
str_len(buf),
&pf, NULL);
if (err) {
warning("ctrl_tcp: error processing command (%m)\n", err);
}
err = encode_response(err, resp, oe_tok ? oe_tok->u.str : NULL);
if (err) {
warning("ctrl_tcp: failed to encode response (%m)\n", err);
goto out;
}
resp->pos = NETSTRING_HEADER_SIZE;
err = tcp_send(st->tc, resp);
if (err) {
warning("ctrl_tcp: failed to send the message (%m)\n", err);
}
out:
mem_deref(resp);
mem_deref(od);
return true; /* always handled */
}
static void tcp_close_handler(int err, void *arg)
{
struct ctrl_st *st = arg;
(void)err;
st->tc = mem_deref(st->tc);
}
static void tcp_conn_handler(const struct sa *peer, void *arg)
{
struct ctrl_st *st = arg;
(void)peer;
/* only one connection allowed */
st->tc = mem_deref(st->tc);
st->ns = mem_deref(st->ns);
(void)tcp_accept(&st->tc, st->ts, NULL, NULL, tcp_close_handler, st);
(void)netstring_insert(&st->ns, st->tc, 0, command_handler, st);
}
/*
* Relay UA events
*/
static void ua_event_handler(struct ua *ua, enum ua_event ev,
struct call *call, const char *prm, void *arg)
{
struct ctrl_st *st = arg;
struct mbuf *buf = mbuf_alloc(1024);
struct re_printf pf = {print_handler, buf};
struct odict *od = NULL;
int err;
buf->pos = NETSTRING_HEADER_SIZE;
err = odict_alloc(&od, 8);
if (err)
return;
err = odict_entry_add(od, "event", ODICT_BOOL, true);
err |= event_encode_dict(od, ua, ev, call, prm);
if (err)
goto out;
err = json_encode_odict(&pf, od);
if (err) {
warning("ctrl_tcp: failed to encode json (%m)\n", err);
goto out;
}
if (st->tc) {
buf->pos = NETSTRING_HEADER_SIZE;
err = tcp_send(st->tc, buf);
if (err) {
warning("ctrl_tcp: failed to send the message (%m)\n",
err);
}
}
out:
mem_deref(buf);
mem_deref(od);
}
static void ctrl_destructor(void *arg)
{
struct ctrl_st *st = arg;
mem_deref(st->tc);
mem_deref(st->ts);
mem_deref(st->ns);
}
static int ctrl_alloc(struct ctrl_st **stp, const struct sa *laddr)
{
struct ctrl_st *st;
int err;
if (!stp)
return EINVAL;
st = mem_zalloc(sizeof(*st), ctrl_destructor);
if (!st)
return ENOMEM;
err = tcp_listen(&st->ts, laddr, tcp_conn_handler, st);
if (err) {
warning("ctrl_tcp: failed to listen on TCP %J (%m)\n",
laddr, err);
goto out;
}
debug("ctrl_tcp: TCP socket listening on %J\n", laddr);
out:
if (err)
mem_deref(st);
else
*stp = st;
return err;
}
static int ctrl_init(void)
{
struct sa laddr;
int err;
if (conf_get_sa(conf_cur(), "ctrl_tcp_listen", &laddr)) {
sa_set_str(&laddr, "0.0.0.0", CTRL_PORT);
}
err = ctrl_alloc(&ctrl, &laddr);
if (err)
return err;
err = uag_event_register(ua_event_handler, ctrl);
if (err)
return err;
return 0;
}
static int ctrl_close(void)
{
uag_event_unregister(ua_event_handler);
ctrl = mem_deref(ctrl);
return 0;
}
const struct mod_export DECL_EXPORTS(ctrl_tcp) = {
"ctrl_tcp",
"application",
ctrl_init,
ctrl_close
};
|