dbus/dbus-server-unix.c

   1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
   2 /* dbus-server-unix.c Server implementation for Unix network protocols.
   3  *
   4  * Copyright (C) 2002, 2003, 2004  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-unix.h"
  27 #include "dbus-server-socket.h"
  28 #include "dbus-server-launchd.h"
  29 #include "dbus-transport-unix.h"
  30 #include "dbus-connection-internal.h"
  31 #include "dbus-sysdeps-unix.h"
  32 #include "dbus-string.h"
  33
  34 /**
  35  * @defgroup DBusServerUnix DBusServer implementations for UNIX
  36  * @ingroup  DBusInternals
  37  * @brief Implementation details of DBusServer on UNIX
  38  *
  39  * @{
  40  */
  41
  42 /**
  43  * Tries to interpret the address entry in a platform-specific
  44  * way, creating a platform-specific server type if appropriate.
  45  * Sets error if the result is not OK.
  46  *
  47  * @param entry an address entry
  48  * @param server_p location to store a new DBusServer, or #NULL on failure.
  49  * @param error location to store rationale for failure on bad address
  50  * @returns the outcome
  51  *
  52  */
  53 DBusServerListenResult
  54 _dbus_server_listen_platform_specific (DBusAddressEntry *entry,
  55                                        DBusServer      **server_p,
  56                                        DBusError        *error)
  57 {
  58   const char *method;
  59
  60   *server_p = NULL;
  61
  62   method = dbus_address_entry_get_method (entry);
  63
  64   if (strcmp (method, "unix") == 0)
  65     {
  66       const char *path = dbus_address_entry_get_value (entry, "path");
  67       const char *tmpdir = dbus_address_entry_get_value (entry, "tmpdir");
  68       const char *abstract = dbus_address_entry_get_value (entry, "abstract");
  69
  70       if (path == NULL && tmpdir == NULL && abstract == NULL)
  71         {
  72           _dbus_set_bad_address(error, "unix",
  73                                 "path or tmpdir or abstract",
  74                                 NULL);
  75           return DBUS_SERVER_LISTEN_BAD_ADDRESS;
  76         }
  77
  78       if ((path && tmpdir) ||
  79           (path && abstract) ||
  80           (tmpdir && abstract))
  81         {
  82           _dbus_set_bad_address(error, NULL, NULL,
  83                                 "cannot specify two of \"path\" and \"tmpdir\" and \"abstract\" at the same time");
  84           return DBUS_SERVER_LISTEN_BAD_ADDRESS;
  85         }
  86
  87       if (tmpdir != NULL)
  88         {
  89           DBusString full_path;
  90           DBusString filename;
  91
  92           if (!_dbus_string_init (&full_path))
  93             {
  94               dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
  95               return DBUS_SERVER_LISTEN_DID_NOT_CONNECT;
  96             }
  97
  98           if (!_dbus_string_init (&filename))
  99             {
 100               _dbus_string_free (&full_path);
 101               dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 102               return DBUS_SERVER_LISTEN_DID_NOT_CONNECT;
 103             }
 104
 105           if (!_dbus_string_append (&filename,
 106                                     "dbus-") ||
 107               !_dbus_generate_random_ascii (&filename, 10) ||
 108               !_dbus_string_append (&full_path, tmpdir) ||
 109               !_dbus_concat_dir_and_file (&full_path, &filename))
 110             {
 111               _dbus_string_free (&full_path);
 112               _dbus_string_free (&filename);
 113               dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 114               return DBUS_SERVER_LISTEN_DID_NOT_CONNECT;
 115             }
 116
 117           /* Always use abstract namespace if possible with tmpdir */
 118
 119           *server_p =
 120             _dbus_server_new_for_domain_socket (_dbus_string_get_const_data (&full_path),
 121 #ifdef HAVE_ABSTRACT_SOCKETS
 122                                                 TRUE,
 123 #else
 124                                                 FALSE,
 125 #endif
 126                                                 error);
 127
 128           _dbus_string_free (&full_path);
 129           _dbus_string_free (&filename);
 130         }
 131       else
 132         {
 133           if (path)
 134             *server_p = _dbus_server_new_for_domain_socket (path, FALSE, error);
 135           else
 136             *server_p = _dbus_server_new_for_domain_socket (abstract, TRUE, error);
 137         }
 138
 139       if (*server_p != NULL)
 140         {
 141           _DBUS_ASSERT_ERROR_IS_CLEAR(error);
 142           return DBUS_SERVER_LISTEN_OK;
 143         }
 144       else
 145         {
 146           _DBUS_ASSERT_ERROR_IS_SET(error);
 147           return DBUS_SERVER_LISTEN_DID_NOT_CONNECT;
 148         }
 149     }
 150   else if (strcmp (method, "systemd") == 0)
 151     {
 152       int i, n, *fds;
 153       DBusString address;
 154
 155       n = _dbus_listen_systemd_sockets (&fds, error);
 156       if (n < 0)
 157         {
 158           _DBUS_ASSERT_ERROR_IS_SET (error);
 159           return DBUS_SERVER_LISTEN_DID_NOT_CONNECT;
 160         }
 161
 162       if (!_dbus_string_init (&address))
 163           goto systemd_oom;
 164
 165       for (i = 0; i < n; i++)
 166         {
 167           if (i > 0)
 168             {
 169               if (!_dbus_string_append (&address, ";"))
 170                 goto systemd_oom;
 171             }
 172           if (!_dbus_append_address_from_socket (fds[i], &address, error))
 173             goto systemd_err;
 174         }
 175
 176       *server_p = _dbus_server_new_for_socket (fds, n, &address, NULL);
 177       if (*server_p == NULL)
 178         goto systemd_oom;
 179
 180       dbus_free (fds);
 181
 182       return DBUS_SERVER_LISTEN_OK;
 183   systemd_oom:
 184       _DBUS_SET_OOM (error);
 185   systemd_err:
 186       for (i = 0; i < n; i++)
 187         {
 188           _dbus_close_socket (fds[i], NULL);
 189         }
 190       dbus_free (fds);
 191       _dbus_string_free (&address);
 192
 193       return DBUS_SERVER_LISTEN_DID_NOT_CONNECT;
 194     }
 195 #ifdef DBUS_ENABLE_LAUNCHD
 196   else if (strcmp (method, "launchd") == 0)
 197     {
 198       const char *launchd_env_var = dbus_address_entry_get_value (entry, "env");
 199       if (launchd_env_var == NULL)
 200         {
 201           _dbus_set_bad_address (error, "launchd", "env", NULL);
 202           return DBUS_SERVER_LISTEN_DID_NOT_CONNECT;
 203         }
 204       *server_p = _dbus_server_new_for_launchd (launchd_env_var, error);
 205
 206       if (*server_p != NULL)
 207         {
 208           _DBUS_ASSERT_ERROR_IS_CLEAR(error);
 209           return DBUS_SERVER_LISTEN_OK;
 210         }
 211       else
 212         {
 213           _DBUS_ASSERT_ERROR_IS_SET(error);
 214           return DBUS_SERVER_LISTEN_DID_NOT_CONNECT;
 215         }
 216     }
 217 #endif
 218   else
 219     {
 220       /* If we don't handle the method, we return NULL with the
 221        * error unset
 222        */
 223       _DBUS_ASSERT_ERROR_IS_CLEAR(error);
 224       return DBUS_SERVER_LISTEN_NOT_HANDLED;
 225     }
 226 }
 227
 228 /**
 229  * Creates a new server listening on the given Unix domain socket.
 230  *
 231  * @param path the path for the domain socket.
 232  * @param abstract #TRUE to use abstract socket namespace
 233  * @param error location to store reason for failure.
 234  * @returns the new server, or #NULL on failure.
 235  */
 236 DBusServer*
 237 _dbus_server_new_for_domain_socket (const char     *path,
 238                                     dbus_bool_t     abstract,
 239                                     DBusError      *error)
 240 {
 241   DBusServer *server;
 242   int listen_fd;
 243   DBusString address;
 244   char *path_copy;
 245   DBusString path_str;
 246
 247   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 248
 249   if (!_dbus_string_init (&address))
 250     {
 251       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 252       return NULL;
 253     }
 254
 255   _dbus_string_init_const (&path_str, path);
 256   if ((abstract &&
 257        !_dbus_string_append (&address, "unix:abstract=")) ||
 258       (!abstract &&
 259        !_dbus_string_append (&address, "unix:path=")) ||
 260       !_dbus_address_append_escaped (&address, &path_str))
 261     {
 262       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 263       goto failed_0;
 264     }
 265
 266   if (abstract)
 267     {
 268       path_copy = NULL;
 269     }
 270   else
 271     {
 272       path_copy = _dbus_strdup (path);
 273       if (path_copy == NULL)
 274         {
 275           dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 276           goto failed_0;
 277         }
 278     }
 279
 280   listen_fd = _dbus_listen_unix_socket (path, abstract, error);
 281
 282   if (listen_fd < 0)
 283     {
 284       _DBUS_ASSERT_ERROR_IS_SET (error);
 285       goto failed_1;
 286     }
 287
 288   server = _dbus_server_new_for_socket (&listen_fd, 1, &address, 0);
 289   if (server == NULL)
 290     {
 291       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 292       goto failed_2;
 293     }
 294
 295   if (path_copy != NULL)
 296     _dbus_server_socket_own_filename(server, path_copy);
 297
 298   _dbus_string_free (&address);
 299
 300   return server;
 301
 302  failed_2:
 303   _dbus_close_socket (listen_fd, NULL);
 304  failed_1:
 305   dbus_free (path_copy);
 306  failed_0:
 307   _dbus_string_free (&address);
 308
 309   return NULL;
 310 }
 311
 312 /** @} */