res_pjsip_t38: Don't pass T.38 control frames through to other hooks.
[asterisk/asterisk.git] / res / res_pjsip_t38.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * Joshua Colp <jcolp@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 /*! \file
20  *
21  * \author Joshua Colp <jcolp@digium.com>
22  *
23  * \brief SIP T.38 handling
24  */
25
26 /*** MODULEINFO
27         <depend>pjproject</depend>
28         <depend>res_pjsip</depend>
29         <depend>res_pjsip_session</depend>
30         <support_level>core</support_level>
31  ***/
32
33 #include "asterisk.h"
34
35 #include <pjsip.h>
36 #include <pjsip_ua.h>
37 #include <pjmedia.h>
38 #include <pjlib.h>
39
40 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
41
42 #include "asterisk/module.h"
43 #include "asterisk/udptl.h"
44 #include "asterisk/netsock2.h"
45 #include "asterisk/channel.h"
46 #include "asterisk/acl.h"
47
48 #include "asterisk/res_pjsip.h"
49 #include "asterisk/res_pjsip_session.h"
50
51 /*! \brief The number of seconds after receiving a T.38 re-invite before automatically rejecting it */
52 #define T38_AUTOMATIC_REJECTION_SECONDS 5
53
54 /*! \brief Address for IPv4 UDPTL */
55 static struct ast_sockaddr address_ipv4;
56
57 /*! \brief Address for IPv6 UDPTL */
58 static struct ast_sockaddr address_ipv6;
59
60 /*! \brief T.38 state information */
61 struct t38_state {
62         /*! \brief Current state */
63         enum ast_sip_session_t38state state;
64         /*! \brief Our T.38 parameters */
65         struct ast_control_t38_parameters our_parms;
66         /*! \brief Their T.38 parameters */
67         struct ast_control_t38_parameters their_parms;
68         /*! \brief Timer entry for automatically rejecting an inbound re-invite */
69         pj_timer_entry timer;
70 };
71
72 /*! \brief Destructor for T.38 state information */
73 static void t38_state_destroy(void *obj)
74 {
75         ast_free(obj);
76 }
77
78 /*! \brief Datastore for attaching T.38 state information */
79 static const struct ast_datastore_info t38_datastore = {
80         .type = "t38",
81         .destroy = t38_state_destroy,
82 };
83
84 /*! \brief Structure for T.38 parameters task data */
85 struct t38_parameters_task_data {
86         /*! \brief Session itself */
87         struct ast_sip_session *session;
88         /*! \brief T.38 control frame */
89         struct ast_frame *frame;
90 };
91
92 /*! \brief Destructor for T.38 data */
93 static void t38_parameters_task_data_destroy(void *obj)
94 {
95         struct t38_parameters_task_data *data = obj;
96
97         ao2_cleanup(data->session);
98
99         if (data->frame) {
100                 ast_frfree(data->frame);
101         }
102 }
103
104 /*! \brief Allocator for T.38 data */
105 static struct t38_parameters_task_data *t38_parameters_task_data_alloc(struct ast_sip_session *session,
106         struct ast_frame *frame)
107 {
108         struct t38_parameters_task_data *data = ao2_alloc(sizeof(*data), t38_parameters_task_data_destroy);
109
110         if (!data) {
111                 return NULL;
112         }
113
114         data->session = session;
115         ao2_ref(session, +1);
116         data->frame = frame;
117
118         return data;
119 }
120
121 /*! \brief Helper function for changing the T.38 state */
122 static void t38_change_state(struct ast_sip_session *session, struct ast_sip_session_media *session_media,
123         struct t38_state *state, enum ast_sip_session_t38state new_state)
124 {
125         enum ast_sip_session_t38state old_state = session->t38state;
126         struct ast_control_t38_parameters parameters = { .request_response = 0, };
127         pj_time_val delay = { .sec = T38_AUTOMATIC_REJECTION_SECONDS };
128
129         if (old_state == new_state) {
130                 return;
131         }
132
133         session->t38state = new_state;
134         ast_debug(2, "T.38 state changed to '%d' from '%d' on channel '%s'\n", new_state, old_state, ast_channel_name(session->channel));
135
136         if (pj_timer_heap_cancel(pjsip_endpt_get_timer_heap(ast_sip_get_pjsip_endpoint()), &state->timer)) {
137                 ast_debug(2, "Automatic T.38 rejection on channel '%s' terminated\n", ast_channel_name(session->channel));
138                 ao2_ref(session, -1);
139         }
140
141         if (!session->channel) {
142                 return;
143         }
144
145         switch (new_state) {
146         case T38_PEER_REINVITE:
147                 ao2_ref(session, +1);
148                 if (pjsip_endpt_schedule_timer(ast_sip_get_pjsip_endpoint(), &state->timer, &delay) != PJ_SUCCESS) {
149                         ast_log(LOG_WARNING, "Scheduling of automatic T.38 rejection for channel '%s' failed\n",
150                                 ast_channel_name(session->channel));
151                         ao2_ref(session, -1);
152                 }
153                 parameters = state->their_parms;
154                 parameters.max_ifp = ast_udptl_get_far_max_ifp(session_media->udptl);
155                 parameters.request_response = AST_T38_REQUEST_NEGOTIATE;
156                 ast_udptl_set_tag(session_media->udptl, "%s", ast_channel_name(session->channel));
157                 break;
158         case T38_ENABLED:
159                 parameters = state->their_parms;
160                 parameters.max_ifp = ast_udptl_get_far_max_ifp(session_media->udptl);
161                 parameters.request_response = AST_T38_NEGOTIATED;
162                 ast_udptl_set_tag(session_media->udptl, "%s", ast_channel_name(session->channel));
163                 break;
164         case T38_REJECTED:
165         case T38_DISABLED:
166                 if (old_state == T38_ENABLED) {
167                         parameters.request_response = AST_T38_TERMINATED;
168                 } else if (old_state == T38_LOCAL_REINVITE) {
169                         parameters.request_response = AST_T38_REFUSED;
170                 }
171                 break;
172         case T38_LOCAL_REINVITE:
173                 /* wait until we get a peer response before responding to local reinvite */
174                 break;
175         }
176
177         if (parameters.request_response) {
178                 ast_queue_control_data(session->channel, AST_CONTROL_T38_PARAMETERS, &parameters, sizeof(parameters));
179         }
180 }
181
182 /*! \brief Task function which rejects a T.38 re-invite and resumes handling it */
183 static int t38_automatic_reject(void *obj)
184 {
185         RAII_VAR(struct ast_sip_session *, session, obj, ao2_cleanup);
186         RAII_VAR(struct ast_datastore *, datastore, ast_sip_session_get_datastore(session, "t38"), ao2_cleanup);
187         RAII_VAR(struct ast_sip_session_media *, session_media, ao2_find(session->media, "image", OBJ_KEY), ao2_cleanup);
188
189         if (!datastore) {
190                 return 0;
191         }
192
193         ast_debug(2, "Automatically rejecting T.38 request on channel '%s'\n", ast_channel_name(session->channel));
194
195         t38_change_state(session, session_media, datastore->data, T38_REJECTED);
196         ast_sip_session_resume_reinvite(session);
197
198         return 0;
199 }
200
201 /*! \brief Timer entry callback which queues a task to reject a T.38 re-invite and resume handling it */
202 static void t38_automatic_reject_timer_cb(pj_timer_heap_t *timer_heap, struct pj_timer_entry *entry)
203 {
204         struct ast_sip_session *session = entry->user_data;
205
206         if (ast_sip_push_task(session->serializer, t38_automatic_reject, session)) {
207                 ao2_ref(session, -1);
208         }
209 }
210
211 /*! \brief Helper function which retrieves or allocates a T.38 state information datastore */
212 static struct t38_state *t38_state_get_or_alloc(struct ast_sip_session *session)
213 {
214         RAII_VAR(struct ast_datastore *, datastore, ast_sip_session_get_datastore(session, "t38"), ao2_cleanup);
215         struct t38_state *state;
216
217         /* While the datastore refcount is decremented this is operating in the serializer so it will remain valid regardless */
218         if (datastore) {
219                 return datastore->data;
220         }
221
222         if (!(datastore = ast_sip_session_alloc_datastore(&t38_datastore, "t38")) ||
223                 !(datastore->data = ast_calloc(1, sizeof(struct t38_state))) ||
224                 ast_sip_session_add_datastore(session, datastore)) {
225                 return NULL;
226         }
227
228         state = datastore->data;
229
230         /* This will get bumped up before scheduling */
231         state->timer.user_data = session;
232         state->timer.cb = t38_automatic_reject_timer_cb;
233
234         datastore->data = state;
235
236         return state;
237 }
238
239 /*! \brief Initializes UDPTL support on a session, only done when actually needed */
240 static int t38_initialize_session(struct ast_sip_session *session, struct ast_sip_session_media *session_media)
241 {
242         if (session_media->udptl) {
243                 return 0;
244         }
245
246         if (!(session_media->udptl = ast_udptl_new_with_bindaddr(NULL, NULL, 0,
247                 session->endpoint->media.t38.ipv6 ? &address_ipv6 : &address_ipv4))) {
248                 return -1;
249         }
250
251         ast_channel_set_fd(session->channel, 5, ast_udptl_fd(session_media->udptl));
252         ast_udptl_set_error_correction_scheme(session_media->udptl, session->endpoint->media.t38.error_correction);
253         ast_udptl_setnat(session_media->udptl, session->endpoint->media.t38.nat);
254
255         return 0;
256 }
257
258 /*! \brief Callback for when T.38 reinvite SDP is created */
259 static int t38_reinvite_sdp_cb(struct ast_sip_session *session, pjmedia_sdp_session *sdp)
260 {
261         int stream;
262
263         /* Move the image media stream to the front and have it as the only stream, pjmedia will fill in
264          * dummy streams for the rest
265          */
266         for (stream = 0; stream < sdp->media_count++; ++stream) {
267                 if (!pj_strcmp2(&sdp->media[stream]->desc.media, "image")) {
268                         sdp->media[0] = sdp->media[stream];
269                         sdp->media_count = 1;
270                         break;
271                 }
272         }
273
274         return 0;
275 }
276
277 /*! \brief Callback for when a response is received for a T.38 re-invite */
278 static int t38_reinvite_response_cb(struct ast_sip_session *session, pjsip_rx_data *rdata)
279 {
280         struct pjsip_status_line status = rdata->msg_info.msg->line.status;
281         struct t38_state *state;
282         RAII_VAR(struct ast_sip_session_media *, session_media, NULL, ao2_cleanup);
283
284         if (status.code == 100) {
285                 return 0;
286         }
287
288         if (!(state = t38_state_get_or_alloc(session)) ||
289                 !(session_media = ao2_find(session->media, "image", OBJ_KEY))) {
290                 ast_log(LOG_WARNING, "Received response to T.38 re-invite on '%s' but state unavailable\n",
291                         ast_channel_name(session->channel));
292                 return 0;
293         }
294
295         t38_change_state(session, session_media, state, (status.code == 200) ? T38_ENABLED : T38_REJECTED);
296
297         return 0;
298 }
299
300 /*! \brief Task for reacting to T.38 control frame */
301 static int t38_interpret_parameters(void *obj)
302 {
303         RAII_VAR(struct t38_parameters_task_data *, data, obj, ao2_cleanup);
304         const struct ast_control_t38_parameters *parameters = data->frame->data.ptr;
305         struct t38_state *state = t38_state_get_or_alloc(data->session);
306         RAII_VAR(struct ast_sip_session_media *, session_media, ao2_find(data->session->media, "image", OBJ_KEY), ao2_cleanup);
307
308         /* Without session media or state we can't interpret parameters */
309         if (!session_media || !state) {
310                 return 0;
311         }
312
313         switch (parameters->request_response) {
314         case AST_T38_NEGOTIATED:
315         case AST_T38_REQUEST_NEGOTIATE:         /* Request T38 */
316                 /* Negotiation can not take place without a valid max_ifp value. */
317                 if (!parameters->max_ifp) {
318                         t38_change_state(data->session, session_media, state, T38_REJECTED);
319                         if (data->session->t38state == T38_PEER_REINVITE) {
320                                 ast_sip_session_resume_reinvite(data->session);
321                         }
322                         break;
323                 } else if (data->session->t38state == T38_PEER_REINVITE) {
324                         state->our_parms = *parameters;
325                         /* modify our parameters to conform to the peer's parameters,
326                          * based on the rules in the ITU T.38 recommendation
327                          */
328                         if (!state->their_parms.fill_bit_removal) {
329                                 state->our_parms.fill_bit_removal = 0;
330                         }
331                         if (!state->their_parms.transcoding_mmr) {
332                                 state->our_parms.transcoding_mmr = 0;
333                         }
334                         if (!state->their_parms.transcoding_jbig) {
335                                 state->our_parms.transcoding_jbig = 0;
336                         }
337                         state->our_parms.version = MIN(state->our_parms.version, state->their_parms.version);
338                         state->our_parms.rate_management = state->their_parms.rate_management;
339                         ast_udptl_set_local_max_ifp(session_media->udptl, state->our_parms.max_ifp);
340                         t38_change_state(data->session, session_media, state, T38_ENABLED);
341                         ast_sip_session_resume_reinvite(data->session);
342                 } else if (data->session->t38state != T38_ENABLED) {
343                         if (t38_initialize_session(data->session, session_media)) {
344                                 break;
345                         }
346                         state->our_parms = *parameters;
347                         ast_udptl_set_local_max_ifp(session_media->udptl, state->our_parms.max_ifp);
348                         t38_change_state(data->session, session_media, state, T38_LOCAL_REINVITE);
349                         ast_sip_session_refresh(data->session, NULL, t38_reinvite_sdp_cb, t38_reinvite_response_cb,
350                                 AST_SIP_SESSION_REFRESH_METHOD_INVITE, 1);
351                 }
352                 break;
353         case AST_T38_TERMINATED:
354         case AST_T38_REFUSED:
355         case AST_T38_REQUEST_TERMINATE:         /* Shutdown T38 */
356                 if (data->session->t38state == T38_PEER_REINVITE) {
357                         t38_change_state(data->session, session_media, state, T38_REJECTED);
358                         ast_sip_session_resume_reinvite(data->session);
359                 } else if (data->session->t38state == T38_ENABLED) {
360                         t38_change_state(data->session, session_media, state, T38_DISABLED);
361                         ast_sip_session_refresh(data->session, NULL, NULL, NULL, AST_SIP_SESSION_REFRESH_METHOD_INVITE, 1);
362                 }
363                 break;
364         case AST_T38_REQUEST_PARMS: {           /* Application wants remote's parameters re-sent */
365                 struct ast_control_t38_parameters parameters = state->their_parms;
366
367                 if (data->session->t38state == T38_PEER_REINVITE) {
368                         parameters.max_ifp = ast_udptl_get_far_max_ifp(session_media->udptl);
369                         parameters.request_response = AST_T38_REQUEST_NEGOTIATE;
370                         ast_queue_control_data(data->session->channel, AST_CONTROL_T38_PARAMETERS, &parameters, sizeof(parameters));
371                 }
372                 break;
373         }
374         default:
375                 break;
376         }
377
378         return 0;
379 }
380
381 /*! \brief Frame hook callback for writing */
382 static struct ast_frame *t38_framehook_write(struct ast_sip_session *session, struct ast_frame *f)
383 {
384         if (f->frametype == AST_FRAME_CONTROL && f->subclass.integer == AST_CONTROL_T38_PARAMETERS &&
385                 session->endpoint->media.t38.enabled) {
386                 struct t38_parameters_task_data *data = t38_parameters_task_data_alloc(session, f);
387
388                 if (!data) {
389                         return f;
390                 }
391
392                 if (ast_sip_push_task(session->serializer, t38_interpret_parameters, data)) {
393                         ao2_ref(data, -1);
394                 }
395
396                 f = &ast_null_frame;
397         } else if (f->frametype == AST_FRAME_MODEM) {
398                 RAII_VAR(struct ast_sip_session_media *, session_media, NULL, ao2_cleanup);
399
400                 if ((session_media = ao2_find(session->media, "image", OBJ_KEY)) &&
401                         session_media->udptl) {
402                         ast_udptl_write(session_media->udptl, f);
403                 }
404         }
405
406         return f;
407 }
408
409 /*! \brief Frame hook callback for reading */
410 static struct ast_frame *t38_framehook_read(struct ast_sip_session *session, struct ast_frame *f)
411 {
412         if (ast_channel_fdno(session->channel) == 5) {
413                 RAII_VAR(struct ast_sip_session_media *, session_media, NULL, ao2_cleanup);
414
415                 if ((session_media = ao2_find(session->media, "image", OBJ_KEY)) &&
416                         session_media->udptl) {
417                         f = ast_udptl_read(session_media->udptl);
418                 }
419         }
420
421         return f;
422 }
423
424 /*! \brief Frame hook callback for T.38 related stuff */
425 static struct ast_frame *t38_framehook(struct ast_channel *chan, struct ast_frame *f,
426         enum ast_framehook_event event, void *data)
427 {
428         struct ast_sip_channel_pvt *channel = ast_channel_tech_pvt(chan);
429
430         if (event == AST_FRAMEHOOK_EVENT_READ) {
431                 f = t38_framehook_read(channel->session, f);
432         } else if (event == AST_FRAMEHOOK_EVENT_WRITE) {
433                 f = t38_framehook_write(channel->session, f);
434         }
435
436         return f;
437 }
438
439 /*! \brief Function called to attach T.38 framehook to channel when appropriate */
440 static void t38_attach_framehook(struct ast_sip_session *session)
441 {
442         static struct ast_framehook_interface hook = {
443                 .version = AST_FRAMEHOOK_INTERFACE_VERSION,
444                 .event_cb = t38_framehook,
445         };
446
447         /* Only attach the framehook on the first outgoing INVITE or the first incoming INVITE */
448         if ((session->inv_session->state != PJSIP_INV_STATE_NULL &&
449                 session->inv_session->state != PJSIP_INV_STATE_INCOMING) ||
450                 !session->endpoint->media.t38.enabled) {
451                 return;
452         }
453
454         if (ast_framehook_attach(session->channel, &hook) < 0) {
455                 ast_log(LOG_WARNING, "Could not attach T.38 Frame hook to channel, T.38 will be unavailable on '%s'\n",
456                         ast_channel_name(session->channel));
457         }
458 }
459
460 /*! \brief Function called when an INVITE goes out */
461 static int t38_incoming_invite_request(struct ast_sip_session *session, struct pjsip_rx_data *rdata)
462 {
463         t38_attach_framehook(session);
464         return 0;
465 }
466
467 /*! \brief Function called when an INVITE comes in */
468 static void t38_outgoing_invite_request(struct ast_sip_session *session, struct pjsip_tx_data *tdata)
469 {
470         t38_attach_framehook(session);
471 }
472
473 /*! \brief Get Max T.38 Transmission rate from T38 capabilities */
474 static unsigned int t38_get_rate(enum ast_control_t38_rate rate)
475 {
476         switch (rate) {
477         case AST_T38_RATE_2400:
478                 return 2400;
479         case AST_T38_RATE_4800:
480                 return 4800;
481         case AST_T38_RATE_7200:
482                 return 7200;
483         case AST_T38_RATE_9600:
484                 return 9600;
485         case AST_T38_RATE_12000:
486                 return 12000;
487         case AST_T38_RATE_14400:
488                 return 14400;
489         default:
490                 return 0;
491         }
492 }
493
494 /*! \brief Supplement for adding framehook to session channel */
495 static struct ast_sip_session_supplement t38_supplement = {
496         .method = "INVITE",
497         .priority = AST_SIP_SESSION_SUPPLEMENT_PRIORITY_CHANNEL + 1,
498         .incoming_request = t38_incoming_invite_request,
499         .outgoing_request = t38_outgoing_invite_request,
500 };
501
502 /*! \brief Parse a T.38 image stream and store the attribute information */
503 static void t38_interpret_sdp(struct t38_state *state, struct ast_sip_session *session, struct ast_sip_session_media *session_media,
504         const struct pjmedia_sdp_media *stream)
505 {
506         unsigned int attr_i;
507
508         for (attr_i = 0; attr_i < stream->attr_count; attr_i++) {
509                 pjmedia_sdp_attr *attr = stream->attr[attr_i];
510
511                 if (!pj_stricmp2(&attr->name, "t38faxmaxbuffer")) {
512                         /* This is purposely left empty, it is unused */
513                 } else if (!pj_stricmp2(&attr->name, "t38maxbitrate") || !pj_stricmp2(&attr->name, "t38faxmaxrate")) {
514                         switch (pj_strtoul(&attr->value)) {
515                         case 14400:
516                                 state->their_parms.rate = AST_T38_RATE_14400;
517                                 break;
518                         case 12000:
519                                 state->their_parms.rate = AST_T38_RATE_12000;
520                                 break;
521                         case 9600:
522                                 state->their_parms.rate = AST_T38_RATE_9600;
523                                 break;
524                         case 7200:
525                                 state->their_parms.rate = AST_T38_RATE_7200;
526                                 break;
527                         case 4800:
528                                 state->their_parms.rate = AST_T38_RATE_4800;
529                                 break;
530                         case 2400:
531                                 state->their_parms.rate = AST_T38_RATE_2400;
532                                 break;
533                         }
534                 } else if (!pj_stricmp2(&attr->name, "t38faxversion")) {
535                         state->their_parms.version = pj_strtoul(&attr->value);
536                 } else if (!pj_stricmp2(&attr->name, "t38faxmaxdatagram") || !pj_stricmp2(&attr->name, "t38maxdatagram")) {
537                         if (session->endpoint->media.t38.maxdatagram) {
538                                 ast_udptl_set_far_max_datagram(session_media->udptl, session->endpoint->media.t38.maxdatagram);
539                         } else {
540                                 ast_udptl_set_far_max_datagram(session_media->udptl, pj_strtoul(&attr->value));
541                         }
542                 } else if (!pj_stricmp2(&attr->name, "t38faxfillbitremoval")) {
543                         state->their_parms.fill_bit_removal = 1;
544                 } else if (!pj_stricmp2(&attr->name, "t38faxtranscodingmmr")) {
545                         state->their_parms.transcoding_mmr = 1;
546                 } else if (!pj_stricmp2(&attr->name, "t38faxtranscodingjbig")) {
547                         state->their_parms.transcoding_jbig = 1;
548                 } else if (!pj_stricmp2(&attr->name, "t38faxratemanagement")) {
549                         if (!pj_stricmp2(&attr->value, "localTCF")) {
550                                 state->their_parms.rate_management = AST_T38_RATE_MANAGEMENT_LOCAL_TCF;
551                         } else if (!pj_stricmp2(&attr->value, "transferredTCF")) {
552                                 state->their_parms.rate_management = AST_T38_RATE_MANAGEMENT_TRANSFERRED_TCF;
553                         }
554                 } else if (!pj_stricmp2(&attr->name, "t38faxudpec")) {
555                         if (!pj_stricmp2(&attr->value, "t38UDPRedundancy")) {
556                                 ast_udptl_set_error_correction_scheme(session_media->udptl, UDPTL_ERROR_CORRECTION_REDUNDANCY);
557                         } else if (!pj_stricmp2(&attr->value, "t38UDPFEC")) {
558                                 ast_udptl_set_error_correction_scheme(session_media->udptl, UDPTL_ERROR_CORRECTION_FEC);
559                         } else {
560                                 ast_udptl_set_error_correction_scheme(session_media->udptl, UDPTL_ERROR_CORRECTION_NONE);
561                         }
562                 }
563
564         }
565 }
566
567 /*! \brief Function which defers an incoming media stream */
568 static int defer_incoming_sdp_stream(struct ast_sip_session *session, struct ast_sip_session_media *session_media,
569                                          const struct pjmedia_sdp_session *sdp, const struct pjmedia_sdp_media *stream)
570 {
571         struct t38_state *state;
572
573         if (!session->endpoint->media.t38.enabled) {
574                 return 0;
575         }
576
577         if (t38_initialize_session(session, session_media)) {
578                 return 0;
579         }
580
581         if (!(state = t38_state_get_or_alloc(session))) {
582                 return 0;
583         }
584
585         t38_interpret_sdp(state, session, session_media, stream);
586
587         /* If they are initiating the re-invite we need to defer responding until later */
588         if (session->t38state == T38_DISABLED) {
589                 t38_change_state(session, session_media, state, T38_PEER_REINVITE);
590                 return 1;
591         }
592
593         return 0;
594 }
595
596 /*! \brief Function which negotiates an incoming media stream */
597 static int negotiate_incoming_sdp_stream(struct ast_sip_session *session, struct ast_sip_session_media *session_media,
598                                          const struct pjmedia_sdp_session *sdp, const struct pjmedia_sdp_media *stream)
599 {
600         struct t38_state *state;
601         char host[NI_MAXHOST];
602         RAII_VAR(struct ast_sockaddr *, addrs, NULL, ast_free_ptr);
603
604         if (!session->endpoint->media.t38.enabled) {
605                 return -1;
606         }
607
608         if (!(state = t38_state_get_or_alloc(session))) {
609                 return -1;
610         }
611
612         if ((session->t38state == T38_REJECTED) || (session->t38state == T38_DISABLED)) {
613                 t38_change_state(session, session_media, state, T38_DISABLED);
614                 return -1;
615         }
616
617         ast_copy_pj_str(host, stream->conn ? &stream->conn->addr : &sdp->conn->addr, sizeof(host));
618
619         /* Ensure that the address provided is valid */
620         if (ast_sockaddr_resolve(&addrs, host, PARSE_PORT_FORBID, AST_AF_INET) <= 0) {
621                 /* The provided host was actually invalid so we error out this negotiation */
622                 return -1;
623         }
624
625         /* Check the address family to make sure it matches configured */
626         if ((ast_sockaddr_is_ipv6(addrs) && !session->endpoint->media.t38.ipv6) ||
627                 (ast_sockaddr_is_ipv4(addrs) && session->endpoint->media.t38.ipv6)) {
628                 /* The address does not match configured */
629                 return -1;
630         }
631
632         return 1;
633 }
634
635 /*! \brief Function which creates an outgoing stream */
636 static int create_outgoing_sdp_stream(struct ast_sip_session *session, struct ast_sip_session_media *session_media,
637                                       struct pjmedia_sdp_session *sdp)
638 {
639         pj_pool_t *pool = session->inv_session->pool_prov;
640         static const pj_str_t STR_IN = { "IN", 2 };
641         static const pj_str_t STR_IP4 = { "IP4", 3};
642         static const pj_str_t STR_IP6 = { "IP6", 3};
643         static const pj_str_t STR_UDPTL = { "udptl", 5 };
644         static const pj_str_t STR_T38 = { "t38", 3 };
645         static const pj_str_t STR_TRANSFERREDTCF = { "transferredTCF", 14 };
646         static const pj_str_t STR_LOCALTCF = { "localTCF", 8 };
647         static const pj_str_t STR_T38UDPFEC = { "t38UDPFEC", 9 };
648         static const pj_str_t STR_T38UDPREDUNDANCY = { "t38UDPRedundancy", 16 };
649         struct t38_state *state;
650         pjmedia_sdp_media *media;
651         char hostip[PJ_INET6_ADDRSTRLEN+2];
652         struct ast_sockaddr addr;
653         char tmp[512];
654         pj_str_t stmp;
655
656         if (!session->endpoint->media.t38.enabled) {
657                 return 1;
658         } else if ((session->t38state != T38_LOCAL_REINVITE) && (session->t38state != T38_PEER_REINVITE) &&
659                 (session->t38state != T38_ENABLED)) {
660                 return 1;
661         } else if (!(state = t38_state_get_or_alloc(session))) {
662                 return -1;
663         } else if (t38_initialize_session(session, session_media)) {
664                 return -1;
665         }
666
667         if (!(media = pj_pool_zalloc(pool, sizeof(struct pjmedia_sdp_media))) ||
668                 !(media->conn = pj_pool_zalloc(pool, sizeof(struct pjmedia_sdp_conn)))) {
669                 return -1;
670         }
671
672         media->desc.media = pj_str(session_media->stream_type);
673         media->desc.transport = STR_UDPTL;
674
675         if (ast_strlen_zero(session->endpoint->media.address)) {
676                 pj_sockaddr localaddr;
677
678                 if (pj_gethostip(session->endpoint->media.t38.ipv6 ? pj_AF_INET6() : pj_AF_INET(), &localaddr)) {
679                         return -1;
680                 }
681                 pj_sockaddr_print(&localaddr, hostip, sizeof(hostip), 2);
682         } else {
683                 ast_copy_string(hostip, session->endpoint->media.address, sizeof(hostip));
684         }
685
686         media->conn->net_type = STR_IN;
687         media->conn->addr_type = session->endpoint->media.t38.ipv6 ? STR_IP6 : STR_IP4;
688         pj_strdup2(pool, &media->conn->addr, hostip);
689         ast_udptl_get_us(session_media->udptl, &addr);
690         media->desc.port = (pj_uint16_t) ast_sockaddr_port(&addr);
691         media->desc.port_count = 1;
692         media->desc.fmt[media->desc.fmt_count++] = STR_T38;
693
694         snprintf(tmp, sizeof(tmp), "%d", state->our_parms.version);
695         media->attr[media->attr_count++] = pjmedia_sdp_attr_create(pool, "T38FaxVersion", pj_cstr(&stmp, tmp));
696
697         snprintf(tmp, sizeof(tmp), "%d", t38_get_rate(state->our_parms.rate));
698         media->attr[media->attr_count++] = pjmedia_sdp_attr_create(pool, "T38MaxBitRate", pj_cstr(&stmp, tmp));
699
700         if (state->our_parms.fill_bit_removal) {
701                 media->attr[media->attr_count++] = pjmedia_sdp_attr_create(pool, "T38FaxFillBitRemoval", NULL);
702         }
703
704         if (state->our_parms.transcoding_mmr) {
705                 media->attr[media->attr_count++] = pjmedia_sdp_attr_create(pool, "T38FaxTranscodingMMR", NULL);
706         }
707
708         if (state->our_parms.transcoding_jbig) {
709                 media->attr[media->attr_count++] = pjmedia_sdp_attr_create(pool, "T38FaxTranscodingJBIG", NULL);
710         }
711
712         switch (state->our_parms.rate_management) {
713         case AST_T38_RATE_MANAGEMENT_TRANSFERRED_TCF:
714                 media->attr[media->attr_count++] = pjmedia_sdp_attr_create(pool, "T38FaxRateManagement", &STR_TRANSFERREDTCF);
715                 break;
716         case AST_T38_RATE_MANAGEMENT_LOCAL_TCF:
717                 media->attr[media->attr_count++] = pjmedia_sdp_attr_create(pool, "T38FaxRateManagement", &STR_LOCALTCF);
718                 break;
719         }
720
721         snprintf(tmp, sizeof(tmp), "%d", ast_udptl_get_local_max_datagram(session_media->udptl));
722         media->attr[media->attr_count++] = pjmedia_sdp_attr_create(pool, "T38FaxMaxDatagram", pj_cstr(&stmp, tmp));
723
724         switch (ast_udptl_get_error_correction_scheme(session_media->udptl)) {
725         case UDPTL_ERROR_CORRECTION_NONE:
726                 break;
727         case UDPTL_ERROR_CORRECTION_FEC:
728                 media->attr[media->attr_count++] = pjmedia_sdp_attr_create(pool, "T38FaxUdpEC", &STR_T38UDPFEC);
729                 break;
730         case UDPTL_ERROR_CORRECTION_REDUNDANCY:
731                 media->attr[media->attr_count++] = pjmedia_sdp_attr_create(pool, "T38FaxUdpEC", &STR_T38UDPREDUNDANCY);
732                 break;
733         }
734
735         sdp->media[sdp->media_count++] = media;
736
737         return 1;
738 }
739
740 /*! \brief Function which applies a negotiated stream */
741 static int apply_negotiated_sdp_stream(struct ast_sip_session *session, struct ast_sip_session_media *session_media,
742                                        const struct pjmedia_sdp_session *local, const struct pjmedia_sdp_media *local_stream,
743                                        const struct pjmedia_sdp_session *remote, const struct pjmedia_sdp_media *remote_stream)
744 {
745         RAII_VAR(struct ast_sockaddr *, addrs, NULL, ast_free_ptr);
746         char host[NI_MAXHOST];
747         struct t38_state *state;
748
749         if (!session_media->udptl) {
750                 return 0;
751         }
752
753         if (!(state = t38_state_get_or_alloc(session))) {
754                 return -1;
755         }
756
757         ast_copy_pj_str(host, remote_stream->conn ? &remote_stream->conn->addr : &remote->conn->addr, sizeof(host));
758
759         /* Ensure that the address provided is valid */
760         if (ast_sockaddr_resolve(&addrs, host, PARSE_PORT_FORBID, AST_AF_UNSPEC) <= 0) {
761                 /* The provided host was actually invalid so we error out this negotiation */
762                 return -1;
763         }
764
765         ast_sockaddr_set_port(addrs, remote_stream->desc.port);
766         ast_udptl_set_peer(session_media->udptl, addrs);
767
768         t38_interpret_sdp(state, session, session_media, remote_stream);
769
770         return 0;
771 }
772
773 /*! \brief Function which updates the media stream with external media address, if applicable */
774 static void change_outgoing_sdp_stream_media_address(pjsip_tx_data *tdata, struct pjmedia_sdp_media *stream, struct ast_sip_transport *transport)
775 {
776         char host[NI_MAXHOST];
777         struct ast_sockaddr addr = { { 0, } };
778
779         /* If the stream has been rejected there will be no connection line */
780         if (!stream->conn) {
781                 return;
782         }
783
784         ast_copy_pj_str(host, &stream->conn->addr, sizeof(host));
785         ast_sockaddr_parse(&addr, host, PARSE_PORT_FORBID);
786
787         /* Is the address within the SDP inside the same network? */
788         if (ast_apply_ha(transport->localnet, &addr) == AST_SENSE_ALLOW) {
789                 return;
790         }
791
792         pj_strdup2(tdata->pool, &stream->conn->addr, transport->external_media_address);
793 }
794
795 /*! \brief Function which destroys the UDPTL instance when session ends */
796 static void stream_destroy(struct ast_sip_session_media *session_media)
797 {
798         if (session_media->udptl) {
799                 ast_udptl_destroy(session_media->udptl);
800         }
801 }
802
803 /*! \brief SDP handler for 'image' media stream */
804 static struct ast_sip_session_sdp_handler image_sdp_handler = {
805         .id = "image",
806         .defer_incoming_sdp_stream = defer_incoming_sdp_stream,
807         .negotiate_incoming_sdp_stream = negotiate_incoming_sdp_stream,
808         .create_outgoing_sdp_stream = create_outgoing_sdp_stream,
809         .apply_negotiated_sdp_stream = apply_negotiated_sdp_stream,
810         .change_outgoing_sdp_stream_media_address = change_outgoing_sdp_stream_media_address,
811         .stream_destroy = stream_destroy,
812 };
813
814 /*! \brief Unloads the SIP T.38 module from Asterisk */
815 static int unload_module(void)
816 {
817         ast_sip_session_unregister_sdp_handler(&image_sdp_handler, "image");
818         ast_sip_session_unregister_supplement(&t38_supplement);
819
820         return 0;
821 }
822
823 /*!
824  * \brief Load the module
825  *
826  * Module loading including tests for configuration or dependencies.
827  * This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
828  * or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
829  * tests return AST_MODULE_LOAD_FAILURE. If the module can not load the
830  * configuration file or other non-critical problem return
831  * AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
832  */
833 static int load_module(void)
834 {
835         ast_sockaddr_parse(&address_ipv4, "0.0.0.0", 0);
836         ast_sockaddr_parse(&address_ipv6, "::", 0);
837
838         if (ast_sip_session_register_supplement(&t38_supplement)) {
839                 ast_log(LOG_ERROR, "Unable to register T.38 session supplement\n");
840                 goto end;
841         }
842
843         if (ast_sip_session_register_sdp_handler(&image_sdp_handler, "image")) {
844                 ast_log(LOG_ERROR, "Unable to register SDP handler for image stream type\n");
845                 goto end;
846         }
847
848         return AST_MODULE_LOAD_SUCCESS;
849 end:
850         unload_module();
851
852         return AST_MODULE_LOAD_FAILURE;
853 }
854
855 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "PJSIP T.38 UDPTL Support",
856                 .load = load_module,
857                 .unload = unload_module,
858                 .load_pri = AST_MODPRI_CHANNEL_DRIVER,
859         );