res_resolver_unbound: Fix config documentation.
[asterisk/asterisk.git] / res / res_pjsip_phoneprov_provider.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2014, Fairview 5 Engineering, LLC
5  *
6  * George Joseph <george.joseph@fairview5.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 /*! \file
20  *
21  * \brief PJSIP Phoneprov Configuration Provider
22  *
23  * \author George Joseph <george.joseph@fairview5.com>
24   */
25
26 /*! \li \ref res_pjsip_phoneprov_provider.c uses the configuration file \ref pjsip.conf
27  * \addtogroup configuration_file Configuration Files
28  */
29
30 /*!
31  * \page pjsip.conf pjsip.conf
32  * \verbinclude pjsip.conf.sample
33  */
34
35 /*** MODULEINFO
36         <depend>pjproject</depend>
37         <depend>res_pjsip</depend>
38         <depend>res_phoneprov</depend>
39         <support_level>extended</support_level>
40  ***/
41
42 #include "asterisk.h"
43
44 #include <pjsip.h>
45
46 #include "asterisk/res_pjsip.h"
47 #include "asterisk/module.h"
48 #include "asterisk/sorcery.h"
49 #include "asterisk/phoneprov.h"
50 #include "res_pjsip/include/res_pjsip_private.h"
51
52 /*** DOCUMENTATION
53         <configInfo name="res_pjsip_phoneprov_provider" language="en_US">
54                 <synopsis>Module that integrates res_pjsip with res_phoneprov.</synopsis>
55                 <description><para>
56                         <emphasis>PJSIP Phoneprov Provider</emphasis>
57                         </para>
58                         <para>This module creates the integration between <literal>res_pjsip</literal> and
59                         <literal>res_phoneprov</literal>.
60                         </para>
61                         <para>Each user to be integrated requires a <literal>phoneprov</literal>
62                         section defined in <filename>pjsip.conf</filename>.  Each section identifies
63                         the endpoint associated with the user and any other name/value pairs to be passed
64                         on to res_phoneprov's template substitution.  Only <literal>MAC</literal> and
65                         <literal>PROFILE</literal> variables are required.  Any other variables
66                         supplied will be passed through.</para>
67                         <para> </para>
68                         <para>Example:</para>
69                         <para>[1000]</para>
70                         <para>type = phoneprovr</para>
71                         <para>endpoint = ep1000</para>
72                         <para>MAC = deadbeef4dad</para>
73                         <para>PROFILE = grandstream2</para>
74                         <para>LINEKEYS = 2</para>
75                         <para>LINE = 1</para>
76                         <para>OTHERVAR = othervalue</para>
77                         <para> </para>
78                         <para>The following variables are automatically defined if an endpoint
79                         is defined for the user:</para>
80                         <enumlist>
81                                 <enum name="USERNAME"><para>Source: The user_name defined in the first auth reference
82                                 in the endpoint.</para></enum>
83                                 <enum name="SECRET"><para>Source: The user_pass defined in the first auth reference
84                                 in the endpoint.</para></enum>
85                                 <enum name="CALLERID"><para>Source: The number part of the callerid defined in
86                                 the endpoint.</para></enum>
87                                 <enum name="DISPLAY_NAME"><para>Source: The name part of the callerid defined in
88                                 the endpoint.</para></enum>
89                                 <enum name="LABEL"><para>Source: The id of the phoneprov section.</para></enum>
90                         </enumlist>
91                         <para> </para>
92                         <para>In addition to the standard variables, the following are also automatically defined:</para>
93                         <enumlist>
94                                 <enum name="ENDPOINT_ID"><para>Source: The id of the endpoint.</para></enum>
95                                 <enum name="TRANSPORT_ID"><para>Source: The id of the transport used by the endpoint.</para></enum>
96                                 <enum name="AUTH_ID"><para>Source: The id of the auth used by the endpoint.</para></enum>
97                         </enumlist>
98                         <para> </para>
99                         <para>All other template substitution variables must be explicitly defined in the
100                         phoneprov_default or phoneprov sections.</para>
101                 </description>
102
103                 <configFile name="pjsip.conf">
104                         <configObject name="phoneprov">
105                                 <synopsis>Provides variables for each user.</synopsis>
106                                 <configOption name="type">
107                                         <synopsis>Must be of type 'phoneprov'.</synopsis>
108                                 </configOption>
109                                 <configOption name="endpoint">
110                                         <synopsis>The endpoint from which variables will be retrieved.</synopsis>
111                                 </configOption>
112                                 <configOption name="MAC">
113                                         <synopsis>The mac address for this user. (required)</synopsis>
114                                 </configOption>
115                                 <configOption name="PROFILE">
116                                         <synopsis>The phoneprov profile to use for this user. (required)</synopsis>
117                                 </configOption>
118                                 <configOption name="*">
119                                         <synopsis>Other name/value pairs to be passed through for use in templates.</synopsis>
120                                 </configOption>
121                         </configObject>
122                 </configFile>
123         </configInfo>
124  ***/
125
126 static struct ast_sorcery *sorcery;
127
128 /*! \brief Structure for a phoneprov object */
129 struct phoneprov {
130         SORCERY_OBJECT(details);
131         struct varshead *vars;
132 };
133
134 /*! \brief Destructor function for phoneprov */
135 static void phoneprov_destroy(void *obj)
136 {
137         struct phoneprov *pp = obj;
138         char *mac = ast_var_find(pp->vars, "MAC");
139
140         if (mac) {
141                 ast_phoneprov_delete_extension(AST_MODULE, mac);
142         }
143
144         ast_var_list_destroy(pp->vars);
145 }
146
147 /*! \brief Allocator for phoneprov */
148 static void *phoneprov_alloc(const char *name)
149 {
150         struct phoneprov *pp = ast_sorcery_generic_alloc(sizeof(*pp), phoneprov_destroy);
151
152         if (!pp || !(pp->vars = ast_var_list_create())) {
153                 ast_log(LOG_ERROR, "Unable to allocate memory for phoneprov structure %s\n",
154                         name);
155                 ao2_cleanup(pp);
156                 return NULL;
157         }
158
159         return pp;
160 }
161
162 /*! \brief Helper that creates an ast_var_t and inserts it into the list */
163 static int assign_and_insert(const char *name, const char *value, struct varshead *vars)
164 {
165         struct ast_var_t *var;
166
167         if (ast_strlen_zero(name) || !vars) {
168                 return -1;
169         }
170
171         /* Just ignore if the value is NULL or empty */
172         if (ast_strlen_zero(value)) {
173                 return 0;
174         }
175
176         var = ast_var_assign(name, value);
177         if (!var) {
178                 ast_log(LOG_ERROR, "Could not allocate variable memory for variable.\n");
179                 return -1;
180         }
181         AST_VAR_LIST_INSERT_TAIL(vars, var);
182
183         return 0;
184 }
185
186 /*! \brief Adds a config name/value pair to the phoneprov object */
187 static int aco_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
188 {
189         struct phoneprov *pp = obj;
190
191         return assign_and_insert(var->name, var->value, pp->vars);
192 }
193
194 /*! \brief Converts the phoneprov varlist to an ast_variable list */
195 static int fields_handler(const void *obj, struct ast_variable **fields)
196 {
197         const struct phoneprov *pp = obj;
198         struct ast_var_t *pvar;
199         struct ast_variable *head = NULL;
200         struct ast_variable *tail = NULL;
201         struct ast_variable *var;
202
203         AST_VAR_LIST_TRAVERSE(pp->vars, pvar) {
204                 var = ast_variable_new(pvar->name, pvar->value, "");
205                 if (!var) {
206                         ast_variables_destroy(head);
207                         return -1;
208                 }
209                 if (!head) {
210                         head = var;
211                         tail = var;
212                         continue;
213                 }
214                 tail->next = var;
215                 tail = var;
216         }
217
218         *fields = head;
219
220         return 0;
221 }
222
223 static int load_endpoint(const char *id, const char *endpoint_name, struct varshead *vars,
224         char *port_string)
225 {
226         struct ast_sip_auth *auth;
227         RAII_VAR(struct ast_sip_endpoint *, endpoint, NULL, ao2_cleanup);
228         RAII_VAR(struct ast_sip_transport *, transport, NULL, ao2_cleanup);
229         const char *auth_name;
230
231         *port_string = '\0';
232
233         /* We need to use res_pjsip's sorcery instance instead of our own to
234          * get endpoint and auth.
235          */
236         endpoint = ast_sorcery_retrieve_by_id(sorcery, "endpoint",
237                 endpoint_name);
238         if (!endpoint) {
239                 ast_log(LOG_ERROR, "phoneprov %s contained invalid endpoint %s.\n", id,
240                         endpoint_name);
241                 return -1;
242         }
243
244         assign_and_insert("ENDPOINT_ID", endpoint_name, vars);
245         assign_and_insert("TRANSPORT_ID", endpoint->transport, vars);
246
247         if (endpoint->id.self.number.valid && !ast_strlen_zero(endpoint->id.self.number.str)) {
248                 assign_and_insert(ast_phoneprov_std_variable_lookup(AST_PHONEPROV_STD_CALLERID),
249                         endpoint->id.self.number.str, vars);
250         }
251
252         if (endpoint->id.self.name.valid && !ast_strlen_zero(endpoint->id.self.name.str)) {
253                 assign_and_insert(
254                         ast_phoneprov_std_variable_lookup(AST_PHONEPROV_STD_DISPLAY_NAME),
255                         endpoint->id.self.name.str, vars);
256         }
257
258         transport = ast_sorcery_retrieve_by_id(sorcery, "transport",
259                 endpoint->transport);
260         if (!transport) {
261                 ast_log(LOG_ERROR, "Endpoint %s contained invalid transport %s.\n", endpoint_name,
262                         endpoint->transport);
263                 return -1;
264         }
265         snprintf(port_string, 6, "%d", pj_sockaddr_get_port(&transport->host));
266
267         if (!AST_VECTOR_SIZE(&endpoint->inbound_auths)) {
268                 return 0;
269         }
270         auth_name = AST_VECTOR_GET(&endpoint->inbound_auths, 0);
271
272         auth = ast_sorcery_retrieve_by_id(sorcery, "auth", auth_name);
273         if (!auth) {
274                 ast_log(LOG_ERROR, "phoneprov %s contained invalid auth %s.\n", id, auth_name);
275                 return -1;
276         }
277
278         assign_and_insert("AUTH_ID", auth_name, vars);
279         assign_and_insert(ast_phoneprov_std_variable_lookup(AST_PHONEPROV_STD_USERNAME),
280                 auth->auth_user, vars);
281         assign_and_insert(ast_phoneprov_std_variable_lookup(AST_PHONEPROV_STD_SECRET),
282                 auth->auth_pass, vars);
283         ao2_ref(auth, -1);
284
285         return 0;
286 }
287
288 /*! \brief Callback that validates the phoneprov object */
289 static void users_apply_handler(struct phoneprov *pp)
290 {
291         const char *id = ast_sorcery_object_get_id(pp);
292         const char *endpoint_name;
293         char port_string[6];
294
295         if (!ast_var_find(pp->vars,
296                 ast_phoneprov_std_variable_lookup(AST_PHONEPROV_STD_MAC))) {
297                 ast_log(LOG_ERROR, "phoneprov %s must contain a MAC entry.\n", id);
298                 return;
299         }
300
301         if (!ast_var_find(pp->vars,
302                 ast_phoneprov_std_variable_lookup(AST_PHONEPROV_STD_PROFILE))) {
303                 ast_log(LOG_ERROR, "phoneprov %s must contain a PROFILE entry.\n", id);
304                 return;
305         }
306
307         endpoint_name = ast_var_find(pp->vars, "endpoint");
308         if (endpoint_name) {
309                 if (load_endpoint(id, endpoint_name, pp->vars, port_string)) {
310                         return;
311                 }
312         }
313
314         if (!ast_var_find(pp->vars,
315                 ast_phoneprov_std_variable_lookup(AST_PHONEPROV_STD_USERNAME))) {
316                 assign_and_insert(
317                         ast_phoneprov_std_variable_lookup(AST_PHONEPROV_STD_USERNAME), id,
318                         pp->vars);
319         }
320
321         if (!ast_var_find(pp->vars,
322                 ast_phoneprov_std_variable_lookup(AST_PHONEPROV_STD_LABEL))) {
323                 assign_and_insert(ast_phoneprov_std_variable_lookup(AST_PHONEPROV_STD_LABEL),
324                         id, pp->vars);
325         }
326
327         if (!ast_var_find(pp->vars,
328                 ast_phoneprov_std_variable_lookup(AST_PHONEPROV_STD_SERVER_PORT))) {
329                 assign_and_insert("SERVER_PORT", S_OR(port_string, "5060"), pp->vars);
330         }
331
332         if (!ast_var_find(pp->vars,
333                 ast_phoneprov_std_variable_lookup(AST_PHONEPROV_STD_PROFILE))) {
334                 ast_log(LOG_ERROR, "phoneprov %s didn't contain a PROFILE entry.\n", id);
335         }
336
337         ast_phoneprov_add_extension(AST_MODULE, pp->vars);
338
339         return;
340 }
341
342 /*! \brief Callback that loads the users from phoneprov sections */
343 static int load_users(void)
344 {
345         struct ao2_container *users;
346         struct ao2_iterator i;
347         struct phoneprov *pp;
348
349         ast_sorcery_reload_object(sorcery, "phoneprov");
350
351         users = ast_sorcery_retrieve_by_fields(sorcery, "phoneprov",
352                 AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
353         if (!users) {
354                 return 0;
355         }
356
357         i = ao2_iterator_init(users, 0);
358         while ((pp = ao2_iterator_next(&i))) {
359                 users_apply_handler(pp);
360                 ao2_ref(pp, -1);
361         }
362         ao2_iterator_destroy(&i);
363         ao2_ref(users, -1);
364
365         return 0;
366 }
367
368 static int load_module(void)
369 {
370         CHECK_PJSIP_MODULE_LOADED();
371
372         sorcery = ast_sip_get_sorcery();
373
374         ast_sorcery_apply_config(sorcery, "res_pjsip_phoneprov_provider");
375         ast_sorcery_apply_default(sorcery, "phoneprov", "config",
376                 "pjsip.conf,criteria=type=phoneprov");
377
378         ast_sorcery_object_register(sorcery, "phoneprov", phoneprov_alloc, NULL,
379                 NULL);
380
381         ast_sorcery_object_field_register(sorcery, "phoneprov", "type", "", OPT_NOOP_T, 0,
382                 0);
383         ast_sorcery_object_fields_register(sorcery, "phoneprov", "^", aco_handler,
384                 fields_handler);
385
386         ast_sorcery_load_object(sorcery, "phoneprov");
387
388         if (ast_phoneprov_provider_register(AST_MODULE, load_users)) {
389                 ast_log(LOG_ERROR, "Unable to register pjsip phoneprov provider.\n");
390                 return AST_MODULE_LOAD_DECLINE;
391         }
392
393         return AST_MODULE_LOAD_SUCCESS;
394 }
395
396 static int unload_module(void)
397 {
398         ast_phoneprov_provider_unregister(AST_MODULE);
399
400         return 0;
401 }
402
403 static int reload_module(void)
404 {
405         ast_phoneprov_provider_unregister(AST_MODULE);
406
407         if (ast_phoneprov_provider_register(AST_MODULE, load_users)) {
408                 ast_log(LOG_ERROR, "Unable to register pjsip phoneprov provider.\n");
409                 return AST_MODULE_LOAD_DECLINE;
410         }
411
412         return 0;
413 }
414
415 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "PJSIP Phoneprov Provider",
416         .load = load_module,
417         .reload = reload_module,
418         .unload = unload_module,
419         .load_pri = AST_MODPRI_APP_DEPEND,
420 );