res_srtp: Add support for libsrtp2.1.
[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  Return the first entry from ast_sockaddr_resolve filtered by address family
45  *
46  * \warning Using this function probably means you have a faulty design.
47  * \note This function was taken from the function of the same name in chan_sip.c
48  */
49 static int ast_sockaddr_resolve_first_af(struct ast_sockaddr *addr,
50                                       const char* name, int flag, int family)
51 {
52         struct ast_sockaddr *addrs;
53         int addrs_cnt;
54
55         addrs_cnt = ast_sockaddr_resolve(&addrs, name, flag, family);
56         if (addrs_cnt <= 0) {
57                 return 1;
58         }
59         if (addrs_cnt > 1) {
60                 ast_debug(1, "Multiple addresses, using the first one only\n");
61         }
62
63         ast_sockaddr_copy(addr, &addrs[0]);
64
65         ast_free(addrs);
66         return 0;
67 }
68
69 /*! \brief See if we pass debug IP filter */
70 static inline int pjsip_log_test_addr(const char *address, int port)
71 {
72         struct ast_sockaddr test_addr;
73         if (logging_mode == LOGGING_MODE_DISABLED) {
74                 return 0;
75         }
76
77         /* A null logging address means we'll debug any address */
78         if (ast_sockaddr_isnull(&log_addr)) {
79                 return 1;
80         }
81
82         /* A null address was passed in. Just reject it. */
83         if (ast_strlen_zero(address)) {
84                 return 0;
85         }
86
87         ast_sockaddr_parse(&test_addr, address, PARSE_PORT_IGNORE);
88         ast_sockaddr_set_port(&test_addr, port);
89
90         /* If no port was specified for a debug address, just compare the
91          * addresses, otherwise compare the address and port
92          */
93         if (ast_sockaddr_port(&log_addr)) {
94                 return !ast_sockaddr_cmp(&log_addr, &test_addr);
95         } else {
96                 return !ast_sockaddr_cmp_addr(&log_addr, &test_addr);
97         }
98 }
99
100 static pj_status_t logging_on_tx_msg(pjsip_tx_data *tdata)
101 {
102         if (!pjsip_log_test_addr(tdata->tp_info.dst_name, tdata->tp_info.dst_port)) {
103                 return PJ_SUCCESS;
104         }
105
106         ast_verbose("<--- Transmitting SIP %s (%d bytes) to %s:%s:%d --->\n%.*s\n",
107                     tdata->msg->type == PJSIP_REQUEST_MSG ? "request" : "response",
108                     (int) (tdata->buf.cur - tdata->buf.start),
109                     tdata->tp_info.transport->type_name,
110                     tdata->tp_info.dst_name,
111                     tdata->tp_info.dst_port,
112                     (int) (tdata->buf.end - tdata->buf.start), tdata->buf.start);
113         return PJ_SUCCESS;
114 }
115
116 static pj_bool_t logging_on_rx_msg(pjsip_rx_data *rdata)
117 {
118         if (!pjsip_log_test_addr(rdata->pkt_info.src_name, rdata->pkt_info.src_port)) {
119                 return PJ_FALSE;
120         }
121
122         if (!rdata->msg_info.msg) {
123                 return PJ_FALSE;
124         }
125
126         ast_verbose("<--- Received SIP %s (%d bytes) from %s:%s:%d --->\n%s\n",
127                     rdata->msg_info.msg->type == PJSIP_REQUEST_MSG ? "request" : "response",
128                     rdata->msg_info.len,
129                     rdata->tp_info.transport->type_name,
130                     rdata->pkt_info.src_name,
131                     rdata->pkt_info.src_port,
132                     rdata->pkt_info.packet);
133         return PJ_FALSE;
134 }
135
136 static pjsip_module logging_module = {
137         .name = { "Logging Module", 14 },
138         .priority = 0,
139         .on_rx_request = logging_on_rx_msg,
140         .on_rx_response = logging_on_rx_msg,
141         .on_tx_request = logging_on_tx_msg,
142         .on_tx_response = logging_on_tx_msg,
143 };
144
145 static char *pjsip_enable_logger_host(int fd, const char *arg)
146 {
147         if (ast_sockaddr_resolve_first_af(&log_addr, arg, 0, AST_AF_UNSPEC)) {
148                 return CLI_SHOWUSAGE;
149         }
150
151         ast_cli(fd, "PJSIP Logging Enabled for host: %s\n", ast_sockaddr_stringify_addr(&log_addr));
152         logging_mode = LOGGING_MODE_ENABLED;
153
154         return CLI_SUCCESS;
155 }
156
157 static char *pjsip_set_logger(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
158 {
159         const char *what;
160
161         if (cmd == CLI_INIT) {
162                 e->command = "pjsip set logger {on|off|host}";
163                 e->usage =
164                         "Usage: pjsip set logger {on|off|host <name>}\n"
165                         "       Enables or disabling logging of SIP packets\n"
166                         "       read on ports bound to PJSIP transports either\n"
167                         "       globally or enables logging for an individual\n"
168                         "       host.\n";
169                 return NULL;
170         } else if (cmd == CLI_GENERATE) {
171                 return NULL;
172         }
173
174         what = a->argv[e->args - 1];     /* Guaranteed to exist */
175
176         if (a->argc == e->args) {        /* on/off */
177                 if (!strcasecmp(what, "on")) {
178                         logging_mode = LOGGING_MODE_ENABLED;
179                         ast_cli(a->fd, "PJSIP Logging enabled\n");
180                         ast_sockaddr_setnull(&log_addr);
181                         return CLI_SUCCESS;
182                 } else if (!strcasecmp(what, "off")) {
183                         logging_mode = LOGGING_MODE_DISABLED;
184                         ast_cli(a->fd, "PJSIP Logging disabled\n");
185                         return CLI_SUCCESS;
186                 }
187         } else if (a->argc == e->args + 1) {
188                 if (!strcasecmp(what, "host")) {
189                         return pjsip_enable_logger_host(a->fd, a->argv[e->args]);
190                 }
191         }
192
193         return CLI_SHOWUSAGE;
194 }
195
196 static struct ast_cli_entry cli_pjsip[] = {
197         AST_CLI_DEFINE(pjsip_set_logger, "Enable/Disable PJSIP Logger Output")
198 };
199
200 static void check_debug(void)
201 {
202         RAII_VAR(char *, debug, ast_sip_get_debug(), ast_free);
203
204         if (ast_false(debug)) {
205                 logging_mode = LOGGING_MODE_DISABLED;
206                 return;
207         }
208
209         logging_mode = LOGGING_MODE_ENABLED;
210
211         if (ast_true(debug)) {
212                 ast_sockaddr_setnull(&log_addr);
213                 return;
214         }
215
216         /* assume host */
217         if (ast_sockaddr_resolve_first_af(&log_addr, debug, 0, AST_AF_UNSPEC)) {
218                 ast_log(LOG_WARNING, "Could not resolve host %s for debug "
219                         "logging\n", debug);
220         }
221 }
222
223 static void global_reloaded(const char *object_type)
224 {
225         check_debug();
226 }
227
228 static const struct ast_sorcery_observer global_observer = {
229         .loaded = global_reloaded
230 };
231
232 static int load_module(void)
233 {
234         CHECK_PJSIP_MODULE_LOADED();
235
236         if (ast_sorcery_observer_add(ast_sip_get_sorcery(), "global", &global_observer)) {
237                 ast_log(LOG_WARNING, "Unable to add global observer\n");
238                 return AST_MODULE_LOAD_DECLINE;
239         }
240
241         check_debug();
242
243         ast_sip_register_service(&logging_module);
244         ast_cli_register_multiple(cli_pjsip, ARRAY_LEN(cli_pjsip));
245
246         return AST_MODULE_LOAD_SUCCESS;
247 }
248
249 static int unload_module(void)
250 {
251         ast_cli_unregister_multiple(cli_pjsip, ARRAY_LEN(cli_pjsip));
252         ast_sip_unregister_service(&logging_module);
253
254         ast_sorcery_observer_remove(
255                 ast_sip_get_sorcery(), "global", &global_observer);
256
257         return 0;
258 }
259
260 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "PJSIP Packet Logger",
261         .support_level = AST_MODULE_SUPPORT_CORE,
262         .load = load_module,
263         .unload = unload_module,
264         .load_pri = AST_MODPRI_APP_DEPEND,
265 );