dbus/dbus-server-unix.c

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-server-unix.c Server implementation for Unix network protocols.
   3  *
   4  * Copyright (C) 2002  Red Hat Inc.
   5  *
   6  * Licensed under the Academic Free License version 1.2
   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
  24 #include "dbus-internals.h"
  25 #include "dbus-server-unix.h"
  26 #include "dbus-transport-unix.h"
  27 #include "dbus-connection-internal.h"
  28 #include <sys/types.h>
  29 #include <unistd.h>
  30
  31 /**
  32  * @defgroup DBusServerUnix DBusServer implementations for UNIX
  33  * @ingroup  DBusInternals
  34  * @brief Implementation details of DBusServer on UNIX
  35  *
  36  * @{
  37  */
  38 /**
  39  *
  40  * Opaque object representing a Unix server implementation.
  41  */
  42 typedef struct DBusServerUnix DBusServerUnix;
  43
  44 /**
  45  * Implementation details of DBusServerUnix. All members
  46  * are private.
  47  */
  48 struct DBusServerUnix
  49 {
  50   DBusServer base;   /**< Parent class members. */
  51   int fd;            /**< File descriptor or -1 if disconnected. */
  52   DBusWatch *watch;  /**< File descriptor watch. */
  53   char *socket_name; /**< Name of domain socket, to unlink if appropriate */
  54 };
  55
  56 static void
  57 unix_finalize (DBusServer *server)
  58 {
  59   DBusServerUnix *unix_server = (DBusServerUnix*) server;
  60
  61   if (unix_server->watch)
  62     _dbus_watch_unref (unix_server->watch);
  63
  64   dbus_free (unix_server->socket_name);
  65
  66   _dbus_server_finalize_base (server);
  67
  68   dbus_free (server);
  69 }
  70
  71 /**
  72  * @todo unreffing the connection at the end may cause
  73  * us to drop the last ref to the connection before
  74  * disconnecting it. That is invalid.
  75  */
  76 /* Return value is just for memory, not other failures. */
  77 static dbus_bool_t
  78 handle_new_client_fd (DBusServer *server,
  79                       int         client_fd)
  80 {
  81   DBusConnection *connection;
  82   DBusTransport *transport;
  83
  84   _dbus_verbose ("Creating new client connection with fd %d\n", client_fd);
  85
  86   if (!_dbus_set_fd_nonblocking (client_fd, NULL))
  87     return TRUE;
  88
  89   transport = _dbus_transport_new_for_fd (client_fd, TRUE, NULL);
  90   if (transport == NULL)
  91     {
  92       close (client_fd);
  93       return FALSE;
  94     }
  95
  96   if (!_dbus_transport_set_auth_mechanisms (transport,
  97                                             (const char **) server->auth_mechanisms))
  98     {
  99       _dbus_transport_unref (transport);
 100       return FALSE;
 101     }
 102
 103   /* note that client_fd is now owned by the transport, and will be
 104    * closed on transport disconnection/finalization
 105    */
 106
 107   connection = _dbus_connection_new_for_transport (transport);
 108   _dbus_transport_unref (transport);
 109
 110   if (connection == NULL)
 111     return FALSE;
 112
 113   /* See if someone wants to handle this new connection,
 114    * self-referencing for paranoia
 115    */
 116   if (server->new_connection_function)
 117     {
 118       dbus_server_ref (server);
 119
 120       (* server->new_connection_function) (server, connection,
 121                                            server->new_connection_data);
 122       dbus_server_unref (server);
 123     }
 124
 125   /* If no one grabbed a reference, the connection will die. */
 126   dbus_connection_unref (connection);
 127
 128   return TRUE;
 129 }
 130
 131 static dbus_bool_t
 132 unix_handle_watch (DBusServer  *server,
 133                    DBusWatch   *watch,
 134                    unsigned int flags)
 135 {
 136   DBusServerUnix *unix_server = (DBusServerUnix*) server;
 137
 138   _dbus_assert (watch == unix_server->watch);
 139
 140   _dbus_verbose ("Handling client connection, flags 0x%x\n", flags);
 141
 142   if (flags & DBUS_WATCH_READABLE)
 143     {
 144       int client_fd;
 145       int listen_fd;
 146
 147       listen_fd = dbus_watch_get_fd (watch);
 148
 149       client_fd = _dbus_accept (listen_fd);
 150
 151       if (client_fd < 0)
 152         {
 153           /* EINTR handled for us */
 154
 155           if (errno == EAGAIN || errno == EWOULDBLOCK)
 156             _dbus_verbose ("No client available to accept after all\n");
 157           else
 158             _dbus_verbose ("Failed to accept a client connection: %s\n",
 159                            _dbus_strerror (errno));
 160         }
 161       else
 162         {
 163           _dbus_fd_set_close_on_exec (client_fd);
 164
 165           if (!handle_new_client_fd (server, client_fd))
 166             _dbus_verbose ("Rejected client connection due to lack of memory\n");
 167         }
 168     }
 169
 170   if (flags & DBUS_WATCH_ERROR)
 171     _dbus_verbose ("Error on server listening socket\n");
 172
 173   if (flags & DBUS_WATCH_HANGUP)
 174     _dbus_verbose ("Hangup on server listening socket\n");
 175
 176   return TRUE;
 177 }
 178
 179 static void
 180 unix_disconnect (DBusServer *server)
 181 {
 182   DBusServerUnix *unix_server = (DBusServerUnix*) server;
 183
 184   if (unix_server->watch)
 185     {
 186       _dbus_server_remove_watch (server,
 187                                  unix_server->watch);
 188       _dbus_watch_unref (unix_server->watch);
 189       unix_server->watch = NULL;
 190     }
 191
 192   close (unix_server->fd);
 193   unix_server->fd = -1;
 194
 195   if (unix_server->socket_name != NULL)
 196     {
 197       DBusString tmp;
 198       _dbus_string_init_const (&tmp, unix_server->socket_name);
 199       _dbus_delete_file (&tmp, NULL);
 200     }
 201 }
 202
 203 static DBusServerVTable unix_vtable = {
 204   unix_finalize,
 205   unix_handle_watch,
 206   unix_disconnect
 207 };
 208
 209 /**
 210  * Creates a new server listening on the given file descriptor.  The
 211  * file descriptor should be nonblocking (use
 212  * _dbus_set_fd_nonblocking() to make it so). The file descriptor
 213  * should be listening for connections, that is, listen() should have
 214  * been successfully invoked on it. The server will use accept() to
 215  * accept new client connections.
 216  *
 217  * @param fd the file descriptor.
 218  * @param address the server's address
 219  * @returns the new server, or #NULL if no memory.
 220  *
 221  */
 222 DBusServer*
 223 _dbus_server_new_for_fd (int               fd,
 224                          const DBusString *address)
 225 {
 226   DBusServerUnix *unix_server;
 227   DBusWatch *watch;
 228
 229   watch = _dbus_watch_new (fd,
 230                            DBUS_WATCH_READABLE,
 231                            TRUE);
 232   if (watch == NULL)
 233     return NULL;
 234
 235   unix_server = dbus_new0 (DBusServerUnix, 1);
 236   if (unix_server == NULL)
 237     {
 238       _dbus_watch_unref (watch);
 239       return NULL;
 240     }
 241
 242   if (!_dbus_server_init_base (&unix_server->base,
 243                                &unix_vtable, address))
 244     {
 245       _dbus_watch_unref (watch);
 246       dbus_free (unix_server);
 247       return NULL;
 248     }
 249
 250   if (!_dbus_server_add_watch (&unix_server->base,
 251                                watch))
 252     {
 253       _dbus_server_finalize_base (&unix_server->base);
 254       _dbus_watch_unref (watch);
 255       dbus_free (unix_server);
 256       return NULL;
 257     }
 258
 259   unix_server->fd = fd;
 260   unix_server->watch = watch;
 261
 262   return (DBusServer*) unix_server;
 263 }
 264
 265 /**
 266  * Creates a new server listening on the given Unix domain socket.
 267  *
 268  * @param path the path for the domain socket.
 269  * @param error location to store reason for failure.
 270  * @returns the new server, or #NULL on failure.
 271  */
 272 DBusServer*
 273 _dbus_server_new_for_domain_socket (const char     *path,
 274                                     DBusError      *error)
 275 {
 276   DBusServer *server;
 277   DBusServerUnix *unix_server;
 278   int listen_fd;
 279   DBusString address;
 280   char *path_copy;
 281
 282   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 283
 284   if (!_dbus_string_init (&address))
 285     {
 286       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 287       return NULL;
 288     }
 289
 290   if (!_dbus_string_append (&address, "unix:path=") ||
 291       !_dbus_string_append (&address, path))
 292     {
 293       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 294       goto failed_0;
 295     }
 296
 297   path_copy = _dbus_strdup (path);
 298   if (path_copy == NULL)
 299     {
 300       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 301       goto failed_0;
 302     }
 303
 304   listen_fd = _dbus_listen_unix_socket (path, error);
 305   _dbus_fd_set_close_on_exec (listen_fd);
 306
 307   if (listen_fd < 0)
 308     {
 309       _DBUS_ASSERT_ERROR_IS_SET (error);
 310       goto failed_1;
 311     }
 312
 313   server = _dbus_server_new_for_fd (listen_fd, &address);
 314   if (server == NULL)
 315     {
 316       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 317       goto failed_2;
 318     }
 319
 320   unix_server = (DBusServerUnix*) server;
 321   unix_server->socket_name = path_copy;
 322
 323   _dbus_string_free (&address);
 324
 325   return server;
 326
 327  failed_2:
 328   _dbus_close (listen_fd, NULL);
 329  failed_1:
 330   dbus_free (path_copy);
 331  failed_0:
 332   _dbus_string_free (&address);
 333
 334   return NULL;
 335 }
 336
 337 /**
 338  * Creates a new server listening on the given hostname and port.
 339  * If the hostname is NULL, listens on localhost.
 340  *
 341  * @param host the hostname to listen on.
 342  * @param port the port to listen on.
 343  * @param error location to store reason for failure.
 344  * @returns the new server, or #NULL on failure.
 345  */
 346 DBusServer*
 347 _dbus_server_new_for_tcp_socket (const char     *host,
 348                                  dbus_uint32_t   port,
 349                                  DBusError      *error)
 350 {
 351   DBusServer *server;
 352   int listen_fd;
 353   DBusString address;
 354
 355   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 356
 357   if (!_dbus_string_init (&address))
 358     {
 359       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 360       return NULL;
 361     }
 362
 363   if (!_dbus_string_append (&address, "tcp:host=") ||
 364       !_dbus_string_append (&address, host) ||
 365       !_dbus_string_append (&address, ",port=") ||
 366       !_dbus_string_append_int (&address, port))
 367     {
 368       _dbus_string_free (&address);
 369       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 370       return NULL;
 371     }
 372
 373   listen_fd = _dbus_listen_tcp_socket (host, port, error);
 374   _dbus_fd_set_close_on_exec (listen_fd);
 375
 376   if (listen_fd < 0)
 377     {
 378       _dbus_string_free (&address);
 379       return NULL;
 380     }
 381
 382   server = _dbus_server_new_for_fd (listen_fd, &address);
 383   if (server == NULL)
 384     {
 385       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 386       close (listen_fd);
 387       _dbus_string_free (&address);
 388       return NULL;
 389     }
 390
 391   _dbus_string_free (&address);
 392
 393   return server;
 394
 395
 396 }
 397
 398 /** @} */
 399