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       if (socket_server->noncefile)
 192           client_fd = _dbus_accept_with_noncefile (listen_fd, socket_server->noncefile);
 193       else
 194           client_fd = _dbus_accept (listen_fd);
 195
 196       if (client_fd < 0)
 197         {
 198           /* EINTR handled for us */
 199
 200           if (_dbus_get_is_errno_eagain_or_ewouldblock ())
 201             _dbus_verbose ("No client available to accept after all\n");
 202           else
 203             _dbus_verbose ("Failed to accept a client connection: %s\n",
 204                            _dbus_strerror_from_errno ());
 205
 206           SERVER_UNLOCK (server);
 207         }
 208       else
 209         {
 210           if (!handle_new_client_fd_and_unlock (server, client_fd))
 211             _dbus_verbose ("Rejected client connection due to lack of memory\n");
 212         }
 213     }
 214
 215   if (flags & DBUS_WATCH_ERROR)
 216     _dbus_verbose ("Error on server listening socket\n");
 217
 218   if (flags & DBUS_WATCH_HANGUP)
 219     _dbus_verbose ("Hangup on server listening socket\n");
 220
 221   return TRUE;
 222 }
 223
 224 static void
 225 socket_disconnect (DBusServer *server)
 226 {
 227   DBusServerSocket *socket_server = (DBusServerSocket*) server;
 228   int i;
 229
 230   HAVE_LOCK_CHECK (server);
 231
 232   for (i = 0 ; i < socket_server->n_fds ; i++)
 233     {
 234       if (socket_server->watch[i])
 235         {
 236           _dbus_server_remove_watch (server,
 237                                      socket_server->watch[i]);
 238           _dbus_watch_unref (socket_server->watch[i]);
 239           socket_server->watch[i] = NULL;
 240         }
 241
 242       _dbus_close_socket (socket_server->fds[i], NULL);
 243       socket_server->fds[i] = -1;
 244     }
 245
 246   if (socket_server->socket_name != NULL)
 247     {
 248       DBusString tmp;
 249       _dbus_string_init_const (&tmp, socket_server->socket_name);
 250       _dbus_delete_file (&tmp, NULL);
 251     }
 252
 253   HAVE_LOCK_CHECK (server);
 254 }
 255
 256 static const DBusServerVTable socket_vtable = {
 257   socket_finalize,
 258   socket_disconnect
 259 };
 260
 261 /**
 262  * Creates a new server listening on the given file descriptor.  The
 263  * file descriptor should be nonblocking (use
 264  * _dbus_set_fd_nonblocking() to make it so). The file descriptor
 265  * should be listening for connections, that is, listen() should have
 266  * been successfully invoked on it. The server will use accept() to
 267  * accept new client connections.
 268  *
 269  * @param fds list of file descriptors.
 270  * @param n_fds number of file descriptors
 271  * @param address the server's address
 272  * @param use_nonce whether to create and use a nonce for authentication
 273  * @returns the new server, or #NULL if no memory.
 274  *
 275  */
 276 DBusServer*
 277 _dbus_server_new_for_socket (int              *fds,
 278                              int               n_fds,
 279                              const DBusString *address,
 280                              DBusNonceFile    *noncefile)
 281 {
 282   DBusServerSocket *socket_server;
 283   DBusServer *server;
 284   int i;
 285
 286   socket_server = dbus_new0 (DBusServerSocket, 1);
 287   if (socket_server == NULL)
 288     return NULL;
 289
 290   socket_server->noncefile = noncefile;
 291
 292   socket_server->fds = dbus_new (int, n_fds);
 293   if (!socket_server->fds)
 294     goto failed_0;
 295
 296   socket_server->watch = dbus_new0 (DBusWatch *, n_fds);
 297   if (!socket_server->watch)
 298     goto failed_1;
 299
 300   for (i = 0 ; i < n_fds ; i++)
 301     {
 302       DBusWatch *watch;
 303
 304       watch = _dbus_watch_new (fds[i],
 305                                DBUS_WATCH_READABLE,
 306                                TRUE,
 307                                socket_handle_watch, socket_server,
 308                                NULL);
 309       if (watch == NULL)
 310         goto failed_2;
 311
 312       socket_server->n_fds++;
 313       socket_server->fds[i] = fds[i];
 314       socket_server->watch[i] = watch;
 315     }
 316
 317   if (!_dbus_server_init_base (&socket_server->base,
 318                                &socket_vtable, address))
 319     goto failed_2;
 320
 321   server = (DBusServer*)socket_server;
 322
 323   SERVER_LOCK (server);
 324
 325   for (i = 0 ; i < n_fds ; i++)
 326     {
 327       if (!_dbus_server_add_watch (&socket_server->base,
 328                                    socket_server->watch[i]))
 329         {
 330           int j;
 331           for (j = 0 ; j < i ; j++)
 332             _dbus_server_remove_watch (server,
 333                                        socket_server->watch[j]);
 334
 335           SERVER_UNLOCK (server);
 336           _dbus_server_finalize_base (&socket_server->base);
 337           goto failed_2;
 338         }
 339     }
 340
 341   SERVER_UNLOCK (server);
 342
 343   return (DBusServer*) socket_server;
 344
 345  failed_3:
 346   if (socket_server->noncefile)
 347     {
 348       _dbus_noncefile_delete (socket_server->noncefile, NULL);
 349       dbus_free (socket_server->noncefile );
 350     }
 351  failed_2:
 352   for (i = 0 ; i < n_fds ; i++)
 353     {
 354       if (socket_server->watch[i] != NULL)
 355         {
 356           _dbus_watch_unref (socket_server->watch[i]);
 357           socket_server->watch[i] = NULL;
 358         }
 359     }
 360   dbus_free (socket_server->watch);
 361
 362  failed_1:
 363   dbus_free (socket_server->fds);
 364
 365  failed_0:
 366   dbus_free (socket_server);
 367   return NULL;
 368 }
 369
 370 /**
 371  * Creates a new server listening on TCP.
 372  * If host is NULL, it will default to localhost.
 373  * If bind is NULL, it will default to the value for the host
 374  * parameter, and if that is NULL, then localhost
 375  * If bind is a hostname, it will be resolved and will listen
 376  * on all returned addresses.
 377  * If family is NULL, hostname resolution will try all address
 378  * families, otherwise it can be ipv4 or ipv6 to restrict the
 379  * addresses considered.
 380  *
 381  * @param host the hostname to report for the listen address
 382  * @param bind the hostname to listen on
 383  * @param port the port to listen on or 0 to let the OS choose
 384  * @param family
 385  * @param error location to store reason for failure.
 386  * @param use_nonce whether to use a nonce for low-level authentication (nonce-tcp transport) or not (tcp transport)
 387  * @returns the new server, or #NULL on failure.
 388  */
 389 DBusServer*
 390 _dbus_server_new_for_tcp_socket (const char     *host,
 391                                  const char     *bind,
 392                                  const char     *port,
 393                                  const char     *family,
 394                                  DBusError      *error,
 395                                  dbus_bool_t    use_nonce)
 396 {
 397   DBusServer *server;
 398   int *listen_fds = NULL;
 399   int nlisten_fds = 0, i;
 400   DBusString address;
 401   DBusString host_str;
 402   DBusString port_str;
 403   DBusNonceFile *noncefile;
 404
 405   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 406
 407   noncefile = NULL;
 408
 409   if (!_dbus_string_init (&address))
 410     {
 411       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 412       return NULL;
 413     }
 414
 415   if (!_dbus_string_init (&port_str))
 416     {
 417       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 418       goto failed_0;
 419     }
 420
 421   if (host == NULL)
 422     host = "localhost";
 423
 424   if (port == NULL)
 425     port = "0";
 426
 427   if (bind == NULL)
 428     bind = host;
 429   else if (strcmp (bind, "*") == 0)
 430     bind = NULL;
 431
 432   nlisten_fds =_dbus_listen_tcp_socket (bind, port, family,
 433                                         &port_str,
 434                                         &listen_fds, error);
 435   if (nlisten_fds <= 0)
 436     {
 437       _DBUS_ASSERT_ERROR_IS_SET(error);
 438       goto failed_1;
 439     }
 440
 441   _dbus_string_init_const (&host_str, host);
 442   if (!_dbus_string_append (&address, use_nonce ? "nonce-tcp:host=" : "tcp:host=") ||
 443       !_dbus_address_append_escaped (&address, &host_str) ||
 444       !_dbus_string_append (&address, ",port=") ||
 445       !_dbus_string_append (&address, _dbus_string_get_const_data(&port_str)))
 446     {
 447       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 448       goto failed_2;
 449     }
 450   if (family &&
 451       (!_dbus_string_append (&address, ",family=") ||
 452        !_dbus_string_append (&address, family)))
 453     {
 454       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 455       goto failed_2;
 456     }
 457
 458   if (use_nonce)
 459     {
 460       noncefile = dbus_new0 (DBusNonceFile, 1);
 461       if (noncefile == NULL)
 462         {
 463           goto failed_2;
 464         }
 465
 466       if (!_dbus_noncefile_create (noncefile, NULL))
 467           goto failed_2;
 468
 469       if (!_dbus_string_append (&address, ",noncefile=") ||
 470           !_dbus_address_append_escaped (&address, _dbus_noncefile_get_path (noncefile)))
 471         {
 472           goto failed_2;
 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_2;
 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_2:
 491   for (i = 0 ; i < nlisten_fds ; i++)
 492     _dbus_close_socket (listen_fds[i], NULL);
 493   dbus_free(listen_fds);
 494
 495  failed_1:
 496   _dbus_string_free (&port_str);
 497
 498  failed_0:
 499   _dbus_string_free (&address);
 500
 501   return NULL;
 502 }
 503
 504 /**
 505  * Tries to interpret the address entry for various socket-related
 506  * addresses (well, currently only tcp and nonce-tcp).
 507  *
 508  * Sets error if the result is not OK.
 509  *
 510  * @param entry an address entry
 511  * @param server_p a new DBusServer, or #NULL on failure.
 512  * @param error location to store rationale for failure on bad address
 513  * @returns the outcome
 514  *
 515  */
 516 DBusServerListenResult
 517 _dbus_server_listen_socket (DBusAddressEntry *entry,
 518                             DBusServer      **server_p,
 519                             DBusError        *error)
 520 {
 521   const char *method;
 522
 523   *server_p = NULL;
 524
 525   method = dbus_address_entry_get_method (entry);
 526
 527   if (strcmp (method, "tcp") == 0 || strcmp (method, "nonce-tcp") == 0)
 528     {
 529       const char *host;
 530       const char *port;
 531       const char *bind;
 532       const char *family;
 533
 534       host = dbus_address_entry_get_value (entry, "host");
 535       bind = dbus_address_entry_get_value (entry, "bind");
 536       port = dbus_address_entry_get_value (entry, "port");
 537       family = dbus_address_entry_get_value (entry, "family");
 538
 539       *server_p = _dbus_server_new_for_tcp_socket (host, bind, port,
 540                                                    family, error, strcmp (method, "nonce-tcp") == 0 ? TRUE : FALSE);
 541
 542       if (*server_p)
 543         {
 544           _DBUS_ASSERT_ERROR_IS_CLEAR(error);
 545           return DBUS_SERVER_LISTEN_OK;
 546         }
 547       else
 548         {
 549           _DBUS_ASSERT_ERROR_IS_SET(error);
 550           return DBUS_SERVER_LISTEN_DID_NOT_CONNECT;
 551         }
 552     }
 553   else
 554     {
 555       _DBUS_ASSERT_ERROR_IS_CLEAR(error);
 556       return DBUS_SERVER_LISTEN_NOT_HANDLED;
 557     }
 558 }
 559
 560 /**
 561  * This is a bad hack since it's really unix domain socket
 562  * specific. Also, the function weirdly adopts ownership
 563  * of the passed-in string.
 564  *
 565  * @param server a socket server
 566  * @param filename socket filename to report/delete
 567  *
 568  */
 569 void
 570 _dbus_server_socket_own_filename (DBusServer *server,
 571                                   char       *filename)
 572 {
 573   DBusServerSocket *socket_server = (DBusServerSocket*) server;
 574
 575   socket_server->socket_name = filename;
 576 }
 577
 578
 579 /** @} */
 580