src/telepathy/telepathy-transport.c

   1 /**
   2  * @file telepathy-transport.c
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2012-2017 SIPE Project <http://sipe.sourceforge.net/>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 #ifdef HAVE_CONFIG_H
  24 #include "config.h"
  25 #endif
  26
  27 #include <string.h>
  28
  29 #include <glib.h>
  30 #include <gio/gio.h>
  31
  32 #include "sipe-backend.h"
  33 #include "sipe-common.h"
  34 #include "sipe-core.h"
  35 #include "sipe-nls.h"
  36
  37 #include "telepathy-private.h"
  38
  39 struct sipe_transport_telepathy {
  40         /* public part shared with core */
  41         struct sipe_transport_connection public;
  42
  43         /* telepathy private part */
  44         transport_connected_cb *connected;
  45         transport_input_cb *input;
  46         transport_error_cb *error;
  47         gchar *hostname;
  48         struct sipe_tls_info *tls_info;
  49         struct sipe_backend_private *private;
  50         GCancellable *cancel;
  51         GSocketConnection *socket;
  52         GInputStream *istream;
  53         GOutputStream *ostream;
  54         GSList *buffers; /* != NULL -> write operation in progress */
  55         guint port;
  56         gboolean do_flush;
  57 };
  58
  59 #define TELEPATHY_TRANSPORT ((struct sipe_transport_telepathy *) conn)
  60 #define SIPE_TRANSPORT_CONNECTION ((struct sipe_transport_connection *) transport)
  61
  62 #define BUFFER_SIZE_INCREMENT 4096
  63
  64 static void read_completed(GObject *stream,
  65                            GAsyncResult *result,
  66                            gpointer data)
  67 {
  68         struct sipe_transport_telepathy *transport = data;
  69         struct sipe_transport_connection *conn = SIPE_TRANSPORT_CONNECTION;
  70
  71         do {
  72                 if (conn->buffer_length < conn->buffer_used + BUFFER_SIZE_INCREMENT) {
  73                         conn->buffer_length += BUFFER_SIZE_INCREMENT;
  74                         conn->buffer = g_realloc(conn->buffer, conn->buffer_length);
  75                         SIPE_DEBUG_INFO("read_completed: new buffer length %" G_GSIZE_FORMAT,
  76                                         conn->buffer_length);
  77                 }
  78
  79                 /* callback result is valid */
  80                 if (result) {
  81                         GError *error = NULL;
  82                         gssize len    = g_input_stream_read_finish(G_INPUT_STREAM(stream),
  83                                                                    result,
  84                                                                    &error);
  85
  86                         if (len < 0) {
  87                                 const gchar *msg = error ? error->message : "UNKNOWN";
  88                                 SIPE_DEBUG_ERROR("read_completed: error: %s", msg);
  89                                 if (transport->error)
  90                                         transport->error(conn, msg);
  91                                 if (error)
  92                                         g_error_free(error);
  93                                 return;
  94                         } else if (len == 0) {
  95                                 SIPE_DEBUG_ERROR_NOFORMAT("read_completed: server has disconnected");
  96                                 transport->error(conn, _("Server has disconnected"));
  97                                 return;
  98                         } else if (transport->do_flush) {
  99                                 /* read completed while disconnected transport is flushing */
 100                                 SIPE_DEBUG_INFO_NOFORMAT("read_completed: ignored during flushing");
 101                                 return;
 102                         } else if (g_cancellable_is_cancelled(transport->cancel)) {
 103                                 /* read completed when transport was disconnected */
 104                                 SIPE_DEBUG_INFO_NOFORMAT("read_completed: cancelled");
 105                                 return;
 106                         }
 107
 108                         /* Forward data to core */
 109                         conn->buffer_used               += len;
 110                         conn->buffer[conn->buffer_used]  = '\0';
 111                         transport->input(conn);
 112
 113                         /* we processed the result */
 114                         result = NULL;
 115                 }
 116
 117                 /* buffer too short? */
 118         } while (conn->buffer_length - conn->buffer_used - 1 == 0);
 119
 120         /* setup next read */
 121         g_input_stream_read_async(G_INPUT_STREAM(stream),
 122                                   conn->buffer + conn->buffer_used,
 123                                   conn->buffer_length - conn->buffer_used - 1,
 124                                   G_PRIORITY_DEFAULT,
 125                                   transport->cancel,
 126                                   read_completed,
 127                                   transport);
 128 }
 129
 130 static gboolean internal_connect(gpointer data);
 131 static void certificate_result(SIPE_UNUSED_PARAMETER GObject *unused,
 132                                GAsyncResult *result,
 133                                gpointer data)
 134 {
 135         struct sipe_transport_telepathy *transport = data;
 136         GError *error = NULL;
 137
 138         g_simple_async_result_propagate_error(G_SIMPLE_ASYNC_RESULT(result),
 139                                               &error);
 140         if (error) {
 141                 SIPE_DEBUG_INFO("certificate_result: %s", error->message);
 142                 if (transport->error)
 143                         transport->error(SIPE_TRANSPORT_CONNECTION,
 144                                          error->message);
 145                 g_error_free(error);
 146         } else {
 147                 SIPE_DEBUG_INFO("certificate_result: trigger reconnect %p", transport);
 148                 g_idle_add(internal_connect, transport);
 149         }
 150 }
 151
 152 static void socket_connected(GObject *client,
 153                              GAsyncResult *result,
 154                              gpointer data)
 155 {
 156         struct sipe_transport_telepathy *transport = data;
 157         GError *error = NULL;
 158
 159         transport->socket = g_socket_client_connect_finish(G_SOCKET_CLIENT(client),
 160                                                            result,
 161                                                            &error);
 162
 163         if (transport->socket == NULL) {
 164                 if (transport->tls_info) {
 165                         SIPE_DEBUG_INFO_NOFORMAT("socket_connected: need to wait for user interaction");
 166                         sipe_telepathy_tls_verify_async(G_OBJECT(transport->private->connection),
 167                                                         transport->tls_info,
 168                                                         certificate_result,
 169                                                         transport);
 170                 } else {
 171                         const gchar *msg = error ? error->message : "UNKNOWN";
 172                         SIPE_DEBUG_ERROR("socket_connected: failed: %s", msg);
 173                         if (transport->error)
 174                                 transport->error(SIPE_TRANSPORT_CONNECTION, msg);
 175                         if (error)
 176                                 g_error_free(error);
 177                 }
 178         } else if (g_cancellable_is_cancelled(transport->cancel)) {
 179                 /* connect already succeeded when transport was disconnected */
 180                 g_object_unref(transport->socket);
 181                 transport->socket = NULL;
 182                 SIPE_DEBUG_INFO_NOFORMAT("socket_connected: succeeded, but cancelled");
 183         } else {
 184                 GSocketAddress *saddr = g_socket_connection_get_local_address(transport->socket,
 185                                                                               &error);
 186
 187                 if (saddr) {
 188                         SIPE_DEBUG_INFO_NOFORMAT("socket_connected: success");
 189
 190                         transport->public.client_port = g_inet_socket_address_get_port(G_INET_SOCKET_ADDRESS(saddr));
 191                         g_object_unref(saddr);
 192
 193                         transport->istream = g_io_stream_get_input_stream(G_IO_STREAM(transport->socket));
 194                         transport->ostream = g_io_stream_get_output_stream(G_IO_STREAM(transport->socket));
 195
 196                         /* the first connection is always to the server */
 197                         if (transport->private->transport == NULL)
 198                                 transport->private->transport = transport;
 199
 200                         /* this sets up the async read handler */
 201                         read_completed(G_OBJECT(transport->istream), NULL, transport);
 202                         transport->connected(SIPE_TRANSPORT_CONNECTION);
 203
 204                 } else {
 205                         g_object_unref(transport->socket);
 206                         transport->socket = NULL;
 207                         SIPE_DEBUG_ERROR("socket_connected: failed: %s", error->message);
 208                         transport->error(SIPE_TRANSPORT_CONNECTION, error->message);
 209                         g_error_free(error);
 210                 }
 211         }
 212 }
 213
 214 static gboolean accept_certificate_signal(SIPE_UNUSED_PARAMETER GTlsConnection *tls,
 215                                           GTlsCertificate *peer_cert,
 216                                           SIPE_UNUSED_PARAMETER GTlsCertificateFlags errors,
 217                                           gpointer user_data)
 218 {
 219         struct sipe_transport_telepathy *transport = user_data;
 220
 221         SIPE_DEBUG_INFO("accept_certificate_signal: %p", transport);
 222
 223         /* second connection attempt after feedback from user? */
 224         if (transport->tls_info) {
 225                 /* user accepted certificate */
 226                 sipe_telepathy_tls_info_free(transport->tls_info);
 227                 transport->tls_info = NULL;
 228                 return(TRUE);
 229         } else {
 230                 /* retry after user accepted certificate */
 231                 transport->tls_info = sipe_telepathy_tls_info_new(transport->hostname,
 232                                                                   peer_cert);
 233                 return(FALSE);
 234         }
 235 }
 236
 237 static void tls_handshake_starts(SIPE_UNUSED_PARAMETER GSocketClient *client,
 238                                  GSocketClientEvent event,
 239                                  SIPE_UNUSED_PARAMETER GSocketConnectable *connectable,
 240                                  GIOStream *connection,
 241                                  gpointer user_data)
 242 {
 243         if (event == G_SOCKET_CLIENT_TLS_HANDSHAKING) {
 244                 SIPE_DEBUG_INFO("tls_handshake_starts: %p", connection);
 245                 g_signal_connect(connection, /* is a GTlsConnection */
 246                                  "accept-certificate",
 247                                  G_CALLBACK(accept_certificate_signal),
 248                                  user_data);
 249         }
 250 }
 251
 252 static gboolean internal_connect(gpointer data)
 253 {
 254         struct sipe_transport_telepathy *transport = data;
 255         GSocketClient *client = g_socket_client_new();
 256
 257         SIPE_DEBUG_INFO("internal_connect - hostname: %s port: %d",
 258                         transport->hostname, transport->port);
 259
 260         /* request TLS connection */
 261         if (transport->public.type == SIPE_TRANSPORT_TLS) {
 262                 SIPE_DEBUG_INFO_NOFORMAT("using TLS");
 263                 g_socket_client_set_tls(client, TRUE);
 264                 g_signal_connect(client,
 265                                  "event",
 266                                  G_CALLBACK(tls_handshake_starts),
 267                                  transport);
 268         } else
 269                 SIPE_DEBUG_INFO_NOFORMAT("using TCP");
 270
 271         g_socket_client_connect_async(client,
 272                                       g_network_address_new(transport->hostname,
 273                                                             transport->port),
 274                                       transport->cancel,
 275                                       socket_connected,
 276                                       transport);
 277         g_object_unref(client);
 278
 279         return(FALSE);
 280 }
 281
 282 struct sipe_transport_connection *sipe_backend_transport_connect(struct sipe_core_public *sipe_public,
 283                                                                  const sipe_connect_setup *setup)
 284 {
 285         struct sipe_transport_telepathy *transport = g_new0(struct sipe_transport_telepathy, 1);
 286
 287         transport->public.type      = setup->type;
 288         transport->public.user_data = setup->user_data;
 289         transport->connected        = setup->connected;
 290         transport->input            = setup->input;
 291         transport->error            = setup->error;
 292         transport->hostname         = g_strdup(setup->server_name);
 293         transport->tls_info         = NULL;
 294         transport->private          = sipe_public->backend_private;
 295         transport->cancel           = g_cancellable_new();
 296         transport->buffers          = NULL;
 297         transport->port             = setup->server_port;
 298         transport->do_flush         = FALSE;
 299
 300         if ((setup->type == SIPE_TRANSPORT_TLS) ||
 301             (setup->type == SIPE_TRANSPORT_TCP)) {
 302
 303                 internal_connect(transport);
 304                 return(SIPE_TRANSPORT_CONNECTION);
 305
 306         } else {
 307                 setup->error(SIPE_TRANSPORT_CONNECTION,
 308                              "This should not happen...");
 309                 sipe_backend_transport_disconnect(SIPE_TRANSPORT_CONNECTION);
 310                 return(NULL);
 311         }
 312 }
 313
 314 static gboolean free_transport(gpointer data)
 315 {
 316         struct sipe_transport_telepathy *transport = data;
 317         GSList *entry;
 318
 319         SIPE_DEBUG_INFO("free_transport %p", transport);
 320
 321         if (transport->tls_info)
 322                 sipe_telepathy_tls_info_free(transport->tls_info);
 323         g_free(transport->hostname);
 324
 325         /* free unflushed buffers */
 326         for (entry = transport->buffers; entry; entry = entry->next)
 327                 g_free(entry->data);
 328         g_slist_free(transport->buffers);
 329
 330         if (transport->cancel)
 331                 g_object_unref(transport->cancel);
 332
 333         g_free(transport);
 334
 335         return(FALSE);
 336 }
 337
 338 static void close_completed(GObject *stream,
 339                             GAsyncResult *result,
 340                             gpointer data)
 341 {
 342         struct sipe_transport_telepathy *transport = data;
 343         SIPE_DEBUG_INFO("close_completed: transport %p", data);
 344         g_io_stream_close_finish(G_IO_STREAM(stream), result, NULL);
 345         g_idle_add(free_transport, transport);
 346 }
 347
 348 static void do_close(struct sipe_transport_telepathy *transport)
 349 {
 350         SIPE_DEBUG_INFO("do_close: %p", transport);
 351
 352         /* cancel outstanding asynchronous operations */
 353         transport->do_flush = FALSE;
 354         g_cancellable_cancel(transport->cancel);
 355         g_io_stream_close_async(G_IO_STREAM(transport->socket),
 356                                 G_PRIORITY_DEFAULT,
 357                                 NULL,
 358                                 close_completed,
 359                                 transport);
 360 }
 361
 362 void sipe_backend_transport_disconnect(struct sipe_transport_connection *conn)
 363 {
 364         struct sipe_transport_telepathy *transport = TELEPATHY_TRANSPORT;
 365
 366         if (!transport) return;
 367
 368         SIPE_DEBUG_INFO("sipe_backend_transport_disconnect: %p", transport);
 369
 370         /* error callback is invalid now, do no longer call! */
 371         transport->error = NULL;
 372
 373         /* dropping connection to the server? */
 374         if (transport->private->transport == transport)
 375                 transport->private->transport = NULL;
 376
 377         /* already connected? */
 378         if (transport->socket) {
 379
 380                 /* flush required? */
 381                 if (transport->do_flush && transport->buffers)
 382                         SIPE_DEBUG_INFO("sipe_backend_transport_disconnect: %p needs flushing",
 383                                         transport);
 384                 else
 385                         do_close(transport);
 386
 387         } else {
 388                 /* cancel outstanding connect operation */
 389                 if (transport->cancel)
 390                         g_cancellable_cancel(transport->cancel);
 391
 392                 /* queue transport to be deleted */
 393                 g_idle_add(free_transport, transport);
 394         }
 395 }
 396
 397 gchar *sipe_backend_transport_ip_address(struct sipe_transport_connection *conn)
 398 {
 399         struct sipe_transport_telepathy *transport = TELEPATHY_TRANSPORT;
 400         gchar *ipstr = NULL;
 401
 402         if (transport && transport->socket) {
 403                 GSocketAddress *saddr = g_socket_connection_get_local_address(transport->socket,
 404                                                                               NULL);
 405
 406                 if (saddr) {
 407                         GInetAddress *iaddr = g_inet_socket_address_get_address(G_INET_SOCKET_ADDRESS(saddr));
 408
 409                         if (iaddr) {
 410                                 ipstr = g_inet_address_to_string(iaddr);
 411                                 SIPE_DEBUG_INFO("sipe_backend_transport_ip_address: %s", ipstr);
 412                         }
 413                         g_object_unref(saddr);
 414                 }
 415         }
 416
 417         return(ipstr ? ipstr : g_strdup("0.0.0.0"));
 418 }
 419
 420 static void do_write(struct sipe_transport_telepathy *transport);
 421 static void write_completed(GObject *stream,
 422                             GAsyncResult *result,
 423                             gpointer data)
 424 {
 425         struct sipe_transport_telepathy *transport = data;
 426         gchar                           *buffer;
 427         GError                          *error     = NULL;
 428         gssize written = g_output_stream_write_finish(G_OUTPUT_STREAM(stream),
 429                                                       result,
 430                                                       &error);
 431
 432         /* free the buffer that has just been written. */
 433         buffer = transport->buffers->data;
 434         transport->buffers = g_slist_remove(transport->buffers, buffer);
 435         g_free(buffer);
 436
 437         if ((written < 0) || error) {
 438                 const gchar *msg = error ? error->message : "UNKNOWN";
 439                 SIPE_DEBUG_ERROR("write_completed: error: %s", msg);
 440                 if (transport->error)
 441                         transport->error(SIPE_TRANSPORT_CONNECTION, msg);
 442                 if (error)
 443                         g_error_free(error);
 444
 445                 /* error during flush: give up and close transport */
 446                 if (transport->do_flush)
 447                         do_close(transport);
 448
 449         } else if (g_cancellable_is_cancelled(transport->cancel)) {
 450                 /* write completed when transport was disconnected */
 451                 SIPE_DEBUG_INFO_NOFORMAT("write_completed: cancelled");
 452         } else {
 453                 /* more to write? */
 454                 if (transport->buffers) {
 455                         do_write(transport);
 456                 /* flush completed? */
 457                 } else if (transport->do_flush) {
 458                         do_close(transport);
 459                 }
 460         }
 461 }
 462
 463 static void do_write(struct sipe_transport_telepathy *transport)
 464 {
 465         g_output_stream_write_async(transport->ostream,
 466                                     transport->buffers->data,
 467                                     strlen(transport->buffers->data),
 468                                     G_PRIORITY_DEFAULT,
 469                                     transport->cancel,
 470                                     write_completed,
 471                                     transport);
 472 }
 473
 474 void sipe_backend_transport_message(struct sipe_transport_connection *conn,
 475                                     const gchar *buffer)
 476 {
 477         struct sipe_transport_telepathy *transport = TELEPATHY_TRANSPORT;
 478         gboolean can_write = (transport->buffers == NULL);
 479
 480         transport->buffers = g_slist_append(transport->buffers, g_strdup(buffer));
 481
 482         if (can_write)
 483                 do_write(transport);
 484 }
 485
 486 void sipe_backend_transport_flush(struct sipe_transport_connection *conn)
 487 {
 488         struct sipe_transport_telepathy *transport = TELEPATHY_TRANSPORT;
 489         transport->do_flush = TRUE;
 490 }
 491
 492
 493 /*
 494   Local Variables:
 495   mode: c
 496   c-file-style: "bsd"
 497   indent-tabs-mode: t
 498   tab-width: 8
 499   End:
 500 */