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