Merge "Optional autogen.sh flag --enable-kdbus-transport added allowing to compile...
[platform/upstream/dbus.git] / dbus / dbus-nonce.c
index bca60e0..ef037ef 100644 (file)
@@ -21,6 +21,7 @@
  *
  */
 
+#include <config.h>
 // major sections of this file are modified code from libassuan, (C) FSF
 #include "dbus-nonce.h"
 #include "dbus-internals.h"
 
 #include <stdio.h>
 
-#ifdef HAVE_ERRNO_H
-#include <errno.h>
-#endif
-
-#ifndef ENOFILE
-# define ENOFILE ENOENT
-#endif
-
-dbus_bool_t
-_dbus_check_nonce (int fd, const DBusString *nonce)
+static dbus_bool_t
+do_check_nonce (int fd, const DBusString *nonce, DBusError *error)
 {
   DBusString buffer;
   DBusString p;
@@ -46,11 +39,18 @@ _dbus_check_nonce (int fd, const DBusString *nonce)
   dbus_bool_t result;
   int n;
 
+  _DBUS_ASSERT_ERROR_IS_CLEAR (error);
+
   nleft = 16;
 
-  _dbus_string_init (&buffer);
-  _dbus_string_init (&p);
-//PENDING(kdab) replace errno by DBusError
+  if (   !_dbus_string_init (&buffer)
+      || !_dbus_string_init (&p) ) {
+        dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
+        _dbus_string_free (&p);
+        _dbus_string_free (&buffer);
+        return FALSE;
+      }
+
   while (nleft)
     {
       n = _dbus_read_socket (fd, &p, nleft);
@@ -60,15 +60,16 @@ _dbus_check_nonce (int fd, const DBusString *nonce)
         _dbus_sleep_milliseconds (100);
       else if (n==-1)
         {
+          dbus_set_error (error, DBUS_ERROR_IO_ERROR, "Could not read nonce from socket (fd=%d)", fd );
           _dbus_string_free (&p);
           _dbus_string_free (&buffer);
           return FALSE;
         }
       else if (!n)
         {
-        _dbus_string_free (&p);
-        _dbus_string_free (&buffer);
-          errno = EIO;
+          _dbus_string_free (&p);
+          _dbus_string_free (&buffer);
+          dbus_set_error (error, DBUS_ERROR_IO_ERROR, "Could not read nonce from socket (fd=%d)", fd );
           return FALSE;
         }
       else
@@ -80,7 +81,7 @@ _dbus_check_nonce (int fd, const DBusString *nonce)
 
   result =  _dbus_string_equal_len (&buffer, nonce, 16);
   if (!result)
-      errno = EACCES;
+    dbus_set_error (error, DBUS_ERROR_ACCESS_DENIED, "Nonces do not match, access denied (fd=%d)", fd );
 
   _dbus_string_free (&p);
   _dbus_string_free (&buffer);
@@ -88,15 +89,25 @@ _dbus_check_nonce (int fd, const DBusString *nonce)
   return result;
 }
 
-//PENDING(kdab) document
+/**
+ * reads the nonce from the nonce file and stores it in a string
+ *
+ * @param fname the file to read the nonce from
+ * @param nonce returns the nonce. Must be an initialized string, the nonce will be appended.
+ * @param error error object to report possible errors
+ * @return FALSE iff reading the nonce fails (error is set then)
+ */
 dbus_bool_t
-_dbus_read_nonce (const DBusString *fname, DBusString *nonce)
+_dbus_read_nonce (const DBusString *fname, DBusString *nonce, DBusError* error)
 {
-  //PENDING(kdab) replace errno by DBusError
   FILE *fp;
   char buffer[17];
-  buffer[sizeof buffer - 1] = '\0';
   size_t nread;
+
+  buffer[sizeof buffer - 1] = '\0';
+
+  _DBUS_ASSERT_ERROR_IS_CLEAR (error);
+
   _dbus_verbose ("reading nonce from file: %s\n", _dbus_string_get_const_data (fname));
 
 
@@ -107,27 +118,34 @@ _dbus_read_nonce (const DBusString *fname, DBusString *nonce)
   fclose (fp);
   if (!nread)
     {
-      errno = ENOFILE;
+      dbus_set_error (error, DBUS_ERROR_FILE_NOT_FOUND, "Could not read nonce from file %s", _dbus_string_get_const_data (fname));
       return FALSE;
     }
 
   if (!_dbus_string_append_len (nonce, buffer, sizeof buffer - 1 ))
     {
-      errno = ENOMEM;
+      dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
       return FALSE;
     }
   return TRUE;
 }
 
 int
-_dbus_accept_with_nonce (int listen_fd, const DBusString *nonce)
+_dbus_accept_with_noncefile (int listen_fd, const DBusNonceFile *noncefile)
 {
-  _dbus_assert (nonce != NULL);
   int fd;
+  DBusString nonce;
+
+  _dbus_assert (noncefile != NULL);
+  if (!_dbus_string_init (&nonce))
+    return -1;
+  //PENDING(kdab): set better errors
+  if (_dbus_read_nonce (_dbus_noncefile_get_path(noncefile), &nonce, NULL) != TRUE)
+    return -1;
   fd = _dbus_accept (listen_fd);
   if (_dbus_socket_is_invalid (fd))
     return fd;
-  if (_dbus_check_nonce(fd, nonce) != TRUE) {
+  if (do_check_nonce(fd, &nonce, NULL) != TRUE) {
     _dbus_verbose ("nonce check failed. Closing socket.\n");
     _dbus_close_socket(fd, NULL);
     return -1;
@@ -136,54 +154,19 @@ _dbus_accept_with_nonce (int listen_fd, const DBusString *nonce)
   return fd;
 }
 
-int
-_dbus_accept_with_noncefile (int listen_fd, const DBusString *noncefile)
+static dbus_bool_t
+generate_and_write_nonce (const DBusString *filename, DBusError *error)
 {
-  _dbus_assert (noncefile != NULL);
   DBusString nonce;
-  _dbus_string_init (&nonce);
-  //PENDING(kdab): set better errors
-  if (_dbus_read_nonce (noncefile, &nonce) != TRUE)
-    return -1;
-  return _dbus_accept_with_nonce (listen_fd, &nonce);
-}
-
-dbus_bool_t
-_dbus_generate_noncefilename (DBusString *buf, DBusError *error)
-{
   dbus_bool_t ret;
-  DBusString randomStr;
 
   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 
-  ret = _dbus_string_init (&randomStr);
-  if (!ret)
-    goto oom;
-  ret = _dbus_generate_random_ascii (&randomStr, 8);
-  if (!ret)
-    goto oom;
-  if (!_dbus_string_append (buf, _dbus_get_tmpdir())
-      || !_dbus_string_append (buf, DBUS_DIR_SEPARATOR "dbus_nonce-")
-      || !_dbus_string_append (buf, _dbus_string_get_const_data (&randomStr)) )
-    goto oom;
-
-  _dbus_string_free (&randomStr);
-  return TRUE;
-oom:
-  dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
-  _dbus_string_free (&randomStr);
-  return FALSE;
-}
-
-dbus_bool_t
-_dbus_generate_and_write_nonce (const DBusString *filename, DBusError *error)
-{
-  DBusString nonce;
-  dbus_bool_t ret;
-
-  _DBUS_ASSERT_ERROR_IS_CLEAR (error);
-
-  _dbus_string_init (&nonce);
+  if (!_dbus_string_init (&nonce))
+    {
+      dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
+      return FALSE;
+    }
 
   if (!_dbus_generate_random_bytes (&nonce, 16))
     {
@@ -192,19 +175,27 @@ _dbus_generate_and_write_nonce (const DBusString *filename, DBusError *error)
       return FALSE;
     }
 
-  ret = _dbus_string_save_to_file (filename, &nonce, error);
+  ret = _dbus_string_save_to_file (&nonce, filename, FALSE, error);
 
   _dbus_string_free (&nonce);
 
   return ret;
 }
 
+/**
+ * sends the nonce over a given socket. Blocks while doing so.
+ *
+ * @param fd the file descriptor to write the nonce data to (usually a socket)
+ * @param noncefile the noncefile location to read the nonce from
+ * @param error contains error details if FALSE is returned
+ * @return TRUE iff the nonce was successfully sent. Note that this does not
+ * indicate whether the server accepted the nonce.
+ */
 dbus_bool_t
-_dbus_send_nonce(int fd, const DBusString *noncefile, DBusError *error)
+_dbus_send_nonce (int fd, const DBusString *noncefile, DBusError *error)
 {
   dbus_bool_t read_result;
   int send_result;
-  size_t sendLen;
   DBusString nonce;
 
   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
@@ -212,38 +203,228 @@ _dbus_send_nonce(int fd, const DBusString *noncefile, DBusError *error)
   if (_dbus_string_get_length (noncefile) == 0)
     return FALSE;
 
-  if ( !_dbus_string_init (&nonce) )
+  if (!_dbus_string_init (&nonce))
     {
       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
       return FALSE;
-  }
-
-  read_result = _dbus_read_nonce (noncefile, &nonce);
+    }
 
+  read_result = _dbus_read_nonce (noncefile, &nonce, error);
   if (!read_result)
     {
-      dbus_set_error (error,
-                      _dbus_error_from_errno (errno),
-                      "Could not read nonce from file %s (%s)",
-                      _dbus_string_get_const_data (noncefile), _dbus_strerror(errno));
+      _DBUS_ASSERT_ERROR_IS_SET (error);
       _dbus_string_free (&nonce);
       return FALSE;
     }
+  _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 
   send_result = _dbus_write_socket (fd, &nonce, 0, _dbus_string_get_length (&nonce));
 
   _dbus_string_free (&nonce);
 
   if (send_result == -1)
-  {
-    dbus_set_error (error,
-                    _dbus_error_from_errno (errno),
-                    "Failed to send nonce (fd=%d): %s",
-                    fd, _dbus_strerror(errno));
-    return FALSE;
-  }
+    {
+      dbus_set_error (error,
+                      _dbus_error_from_system_errno (),
+                      "Failed to send nonce (fd=%d): %s",
+                      fd, _dbus_strerror_from_errno ());
+      return FALSE;
+    }
 
   return TRUE;
 }
 
+static dbus_bool_t
+do_noncefile_create (DBusNonceFile *noncefile,
+                     DBusError *error,
+                     dbus_bool_t use_subdir)
+{
+    DBusString randomStr;
+    const char *tmp;
+
+    _DBUS_ASSERT_ERROR_IS_CLEAR (error);
+
+    _dbus_assert (noncefile);
+
+    if (!_dbus_string_init (&randomStr))
+      {
+        dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
+        goto on_error;
+      }
+
+    if (!_dbus_generate_random_ascii (&randomStr, 8))
+      {
+        dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
+        goto on_error;
+      }
+
+    tmp = _dbus_get_tmpdir ();
+
+    if (!_dbus_string_init (&noncefile->dir)
+        || tmp == NULL
+        || !_dbus_string_append (&noncefile->dir, tmp))
+      {
+        dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
+        goto on_error;
+      }
+    if (use_subdir)
+      {
+        if (!_dbus_string_append (&noncefile->dir, "/dbus_nonce-")
+            || !_dbus_string_append (&noncefile->dir, _dbus_string_get_const_data (&randomStr)) )
+          {
+            dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
+            goto on_error;
+          }
+        if (!_dbus_string_init (&noncefile->path)
+            || !_dbus_string_copy (&noncefile->dir, 0, &noncefile->path, 0)
+            || !_dbus_string_append (&noncefile->path, "/nonce"))
+          {
+            dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
+            goto on_error;
+          }
+        if (!_dbus_create_directory (&noncefile->dir, error))
+          {
+            _DBUS_ASSERT_ERROR_IS_SET (error);
+            goto on_error;
+          }
+        _DBUS_ASSERT_ERROR_IS_CLEAR (error);
+
+      }
+    else
+      {
+        if (!_dbus_string_init (&noncefile->path)
+            || !_dbus_string_copy (&noncefile->dir, 0, &noncefile->path, 0)
+            || !_dbus_string_append (&noncefile->path, "/dbus_nonce-")
+            || !_dbus_string_append (&noncefile->path, _dbus_string_get_const_data (&randomStr)))
+          {
+            dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
+            goto on_error;
+          }
+
+      }
+
+    if (!generate_and_write_nonce (&noncefile->path, error))
+      {
+        _DBUS_ASSERT_ERROR_IS_SET (error);
+        if (use_subdir)
+          _dbus_delete_directory (&noncefile->dir, NULL); //we ignore possible errors deleting the dir and return the write error instead
+        goto on_error;
+      }
+    _DBUS_ASSERT_ERROR_IS_CLEAR (error);
+
+    _dbus_string_free (&randomStr);
+
+    return TRUE;
+  on_error:
+    if (use_subdir)
+      _dbus_delete_directory (&noncefile->dir, NULL);
+    _dbus_string_free (&noncefile->dir);
+    _dbus_string_free (&noncefile->path);
+    _dbus_string_free (&randomStr);
+    return FALSE;
+}
+
+#ifdef DBUS_WIN
+/**
+ * creates a nonce file in a user-readable location and writes a generated nonce to it
+ *
+ * @param noncefile returns the nonce file location
+ * @param error error details if creating the nonce file fails
+ * @return TRUE iff the nonce file was successfully created
+ */
+dbus_bool_t
+_dbus_noncefile_create (DBusNonceFile *noncefile,
+                        DBusError *error)
+{
+    return do_noncefile_create (noncefile, error, /*use_subdir=*/FALSE);
+}
+
+/**
+ * deletes the noncefile and frees the DBusNonceFile object.
+ *
+ * @param noncefile the nonce file to delete. Contents will be freed.
+ * @param error error details if the nonce file could not be deleted
+ * @return TRUE
+ */
+dbus_bool_t
+_dbus_noncefile_delete (DBusNonceFile *noncefile,
+                        DBusError *error)
+{
+    _DBUS_ASSERT_ERROR_IS_CLEAR (error);
+
+    _dbus_delete_file (&noncefile->path, error);
+    _dbus_string_free (&noncefile->dir);
+    _dbus_string_free (&noncefile->path);
+    return TRUE;
+}
+
+#else
+/**
+ * creates a nonce file in a user-readable location and writes a generated nonce to it.
+ * Initializes the noncefile object.
+ *
+ * @param noncefile returns the nonce file location
+ * @param error error details if creating the nonce file fails
+ * @return TRUE iff the nonce file was successfully created
+ */
+dbus_bool_t
+_dbus_noncefile_create (DBusNonceFile *noncefile,
+                        DBusError *error)
+{
+    return do_noncefile_create (noncefile, error, /*use_subdir=*/TRUE);
+}
+
+/**
+ * deletes the noncefile and frees the DBusNonceFile object.
+ *
+ * @param noncefile the nonce file to delete. Contents will be freed.
+ * @param error error details if the nonce file could not be deleted
+ * @return TRUE
+ */
+dbus_bool_t
+_dbus_noncefile_delete (DBusNonceFile *noncefile,
+                        DBusError *error)
+{
+    _DBUS_ASSERT_ERROR_IS_CLEAR (error);
+
+    _dbus_delete_directory (&noncefile->dir, error);
+    _dbus_string_free (&noncefile->dir);
+    _dbus_string_free (&noncefile->path);
+    return TRUE;
+}
+#endif
+
+
+/**
+ * returns the absolute file path of the nonce file
+ *
+ * @param noncefile an initialized noncefile object
+ * @return the absolute path of the nonce file
+ */
+const DBusString*
+_dbus_noncefile_get_path (const DBusNonceFile *noncefile)
+{
+    _dbus_assert (noncefile);
+    return &noncefile->path;
+}
+
+/**
+ * reads data from a file descriptor and checks if the received data matches
+ * the data in the given noncefile.
+ *
+ * @param fd the file descriptor to read the nonce from
+ * @param noncefile the nonce file to check the received data against
+ * @param error error details on fail
+ * @return TRUE iff a nonce could be successfully read from the file descriptor
+ * and matches the nonce from the given nonce file
+ */
+dbus_bool_t
+_dbus_noncefile_check_nonce (int fd,
+                             const DBusNonceFile *noncefile,
+                             DBusError* error)
+{
+    return do_check_nonce (fd, _dbus_noncefile_get_path (noncefile), error);
+}
+
+
 /** @} end of nonce */