fb58f2bbe15b8bcc5900ee55511bdb4176e6b2b5
[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         if (!pjsip_log_test_addr(tdata->tp_info.dst_name, tdata->tp_info.dst_port)) {
78                 return PJ_SUCCESS;
79         }
80
81         ast_verbose("<--- Transmitting SIP %s (%d bytes) to %s:%s:%d --->\n%.*s\n",
82                     tdata->msg->type == PJSIP_REQUEST_MSG ? "request" : "response",
83                     (int) (tdata->buf.cur - tdata->buf.start),
84                     tdata->tp_info.transport->type_name,
85                     tdata->tp_info.dst_name,
86                     tdata->tp_info.dst_port,
87                     (int) (tdata->buf.end - tdata->buf.start), tdata->buf.start);
88         return PJ_SUCCESS;
89 }
90
91 static pj_bool_t logging_on_rx_msg(pjsip_rx_data *rdata)
92 {
93         if (!pjsip_log_test_addr(rdata->pkt_info.src_name, rdata->pkt_info.src_port)) {
94                 return PJ_FALSE;
95         }
96
97         if (!rdata->msg_info.msg) {
98                 return PJ_FALSE;
99         }
100
101         ast_verbose("<--- Received SIP %s (%d bytes) from %s:%s:%d --->\n%s\n",
102                     rdata->msg_info.msg->type == PJSIP_REQUEST_MSG ? "request" : "response",
103                     rdata->msg_info.len,
104                     rdata->tp_info.transport->type_name,
105                     rdata->pkt_info.src_name,
106                     rdata->pkt_info.src_port,
107                     rdata->pkt_info.packet);
108         return PJ_FALSE;
109 }
110
111 static pjsip_module logging_module = {
112         .name = { "Logging Module", 14 },
113         .priority = 0,
114         .on_rx_request = logging_on_rx_msg,
115         .on_rx_response = logging_on_rx_msg,
116         .on_tx_request = logging_on_tx_msg,
117         .on_tx_response = logging_on_tx_msg,
118 };
119
120 static char *pjsip_enable_logger_host(int fd, const char *arg)
121 {
122         if (ast_sockaddr_resolve_first_af(&log_addr, arg, 0, AST_AF_UNSPEC)) {
123                 return CLI_SHOWUSAGE;
124         }
125
126         ast_cli(fd, "PJSIP Logging Enabled for host: %s\n", ast_sockaddr_stringify_addr(&log_addr));
127         logging_mode = LOGGING_MODE_ENABLED;
128
129         return CLI_SUCCESS;
130 }
131
132 static char *pjsip_set_logger(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
133 {
134         const char *what;
135
136         if (cmd == CLI_INIT) {
137                 e->command = "pjsip set logger {on|off|host}";
138                 e->usage =
139                         "Usage: pjsip set logger {on|off|host <name>}\n"
140                         "       Enables or disabling logging of SIP packets\n"
141                         "       read on ports bound to PJSIP transports either\n"
142                         "       globally or enables logging for an individual\n"
143                         "       host.\n";
144                 return NULL;
145         } else if (cmd == CLI_GENERATE) {
146                 return NULL;
147         }
148
149         what = a->argv[e->args - 1];     /* Guaranteed to exist */
150
151         if (a->argc == e->args) {        /* on/off */
152                 if (!strcasecmp(what, "on")) {
153                         logging_mode = LOGGING_MODE_ENABLED;
154                         ast_cli(a->fd, "PJSIP Logging enabled\n");
155                         ast_sockaddr_setnull(&log_addr);
156                         return CLI_SUCCESS;
157                 } else if (!strcasecmp(what, "off")) {
158                         logging_mode = LOGGING_MODE_DISABLED;
159                         ast_cli(a->fd, "PJSIP Logging disabled\n");
160                         return CLI_SUCCESS;
161                 }
162         } else if (a->argc == e->args + 1) {
163                 if (!strcasecmp(what, "host")) {
164                         return pjsip_enable_logger_host(a->fd, a->argv[e->args]);
165                 }
166         }
167
168         return CLI_SHOWUSAGE;
169 }
170
171 static struct ast_cli_entry cli_pjsip[] = {
172         AST_CLI_DEFINE(pjsip_set_logger, "Enable/Disable PJSIP Logger Output")
173 };
174
175 static void check_debug(void)
176 {
177         RAII_VAR(char *, debug, ast_sip_get_debug(), ast_free);
178
179         if (ast_false(debug)) {
180                 logging_mode = LOGGING_MODE_DISABLED;
181                 return;
182         }
183
184         logging_mode = LOGGING_MODE_ENABLED;
185
186         if (ast_true(debug)) {
187                 ast_sockaddr_setnull(&log_addr);
188                 return;
189         }
190
191         /* assume host */
192         if (ast_sockaddr_resolve_first_af(&log_addr, debug, 0, AST_AF_UNSPEC)) {
193                 ast_log(LOG_WARNING, "Could not resolve host %s for debug "
194                         "logging\n", debug);
195         }
196 }
197
198 static void global_reloaded(const char *object_type)
199 {
200         check_debug();
201 }
202
203 static const struct ast_sorcery_observer global_observer = {
204         .loaded = global_reloaded
205 };
206
207 static int load_module(void)
208 {
209         if (ast_sorcery_observer_add(ast_sip_get_sorcery(), "global", &global_observer)) {
210                 ast_log(LOG_WARNING, "Unable to add global observer\n");
211                 return AST_MODULE_LOAD_DECLINE;
212         }
213
214         check_debug();
215
216         ast_sip_register_service(&logging_module);
217         ast_cli_register_multiple(cli_pjsip, ARRAY_LEN(cli_pjsip));
218
219         return AST_MODULE_LOAD_SUCCESS;
220 }
221
222 static int unload_module(void)
223 {
224         ast_cli_unregister_multiple(cli_pjsip, ARRAY_LEN(cli_pjsip));
225         ast_sip_unregister_service(&logging_module);
226
227         ast_sorcery_observer_remove(
228                 ast_sip_get_sorcery(), "global", &global_observer);
229
230         return 0;
231 }
232
233 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "PJSIP Packet Logger",
234         .support_level = AST_MODULE_SUPPORT_CORE,
235         .load = load_module,
236         .unload = unload_module,
237         .load_pri = AST_MODPRI_APP_DEPEND,
238         .requires = "res_pjsip",
239 );