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