gio/gdbusauthmechanismsha1.c

   1 /* GDBus - GLib D-Bus Library
   2  *
   3  * Copyright (C) 2008-2010 Red Hat, Inc.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General
  16  * Public License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Author: David Zeuthen <davidz@redhat.com>
  21  */
  22
  23 #include "config.h"
  24
  25 #include <string.h>
  26 #include <fcntl.h>
  27 #include <errno.h>
  28 #include <sys/types.h>
  29 #ifdef HAVE_UNISTD_H
  30 #include <unistd.h>
  31 #endif
  32 #ifdef _WIN32
  33 #include <io.h>
  34 #endif
  35
  36 #include <glib/gstdio.h>
  37
  38 #include "gdbusauthmechanismsha1.h"
  39 #include "gcredentials.h"
  40 #include "gdbuserror.h"
  41 #include "gioenumtypes.h"
  42 #include "gioerror.h"
  43 #include "gdbusprivate.h"
  44
  45 #include "glibintl.h"
  46
  47 struct _GDBusAuthMechanismSha1Private
  48 {
  49   gboolean is_client;
  50   gboolean is_server;
  51   GDBusAuthMechanismState state;
  52
  53   /* used on the client side */
  54   gchar *to_send;
  55
  56   /* used on the server side */
  57   gchar *cookie;
  58   gchar *server_challenge;
  59 };
  60
  61 static gint                     mechanism_get_priority              (void);
  62 static const gchar             *mechanism_get_name                  (void);
  63
  64 static gboolean                 mechanism_is_supported              (GDBusAuthMechanism   *mechanism);
  65 static gchar                   *mechanism_encode_data               (GDBusAuthMechanism   *mechanism,
  66                                                                      const gchar          *data,
  67                                                                      gsize                 data_len,
  68                                                                      gsize                *out_data_len);
  69 static gchar                   *mechanism_decode_data               (GDBusAuthMechanism   *mechanism,
  70                                                                      const gchar          *data,
  71                                                                      gsize                 data_len,
  72                                                                      gsize                *out_data_len);
  73 static GDBusAuthMechanismState  mechanism_server_get_state          (GDBusAuthMechanism   *mechanism);
  74 static void                     mechanism_server_initiate           (GDBusAuthMechanism   *mechanism,
  75                                                                      const gchar          *initial_response,
  76                                                                      gsize                 initial_response_len);
  77 static void                     mechanism_server_data_receive       (GDBusAuthMechanism   *mechanism,
  78                                                                      const gchar          *data,
  79                                                                      gsize                 data_len);
  80 static gchar                   *mechanism_server_data_send          (GDBusAuthMechanism   *mechanism,
  81                                                                      gsize                *out_data_len);
  82 static gchar                   *mechanism_server_get_reject_reason  (GDBusAuthMechanism   *mechanism);
  83 static void                     mechanism_server_shutdown           (GDBusAuthMechanism   *mechanism);
  84 static GDBusAuthMechanismState  mechanism_client_get_state          (GDBusAuthMechanism   *mechanism);
  85 static gchar                   *mechanism_client_initiate           (GDBusAuthMechanism   *mechanism,
  86                                                                      gsize                *out_initial_response_len);
  87 static void                     mechanism_client_data_receive       (GDBusAuthMechanism   *mechanism,
  88                                                                      const gchar          *data,
  89                                                                      gsize                 data_len);
  90 static gchar                   *mechanism_client_data_send          (GDBusAuthMechanism   *mechanism,
  91                                                                      gsize                *out_data_len);
  92 static void                     mechanism_client_shutdown           (GDBusAuthMechanism   *mechanism);
  93
  94 /* ---------------------------------------------------------------------------------------------------- */
  95
  96 G_DEFINE_TYPE (GDBusAuthMechanismSha1, _g_dbus_auth_mechanism_sha1, G_TYPE_DBUS_AUTH_MECHANISM);
  97
  98 /* ---------------------------------------------------------------------------------------------------- */
  99
 100 static void
 101 _g_dbus_auth_mechanism_sha1_finalize (GObject *object)
 102 {
 103   GDBusAuthMechanismSha1 *mechanism = G_DBUS_AUTH_MECHANISM_SHA1 (object);
 104
 105   g_free (mechanism->priv->to_send);
 106
 107   g_free (mechanism->priv->cookie);
 108   g_free (mechanism->priv->server_challenge);
 109
 110   if (G_OBJECT_CLASS (_g_dbus_auth_mechanism_sha1_parent_class)->finalize != NULL)
 111     G_OBJECT_CLASS (_g_dbus_auth_mechanism_sha1_parent_class)->finalize (object);
 112 }
 113
 114 static void
 115 _g_dbus_auth_mechanism_sha1_class_init (GDBusAuthMechanismSha1Class *klass)
 116 {
 117   GObjectClass *gobject_class;
 118   GDBusAuthMechanismClass *mechanism_class;
 119
 120   g_type_class_add_private (klass, sizeof (GDBusAuthMechanismSha1Private));
 121
 122   gobject_class = G_OBJECT_CLASS (klass);
 123   gobject_class->finalize = _g_dbus_auth_mechanism_sha1_finalize;
 124
 125   mechanism_class = G_DBUS_AUTH_MECHANISM_CLASS (klass);
 126   mechanism_class->get_priority              = mechanism_get_priority;
 127   mechanism_class->get_name                  = mechanism_get_name;
 128   mechanism_class->is_supported              = mechanism_is_supported;
 129   mechanism_class->encode_data               = mechanism_encode_data;
 130   mechanism_class->decode_data               = mechanism_decode_data;
 131   mechanism_class->server_get_state          = mechanism_server_get_state;
 132   mechanism_class->server_initiate           = mechanism_server_initiate;
 133   mechanism_class->server_data_receive       = mechanism_server_data_receive;
 134   mechanism_class->server_data_send          = mechanism_server_data_send;
 135   mechanism_class->server_get_reject_reason  = mechanism_server_get_reject_reason;
 136   mechanism_class->server_shutdown           = mechanism_server_shutdown;
 137   mechanism_class->client_get_state          = mechanism_client_get_state;
 138   mechanism_class->client_initiate           = mechanism_client_initiate;
 139   mechanism_class->client_data_receive       = mechanism_client_data_receive;
 140   mechanism_class->client_data_send          = mechanism_client_data_send;
 141   mechanism_class->client_shutdown           = mechanism_client_shutdown;
 142 }
 143
 144 static void
 145 _g_dbus_auth_mechanism_sha1_init (GDBusAuthMechanismSha1 *mechanism)
 146 {
 147   mechanism->priv = G_TYPE_INSTANCE_GET_PRIVATE (mechanism,
 148                                                  G_TYPE_DBUS_AUTH_MECHANISM_SHA1,
 149                                                  GDBusAuthMechanismSha1Private);
 150 }
 151
 152 /* ---------------------------------------------------------------------------------------------------- */
 153
 154 static gint
 155 mechanism_get_priority (void)
 156 {
 157   return 0;
 158 }
 159
 160 static const gchar *
 161 mechanism_get_name (void)
 162 {
 163   return "DBUS_COOKIE_SHA1";
 164 }
 165
 166 static gboolean
 167 mechanism_is_supported (GDBusAuthMechanism *mechanism)
 168 {
 169   g_return_val_if_fail (G_IS_DBUS_AUTH_MECHANISM_SHA1 (mechanism), FALSE);
 170   return TRUE;
 171 }
 172
 173 static gchar *
 174 mechanism_encode_data (GDBusAuthMechanism   *mechanism,
 175                        const gchar          *data,
 176                        gsize                 data_len,
 177                        gsize                *out_data_len)
 178 {
 179   return NULL;
 180 }
 181
 182
 183 static gchar *
 184 mechanism_decode_data (GDBusAuthMechanism   *mechanism,
 185                        const gchar          *data,
 186                        gsize                 data_len,
 187                        gsize                *out_data_len)
 188 {
 189   return NULL;
 190 }
 191
 192 /* ---------------------------------------------------------------------------------------------------- */
 193
 194 static gint
 195 random_ascii (void)
 196 {
 197   gint ret;
 198   ret = g_random_int_range (0, 60);
 199   if (ret < 25)
 200     ret += 'A';
 201   else if (ret < 50)
 202     ret += 'a' - 25;
 203   else
 204     ret += '0' - 50;
 205   return ret;
 206 }
 207
 208 static gchar *
 209 random_ascii_string (guint len)
 210 {
 211   GString *challenge;
 212   guint n;
 213
 214   challenge = g_string_new (NULL);
 215   for (n = 0; n < len; n++)
 216     g_string_append_c (challenge, random_ascii ());
 217   return g_string_free (challenge, FALSE);
 218 }
 219
 220 static gchar *
 221 random_blob (guint len)
 222 {
 223   GString *challenge;
 224   guint n;
 225
 226   challenge = g_string_new (NULL);
 227   for (n = 0; n < len; n++)
 228     g_string_append_c (challenge, g_random_int_range (0, 256));
 229   return g_string_free (challenge, FALSE);
 230 }
 231
 232 /* ---------------------------------------------------------------------------------------------------- */
 233
 234 /* ensure keyring dir exists and permissions are correct */
 235 static gchar *
 236 ensure_keyring_directory (GError **error)
 237 {
 238   gchar *path;
 239   const gchar *e;
 240
 241   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
 242
 243   e = g_getenv ("G_DBUS_COOKIE_SHA1_KEYRING_DIR");
 244   if (e != NULL)
 245     {
 246       path = g_strdup (e);
 247     }
 248   else
 249     {
 250       path = g_build_filename (g_get_home_dir (),
 251                                ".dbus-keyrings",
 252                                NULL);
 253     }
 254
 255   if (g_file_test (path, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR))
 256     {
 257       if (g_getenv ("G_DBUS_COOKIE_SHA1_KEYRING_DIR_IGNORE_PERMISSION") == NULL)
 258         {
 259 #ifdef G_OS_UNIX
 260           struct stat statbuf;
 261           if (stat (path, &statbuf) != 0)
 262             {
 263               g_set_error (error,
 264                            G_IO_ERROR,
 265                            g_io_error_from_errno (errno),
 266                            _("Error statting directory `%s': %s"),
 267                            path,
 268                            strerror (errno));
 269               g_free (path);
 270               path = NULL;
 271               goto out;
 272             }
 273           if ((statbuf.st_mode  & 0777) != 0700)
 274             {
 275               g_set_error (error,
 276                            G_IO_ERROR,
 277                            G_IO_ERROR_FAILED,
 278                            _("Permissions on directory `%s' are malformed. Expected mode 0700, got 0%o"),
 279                            path,
 280                            statbuf.st_mode & 0777);
 281               g_free (path);
 282               path = NULL;
 283               goto out;
 284             }
 285 #else
 286 #ifdef __GNUC__
 287 #warning Please implement permission checking on this non-UNIX platform
 288 #endif
 289 #endif
 290         }
 291         goto out;
 292     }
 293
 294   if (g_mkdir (path, 0700) != 0)
 295     {
 296       g_set_error (error,
 297                    G_IO_ERROR,
 298                    g_io_error_from_errno (errno),
 299                    _("Error creating directory `%s': %s"),
 300                    path,
 301                    strerror (errno));
 302       g_free (path);
 303       path = NULL;
 304       goto out;
 305     }
 306
 307 out:
 308   return path;
 309 }
 310
 311 /* ---------------------------------------------------------------------------------------------------- */
 312
 313 static void
 314 append_nibble (GString *s, gint val)
 315 {
 316   g_string_append_c (s, val >= 10 ? ('a' + val - 10) : ('0' + val));
 317 }
 318
 319 static gchar *
 320 hexencode (const gchar *str,
 321            gssize       len)
 322 {
 323   guint n;
 324   GString *s;
 325
 326   if (len == -1)
 327     len = strlen (str);
 328
 329   s = g_string_new (NULL);
 330   for (n = 0; n < len; n++)
 331     {
 332       gint val;
 333       gint upper_nibble;
 334       gint lower_nibble;
 335
 336       val = ((const guchar *) str)[n];
 337       upper_nibble = val >> 4;
 338       lower_nibble = val & 0x0f;
 339
 340       append_nibble (s, upper_nibble);
 341       append_nibble (s, lower_nibble);
 342     }
 343
 344   return g_string_free (s, FALSE);
 345 }
 346
 347 /* ---------------------------------------------------------------------------------------------------- */
 348
 349 /* looks up an entry in the keyring */
 350 static gchar *
 351 keyring_lookup_entry (const gchar  *cookie_context,
 352                       gint          cookie_id,
 353                       GError      **error)
 354 {
 355   gchar *ret;
 356   gchar *keyring_dir;
 357   gchar *contents;
 358   gchar *path;
 359   guint n;
 360   gchar **lines;
 361
 362   g_return_val_if_fail (cookie_context != NULL, NULL);
 363   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
 364
 365   ret = NULL;
 366   path = NULL;
 367   contents = NULL;
 368   lines = NULL;
 369
 370   keyring_dir = ensure_keyring_directory (error);
 371   if (keyring_dir == NULL)
 372     goto out;
 373
 374   path = g_build_filename (keyring_dir, cookie_context, NULL);
 375
 376   if (!g_file_get_contents (path,
 377                             &contents,
 378                             NULL,
 379                             error))
 380     {
 381       g_prefix_error (error,
 382                       _("Error opening keyring `%s' for reading: "),
 383                       path);
 384       goto out;
 385     }
 386   g_assert (contents != NULL);
 387
 388   lines = g_strsplit (contents, "\n", 0);
 389   for (n = 0; lines[n] != NULL; n++)
 390     {
 391       const gchar *line = lines[n];
 392       gchar **tokens;
 393       gchar *endp;
 394       gint line_id;
 395       guint64 line_when;
 396
 397       if (line[0] == '\0')
 398         continue;
 399
 400       tokens = g_strsplit (line, " ", 0);
 401       if (g_strv_length (tokens) != 3)
 402         {
 403           g_set_error (error,
 404                        G_IO_ERROR,
 405                        G_IO_ERROR_FAILED,
 406                        _("Line %d of the keyring at `%s' with content `%s' is malformed"),
 407                        n + 1,
 408                        path,
 409                        line);
 410           g_strfreev (tokens);
 411           goto out;
 412         }
 413
 414       line_id = g_ascii_strtoll (tokens[0], &endp, 10);
 415       if (*endp != '\0')
 416         {
 417           g_set_error (error,
 418                        G_IO_ERROR,
 419                        G_IO_ERROR_FAILED,
 420                        _("First token of line %d of the keyring at `%s' with content `%s' is malformed"),
 421                        n + 1,
 422                        path,
 423                        line);
 424           g_strfreev (tokens);
 425           goto out;
 426         }
 427
 428       line_when = g_ascii_strtoll (tokens[1], &endp, 10);
 429       if (*endp != '\0')
 430         {
 431           g_set_error (error,
 432                        G_IO_ERROR,
 433                        G_IO_ERROR_FAILED,
 434                        _("Second token of line %d of the keyring at `%s' with content `%s' is malformed"),
 435                        n + 1,
 436                        path,
 437                        line);
 438           g_strfreev (tokens);
 439           goto out;
 440         }
 441
 442       if (line_id == cookie_id)
 443         {
 444           /* YAY, success */
 445           ret = tokens[2]; /* steal pointer */
 446           tokens[2] = NULL;
 447           g_strfreev (tokens);
 448           goto out;
 449         }
 450
 451       g_strfreev (tokens);
 452     }
 453
 454   /* BOOH, didn't find the cookie */
 455   g_set_error (error,
 456                G_IO_ERROR,
 457                G_IO_ERROR_FAILED,
 458                _("Didn't find cookie with id %d in the keyring at `%s'"),
 459                cookie_id,
 460                path);
 461
 462  out:
 463   g_free (keyring_dir);
 464   g_free (path);
 465   g_free (contents);
 466   g_strfreev (lines);
 467   return ret;
 468 }
 469
 470 /* function for logging important events that the system administrator should take notice of */
 471 static void
 472 _log (const gchar *message,
 473       ...)
 474 {
 475   gchar *s;
 476   va_list var_args;
 477
 478   va_start (var_args, message);
 479   s = g_strdup_vprintf (message, var_args);
 480   va_end (var_args);
 481
 482   /* TODO: might want to send this to syslog instead */
 483   g_printerr ("GDBus-DBUS_COOKIE_SHA1: %s\n", s);
 484   g_free (s);
 485 }
 486
 487 static gint
 488 keyring_acquire_lock (const gchar  *path,
 489                       GError      **error)
 490 {
 491   gchar *lock;
 492   gint ret;
 493   guint num_tries;
 494   guint num_create_tries;
 495
 496   g_return_val_if_fail (path != NULL, FALSE);
 497   g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
 498
 499   ret = -1;
 500   lock = g_strdup_printf ("%s.lock", path);
 501
 502   /* This is what the D-Bus spec says
 503    *
 504    *  Create a lockfile name by appending ".lock" to the name of the
 505    *  cookie file. The server should attempt to create this file using
 506    *  O_CREAT | O_EXCL. If file creation fails, the lock
 507    *  fails. Servers should retry for a reasonable period of time,
 508    *  then they may choose to delete an existing lock to keep users
 509    *  from having to manually delete a stale lock. [1]
 510    *
 511    *  [1] : Lockfiles are used instead of real file locking fcntl() because
 512    *         real locking implementations are still flaky on network filesystems
 513    */
 514
 515   num_create_tries = 0;
 516 #ifdef EEXISTS
 517  again:
 518 #endif
 519   num_tries = 0;
 520   while (g_file_test (lock, G_FILE_TEST_EXISTS))
 521     {
 522       /* sleep 10ms, then try again */
 523       g_usleep (1000*10);
 524       num_tries++;
 525       if (num_tries == 50)
 526         {
 527           /* ok, we slept 50*10ms = 0.5 seconds.. Conclude that the lock-file must be
 528            * stale (nuke the it from orbit)
 529            */
 530           if (g_unlink (lock) != 0)
 531             {
 532               g_set_error (error,
 533                            G_IO_ERROR,
 534                            g_io_error_from_errno (errno),
 535                            _("Error deleting stale lock-file `%s': %s"),
 536                            lock,
 537                            strerror (errno));
 538               goto out;
 539             }
 540           _log ("Deleted stale lock-file `%s'", lock);
 541           break;
 542         }
 543     }
 544
 545   ret = g_open (lock, O_CREAT |
 546 #ifdef O_EXCL
 547                 O_EXCL,
 548 #else
 549                 0,
 550 #endif
 551                 0700);
 552   if (ret == -1)
 553     {
 554 #ifdef EEXISTS
 555       /* EEXIST: pathname already exists and O_CREAT and O_EXCL were used. */
 556       if (errno == EEXISTS)
 557         {
 558           num_create_tries++;
 559           if (num_create_tries < 5)
 560             goto again;
 561         }
 562 #endif
 563       g_set_error (error,
 564                    G_IO_ERROR,
 565                    g_io_error_from_errno (errno),
 566                    _("Error creating lock-file `%s': %s"),
 567                    lock,
 568                    strerror (errno));
 569       goto out;
 570     }
 571
 572  out:
 573   g_free (lock);
 574   return ret;
 575 }
 576
 577 static gboolean
 578 keyring_release_lock (const gchar  *path,
 579                       gint          lock_fd,
 580                       GError      **error)
 581 {
 582   gchar *lock;
 583   gboolean ret;
 584
 585   g_return_val_if_fail (path != NULL, FALSE);
 586   g_return_val_if_fail (lock_fd != -1, FALSE);
 587   g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
 588
 589   ret = FALSE;
 590   lock = g_strdup_printf ("%s.lock", path);
 591   if (close (lock_fd) != 0)
 592     {
 593       g_set_error (error,
 594                    G_IO_ERROR,
 595                    g_io_error_from_errno (errno),
 596                    _("Error closing (unlinked) lock-file `%s': %s"),
 597                    lock,
 598                    strerror (errno));
 599       goto out;
 600     }
 601   if (g_unlink (lock) != 0)
 602     {
 603       g_set_error (error,
 604                    G_IO_ERROR,
 605                    g_io_error_from_errno (errno),
 606                    _("Error unlinking lock-file `%s': %s"),
 607                    lock,
 608                    strerror (errno));
 609       goto out;
 610     }
 611
 612   ret = TRUE;
 613
 614  out:
 615   g_free (lock);
 616   return ret;
 617 }
 618
 619
 620 /* adds an entry to the keyring, taking care of locking and deleting stale/future entries */
 621 static gboolean
 622 keyring_generate_entry (const gchar  *cookie_context,
 623                         gint         *out_id,
 624                         gchar       **out_cookie,
 625                         GError      **error)
 626 {
 627   gboolean ret;
 628   gchar *keyring_dir;
 629   gchar *path;
 630   gchar *contents;
 631   GError *local_error;
 632   gchar **lines;
 633   gint max_line_id;
 634   GString *new_contents;
 635   guint64 now;
 636   gboolean have_id;
 637   gint use_id;
 638   gchar *use_cookie;
 639   gboolean changed_file;
 640   gint lock_fd;
 641
 642   g_return_val_if_fail (cookie_context != NULL, FALSE);
 643   g_return_val_if_fail (out_id != NULL, FALSE);
 644   g_return_val_if_fail (out_cookie != NULL, FALSE);
 645   g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
 646
 647   ret = FALSE;
 648   path = NULL;
 649   contents = NULL;
 650   lines = NULL;
 651   new_contents = NULL;
 652   have_id = FALSE;
 653   use_cookie = NULL;
 654   lock_fd = -1;
 655
 656   keyring_dir = ensure_keyring_directory (error);
 657   if (keyring_dir == NULL)
 658     goto out;
 659
 660   path = g_build_filename (keyring_dir, cookie_context, NULL);
 661
 662   lock_fd = keyring_acquire_lock (path, error);
 663   if (lock_fd == -1)
 664     goto out;
 665
 666   local_error = NULL;
 667   contents = NULL;
 668   if (!g_file_get_contents (path,
 669                             &contents,
 670                             NULL,
 671                             &local_error))
 672     {
 673       if (local_error->domain == G_FILE_ERROR && local_error->code == G_FILE_ERROR_NOENT)
 674         {
 675           /* file doesn't have to exist */
 676           g_error_free (local_error);
 677         }
 678       else
 679         {
 680           g_propagate_prefixed_error (error,
 681                                       local_error,
 682                                       _("Error opening keyring `%s' for writing: "),
 683                                       path);
 684           goto out;
 685         }
 686     }
 687
 688   new_contents = g_string_new (NULL);
 689   now = time (NULL);
 690   changed_file = FALSE;
 691
 692   max_line_id = 0;
 693   if (contents != NULL)
 694     {
 695       guint n;
 696       lines = g_strsplit (contents, "\n", 0);
 697       for (n = 0; lines[n] != NULL; n++)
 698         {
 699           const gchar *line = lines[n];
 700           gchar **tokens;
 701           gchar *endp;
 702           gint line_id;
 703           guint64 line_when;
 704           gboolean keep_entry;
 705
 706           if (line[0] == '\0')
 707             continue;
 708
 709           tokens = g_strsplit (line, " ", 0);
 710           if (g_strv_length (tokens) != 3)
 711             {
 712               g_set_error (error,
 713                            G_IO_ERROR,
 714                            G_IO_ERROR_FAILED,
 715                            _("Line %d of the keyring at `%s' with content `%s' is malformed"),
 716                            n + 1,
 717                            path,
 718                            line);
 719               g_strfreev (tokens);
 720               goto out;
 721             }
 722
 723           line_id = g_ascii_strtoll (tokens[0], &endp, 10);
 724           if (*endp != '\0')
 725             {
 726               g_set_error (error,
 727                            G_IO_ERROR,
 728                            G_IO_ERROR_FAILED,
 729                            _("First token of line %d of the keyring at `%s' with content `%s' is malformed"),
 730                            n + 1,
 731                            path,
 732                            line);
 733               g_strfreev (tokens);
 734               goto out;
 735             }
 736
 737           line_when = g_ascii_strtoll (tokens[1], &endp, 10);
 738           if (*endp != '\0')
 739             {
 740               g_set_error (error,
 741                            G_IO_ERROR,
 742                            G_IO_ERROR_FAILED,
 743                            _("Second token of line %d of the keyring at `%s' with content `%s' is malformed"),
 744                            n + 1,
 745                            path,
 746                            line);
 747               g_strfreev (tokens);
 748               goto out;
 749             }
 750
 751           /* D-Bus spec says:
 752            *
 753            *  Once the lockfile has been created, the server loads the
 754            *  cookie file. It should then delete any cookies that are
 755            *  old (the timeout can be fairly short), or more than a
 756            *  reasonable time in the future (so that cookies never
 757            *  accidentally become permanent, if the clock was set far
 758            *  into the future at some point). If no recent keys remain,
 759            *  the server may generate a new key.
 760            *
 761            */
 762           keep_entry = TRUE;
 763           if (line_when > now)
 764             {
 765               /* Oddball case: entry is more recent than our current wall-clock time..
 766                * This is OK, it means that another server on another machine but with
 767                * same $HOME wrote the entry.
 768                *
 769                * So discard the entry if it's more than 1 day in the future ("reasonable
 770                * time in the future").
 771                */
 772               if (line_when - now > 24*60*60)
 773                 {
 774                   keep_entry = FALSE;
 775                   _log ("Deleted SHA1 cookie from %" G_GUINT64_FORMAT " seconds in the future", line_when - now);
 776                 }
 777             }
 778           else
 779             {
 780               /* Discard entry if it's older than 15 minutes ("can be fairly short") */
 781               if (now - line_when > 15*60)
 782                 {
 783                   keep_entry = FALSE;
 784                 }
 785             }
 786
 787           if (!keep_entry)
 788             {
 789               changed_file = FALSE;
 790             }
 791           else
 792             {
 793               g_string_append_printf (new_contents,
 794                                       "%d %" G_GUINT64_FORMAT " %s\n",
 795                                       line_id,
 796                                       line_when,
 797                                       tokens[2]);
 798               max_line_id = MAX (line_id, max_line_id);
 799               /* Only reuse entry if not older than 10 minutes.
 800                *
 801                * (We need a bit of grace time compared to 15 minutes above.. otherwise
 802                * there's a race where we reuse the 14min59.9 secs old entry and a
 803                * split-second later another server purges the now 15 minute old entry.)
 804                */
 805               if (now - line_when < 10 * 60)
 806                 {
 807                   if (!have_id)
 808                     {
 809                       use_id = line_id;
 810                       use_cookie = tokens[2]; /* steal memory */
 811                       tokens[2] = NULL;
 812                       have_id = TRUE;
 813                     }
 814                 }
 815             }
 816           g_strfreev (tokens);
 817         }
 818     } /* for each line */
 819
 820   ret = TRUE;
 821
 822   if (have_id)
 823     {
 824       *out_id = use_id;
 825       *out_cookie = use_cookie;
 826       use_cookie = NULL;
 827     }
 828   else
 829     {
 830       gchar *raw_cookie;
 831       *out_id = max_line_id + 1;
 832       raw_cookie = random_blob (32);
 833       *out_cookie = hexencode (raw_cookie, 32);
 834       g_free (raw_cookie);
 835
 836       g_string_append_printf (new_contents,
 837                               "%d %" G_GUINT64_FORMAT " %s\n",
 838                               *out_id,
 839                               (guint64) time (NULL),
 840                               *out_cookie);
 841       changed_file = TRUE;
 842     }
 843
 844   /* and now actually write the cookie file if there are changes (this is atomic) */
 845   if (changed_file)
 846     {
 847       if (!g_file_set_contents (path,
 848                                 new_contents->str,
 849                                 -1,
 850                                 error))
 851         {
 852           *out_id = 0;
 853           *out_cookie = 0;
 854           g_free (*out_cookie);
 855           ret = FALSE;
 856           goto out;
 857         }
 858     }
 859
 860  out:
 861
 862   if (lock_fd != -1)
 863     {
 864       GError *local_error;
 865       local_error = NULL;
 866       if (!keyring_release_lock (path, lock_fd, &local_error))
 867         {
 868           if (error != NULL)
 869             {
 870               if (*error == NULL)
 871                 {
 872                   *error = local_error;
 873                 }
 874               else
 875                 {
 876                   g_prefix_error (error,
 877                                   _("(Additionally, releasing the lock for `%s' also failed: %s) "),
 878                                   path,
 879                                   local_error->message);
 880                 }
 881             }
 882           else
 883             {
 884               g_error_free (local_error);
 885             }
 886         }
 887     }
 888
 889   g_free (keyring_dir);
 890   g_free (path);
 891   g_strfreev (lines);
 892   g_free (contents);
 893   if (new_contents != NULL)
 894     g_string_free (new_contents, TRUE);
 895   g_free (use_cookie);
 896   return ret;
 897 }
 898
 899 /* ---------------------------------------------------------------------------------------------------- */
 900
 901 static gchar *
 902 generate_sha1 (const gchar *server_challenge,
 903                const gchar *client_challenge,
 904                const gchar *cookie)
 905 {
 906   GString *str;
 907   gchar *sha1;
 908
 909   str = g_string_new (server_challenge);
 910   g_string_append_c (str, ':');
 911   g_string_append (str, client_challenge);
 912   g_string_append_c (str, ':');
 913   g_string_append (str, cookie);
 914   sha1 = g_compute_checksum_for_string (G_CHECKSUM_SHA1, str->str, -1);
 915   g_string_free (str, TRUE);
 916
 917   return sha1;
 918 }
 919
 920 /* ---------------------------------------------------------------------------------------------------- */
 921
 922 static GDBusAuthMechanismState
 923 mechanism_server_get_state (GDBusAuthMechanism   *mechanism)
 924 {
 925   GDBusAuthMechanismSha1 *m = G_DBUS_AUTH_MECHANISM_SHA1 (mechanism);
 926
 927   g_return_val_if_fail (G_IS_DBUS_AUTH_MECHANISM_SHA1 (mechanism), G_DBUS_AUTH_MECHANISM_STATE_INVALID);
 928   g_return_val_if_fail (m->priv->is_server && !m->priv->is_client, G_DBUS_AUTH_MECHANISM_STATE_INVALID);
 929
 930   return m->priv->state;
 931 }
 932
 933 static void
 934 mechanism_server_initiate (GDBusAuthMechanism   *mechanism,
 935                            const gchar          *initial_response,
 936                            gsize                 initial_response_len)
 937 {
 938   GDBusAuthMechanismSha1 *m = G_DBUS_AUTH_MECHANISM_SHA1 (mechanism);
 939
 940   g_return_if_fail (G_IS_DBUS_AUTH_MECHANISM_SHA1 (mechanism));
 941   g_return_if_fail (!m->priv->is_server && !m->priv->is_client);
 942
 943   m->priv->is_server = TRUE;
 944   m->priv->state = G_DBUS_AUTH_MECHANISM_STATE_REJECTED;
 945
 946   if (initial_response != NULL && strlen (initial_response) > 0)
 947     {
 948 #ifdef G_OS_UNIX
 949       gint64 uid;
 950       gchar *endp;
 951
 952       uid = g_ascii_strtoll (initial_response, &endp, 10);
 953       if (*endp == '\0')
 954         {
 955           if (uid == getuid ())
 956             {
 957               m->priv->state = G_DBUS_AUTH_MECHANISM_STATE_HAVE_DATA_TO_SEND;
 958             }
 959         }
 960 #elif defined(G_OS_WIN32)
 961       gchar *sid;
 962       sid = _g_dbus_win32_get_user_sid ();
 963       if (g_strcmp0 (initial_response, sid) == 0)
 964         m->priv->state = G_DBUS_AUTH_MECHANISM_STATE_HAVE_DATA_TO_SEND;
 965       g_free (sid);
 966 #else
 967 #error Please implement for your OS
 968 #endif
 969     }
 970 }
 971
 972 static void
 973 mechanism_server_data_receive (GDBusAuthMechanism   *mechanism,
 974                                const gchar          *data,
 975                                gsize                 data_len)
 976 {
 977   GDBusAuthMechanismSha1 *m = G_DBUS_AUTH_MECHANISM_SHA1 (mechanism);
 978   gchar **tokens;
 979   const gchar *client_challenge;
 980   const gchar *alleged_sha1;
 981   gchar *sha1;
 982
 983   g_return_if_fail (G_IS_DBUS_AUTH_MECHANISM_SHA1 (mechanism));
 984   g_return_if_fail (m->priv->is_server && !m->priv->is_client);
 985   g_return_if_fail (m->priv->state == G_DBUS_AUTH_MECHANISM_STATE_WAITING_FOR_DATA);
 986
 987   tokens = NULL;
 988   sha1 = NULL;
 989
 990   tokens = g_strsplit (data, " ", 0);
 991   if (g_strv_length (tokens) != 2)
 992     {
 993       g_warning ("Malformed data `%s'", data);
 994       m->priv->state = G_DBUS_AUTH_MECHANISM_STATE_REJECTED;
 995       goto out;
 996     }
 997
 998   client_challenge = tokens[0];
 999   alleged_sha1 = tokens[1];
1000
1001   sha1 = generate_sha1 (m->priv->server_challenge, client_challenge, m->priv->cookie);
1002
1003   if (g_strcmp0 (sha1, alleged_sha1) == 0)
1004     {
1005       m->priv->state = G_DBUS_AUTH_MECHANISM_STATE_ACCEPTED;
1006     }
1007   else
1008     {
1009       m->priv->state = G_DBUS_AUTH_MECHANISM_STATE_REJECTED;
1010     }
1011
1012  out:
1013   g_strfreev (tokens);
1014   g_free (sha1);
1015 }
1016
1017 static gchar *
1018 mechanism_server_data_send (GDBusAuthMechanism   *mechanism,
1019                             gsize                *out_data_len)
1020 {
1021   GDBusAuthMechanismSha1 *m = G_DBUS_AUTH_MECHANISM_SHA1 (mechanism);
1022   gchar *s;
1023   gint cookie_id;
1024   const gchar *cookie_context;
1025   GError *error;
1026
1027   g_return_val_if_fail (G_IS_DBUS_AUTH_MECHANISM_SHA1 (mechanism), NULL);
1028   g_return_val_if_fail (m->priv->is_server && !m->priv->is_client, NULL);
1029   g_return_val_if_fail (m->priv->state == G_DBUS_AUTH_MECHANISM_STATE_HAVE_DATA_TO_SEND, NULL);
1030
1031   s = NULL;
1032
1033   /* TODO: use GDBusAuthObserver here to get the cookie context to use? */
1034   cookie_context = "org_gtk_gdbus_general";
1035
1036   error = NULL;
1037   if (!keyring_generate_entry (cookie_context,
1038                                &cookie_id,
1039                                &m->priv->cookie,
1040                                &error))
1041     {
1042       g_warning ("Error adding entry to keyring: %s", error->message);
1043       g_error_free (error);
1044       m->priv->state = G_DBUS_AUTH_MECHANISM_STATE_REJECTED;
1045       goto out;
1046     }
1047
1048   m->priv->server_challenge = random_ascii_string (16);
1049   s = g_strdup_printf ("%s %d %s",
1050                        cookie_context,
1051                        cookie_id,
1052                        m->priv->server_challenge);
1053
1054   m->priv->state = G_DBUS_AUTH_MECHANISM_STATE_WAITING_FOR_DATA;
1055
1056  out:
1057   return s;
1058 }
1059
1060 static gchar *
1061 mechanism_server_get_reject_reason (GDBusAuthMechanism   *mechanism)
1062 {
1063   GDBusAuthMechanismSha1 *m = G_DBUS_AUTH_MECHANISM_SHA1 (mechanism);
1064
1065   g_return_val_if_fail (G_IS_DBUS_AUTH_MECHANISM_SHA1 (mechanism), NULL);
1066   g_return_val_if_fail (m->priv->is_server && !m->priv->is_client, NULL);
1067   g_return_val_if_fail (m->priv->state == G_DBUS_AUTH_MECHANISM_STATE_REJECTED, NULL);
1068
1069   /* can never end up here because we are never in the REJECTED state */
1070   g_assert_not_reached ();
1071
1072   return NULL;
1073 }
1074
1075 static void
1076 mechanism_server_shutdown (GDBusAuthMechanism   *mechanism)
1077 {
1078   GDBusAuthMechanismSha1 *m = G_DBUS_AUTH_MECHANISM_SHA1 (mechanism);
1079
1080   g_return_if_fail (G_IS_DBUS_AUTH_MECHANISM_SHA1 (mechanism));
1081   g_return_if_fail (m->priv->is_server && !m->priv->is_client);
1082
1083   m->priv->is_server = FALSE;
1084 }
1085
1086 /* ---------------------------------------------------------------------------------------------------- */
1087
1088 static GDBusAuthMechanismState
1089 mechanism_client_get_state (GDBusAuthMechanism   *mechanism)
1090 {
1091   GDBusAuthMechanismSha1 *m = G_DBUS_AUTH_MECHANISM_SHA1 (mechanism);
1092
1093   g_return_val_if_fail (G_IS_DBUS_AUTH_MECHANISM_SHA1 (mechanism), G_DBUS_AUTH_MECHANISM_STATE_INVALID);
1094   g_return_val_if_fail (m->priv->is_client && !m->priv->is_server, G_DBUS_AUTH_MECHANISM_STATE_INVALID);
1095
1096   return m->priv->state;
1097 }
1098
1099 static gchar *
1100 mechanism_client_initiate (GDBusAuthMechanism   *mechanism,
1101                            gsize                *out_initial_response_len)
1102 {
1103   GDBusAuthMechanismSha1 *m = G_DBUS_AUTH_MECHANISM_SHA1 (mechanism);
1104   gchar *initial_response;
1105
1106   g_return_val_if_fail (G_IS_DBUS_AUTH_MECHANISM_SHA1 (mechanism), NULL);
1107   g_return_val_if_fail (!m->priv->is_server && !m->priv->is_client, NULL);
1108
1109   m->priv->is_client = TRUE;
1110   m->priv->state = G_DBUS_AUTH_MECHANISM_STATE_WAITING_FOR_DATA;
1111
1112   *out_initial_response_len = -1;
1113
1114 #ifdef G_OS_UNIX
1115   initial_response = g_strdup_printf ("%" G_GINT64_FORMAT, (gint64) getuid ());
1116 #elif defined (G_OS_WIN32)
1117 initial_response = _g_dbus_win32_get_user_sid ();
1118 #else
1119 #error Please implement for your OS
1120 #endif
1121   g_assert (initial_response != NULL);
1122
1123   return initial_response;
1124 }
1125
1126 static void
1127 mechanism_client_data_receive (GDBusAuthMechanism   *mechanism,
1128                                const gchar          *data,
1129                                gsize                 data_len)
1130 {
1131   GDBusAuthMechanismSha1 *m = G_DBUS_AUTH_MECHANISM_SHA1 (mechanism);
1132   gchar **tokens;
1133   const gchar *cookie_context;
1134   guint cookie_id;
1135   const gchar *server_challenge;
1136   gchar *client_challenge;
1137   gchar *endp;
1138   gchar *cookie;
1139   GError *error;
1140   gchar *sha1;
1141
1142   g_return_if_fail (G_IS_DBUS_AUTH_MECHANISM_SHA1 (mechanism));
1143   g_return_if_fail (m->priv->is_client && !m->priv->is_server);
1144   g_return_if_fail (m->priv->state == G_DBUS_AUTH_MECHANISM_STATE_WAITING_FOR_DATA);
1145
1146   tokens = NULL;
1147   cookie = NULL;
1148   client_challenge = NULL;
1149
1150   tokens = g_strsplit (data, " ", 0);
1151   if (g_strv_length (tokens) != 3)
1152     {
1153       g_warning ("Malformed data `%s'", data);
1154       m->priv->state = G_DBUS_AUTH_MECHANISM_STATE_REJECTED;
1155       goto out;
1156     }
1157
1158   cookie_context = tokens[0];
1159   cookie_id = g_ascii_strtoll (tokens[1], &endp, 10);
1160   if (*endp != '\0')
1161     {
1162       g_warning ("Malformed cookie_id `%s'", tokens[1]);
1163       m->priv->state = G_DBUS_AUTH_MECHANISM_STATE_REJECTED;
1164       goto out;
1165     }
1166   server_challenge = tokens[2];
1167
1168   error = NULL;
1169   cookie = keyring_lookup_entry (cookie_context, cookie_id, &error);
1170   if (cookie == NULL)
1171     {
1172       g_warning ("Problems looking up entry in keyring: %s", error->message);
1173       g_error_free (error);
1174       m->priv->state = G_DBUS_AUTH_MECHANISM_STATE_REJECTED;
1175       goto out;
1176     }
1177
1178   client_challenge = random_ascii_string (16);
1179   sha1 = generate_sha1 (server_challenge, client_challenge, cookie);
1180   m->priv->to_send = g_strdup_printf ("%s %s", client_challenge, sha1);
1181   g_free (sha1);
1182   m->priv->state = G_DBUS_AUTH_MECHANISM_STATE_HAVE_DATA_TO_SEND;
1183
1184  out:
1185   g_strfreev (tokens);
1186   g_free (cookie);
1187   g_free (client_challenge);
1188 }
1189
1190 static gchar *
1191 mechanism_client_data_send (GDBusAuthMechanism   *mechanism,
1192                             gsize                *out_data_len)
1193 {
1194   GDBusAuthMechanismSha1 *m = G_DBUS_AUTH_MECHANISM_SHA1 (mechanism);
1195
1196   g_return_val_if_fail (G_IS_DBUS_AUTH_MECHANISM_SHA1 (mechanism), NULL);
1197   g_return_val_if_fail (m->priv->is_client && !m->priv->is_server, NULL);
1198   g_return_val_if_fail (m->priv->state == G_DBUS_AUTH_MECHANISM_STATE_HAVE_DATA_TO_SEND, NULL);
1199
1200   g_assert (m->priv->to_send != NULL);
1201
1202   m->priv->state = G_DBUS_AUTH_MECHANISM_STATE_ACCEPTED;
1203
1204   return g_strdup (m->priv->to_send);
1205 }
1206
1207 static void
1208 mechanism_client_shutdown (GDBusAuthMechanism   *mechanism)
1209 {
1210   GDBusAuthMechanismSha1 *m = G_DBUS_AUTH_MECHANISM_SHA1 (mechanism);
1211
1212   g_return_if_fail (G_IS_DBUS_AUTH_MECHANISM_SHA1 (mechanism));
1213   g_return_if_fail (m->priv->is_client && !m->priv->is_server);
1214
1215   m->priv->is_client = FALSE;
1216 }
1217
1218 /* ---------------------------------------------------------------------------------------------------- */