gio/gunixconnection.c

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright © 2009 Codethink Limited
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU Lesser General Public License as published
   7  * by the Free Software Foundation; either version 2 of the licence or (at
   8  * your option) any later version.
   9  *
  10  * See the included COPYING file for more information.
  11  *
  12  * Authors: Ryan Lortie <desrt@desrt.ca>
  13  */
  14
  15 #include "config.h"
  16 #include "gunixconnection.h"
  17 #include "gunixcredentialsmessage.h"
  18 #include "glibintl.h"
  19
  20 /**
  21  * SECTION:gunixconnection
  22  * @title: GUnixConnection
  23  * @short_description: A UNIX domain GSocketConnection
  24  * @include: gio/gunixconnection.h
  25  * @see_also: #GSocketConnection.
  26  *
  27  * This is the subclass of #GSocketConnection that is created
  28  * for UNIX domain sockets.
  29  *
  30  * It contains functions to do some of the UNIX socket specific
  31  * functionality like passing file descriptors.
  32  *
  33  * Note that <filename>&lt;gio/gunixconnection.h&gt;</filename> belongs to
  34  * the UNIX-specific GIO interfaces, thus you have to use the
  35  * <filename>gio-unix-2.0.pc</filename> pkg-config file when using it.
  36  *
  37  * Since: 2.22
  38  */
  39
  40 #include <gio/gsocketcontrolmessage.h>
  41 #include <gio/gunixfdmessage.h>
  42 #include <gio/gsocket.h>
  43 #include <unistd.h>
  44
  45 #ifdef __linux__
  46 /* for getsockopt() and setsockopt() */
  47 #include <sys/types.h>          /* See NOTES */
  48 #include <sys/socket.h>
  49 #include <errno.h>
  50 #include <string.h>
  51 #endif
  52
  53
  54 G_DEFINE_TYPE_WITH_CODE (GUnixConnection, g_unix_connection,
  55                          G_TYPE_SOCKET_CONNECTION,
  56   g_socket_connection_factory_register_type (g_define_type_id,
  57                                              G_SOCKET_FAMILY_UNIX,
  58                                              G_SOCKET_TYPE_STREAM,
  59                                              G_SOCKET_PROTOCOL_DEFAULT);
  60                          );
  61
  62 /**
  63  * g_unix_connection_send_fd:
  64  * @connection: a #GUnixConnection
  65  * @fd: a file descriptor
  66  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
  67  * @error: (allow-none): #GError for error reporting, or %NULL to ignore.
  68  *
  69  * Passes a file descriptor to the receiving side of the
  70  * connection. The receiving end has to call g_unix_connection_receive_fd()
  71  * to accept the file descriptor.
  72  *
  73  * As well as sending the fd this also writes a single byte to the
  74  * stream, as this is required for fd passing to work on some
  75  * implementations.
  76  *
  77  * Returns: a %TRUE on success, %NULL on error.
  78  *
  79  * Since: 2.22
  80  */
  81 gboolean
  82 g_unix_connection_send_fd (GUnixConnection  *connection,
  83                            gint              fd,
  84                            GCancellable     *cancellable,
  85                            GError          **error)
  86 {
  87   GSocketControlMessage *scm;
  88   GSocket *socket;
  89
  90   g_return_val_if_fail (G_IS_UNIX_CONNECTION (connection), FALSE);
  91   g_return_val_if_fail (fd >= 0, FALSE);
  92
  93   scm = g_unix_fd_message_new ();
  94
  95   if (!g_unix_fd_message_append_fd (G_UNIX_FD_MESSAGE (scm), fd, error))
  96     {
  97       g_object_unref (scm);
  98       return FALSE;
  99     }
 100
 101   g_object_get (connection, "socket", &socket, NULL);
 102   if (g_socket_send_message (socket, NULL, NULL, 0, &scm, 1, 0, cancellable, error) != 1)
 103     /* XXX could it 'fail' with zero? */
 104     {
 105       g_object_unref (socket);
 106       g_object_unref (scm);
 107
 108       return FALSE;
 109     }
 110
 111   g_object_unref (socket);
 112   g_object_unref (scm);
 113
 114   return TRUE;
 115 }
 116
 117 /**
 118  * g_unix_connection_receive_fd:
 119  * @connection: a #GUnixConnection
 120  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
 121  * @error: (allow-none): #GError for error reporting, or %NULL to ignore
 122  *
 123  * Receives a file descriptor from the sending end of the connection.
 124  * The sending end has to call g_unix_connection_send_fd() for this
 125  * to work.
 126  *
 127  * As well as reading the fd this also reads a single byte from the
 128  * stream, as this is required for fd passing to work on some
 129  * implementations.
 130  *
 131  * Returns: a file descriptor on success, -1 on error.
 132  *
 133  * Since: 2.22
 134  **/
 135 gint
 136 g_unix_connection_receive_fd (GUnixConnection  *connection,
 137                               GCancellable     *cancellable,
 138                               GError          **error)
 139 {
 140   GSocketControlMessage **scms;
 141   gint *fds, nfd, fd, nscm;
 142   GUnixFDMessage *fdmsg;
 143   GSocket *socket;
 144
 145   g_return_val_if_fail (G_IS_UNIX_CONNECTION (connection), -1);
 146
 147   g_object_get (connection, "socket", &socket, NULL);
 148   if (g_socket_receive_message (socket, NULL, NULL, 0,
 149                                 &scms, &nscm, NULL, cancellable, error) != 1)
 150     /* XXX it _could_ 'fail' with zero. */
 151     {
 152       g_object_unref (socket);
 153
 154       return -1;
 155     }
 156
 157   g_object_unref (socket);
 158
 159   if (nscm != 1)
 160     {
 161       gint i;
 162
 163       g_set_error (error, G_IO_ERROR, G_IO_ERROR_FAILED,
 164                    _("Expecting 1 control message, got %d"), nscm);
 165
 166       for (i = 0; i < nscm; i++)
 167         g_object_unref (scms[i]);
 168
 169       g_free (scms);
 170
 171       return -1;
 172     }
 173
 174   if (!G_IS_UNIX_FD_MESSAGE (scms[0]))
 175     {
 176       g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_FAILED,
 177                            _("Unexpected type of ancillary data"));
 178       g_object_unref (scms[0]);
 179       g_free (scms);
 180
 181       return -1;
 182     }
 183
 184   fdmsg = G_UNIX_FD_MESSAGE (scms[0]);
 185   g_free (scms);
 186
 187   fds = g_unix_fd_message_steal_fds (fdmsg, &nfd);
 188   g_object_unref (fdmsg);
 189
 190   if (nfd != 1)
 191     {
 192       gint i;
 193
 194       g_set_error (error, G_IO_ERROR, G_IO_ERROR_FAILED,
 195                    _("Expecting one fd, but got %d\n"), nfd);
 196
 197       for (i = 0; i < nfd; i++)
 198         close (fds[i]);
 199
 200       g_free (fds);
 201
 202       return -1;
 203     }
 204
 205   fd = *fds;
 206   g_free (fds);
 207
 208   if (fd < 0)
 209     {
 210       g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_FAILED,
 211                            _("Received invalid fd"));
 212       fd = -1;
 213     }
 214
 215   return fd;
 216 }
 217
 218 static void
 219 g_unix_connection_init (GUnixConnection *connection)
 220 {
 221 }
 222
 223 static void
 224 g_unix_connection_class_init (GUnixConnectionClass *class)
 225 {
 226 }
 227
 228 /* TODO: Other stuff we might want to add are:
 229 void                    g_unix_connection_send_fd_async                 (GUnixConnection      *connection,
 230                                                                          gint                  fd,
 231                                                                          gboolean              close,
 232                                                                          gint                  io_priority,
 233                                                                          GAsyncReadyCallback   callback,
 234                                                                          gpointer              user_data);
 235 gboolean                g_unix_connection_send_fd_finish                (GUnixConnection      *connection,
 236                                                                          GError              **error);
 237
 238 gboolean                g_unix_connection_send_fds                      (GUnixConnection      *connection,
 239                                                                          gint                 *fds,
 240                                                                          gint                  nfds,
 241                                                                          GError              **error);
 242 void                    g_unix_connection_send_fds_async                (GUnixConnection      *connection,
 243                                                                          gint                 *fds,
 244                                                                          gint                  nfds,
 245                                                                          gint                  io_priority,
 246                                                                          GAsyncReadyCallback   callback,
 247                                                                          gpointer              user_data);
 248 gboolean                g_unix_connection_send_fds_finish               (GUnixConnection      *connection,
 249                                                                          GError              **error);
 250
 251 void                    g_unix_connection_receive_fd_async              (GUnixConnection      *connection,
 252                                                                          gint                  io_priority,
 253                                                                          GAsyncReadyCallback   callback,
 254                                                                          gpointer              user_data);
 255 gint                    g_unix_connection_receive_fd_finish             (GUnixConnection      *connection,
 256                                                                          GError              **error);
 257
 258
 259 gboolean                g_unix_connection_send_fake_credentials         (GUnixConnection      *connection,
 260                                                                          guint64               pid,
 261                                                                          guint64               uid,
 262                                                                          guint64               gid,
 263                                                                          GError              **error);
 264 void                    g_unix_connection_send_fake_credentials_async   (GUnixConnection      *connection,
 265                                                                          guint64               pid,
 266                                                                          guint64               uid,
 267                                                                          guint64               gid,
 268                                                                          gint                  io_priority,
 269                                                                          GAsyncReadyCallback   callback,
 270                                                                          gpointer              user_data);
 271 gboolean                g_unix_connection_send_fake_credentials_finish  (GUnixConnection      *connection,
 272                                                                          GError              **error);
 273
 274 gboolean                g_unix_connection_create_pair                   (GUnixConnection     **one,
 275                                                                          GUnixConnection     **two,
 276                                                                          GError              **error);
 277 */
 278
 279
 280 /**
 281  * g_unix_connection_send_credentials:
 282  * @connection: A #GUnixConnection.
 283  * @cancellable: (allow-none): A #GCancellable or %NULL.
 284  * @error: Return location for error or %NULL.
 285  *
 286  * Passes the credentials of the current user the receiving side
 287  * of the connection. The receiving end has to call
 288  * g_unix_connection_receive_credentials() (or similar) to accept the
 289  * credentials.
 290  *
 291  * As well as sending the credentials this also writes a single NUL
 292  * byte to the stream, as this is required for credentials passing to
 293  * work on some implementations.
 294  *
 295  * Other ways to exchange credentials with a foreign peer includes the
 296  * #GUnixCredentialsMessage type and g_socket_get_credentials() function.
 297  *
 298  * Returns: %TRUE on success, %FALSE if @error is set.
 299  *
 300  * Since: 2.26
 301  */
 302 gboolean
 303 g_unix_connection_send_credentials (GUnixConnection      *connection,
 304                                     GCancellable         *cancellable,
 305                                     GError              **error)
 306 {
 307   GCredentials *credentials;
 308   GSocketControlMessage *scm;
 309   GSocket *socket;
 310   gboolean ret;
 311   GOutputVector vector;
 312   guchar nul_byte[1] = {'\0'};
 313   gint num_messages;
 314
 315   g_return_val_if_fail (G_IS_UNIX_CONNECTION (connection), FALSE);
 316   g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
 317
 318   ret = FALSE;
 319
 320   credentials = g_credentials_new ();
 321
 322   vector.buffer = &nul_byte;
 323   vector.size = 1;
 324
 325   if (g_unix_credentials_message_is_supported ())
 326     {
 327       scm = g_unix_credentials_message_new_with_credentials (credentials);
 328       num_messages = 1;
 329     }
 330   else
 331     {
 332       scm = NULL;
 333       num_messages = 0;
 334     }
 335
 336   g_object_get (connection, "socket", &socket, NULL);
 337   if (g_socket_send_message (socket,
 338                              NULL, /* address */
 339                              &vector,
 340                              1,
 341                              &scm,
 342                              num_messages,
 343                              G_SOCKET_MSG_NONE,
 344                              cancellable,
 345                              error) != 1)
 346     {
 347       g_prefix_error (error, _("Error sending credentials: "));
 348       goto out;
 349     }
 350
 351   ret = TRUE;
 352
 353  out:
 354   g_object_unref (socket);
 355   if (scm != NULL)
 356     g_object_unref (scm);
 357   g_object_unref (credentials);
 358   return ret;
 359 }
 360
 361 static void
 362 send_credentials_async_thread (GTask         *task,
 363                                gpointer       source_object,
 364                                gpointer       task_data,
 365                                GCancellable  *cancellable)
 366 {
 367   GError *error = NULL;
 368
 369   if (g_unix_connection_send_credentials (G_UNIX_CONNECTION (source_object),
 370                                           cancellable,
 371                                           &error))
 372     g_task_return_boolean (task, TRUE);
 373   else
 374     g_task_return_error (task, error);
 375   g_object_unref (task);
 376 }
 377
 378 /**
 379  * g_unix_connection_send_credentials_async:
 380  * @connection: A #GUnixConnection.
 381  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
 382  * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
 383  * @user_data: (closure): the data to pass to callback function
 384  *
 385  * Asynchronously send credentials.
 386  *
 387  * For more details, see g_unix_connection_send_credentials() which is
 388  * the synchronous version of this call.
 389  *
 390  * When the operation is finished, @callback will be called. You can then call
 391  * g_unix_connection_send_credentials_finish() to get the result of the operation.
 392  *
 393  * Since: 2.32
 394  **/
 395 void
 396 g_unix_connection_send_credentials_async (GUnixConnection      *connection,
 397                                           GCancellable         *cancellable,
 398                                           GAsyncReadyCallback   callback,
 399                                           gpointer              user_data)
 400 {
 401   GTask *task;
 402
 403   task = g_task_new (connection, cancellable, callback, user_data);
 404
 405   g_task_run_in_thread (task, send_credentials_async_thread);
 406 }
 407
 408 /**
 409  * g_unix_connection_send_credentials_finish:
 410  * @connection: A #GUnixConnection.
 411  * @result: a #GAsyncResult.
 412  * @error: a #GError, or %NULL
 413  *
 414  * Finishes an asynchronous send credentials operation started with
 415  * g_unix_connection_send_credentials_async().
 416  *
 417  * Returns: %TRUE if the operation was successful, otherwise %FALSE.
 418  *
 419  * Since: 2.32
 420  **/
 421 gboolean
 422 g_unix_connection_send_credentials_finish (GUnixConnection *connection,
 423                                            GAsyncResult    *result,
 424                                            GError         **error)
 425 {
 426   g_return_val_if_fail (g_task_is_valid (result, connection), FALSE);
 427
 428   return g_task_propagate_boolean (G_TASK (result), error);
 429 }
 430
 431 /**
 432  * g_unix_connection_receive_credentials:
 433  * @connection: A #GUnixConnection.
 434  * @cancellable: (allow-none): A #GCancellable or %NULL.
 435  * @error: Return location for error or %NULL.
 436  *
 437  * Receives credentials from the sending end of the connection.  The
 438  * sending end has to call g_unix_connection_send_credentials() (or
 439  * similar) for this to work.
 440  *
 441  * As well as reading the credentials this also reads (and discards) a
 442  * single byte from the stream, as this is required for credentials
 443  * passing to work on some implementations.
 444  *
 445  * Other ways to exchange credentials with a foreign peer includes the
 446  * #GUnixCredentialsMessage type and g_socket_get_credentials() function.
 447  *
 448  * Returns: (transfer full): Received credentials on success (free with
 449  * g_object_unref()), %NULL if @error is set.
 450  *
 451  * Since: 2.26
 452  */
 453 GCredentials *
 454 g_unix_connection_receive_credentials (GUnixConnection      *connection,
 455                                        GCancellable         *cancellable,
 456                                        GError              **error)
 457 {
 458   GCredentials *ret;
 459   GSocketControlMessage **scms;
 460   gint nscm;
 461   GSocket *socket;
 462   gint n;
 463   gssize num_bytes_read;
 464 #ifdef __linux__
 465   gboolean turn_off_so_passcreds;
 466 #endif
 467
 468   g_return_val_if_fail (G_IS_UNIX_CONNECTION (connection), NULL);
 469   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
 470
 471   ret = NULL;
 472   scms = NULL;
 473
 474   g_object_get (connection, "socket", &socket, NULL);
 475
 476   /* On Linux, we need to turn on SO_PASSCRED if it isn't enabled
 477    * already. We also need to turn it off when we're done.  See
 478    * #617483 for more discussion.
 479    */
 480 #ifdef __linux__
 481   {
 482     gint opt_val;
 483     socklen_t opt_len;
 484
 485     turn_off_so_passcreds = FALSE;
 486     opt_val = 0;
 487     opt_len = sizeof (gint);
 488     if (getsockopt (g_socket_get_fd (socket),
 489                     SOL_SOCKET,
 490                     SO_PASSCRED,
 491                     &opt_val,
 492                     &opt_len) != 0)
 493       {
 494         g_set_error (error,
 495                      G_IO_ERROR,
 496                      g_io_error_from_errno (errno),
 497                      _("Error checking if SO_PASSCRED is enabled for socket: %s"),
 498                      strerror (errno));
 499         goto out;
 500       }
 501     if (opt_len != sizeof (gint))
 502       {
 503         g_set_error (error,
 504                      G_IO_ERROR,
 505                      G_IO_ERROR_FAILED,
 506                      _("Unexpected option length while checking if SO_PASSCRED is enabled for socket. "
 507                        "Expected %d bytes, got %d"),
 508                      (gint) sizeof (gint), (gint) opt_len);
 509         goto out;
 510       }
 511     if (opt_val == 0)
 512       {
 513         opt_val = 1;
 514         if (setsockopt (g_socket_get_fd (socket),
 515                         SOL_SOCKET,
 516                         SO_PASSCRED,
 517                         &opt_val,
 518                         sizeof opt_val) != 0)
 519           {
 520             g_set_error (error,
 521                          G_IO_ERROR,
 522                          g_io_error_from_errno (errno),
 523                          _("Error enabling SO_PASSCRED: %s"),
 524                          strerror (errno));
 525             goto out;
 526           }
 527         turn_off_so_passcreds = TRUE;
 528       }
 529   }
 530 #endif
 531
 532   g_type_ensure (G_TYPE_UNIX_CREDENTIALS_MESSAGE);
 533   num_bytes_read = g_socket_receive_message (socket,
 534                                              NULL, /* GSocketAddress **address */
 535                                              NULL,
 536                                              0,
 537                                              &scms,
 538                                              &nscm,
 539                                              NULL,
 540                                              cancellable,
 541                                              error);
 542   if (num_bytes_read != 1)
 543     {
 544       /* Handle situation where g_socket_receive_message() returns
 545        * 0 bytes and not setting @error
 546        */
 547       if (num_bytes_read == 0 && error != NULL && *error == NULL)
 548         {
 549           g_set_error_literal (error,
 550                                G_IO_ERROR,
 551                                G_IO_ERROR_FAILED,
 552                                _("Expecting to read a single byte for receiving credentials but read zero bytes"));
 553         }
 554       goto out;
 555     }
 556
 557   if (g_unix_credentials_message_is_supported () &&
 558       /* Fall back on get_credentials if the other side didn't send the credentials */
 559       nscm > 0)
 560     {
 561       if (nscm != 1)
 562         {
 563           g_set_error (error,
 564                        G_IO_ERROR,
 565                        G_IO_ERROR_FAILED,
 566                        _("Expecting 1 control message, got %d"),
 567                        nscm);
 568           goto out;
 569         }
 570
 571       if (!G_IS_UNIX_CREDENTIALS_MESSAGE (scms[0]))
 572         {
 573           g_set_error_literal (error,
 574                                G_IO_ERROR,
 575                                G_IO_ERROR_FAILED,
 576                                _("Unexpected type of ancillary data"));
 577           goto out;
 578         }
 579
 580       ret = g_unix_credentials_message_get_credentials (G_UNIX_CREDENTIALS_MESSAGE (scms[0]));
 581       g_object_ref (ret);
 582     }
 583   else
 584     {
 585       if (nscm != 0)
 586         {
 587           g_set_error (error,
 588                        G_IO_ERROR,
 589                        G_IO_ERROR_FAILED,
 590                        _("Not expecting control message, but got %d"),
 591                        nscm);
 592           goto out;
 593         }
 594       else
 595         {
 596           ret = g_socket_get_credentials (socket, error);
 597         }
 598     }
 599
 600  out:
 601
 602 #ifdef __linux__
 603   if (turn_off_so_passcreds)
 604     {
 605       gint opt_val;
 606       opt_val = 0;
 607       if (setsockopt (g_socket_get_fd (socket),
 608                       SOL_SOCKET,
 609                       SO_PASSCRED,
 610                       &opt_val,
 611                       sizeof opt_val) != 0)
 612         {
 613           g_set_error (error,
 614                        G_IO_ERROR,
 615                        g_io_error_from_errno (errno),
 616                        _("Error while disabling SO_PASSCRED: %s"),
 617                        strerror (errno));
 618           goto out;
 619         }
 620     }
 621 #endif
 622
 623   if (scms != NULL)
 624     {
 625       for (n = 0; n < nscm; n++)
 626         g_object_unref (scms[n]);
 627       g_free (scms);
 628     }
 629   g_object_unref (socket);
 630   return ret;
 631 }
 632
 633 static void
 634 receive_credentials_async_thread (GTask         *task,
 635                                   gpointer       source_object,
 636                                   gpointer       task_data,
 637                                   GCancellable  *cancellable)
 638 {
 639   GCredentials *creds;
 640   GError *error = NULL;
 641
 642   creds = g_unix_connection_receive_credentials (G_UNIX_CONNECTION (source_object),
 643                                                  cancellable,
 644                                                  &error);
 645   if (creds)
 646     g_task_return_pointer (task, creds, g_object_unref);
 647   else
 648     g_task_return_error (task, error);
 649   g_object_unref (task);
 650 }
 651
 652 /**
 653  * g_unix_connection_receive_credentials_async:
 654  * @connection: A #GUnixConnection.
 655  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
 656  * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
 657  * @user_data: (closure): the data to pass to callback function
 658  *
 659  * Asynchronously receive credentials.
 660  *
 661  * For more details, see g_unix_connection_receive_credentials() which is
 662  * the synchronous version of this call.
 663  *
 664  * When the operation is finished, @callback will be called. You can then call
 665  * g_unix_connection_receive_credentials_finish() to get the result of the operation.
 666  *
 667  * Since: 2.32
 668  **/
 669 void
 670 g_unix_connection_receive_credentials_async (GUnixConnection      *connection,
 671                                               GCancellable         *cancellable,
 672                                               GAsyncReadyCallback   callback,
 673                                               gpointer              user_data)
 674 {
 675   GTask *task;
 676
 677   task = g_task_new (connection, cancellable, callback, user_data);
 678
 679   g_task_run_in_thread (task, receive_credentials_async_thread);
 680 }
 681
 682 /**
 683  * g_unix_connection_receive_credentials_finish:
 684  * @connection: A #GUnixConnection.
 685  * @result: a #GAsyncResult.
 686  * @error: a #GError, or %NULL
 687  *
 688  * Finishes an asynchronous receive credentials operation started with
 689  * g_unix_connection_receive_credentials_async().
 690  *
 691  * Returns: (transfer full): a #GCredentials, or %NULL on error.
 692  *     Free the returned object with g_object_unref().
 693  *
 694  * Since: 2.32
 695  **/
 696 GCredentials *
 697 g_unix_connection_receive_credentials_finish (GUnixConnection *connection,
 698                                               GAsyncResult    *result,
 699                                               GError         **error)
 700 {
 701   g_return_val_if_fail (g_task_is_valid (result, connection), NULL);
 702
 703   return g_task_propagate_pointer (G_TASK (result), error);
 704 }