4 * Created on: Jan 25, 2013
13 #include "asterisk/res_pjsip.h"
14 #include "include/res_pjsip_private.h"
15 #include "asterisk/res_pjsip_cli.h"
16 #include "asterisk/acl.h"
17 #include "asterisk/manager.h"
18 #include "asterisk/astobj2.h"
19 #include "asterisk/utils.h"
20 #include "asterisk/sorcery.h"
21 #include "asterisk/callerid.h"
23 /*! \brief Number of buckets for persistent endpoint information */
24 #define PERSISTENT_BUCKETS 53
26 /*! \brief Persistent endpoint information */
27 struct sip_persistent_endpoint {
28 /*! \brief Asterisk endpoint itself */
29 struct ast_endpoint *endpoint;
30 /*! \brief AORs that we should react to */
34 /*! \brief Container for persistent endpoint information */
35 static struct ao2_container *persistent_endpoints;
37 static struct ast_sorcery *sip_sorcery;
39 /*! \brief Hashing function for persistent endpoint information */
40 static int persistent_endpoint_hash(const void *obj, const int flags)
42 const struct sip_persistent_endpoint *persistent = obj;
43 const char *id = (flags & OBJ_KEY ? obj : ast_endpoint_get_resource(persistent->endpoint));
45 return ast_str_hash(id);
48 /*! \brief Comparison function for persistent endpoint information */
49 static int persistent_endpoint_cmp(void *obj, void *arg, int flags)
51 const struct sip_persistent_endpoint *persistent1 = obj;
52 const struct sip_persistent_endpoint *persistent2 = arg;
53 const char *id = (flags & OBJ_KEY ? arg : ast_endpoint_get_resource(persistent2->endpoint));
55 return !strcmp(ast_endpoint_get_resource(persistent1->endpoint), id) ? CMP_MATCH | CMP_STOP : 0;
58 /*! \brief Callback function for changing the state of an endpoint */
59 static int persistent_endpoint_update_state(void *obj, void *arg, int flags)
61 struct sip_persistent_endpoint *persistent = obj;
63 RAII_VAR(struct ast_sip_contact *, contact, NULL, ao2_cleanup);
64 RAII_VAR(struct ast_json *, blob, NULL, ast_json_unref);
66 if (!ast_strlen_zero(aor) && !strstr(persistent->aors, aor)) {
70 if ((contact = ast_sip_location_retrieve_contact_from_aor_list(persistent->aors))) {
71 ast_endpoint_set_state(persistent->endpoint, AST_ENDPOINT_ONLINE);
72 blob = ast_json_pack("{s: s}", "peer_status", "Reachable");
74 ast_endpoint_set_state(persistent->endpoint, AST_ENDPOINT_OFFLINE);
75 blob = ast_json_pack("{s: s}", "peer_status", "Unreachable");
78 ast_endpoint_blob_publish(persistent->endpoint, ast_endpoint_state_type(), blob);
80 ast_devstate_changed(AST_DEVICE_UNKNOWN, AST_DEVSTATE_CACHABLE, "PJSIP/%s", ast_endpoint_get_resource(persistent->endpoint));
85 /*! \brief Function called when stuff relating to a contact happens (created/deleted) */
86 static void persistent_endpoint_contact_observer(const void *object)
88 char *id = ast_strdupa(ast_sorcery_object_get_id(object)), *aor = NULL;
90 aor = strsep(&id, ";@");
92 ao2_callback(persistent_endpoints, OBJ_NODATA, persistent_endpoint_update_state, aor);
95 /*! \brief Observer for contacts so state can be updated on respective endpoints */
96 static const struct ast_sorcery_observer state_contact_observer = {
97 .created = persistent_endpoint_contact_observer,
98 .deleted = persistent_endpoint_contact_observer,
102 static int dtmf_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
104 struct ast_sip_endpoint *endpoint = obj;
106 if (!strcasecmp(var->value, "rfc4733")) {
107 endpoint->dtmf = AST_SIP_DTMF_RFC_4733;
108 } else if (!strcasecmp(var->value, "inband")) {
109 endpoint->dtmf = AST_SIP_DTMF_INBAND;
110 } else if (!strcasecmp(var->value, "info")) {
111 endpoint->dtmf = AST_SIP_DTMF_INFO;
112 } else if (!strcasecmp(var->value, "none")) {
113 endpoint->dtmf = AST_SIP_DTMF_NONE;
121 static int dtmf_to_str(const void *obj, const intptr_t *args, char **buf)
123 const struct ast_sip_endpoint *endpoint = obj;
125 switch (endpoint->dtmf) {
126 case AST_SIP_DTMF_RFC_4733 :
127 *buf = "rfc4733"; break;
128 case AST_SIP_DTMF_INBAND :
129 *buf = "inband"; break;
130 case AST_SIP_DTMF_INFO :
131 *buf = "info"; break;
136 *buf = ast_strdup(*buf);
140 static int prack_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
142 struct ast_sip_endpoint *endpoint = obj;
144 if (ast_true(var->value)) {
145 endpoint->extensions.flags |= PJSIP_INV_SUPPORT_100REL;
146 } else if (ast_false(var->value)) {
147 endpoint->extensions.flags &= PJSIP_INV_SUPPORT_100REL;
148 } else if (!strcasecmp(var->value, "required")) {
149 endpoint->extensions.flags |= PJSIP_INV_REQUIRE_100REL;
157 static int prack_to_str(const void *obj, const intptr_t *args, char **buf)
159 const struct ast_sip_endpoint *endpoint = obj;
161 if (endpoint->extensions.flags & PJSIP_INV_REQUIRE_100REL) {
163 } else if (endpoint->extensions.flags & PJSIP_INV_SUPPORT_100REL) {
169 *buf = ast_strdup(*buf);
173 static int timers_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
175 struct ast_sip_endpoint *endpoint = obj;
177 if (ast_true(var->value)) {
178 endpoint->extensions.flags |= PJSIP_INV_SUPPORT_TIMER;
179 } else if (ast_false(var->value)) {
180 endpoint->extensions.flags &= PJSIP_INV_SUPPORT_TIMER;
181 } else if (!strcasecmp(var->value, "required")) {
182 endpoint->extensions.flags |= PJSIP_INV_REQUIRE_TIMER;
183 } else if (!strcasecmp(var->value, "always")) {
184 endpoint->extensions.flags |= PJSIP_INV_ALWAYS_USE_TIMER;
192 static int timers_to_str(const void *obj, const intptr_t *args, char **buf)
194 const struct ast_sip_endpoint *endpoint = obj;
196 if (endpoint->extensions.flags & PJSIP_INV_ALWAYS_USE_TIMER) {
198 } else if (endpoint->extensions.flags & PJSIP_INV_REQUIRE_TIMER) {
200 } else if (endpoint->extensions.flags & PJSIP_INV_SUPPORT_TIMER) {
206 *buf = ast_strdup(*buf);
210 void ast_sip_auth_vector_destroy(struct ast_sip_auth_vector *auths)
219 size = AST_VECTOR_SIZE(auths);
221 for (i = 0; i < size; ++i) {
222 const char *name = AST_VECTOR_REMOVE_UNORDERED(auths, 0);
223 ast_free((char *) name);
225 AST_VECTOR_FREE(auths);
228 int ast_sip_auth_vector_init(struct ast_sip_auth_vector *auths, const char *value)
230 char *auth_names = ast_strdupa(value);
233 ast_assert(auths != NULL);
235 if (AST_VECTOR_SIZE(auths)) {
236 ast_sip_auth_vector_destroy(auths);
238 if (AST_VECTOR_INIT(auths, 1)) {
242 while ((val = strsep(&auth_names, ","))) {
243 val = ast_strdup(val);
247 if (AST_VECTOR_APPEND(auths, val)) {
254 ast_sip_auth_vector_destroy(auths);
258 static int inbound_auth_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
260 struct ast_sip_endpoint *endpoint = obj;
262 return ast_sip_auth_vector_init(&endpoint->inbound_auths, var->value);
265 static int outbound_auth_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
267 struct ast_sip_endpoint *endpoint = obj;
269 return ast_sip_auth_vector_init(&endpoint->outbound_auths, var->value);
272 int ast_sip_auths_to_str(const struct ast_sip_auth_vector *auths, char **buf)
274 if (!auths || !AST_VECTOR_SIZE(auths)) {
278 if (!(*buf = ast_calloc(MAX_OBJECT_FIELD, sizeof(char)))) {
282 /* I feel like accessing the vector's elem array directly is cheating...*/
283 ast_join_delim(*buf, MAX_OBJECT_FIELD, auths->elems, AST_VECTOR_SIZE(auths), ',');
287 static int inbound_auths_to_str(const void *obj, const intptr_t *args, char **buf)
289 const struct ast_sip_endpoint *endpoint = obj;
290 return ast_sip_auths_to_str(&endpoint->inbound_auths, buf);
293 static int outbound_auths_to_str(const void *obj, const intptr_t *args, char **buf)
295 const struct ast_sip_endpoint *endpoint = obj;
296 return ast_sip_auths_to_str(&endpoint->outbound_auths, buf);
299 static int ident_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
301 struct ast_sip_endpoint *endpoint = obj;
302 char *idents = ast_strdupa(var->value);
305 while ((val = strsep(&idents, ","))) {
306 if (!strcasecmp(val, "username")) {
307 endpoint->ident_method |= AST_SIP_ENDPOINT_IDENTIFY_BY_USERNAME;
309 ast_log(LOG_ERROR, "Unrecognized identification method %s specified for endpoint %s\n",
310 val, ast_sorcery_object_get_id(endpoint));
317 static int ident_to_str(const void *obj, const intptr_t *args, char **buf)
319 const struct ast_sip_endpoint *endpoint = obj;
320 switch (endpoint->ident_method) {
321 case AST_SIP_ENDPOINT_IDENTIFY_BY_USERNAME :
322 *buf = "username"; break;
327 *buf = ast_strdup(*buf);
331 static int redirect_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
333 struct ast_sip_endpoint *endpoint = obj;
335 if (!strcasecmp(var->value, "user")) {
336 endpoint->redirect_method = AST_SIP_REDIRECT_USER;
337 } else if (!strcasecmp(var->value, "uri_core")) {
338 endpoint->redirect_method = AST_SIP_REDIRECT_URI_CORE;
339 } else if (!strcasecmp(var->value, "uri_pjsip")) {
340 endpoint->redirect_method = AST_SIP_REDIRECT_URI_PJSIP;
342 ast_log(LOG_ERROR, "Unrecognized redirect method %s specified for endpoint %s\n",
343 var->value, ast_sorcery_object_get_id(endpoint));
350 static int direct_media_method_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
352 struct ast_sip_endpoint *endpoint = obj;
354 if (!strcasecmp(var->value, "invite") || !strcasecmp(var->value, "reinvite")) {
355 endpoint->media.direct_media.method = AST_SIP_SESSION_REFRESH_METHOD_INVITE;
356 } else if (!strcasecmp(var->value, "update")) {
357 endpoint->media.direct_media.method = AST_SIP_SESSION_REFRESH_METHOD_UPDATE;
359 ast_log(LOG_NOTICE, "Unrecognized option value %s for %s on endpoint %s\n",
360 var->value, var->name, ast_sorcery_object_get_id(endpoint));
366 static const char *id_configuration_refresh_methods[] = {
367 [AST_SIP_SESSION_REFRESH_METHOD_INVITE] = "invite",
368 [AST_SIP_SESSION_REFRESH_METHOD_UPDATE] = "update"
371 static int direct_media_method_to_str(const void *obj, const intptr_t *args, char **buf)
373 const struct ast_sip_endpoint *endpoint = obj;
374 if (ARRAY_IN_BOUNDS(endpoint->id.refresh_method, id_configuration_refresh_methods)) {
375 *buf = ast_strdup(id_configuration_refresh_methods[endpoint->id.refresh_method]);
380 static int connected_line_method_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
382 struct ast_sip_endpoint *endpoint = obj;
384 if (!strcasecmp(var->value, "invite") || !strcasecmp(var->value, "reinvite")) {
385 endpoint->id.refresh_method = AST_SIP_SESSION_REFRESH_METHOD_INVITE;
386 } else if (!strcasecmp(var->value, "update")) {
387 endpoint->id.refresh_method = AST_SIP_SESSION_REFRESH_METHOD_UPDATE;
389 ast_log(LOG_NOTICE, "Unrecognized option value %s for %s on endpoint %s\n",
390 var->value, var->name, ast_sorcery_object_get_id(endpoint));
396 static int connected_line_method_to_str(const void *obj, const intptr_t *args, char **buf)
398 const struct ast_sip_endpoint *endpoint = obj;
399 *buf = ast_strdup(id_configuration_refresh_methods[endpoint->id.refresh_method]);
403 static int direct_media_glare_mitigation_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
405 struct ast_sip_endpoint *endpoint = obj;
407 if (!strcasecmp(var->value, "none")) {
408 endpoint->media.direct_media.glare_mitigation = AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_NONE;
409 } else if (!strcasecmp(var->value, "outgoing")) {
410 endpoint->media.direct_media.glare_mitigation = AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_OUTGOING;
411 } else if (!strcasecmp(var->value, "incoming")) {
412 endpoint->media.direct_media.glare_mitigation = AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_INCOMING;
414 ast_log(LOG_NOTICE, "Unrecognized option value %s for %s on endpoint %s\n",
415 var->value, var->name, ast_sorcery_object_get_id(endpoint));
422 static const char *direct_media_glare_mitigation_map[] = {
423 [AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_NONE] = "none",
424 [AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_OUTGOING] = "outgoing",
425 [AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_INCOMING] = "incoming"
428 static int direct_media_glare_mitigation_to_str(const void *obj, const intptr_t *args, char **buf)
430 const struct ast_sip_endpoint *endpoint = obj;
431 if (ARRAY_IN_BOUNDS(endpoint->media.direct_media.glare_mitigation, direct_media_glare_mitigation_map)) {
432 *buf = ast_strdup(direct_media_glare_mitigation_map[endpoint->media.direct_media.glare_mitigation]);
438 static int caller_id_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
440 struct ast_sip_endpoint *endpoint = obj;
441 char cid_name[80] = { '\0' };
442 char cid_num[80] = { '\0' };
444 ast_callerid_split(var->value, cid_name, sizeof(cid_name), cid_num, sizeof(cid_num));
445 if (!ast_strlen_zero(cid_name)) {
446 endpoint->id.self.name.str = ast_strdup(cid_name);
447 if (!endpoint->id.self.name.str) {
450 endpoint->id.self.name.valid = 1;
452 if (!ast_strlen_zero(cid_num)) {
453 endpoint->id.self.number.str = ast_strdup(cid_num);
454 if (!endpoint->id.self.number.str) {
457 endpoint->id.self.number.valid = 1;
462 static int caller_id_to_str(const void *obj, const intptr_t *args, char **buf)
464 const struct ast_sip_endpoint *endpoint = obj;
465 const char *name = S_COR(endpoint->id.self.name.valid,
466 endpoint->id.self.name.str, NULL);
467 const char *number = S_COR(endpoint->id.self.number.valid,
468 endpoint->id.self.number.str, NULL);
470 /* make sure size is at least 10 - that should cover the "<unknown>"
471 case as well as any additional formatting characters added in
472 the name and/or number case. */
474 size += name ? strlen(name) : 0;
475 size += number ? strlen(number) : 0;
477 if (!(*buf = ast_calloc(size + 1, sizeof(char)))) {
481 ast_callerid_merge(*buf, size + 1, name, number, NULL);
485 static int caller_id_privacy_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
487 struct ast_sip_endpoint *endpoint = obj;
488 int callingpres = ast_parse_caller_presentation(var->value);
489 if (callingpres == -1 && sscanf(var->value, "%d", &callingpres) != 1) {
492 endpoint->id.self.number.presentation = callingpres;
493 endpoint->id.self.name.presentation = callingpres;
497 static int caller_id_privacy_to_str(const void *obj, const intptr_t *args, char **buf)
499 const struct ast_sip_endpoint *endpoint = obj;
500 const char *presentation = ast_named_caller_presentation(
501 endpoint->id.self.name.presentation);
503 *buf = ast_strdup(presentation);
507 static int caller_id_tag_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
509 struct ast_sip_endpoint *endpoint = obj;
510 endpoint->id.self.tag = ast_strdup(var->value);
511 return endpoint->id.self.tag ? 0 : -1;
514 static int caller_id_tag_to_str(const void *obj, const intptr_t *args, char **buf)
516 const struct ast_sip_endpoint *endpoint = obj;
517 *buf = ast_strdup(endpoint->id.self.tag);
521 static int media_encryption_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
523 struct ast_sip_endpoint *endpoint = obj;
525 if (!strcasecmp("no", var->value)) {
526 endpoint->media.rtp.encryption = AST_SIP_MEDIA_ENCRYPT_NONE;
527 } else if (!strcasecmp("sdes", var->value)) {
528 endpoint->media.rtp.encryption = AST_SIP_MEDIA_ENCRYPT_SDES;
529 } else if (!strcasecmp("dtls", var->value)) {
530 endpoint->media.rtp.encryption = AST_SIP_MEDIA_ENCRYPT_DTLS;
531 ast_rtp_dtls_cfg_parse(&endpoint->media.rtp.dtls_cfg, "dtlsenable", "yes");
539 static const char *media_encryption_map[] = {
540 [AST_SIP_MEDIA_TRANSPORT_INVALID] = "invalid",
541 [AST_SIP_MEDIA_ENCRYPT_NONE] = "none",
542 [AST_SIP_MEDIA_ENCRYPT_SDES] = "sdes",
543 [AST_SIP_MEDIA_ENCRYPT_DTLS] = "dtls",
546 static int media_encryption_to_str(const void *obj, const intptr_t *args, char **buf)
548 const struct ast_sip_endpoint *endpoint = obj;
549 if (ARRAY_IN_BOUNDS(endpoint->media.rtp.encryption, media_encryption_map)) {
550 *buf = ast_strdup(media_encryption_map[
551 endpoint->media.rtp.encryption]);
556 static int group_handler(const struct aco_option *opt,
557 struct ast_variable *var, void *obj)
559 struct ast_sip_endpoint *endpoint = obj;
561 if (!strncmp(var->name, "call_group", 10)) {
562 if (!(endpoint->pickup.callgroup = ast_get_group(var->value))) {
565 } else if (!strncmp(var->name, "pickup_group", 12)) {
566 if (!(endpoint->pickup.pickupgroup = ast_get_group(var->value))) {
576 static int callgroup_to_str(const void *obj, const intptr_t *args, char **buf)
578 const struct ast_sip_endpoint *endpoint = obj;
580 if (!(*buf = ast_calloc(MAX_OBJECT_FIELD, sizeof(char)))) {
584 ast_print_group(*buf, MAX_OBJECT_FIELD, endpoint->pickup.callgroup);
588 static int pickupgroup_to_str(const void *obj, const intptr_t *args, char **buf)
590 const struct ast_sip_endpoint *endpoint = obj;
592 if (!(*buf = ast_calloc(MAX_OBJECT_FIELD, sizeof(char)))) {
596 ast_print_group(*buf, MAX_OBJECT_FIELD, endpoint->pickup.pickupgroup);
600 static int named_groups_handler(const struct aco_option *opt,
601 struct ast_variable *var, void *obj)
603 struct ast_sip_endpoint *endpoint = obj;
605 if (!strncmp(var->name, "named_call_group", 16)) {
606 if (!(endpoint->pickup.named_callgroups =
607 ast_get_namedgroups(var->value))) {
610 } else if (!strncmp(var->name, "named_pickup_group", 18)) {
611 if (!(endpoint->pickup.named_pickupgroups =
612 ast_get_namedgroups(var->value))) {
622 static int named_callgroups_to_str(const void *obj, const intptr_t *args, char **buf)
624 const struct ast_sip_endpoint *endpoint = obj;
625 RAII_VAR(struct ast_str *, str, ast_str_create(MAX_OBJECT_FIELD), ast_free);
627 ast_print_namedgroups(&str, endpoint->pickup.named_callgroups);
628 *buf = ast_strdup(ast_str_buffer(str));
632 static int named_pickupgroups_to_str(const void *obj, const intptr_t *args, char **buf)
634 const struct ast_sip_endpoint *endpoint = obj;
635 RAII_VAR(struct ast_str *, str, ast_str_create(MAX_OBJECT_FIELD), ast_free);
637 ast_print_namedgroups(&str, endpoint->pickup.named_pickupgroups);
638 *buf = ast_strdup(ast_str_buffer(str));
642 static int dtls_handler(const struct aco_option *opt,
643 struct ast_variable *var, void *obj)
645 struct ast_sip_endpoint *endpoint = obj;
646 char *name = ast_strdupa(var->name);
647 char *front, *buf = name;
649 /* strip out underscores in the name */
650 front = strtok(buf, "_");
652 int size = strlen(front);
653 ast_copy_string(buf, front, size + 1);
655 front = strtok(NULL, "_");
658 return ast_rtp_dtls_cfg_parse(&endpoint->media.rtp.dtls_cfg, name, var->value);
661 static int dtlsverify_to_str(const void *obj, const intptr_t *args, char **buf)
663 const struct ast_sip_endpoint *endpoint = obj;
664 *buf = ast_strdup(AST_YESNO(endpoint->media.rtp.dtls_cfg.verify));
668 static int dtlsrekey_to_str(const void *obj, const intptr_t *args, char **buf)
670 const struct ast_sip_endpoint *endpoint = obj;
673 buf, "%d", endpoint->media.rtp.dtls_cfg.rekey) >=0 ? 0 : -1;
676 static int dtlscertfile_to_str(const void *obj, const intptr_t *args, char **buf)
678 const struct ast_sip_endpoint *endpoint = obj;
679 *buf = ast_strdup(endpoint->media.rtp.dtls_cfg.certfile);
683 static int dtlsprivatekey_to_str(const void *obj, const intptr_t *args, char **buf)
685 const struct ast_sip_endpoint *endpoint = obj;
686 *buf = ast_strdup(endpoint->media.rtp.dtls_cfg.pvtfile);
690 static int dtlscipher_to_str(const void *obj, const intptr_t *args, char **buf)
692 const struct ast_sip_endpoint *endpoint = obj;
693 *buf = ast_strdup(endpoint->media.rtp.dtls_cfg.cipher);
697 static int dtlscafile_to_str(const void *obj, const intptr_t *args, char **buf)
699 const struct ast_sip_endpoint *endpoint = obj;
700 *buf = ast_strdup(endpoint->media.rtp.dtls_cfg.cafile);
704 static int dtlscapath_to_str(const void *obj, const intptr_t *args, char **buf)
706 const struct ast_sip_endpoint *endpoint = obj;
707 *buf = ast_strdup(endpoint->media.rtp.dtls_cfg.capath);
711 static const char *ast_rtp_dtls_setup_map[] = {
712 [AST_RTP_DTLS_SETUP_ACTIVE] = "active",
713 [AST_RTP_DTLS_SETUP_PASSIVE] = "passive",
714 [AST_RTP_DTLS_SETUP_ACTPASS] = "actpass",
715 [AST_RTP_DTLS_SETUP_HOLDCONN] = "holdconn",
718 static int dtlssetup_to_str(const void *obj, const intptr_t *args, char **buf)
720 const struct ast_sip_endpoint *endpoint = obj;
721 if (ARRAY_IN_BOUNDS(endpoint->media.rtp.dtls_cfg.default_setup, ast_rtp_dtls_setup_map)) {
722 *buf = ast_strdup(ast_rtp_dtls_setup_map[endpoint->media.rtp.dtls_cfg.default_setup]);
727 static int t38udptl_ec_handler(const struct aco_option *opt,
728 struct ast_variable *var, void *obj)
730 struct ast_sip_endpoint *endpoint = obj;
732 if (!strcmp(var->value, "none")) {
733 endpoint->media.t38.error_correction = UDPTL_ERROR_CORRECTION_NONE;
734 } else if (!strcmp(var->value, "fec")) {
735 endpoint->media.t38.error_correction = UDPTL_ERROR_CORRECTION_FEC;
736 } else if (!strcmp(var->value, "redundancy")) {
737 endpoint->media.t38.error_correction = UDPTL_ERROR_CORRECTION_REDUNDANCY;
745 static const char *ast_t38_ec_modes_map[] = {
746 [UDPTL_ERROR_CORRECTION_NONE] = "none",
747 [UDPTL_ERROR_CORRECTION_FEC] = "fec",
748 [UDPTL_ERROR_CORRECTION_REDUNDANCY] = "redundancy"
751 static int t38udptl_ec_to_str(const void *obj, const intptr_t *args, char **buf)
753 const struct ast_sip_endpoint *endpoint = obj;
754 if (ARRAY_IN_BOUNDS(endpoint->media.t38.error_correction, ast_t38_ec_modes_map)) {
755 *buf = ast_strdup(ast_t38_ec_modes_map[
756 endpoint->media.t38.error_correction]);
761 static int set_var_handler(const struct aco_option *opt,
762 struct ast_variable *var, void *obj)
764 struct ast_sip_endpoint *endpoint = obj;
765 struct ast_variable *new_var;
766 char *name = ast_strdupa(var->value), *val = strchr(name, '=');
773 if (!(new_var = ast_variable_new(name, val, ""))) {
777 new_var->next = endpoint->channel_vars;
778 endpoint->channel_vars = new_var;
783 static int set_var_to_str(const void *obj, const intptr_t *args, char **buf)
785 struct ast_str *str = ast_str_create(MAX_OBJECT_FIELD);
786 const struct ast_sip_endpoint *endpoint = obj;
787 struct ast_variable *var;
789 for (var = endpoint->channel_vars; var; var = var->next) {
790 ast_str_append(&str, 0, "%s=%s,", var->name, var->value);
793 *buf = ast_strdup(ast_str_truncate(str, -1));
798 static void *sip_nat_hook_alloc(const char *name)
800 return ast_sorcery_generic_alloc(sizeof(struct ast_sip_nat_hook), NULL);
803 /*! \brief Destructor function for persistent endpoint information */
804 static void persistent_endpoint_destroy(void *obj)
806 struct sip_persistent_endpoint *persistent = obj;
808 ast_endpoint_shutdown(persistent->endpoint);
809 ast_free(persistent->aors);
812 /*! \brief Internal function which finds (or creates) persistent endpoint information */
813 static struct ast_endpoint *persistent_endpoint_find_or_create(const struct ast_sip_endpoint *endpoint)
815 RAII_VAR(struct sip_persistent_endpoint *, persistent, NULL, ao2_cleanup);
816 SCOPED_AO2LOCK(lock, persistent_endpoints);
818 if (!(persistent = ao2_find(persistent_endpoints, ast_sorcery_object_get_id(endpoint), OBJ_KEY | OBJ_NOLOCK))) {
819 if (!(persistent = ao2_alloc(sizeof(*persistent), persistent_endpoint_destroy))) {
823 if (!(persistent->endpoint = ast_endpoint_create("PJSIP", ast_sorcery_object_get_id(endpoint)))) {
827 persistent->aors = ast_strdup(endpoint->aors);
829 if (ast_strlen_zero(persistent->aors)) {
830 ast_endpoint_set_state(persistent->endpoint, AST_ENDPOINT_UNKNOWN);
832 persistent_endpoint_update_state(persistent, NULL, 0);
835 ao2_link_flags(persistent_endpoints, persistent, OBJ_NOLOCK);
838 ao2_ref(persistent->endpoint, +1);
839 return persistent->endpoint;
842 /*! \brief Helper function which validates an outbound proxy */
843 static int outbound_proxy_validate(void *data)
845 const char *proxy = data;
848 static const pj_str_t ROUTE_HNAME = { "Route", 5 };
850 pool = pjsip_endpt_create_pool(ast_sip_get_pjsip_endpoint(), "Outbound Proxy Validation", 256, 256);
855 pj_strdup2_with_null(pool, &tmp, proxy);
856 if (!pjsip_parse_hdr(pool, &ROUTE_HNAME, tmp.ptr, tmp.slen, NULL)) {
857 pjsip_endpt_release_pool(ast_sip_get_pjsip_endpoint(), pool);
861 pjsip_endpt_release_pool(ast_sip_get_pjsip_endpoint(), pool);
865 /*! \brief Callback function for when an object is finalized */
866 static int sip_endpoint_apply_handler(const struct ast_sorcery *sorcery, void *obj)
868 struct ast_sip_endpoint *endpoint = obj;
870 if (!(endpoint->persistent = persistent_endpoint_find_or_create(endpoint))) {
874 if (!ast_strlen_zero(endpoint->outbound_proxy) &&
875 ast_sip_push_task_synchronous(NULL, outbound_proxy_validate, (char*)endpoint->outbound_proxy)) {
876 ast_log(LOG_ERROR, "Invalid outbound proxy '%s' specified on endpoint '%s'\n",
877 endpoint->outbound_proxy, ast_sorcery_object_get_id(endpoint));
884 const char *ast_sip_get_device_state(const struct ast_sip_endpoint *endpoint)
886 char device[MAX_OBJECT_FIELD];
888 snprintf(device, MAX_OBJECT_FIELD, "PJSIP/%s", ast_sorcery_object_get_id(endpoint));
889 return ast_devstate2str(ast_device_state(device));
892 struct ast_endpoint_snapshot *ast_sip_get_endpoint_snapshot(
893 const struct ast_sip_endpoint *endpoint)
895 return ast_endpoint_latest_snapshot(
896 ast_endpoint_get_tech(endpoint->persistent),
897 ast_endpoint_get_resource(endpoint->persistent));
900 int ast_sip_for_each_channel_snapshot(
901 const struct ast_endpoint_snapshot *endpoint_snapshot,
902 ao2_callback_fn on_channel_snapshot, void *arg)
904 int num, num_channels = endpoint_snapshot->num_channels;
906 if (!on_channel_snapshot || !num_channels) {
910 for (num = 0; num < num_channels; ++num) {
911 RAII_VAR(struct ast_channel_snapshot *, snapshot, NULL, ao2_cleanup);
914 snapshot = ast_channel_snapshot_get_latest(endpoint_snapshot->channel_ids[num]);
919 res = on_channel_snapshot(snapshot, arg, 0);
927 int ast_sip_for_each_channel(
928 const struct ast_sip_endpoint *endpoint,
929 ao2_callback_fn on_channel_snapshot, void *arg)
931 RAII_VAR(struct ast_endpoint_snapshot *, endpoint_snapshot, ast_sip_get_endpoint_snapshot(endpoint), ao2_cleanup);
932 return ast_sip_for_each_channel_snapshot(endpoint_snapshot, on_channel_snapshot, arg);
935 static int active_channels_to_str_cb(void *object, void *arg, int flags)
937 const struct ast_channel_snapshot *snapshot = object;
938 struct ast_str **buf = arg;
939 ast_str_append(buf, 0, "%s,", snapshot->name);
943 static void active_channels_to_str(const struct ast_sip_endpoint *endpoint,
944 struct ast_str **str)
947 RAII_VAR(struct ast_endpoint_snapshot *, endpoint_snapshot,
948 ast_sip_get_endpoint_snapshot(endpoint), ao2_cleanup);
950 if (endpoint_snapshot) {
954 ast_sip_for_each_channel_snapshot(endpoint_snapshot,
955 active_channels_to_str_cb, str);
956 ast_str_truncate(*str, -1);
959 #define AMI_DEFAULT_STR_SIZE 512
961 struct ast_str *ast_sip_create_ami_event(const char *event, struct ast_sip_ami *ami)
963 struct ast_str *buf = ast_str_create(AMI_DEFAULT_STR_SIZE);
966 astman_send_error_va(ami->s, ami->m, "Unable create event "
971 ast_str_set(&buf, 0, "Event: %s\r\n", event);
975 static void sip_sorcery_object_ami_set_type_name(const void *obj, struct ast_str **buf)
977 ast_str_append(buf, 0, "ObjectType: %s\r\n",
978 ast_sorcery_object_get_type(obj));
979 ast_str_append(buf, 0, "ObjectName: %s\r\n",
980 ast_sorcery_object_get_id(obj));
983 int ast_sip_sorcery_object_to_ami(const void *obj, struct ast_str **buf)
985 RAII_VAR(struct ast_variable *, objset, ast_sorcery_objectset_create(
986 ast_sip_get_sorcery(), obj), ast_variables_destroy);
987 struct ast_variable *i;
993 sip_sorcery_object_ami_set_type_name(obj, buf);
995 for (i = objset; i; i = i->next) {
996 RAII_VAR(char *, camel, ast_to_camel_case(i->name), ast_free);
997 ast_str_append(buf, 0, "%s: %s\r\n", camel, i->value);
1003 static int sip_endpoints_aors_ami(void *obj, void *arg, int flags)
1005 struct ast_sip_aor *aor = obj;
1006 struct ast_str **buf = arg;
1008 ast_str_append(buf, 0, "Contacts: ");
1009 ast_sip_for_each_contact(aor, ast_sip_contact_to_str, arg);
1010 ast_str_append(buf, 0, "\r\n");
1015 static int sip_endpoint_to_ami(const struct ast_sip_endpoint *endpoint,
1016 struct ast_str **buf)
1018 if (ast_sip_sorcery_object_to_ami(endpoint, buf)) {
1022 ast_str_append(buf, 0, "DeviceState: %s\r\n",
1023 ast_sip_get_device_state(endpoint));
1025 ast_str_append(buf, 0, "ActiveChannels: ");
1026 active_channels_to_str(endpoint, buf);
1027 ast_str_append(buf, 0, "\r\n");
1032 static int format_ami_endpoint(const struct ast_sip_endpoint *endpoint,
1033 struct ast_sip_ami *ami)
1035 RAII_VAR(struct ast_str *, buf,
1036 ast_sip_create_ami_event("EndpointDetail", ami), ast_free);
1042 sip_endpoint_to_ami(endpoint, &buf);
1043 astman_append(ami->s, "%s\r\n", ast_str_buffer(buf));
1047 #define AMI_SHOW_ENDPOINTS "PJSIPShowEndpoints"
1048 #define AMI_SHOW_ENDPOINT "PJSIPShowEndpoint"
1050 static int ami_show_endpoint(struct mansession *s, const struct message *m)
1052 struct ast_sip_ami ami = { .s = s, .m = m };
1053 RAII_VAR(struct ast_sip_endpoint *, endpoint, NULL, ao2_cleanup);
1054 const char *endpoint_name = astman_get_header(m, "Endpoint");
1057 if (ast_strlen_zero(endpoint_name)) {
1058 astman_send_error_va(s, m, "%s requires an endpoint name\n",
1063 if (!strncasecmp(endpoint_name, "pjsip/", 6)) {
1067 if (!(endpoint = ast_sorcery_retrieve_by_id(
1068 ast_sip_get_sorcery(), "endpoint", endpoint_name))) {
1069 astman_send_error_va(s, m, "Unable to retrieve endpoint %s\n",
1074 astman_send_listack(s, m, "Following are Events for each object "
1075 "associated with the the Endpoint", "start");
1077 /* the endpoint detail needs to always come first so apply as such */
1078 if (format_ami_endpoint(endpoint, &ami) ||
1079 ast_sip_format_endpoint_ami(endpoint, &ami, &count)) {
1080 astman_send_error_va(s, m, "Unable to format endpoint %s\n",
1085 "Event: EndpointDetailComplete\r\n"
1086 "EventList: Complete\r\n"
1087 "ListItems: %d\r\n\r\n", count + 1);
1091 static int format_str_append_auth(const struct ast_sip_auth_vector *auths,
1092 struct ast_str **buf)
1095 if (ast_sip_auths_to_str(auths, &str)) {
1098 ast_str_append(buf, 0, "%s", str ? str : "");
1103 static int format_ami_endpoints(void *obj, void *arg, int flags)
1106 struct ast_sip_endpoint *endpoint = obj;
1107 struct ast_sip_ami *ami = arg;
1108 RAII_VAR(struct ast_str *, buf,
1109 ast_sip_create_ami_event("EndpointList", ami), ast_free);
1115 sip_sorcery_object_ami_set_type_name(endpoint, &buf);
1116 ast_str_append(&buf, 0, "Transport: %s\r\n",
1117 endpoint->transport);
1118 ast_str_append(&buf, 0, "Aor: %s\r\n",
1121 ast_str_append(&buf, 0, "Auths: ");
1122 format_str_append_auth(&endpoint->inbound_auths, &buf);
1123 ast_str_append(&buf, 0, "\r\n");
1125 ast_str_append(&buf, 0, "OutboundAuths: ");
1126 format_str_append_auth(&endpoint->outbound_auths, &buf);
1127 ast_str_append(&buf, 0, "\r\n");
1129 ast_sip_for_each_aor(endpoint->aors,
1130 sip_endpoints_aors_ami, &buf);
1132 ast_str_append(&buf, 0, "DeviceState: %s\r\n",
1133 ast_sip_get_device_state(endpoint));
1135 ast_str_append(&buf, 0, "ActiveChannels: ");
1136 active_channels_to_str(endpoint, &buf);
1137 ast_str_append(&buf, 0, "\r\n");
1139 astman_append(ami->s, "%s\r\n", ast_str_buffer(buf));
1143 static int ami_show_endpoints(struct mansession *s, const struct message *m)
1145 struct ast_sip_ami ami = { .s = s, .m = m };
1146 RAII_VAR(struct ao2_container *, endpoints, NULL, ao2_cleanup);
1149 endpoints = ast_sip_get_endpoints();
1154 if (!(num = ao2_container_count(endpoints))) {
1155 astman_send_error(s, m, "No endpoints found\n");
1159 astman_send_listack(s, m, "A listing of Endpoints follows, "
1160 "presented as EndpointList events", "start");
1162 ao2_callback(endpoints, OBJ_NODATA, format_ami_endpoints, &ami);
1165 "Event: EndpointListComplete\r\n"
1166 "EventList: Complete\r\n"
1167 "ListItems: %d\r\n\r\n", num);
1171 static struct ao2_container *cli_get_endpoint_container(void)
1173 RAII_VAR(struct ao2_container *, container, NULL, ao2_cleanup);
1174 RAII_VAR(struct ao2_container *, s_container, NULL, ao2_cleanup);
1176 container = ast_sorcery_retrieve_by_fields(sip_sorcery, "endpoint",
1177 AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
1182 s_container = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK, 0,
1183 ast_sorcery_object_id_compare, NULL);
1188 if (ao2_container_dup(s_container, container, 0)) {
1191 ao2_ref(s_container, +1);
1195 static int populate_channel_container(void *obj, void *arg, int flags)
1197 struct ast_channel_snapshot *snapshot = obj;
1198 struct ao2_container *container = arg;
1200 ao2_link(container, snapshot);
1204 static int cli_channel_iterator(const void *container, ao2_callback_fn callback, void *args)
1206 const struct ast_sip_endpoint *array = container;
1208 return ast_sip_for_each_channel(array, callback, args);
1211 static int gather_endpoint_channels(void *obj, void *arg, int flags)
1213 struct ast_sip_endpoint *endpoint = obj;
1214 struct ao2_container *channels = arg;
1216 ast_sip_for_each_channel(endpoint, populate_channel_container, channels);
1220 static int cli_channel_compare(const void *left, const void *right, int flags)
1222 const struct ast_channel_snapshot *left_snap = left;
1223 const struct ast_channel_snapshot *right_snap = right;
1225 if (!left_snap || !right_snap) {
1228 return strcmp(left_snap->name, right_snap->name);
1231 static struct ao2_container *cli_get_channel_container(void)
1233 RAII_VAR(struct ao2_container *, parent_container, NULL, ao2_cleanup);
1234 RAII_VAR(struct ao2_container *, child_container, NULL, ao2_cleanup);
1236 parent_container = cli_get_endpoint_container();
1237 if (!parent_container) {
1240 child_container = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK, 0,
1241 cli_channel_compare, NULL);
1242 if (!child_container) {
1246 ao2_callback(parent_container, OBJ_NODATA, gather_endpoint_channels, child_container);
1247 ao2_ref(child_container, +1);
1248 return child_container;
1251 static int cli_print_channel_header(void *obj, void *arg, int flags)
1253 struct ast_sip_cli_context *context = arg;
1254 int indent = CLI_INDENT_TO_SPACES(context->indent_level);
1255 int filler = CLI_LAST_TABSTOP - indent - 13;
1257 if (!context->output_buffer) {
1260 ast_str_append(&context->output_buffer, 0,
1261 "%*s: <ChannelId%*.*s> <State.....> <Time(sec)>\n",
1262 indent, "Channel", filler, filler, CLI_HEADER_FILLER);
1264 context->indent_level++;
1265 indent = CLI_INDENT_TO_SPACES(context->indent_level);
1266 filler = CLI_LAST_TABSTOP - indent - 38;
1267 ast_str_append(&context->output_buffer, 0,
1268 "%*s: <Codec> Exten: <DialedExten%*.*s> CLCID: <ConnectedLineCID.......>\n",
1269 indent, "Codec", filler, filler, CLI_HEADER_FILLER);
1270 context->indent_level--;
1274 static int cli_print_channel_body(void *obj, void *arg, int flags)
1276 struct ast_channel_snapshot *snapshot = obj;
1277 struct ast_sip_cli_context *context = arg;
1278 struct timeval current_time;
1279 char *print_name = NULL;
1284 if (!context->output_buffer) {
1288 gettimeofday(¤t_time, NULL);
1290 print_name_len = strlen(snapshot->name) + strlen(snapshot->appl) + 2;
1291 if (!(print_name = alloca(print_name_len))) {
1295 snprintf(print_name, print_name_len, "%s/%s", snapshot->name, snapshot->appl);
1297 indent = CLI_INDENT_TO_SPACES(context->indent_level);
1298 flexwidth = CLI_LAST_TABSTOP - indent;
1300 ast_str_append(&context->output_buffer, 0, "%*s: %-*.*s %-12.12s %11ld\n",
1301 CLI_INDENT_TO_SPACES(context->indent_level), "Channel",
1302 flexwidth, flexwidth,
1304 ast_state2str(snapshot->state),
1305 current_time.tv_sec - snapshot->creationtime.tv_sec);
1307 context->indent_level++;
1308 indent = CLI_INDENT_TO_SPACES(context->indent_level);
1309 flexwidth = CLI_LAST_TABSTOP - indent - 25;
1311 ast_str_append(&context->output_buffer, 0,
1312 "%*s: %-7s Exten: %-*.*s CLCID: \"%s\" <%s>\n",
1314 snapshot->nativeformats,
1315 flexwidth, flexwidth,
1317 snapshot->connected_name,
1318 snapshot->connected_number
1320 context->indent_level--;
1321 if (context->indent_level == 0) {
1322 ast_str_append(&context->output_buffer, 0, "\n");
1328 static int cli_endpoint_iterator(const void *container, ao2_callback_fn callback,
1331 struct ao2_container *ao2container = (struct ao2_container *) container;
1333 ao2_callback(ao2container, OBJ_NODATA, callback, args);
1337 static void print_child_header(char *type, struct ast_sip_cli_context *context)
1339 struct ast_sip_cli_formatter_entry *formatter_entry;
1341 formatter_entry = ast_sip_lookup_cli_formatter(type);
1342 if (formatter_entry && formatter_entry->print_header) {
1343 formatter_entry->print_header(NULL, context, 0);
1347 static int cli_print_endpoint_header(void *obj, void *arg, int flags)
1349 struct ast_sip_cli_context *context = arg;
1351 if (!context->output_buffer) {
1354 ast_str_append(&context->output_buffer, 0,
1355 " Endpoint: <Endpoint/CID.....................................> <State.....> <Channels.>\n");
1357 if (context->recurse) {
1358 context->indent_level++;
1359 print_child_header("auth", context);
1360 print_child_header("aor", context);
1361 print_child_header("transport", context);
1362 print_child_header("identify", context);
1363 print_child_header("channel", context);
1364 context->indent_level--;
1369 static void print_child_body(char *type, const void *obj, struct ast_sip_cli_context *context)
1371 struct ast_sip_cli_formatter_entry *formatter_entry;
1373 formatter_entry = ast_sip_lookup_cli_formatter(type);
1374 if (formatter_entry && formatter_entry->print_body && formatter_entry->iterator) {
1375 formatter_entry->iterator(obj, formatter_entry->print_body, context);
1379 static int cli_print_endpoint_body(void *obj, void *arg, int flags)
1381 struct ast_sip_endpoint *endpoint = obj;
1382 RAII_VAR(struct ast_endpoint_snapshot *, endpoint_snapshot, ast_sip_get_endpoint_snapshot(endpoint), ao2_cleanup);
1383 struct ast_sip_cli_context *context = arg;
1384 const char *id = ast_sorcery_object_get_id(endpoint);
1385 char *print_name = NULL;
1387 char *number = S_COR(endpoint->id.self.number.valid,
1388 endpoint->id.self.number.str, NULL);
1392 if (!context->output_buffer) {
1396 context->current_endpoint = endpoint;
1399 print_name_len = strlen(id) + strlen(number) + 2;
1400 if (!(print_name = alloca(print_name_len))) {
1403 snprintf(print_name, print_name_len, "%s/%s", id, number);
1406 indent = CLI_INDENT_TO_SPACES(context->indent_level);
1407 flexwidth = CLI_LAST_TABSTOP - indent - 2;
1409 ast_str_append(&context->output_buffer, 0, "%*s: %-*.*s %-12.12s %d of %.0f\n",
1411 flexwidth, flexwidth, print_name ? print_name : id,
1412 ast_sip_get_device_state(endpoint),
1413 endpoint_snapshot->num_channels,
1414 (double) endpoint->devicestate_busy_at ? endpoint->devicestate_busy_at :
1418 if (context->recurse) {
1419 context->indent_level++;
1421 context->auth_direction = "Out";
1422 print_child_body("auth", &endpoint->outbound_auths, context);
1423 context->auth_direction = "In";
1424 print_child_body("auth", &endpoint->inbound_auths, context);
1426 print_child_body("aor", endpoint->aors, context);
1427 print_child_body("transport", endpoint, context);
1428 print_child_body("identify", endpoint, context);
1429 print_child_body("channel", endpoint, context);
1431 context->indent_level--;
1433 if (context->indent_level == 0) {
1434 ast_str_append(&context->output_buffer, 0, "\n");
1438 if (context->show_details || (context->show_details_only_level_0 && context->indent_level == 0)) {
1439 ast_str_append(&context->output_buffer, 0, "\n");
1440 ast_sip_cli_print_sorcery_objectset(endpoint, context, 0);
1446 static struct ast_sip_cli_formatter_entry cli_channel_formatter = {
1448 .print_header = cli_print_channel_header,
1449 .print_body = cli_print_channel_body,
1450 .get_container = cli_get_channel_container,
1451 .iterator = cli_channel_iterator,
1452 .comparator = cli_channel_compare,
1455 static struct ast_sip_cli_formatter_entry cli_endpoint_formatter = {
1457 .print_header = cli_print_endpoint_header,
1458 .print_body = cli_print_endpoint_body,
1459 .get_container = cli_get_endpoint_container,
1460 .iterator = cli_endpoint_iterator,
1461 .comparator = ast_sorcery_object_id_compare,
1464 static struct ast_cli_entry cli_commands[] = {
1465 AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "List PJSIP Channels",
1466 .command = "pjsip list channels",
1467 .usage = "Usage: pjsip list channels\n"
1468 " List the active PJSIP channels\n"),
1469 AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "Show PJSIP Channels",
1470 .command = "pjsip show channels",
1471 .usage = "Usage: pjsip show channels\n"
1472 " List(detailed) the active PJSIP channels\n"),
1474 AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "List PJSIP Endpoints",
1475 .command = "pjsip list endpoints",
1476 .usage = "Usage: pjsip list endpoints\n"
1477 " List the configured PJSIP endpoints\n"),
1478 AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "Show PJSIP Endpoints",
1479 .command = "pjsip show endpoints",
1480 .usage = "Usage: pjsip show endpoints\n"
1481 " List(detailed) the configured PJSIP endpoints\n"),
1482 AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "Show PJSIP Endpoint",
1483 .command = "pjsip show endpoint",
1484 .usage = "Usage: pjsip show endpoint <id>\n"
1485 " Show the configured PJSIP endpoint\n"),
1488 int ast_res_pjsip_initialize_configuration(const struct ast_module_info *ast_module_info)
1491 if (ast_manager_register_xml(AMI_SHOW_ENDPOINTS, EVENT_FLAG_SYSTEM, ami_show_endpoints) ||
1492 ast_manager_register_xml(AMI_SHOW_ENDPOINT, EVENT_FLAG_SYSTEM, ami_show_endpoint)) {
1496 if (!(persistent_endpoints = ao2_container_alloc(PERSISTENT_BUCKETS, persistent_endpoint_hash, persistent_endpoint_cmp))) {
1500 if (!(sip_sorcery = ast_sorcery_open())) {
1501 ast_log(LOG_ERROR, "Failed to open SIP sorcery failed to open\n");
1505 ast_sorcery_apply_config(sip_sorcery, "res_pjsip");
1507 ast_sip_initialize_cli();
1509 if (ast_sip_initialize_sorcery_auth()) {
1510 ast_log(LOG_ERROR, "Failed to register SIP authentication support\n");
1511 ast_sorcery_unref(sip_sorcery);
1516 ast_sorcery_apply_default(sip_sorcery, "endpoint", "config", "pjsip.conf,criteria=type=endpoint");
1518 ast_sorcery_apply_default(sip_sorcery, "nat_hook", "memory", NULL);
1520 if (ast_sorcery_object_register(sip_sorcery, "endpoint", ast_sip_endpoint_alloc, NULL, sip_endpoint_apply_handler)) {
1521 ast_log(LOG_ERROR, "Failed to register SIP endpoint object with sorcery\n");
1522 ast_sorcery_unref(sip_sorcery);
1527 ast_sorcery_internal_object_register(sip_sorcery, "nat_hook", sip_nat_hook_alloc, NULL, NULL);
1529 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "type", "", OPT_NOOP_T, 0, 0);
1530 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "context", "default", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_endpoint, context));
1531 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "disallow", "", OPT_CODEC_T, 0, FLDSET(struct ast_sip_endpoint, media.prefs, media.codecs));
1532 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "allow", "", OPT_CODEC_T, 1, FLDSET(struct ast_sip_endpoint, media.prefs, media.codecs));
1533 ast_sorcery_object_field_register_custom(sip_sorcery, "endpoint", "dtmf_mode", "rfc4733", dtmf_handler, dtmf_to_str, 0, 0);
1534 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "rtp_ipv6", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_endpoint, media.rtp.ipv6));
1535 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "rtp_symmetric", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_endpoint, media.rtp.symmetric));
1536 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "ice_support", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_endpoint, media.rtp.ice_support));
1537 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "use_ptime", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_endpoint, media.rtp.use_ptime));
1538 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "force_rport", "yes", OPT_BOOL_T, 1, FLDSET(struct ast_sip_endpoint, nat.force_rport));
1539 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "rewrite_contact", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_endpoint, nat.rewrite_contact));
1540 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "transport", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_endpoint, transport));
1541 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "outbound_proxy", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_endpoint, outbound_proxy));
1542 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "moh_suggest", "default", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_endpoint, mohsuggest));
1543 ast_sorcery_object_field_register_custom(sip_sorcery, "endpoint", "100rel", "yes", prack_handler, prack_to_str, 0, 0);
1544 ast_sorcery_object_field_register_custom(sip_sorcery, "endpoint", "timers", "yes", timers_handler, timers_to_str, 0, 0);
1545 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "timers_min_se", "90", OPT_UINT_T, 0, FLDSET(struct ast_sip_endpoint, extensions.timer.min_se));
1546 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "timers_sess_expires", "1800", OPT_UINT_T, 0, FLDSET(struct ast_sip_endpoint, extensions.timer.sess_expires));
1547 ast_sorcery_object_field_register_custom(sip_sorcery, "endpoint", "auth", "", inbound_auth_handler, inbound_auths_to_str, 0, 0);
1548 ast_sorcery_object_field_register_custom(sip_sorcery, "endpoint", "outbound_auth", "", outbound_auth_handler, outbound_auths_to_str, 0, 0);
1549 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "aors", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_endpoint, aors));
1550 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "media_address", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_endpoint, media.address));
1551 ast_sorcery_object_field_register_custom(sip_sorcery, "endpoint", "identify_by", "username", ident_handler, ident_to_str, 0, 0);
1552 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "direct_media", "yes", OPT_BOOL_T, 1, FLDSET(struct ast_sip_endpoint, media.direct_media.enabled));
1553 ast_sorcery_object_field_register_custom(sip_sorcery, "endpoint", "direct_media_method", "invite", direct_media_method_handler, direct_media_method_to_str, 0, 0);
1554 ast_sorcery_object_field_register_custom(sip_sorcery, "endpoint", "connected_line_method", "invite", connected_line_method_handler, connected_line_method_to_str, 0, 0);
1555 ast_sorcery_object_field_register_custom(sip_sorcery, "endpoint", "direct_media_glare_mitigation", "none", direct_media_glare_mitigation_handler, direct_media_glare_mitigation_to_str, 0, 0);
1556 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "disable_direct_media_on_nat", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_endpoint, media.direct_media.disable_on_nat));
1557 ast_sorcery_object_field_register_custom(sip_sorcery, "endpoint", "callerid", "", caller_id_handler, caller_id_to_str, 0, 0);
1558 ast_sorcery_object_field_register_custom(sip_sorcery, "endpoint", "callerid_privacy", "", caller_id_privacy_handler, caller_id_privacy_to_str, 0, 0);
1559 ast_sorcery_object_field_register_custom(sip_sorcery, "endpoint", "callerid_tag", "", caller_id_tag_handler, caller_id_tag_to_str, 0, 0);
1560 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "trust_id_inbound", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_endpoint, id.trust_inbound));
1561 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "trust_id_outbound", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_endpoint, id.trust_outbound));
1562 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "send_pai", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_endpoint, id.send_pai));
1563 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "send_rpid", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_endpoint, id.send_rpid));
1564 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "send_diversion", "yes", OPT_BOOL_T, 1, FLDSET(struct ast_sip_endpoint, id.send_diversion));
1565 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "mailboxes", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_endpoint, subscription.mwi.mailboxes));
1566 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "aggregate_mwi", "yes", OPT_BOOL_T, 1, FLDSET(struct ast_sip_endpoint, subscription.mwi.aggregate));
1567 ast_sorcery_object_field_register_custom(sip_sorcery, "endpoint", "media_encryption", "no", media_encryption_handler, media_encryption_to_str, 0, 0);
1568 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "use_avpf", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_endpoint, media.rtp.use_avpf));
1569 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "one_touch_recording", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_endpoint, info.recording.enabled));
1570 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "inband_progress", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_endpoint, inband_progress));
1571 ast_sorcery_object_field_register_custom(sip_sorcery, "endpoint", "call_group", "", group_handler, callgroup_to_str, 0, 0);
1572 ast_sorcery_object_field_register_custom(sip_sorcery, "endpoint", "pickup_group", "", group_handler, pickupgroup_to_str, 0, 0);
1573 ast_sorcery_object_field_register_custom(sip_sorcery, "endpoint", "named_call_group", "", named_groups_handler, named_callgroups_to_str, 0, 0);
1574 ast_sorcery_object_field_register_custom(sip_sorcery, "endpoint", "named_pickup_group", "", named_groups_handler, named_pickupgroups_to_str, 0, 0);
1575 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "device_state_busy_at", "0", OPT_UINT_T, 0, FLDSET(struct ast_sip_endpoint, devicestate_busy_at));
1576 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "t38_udptl", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_endpoint, media.t38.enabled));
1577 ast_sorcery_object_field_register_custom(sip_sorcery, "endpoint", "t38_udptl_ec", "none", t38udptl_ec_handler, t38udptl_ec_to_str, 0, 0);
1578 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "t38_udptl_maxdatagram", "0", OPT_UINT_T, 0, FLDSET(struct ast_sip_endpoint, media.t38.maxdatagram));
1579 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "fax_detect", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_endpoint, faxdetect));
1580 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "t38_udptl_nat", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_endpoint, media.t38.nat));
1581 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "t38_udptl_ipv6", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_endpoint, media.t38.ipv6));
1582 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "tone_zone", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_endpoint, zone));
1583 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "language", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_endpoint, language));
1584 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "record_on_feature", "automixmon", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_endpoint, info.recording.onfeature));
1585 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "record_off_feature", "automixmon", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_endpoint, info.recording.offfeature));
1586 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "allow_transfer", "yes", OPT_BOOL_T, 1, FLDSET(struct ast_sip_endpoint, allowtransfer));
1587 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "sdp_owner", "-", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_endpoint, media.sdpowner));
1588 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "sdp_session", "Asterisk", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_endpoint, media.sdpsession));
1589 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "tos_audio", "0", OPT_UINT_T, 0, FLDSET(struct ast_sip_endpoint, media.tos_audio));
1590 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "tos_video", "0", OPT_UINT_T, 0, FLDSET(struct ast_sip_endpoint, media.tos_video));
1591 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "cos_audio", "0", OPT_UINT_T, 0, FLDSET(struct ast_sip_endpoint, media.cos_audio));
1592 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "cos_video", "0", OPT_UINT_T, 0, FLDSET(struct ast_sip_endpoint, media.cos_video));
1593 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "allow_subscribe", "yes", OPT_BOOL_T, 1, FLDSET(struct ast_sip_endpoint, subscription.allow));
1594 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "sub_min_expiry", "0", OPT_UINT_T, 0, FLDSET(struct ast_sip_endpoint, subscription.minexpiry));
1595 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "from_user", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_endpoint, fromuser));
1596 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "from_domain", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_endpoint, fromdomain));
1597 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "mwi_from_user", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_endpoint, subscription.mwi.fromuser));
1598 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "rtp_engine", "asterisk", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_endpoint, media.rtp.engine));
1599 ast_sorcery_object_field_register_custom(sip_sorcery, "endpoint", "dtls_verify", "", dtls_handler, dtlsverify_to_str, 0, 0);
1600 ast_sorcery_object_field_register_custom(sip_sorcery, "endpoint", "dtls_rekey", "", dtls_handler, dtlsrekey_to_str, 0, 0);
1601 ast_sorcery_object_field_register_custom(sip_sorcery, "endpoint", "dtls_cert_file", "", dtls_handler, dtlscertfile_to_str, 0, 0);
1602 ast_sorcery_object_field_register_custom(sip_sorcery, "endpoint", "dtls_private_key", "", dtls_handler, dtlsprivatekey_to_str, 0, 0);
1603 ast_sorcery_object_field_register_custom(sip_sorcery, "endpoint", "dtls_cipher", "", dtls_handler, dtlscipher_to_str, 0, 0);
1604 ast_sorcery_object_field_register_custom(sip_sorcery, "endpoint", "dtls_ca_file", "", dtls_handler, dtlscafile_to_str, 0, 0);
1605 ast_sorcery_object_field_register_custom(sip_sorcery, "endpoint", "dtls_ca_path", "", dtls_handler, dtlscapath_to_str, 0, 0);
1606 ast_sorcery_object_field_register_custom(sip_sorcery, "endpoint", "dtls_setup", "", dtls_handler, dtlssetup_to_str, 0, 0);
1607 ast_sorcery_object_field_register(sip_sorcery, "endpoint", "srtp_tag_32", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_endpoint, media.rtp.srtp_tag_32));
1608 ast_sorcery_object_field_register_custom(sip_sorcery, "endpoint", "redirect_method", "user", redirect_handler, NULL, 0, 0);
1609 ast_sorcery_object_field_register_custom(sip_sorcery, "endpoint", "set_var", "", set_var_handler, set_var_to_str, 0, 0);
1611 if (ast_sip_initialize_sorcery_transport()) {
1612 ast_log(LOG_ERROR, "Failed to register SIP transport support with sorcery\n");
1613 ast_sorcery_unref(sip_sorcery);
1618 if (ast_sip_initialize_sorcery_location()) {
1619 ast_log(LOG_ERROR, "Failed to register SIP location support with sorcery\n");
1620 ast_sorcery_unref(sip_sorcery);
1625 if (ast_sip_initialize_sorcery_qualify()) {
1626 ast_log(LOG_ERROR, "Failed to register SIP qualify support with sorcery\n");
1627 ast_sorcery_unref(sip_sorcery);
1632 ast_sorcery_observer_add(sip_sorcery, "contact", &state_contact_observer);
1634 if (ast_sip_initialize_sorcery_domain_alias()) {
1635 ast_log(LOG_ERROR, "Failed to register SIP domain aliases support with sorcery\n");
1636 ast_sorcery_unref(sip_sorcery);
1641 if (ast_sip_initialize_sorcery_global()) {
1642 ast_log(LOG_ERROR, "Failed to register SIP Global support\n");
1643 ast_sorcery_unref(sip_sorcery);
1648 ast_sip_register_cli_formatter(&cli_channel_formatter);
1649 ast_sip_register_cli_formatter(&cli_endpoint_formatter);
1650 ast_cli_register_multiple(cli_commands, ARRAY_LEN(cli_commands));
1652 ast_sorcery_load(sip_sorcery);
1657 void ast_res_pjsip_destroy_configuration(void)
1659 ast_cli_unregister_multiple(cli_commands, ARRAY_LEN(cli_commands));
1660 ast_sip_destroy_sorcery_location();
1661 ast_sip_destroy_sorcery_auth();
1662 ast_sip_destroy_sorcery_transport();
1663 ast_manager_unregister(AMI_SHOW_ENDPOINT);
1664 ast_manager_unregister(AMI_SHOW_ENDPOINTS);
1665 ast_sorcery_unref(sip_sorcery);
1670 * \brief Reload configuration within a PJSIP thread
1672 static int reload_configuration_task(void *obj)
1675 ast_sorcery_reload(sip_sorcery);
1680 int ast_res_pjsip_reload_configuration(void)
1682 if (ast_sip_push_task(NULL, reload_configuration_task, NULL)) {
1683 ast_log(LOG_WARNING, "Failed to reload PJSIP configuration\n");
1689 static void subscription_configuration_destroy(struct ast_sip_endpoint_subscription_configuration *subscription)
1691 ast_string_field_free_memory(&subscription->mwi);
1694 static void info_configuration_destroy(struct ast_sip_endpoint_info_configuration *info)
1696 ast_string_field_free_memory(&info->recording);
1699 static void media_configuration_destroy(struct ast_sip_endpoint_media_configuration *media)
1701 ast_string_field_free_memory(&media->rtp);
1702 ast_string_field_free_memory(media);
1705 static void endpoint_destructor(void* obj)
1707 struct ast_sip_endpoint *endpoint = obj;
1709 ast_string_field_free_memory(endpoint);
1711 if (endpoint->media.codecs) {
1712 ast_format_cap_destroy(endpoint->media.codecs);
1714 subscription_configuration_destroy(&endpoint->subscription);
1715 info_configuration_destroy(&endpoint->info);
1716 media_configuration_destroy(&endpoint->media);
1717 ast_sip_auth_vector_destroy(&endpoint->inbound_auths);
1718 ast_sip_auth_vector_destroy(&endpoint->outbound_auths);
1719 ast_party_id_free(&endpoint->id.self);
1720 endpoint->pickup.named_callgroups = ast_unref_namedgroups(endpoint->pickup.named_callgroups);
1721 endpoint->pickup.named_pickupgroups = ast_unref_namedgroups(endpoint->pickup.named_pickupgroups);
1722 ao2_cleanup(endpoint->persistent);
1723 ast_variables_destroy(endpoint->channel_vars);
1726 static int init_subscription_configuration(struct ast_sip_endpoint_subscription_configuration *subscription)
1728 return ast_string_field_init(&subscription->mwi, 64);
1731 static int init_info_configuration(struct ast_sip_endpoint_info_configuration *info)
1733 return ast_string_field_init(&info->recording, 32);
1736 static int init_media_configuration(struct ast_sip_endpoint_media_configuration *media)
1738 return ast_string_field_init(media, 64) || ast_string_field_init(&media->rtp, 32);
1741 void *ast_sip_endpoint_alloc(const char *name)
1743 struct ast_sip_endpoint *endpoint = ast_sorcery_generic_alloc(sizeof(*endpoint), endpoint_destructor);
1747 if (ast_string_field_init(endpoint, 64)) {
1748 ao2_cleanup(endpoint);
1751 if (!(endpoint->media.codecs = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_NOLOCK))) {
1752 ao2_cleanup(endpoint);
1755 if (init_subscription_configuration(&endpoint->subscription)) {
1756 ao2_cleanup(endpoint);
1759 if (init_info_configuration(&endpoint->info)) {
1760 ao2_cleanup(endpoint);
1763 if (init_media_configuration(&endpoint->media)) {
1764 ao2_cleanup(endpoint);
1767 ast_party_id_init(&endpoint->id.self);
1771 struct ao2_container *ast_sip_get_endpoints(void)
1773 struct ao2_container *endpoints;
1775 endpoints = ast_sorcery_retrieve_by_fields(sip_sorcery, "endpoint", AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
1780 struct ast_sip_endpoint *ast_sip_default_outbound_endpoint(void)
1782 RAII_VAR(char *, name, ast_sip_global_default_outbound_endpoint(), ast_free);
1783 return ast_strlen_zero(name) ? NULL : ast_sorcery_retrieve_by_id(
1784 sip_sorcery, "endpoint", name);
1787 int ast_sip_retrieve_auths(const struct ast_sip_auth_vector *auths, struct ast_sip_auth **out)
1791 for (i = 0; i < AST_VECTOR_SIZE(auths); ++i) {
1792 /* Using AST_VECTOR_GET is safe since the vector is immutable */
1793 const char *name = AST_VECTOR_GET(auths, i);
1794 out[i] = ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), SIP_SORCERY_AUTH_TYPE, name);
1796 ast_log(LOG_NOTICE, "Couldn't find auth '%s'. Cannot authenticate\n", name);
1804 void ast_sip_cleanup_auths(struct ast_sip_auth *auths[], size_t num_auths)
1807 for (i = 0; i < num_auths; ++i) {
1808 ao2_cleanup(auths[i]);
1812 struct ast_sorcery *ast_sip_get_sorcery(void)