Asterisk - The Open Source Telephony Project GIT-master-55f4e6d
Data Structures | Macros | Enumerations | Functions | Variables
pjsip_message_filter.c File Reference
#include "asterisk.h"
#include <pjsip.h>
#include <pjsip_ua.h>
#include "asterisk/res_pjsip.h"
#include "asterisk/res_pjsip_session.h"
#include "include/res_pjsip_private.h"
#include "asterisk/module.h"
Include dependency graph for pjsip_message_filter.c:

Go to the source code of this file.

Data Structures

struct  filter_message_restrictions
 Outgoing message modification restrictions. More...
 

Macros

#define FUNC_ATTRS
 
#define is_sip_uri(uri)    (PJSIP_URI_SCHEME_IS_SIP(uri) || PJSIP_URI_SCHEME_IS_SIPS(uri))
 
#define MOD_DATA_RESTRICTIONS   "restrictions"
 

Enumerations

enum  uri_type { URI_TYPE_REQUEST = -1 , URI_TYPE_TO = PJSIP_H_TO , URI_TYPE_FROM = PJSIP_H_FROM , URI_TYPE_CONTACT = PJSIP_H_CONTACT }
 

Functions

void ast_res_pjsip_cleanup_message_filter (void)
 
int ast_res_pjsip_init_message_filter (void)
 
static pj_bool_t filter_on_rx_message (pjsip_rx_data *rdata)
 
static pj_status_t filter_on_tx_message (pjsip_tx_data *tdata)
 
static void filter_outgoing_message (struct ast_sip_endpoint *endpoint, struct ast_sip_contact *contact, struct pjsip_tx_data *tdata)
 Callback invoked on non-session outgoing messages. More...
 
static void filter_session_outgoing_message (struct ast_sip_session *session, struct pjsip_tx_data *tdata)
 Callback invoked on session outgoing messages. More...
 
static struct filter_message_restrictionsget_restrictions (pjsip_tx_data *tdata)
 Helper function to get (or allocate if not already present) restrictions on a message. More...
 
static pjsip_transport * get_udp_transport (pj_str_t *address, int port)
 Helper function which returns a UDP transport bound to the given address and port. More...
 
static int is_allowed_tel_uri_request (pjsip_rx_data *rdata)
 
static int is_bound_any (pjsip_transport *transport)
 Helper function which determines if a transport is bound to any. More...
 
static int multihomed_rewrite_sdp (struct pjmedia_sdp_session *sdp)
 Helper function which determines if the address within SDP should be rewritten. More...
 
static pj_bool_t on_rx_process_symmetric_transport (pjsip_rx_data *rdata)
 
static pj_bool_t on_rx_process_uris (pjsip_rx_data *rdata)
 
static void print_sanitize_debug (char *msg, pjsip_uri_context_e context, pjsip_sip_uri *uri)
 
static void print_uri_debug (enum uri_type ut, pjsip_rx_data *rdata, pjsip_hdr *hdr)
 
static void remove_x_ast_params (pjsip_uri *header_uri)
 
static void FUNC_ATTRS sanitize_tdata (pjsip_tx_data *tdata)
 

Variables

static pjsip_module filter_module_transport
 
static pjsip_module filter_module_tsx
 
static struct ast_sip_session_supplement filter_session_supplement
 PJSIP Session Supplement for tagging messages with restrictions. More...
 
static struct ast_sip_supplement filter_supplement
 PJSIP Supplement for tagging messages with restrictions. More...
 

Macro Definition Documentation

◆ FUNC_ATTRS

#define FUNC_ATTRS

Definition at line 182 of file pjsip_message_filter.c.

◆ is_sip_uri

#define is_sip_uri (   uri)     (PJSIP_URI_SCHEME_IS_SIP(uri) || PJSIP_URI_SCHEME_IS_SIPS(uri))

Definition at line 163 of file pjsip_message_filter.c.

◆ MOD_DATA_RESTRICTIONS

#define MOD_DATA_RESTRICTIONS   "restrictions"

Definition at line 29 of file pjsip_message_filter.c.

Enumeration Type Documentation

◆ uri_type

enum uri_type
Enumerator
URI_TYPE_REQUEST 
URI_TYPE_TO 
URI_TYPE_FROM 
URI_TYPE_CONTACT 

Definition at line 373 of file pjsip_message_filter.c.

373 {
374 URI_TYPE_REQUEST = -1,
375 URI_TYPE_TO = PJSIP_H_TO,
376 URI_TYPE_FROM = PJSIP_H_FROM,
377 URI_TYPE_CONTACT = PJSIP_H_CONTACT,
378};
@ URI_TYPE_TO
@ URI_TYPE_CONTACT
@ URI_TYPE_FROM
@ URI_TYPE_REQUEST

Function Documentation

◆ ast_res_pjsip_cleanup_message_filter()

void ast_res_pjsip_cleanup_message_filter ( void  )

Definition at line 604 of file pjsip_message_filter.c.

605{
610}
static pjsip_module filter_module_tsx
static pjsip_module filter_module_transport
static struct ast_sip_session_supplement filter_session_supplement
PJSIP Session Supplement for tagging messages with restrictions.
static struct ast_sip_supplement filter_supplement
PJSIP Supplement for tagging messages with restrictions.
void ast_sip_unregister_supplement(struct ast_sip_supplement *supplement)
Unregister a an supplement to SIP out of dialog processing.
Definition: res_pjsip.c:1476
void ast_sip_unregister_service(pjsip_module *module)
Definition: res_pjsip.c:133
void ast_sip_session_unregister_supplement(struct ast_sip_session_supplement *supplement)
Unregister a an supplement to SIP session processing.
Definition: pjsip_session.c:63

References ast_sip_session_unregister_supplement(), ast_sip_unregister_service(), ast_sip_unregister_supplement(), filter_module_transport, filter_module_tsx, filter_session_supplement, and filter_supplement.

Referenced by ast_res_pjsip_init_message_filter(), and unload_pjsip().

◆ ast_res_pjsip_init_message_filter()

int ast_res_pjsip_init_message_filter ( void  )

Definition at line 612 of file pjsip_message_filter.c.

613{
616
618 ast_log(LOG_ERROR, "Could not register message filter module for incoming and outgoing requests\n");
620 return -1;
621 }
622
624 ast_log(LOG_ERROR, "Could not register message filter module for incoming and outgoing requests\n");
626 return -1;
627 }
628
629 return 0;
630}
#define ast_log
Definition: astobj2.c:42
#define LOG_ERROR
void ast_res_pjsip_cleanup_message_filter(void)
int ast_sip_register_service(pjsip_module *module)
Register a SIP service in Asterisk.
Definition: res_pjsip.c:117
void ast_sip_register_supplement(struct ast_sip_supplement *supplement)
Register a supplement to SIP out of dialog processing.
Definition: res_pjsip.c:1456
#define ast_sip_session_register_supplement(supplement)

References ast_log, ast_res_pjsip_cleanup_message_filter(), ast_sip_register_service(), ast_sip_register_supplement(), ast_sip_session_register_supplement, filter_module_transport, filter_module_tsx, filter_session_supplement, filter_supplement, and LOG_ERROR.

Referenced by load_module().

◆ filter_on_rx_message()

static pj_bool_t filter_on_rx_message ( pjsip_rx_data *  rdata)
static

Definition at line 587 of file pjsip_message_filter.c.

588{
589 pj_bool_t rc;
590
591 rc = on_rx_process_uris(rdata);
592 if (rc == PJ_TRUE) {
593 return rc;
594 }
595
597 if (rc == PJ_TRUE) {
598 return rc;
599 }
600
601 return PJ_FALSE;
602}
static pj_bool_t on_rx_process_uris(pjsip_rx_data *rdata)
static pj_bool_t on_rx_process_symmetric_transport(pjsip_rx_data *rdata)

References on_rx_process_symmetric_transport(), and on_rx_process_uris().

◆ filter_on_tx_message()

static pj_status_t filter_on_tx_message ( pjsip_tx_data *  tdata)
static

Definition at line 225 of file pjsip_message_filter.c.

226{
227 struct filter_message_restrictions *restrictions =
229 pjsip_tpmgr_fla2_param prm;
230 pjsip_cseq_hdr *cseq;
231 pjsip_via_hdr *via;
232 pjsip_fromto_hdr *from;
233 pjsip_tpselector sel;
234 pjsip_sdp_info *sdp_info;
235 pjmedia_sdp_session *sdp;
236
237 sanitize_tdata(tdata);
238
239 /* Use the destination information to determine what local interface this message will go out on */
240 pjsip_tpmgr_fla2_param_default(&prm);
241 prm.tp_type = tdata->tp_info.transport->key.type;
242 pj_strset2(&prm.dst_host, tdata->tp_info.dst_name);
243 prm.local_if = PJ_TRUE;
244
245 if ((tdata->tp_info.transport->key.type != PJSIP_TRANSPORT_UDP) &&
246 (tdata->tp_info.transport->key.type != PJSIP_TRANSPORT_UDP6)) {
247 sel.type = PJSIP_TPSELECTOR_LISTENER;
248 sel.u.listener = tdata->tp_info.transport->factory;
249 prm.tp_sel = &sel;
250 }
251
252 /* If we can't get the local address use best effort and let it pass */
253 if (pjsip_tpmgr_find_local_addr2(pjsip_endpt_get_tpmgr(ast_sip_get_pjsip_endpoint()), tdata->pool, &prm) != PJ_SUCCESS) {
254 return PJ_SUCCESS;
255 }
256
257 /* For UDP we can have multiple transports so the port needs to be maintained */
258 if (tdata->tp_info.transport->key.type == PJSIP_TRANSPORT_UDP ||
259 tdata->tp_info.transport->key.type == PJSIP_TRANSPORT_UDP6) {
260 prm.ret_port = tdata->tp_info.transport->local_name.port;
261 }
262
263 /* If the IP source differs from the existing transport see if we need to update it */
264 if (pj_strcmp(&prm.ret_addr, &tdata->tp_info.transport->local_name.host)) {
265
266 /* If the transport it is going out on is different reflect it in the message */
267 if (tdata->tp_info.transport->key.type == PJSIP_TRANSPORT_UDP ||
268 tdata->tp_info.transport->key.type == PJSIP_TRANSPORT_UDP6) {
269 pjsip_transport *transport;
270
271 transport = get_udp_transport(&prm.ret_addr, prm.ret_port);
272
273 if (transport) {
274 tdata->tp_info.transport = transport;
275 }
276 }
277
278 /* If the chosen transport is not bound to any we can't use the source address as it won't get back to us */
279 if (!is_bound_any(tdata->tp_info.transport)) {
280 pj_strassign(&prm.ret_addr, &tdata->tp_info.transport->local_name.host);
281 }
282 } else {
283 /* The transport chosen will deliver this but ensure it is updated with the right information */
284 pj_strassign(&prm.ret_addr, &tdata->tp_info.transport->local_name.host);
285 }
286
287 /* If the message needs to be updated with new address do so */
288 if (tdata->msg->type == PJSIP_REQUEST_MSG || !(cseq = pjsip_msg_find_hdr(tdata->msg, PJSIP_H_CSEQ, NULL)) ||
289 pj_strcmp2(&cseq->method.name, "REGISTER")) {
290 pjsip_contact_hdr *contact = pjsip_msg_find_hdr(tdata->msg, PJSIP_H_CONTACT, NULL);
291 if (contact && ast_sip_is_uri_sip_sips(contact->uri)
292 && !(tdata->msg->type == PJSIP_RESPONSE_MSG && tdata->msg->line.status.code / 100 == 3)) {
293 pjsip_sip_uri *uri = pjsip_uri_get_uri(contact->uri);
294
295 /* prm.ret_addr is allocated from the tdata pool OR the transport so it is perfectly fine to just do an assignment like this */
296 pj_strassign(&uri->host, &prm.ret_addr);
297 uri->port = prm.ret_port;
298 ast_debug(5, "Re-wrote Contact URI host/port to %.*s:%d (this may be re-written again later)\n",
299 (int)pj_strlen(&uri->host), pj_strbuf(&uri->host), uri->port);
300
301 if (tdata->tp_info.transport->key.type == PJSIP_TRANSPORT_UDP ||
302 tdata->tp_info.transport->key.type == PJSIP_TRANSPORT_UDP6) {
303 uri->transport_param.slen = 0;
304 } else {
305 pj_strdup2(tdata->pool, &uri->transport_param, pjsip_transport_get_type_name(tdata->tp_info.transport->key.type));
306 }
307
308 pjsip_tx_data_invalidate_msg(tdata);
309 }
310 }
311
312 if (tdata->msg->type == PJSIP_REQUEST_MSG && (via = pjsip_msg_find_hdr(tdata->msg, PJSIP_H_VIA, NULL))) {
313 pj_strassign(&via->sent_by.host, &prm.ret_addr);
314 via->sent_by.port = prm.ret_port;
315
316 pjsip_tx_data_invalidate_msg(tdata);
317 }
318
319 if (tdata->msg->type == PJSIP_REQUEST_MSG && (from = pjsip_msg_find_hdr(tdata->msg, PJSIP_H_FROM, NULL)) &&
320 (restrictions && !restrictions->disallow_from_domain_modification)) {
321 pjsip_name_addr *id_name_addr = (pjsip_name_addr *)from->uri;
322 pjsip_sip_uri *uri = pjsip_uri_get_uri(id_name_addr);
323 pj_sockaddr ip;
324
325 if (pj_strcmp2(&uri->host, "localhost") && pj_sockaddr_parse(pj_AF_UNSPEC(), 0, &uri->host, &ip) == PJ_SUCCESS) {
326 pj_strassign(&uri->host, &prm.ret_addr);
327 pjsip_tx_data_invalidate_msg(tdata);
328 }
329 }
330
331 /* If there's no body in the tdata we can just return here. */
332 if (!tdata->msg->body) {
333 return PJ_SUCCESS;
334 }
335
336 /*
337 * pjsip_get_sdp_info will search for an SDP even if it's in
338 * a multipart message body.
339 */
340 sdp_info = pjsip_get_sdp_info(tdata->pool, tdata->msg->body, NULL, &pjsip_media_type_application_sdp);
341 if (sdp_info->sdp_err != PJ_SUCCESS || !sdp_info->sdp) {
342 return PJ_SUCCESS;
343 }
344
345 sdp = sdp_info->sdp;
346
347 if (multihomed_rewrite_sdp(sdp)) {
348 static const pj_str_t STR_IP4 = { "IP4", 3 };
349 static const pj_str_t STR_IP6 = { "IP6", 3 };
350 pj_str_t STR_IP;
351 int stream;
352
353 STR_IP = tdata->tp_info.transport->key.type & PJSIP_TRANSPORT_IPV6 ? STR_IP6 : STR_IP4;
354
355 pj_strassign(&sdp->origin.addr, &prm.ret_addr);
356 sdp->origin.addr_type = STR_IP;
357 pj_strassign(&sdp->conn->addr, &prm.ret_addr);
358 sdp->conn->addr_type = STR_IP;
359
360 for (stream = 0; stream < sdp->media_count; ++stream) {
361 if (sdp->media[stream]->conn) {
362 pj_strassign(&sdp->media[stream]->conn->addr, &prm.ret_addr);
363 sdp->media[stream]->conn->addr_type = STR_IP;
364 }
365 }
366
367 pjsip_tx_data_invalidate_msg(tdata);
368 }
369
370 return PJ_SUCCESS;
371}
#define ast_debug(level,...)
Log a DEBUG message.
#define MOD_DATA_RESTRICTIONS
static void FUNC_ATTRS sanitize_tdata(pjsip_tx_data *tdata)
static int multihomed_rewrite_sdp(struct pjmedia_sdp_session *sdp)
Helper function which determines if the address within SDP should be rewritten.
static int is_bound_any(pjsip_transport *transport)
Helper function which determines if a transport is bound to any.
static pjsip_transport * get_udp_transport(pj_str_t *address, int port)
Helper function which returns a UDP transport bound to the given address and port.
pjsip_media_type pjsip_media_type_application_sdp
Definition: res_pjsip.c:3916
pjsip_endpoint * ast_sip_get_pjsip_endpoint(void)
Get a pointer to the PJSIP endpoint.
Definition: res_pjsip.c:520
int ast_sip_is_uri_sip_sips(pjsip_uri *uri)
Check whether a pjsip_uri is SIP/SIPS or not.
Definition: res_pjsip.c:3467
#define ast_sip_mod_data_get(mod_data, id, key)
Using the dictionary stored in mod_data array at a given id, retrieve the value associated with the g...
Definition: res_pjsip.h:2946
#define NULL
Definition: resample.c:96
Outgoing message modification restrictions.
unsigned int disallow_from_domain_modification
Disallow modification of the From domain.

References ast_debug, ast_sip_get_pjsip_endpoint(), ast_sip_is_uri_sip_sips(), ast_sip_mod_data_get, filter_message_restrictions::disallow_from_domain_modification, filter_module_transport, get_udp_transport(), is_bound_any(), MOD_DATA_RESTRICTIONS, multihomed_rewrite_sdp(), NULL, pjsip_media_type_application_sdp, and sanitize_tdata().

◆ filter_outgoing_message()

static void filter_outgoing_message ( struct ast_sip_endpoint endpoint,
struct ast_sip_contact contact,
struct pjsip_tx_data *  tdata 
)
static

Callback invoked on non-session outgoing messages.

Definition at line 72 of file pjsip_message_filter.c.

73{
74 struct filter_message_restrictions *restrictions = get_restrictions(tdata);
75
77}
static struct filter_message_restrictions * get_restrictions(pjsip_tx_data *tdata)
Helper function to get (or allocate if not already present) restrictions on a message.
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition: strings.h:65
const ast_string_field fromdomain
Definition: res_pjsip.h:990

References ast_strlen_zero(), filter_message_restrictions::disallow_from_domain_modification, ast_sip_endpoint::fromdomain, and get_restrictions().

◆ filter_session_outgoing_message()

static void filter_session_outgoing_message ( struct ast_sip_session session,
struct pjsip_tx_data *  tdata 
)
static

Callback invoked on session outgoing messages.

Definition at line 87 of file pjsip_message_filter.c.

88{
89 struct filter_message_restrictions *restrictions = get_restrictions(tdata);
90
91 restrictions->disallow_from_domain_modification = !ast_strlen_zero(session->endpoint->fromdomain);
92}
static struct ast_mansession session

References ast_strlen_zero(), filter_message_restrictions::disallow_from_domain_modification, get_restrictions(), and session.

◆ get_restrictions()

static struct filter_message_restrictions * get_restrictions ( pjsip_tx_data *  tdata)
static

Helper function to get (or allocate if not already present) restrictions on a message.

Definition at line 56 of file pjsip_message_filter.c.

57{
58 struct filter_message_restrictions *restrictions;
59
60 restrictions = ast_sip_mod_data_get(tdata->mod_data, filter_module_tsx.id, MOD_DATA_RESTRICTIONS);
61 if (restrictions) {
62 return restrictions;
63 }
64
65 restrictions = PJ_POOL_ALLOC_T(tdata->pool, struct filter_message_restrictions);
66 ast_sip_mod_data_set(tdata->pool, tdata->mod_data, filter_module_tsx.id, MOD_DATA_RESTRICTIONS, restrictions);
67
68 return restrictions;
69}
#define ast_sip_mod_data_set(pool, mod_data, id, key, val)
Utilizing a mod_data array for a given id, set the value associated with the given key.
Definition: res_pjsip.h:2978

References ast_sip_mod_data_get, ast_sip_mod_data_set, filter_module_tsx, and MOD_DATA_RESTRICTIONS.

Referenced by filter_outgoing_message(), and filter_session_outgoing_message().

◆ get_udp_transport()

static pjsip_transport * get_udp_transport ( pj_str_t *  address,
int  port 
)
static

Helper function which returns a UDP transport bound to the given address and port.

Definition at line 102 of file pjsip_message_filter.c.

103{
105 struct ast_sip_transport_state *transport_state;
106 struct ao2_iterator iter;
107 pjsip_transport *sip_transport = NULL;
108
109 if (!transport_states) {
110 return NULL;
111 }
112
113 for (iter = ao2_iterator_init(transport_states, 0); (transport_state = ao2_iterator_next(&iter)); ao2_ref(transport_state, -1)) {
114 if (!transport_state->flow &&
115 transport_state->type == AST_TRANSPORT_UDP &&
116 !pj_strcmp(&transport_state->transport->local_name.host, address) &&
117 transport_state->transport->local_name.port == port) {
118 sip_transport = transport_state->transport;
119 ao2_ref(transport_state, -1);
120 break;
121 }
122 }
124
126
127 return sip_transport;
128}
#define ao2_iterator_next(iter)
Definition: astobj2.h:1911
struct ao2_iterator ao2_iterator_init(struct ao2_container *c, int flags) attribute_warn_unused_result
Create an iterator for a container.
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition: astobj2.h:459
void ao2_iterator_destroy(struct ao2_iterator *iter)
Destroy a container iterator.
static struct ao2_container * transport_states
char * address
Definition: f2c.h:59
@ AST_TRANSPORT_UDP
Definition: netsock2.h:60
struct ao2_container * ast_sip_get_transport_states(void)
Retrieves all transport states.
Generic container type.
When we need to walk through a container, we use an ao2_iterator to keep track of the current positio...
Definition: astobj2.h:1821
Structure for SIP transport information.
Definition: res_pjsip.h:119
enum ast_transport type
Definition: res_pjsip.h:133
struct pjsip_transport * transport
Transport itself.
Definition: res_pjsip.h:121

References ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, ast_sip_get_transport_states(), AST_TRANSPORT_UDP, ast_sip_transport_state::flow, NULL, ast_sip_transport_state::transport, transport_states, and ast_sip_transport_state::type.

Referenced by filter_on_tx_message().

◆ is_allowed_tel_uri_request()

static int is_allowed_tel_uri_request ( pjsip_rx_data *  rdata)
static

Definition at line 466 of file pjsip_message_filter.c.

467{
468 struct pjsip_request_line req = rdata->msg_info.msg->line.req;
469 const pjsip_method method = (const pjsip_method)req.method;
470
471 if (pjsip_method_cmp(&method, pjsip_get_invite_method())) {
472 return 1;
473 } else if (pjsip_method_cmp(&method, pjsip_get_ack_method())) {
474 return 1;
475 } else if (pjsip_method_cmp(&method, pjsip_get_bye_method())) {
476 return 1;
477 } else if (pjsip_method_cmp(&method, pjsip_get_cancel_method())) {
478 return 1;
479 }
480
481 return 0;
482}
if(!yyg->yy_init)
Definition: ast_expr2f.c:854
const char * method
Definition: res_pjsip.c:1279

References if(), and method.

Referenced by on_rx_process_uris().

◆ is_bound_any()

static int is_bound_any ( pjsip_transport *  transport)
static

Helper function which determines if a transport is bound to any.

Definition at line 131 of file pjsip_message_filter.c.

132{
133 pj_uint32_t loop6[4] = {0, 0, 0, 0};
134
135 if ((transport->local_addr.addr.sa_family == pj_AF_INET() &&
136 transport->local_addr.ipv4.sin_addr.s_addr == PJ_INADDR_ANY) ||
137 (transport->local_addr.addr.sa_family == pj_AF_INET6() &&
138 !pj_memcmp(&transport->local_addr.ipv6.sin6_addr, loop6, sizeof(loop6)))) {
139 return 1;
140 }
141
142 return 0;
143}

Referenced by filter_on_tx_message().

◆ multihomed_rewrite_sdp()

static int multihomed_rewrite_sdp ( struct pjmedia_sdp_session *  sdp)
static

Helper function which determines if the address within SDP should be rewritten.

Definition at line 146 of file pjsip_message_filter.c.

147{
148 if (!sdp->conn) {
149 return 0;
150 }
151
152 /* If the host address is used in the SDP replace it with the address of what this is going out on */
153 if ((!pj_strcmp2(&sdp->conn->addr_type, "IP4") && !pj_strcmp2(&sdp->conn->addr,
154 ast_sip_get_host_ip_string(pj_AF_INET()))) ||
155 (!pj_strcmp2(&sdp->conn->addr_type, "IP6") && !pj_strcmp2(&sdp->conn->addr,
156 ast_sip_get_host_ip_string(pj_AF_INET6())))) {
157 return 1;
158 }
159
160 return 0;
161}
const char * ast_sip_get_host_ip_string(int af)
Retrieve the local host address in string form.
Definition: res_pjsip.c:2493

References ast_sip_get_host_ip_string().

Referenced by filter_on_tx_message().

◆ on_rx_process_symmetric_transport()

static pj_bool_t on_rx_process_symmetric_transport ( pjsip_rx_data *  rdata)
static

Definition at line 544 of file pjsip_message_filter.c.

545{
546 pjsip_contact_hdr *contact;
547 pjsip_sip_uri *uri;
548 const char *transport_id;
549 struct ast_sip_transport *transport;
550 pjsip_param *x_transport;
551
552 if (rdata->msg_info.msg->type != PJSIP_REQUEST_MSG) {
553 return PJ_FALSE;
554 }
555
556 contact = pjsip_msg_find_hdr(rdata->msg_info.msg, PJSIP_H_CONTACT, NULL);
557 if (!(contact && contact->uri
558 && ast_begins_with(rdata->tp_info.transport->info, AST_SIP_X_AST_TXP ":"))) {
559 return PJ_FALSE;
560 }
561
562 uri = pjsip_uri_get_uri(contact->uri);
563
564 transport_id = rdata->tp_info.transport->info + AST_SIP_X_AST_TXP_LEN + 1;
565 transport = ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "transport", transport_id);
566
567 if (!(transport && transport->symmetric_transport)) {
568 ao2_cleanup(transport);
569 return PJ_FALSE;
570 }
571 ao2_cleanup(transport);
572
573 x_transport = PJ_POOL_ALLOC_T(rdata->tp_info.pool, pjsip_param);
574 x_transport->name = pj_strdup3(rdata->tp_info.pool, AST_SIP_X_AST_TXP);
575 x_transport->value = pj_strdup3(rdata->tp_info.pool, transport_id);
576
577 pj_list_insert_before(&uri->other_param, x_transport);
578
579 ast_debug(1, "Set transport '%s' on %.*s from %.*s:%d\n", transport_id,
580 (int)rdata->msg_info.msg->line.req.method.name.slen,
581 rdata->msg_info.msg->line.req.method.name.ptr,
582 (int)uri->host.slen, uri->host.ptr, uri->port);
583
584 return PJ_FALSE;
585}
#define ao2_cleanup(obj)
Definition: astobj2.h:1934
#define AST_SIP_X_AST_TXP
Definition: res_pjsip.h:1076
struct ast_sorcery * ast_sip_get_sorcery(void)
Get a pointer to the SIP sorcery structure.
#define AST_SIP_X_AST_TXP_LEN
Definition: res_pjsip.h:1077
void * ast_sorcery_retrieve_by_id(const struct ast_sorcery *sorcery, const char *type, const char *id)
Retrieve an object using its unique identifier.
Definition: sorcery.c:1853
static int force_inline attribute_pure ast_begins_with(const char *str, const char *prefix)
Checks whether a string begins with another.
Definition: strings.h:97
Transport to bind to.
Definition: res_pjsip.h:221

References ao2_cleanup, ast_begins_with(), ast_debug, ast_sip_get_sorcery(), AST_SIP_X_AST_TXP, AST_SIP_X_AST_TXP_LEN, ast_sorcery_retrieve_by_id(), NULL, and ast_sip_transport::symmetric_transport.

Referenced by filter_on_rx_message().

◆ on_rx_process_uris()

static pj_bool_t on_rx_process_uris ( pjsip_rx_data *  rdata)
static

Definition at line 484 of file pjsip_message_filter.c.

485{
486 pjsip_contact_hdr *contact = NULL;
487
488 if (rdata->msg_info.msg->type != PJSIP_REQUEST_MSG) {
489 return PJ_FALSE;
490 }
491
492 if (PJSIP_URI_SCHEME_IS_TEL(rdata->msg_info.msg->line.req.uri)
493 && !is_allowed_tel_uri_request(rdata)) {
495 pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata,
496 PJSIP_SC_UNSUPPORTED_URI_SCHEME, NULL, NULL, NULL);
497 return PJ_TRUE;
498 }
499 remove_x_ast_params(rdata->msg_info.msg->line.req.uri);
500
501 if (!ast_sip_is_allowed_uri(rdata->msg_info.from->uri)) {
502 print_uri_debug(URI_TYPE_FROM, rdata, (pjsip_hdr *)rdata->msg_info.from);
503 pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata,
504 PJSIP_SC_UNSUPPORTED_URI_SCHEME, NULL, NULL, NULL);
505 return PJ_TRUE;
506 }
507 remove_x_ast_params(rdata->msg_info.from->uri);
508
509 if (!ast_sip_is_allowed_uri(rdata->msg_info.to->uri)) {
510 print_uri_debug(URI_TYPE_TO, rdata, (pjsip_hdr *)rdata->msg_info.to);
511 pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata,
512 PJSIP_SC_UNSUPPORTED_URI_SCHEME, NULL, NULL, NULL);
513 return PJ_TRUE;
514 }
515 remove_x_ast_params(rdata->msg_info.to->uri);
516
517 contact = (pjsip_contact_hdr *) pjsip_msg_find_hdr(
518 rdata->msg_info.msg, PJSIP_H_CONTACT, NULL);
519
520 if (!contact && pjsip_method_creates_dialog(&rdata->msg_info.msg->line.req.method)) {
521 /* A contact header is required for dialog creating methods */
522 static const pj_str_t missing_contact = { "Missing Contact header", 22 };
523 pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata, 400,
524 &missing_contact, NULL, NULL);
525 return PJ_TRUE;
526 }
527
528 while (contact) {
529 if (!contact->star && !is_sip_uri(contact->uri)) {
530 print_uri_debug(URI_TYPE_CONTACT, rdata, (pjsip_hdr *)contact);
531 pjsip_endpt_respond_stateless(ast_sip_get_pjsip_endpoint(), rdata,
532 PJSIP_SC_UNSUPPORTED_URI_SCHEME, NULL, NULL, NULL);
533 return PJ_TRUE;
534 }
535 remove_x_ast_params(contact->uri);
536
537 contact = (pjsip_contact_hdr *) pjsip_msg_find_hdr(
538 rdata->msg_info.msg, PJSIP_H_CONTACT, contact->next);
539 }
540
541 return PJ_FALSE;
542}
static int is_allowed_tel_uri_request(pjsip_rx_data *rdata)
#define is_sip_uri(uri)
static void remove_x_ast_params(pjsip_uri *header_uri)
static void print_uri_debug(enum uri_type ut, pjsip_rx_data *rdata, pjsip_hdr *hdr)
int ast_sip_is_allowed_uri(pjsip_uri *uri)
Check whether a pjsip_uri is allowed or not.
Definition: res_pjsip.c:3472

References ast_sip_get_pjsip_endpoint(), ast_sip_is_allowed_uri(), is_allowed_tel_uri_request(), is_sip_uri, NULL, print_uri_debug(), remove_x_ast_params(), URI_TYPE_CONTACT, URI_TYPE_FROM, URI_TYPE_REQUEST, and URI_TYPE_TO.

Referenced by filter_on_rx_message().

◆ print_sanitize_debug()

static void print_sanitize_debug ( char *  msg,
pjsip_uri_context_e  context,
pjsip_sip_uri *  uri 
)
static

Definition at line 166 of file pjsip_message_filter.c.

167{
168#ifdef AST_DEVMODE
169 char hdrbuf[512];
170 int hdrbuf_len;
171
172 hdrbuf_len = pjsip_uri_print(context, uri, hdrbuf, 512);
173 hdrbuf[hdrbuf_len] = '\0';
174 ast_debug(2, "%s: %s\n", msg, hdrbuf);
175#endif
176}

References ast_debug, and voicemailpwcheck::context.

Referenced by sanitize_tdata().

◆ print_uri_debug()

static void print_uri_debug ( enum uri_type  ut,
pjsip_rx_data *  rdata,
pjsip_hdr *  hdr 
)
static

Definition at line 380 of file pjsip_message_filter.c.

381{
382#ifdef AST_DEVMODE
383 pjsip_uri *local_uri = NULL;
384 char hdrbuf[512];
385 int hdrbuf_len;
386 char *request_uri;
387 pjsip_uri_context_e context = PJSIP_URI_IN_OTHER;
388 char header_name[32];
389
390 switch (ut) {
391 case(URI_TYPE_REQUEST):
392 context = PJSIP_URI_IN_REQ_URI;
393 strcpy(header_name, "Request"); /* Safe */
394 local_uri = rdata->msg_info.msg->line.req.uri;
395 break;
396 case(PJSIP_H_FROM):
397 strcpy(header_name, "From"); /* Safe */
398 context = PJSIP_URI_IN_FROMTO_HDR;
399 local_uri = pjsip_uri_get_uri(((pjsip_from_hdr *)hdr)->uri);
400 break;
401 case(PJSIP_H_TO):
402 strcpy(header_name, "To"); /* Safe */
403 context = PJSIP_URI_IN_FROMTO_HDR;
404 local_uri = pjsip_uri_get_uri(((pjsip_to_hdr *)hdr)->uri);
405 break;
406 case(PJSIP_H_CONTACT):
407 strcpy(header_name, "Contact"); /* Safe */
408 context = PJSIP_URI_IN_CONTACT_HDR;
409 local_uri = pjsip_uri_get_uri(((pjsip_contact_hdr *)hdr)->uri);
410 break;
411 }
412
413 hdrbuf_len = pjsip_uri_print(PJSIP_URI_IN_REQ_URI, rdata->msg_info.msg->line.req.uri, hdrbuf, 512);
414 hdrbuf[hdrbuf_len] = '\0';
415 request_uri = ast_strdupa(hdrbuf);
416 hdrbuf_len = pjsip_uri_print(context, local_uri, hdrbuf, 512);
417 hdrbuf[hdrbuf_len] = '\0';
418
419 ast_debug(2, "There was a non sip(s) URI scheme in %s URI '%s' for request '%*.*s %s'\n",
420 header_name, hdrbuf,
421 (int)rdata->msg_info.msg->line.req.method.name.slen,
422 (int)rdata->msg_info.msg->line.req.method.name.slen,
423 rdata->msg_info.msg->line.req.method.name.ptr, request_uri);
424#endif
425}
#define ast_strdupa(s)
duplicate a string in memory from the stack
Definition: astmm.h:298

References ast_debug, ast_strdupa, voicemailpwcheck::context, NULL, and URI_TYPE_REQUEST.

Referenced by on_rx_process_uris().

◆ remove_x_ast_params()

static void remove_x_ast_params ( pjsip_uri *  header_uri)
static

/internal

We want to make sure that any incoming requests don't already have x-ast-* parameters in any URIs or we may get confused if symmetric transport (x-ast-txp) or rewrite_contact (x-ast-orig-host) is used later on.

Definition at line 435 of file pjsip_message_filter.c.

435 {
436 pjsip_sip_uri *uri;
437 pjsip_param *param;
438
439 if (!header_uri) {
440 return;
441 }
442
443 if (PJSIP_URI_SCHEME_IS_TEL(header_uri)) {
444 return;
445 }
446
447 uri = pjsip_uri_get_uri(header_uri);
448 if (!uri) {
449 return;
450 }
451
452 param = uri->other_param.next;
453
454 while (param != &uri->other_param) {
455 /* We need to save off 'next' because pj_list_erase will remove it */
456 pjsip_param *next = param->next;
457
458 if (pj_strncmp2(&param->name, "x-ast-", 6) == 0) {
459 pj_list_erase(param);
460 }
461 param = next;
462 }
463}

Referenced by on_rx_process_uris().

◆ sanitize_tdata()

static void FUNC_ATTRS sanitize_tdata ( pjsip_tx_data *  tdata)
static

Definition at line 185 of file pjsip_message_filter.c.

186{
187 static const pj_str_t x_name = { AST_SIP_X_AST_TXP, AST_SIP_X_AST_TXP_LEN };
188 pjsip_param *x_transport;
189 pjsip_sip_uri *uri;
190 pjsip_hdr *hdr;
191
192 if (tdata->msg->type == PJSIP_REQUEST_MSG) {
193 if (ast_sip_is_uri_sip_sips(tdata->msg->line.req.uri)) {
194 uri = pjsip_uri_get_uri(tdata->msg->line.req.uri);
195 print_sanitize_debug("Sanitizing Request", PJSIP_URI_IN_REQ_URI, uri);
196 while ((x_transport = pjsip_param_find(&uri->other_param, &x_name))) {
197 pj_list_erase(x_transport);
198 }
199 }
200 }
201
202 for (hdr = tdata->msg->hdr.next; hdr != &tdata->msg->hdr; hdr = hdr->next) {
203 if (hdr->type == PJSIP_H_TO || hdr->type == PJSIP_H_FROM) {
204 if (ast_sip_is_uri_sip_sips(((pjsip_fromto_hdr *) hdr)->uri)) {
205 uri = pjsip_uri_get_uri(((pjsip_fromto_hdr *) hdr)->uri);
206 print_sanitize_debug("Sanitizing From/To header", PJSIP_URI_IN_FROMTO_HDR, uri);
207 while ((x_transport = pjsip_param_find(&uri->other_param, &x_name))) {
208 pj_list_erase(x_transport);
209 }
210 }
211 } else if (hdr->type == PJSIP_H_CONTACT) {
212 if (!((pjsip_contact_hdr *) hdr)->star && ast_sip_is_uri_sip_sips(((pjsip_contact_hdr *) hdr)->uri)) {
213 uri = pjsip_uri_get_uri(((pjsip_contact_hdr *) hdr)->uri);
214 print_sanitize_debug("Sanitizing Contact header", PJSIP_URI_IN_CONTACT_HDR, uri);
215 while ((x_transport = pjsip_param_find(&uri->other_param, &x_name))) {
216 pj_list_erase(x_transport);
217 }
218 }
219 }
220 }
221
222 pjsip_tx_data_invalidate_msg(tdata);
223}
static void print_sanitize_debug(char *msg, pjsip_uri_context_e context, pjsip_sip_uri *uri)

References ast_sip_is_uri_sip_sips(), AST_SIP_X_AST_TXP, AST_SIP_X_AST_TXP_LEN, and print_sanitize_debug().

Referenced by filter_on_tx_message().

Variable Documentation

◆ filter_module_transport

pjsip_module filter_module_transport
static

◆ filter_module_tsx

pjsip_module filter_module_tsx
static

◆ filter_session_supplement

struct ast_sip_session_supplement filter_session_supplement
static
Initial value:
= {
.priority = 1,
.outgoing_request = filter_session_outgoing_message,
.outgoing_response = filter_session_outgoing_message,
}
static void filter_session_outgoing_message(struct ast_sip_session *session, struct pjsip_tx_data *tdata)
Callback invoked on session outgoing messages.

PJSIP Session Supplement for tagging messages with restrictions.

Definition at line 95 of file pjsip_message_filter.c.

Referenced by ast_res_pjsip_cleanup_message_filter(), and ast_res_pjsip_init_message_filter().

◆ filter_supplement

struct ast_sip_supplement filter_supplement
static
Initial value:
= {
.outgoing_request = filter_outgoing_message,
.outgoing_response = filter_outgoing_message,
}
static void filter_outgoing_message(struct ast_sip_endpoint *endpoint, struct ast_sip_contact *contact, struct pjsip_tx_data *tdata)
Callback invoked on non-session outgoing messages.
@ AST_SIP_SUPPLEMENT_PRIORITY_FIRST
Definition: res_pjsip.h:3179

PJSIP Supplement for tagging messages with restrictions.

Definition at line 80 of file pjsip_message_filter.c.

Referenced by ast_res_pjsip_cleanup_message_filter(), and ast_res_pjsip_init_message_filter().