res_pjsip: Apply outbound proxy to all SIP requests.
[asterisk/asterisk.git] / res / res_pjsip / location.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * Joshua Colp <jcolp@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 #include "asterisk.h"
20 #include "pjsip.h"
21 #include "pjlib.h"
22
23 #include "asterisk/res_pjsip.h"
24 #include "asterisk/logger.h"
25 #include "asterisk/astobj2.h"
26 #include "asterisk/sorcery.h"
27 #include "include/res_pjsip_private.h"
28
29 /*! \brief Destructor for AOR */
30 static void aor_destroy(void *obj)
31 {
32         struct ast_sip_aor *aor = obj;
33
34         ao2_cleanup(aor->permanent_contacts);
35         ast_string_field_free_memory(aor);
36 }
37
38 /*! \brief Allocator for AOR */
39 static void *aor_alloc(const char *name)
40 {
41         struct ast_sip_aor *aor = ast_sorcery_generic_alloc(sizeof(struct ast_sip_aor), aor_destroy);
42         if (!aor) {
43                 return NULL;
44         }
45         ast_string_field_init(aor, 128);
46         return aor;
47 }
48
49 /*! \brief Destructor for contact */
50 static void contact_destroy(void *obj)
51 {
52         struct ast_sip_contact *contact = obj;
53
54         ast_string_field_free_memory(contact);
55 }
56
57 /*! \brief Allocator for contact */
58 static void *contact_alloc(const char *name)
59 {
60         struct ast_sip_contact *contact = ast_sorcery_generic_alloc(sizeof(*contact), contact_destroy);
61
62         if (!contact) {
63                 return NULL;
64         }
65
66         if (ast_string_field_init(contact, 256)) {
67                 ao2_cleanup(contact);
68                 return NULL;
69         }
70
71         return contact;
72 }
73
74 struct ast_sip_aor *ast_sip_location_retrieve_aor(const char *aor_name)
75 {
76         return ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "aor", aor_name);
77 }
78
79 /*! \brief Internal callback function which deletes and unlinks any expired contacts */
80 static int contact_expire(void *obj, void *arg, int flags)
81 {
82         struct ast_sip_contact *contact = obj;
83
84         /* If the contact has not yet expired it is valid */
85         if (ast_tvdiff_ms(contact->expiration_time, ast_tvnow()) > 0) {
86                 return 0;
87         }
88
89         ast_sip_location_delete_contact(contact);
90
91         return CMP_MATCH;
92 }
93
94 /*! \brief Internal callback function which links static contacts into another container */
95 static int contact_link_static(void *obj, void *arg, int flags)
96 {
97         struct ao2_container *dest = arg;
98
99         ao2_link_flags(dest, obj, OBJ_NOLOCK);
100         return 0;
101 }
102
103 /*! \brief Simple callback function which returns immediately, used to grab the first contact of an AOR */
104 static int contact_find_first(void *obj, void *arg, int flags)
105 {
106         return CMP_MATCH | CMP_STOP;
107 }
108
109 struct ast_sip_contact *ast_sip_location_retrieve_first_aor_contact(const struct ast_sip_aor *aor)
110 {
111         RAII_VAR(struct ao2_container *, contacts, NULL, ao2_cleanup);
112         struct ast_sip_contact *contact;
113
114         contacts = ast_sip_location_retrieve_aor_contacts(aor);
115         if (!contacts || (ao2_container_count(contacts) == 0)) {
116                 return NULL;
117         }
118
119         contact = ao2_callback(contacts, OBJ_NOLOCK, contact_find_first, NULL);
120         return contact;
121 }
122
123 struct ao2_container *ast_sip_location_retrieve_aor_contacts(const struct ast_sip_aor *aor)
124 {
125         /* Give enough space for ^ at the beginning and ;@ at the end, since that is our object naming scheme */
126         char regex[strlen(ast_sorcery_object_get_id(aor)) + 4];
127         struct ao2_container *contacts;
128
129         snprintf(regex, sizeof(regex), "^%s;@", ast_sorcery_object_get_id(aor));
130
131         if (!(contacts = ast_sorcery_retrieve_by_regex(ast_sip_get_sorcery(), "contact", regex))) {
132                 return NULL;
133         }
134
135         /* Prune any expired contacts and delete them, we do this first because static contacts can never expire */
136         ao2_callback(contacts, OBJ_NOLOCK | OBJ_NODATA | OBJ_MULTIPLE | OBJ_UNLINK, contact_expire, NULL);
137
138         /* Add any permanent contacts from the AOR */
139         if (aor->permanent_contacts) {
140                 ao2_callback(aor->permanent_contacts, OBJ_NOLOCK | OBJ_NODATA, contact_link_static, contacts);
141         }
142
143         return contacts;
144 }
145
146 struct ast_sip_contact *ast_sip_location_retrieve_contact_from_aor_list(const char *aor_list)
147 {
148         char *aor_name;
149         char *rest;
150         struct ast_sip_contact *contact = NULL;
151
152         /* If the location is still empty we have nowhere to go */
153         if (ast_strlen_zero(aor_list) || !(rest = ast_strdupa(aor_list))) {
154                 ast_log(LOG_WARNING, "Unable to determine contacts from empty aor list\n");
155                 return NULL;
156         }
157
158         while ((aor_name = strsep(&rest, ","))) {
159                 RAII_VAR(struct ast_sip_aor *, aor, ast_sip_location_retrieve_aor(aor_name), ao2_cleanup);
160                 RAII_VAR(struct ao2_container *, contacts, NULL, ao2_cleanup);
161
162                 if (!aor) {
163                         continue;
164                 }
165                 contact = ast_sip_location_retrieve_first_aor_contact(aor);
166                 /* If a valid contact is available use its URI for dialing */
167                 if (contact) {
168                         break;
169                 }
170         }
171
172         return contact;
173 }
174
175 struct ast_sip_contact *ast_sip_location_retrieve_contact(const char *contact_name)
176 {
177         return ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "contact", contact_name);
178 }
179
180 int ast_sip_location_add_contact(struct ast_sip_aor *aor, const char *uri, struct timeval expiration_time)
181 {
182         char name[AST_UUID_STR_LEN];
183         RAII_VAR(struct ast_sip_contact *, contact, NULL, ao2_cleanup);
184
185         snprintf(name, sizeof(name), "%s;@%s", ast_sorcery_object_get_id(aor), uri);
186
187         if (!(contact = ast_sorcery_alloc(ast_sip_get_sorcery(), "contact", name))) {
188                 return -1;
189         }
190
191         ast_string_field_set(contact, uri, uri);
192         contact->expiration_time = expiration_time;
193         contact->qualify_frequency = aor->qualify_frequency;
194         contact->authenticate_qualify = aor->authenticate_qualify;
195
196         if (!ast_strlen_zero(aor->outbound_proxy)) {
197                 ast_string_field_set(contact, outbound_proxy, aor->outbound_proxy);
198         }
199
200         return ast_sorcery_create(ast_sip_get_sorcery(), contact);
201 }
202
203 int ast_sip_location_update_contact(struct ast_sip_contact *contact)
204 {
205         return ast_sorcery_update(ast_sip_get_sorcery(), contact);
206 }
207
208 int ast_sip_location_delete_contact(struct ast_sip_contact *contact)
209 {
210         return ast_sorcery_delete(ast_sip_get_sorcery(), contact);
211 }
212
213 /*! \brief Custom handler for translating from a string timeval to actual structure */
214 static int expiration_str2struct(const struct aco_option *opt, struct ast_variable *var, void *obj)
215 {
216         struct ast_sip_contact *contact = obj;
217         return ast_get_timeval(var->value, &contact->expiration_time, ast_tv(0, 0), NULL);
218 }
219
220 /*! \brief Custom handler for translating from an actual structure timeval to string */
221 static int expiration_struct2str(const void *obj, const intptr_t *args, char **buf)
222 {
223         const struct ast_sip_contact *contact = obj;
224         return (ast_asprintf(buf, "%lu", contact->expiration_time.tv_sec) < 0) ? -1 : 0;
225 }
226
227 /*! \brief Custom handler for permanent URIs */
228 static int permanent_uri_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
229 {
230         struct ast_sip_aor *aor = obj;
231         RAII_VAR(struct ast_sip_contact *, contact, NULL, ao2_cleanup);
232         pj_pool_t *pool;
233         pj_str_t contact_uri;
234         static const pj_str_t HCONTACT = { "Contact", 7 };
235
236         pool = pjsip_endpt_create_pool(ast_sip_get_pjsip_endpoint(), "Permanent Contact Validation", 256, 256);
237         if (!pool) {
238                 return -1;
239         }
240
241         pj_strdup2_with_null(pool, &contact_uri, var->value);
242         if (!pjsip_parse_hdr(pool, &HCONTACT, contact_uri.ptr, contact_uri.slen, NULL)) {
243                 ast_log(LOG_ERROR, "Permanent URI on aor '%s' with contact '%s' failed to parse\n",
244                         ast_sorcery_object_get_id(aor), var->value);
245                 pjsip_endpt_release_pool(ast_sip_get_pjsip_endpoint(), pool);
246                 return -1;
247         }
248
249         pjsip_endpt_release_pool(ast_sip_get_pjsip_endpoint(), pool);
250
251         if ((!aor->permanent_contacts && !(aor->permanent_contacts = ao2_container_alloc_options(AO2_ALLOC_OPT_LOCK_NOLOCK, 1, NULL, NULL))) ||
252                 !(contact = ast_sorcery_alloc(ast_sip_get_sorcery(), "contact", NULL))) {
253                 return -1;
254         }
255
256         ast_string_field_set(contact, uri, var->value);
257         ao2_link_flags(aor->permanent_contacts, contact, OBJ_NOLOCK);
258
259         return 0;
260 }
261
262 int ast_sip_for_each_aor(const char *aors, ao2_callback_fn on_aor, void *arg)
263 {
264         char *copy, *name;
265
266         if (!on_aor || ast_strlen_zero(aors)) {
267                 return 0;
268         }
269
270         copy = ast_strdupa(aors);
271         while ((name = strsep(&copy, ","))) {
272                 RAII_VAR(struct ast_sip_aor *, aor,
273                          ast_sip_location_retrieve_aor(name), ao2_cleanup);
274
275                 if (!aor) {
276                         continue;
277                 }
278
279                 if (on_aor(aor, arg, 0)) {
280                         return -1;
281                 }
282         }
283         ast_free(copy);
284         return 0;
285 }
286
287 int ast_sip_for_each_contact(const struct ast_sip_aor *aor,
288                              on_contact_t on_contact, void *arg)
289 {
290         RAII_VAR(struct ao2_container *, contacts, NULL, ao2_cleanup);
291         struct ast_sip_contact *contact;
292         int num;
293         struct ao2_iterator i;
294
295         if (!on_contact ||
296             !(contacts = ast_sip_location_retrieve_aor_contacts(aor))) {
297                 return 0;
298         }
299
300         num = ao2_container_count(contacts);
301         i = ao2_iterator_init(contacts, 0);
302         while ((contact = ao2_iterator_next(&i))) {
303                 int res = on_contact(aor, contact, --num == 0, arg);
304
305                 ao2_ref(contact, -1);
306                 if (res) {
307                         return -1;
308                 }
309         }
310         ao2_iterator_destroy(&i);
311         return 0;
312 }
313
314 int ast_sip_contact_to_str(const struct ast_sip_aor *aor,
315                            const struct ast_sip_contact *contact,
316                            int last, void *arg)
317 {
318         struct ast_str **buf = arg;
319
320         ast_str_append(buf, 0, "%s/%s",
321                        ast_sorcery_object_get_id(aor), contact->uri);
322
323         if (!last) {
324                 ast_str_append(buf, 0, ",");
325         }
326
327         return 0;
328 }
329
330 static int sip_aor_to_ami(const struct ast_sip_aor *aor, struct ast_str **buf)
331 {
332         return ast_sip_sorcery_object_to_ami(aor, buf);
333 }
334
335 static int format_ami_aor_handler(void *obj, void *arg, int flags)
336 {
337         const struct ast_sip_aor *aor = obj;
338         struct ast_sip_ami *ami = arg;
339         const struct ast_sip_endpoint *endpoint = ami->arg;
340         RAII_VAR(struct ast_str *, buf,
341                  ast_sip_create_ami_event("AorDetail", ami), ast_free);
342
343         int num;
344         RAII_VAR(struct ao2_container *, contacts,
345                  ast_sip_location_retrieve_aor_contacts(aor), ao2_cleanup);
346
347         if (!buf) {
348                 return -1;
349         }
350
351         sip_aor_to_ami(aor, &buf);
352         ast_str_append(&buf, 0, "Contacts: ");
353         ast_sip_for_each_contact(aor, ast_sip_contact_to_str, &buf);
354         ast_str_append(&buf, 0, "\r\n");
355
356         num = ao2_container_count(contacts);
357         ast_str_append(&buf, 0, "TotalContacts: %d\r\n", num);
358         ast_str_append(&buf, 0, "ContactsRegistered: %d\r\n",
359                        num - ao2_container_count(aor->permanent_contacts));
360         ast_str_append(&buf, 0, "EndpointName: %s\r\n",
361                        ast_sorcery_object_get_id(endpoint));
362
363         astman_append(ami->s, "%s\r\n", ast_str_buffer(buf));
364         return 0;
365 }
366
367 static int format_ami_endpoint_aor(const struct ast_sip_endpoint *endpoint,
368                                    struct ast_sip_ami *ami)
369 {
370         ami->arg = (void *)endpoint;
371         return ast_sip_for_each_aor(endpoint->aors,
372                                     format_ami_aor_handler, ami);
373 }
374
375 struct ast_sip_endpoint_formatter endpoint_aor_formatter = {
376         .format_ami = format_ami_endpoint_aor
377 };
378
379 /*! \brief Initialize sorcery with location support */
380 int ast_sip_initialize_sorcery_location(struct ast_sorcery *sorcery)
381 {
382         ast_sorcery_apply_default(sorcery, "contact", "astdb", "registrar");
383         ast_sorcery_apply_default(sorcery, "aor", "config", "pjsip.conf,criteria=type=aor");
384
385         if (ast_sorcery_object_register(sorcery, "contact", contact_alloc, NULL, NULL) ||
386                 ast_sorcery_object_register(sorcery, "aor", aor_alloc, NULL, NULL)) {
387                 return -1;
388         }
389
390         ast_sorcery_object_field_register(sorcery, "contact", "type", "", OPT_NOOP_T, 0, 0);
391         ast_sorcery_object_field_register(sorcery, "contact", "uri", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, uri));
392         ast_sorcery_object_field_register_custom(sorcery, "contact", "expiration_time", "", expiration_str2struct, expiration_struct2str, 0, 0);
393         ast_sorcery_object_field_register(sorcery, "contact", "qualify_frequency", 0, OPT_UINT_T,
394                                           PARSE_IN_RANGE, FLDSET(struct ast_sip_contact, qualify_frequency), 0, 86400);
395         ast_sorcery_object_field_register(sorcery, "contact", "outbound_proxy", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, outbound_proxy));
396
397         ast_sorcery_object_field_register(sorcery, "aor", "type", "", OPT_NOOP_T, 0, 0);
398         ast_sorcery_object_field_register(sorcery, "aor", "minimum_expiration", "60", OPT_UINT_T, 0, FLDSET(struct ast_sip_aor, minimum_expiration));
399         ast_sorcery_object_field_register(sorcery, "aor", "maximum_expiration", "7200", OPT_UINT_T, 0, FLDSET(struct ast_sip_aor, maximum_expiration));
400         ast_sorcery_object_field_register(sorcery, "aor", "default_expiration", "3600", OPT_UINT_T, 0, FLDSET(struct ast_sip_aor, default_expiration));
401         ast_sorcery_object_field_register(sorcery, "aor", "qualify_frequency", 0, OPT_UINT_T, PARSE_IN_RANGE, FLDSET(struct ast_sip_aor, qualify_frequency), 0, 86400);
402         ast_sorcery_object_field_register(sorcery, "aor", "authenticate_qualify", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_aor, authenticate_qualify));
403         ast_sorcery_object_field_register(sorcery, "aor", "max_contacts", "0", OPT_UINT_T, 0, FLDSET(struct ast_sip_aor, max_contacts));
404         ast_sorcery_object_field_register(sorcery, "aor", "remove_existing", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_aor, remove_existing));
405         ast_sorcery_object_field_register_custom(sorcery, "aor", "contact", "", permanent_uri_handler, NULL, 0, 0);
406         ast_sorcery_object_field_register(sorcery, "aor", "mailboxes", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_aor, mailboxes));
407         ast_sorcery_object_field_register(sorcery, "aor", "outbound_proxy", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_aor, outbound_proxy));
408
409         ast_sip_register_endpoint_formatter(&endpoint_aor_formatter);
410         return 0;
411 }
412