Merge "res_pjsip: Add XML documentation for "use_callerid_contact""
[asterisk/asterisk.git] / res / res_pjsip_logger.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * Mark Michelson <mmichelson@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 /*** MODULEINFO
20         <depend>pjproject</depend>
21         <depend>res_pjsip</depend>
22         <defaultenabled>yes</defaultenabled>
23         <support_level>core</support_level>
24  ***/
25
26 #include "asterisk.h"
27
28 #include <pjsip.h>
29
30 #include "asterisk/res_pjsip.h"
31 #include "asterisk/module.h"
32 #include "asterisk/logger.h"
33 #include "asterisk/cli.h"
34 #include "asterisk/netsock2.h"
35
36 enum pjsip_logging_mode {
37         LOGGING_MODE_DISABLED,    /* No logging is enabled */
38         LOGGING_MODE_ENABLED,     /* Logging is enabled */
39 };
40
41 static enum pjsip_logging_mode logging_mode;
42 static struct ast_sockaddr log_addr;
43
44 /*! \brief See if we pass debug IP filter */
45 static inline int pjsip_log_test_addr(const char *address, int port)
46 {
47         struct ast_sockaddr test_addr;
48         if (logging_mode == LOGGING_MODE_DISABLED) {
49                 return 0;
50         }
51
52         /* A null logging address means we'll debug any address */
53         if (ast_sockaddr_isnull(&log_addr)) {
54                 return 1;
55         }
56
57         /* A null address was passed in. Just reject it. */
58         if (ast_strlen_zero(address)) {
59                 return 0;
60         }
61
62         ast_sockaddr_parse(&test_addr, address, PARSE_PORT_IGNORE);
63         ast_sockaddr_set_port(&test_addr, port);
64
65         /* If no port was specified for a debug address, just compare the
66          * addresses, otherwise compare the address and port
67          */
68         if (ast_sockaddr_port(&log_addr)) {
69                 return !ast_sockaddr_cmp(&log_addr, &test_addr);
70         } else {
71                 return !ast_sockaddr_cmp_addr(&log_addr, &test_addr);
72         }
73 }
74
75 static pj_status_t logging_on_tx_msg(pjsip_tx_data *tdata)
76 {
77         char buffer[AST_SOCKADDR_BUFLEN];
78
79         if (!pjsip_log_test_addr(tdata->tp_info.dst_name, tdata->tp_info.dst_port)) {
80                 return PJ_SUCCESS;
81         }
82
83         ast_verbose("<--- Transmitting SIP %s (%d bytes) to %s:%s --->\n%.*s\n",
84                     tdata->msg->type == PJSIP_REQUEST_MSG ? "request" : "response",
85                     (int) (tdata->buf.cur - tdata->buf.start),
86                     tdata->tp_info.transport->type_name,
87                     pj_sockaddr_print(&tdata->tp_info.dst_addr, buffer, sizeof(buffer), 3),
88                     (int) (tdata->buf.end - tdata->buf.start), tdata->buf.start);
89         return PJ_SUCCESS;
90 }
91
92 static pj_bool_t logging_on_rx_msg(pjsip_rx_data *rdata)
93 {
94         char buffer[AST_SOCKADDR_BUFLEN];
95
96         if (!pjsip_log_test_addr(rdata->pkt_info.src_name, rdata->pkt_info.src_port)) {
97                 return PJ_FALSE;
98         }
99
100         if (!rdata->msg_info.msg) {
101                 return PJ_FALSE;
102         }
103
104         ast_verbose("<--- Received SIP %s (%d bytes) from %s:%s --->\n%s\n",
105                     rdata->msg_info.msg->type == PJSIP_REQUEST_MSG ? "request" : "response",
106                     rdata->msg_info.len,
107                     rdata->tp_info.transport->type_name,
108                     pj_sockaddr_print(&rdata->pkt_info.src_addr, buffer, sizeof(buffer), 3),
109                     rdata->pkt_info.packet);
110         return PJ_FALSE;
111 }
112
113 static pjsip_module logging_module = {
114         .name = { "Logging Module", 14 },
115         .priority = 0,
116         .on_rx_request = logging_on_rx_msg,
117         .on_rx_response = logging_on_rx_msg,
118         .on_tx_request = logging_on_tx_msg,
119         .on_tx_response = logging_on_tx_msg,
120 };
121
122 static char *pjsip_enable_logger_host(int fd, const char *arg)
123 {
124         if (ast_sockaddr_resolve_first_af(&log_addr, arg, 0, AST_AF_UNSPEC)) {
125                 return CLI_SHOWUSAGE;
126         }
127
128         ast_cli(fd, "PJSIP Logging Enabled for host: %s\n", ast_sockaddr_stringify_addr(&log_addr));
129         logging_mode = LOGGING_MODE_ENABLED;
130
131         return CLI_SUCCESS;
132 }
133
134 static char *pjsip_set_logger(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
135 {
136         const char *what;
137
138         if (cmd == CLI_INIT) {
139                 e->command = "pjsip set logger {on|off|host}";
140                 e->usage =
141                         "Usage: pjsip set logger {on|off|host <name>}\n"
142                         "       Enables or disabling logging of SIP packets\n"
143                         "       read on ports bound to PJSIP transports either\n"
144                         "       globally or enables logging for an individual\n"
145                         "       host.\n";
146                 return NULL;
147         } else if (cmd == CLI_GENERATE) {
148                 return NULL;
149         }
150
151         what = a->argv[e->args - 1];     /* Guaranteed to exist */
152
153         if (a->argc == e->args) {        /* on/off */
154                 if (!strcasecmp(what, "on")) {
155                         logging_mode = LOGGING_MODE_ENABLED;
156                         ast_cli(a->fd, "PJSIP Logging enabled\n");
157                         ast_sockaddr_setnull(&log_addr);
158                         return CLI_SUCCESS;
159                 } else if (!strcasecmp(what, "off")) {
160                         logging_mode = LOGGING_MODE_DISABLED;
161                         ast_cli(a->fd, "PJSIP Logging disabled\n");
162                         return CLI_SUCCESS;
163                 }
164         } else if (a->argc == e->args + 1) {
165                 if (!strcasecmp(what, "host")) {
166                         return pjsip_enable_logger_host(a->fd, a->argv[e->args]);
167                 }
168         }
169
170         return CLI_SHOWUSAGE;
171 }
172
173 static struct ast_cli_entry cli_pjsip[] = {
174         AST_CLI_DEFINE(pjsip_set_logger, "Enable/Disable PJSIP Logger Output")
175 };
176
177 static void check_debug(void)
178 {
179         RAII_VAR(char *, debug, ast_sip_get_debug(), ast_free);
180
181         if (ast_false(debug)) {
182                 logging_mode = LOGGING_MODE_DISABLED;
183                 return;
184         }
185
186         logging_mode = LOGGING_MODE_ENABLED;
187
188         if (ast_true(debug)) {
189                 ast_sockaddr_setnull(&log_addr);
190                 return;
191         }
192
193         /* assume host */
194         if (ast_sockaddr_resolve_first_af(&log_addr, debug, 0, AST_AF_UNSPEC)) {
195                 ast_log(LOG_WARNING, "Could not resolve host %s for debug "
196                         "logging\n", debug);
197         }
198 }
199
200 static void global_reloaded(const char *object_type)
201 {
202         check_debug();
203 }
204
205 static const struct ast_sorcery_observer global_observer = {
206         .loaded = global_reloaded
207 };
208
209 static int load_module(void)
210 {
211         if (ast_sorcery_observer_add(ast_sip_get_sorcery(), "global", &global_observer)) {
212                 ast_log(LOG_WARNING, "Unable to add global observer\n");
213                 return AST_MODULE_LOAD_DECLINE;
214         }
215
216         check_debug();
217
218         ast_sip_register_service(&logging_module);
219         ast_cli_register_multiple(cli_pjsip, ARRAY_LEN(cli_pjsip));
220
221         return AST_MODULE_LOAD_SUCCESS;
222 }
223
224 static int unload_module(void)
225 {
226         ast_cli_unregister_multiple(cli_pjsip, ARRAY_LEN(cli_pjsip));
227         ast_sip_unregister_service(&logging_module);
228
229         ast_sorcery_observer_remove(
230                 ast_sip_get_sorcery(), "global", &global_observer);
231
232         return 0;
233 }
234
235 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "PJSIP Packet Logger",
236         .support_level = AST_MODULE_SUPPORT_CORE,
237         .load = load_module,
238         .unload = unload_module,
239         .load_pri = AST_MODPRI_APP_DEPEND,
240         .requires = "res_pjsip",
241 );