dbus/dbus-nonce.c

   1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
   2 /* dbus-nonce.c  Nonce handling functions used by nonce-tcp (internal to D-Bus implementation)
   3  *
   4  * Copyright (C) 2009 Klaralvdalens Datakonsult AB, a KDAB Group company, info@kdab.net
   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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  */
  23
  24 #include <config.h>
  25 // major sections of this file are modified code from libassuan, (C) FSF
  26 #include "dbus-nonce.h"
  27 #include "dbus-internals.h"
  28 #include "dbus-protocol.h"
  29 #include "dbus-sysdeps.h"
  30
  31 #include <stdio.h>
  32
  33 static dbus_bool_t
  34 do_check_nonce (int fd, const DBusString *nonce, DBusError *error)
  35 {
  36   DBusString buffer;
  37   DBusString p;
  38   size_t nleft;
  39   dbus_bool_t result;
  40   int n;
  41
  42   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
  43
  44   nleft = 16;
  45
  46   if (   !_dbus_string_init (&buffer)
  47       || !_dbus_string_init (&p) ) {
  48         dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
  49         _dbus_string_free (&p);
  50         _dbus_string_free (&buffer);
  51         return FALSE;
  52       }
  53
  54   while (nleft)
  55     {
  56       n = _dbus_read_socket (fd, &p, nleft);
  57       if (n == -1 && _dbus_get_is_errno_eintr())
  58         ;
  59       else if (n == -1 && _dbus_get_is_errno_eagain_or_ewouldblock())
  60         _dbus_sleep_milliseconds (100);
  61       else if (n==-1)
  62         {
  63           dbus_set_error (error, DBUS_ERROR_IO_ERROR, "Could not read nonce from socket (fd=%d)", fd );
  64           _dbus_string_free (&p);
  65           _dbus_string_free (&buffer);
  66           return FALSE;
  67         }
  68       else if (!n)
  69         {
  70           _dbus_string_free (&p);
  71           _dbus_string_free (&buffer);
  72           dbus_set_error (error, DBUS_ERROR_IO_ERROR, "Could not read nonce from socket (fd=%d)", fd );
  73           return FALSE;
  74         }
  75       else
  76         {
  77           _dbus_string_append_len(&buffer, _dbus_string_get_const_data (&p), n);
  78           nleft -= n;
  79         }
  80     }
  81
  82   result =  _dbus_string_equal_len (&buffer, nonce, 16);
  83   if (!result)
  84     dbus_set_error (error, DBUS_ERROR_ACCESS_DENIED, "Nonces do not match, access denied (fd=%d)", fd );
  85
  86   _dbus_string_free (&p);
  87   _dbus_string_free (&buffer);
  88
  89   return result;
  90 }
  91
  92 /**
  93  * reads the nonce from the nonce file and stores it in a string
  94  *
  95  * @param fname the file to read the nonce from
  96  * @param nonce returns the nonce. Must be an initialized string, the nonce will be appended.
  97  * @param error error object to report possible errors
  98  * @return FALSE iff reading the nonce fails (error is set then)
  99  */
 100 dbus_bool_t
 101 _dbus_read_nonce (const DBusString *fname, DBusString *nonce, DBusError* error)
 102 {
 103   FILE *fp;
 104   char buffer[17];
 105   size_t nread;
 106
 107   buffer[sizeof buffer - 1] = '\0';
 108
 109   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 110
 111   _dbus_verbose ("reading nonce from file: %s\n", _dbus_string_get_const_data (fname));
 112
 113
 114   fp = fopen (_dbus_string_get_const_data (fname), "rb");
 115   if (!fp)
 116     return FALSE;
 117   nread = fread (buffer, 1, sizeof buffer - 1, fp);
 118   fclose (fp);
 119   if (!nread)
 120     {
 121       dbus_set_error (error, DBUS_ERROR_FILE_NOT_FOUND, "Could not read nonce from file %s", _dbus_string_get_const_data (fname));
 122       return FALSE;
 123     }
 124
 125   if (!_dbus_string_append_len (nonce, buffer, sizeof buffer - 1 ))
 126     {
 127       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 128       return FALSE;
 129     }
 130   return TRUE;
 131 }
 132
 133 int
 134 _dbus_accept_with_noncefile (int listen_fd, const DBusNonceFile *noncefile)
 135 {
 136   int fd;
 137   DBusString nonce;
 138
 139   _dbus_assert (noncefile != NULL);
 140   if (!_dbus_string_init (&nonce))
 141     return -1;
 142   //PENDING(kdab): set better errors
 143   if (_dbus_read_nonce (_dbus_noncefile_get_path(noncefile), &nonce, NULL) != TRUE)
 144     return -1;
 145   fd = _dbus_accept (listen_fd);
 146   if (_dbus_socket_is_invalid (fd))
 147     return fd;
 148   if (do_check_nonce(fd, &nonce, NULL) != TRUE) {
 149     _dbus_verbose ("nonce check failed. Closing socket.\n");
 150     _dbus_close_socket(fd, NULL);
 151     return -1;
 152   }
 153
 154   return fd;
 155 }
 156
 157 static dbus_bool_t
 158 generate_and_write_nonce (const DBusString *filename, DBusError *error)
 159 {
 160   DBusString nonce;
 161   dbus_bool_t ret;
 162
 163   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 164
 165   if (!_dbus_string_init (&nonce))
 166     {
 167       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 168       return FALSE;
 169     }
 170
 171   if (!_dbus_generate_random_bytes (&nonce, 16))
 172     {
 173       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 174       _dbus_string_free (&nonce);
 175       return FALSE;
 176     }
 177
 178   ret = _dbus_string_save_to_file (&nonce, filename, FALSE, error);
 179
 180   _dbus_string_free (&nonce);
 181
 182   return ret;
 183 }
 184
 185 /**
 186  * sends the nonce over a given socket. Blocks while doing so.
 187  *
 188  * @param fd the file descriptor to write the nonce data to (usually a socket)
 189  * @param noncefile the noncefile location to read the nonce from
 190  * @param error contains error details if FALSE is returned
 191  * @return TRUE iff the nonce was successfully sent. Note that this does not
 192  * indicate whether the server accepted the nonce.
 193  */
 194 dbus_bool_t
 195 _dbus_send_nonce (int fd, const DBusString *noncefile, DBusError *error)
 196 {
 197   dbus_bool_t read_result;
 198   int send_result;
 199   size_t sendLen;
 200   DBusString nonce;
 201
 202   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 203
 204   if (_dbus_string_get_length (noncefile) == 0)
 205     return FALSE;
 206
 207   if (!_dbus_string_init (&nonce))
 208     {
 209       dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 210       return FALSE;
 211     }
 212
 213   read_result = _dbus_read_nonce (noncefile, &nonce, error);
 214   if (!read_result)
 215     {
 216       _DBUS_ASSERT_ERROR_IS_SET (error);
 217       _dbus_string_free (&nonce);
 218       return FALSE;
 219     }
 220   _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 221
 222   send_result = _dbus_write_socket (fd, &nonce, 0, _dbus_string_get_length (&nonce));
 223
 224   _dbus_string_free (&nonce);
 225
 226   if (send_result == -1)
 227     {
 228       dbus_set_error (error,
 229                       _dbus_error_from_system_errno (),
 230                       "Failed to send nonce (fd=%d): %s",
 231                       fd, _dbus_strerror_from_errno ());
 232       return FALSE;
 233     }
 234
 235   return TRUE;
 236 }
 237
 238 static dbus_bool_t
 239 do_noncefile_create (DBusNonceFile *noncefile,
 240                      DBusError *error,
 241                      dbus_bool_t use_subdir)
 242 {
 243     dbus_bool_t ret;
 244     DBusString randomStr;
 245
 246     _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 247
 248     _dbus_assert (noncefile);
 249
 250     if (!_dbus_string_init (&randomStr))
 251       {
 252         dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 253         goto on_error;
 254       }
 255
 256     if (!_dbus_generate_random_ascii (&randomStr, 8))
 257       {
 258         dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 259         goto on_error;
 260       }
 261
 262     if (!_dbus_string_init (&noncefile->dir)
 263         || !_dbus_string_append (&noncefile->dir, _dbus_get_tmpdir()))
 264       {
 265         dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 266         goto on_error;
 267       }
 268     if (use_subdir)
 269       {
 270         if (!_dbus_string_append (&noncefile->dir, "/dbus_nonce-")
 271             || !_dbus_string_append (&noncefile->dir, _dbus_string_get_const_data (&randomStr)) )
 272           {
 273             dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 274             goto on_error;
 275           }
 276         if (!_dbus_string_init (&noncefile->path)
 277             || !_dbus_string_copy (&noncefile->dir, 0, &noncefile->path, 0)
 278             || !_dbus_string_append (&noncefile->path, "/nonce"))
 279           {
 280             dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 281             goto on_error;
 282           }
 283         if (!_dbus_create_directory (&noncefile->dir, error))
 284           {
 285             _DBUS_ASSERT_ERROR_IS_SET (error);
 286             goto on_error;
 287           }
 288         _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 289
 290       }
 291     else
 292       {
 293         if (!_dbus_string_init (&noncefile->path)
 294             || !_dbus_string_copy (&noncefile->dir, 0, &noncefile->path, 0)
 295             || !_dbus_string_append (&noncefile->path, "/dbus_nonce-")
 296             || !_dbus_string_append (&noncefile->path, _dbus_string_get_const_data (&randomStr)))
 297           {
 298             dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
 299             goto on_error;
 300           }
 301
 302       }
 303
 304     if (!generate_and_write_nonce (&noncefile->path, error))
 305       {
 306         _DBUS_ASSERT_ERROR_IS_SET (error);
 307         if (use_subdir)
 308           _dbus_delete_directory (&noncefile->dir, NULL); //we ignore possible errors deleting the dir and return the write error instead
 309         goto on_error;
 310       }
 311     _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 312
 313     _dbus_string_free (&randomStr);
 314
 315     return TRUE;
 316   on_error:
 317     if (use_subdir)
 318       _dbus_delete_directory (&noncefile->dir, NULL);
 319     _dbus_string_free (&noncefile->dir);
 320     _dbus_string_free (&noncefile->path);
 321     _dbus_string_free (&randomStr);
 322     return FALSE;
 323 }
 324
 325 #ifdef DBUS_WIN
 326 /**
 327  * creates a nonce file in a user-readable location and writes a generated nonce to it
 328  *
 329  * @param noncefile returns the nonce file location
 330  * @param error error details if creating the nonce file fails
 331  * @return TRUE iff the nonce file was successfully created
 332  */
 333 dbus_bool_t
 334 _dbus_noncefile_create (DBusNonceFile *noncefile,
 335                         DBusError *error)
 336 {
 337     return do_noncefile_create (noncefile, error, /*use_subdir=*/FALSE);
 338 }
 339
 340 /**
 341  * deletes the noncefile and frees the DBusNonceFile object.
 342  *
 343  * @param noncefile the nonce file to delete. Contents will be freed.
 344  * @param error error details if the nonce file could not be deleted
 345  * @return TRUE
 346  */
 347 dbus_bool_t
 348 _dbus_noncefile_delete (DBusNonceFile *noncefile,
 349                         DBusError *error)
 350 {
 351     _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 352
 353     _dbus_delete_file (&noncefile->path, error);
 354     _dbus_string_free (&noncefile->dir);
 355     _dbus_string_free (&noncefile->path);
 356     return TRUE;
 357 }
 358
 359 #else
 360 /**
 361  * creates a nonce file in a user-readable location and writes a generated nonce to it.
 362  * Initializes the noncefile object.
 363  *
 364  * @param noncefile returns the nonce file location
 365  * @param error error details if creating the nonce file fails
 366  * @return TRUE iff the nonce file was successfully created
 367  */
 368 dbus_bool_t
 369 _dbus_noncefile_create (DBusNonceFile *noncefile,
 370                         DBusError *error)
 371 {
 372     return do_noncefile_create (noncefile, error, /*use_subdir=*/TRUE);
 373 }
 374
 375 /**
 376  * deletes the noncefile and frees the DBusNonceFile object.
 377  *
 378  * @param noncefile the nonce file to delete. Contents will be freed.
 379  * @param error error details if the nonce file could not be deleted
 380  * @return TRUE
 381  */
 382 dbus_bool_t
 383 _dbus_noncefile_delete (DBusNonceFile *noncefile,
 384                         DBusError *error)
 385 {
 386     _DBUS_ASSERT_ERROR_IS_CLEAR (error);
 387
 388     _dbus_delete_directory (&noncefile->dir, error);
 389     _dbus_string_free (&noncefile->dir);
 390     _dbus_string_free (&noncefile->path);
 391     return TRUE;
 392 }
 393 #endif
 394
 395
 396 /**
 397  * returns the absolute file path of the nonce file
 398  *
 399  * @param noncefile an initialized noncefile object
 400  * @return the absolute path of the nonce file
 401  */
 402 const DBusString*
 403 _dbus_noncefile_get_path (const DBusNonceFile *noncefile)
 404 {
 405     _dbus_assert (noncefile);
 406     return &noncefile->path;
 407 }
 408
 409 /**
 410  * reads data from a file descriptor and checks if the received data matches
 411  * the data in the given noncefile.
 412  *
 413  * @param fd the file descriptor to read the nonce from
 414  * @param noncefile the nonce file to check the received data against
 415  * @param error error details on fail
 416  * @return TRUE iff a nonce could be successfully read from the file descriptor
 417  * and matches the nonce from the given nonce file
 418  */
 419 dbus_bool_t
 420 _dbus_noncefile_check_nonce (int fd,
 421                              const DBusNonceFile *noncefile,
 422                              DBusError* error)
 423 {
 424     return do_check_nonce (fd, _dbus_noncefile_get_path (noncefile), error);
 425 }
 426
 427
 428 /** @} end of nonce */