dbus/dbus-server-socket.c

   1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
   2 /* dbus-server-socket.c Server implementation for sockets
   3  *
   4  * Copyright (C) 2002, 2003, 2004, 2006  Red Hat Inc.
   5  *
   6  * Licensed under the Academic Free License version 2.1
   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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  21  *
  22  */
  23
  24 #include <config.h>
  25 #include "dbus-internals.h"
  26 #include "dbus-server-socket.h"
  27 #include "dbus-transport-socket.h"
  28 #include "dbus-connection-internal.h"
  29 #include "dbus-memory.h"
  30 #include "dbus-nonce.h"
  31 #include "dbus-string.h"
  32
  33 /**
  34  * @defgroup DBusServerSocket DBusServer implementations for SOCKET
  35  * @ingroup  DBusInternals
  36  * @brief Implementation details of DBusServer on SOCKET
  37  *
  38  * @{
  39  */
  40 /**
  41  *
  42  * Opaque object representing a Socket server implementation.
  43  */
  44 typedef struct DBusServerSocket DBusServerSocket;
  45
  46 /**
  47  * Implementation details of DBusServerSocket. All members
  48  * are private.
  49  */
  50 struct DBusServerSocket
  51 {
  52   DBusServer base;   /**< Parent class members. */
  53   int n_fds;         /**< Number of active file handles */
  54   int *fds;          /**< File descriptor or -1 if disconnected. */
  55   DBusWatch **watch; /**< File descriptor watch. */
  56   char *socket_name; /**< Name of domain socket, to unlink if appropriate */
  57   DBusNonceFile *noncefile; /**< Nonce file used to authenticate clients */
  58 };
  59
  60 static void
  61 socket_finalize (DBusServer *server)
  62 {
  63   DBusServerSocket *socket_server = (DBusServerSocket*) server;
  64   int i;
  65
  66   _dbus_server_finalize_base (server);
  67
  68   for (i = 0 ; i < socket_server->n_fds ; i++)
  69     if (socket_server->watch[i])
  70       {
  71         _dbus_watch_unref (socket_server->watch[i]);
  72         socket_server->watch[i] = NULL;
  73       }
  74
  75   dbus_free (socket_server->fds);
  76   dbus_free (socket_server->watch);
  77   dbus_free (socket_server->socket_name);
  78   if (socket_server->noncefile)
  79         _dbus_noncefile_delete (socket_server->noncefile, NULL);
  80   dbus_free (socket_server->noncefile);
  81   dbus_free (server);
  82 }
  83
  84 /* Return value is just for memory, not other failures. */
  85 static dbus_bool_t
  86 handle_new_client_fd_and_unlock (DBusServer *server,
  87                                  int         client_fd)
  88 {
  89   DBusConnection *connection;
  90   DBusTransport *transport;
  91   DBusNewConnectionFunction new_connection_function;
  92   DBusServerSocket* socket_server;
  93   void *new_connection_data;
  94
  95   socket_server = (DBusServerSocket*)server;
  96   _dbus_verbose ("Creating new client connection with fd %d\n", client_fd);
  97
  98   HAVE_LOCK_CHECK (server);
  99
 100   if (!_dbus_set_fd_nonblocking (client_fd, NULL))
 101     {
 102       SERVER_UNLOCK (server);
 103       return TRUE;
 104     }
 105
 106   transport = _dbus_transport_new_for_socket (client_fd, &server->guid_hex, FALSE);
 107   if (transport == NULL)
 108     {
 109       _dbus_close_socket (client_fd, NULL);
 110       SERVER_UNLOCK (server);
 111       return FALSE;
 112     }
 113
 114   if (!_dbus_transport_set_auth_mechanisms (transport,
 115                                             (const char **) server->auth_mechanisms))
 116     {
 117       _dbus_transport_unref (transport);
 118       SERVER_UNLOCK (server);
 119       return FALSE;
 120     }
 121
 122   /* note that client_fd is now owned by the transport, and will be
 123    * closed on transport disconnection/finalization
 124    */
 125
 126   connection = _dbus_connection_new_for_transport (transport);
 127   _dbus_transport_unref (transport);
 128   transport = NULL; /* now under the connection lock */
 129
 130   if (connection == NULL)
 131     {
 132       SERVER_UNLOCK (server);
 133       return FALSE;
 134     }
 135
 136   /* See if someone wants to handle this new connection, self-referencing
 137    * for paranoia.
 138    */
 139   new_connection_function = server->new_connection_function;
 140   new_connection_data = server->new_connection_data;
 141
 142   _dbus_server_ref_unlocked (server);
 143   SERVER_UNLOCK (server);
 144
 145   if (new_connection_function)
 146     {
 147       (* new_connection_function) (server, connection,
 148                                    new_connection_data);
 149     }
 150   dbus_server_unref (server);
 151
 152   /* If no one grabbed a reference, the connection will die. */
 153   _dbus_connection_close_if_only_one_ref (connection);
 154   dbus_connection_unref (connection);
 155
 156   return TRUE;
 157 }
 158
 159 static dbus_bool_t
 160 socket_handle_watch (DBusWatch    *watch,
 161                    unsigned int  flags,
 162                    void         *data)
 163 {
 164   DBusServer *server = data;
 165   DBusServerSocket *socket_server = data;
 166
 167 #ifndef DBUS_DISABLE_ASSERT
 168   int i;
 169   dbus_bool_t found = FALSE;
 170 #endif
 171
 172   SERVER_LOCK (server);
 173
 174 #ifndef DBUS_DISABLE_ASSERT
 175   for (i = 0 ; i < socket_server->n_fds ; i++)
 176     {
 177       if (socket_server->watch[i] == watch)
 178         found = TRUE;
 179     }
 180   _dbus_assert (found);
 181 #endif
 182
 183   _dbus_verbose ("Handling client connection, flags 0x%x\n", flags);
 184
 185   if (flags & DBUS_WATCH_READABLE)
 186     {
 187       int client_fd;
 188       int listen_fd;
 189
 190       listen_fd = dbus_watch_get_socket (watch);
 191
 192       if (socket_server->noncefile)
 193           client_fd = _dbus_accept_with_noncefile (listen_fd, socket_server->noncefile);
 194       else
 195           client_fd = _dbus_accept (listen_fd);
 196
 197       if (client_fd < 0)
 198         {
 199           /* EINTR handled for us */
 200
 201           if (_dbus_get_is_errno_eagain_or_ewouldblock ())
 202             _dbus_verbose ("No client available to accept after all\n");
 203           else
 204             _dbus_verbose ("Failed to accept a client connection: %s\n",
 205                            _dbus_strerror_from_errno ());
 206
 207           SERVER_UNLOCK (server);
 208         }
 209       else
 210         {
 211           if (!handle_new_client_fd_and_unlock (server, client_fd))
 212             _dbus_verbose ("Rejected client connection due to lack of memory\n");
 213         }
 214     }
 215
 216   if (flags & DBUS_WATCH_ERROR)
 217     _dbus_verbose ("Error on server listening socket\n");
 218
 219   if (flags & DBUS_WATCH_HANGUP)
 220     _dbus_verbose ("Hangup on server listening socket\n");
 221
 222   return TRUE;
 223 }
 224
 225 static void
 226 socket_disconnect (DBusServer *server)
 227 {
 228   DBusServerSocket *socket_server = (DBusServerSocket*) server;
 229   int i;
 230
 231   HAVE_LOCK_CHECK (server);
 232
 233   for (i = 0 ; i < socket_server->n_fds ; i++)
 234     {
 235       if (socket_server->watch[i])
 236         {
 237           _dbus_server_remove_watch (server,
 238                                      socket_server->watch[i]);
 239           _dbus_watch_unref (socket_server->watch[i]);
 240           socket_server->watch[i] = NULL;
 241         }
 242
 243       _dbus_close_socket (socket_server->fds[i], NULL);
 244       socket_server->fds[i] = -1;
 245     }
 246
 247   if (socket_server->socket_name != NULL)
 248     {
 249       DBusString tmp;
 250       _dbus_string_init_const (&tmp, socket_server->socket_name);
 251       _dbus_delete_file (&tmp, NULL);
 252     }
 253
 254   if (server->published_address)
 255       _dbus_daemon_unpublish_session_bus_address();
 256
 257   HAVE_LOCK_CHECK (server);
 258 }
 259
 260 static const DBusServerVTable socket_vtable = {
 261   socket_finalize,
 262   socket_disconnect
 263 };
 264
 265 /**
 266  * Creates a new server listening on the given file descriptor.  The
 267  * file descriptor should be nonblocking (use
 268  * _dbus_set_fd_nonblocking() to make it so). The file descriptor
 269  * should be listening for connections, that is, listen() should have
 270  * been successfully invoked on it. The server will use accept() to
 271  * accept new client connections.
 272  *
 273  * @param fds list of file descriptors.
 274  * @param n_fds number of file descriptors
 275  * @param address the server's address
 276  * @param noncefile to be used for authentication (NULL if not needed)
 277  * @returns the new server, or #NULL if no memory.
 278  *
 279  */
 280 DBusServer*
 281 _dbus_server_new_for_socket (int              *fds,
 282                              int               n_fds,
 283                              const DBusString *address,
 284                              DBusNonceFile    *noncefile)
 285 {
 286   DBusServerSocket *socket_server;
 287   DBusServer *server;
 288   int i;
 289
 290   socket_server = dbus_new0 (DBusServerSocket, 1);
 291   if (socket_server == NULL)
 292     return NULL;
 293
 294   socket_server->noncefile = noncefile;
 295
 296   socket_server->fds = dbus_new (int, n_fds);
 297   if (!socket_server->fds)
 298     goto failed_0;
 299
 300   socket_server->watch = dbus_new0 (DBusWatch *, n_fds);
 301   if (!socket_server->watch)
 302     goto failed_1;
 303
 304   for (i = 0 ; i < n_fds ; i++)
 305     {
 306       DBusWatch *watch;
 307
 308       watch = _dbus_watch_new (fds[i],
 309                                DBUS_WATCH_READABLE,
 310                                TRUE,
 311                                socket_handle_watch, socket_server,
 312                                NULL);
 313       if (watch == NULL)
 314         goto failed_2;
 315
 316       socket_server->n_fds++;
 317       socket_server->fds[i] = fds[i];
 318       socket_server->watch[i] = watch;
 319     }
 320
 321   if (!_dbus_server_init_base (&socket_server->base,
 322                                &socket_vtable, address))
 323     goto failed_2;
 324
 325   server = (DBusServer*)socket_server;
 326
 327   SERVER_LOCK (server);
 328
 329   for (i = 0 ; i < n_fds ; i++)
 330     {
 331       if (!_dbus_server_add_watch (&socket_server->base,
 332                                    socket_server->watch[i]))
 333         {
 334           int j;
 335           for (j = 0 ; j < i ; j++)
 336             _dbus_server_remove_watch (server,
 337                                        socket_server->watch[j]);
 338
 339           SERVER_UNLOCK (server);
 340           _dbus_server_finalize_base (&socket_server->base);
 341           goto failed_2;
 342         }
 343     }
 344
 345   SERVER_UNLOCK (server);
 346
 347   return (DBusServer*) socket_server;
 348
 349  failed_2:
 350   for (i = 0 ; i < n_fds ; i++)
 351     {
 352       if (socket_server->watch[i] != NULL)
 353         {
 354           _dbus_watch_unref (socket_server->watch[i]);
 355           socket_server->watch[i] = NULL;
 356         }
 357     }
 358   dbus_free (socket_server->watch);
 359
 360  failed_1:
 361   dbus_free (socket_server->fds);
 362
 363  failed_0:
 364   dbus_free (socket_server);
 365   return NULL;
 366 }
 367
 368 /**
 369  * Creates a new server listening on TCP.
 370  * If host is NULL, it will default to localhost.
 371  * If bind is NULL, it will default to the value for the host
 372  * parameter, and if that is NULL, then localhost
 373  * If bind is a hostname, it will be resolved and will listen
 374  * on all returned addresses.
 375  * If family is NULL, hostname resolution will try all address
 376  * families, otherwise it can be ipv4 or ipv6 to restrict the
 377  * addresses considered.
 378  *
 379  * @param host the hostname to report for the listen address
 380  * @param bind the hostname to listen on
 381  * @param port the port to listen on or 0 to let the OS choose
 382  * @param family
 383  * @param error location to store reason for failure.
 384  * @param use_nonce whether to use a nonce for low-level authentication (nonce-tcp transport) or not (tcp transport)
 385  * @returns the new server, or #NULL on failure.
 386  */
 387 DBusServer*
 388 _dbus_server_new_for_tcp_socket (const char     *host,
 389                                  const char     *bind,
 390                                  const char     *port,
 391                                  const char     *family,
 392                                  DBusError      *error,
 393                                  dbus_bool_t    use_nonce)
 394 {
 395   DBusServer *server;
 396   int *listen_fds = NULL;
 397   int nlisten_fds = 0, i;
 398   DBusString address;
 399   DBusString host_str;
 400   DBusString port_str;
 401   DBusNonceFile *noncefile;
 402
 403   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 404
 405   noncefile = NULL;
 406
 407   if (!_dbus_string_init (&address))
 408     {
 409       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 410       return NULL;
 411     }
 412
 413   if (!_dbus_string_init (&port_str))
 414     {
 415       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 416       goto failed_0;
 417     }
 418
 419   if (host == NULL)
 420     host = "localhost";
 421
 422   if (port == NULL)
 423     port = "0";
 424
 425   if (bind == NULL)
 426     bind = host;
 427   else if (strcmp (bind, "*") == 0)
 428     bind = NULL;
 429
 430   nlisten_fds =_dbus_listen_tcp_socket (bind, port, family,
 431                                         &port_str,
 432                                         &listen_fds, error);
 433   if (nlisten_fds <= 0)
 434     {
 435       _DBUS_ASSERT_ERROR_IS_SET(error);
 436       goto failed_1;
 437     }
 438
 439   _dbus_string_init_const (&host_str, host);
 440   if (!_dbus_string_append (&address, use_nonce ? "nonce-tcp:host=" : "tcp:host=") ||
 441       !_dbus_address_append_escaped (&address, &host_str) ||
 442       !_dbus_string_append (&address, ",port=") ||
 443       !_dbus_string_append (&address, _dbus_string_get_const_data(&port_str)))
 444     {
 445       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 446       goto failed_2;
 447     }
 448   if (family &&
 449       (!_dbus_string_append (&address, ",family=") ||
 450        !_dbus_string_append (&address, family)))
 451     {
 452       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 453       goto failed_2;
 454     }
 455
 456   if (use_nonce)
 457     {
 458       noncefile = dbus_new0 (DBusNonceFile, 1);
 459       if (noncefile == NULL)
 460         {
 461           dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 462           goto failed_2;
 463         }
 464
 465       if (!_dbus_noncefile_create (noncefile, error))
 466           goto failed_3;
 467
 468       if (!_dbus_string_append (&address, ",noncefile=") ||
 469           !_dbus_address_append_escaped (&address, _dbus_noncefile_get_path (noncefile)))
 470         {
 471           dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 472           goto failed_4;
 473         }
 474
 475     }
 476
 477   server = _dbus_server_new_for_socket (listen_fds, nlisten_fds, &address, noncefile);
 478   if (server == NULL)
 479     {
 480       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 481       goto failed_4;
 482     }
 483
 484   _dbus_string_free (&port_str);
 485   _dbus_string_free (&address);
 486   dbus_free(listen_fds);
 487
 488   return server;
 489
 490  failed_4:
 491   _dbus_noncefile_delete (noncefile, NULL);
 492
 493  failed_3:
 494   dbus_free (noncefile);
 495
 496  failed_2:
 497   for (i = 0 ; i < nlisten_fds ; i++)
 498     _dbus_close_socket (listen_fds[i], NULL);
 499   dbus_free(listen_fds);
 500
 501  failed_1:
 502   _dbus_string_free (&port_str);
 503
 504  failed_0:
 505   _dbus_string_free (&address);
 506
 507   return NULL;
 508 }
 509
 510 /**
 511  * Tries to interpret the address entry for various socket-related
 512  * addresses (well, currently only tcp and nonce-tcp).
 513  *
 514  * Sets error if the result is not OK.
 515  *
 516  * @param entry an address entry
 517  * @param server_p a new DBusServer, or #NULL on failure.
 518  * @param error location to store rationale for failure on bad address
 519  * @returns the outcome
 520  *
 521  */
 522 DBusServerListenResult
 523 _dbus_server_listen_socket (DBusAddressEntry *entry,
 524                             DBusServer      **server_p,
 525                             DBusError        *error)
 526 {
 527   const char *method;
 528
 529   *server_p = NULL;
 530
 531   method = dbus_address_entry_get_method (entry);
 532
 533   if (strcmp (method, "tcp") == 0 || strcmp (method, "nonce-tcp") == 0)
 534     {
 535       const char *host;
 536       const char *port;
 537       const char *bind;
 538       const char *family;
 539
 540       host = dbus_address_entry_get_value (entry, "host");
 541       bind = dbus_address_entry_get_value (entry, "bind");
 542       port = dbus_address_entry_get_value (entry, "port");
 543       family = dbus_address_entry_get_value (entry, "family");
 544
 545       *server_p = _dbus_server_new_for_tcp_socket (host, bind, port,
 546                                                    family, error, strcmp (method, "nonce-tcp") == 0 ? TRUE : FALSE);
 547
 548       if (*server_p)
 549         {
 550           _DBUS_ASSERT_ERROR_IS_CLEAR(error);
 551           return DBUS_SERVER_LISTEN_OK;
 552         }
 553       else
 554         {
 555           _DBUS_ASSERT_ERROR_IS_SET(error);
 556           return DBUS_SERVER_LISTEN_DID_NOT_CONNECT;
 557         }
 558     }
 559   else
 560     {
 561       _DBUS_ASSERT_ERROR_IS_CLEAR(error);
 562       return DBUS_SERVER_LISTEN_NOT_HANDLED;
 563     }
 564 }
 565
 566 /**
 567  * This is a bad hack since it's really unix domain socket
 568  * specific. Also, the function weirdly adopts ownership
 569  * of the passed-in string.
 570  *
 571  * @param server a socket server
 572  * @param filename socket filename to report/delete
 573  *
 574  */
 575 void
 576 _dbus_server_socket_own_filename (DBusServer *server,
 577                                   char       *filename)
 578 {
 579   DBusServerSocket *socket_server = (DBusServerSocket*) server;
 580
 581   socket_server->socket_name = filename;
 582 }
 583
 584
 585 /** @} */
 586