dbus/dbus-auth.c

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-auth.c Authentication
   3  *
   4  * Copyright (C) 2002, 2003 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 #include "dbus-auth.h"
  24 #include "dbus-string.h"
  25 #include "dbus-list.h"
  26 #include "dbus-internals.h"
  27 #include "dbus-keyring.h"
  28 #include "dbus-sha.h"
  29 #include "dbus-userdb.h"
  30
  31 /* See doc/dbus-sasl-profile.txt */
  32
  33 /**
  34  * @defgroup DBusAuth Authentication
  35  * @ingroup  DBusInternals
  36  * @brief DBusAuth object
  37  *
  38  * DBusAuth manages the authentication negotiation when a connection
  39  * is first established, and also manage any encryption used over a
  40  * connection.
  41  *
  42  * @todo some SASL profiles require sending the empty string as a
  43  * challenge/response, but we don't currently allow that in our
  44  * protocol.
  45  *
  46  * @todo DBusAuth really needs to be rewritten as an explicit state
  47  * machine. Right now it's too hard to prove to yourself by inspection
  48  * that it works.
  49  *
  50  * @todo right now sometimes both ends will block waiting for input
  51  * from the other end, e.g. if there's an error during
  52  * DBUS_COOKIE_SHA1.
  53  *
  54  * @todo the cookie keyring needs to be cached globally not just
  55  * per-auth (which raises threadsafety issues too)
  56  *
  57  * @todo grep FIXME in dbus-auth.c
  58  */
  59
  60 /**
  61  * @defgroup DBusAuthInternals Authentication implementation details
  62  * @ingroup  DBusInternals
  63  * @brief DBusAuth implementation details
  64  *
  65  * Private details of authentication code.
  66  *
  67  * @{
  68  */
  69
  70 /**
  71  * Processes a command. Returns whether we had enough memory to
  72  * complete the operation.
  73  */
  74 typedef dbus_bool_t (* DBusProcessAuthCommandFunction) (DBusAuth         *auth,
  75                                                         const DBusString *command,
  76                                                         const DBusString *args);
  77
  78 typedef struct
  79 {
  80   const char *command;
  81   DBusProcessAuthCommandFunction func;
  82 } DBusAuthCommandHandler;
  83
  84 /**
  85  * This function appends an initial client response to the given string
  86  */
  87 typedef dbus_bool_t (* DBusInitialResponseFunction)  (DBusAuth         *auth,
  88                                                       DBusString       *response);
  89
  90 /**
  91  * This function processes a block of data received from the peer.
  92  * i.e. handles a DATA command.
  93  */
  94 typedef dbus_bool_t (* DBusAuthDataFunction)     (DBusAuth         *auth,
  95                                                   const DBusString *data);
  96
  97 /**
  98  * This function encodes a block of data from the peer.
  99  */
 100 typedef dbus_bool_t (* DBusAuthEncodeFunction)   (DBusAuth         *auth,
 101                                                   const DBusString *data,
 102                                                   DBusString       *encoded);
 103
 104 /**
 105  * This function decodes a block of data from the peer.
 106  */
 107 typedef dbus_bool_t (* DBusAuthDecodeFunction)   (DBusAuth         *auth,
 108                                                   const DBusString *data,
 109                                                   DBusString       *decoded);
 110
 111 /**
 112  * This function is called when the mechanism is abandoned.
 113  */
 114 typedef void        (* DBusAuthShutdownFunction) (DBusAuth       *auth);
 115
 116 typedef struct
 117 {
 118   const char *mechanism;
 119   DBusAuthDataFunction server_data_func;
 120   DBusAuthEncodeFunction server_encode_func;
 121   DBusAuthDecodeFunction server_decode_func;
 122   DBusAuthShutdownFunction server_shutdown_func;
 123   DBusInitialResponseFunction client_initial_response_func;
 124   DBusAuthDataFunction client_data_func;
 125   DBusAuthEncodeFunction client_encode_func;
 126   DBusAuthDecodeFunction client_decode_func;
 127   DBusAuthShutdownFunction client_shutdown_func;
 128 } DBusAuthMechanismHandler;
 129
 130 /**
 131  * Internal members of DBusAuth.
 132  */
 133 struct DBusAuth
 134 {
 135   int refcount;           /**< reference count */
 136
 137   DBusString incoming;    /**< Incoming data buffer */
 138   DBusString outgoing;    /**< Outgoing data buffer */
 139
 140   const DBusAuthCommandHandler *handlers; /**< Handlers for commands */
 141
 142   const DBusAuthMechanismHandler *mech;   /**< Current auth mechanism */
 143
 144   DBusString identity;                   /**< Current identity we're authorizing
 145                                           *   as.
 146                                           */
 147
 148   DBusCredentials credentials;      /**< Credentials read from socket,
 149                                      * fields may be -1
 150                                      */
 151
 152   DBusCredentials authorized_identity; /**< Credentials that are authorized */
 153
 154   DBusCredentials desired_identity;    /**< Identity client has requested */
 155
 156   DBusString context;               /**< Cookie scope */
 157   DBusKeyring *keyring;             /**< Keyring for cookie mechanism. */
 158   int cookie_id;                    /**< ID of cookie to use */
 159   DBusString challenge;             /**< Challenge sent to client */
 160
 161   char **allowed_mechs;             /**< Mechanisms we're allowed to use,
 162                                      * or #NULL if we can use any
 163                                      */
 164
 165   unsigned int needed_memory : 1;   /**< We needed memory to continue since last
 166                                      * successful getting something done
 167                                      */
 168   unsigned int need_disconnect : 1; /**< We've given up, time to disconnect */
 169   unsigned int authenticated : 1;   /**< We are authenticated */
 170   unsigned int authenticated_pending_output : 1; /**< Authenticated once we clear outgoing buffer */
 171   unsigned int authenticated_pending_begin : 1;  /**< Authenticated once we get BEGIN */
 172   unsigned int already_got_mechanisms : 1;       /**< Client already got mech list */
 173   unsigned int already_asked_for_initial_response : 1; /**< Already sent a blank challenge to get an initial response */
 174   unsigned int buffer_outstanding : 1; /**< Buffer is "checked out" for reading data into */
 175 };
 176
 177 typedef struct
 178 {
 179   DBusAuth base;
 180
 181   DBusList *mechs_to_try; /**< Mechanisms we got from the server that we're going to try using */
 182
 183 } DBusAuthClient;
 184
 185 typedef struct
 186 {
 187   DBusAuth base;
 188
 189   int failures;     /**< Number of times client has been rejected */
 190   int max_failures; /**< Number of times we reject before disconnect */
 191
 192 } DBusAuthServer;
 193
 194 static dbus_bool_t process_auth         (DBusAuth         *auth,
 195                                          const DBusString *command,
 196                                          const DBusString *args);
 197 static dbus_bool_t process_cancel       (DBusAuth         *auth,
 198                                          const DBusString *command,
 199                                          const DBusString *args);
 200 static dbus_bool_t process_begin        (DBusAuth         *auth,
 201                                          const DBusString *command,
 202                                          const DBusString *args);
 203 static dbus_bool_t process_data_server  (DBusAuth         *auth,
 204                                          const DBusString *command,
 205                                          const DBusString *args);
 206 static dbus_bool_t process_error_server (DBusAuth         *auth,
 207                                          const DBusString *command,
 208                                          const DBusString *args);
 209 static dbus_bool_t process_rejected     (DBusAuth         *auth,
 210                                          const DBusString *command,
 211                                          const DBusString *args);
 212 static dbus_bool_t process_ok           (DBusAuth         *auth,
 213                                          const DBusString *command,
 214                                          const DBusString *args);
 215 static dbus_bool_t process_data_client  (DBusAuth         *auth,
 216                                          const DBusString *command,
 217                                          const DBusString *args);
 218 static dbus_bool_t process_error_client (DBusAuth         *auth,
 219                                          const DBusString *command,
 220                                          const DBusString *args);
 221
 222
 223 static dbus_bool_t client_try_next_mechanism (DBusAuth *auth);
 224 static dbus_bool_t send_rejected             (DBusAuth *auth);
 225
 226 static DBusAuthCommandHandler
 227 server_handlers[] = {
 228   { "AUTH", process_auth },
 229   { "CANCEL", process_cancel },
 230   { "BEGIN", process_begin },
 231   { "DATA", process_data_server },
 232   { "ERROR", process_error_server },
 233   { NULL, NULL }
 234 };
 235
 236 static DBusAuthCommandHandler
 237 client_handlers[] = {
 238   { "REJECTED", process_rejected },
 239   { "OK", process_ok },
 240   { "DATA", process_data_client },
 241   { "ERROR", process_error_client },
 242   { NULL, NULL }
 243 };
 244
 245 /**
 246  * @param auth the auth conversation
 247  * @returns #TRUE if the conversation is the server side
 248  */
 249 #define DBUS_AUTH_IS_SERVER(auth) ((auth)->handlers == server_handlers)
 250 /**
 251  * @param auth the auth conversation
 252  * @returns #TRUE if the conversation is the client side
 253  */
 254 #define DBUS_AUTH_IS_CLIENT(auth) ((auth)->handlers == client_handlers)
 255 /**
 256  * @param auth the auth conversation
 257  * @returns auth cast to DBusAuthClient
 258  */
 259 #define DBUS_AUTH_CLIENT(auth)    ((DBusAuthClient*)(auth))
 260 /**
 261  * @param auth the auth conversation
 262  * @returns auth cast to DBusAuthServer
 263  */
 264 #define DBUS_AUTH_SERVER(auth)    ((DBusAuthServer*)(auth))
 265
 266 /**
 267  * The name of the auth ("client" or "server")
 268  * @param auth the auth conversation
 269  * @returns a string
 270  */
 271 #define DBUS_AUTH_NAME(auth)      (DBUS_AUTH_IS_SERVER(auth) ? "server" : "client")
 272
 273 static DBusAuth*
 274 _dbus_auth_new (int size)
 275 {
 276   DBusAuth *auth;
 277
 278   auth = dbus_malloc0 (size);
 279   if (auth == NULL)
 280     return NULL;
 281
 282   auth->refcount = 1;
 283
 284   _dbus_credentials_clear (&auth->credentials);
 285   _dbus_credentials_clear (&auth->authorized_identity);
 286   _dbus_credentials_clear (&auth->desired_identity);
 287
 288   auth->keyring = NULL;
 289   auth->cookie_id = -1;
 290
 291   /* note that we don't use the max string length feature,
 292    * because you can't use that feature if you're going to
 293    * try to recover from out-of-memory (it creates
 294    * what looks like unrecoverable inability to alloc
 295    * more space in the string). But we do handle
 296    * overlong buffers in _dbus_auth_do_work().
 297    */
 298
 299   if (!_dbus_string_init (&auth->incoming))
 300     goto enomem_0;
 301
 302   if (!_dbus_string_init (&auth->outgoing))
 303     goto enomem_1;
 304
 305   if (!_dbus_string_init (&auth->identity))
 306     goto enomem_2;
 307
 308   if (!_dbus_string_init (&auth->context))
 309     goto enomem_3;
 310
 311   if (!_dbus_string_init (&auth->challenge))
 312     goto enomem_4;
 313
 314   /* default context if none is specified */
 315   if (!_dbus_string_append (&auth->context, "org_freedesktop_general"))
 316     goto enomem_5;
 317
 318   return auth;
 319
 320  enomem_5:
 321   _dbus_string_free (&auth->challenge);
 322  enomem_4:
 323   _dbus_string_free (&auth->context);
 324  enomem_3:
 325   _dbus_string_free (&auth->identity);
 326  enomem_2:
 327   _dbus_string_free (&auth->outgoing);
 328  enomem_1:
 329   _dbus_string_free (&auth->incoming);
 330  enomem_0:
 331   dbus_free (auth);
 332   return NULL;
 333 }
 334
 335 static void
 336 shutdown_mech (DBusAuth *auth)
 337 {
 338   /* Cancel any auth */
 339   auth->authenticated_pending_begin = FALSE;
 340   auth->authenticated = FALSE;
 341   auth->already_asked_for_initial_response = FALSE;
 342   _dbus_string_set_length (&auth->identity, 0);
 343
 344   _dbus_credentials_clear (&auth->authorized_identity);
 345   _dbus_credentials_clear (&auth->desired_identity);
 346
 347   if (auth->mech != NULL)
 348     {
 349       _dbus_verbose ("%s: Shutting down mechanism %s\n",
 350                      DBUS_AUTH_NAME (auth), auth->mech->mechanism);
 351
 352       if (DBUS_AUTH_IS_CLIENT (auth))
 353         (* auth->mech->client_shutdown_func) (auth);
 354       else
 355         (* auth->mech->server_shutdown_func) (auth);
 356
 357       auth->mech = NULL;
 358     }
 359 }
 360
 361 /* Returns TRUE but with an empty string hash if the
 362  * cookie_id isn't known. As with all this code
 363  * TRUE just means we had enough memory.
 364  */
 365 static dbus_bool_t
 366 sha1_compute_hash (DBusAuth         *auth,
 367                    int               cookie_id,
 368                    const DBusString *server_challenge,
 369                    const DBusString *client_challenge,
 370                    DBusString       *hash)
 371 {
 372   DBusString cookie;
 373   DBusString to_hash;
 374   dbus_bool_t retval;
 375
 376   _dbus_assert (auth->keyring != NULL);
 377
 378   retval = FALSE;
 379
 380   if (!_dbus_string_init (&cookie))
 381     return FALSE;
 382
 383   if (!_dbus_keyring_get_hex_key (auth->keyring, cookie_id,
 384                                   &cookie))
 385     goto out_0;
 386
 387   if (_dbus_string_get_length (&cookie) == 0)
 388     {
 389       retval = TRUE;
 390       goto out_0;
 391     }
 392
 393   if (!_dbus_string_init (&to_hash))
 394     goto out_0;
 395
 396   if (!_dbus_string_copy (server_challenge, 0,
 397                           &to_hash, _dbus_string_get_length (&to_hash)))
 398     goto out_1;
 399
 400   if (!_dbus_string_append (&to_hash, ":"))
 401     goto out_1;
 402
 403   if (!_dbus_string_copy (client_challenge, 0,
 404                           &to_hash, _dbus_string_get_length (&to_hash)))
 405     goto out_1;
 406
 407   if (!_dbus_string_append (&to_hash, ":"))
 408     goto out_1;
 409
 410   if (!_dbus_string_copy (&cookie, 0,
 411                           &to_hash, _dbus_string_get_length (&to_hash)))
 412     goto out_1;
 413
 414   if (!_dbus_sha_compute (&to_hash, hash))
 415     goto out_1;
 416
 417   retval = TRUE;
 418
 419  out_1:
 420   _dbus_string_zero (&to_hash);
 421   _dbus_string_free (&to_hash);
 422  out_0:
 423   _dbus_string_zero (&cookie);
 424   _dbus_string_free (&cookie);
 425   return retval;
 426 }
 427
 428 /** http://www.ietf.org/rfc/rfc2831.txt suggests at least 64 bits of
 429  * entropy, we use 128. This is the number of bytes in the random
 430  * challenge.
 431  */
 432 #define N_CHALLENGE_BYTES (128/8)
 433
 434 static dbus_bool_t
 435 sha1_handle_first_client_response (DBusAuth         *auth,
 436                                    const DBusString *data)
 437 {
 438   /* We haven't sent a challenge yet, we're expecting a desired
 439    * username from the client.
 440    */
 441   DBusString tmp;
 442   DBusString tmp2;
 443   dbus_bool_t retval;
 444   int old_len;
 445   DBusError error;
 446
 447   retval = FALSE;
 448
 449   _dbus_string_set_length (&auth->challenge, 0);
 450
 451   if (_dbus_string_get_length (data) > 0)
 452     {
 453       if (_dbus_string_get_length (&auth->identity) > 0)
 454         {
 455           /* Tried to send two auth identities, wtf */
 456           _dbus_verbose ("%s: client tried to send auth identity, but we already have one\n",
 457                          DBUS_AUTH_NAME (auth));
 458           return send_rejected (auth);
 459         }
 460       else
 461         {
 462           /* this is our auth identity */
 463           if (!_dbus_string_copy (data, 0, &auth->identity, 0))
 464             return FALSE;
 465         }
 466     }
 467
 468   if (!_dbus_credentials_from_username (data, &auth->desired_identity))
 469     {
 470       _dbus_verbose ("%s: Did not get a valid username from client\n",
 471                      DBUS_AUTH_NAME (auth));
 472       return send_rejected (auth);
 473     }
 474
 475   if (!_dbus_string_init (&tmp))
 476     return FALSE;
 477
 478   if (!_dbus_string_init (&tmp2))
 479     {
 480       _dbus_string_free (&tmp);
 481       return FALSE;
 482     }
 483
 484   old_len = _dbus_string_get_length (&auth->outgoing);
 485
 486   /* we cache the keyring for speed, so here we drop it if it's the
 487    * wrong one. FIXME caching the keyring here is useless since we use
 488    * a different DBusAuth for every connection.
 489    */
 490   if (auth->keyring &&
 491       !_dbus_keyring_is_for_user (auth->keyring,
 492                                   data))
 493     {
 494       _dbus_keyring_unref (auth->keyring);
 495       auth->keyring = NULL;
 496     }
 497
 498   if (auth->keyring == NULL)
 499     {
 500       DBusError error;
 501
 502       dbus_error_init (&error);
 503       auth->keyring = _dbus_keyring_new_homedir (data,
 504                                                  &auth->context,
 505                                                  &error);
 506
 507       if (auth->keyring == NULL)
 508         {
 509           if (dbus_error_has_name (&error,
 510                                    DBUS_ERROR_NO_MEMORY))
 511             {
 512               dbus_error_free (&error);
 513               goto out;
 514             }
 515           else
 516             {
 517               _DBUS_ASSERT_ERROR_IS_SET (&error);
 518               _dbus_verbose ("%s: Error loading keyring: %s\n",
 519                              DBUS_AUTH_NAME (auth), error.message);
 520               if (send_rejected (auth))
 521                 retval = TRUE; /* retval is only about mem */
 522               dbus_error_free (&error);
 523               goto out;
 524             }
 525         }
 526       else
 527         {
 528           _dbus_assert (!dbus_error_is_set (&error));
 529         }
 530     }
 531
 532   _dbus_assert (auth->keyring != NULL);
 533
 534   dbus_error_init (&error);
 535   auth->cookie_id = _dbus_keyring_get_best_key (auth->keyring, &error);
 536   if (auth->cookie_id < 0)
 537     {
 538       _DBUS_ASSERT_ERROR_IS_SET (&error);
 539       _dbus_verbose ("%s: Could not get a cookie ID to send to client: %s\n",
 540                      DBUS_AUTH_NAME (auth), error.message);
 541       if (send_rejected (auth))
 542         retval = TRUE;
 543       dbus_error_free (&error);
 544       goto out;
 545     }
 546   else
 547     {
 548       _dbus_assert (!dbus_error_is_set (&error));
 549     }
 550
 551   if (!_dbus_string_copy (&auth->context, 0,
 552                           &tmp2, _dbus_string_get_length (&tmp2)))
 553     goto out;
 554
 555   if (!_dbus_string_append (&tmp2, " "))
 556     goto out;
 557
 558   if (!_dbus_string_append_int (&tmp2, auth->cookie_id))
 559     goto out;
 560
 561   if (!_dbus_string_append (&tmp2, " "))
 562     goto out;
 563
 564   if (!_dbus_generate_random_bytes (&tmp, N_CHALLENGE_BYTES))
 565     goto out;
 566
 567   _dbus_string_set_length (&auth->challenge, 0);
 568   if (!_dbus_string_hex_encode (&tmp, 0, &auth->challenge, 0))
 569     goto out;
 570
 571   if (!_dbus_string_hex_encode (&tmp, 0, &tmp2,
 572                                 _dbus_string_get_length (&tmp2)))
 573     goto out;
 574
 575   if (!_dbus_string_append (&auth->outgoing,
 576                             "DATA "))
 577     goto out;
 578
 579   if (!_dbus_string_base64_encode (&tmp2, 0, &auth->outgoing,
 580                                    _dbus_string_get_length (&auth->outgoing)))
 581     goto out;
 582
 583   if (!_dbus_string_append (&auth->outgoing,
 584                             "\r\n"))
 585     goto out;
 586
 587   retval = TRUE;
 588
 589  out:
 590   _dbus_string_zero (&tmp);
 591   _dbus_string_free (&tmp);
 592   _dbus_string_zero (&tmp2);
 593   _dbus_string_free (&tmp2);
 594   if (!retval)
 595     _dbus_string_set_length (&auth->outgoing, old_len);
 596   return retval;
 597 }
 598
 599 static dbus_bool_t
 600 sha1_handle_second_client_response (DBusAuth         *auth,
 601                                     const DBusString *data)
 602 {
 603   /* We are expecting a response which is the hex-encoded client
 604    * challenge, space, then SHA-1 hash of the concatenation of our
 605    * challenge, ":", client challenge, ":", secret key, all
 606    * hex-encoded.
 607    */
 608   int i;
 609   DBusString client_challenge;
 610   DBusString client_hash;
 611   dbus_bool_t retval;
 612   DBusString correct_hash;
 613
 614   retval = FALSE;
 615
 616   if (!_dbus_string_find_blank (data, 0, &i))
 617     {
 618       _dbus_verbose ("%s: no space separator in client response\n",
 619                      DBUS_AUTH_NAME (auth));
 620       return send_rejected (auth);
 621     }
 622
 623   if (!_dbus_string_init (&client_challenge))
 624     goto out_0;
 625
 626   if (!_dbus_string_init (&client_hash))
 627     goto out_1;
 628
 629   if (!_dbus_string_copy_len (data, 0, i, &client_challenge,
 630                               0))
 631     goto out_2;
 632
 633   _dbus_string_skip_blank (data, i, &i);
 634
 635   if (!_dbus_string_copy_len (data, i,
 636                               _dbus_string_get_length (data) - i,
 637                               &client_hash,
 638                               0))
 639     goto out_2;
 640
 641   if (_dbus_string_get_length (&client_challenge) == 0 ||
 642       _dbus_string_get_length (&client_hash) == 0)
 643     {
 644       _dbus_verbose ("%s: zero-length client challenge or hash\n",
 645                      DBUS_AUTH_NAME (auth));
 646       if (send_rejected (auth))
 647         retval = TRUE;
 648       goto out_2;
 649     }
 650
 651   if (!_dbus_string_init (&correct_hash))
 652     goto out_2;
 653
 654   if (!sha1_compute_hash (auth, auth->cookie_id,
 655                           &auth->challenge,
 656                           &client_challenge,
 657                           &correct_hash))
 658     goto out_3;
 659
 660   /* if cookie_id was invalid, then we get an empty hash */
 661   if (_dbus_string_get_length (&correct_hash) == 0)
 662     {
 663       if (send_rejected (auth))
 664         retval = TRUE;
 665       goto out_3;
 666     }
 667
 668   if (!_dbus_string_equal (&client_hash, &correct_hash))
 669     {
 670       if (send_rejected (auth))
 671         retval = TRUE;
 672       goto out_3;
 673     }
 674
 675   if (!_dbus_string_append (&auth->outgoing,
 676                             "OK\r\n"))
 677     goto out_3;
 678
 679   _dbus_verbose ("%s: authenticated client with UID "DBUS_UID_FORMAT" using DBUS_COOKIE_SHA1\n",
 680                  DBUS_AUTH_NAME (auth), auth->desired_identity.uid);
 681
 682   auth->authorized_identity = auth->desired_identity;
 683   auth->authenticated_pending_begin = TRUE;
 684   retval = TRUE;
 685
 686  out_3:
 687   _dbus_string_zero (&correct_hash);
 688   _dbus_string_free (&correct_hash);
 689  out_2:
 690   _dbus_string_zero (&client_hash);
 691   _dbus_string_free (&client_hash);
 692  out_1:
 693   _dbus_string_free (&client_challenge);
 694  out_0:
 695   return retval;
 696 }
 697
 698 static dbus_bool_t
 699 handle_server_data_cookie_sha1_mech (DBusAuth         *auth,
 700                                      const DBusString *data)
 701 {
 702   if (auth->cookie_id < 0)
 703     return sha1_handle_first_client_response (auth, data);
 704   else
 705     return sha1_handle_second_client_response (auth, data);
 706 }
 707
 708 static void
 709 handle_server_shutdown_cookie_sha1_mech (DBusAuth *auth)
 710 {
 711   auth->cookie_id = -1;
 712   _dbus_string_set_length (&auth->challenge, 0);
 713 }
 714
 715 static dbus_bool_t
 716 handle_client_initial_response_cookie_sha1_mech (DBusAuth   *auth,
 717                                                  DBusString *response)
 718 {
 719   const DBusString *username;
 720   dbus_bool_t retval;
 721
 722   retval = FALSE;
 723
 724   if (!_dbus_username_from_current_process (&username))
 725     goto out_0;
 726
 727   if (!_dbus_string_base64_encode (username, 0,
 728                                    response,
 729                                    _dbus_string_get_length (response)))
 730     goto out_0;
 731
 732   retval = TRUE;
 733
 734  out_0:
 735   return retval;
 736 }
 737
 738 static dbus_bool_t
 739 handle_client_data_cookie_sha1_mech (DBusAuth         *auth,
 740                                      const DBusString *data)
 741 {
 742   /* The data we get from the server should be the cookie context
 743    * name, the cookie ID, and the server challenge, separated by
 744    * spaces. We send back our challenge string and the correct hash.
 745    */
 746   dbus_bool_t retval;
 747   DBusString context;
 748   DBusString cookie_id_str;
 749   DBusString server_challenge;
 750   DBusString client_challenge;
 751   DBusString correct_hash;
 752   DBusString tmp;
 753   int i, j;
 754   long val;
 755   int old_len;
 756
 757   retval = FALSE;
 758
 759   if (!_dbus_string_find_blank (data, 0, &i))
 760     {
 761       if (_dbus_string_append (&auth->outgoing,
 762                                "ERROR \"Server did not send context/ID/challenge properly\"\r\n"))
 763         retval = TRUE;
 764       goto out_0;
 765     }
 766
 767   if (!_dbus_string_init (&context))
 768     goto out_0;
 769
 770   if (!_dbus_string_copy_len (data, 0, i,
 771                               &context, 0))
 772     goto out_1;
 773
 774   _dbus_string_skip_blank (data, i, &i);
 775   if (!_dbus_string_find_blank (data, i, &j))
 776     {
 777       if (_dbus_string_append (&auth->outgoing,
 778                                "ERROR \"Server did not send context/ID/challenge properly\"\r\n"))
 779         retval = TRUE;
 780       goto out_1;
 781     }
 782
 783   if (!_dbus_string_init (&cookie_id_str))
 784     goto out_1;
 785
 786   if (!_dbus_string_copy_len (data, i, j - i,
 787                               &cookie_id_str, 0))
 788     goto out_2;
 789
 790   if (!_dbus_string_init (&server_challenge))
 791     goto out_2;
 792
 793   i = j;
 794   _dbus_string_skip_blank (data, i, &i);
 795   j = _dbus_string_get_length (data);
 796
 797   if (!_dbus_string_copy_len (data, i, j - i,
 798                               &server_challenge, 0))
 799     goto out_3;
 800
 801   if (!_dbus_keyring_validate_context (&context))
 802     {
 803       if (_dbus_string_append (&auth->outgoing,
 804                                "ERROR \"Server sent invalid cookie context\"\r\n"))
 805         retval = TRUE;
 806       goto out_3;
 807     }
 808
 809   if (!_dbus_string_parse_int (&cookie_id_str, 0, &val, NULL))
 810     {
 811       if (_dbus_string_append (&auth->outgoing,
 812                                "ERROR \"Could not parse cookie ID as an integer\"\r\n"))
 813         retval = TRUE;
 814       goto out_3;
 815     }
 816
 817   if (_dbus_string_get_length (&server_challenge) == 0)
 818     {
 819       if (_dbus_string_append (&auth->outgoing,
 820                                "ERROR \"Empty server challenge string\"\r\n"))
 821         retval = TRUE;
 822       goto out_3;
 823     }
 824
 825   if (auth->keyring == NULL)
 826     {
 827       DBusError error;
 828
 829       dbus_error_init (&error);
 830       auth->keyring = _dbus_keyring_new_homedir (NULL,
 831                                                  &context,
 832                                                  &error);
 833
 834       if (auth->keyring == NULL)
 835         {
 836           if (dbus_error_has_name (&error,
 837                                    DBUS_ERROR_NO_MEMORY))
 838             {
 839               dbus_error_free (&error);
 840               goto out_3;
 841             }
 842           else
 843             {
 844               _DBUS_ASSERT_ERROR_IS_SET (&error);
 845
 846               _dbus_verbose ("%s: Error loading keyring: %s\n",
 847                              DBUS_AUTH_NAME (auth), error.message);
 848
 849               if (_dbus_string_append (&auth->outgoing,
 850                                        "ERROR \"Could not load cookie file\"\r\n"))
 851                 retval = TRUE; /* retval is only about mem */
 852
 853               dbus_error_free (&error);
 854               goto out_3;
 855             }
 856         }
 857       else
 858         {
 859           _dbus_assert (!dbus_error_is_set (&error));
 860         }
 861     }
 862
 863   _dbus_assert (auth->keyring != NULL);
 864
 865   if (!_dbus_string_init (&tmp))
 866     goto out_3;
 867
 868   if (!_dbus_generate_random_bytes (&tmp, N_CHALLENGE_BYTES))
 869     goto out_4;
 870
 871   if (!_dbus_string_init (&client_challenge))
 872     goto out_4;
 873
 874   if (!_dbus_string_hex_encode (&tmp, 0, &client_challenge, 0))
 875     goto out_5;
 876
 877   if (!_dbus_string_init (&correct_hash))
 878     goto out_5;
 879
 880   if (!sha1_compute_hash (auth, val,
 881                           &server_challenge,
 882                           &client_challenge,
 883                           &correct_hash))
 884     goto out_6;
 885
 886   if (_dbus_string_get_length (&correct_hash) == 0)
 887     {
 888       /* couldn't find the cookie ID or something */
 889       if (_dbus_string_append (&auth->outgoing,
 890                                "ERROR \"Don't have the requested cookie ID\"\r\n"))
 891         retval = TRUE;
 892       goto out_6;
 893     }
 894
 895   _dbus_string_set_length (&tmp, 0);
 896
 897   if (!_dbus_string_copy (&client_challenge, 0, &tmp,
 898                           _dbus_string_get_length (&tmp)))
 899     goto out_6;
 900
 901   if (!_dbus_string_append (&tmp, " "))
 902     goto out_6;
 903
 904   if (!_dbus_string_copy (&correct_hash, 0, &tmp,
 905                           _dbus_string_get_length (&tmp)))
 906     goto out_6;
 907
 908   old_len = _dbus_string_get_length (&auth->outgoing);
 909   if (!_dbus_string_append (&auth->outgoing, "DATA "))
 910     goto out_6;
 911
 912   if (!_dbus_string_base64_encode (&tmp, 0,
 913                                    &auth->outgoing,
 914                                    _dbus_string_get_length (&auth->outgoing)))
 915     {
 916       _dbus_string_set_length (&auth->outgoing, old_len);
 917       goto out_6;
 918     }
 919
 920   if (!_dbus_string_append (&auth->outgoing, "\r\n"))
 921     {
 922       _dbus_string_set_length (&auth->outgoing, old_len);
 923       goto out_6;
 924     }
 925
 926   retval = TRUE;
 927
 928  out_6:
 929   _dbus_string_zero (&correct_hash);
 930   _dbus_string_free (&correct_hash);
 931  out_5:
 932   _dbus_string_free (&client_challenge);
 933  out_4:
 934   _dbus_string_zero (&tmp);
 935   _dbus_string_free (&tmp);
 936  out_3:
 937   _dbus_string_free (&server_challenge);
 938  out_2:
 939   _dbus_string_free (&cookie_id_str);
 940  out_1:
 941   _dbus_string_free (&context);
 942  out_0:
 943   return retval;
 944 }
 945
 946 static void
 947 handle_client_shutdown_cookie_sha1_mech (DBusAuth *auth)
 948 {
 949   auth->cookie_id = -1;
 950   _dbus_string_set_length (&auth->challenge, 0);
 951 }
 952
 953 static dbus_bool_t
 954 handle_server_data_external_mech (DBusAuth         *auth,
 955                                   const DBusString *data)
 956 {
 957   if (auth->credentials.uid == DBUS_UID_UNSET)
 958     {
 959       _dbus_verbose ("%s: no credentials, mechanism EXTERNAL can't authenticate\n",
 960                      DBUS_AUTH_NAME (auth));
 961       return send_rejected (auth);
 962     }
 963
 964   if (_dbus_string_get_length (data) > 0)
 965     {
 966       if (_dbus_string_get_length (&auth->identity) > 0)
 967         {
 968           /* Tried to send two auth identities, wtf */
 969           _dbus_verbose ("%s: client tried to send auth identity, but we already have one\n",
 970                          DBUS_AUTH_NAME (auth));
 971           return send_rejected (auth);
 972         }
 973       else
 974         {
 975           /* this is our auth identity */
 976           if (!_dbus_string_copy (data, 0, &auth->identity, 0))
 977             return FALSE;
 978         }
 979     }
 980
 981   /* Poke client for an auth identity, if none given */
 982   if (_dbus_string_get_length (&auth->identity) == 0 &&
 983       !auth->already_asked_for_initial_response)
 984     {
 985       if (_dbus_string_append (&auth->outgoing,
 986                                "DATA\r\n"))
 987         {
 988           _dbus_verbose ("%s: sending empty challenge asking client for auth identity\n",
 989                          DBUS_AUTH_NAME (auth));
 990           auth->already_asked_for_initial_response = TRUE;
 991           return TRUE;
 992         }
 993       else
 994         return FALSE;
 995     }
 996
 997   _dbus_credentials_clear (&auth->desired_identity);
 998
 999   /* If auth->identity is still empty here, then client
1000    * responded with an empty string after we poked it for
1001    * an initial response. This means to try to auth the
1002    * identity provided in the credentials.
1003    */
1004   if (_dbus_string_get_length (&auth->identity) == 0)
1005     {
1006       auth->desired_identity.uid = auth->credentials.uid;
1007     }
1008   else
1009     {
1010       if (!_dbus_uid_from_string (&auth->identity,
1011                                   &auth->desired_identity.uid))
1012         {
1013           _dbus_verbose ("%s: could not get credentials from uid string\n",
1014                          DBUS_AUTH_NAME (auth));
1015           return send_rejected (auth);
1016         }
1017     }
1018
1019   if (auth->desired_identity.uid == DBUS_UID_UNSET)
1020     {
1021       _dbus_verbose ("%s: desired user %s is no good\n",
1022                      DBUS_AUTH_NAME (auth),
1023                      _dbus_string_get_const_data (&auth->identity));
1024       return send_rejected (auth);
1025     }
1026
1027   if (_dbus_credentials_match (&auth->desired_identity,
1028                                &auth->credentials))
1029     {
1030       /* client has authenticated */
1031       if (!_dbus_string_append (&auth->outgoing,
1032                                 "OK\r\n"))
1033         return FALSE;
1034
1035       _dbus_verbose ("%s: authenticated client with UID "DBUS_UID_FORMAT
1036                      " matching socket credentials UID "DBUS_UID_FORMAT"\n",
1037                      DBUS_AUTH_NAME (auth),
1038                      auth->desired_identity.uid,
1039                      auth->credentials.uid);
1040
1041       auth->authorized_identity.uid = auth->desired_identity.uid;
1042
1043       auth->authenticated_pending_begin = TRUE;
1044
1045       return TRUE;
1046     }
1047   else
1048     {
1049       _dbus_verbose ("%s: credentials uid="DBUS_UID_FORMAT
1050                      " gid="DBUS_GID_FORMAT
1051                      " do not allow uid="DBUS_UID_FORMAT
1052                      " gid="DBUS_GID_FORMAT"\n",
1053                      DBUS_AUTH_NAME (auth),
1054                      auth->credentials.uid, auth->credentials.gid,
1055                      auth->desired_identity.uid, auth->desired_identity.gid);
1056       return send_rejected (auth);
1057     }
1058 }
1059
1060 static void
1061 handle_server_shutdown_external_mech (DBusAuth *auth)
1062 {
1063
1064 }
1065
1066 static dbus_bool_t
1067 handle_client_initial_response_external_mech (DBusAuth         *auth,
1068                                               DBusString       *response)
1069 {
1070   /* We always append our UID as an initial response, so the server
1071    * doesn't have to send back an empty challenge to check whether we
1072    * want to specify an identity. i.e. this avoids a round trip that
1073    * the spec for the EXTERNAL mechanism otherwise requires.
1074    */
1075   DBusString plaintext;
1076
1077   if (!_dbus_string_init (&plaintext))
1078     return FALSE;
1079
1080   if (!_dbus_string_append_uint (&plaintext,
1081                                  _dbus_getuid ()))
1082     goto failed;
1083
1084   if (!_dbus_string_base64_encode (&plaintext, 0,
1085                                    response,
1086                                    _dbus_string_get_length (response)))
1087     goto failed;
1088
1089   _dbus_string_free (&plaintext);
1090
1091   return TRUE;
1092
1093  failed:
1094   _dbus_string_free (&plaintext);
1095   return FALSE;
1096 }
1097
1098 static dbus_bool_t
1099 handle_client_data_external_mech (DBusAuth         *auth,
1100                                   const DBusString *data)
1101 {
1102
1103   return TRUE;
1104 }
1105
1106 static void
1107 handle_client_shutdown_external_mech (DBusAuth *auth)
1108 {
1109
1110 }
1111
1112 /* Put mechanisms here in order of preference.
1113  * What I eventually want to have is:
1114  *
1115  *  - a mechanism that checks UNIX domain socket credentials
1116  *  - a simple magic cookie mechanism like X11 or ICE
1117  *  - mechanisms that chain to Cyrus SASL, so we can use anything it
1118  *    offers such as Kerberos, X509, whatever.
1119  *
1120  */
1121 static const DBusAuthMechanismHandler
1122 all_mechanisms[] = {
1123   { "EXTERNAL",
1124     handle_server_data_external_mech,
1125     NULL, NULL,
1126     handle_server_shutdown_external_mech,
1127     handle_client_initial_response_external_mech,
1128     handle_client_data_external_mech,
1129     NULL, NULL,
1130     handle_client_shutdown_external_mech },
1131   { "DBUS_COOKIE_SHA1",
1132     handle_server_data_cookie_sha1_mech,
1133     NULL, NULL,
1134     handle_server_shutdown_cookie_sha1_mech,
1135     handle_client_initial_response_cookie_sha1_mech,
1136     handle_client_data_cookie_sha1_mech,
1137     NULL, NULL,
1138     handle_client_shutdown_cookie_sha1_mech },
1139   { NULL, NULL }
1140 };
1141
1142 static const DBusAuthMechanismHandler*
1143 find_mech (const DBusString  *name,
1144            char             **allowed_mechs)
1145 {
1146   int i;
1147
1148   if (allowed_mechs != NULL &&
1149       !_dbus_string_array_contains ((const char**) allowed_mechs,
1150                                     _dbus_string_get_const_data (name)))
1151     return NULL;
1152
1153   i = 0;
1154   while (all_mechanisms[i].mechanism != NULL)
1155     {
1156       if (_dbus_string_equal_c_str (name,
1157                                     all_mechanisms[i].mechanism))
1158
1159         return &all_mechanisms[i];
1160
1161       ++i;
1162     }
1163
1164   return NULL;
1165 }
1166
1167 static dbus_bool_t
1168 send_rejected (DBusAuth *auth)
1169 {
1170   DBusString command;
1171   DBusAuthServer *server_auth;
1172   int i;
1173
1174   if (!_dbus_string_init (&command))
1175     return FALSE;
1176
1177   if (!_dbus_string_append (&command,
1178                             "REJECTED"))
1179     goto nomem;
1180
1181   i = 0;
1182   while (all_mechanisms[i].mechanism != NULL)
1183     {
1184       if (!_dbus_string_append (&command,
1185                                 " "))
1186         goto nomem;
1187
1188       if (!_dbus_string_append (&command,
1189                                 all_mechanisms[i].mechanism))
1190         goto nomem;
1191
1192       ++i;
1193     }
1194
1195   if (!_dbus_string_append (&command, "\r\n"))
1196     goto nomem;
1197
1198   if (!_dbus_string_copy (&command, 0, &auth->outgoing,
1199                           _dbus_string_get_length (&auth->outgoing)))
1200     goto nomem;
1201
1202   shutdown_mech (auth);
1203
1204   _dbus_assert (DBUS_AUTH_IS_SERVER (auth));
1205   server_auth = DBUS_AUTH_SERVER (auth);
1206   server_auth->failures += 1;
1207
1208   _dbus_string_free (&command);
1209
1210   return TRUE;
1211
1212  nomem:
1213   _dbus_string_free (&command);
1214   return FALSE;
1215 }
1216
1217 static dbus_bool_t
1218 process_auth (DBusAuth         *auth,
1219               const DBusString *command,
1220               const DBusString *args)
1221 {
1222   if (auth->mech)
1223     {
1224       /* We are already using a mechanism, client is on crack */
1225       if (!_dbus_string_append (&auth->outgoing,
1226                                 "ERROR \"Sent AUTH while another AUTH in progress\"\r\n"))
1227         return FALSE;
1228
1229       return TRUE;
1230     }
1231   else if (_dbus_string_get_length (args) == 0)
1232     {
1233       /* No args to the auth, send mechanisms */
1234       if (!send_rejected (auth))
1235         return FALSE;
1236
1237       return TRUE;
1238     }
1239   else
1240     {
1241       int i;
1242       DBusString mech;
1243       DBusString base64_response;
1244       DBusString decoded_response;
1245
1246       _dbus_string_find_blank (args, 0, &i);
1247
1248       if (!_dbus_string_init (&mech))
1249         return FALSE;
1250
1251       if (!_dbus_string_init (&base64_response))
1252         {
1253           _dbus_string_free (&mech);
1254           return FALSE;
1255         }
1256
1257       if (!_dbus_string_init (&decoded_response))
1258         {
1259           _dbus_string_free (&mech);
1260           _dbus_string_free (&base64_response);
1261           return FALSE;
1262         }
1263
1264       if (!_dbus_string_copy_len (args, 0, i, &mech, 0))
1265         goto failed;
1266
1267       if (!_dbus_string_copy (args, i, &base64_response, 0))
1268         goto failed;
1269
1270       if (!_dbus_string_base64_decode (&base64_response, 0,
1271                                        &decoded_response, 0))
1272         goto failed;
1273
1274       auth->mech = find_mech (&mech, auth->allowed_mechs);
1275       if (auth->mech != NULL)
1276         {
1277           _dbus_verbose ("%s: Trying mechanism %s with initial response of %d bytes\n",
1278                          DBUS_AUTH_NAME (auth),
1279                          auth->mech->mechanism,
1280                          _dbus_string_get_length (&decoded_response));
1281
1282           if (!(* auth->mech->server_data_func) (auth,
1283                                                  &decoded_response))
1284             goto failed;
1285         }
1286       else
1287         {
1288           /* Unsupported mechanism */
1289           if (!send_rejected (auth))
1290             goto failed;
1291         }
1292
1293       _dbus_string_free (&mech);
1294       _dbus_string_free (&base64_response);
1295       _dbus_string_free (&decoded_response);
1296
1297       return TRUE;
1298
1299     failed:
1300       auth->mech = NULL;
1301       _dbus_string_free (&mech);
1302       _dbus_string_free (&base64_response);
1303       _dbus_string_free (&decoded_response);
1304       return FALSE;
1305     }
1306 }
1307
1308 static dbus_bool_t
1309 process_cancel (DBusAuth         *auth,
1310                 const DBusString *command,
1311                 const DBusString *args)
1312 {
1313   if (!send_rejected (auth))
1314     return FALSE;
1315
1316   return TRUE;
1317 }
1318
1319 static dbus_bool_t
1320 process_begin (DBusAuth         *auth,
1321                const DBusString *command,
1322                const DBusString *args)
1323 {
1324   if (auth->authenticated_pending_begin)
1325     auth->authenticated = TRUE;
1326   else
1327     {
1328       auth->need_disconnect = TRUE; /* client trying to send data before auth,
1329                                      * kick it
1330                                      */
1331       shutdown_mech (auth);
1332     }
1333
1334   return TRUE;
1335 }
1336
1337 static dbus_bool_t
1338 process_data_server (DBusAuth         *auth,
1339                      const DBusString *command,
1340                      const DBusString *args)
1341 {
1342   if (auth->mech != NULL)
1343     {
1344       DBusString decoded;
1345
1346       if (!_dbus_string_init (&decoded))
1347         return FALSE;
1348
1349       if (!_dbus_string_base64_decode (args, 0, &decoded, 0))
1350         {
1351           _dbus_string_free (&decoded);
1352           return FALSE;
1353         }
1354
1355 #ifdef DBUS_ENABLE_VERBOSE_MODE
1356       if (_dbus_string_validate_ascii (&decoded, 0,
1357                                        _dbus_string_get_length (&decoded)))
1358         _dbus_verbose ("%s: data: '%s'\n",
1359                        DBUS_AUTH_NAME (auth),
1360                        _dbus_string_get_const_data (&decoded));
1361 #endif
1362
1363       if (!(* auth->mech->server_data_func) (auth, &decoded))
1364         {
1365           _dbus_string_free (&decoded);
1366           return FALSE;
1367         }
1368
1369       _dbus_string_free (&decoded);
1370     }
1371   else
1372     {
1373       if (!_dbus_string_append (&auth->outgoing,
1374                                 "ERROR \"Not currently in an auth conversation\"\r\n"))
1375         return FALSE;
1376     }
1377
1378   return TRUE;
1379 }
1380
1381 static dbus_bool_t
1382 process_error_server (DBusAuth         *auth,
1383                       const DBusString *command,
1384                       const DBusString *args)
1385 {
1386   /* Server got error from client, reject the auth,
1387    * as we don't have anything more intelligent to do.
1388    */
1389   if (!send_rejected (auth))
1390     return FALSE;
1391
1392   return TRUE;
1393 }
1394
1395 /* return FALSE if no memory, TRUE if all OK */
1396 static dbus_bool_t
1397 get_word (const DBusString *str,
1398           int              *start,
1399           DBusString       *word)
1400 {
1401   int i;
1402
1403   _dbus_string_skip_blank (str, *start, start);
1404   _dbus_string_find_blank (str, *start, &i);
1405
1406   if (i > *start)
1407     {
1408       if (!_dbus_string_copy_len (str, *start, i - *start, word, 0))
1409         return FALSE;
1410
1411       *start = i;
1412     }
1413
1414   return TRUE;
1415 }
1416
1417 static dbus_bool_t
1418 record_mechanisms (DBusAuth         *auth,
1419                    const DBusString *command,
1420                    const DBusString *args)
1421 {
1422   int next;
1423   int len;
1424
1425   if (auth->already_got_mechanisms)
1426     return TRUE;
1427
1428   len = _dbus_string_get_length (args);
1429
1430   next = 0;
1431   while (next < len)
1432     {
1433       DBusString m;
1434       const DBusAuthMechanismHandler *mech;
1435
1436       if (!_dbus_string_init (&m))
1437         goto nomem;
1438
1439       if (!get_word (args, &next, &m))
1440         {
1441           _dbus_string_free (&m);
1442           goto nomem;
1443         }
1444
1445       mech = find_mech (&m, auth->allowed_mechs);
1446
1447       if (mech != NULL)
1448         {
1449           /* FIXME right now we try mechanisms in the order
1450            * the server lists them; should we do them in
1451            * some more deterministic order?
1452            *
1453            * Probably in all_mechanisms order, our order of
1454            * preference. Of course when the server is us,
1455            * it lists things in that order anyhow.
1456            */
1457
1458           _dbus_verbose ("%s: Adding mechanism %s to list we will try\n",
1459                          DBUS_AUTH_NAME (auth), mech->mechanism);
1460
1461           if (!_dbus_list_append (& DBUS_AUTH_CLIENT (auth)->mechs_to_try,
1462                                   (void*) mech))
1463             {
1464               _dbus_string_free (&m);
1465               goto nomem;
1466             }
1467         }
1468       else
1469         {
1470           _dbus_verbose ("%s: Server offered mechanism \"%s\" that we don't know how to use\n",
1471                          DBUS_AUTH_NAME (auth),
1472                          _dbus_string_get_const_data (&m));
1473         }
1474
1475       _dbus_string_free (&m);
1476     }
1477
1478   auth->already_got_mechanisms = TRUE;
1479
1480   return TRUE;
1481
1482  nomem:
1483   _dbus_list_clear (& DBUS_AUTH_CLIENT (auth)->mechs_to_try);
1484
1485   return FALSE;
1486 }
1487
1488 static dbus_bool_t
1489 client_try_next_mechanism (DBusAuth *auth)
1490 {
1491   const DBusAuthMechanismHandler *mech;
1492   DBusString auth_command;
1493   DBusAuthClient *client;
1494
1495   client = DBUS_AUTH_CLIENT (auth);
1496
1497   /* Pop any mechs not in the list of allowed mechanisms */
1498   mech = NULL;
1499   while (client->mechs_to_try != NULL)
1500     {
1501       mech = client->mechs_to_try->data;
1502
1503       if (auth->allowed_mechs != NULL &&
1504           !_dbus_string_array_contains ((const char**) auth->allowed_mechs,
1505                                         mech->mechanism))
1506         {
1507           /* don't try this one after all */
1508           _dbus_verbose ("%s: Mechanism %s isn't in the list of allowed mechanisms\n",
1509                          DBUS_AUTH_NAME (auth), mech->mechanism);
1510           mech = NULL;
1511           _dbus_list_pop_first (& client->mechs_to_try);
1512         }
1513       else
1514         break; /* we'll try this one */
1515     }
1516
1517   if (mech == NULL)
1518     return FALSE;
1519
1520   if (!_dbus_string_init (&auth_command))
1521     return FALSE;
1522
1523   if (!_dbus_string_append (&auth_command,
1524                             "AUTH "))
1525     {
1526       _dbus_string_free (&auth_command);
1527       return FALSE;
1528     }
1529
1530   if (!_dbus_string_append (&auth_command,
1531                             mech->mechanism))
1532     {
1533       _dbus_string_free (&auth_command);
1534       return FALSE;
1535     }
1536
1537   if (mech->client_initial_response_func != NULL)
1538     {
1539       if (!_dbus_string_append (&auth_command, " "))
1540         {
1541           _dbus_string_free (&auth_command);
1542           return FALSE;
1543         }
1544
1545       if (!(* mech->client_initial_response_func) (auth, &auth_command))
1546         {
1547           _dbus_string_free (&auth_command);
1548           return FALSE;
1549         }
1550     }
1551
1552   if (!_dbus_string_append (&auth_command,
1553                             "\r\n"))
1554     {
1555       _dbus_string_free (&auth_command);
1556       return FALSE;
1557     }
1558
1559   if (!_dbus_string_copy (&auth_command, 0,
1560                           &auth->outgoing,
1561                           _dbus_string_get_length (&auth->outgoing)))
1562     {
1563       _dbus_string_free (&auth_command);
1564       return FALSE;
1565     }
1566
1567   auth->mech = mech;
1568   _dbus_list_pop_first (& DBUS_AUTH_CLIENT (auth)->mechs_to_try);
1569
1570   _dbus_verbose ("%s: Trying mechanism %s\n",
1571                  DBUS_AUTH_NAME (auth),
1572                  auth->mech->mechanism);
1573
1574   _dbus_string_free (&auth_command);
1575
1576   return TRUE;
1577 }
1578
1579 static dbus_bool_t
1580 process_rejected (DBusAuth         *auth,
1581                   const DBusString *command,
1582                   const DBusString *args)
1583 {
1584   shutdown_mech (auth);
1585
1586   if (!auth->already_got_mechanisms)
1587     {
1588       if (!record_mechanisms (auth, command, args))
1589         return FALSE;
1590     }
1591
1592   if (DBUS_AUTH_CLIENT (auth)->mechs_to_try != NULL)
1593     {
1594       if (!client_try_next_mechanism (auth))
1595         return FALSE;
1596     }
1597   else
1598     {
1599       /* Give up */
1600       auth->need_disconnect = TRUE;
1601     }
1602
1603   return TRUE;
1604 }
1605
1606 static dbus_bool_t
1607 process_ok (DBusAuth         *auth,
1608             const DBusString *command,
1609             const DBusString *args)
1610 {
1611   if (!_dbus_string_append (&auth->outgoing,
1612                             "BEGIN\r\n"))
1613     return FALSE;
1614
1615   auth->authenticated_pending_output = TRUE;
1616
1617   return TRUE;
1618 }
1619
1620 static dbus_bool_t
1621 process_data_client (DBusAuth         *auth,
1622                      const DBusString *command,
1623                      const DBusString *args)
1624 {
1625   if (auth->mech != NULL)
1626     {
1627       DBusString decoded;
1628
1629       if (!_dbus_string_init (&decoded))
1630         return FALSE;
1631
1632       if (!_dbus_string_base64_decode (args, 0, &decoded, 0))
1633         {
1634           _dbus_string_free (&decoded);
1635           return FALSE;
1636         }
1637
1638 #ifdef DBUS_ENABLE_VERBOSE_MODE
1639       if (_dbus_string_validate_ascii (&decoded, 0,
1640                                        _dbus_string_get_length (&decoded)))
1641         {
1642           _dbus_verbose ("%s: data: '%s'\n",
1643                          DBUS_AUTH_NAME (auth),
1644                          _dbus_string_get_const_data (&decoded));
1645         }
1646 #endif
1647
1648       if (!(* auth->mech->client_data_func) (auth, &decoded))
1649         {
1650           _dbus_string_free (&decoded);
1651           return FALSE;
1652         }
1653
1654       _dbus_string_free (&decoded);
1655     }
1656   else
1657     {
1658       if (!_dbus_string_append (&auth->outgoing,
1659                                 "ERROR \"Got DATA when not in an auth exchange\"\r\n"))
1660         return FALSE;
1661     }
1662
1663   return TRUE;
1664 }
1665
1666 static dbus_bool_t
1667 process_error_client (DBusAuth         *auth,
1668                       const DBusString *command,
1669                       const DBusString *args)
1670 {
1671   /* Cancel current mechanism, as we don't have anything
1672    * more clever to do.
1673    */
1674   if (!_dbus_string_append (&auth->outgoing,
1675                             "CANCEL\r\n"))
1676     return FALSE;
1677
1678   return TRUE;
1679 }
1680
1681 static dbus_bool_t
1682 process_unknown (DBusAuth         *auth,
1683                  const DBusString *command,
1684                  const DBusString *args)
1685 {
1686   if (!_dbus_string_append (&auth->outgoing,
1687                             "ERROR \"Unknown command\"\r\n"))
1688     return FALSE;
1689
1690   return TRUE;
1691 }
1692
1693 /* returns whether to call it again right away */
1694 static dbus_bool_t
1695 process_command (DBusAuth *auth)
1696 {
1697   DBusString command;
1698   DBusString args;
1699   int eol;
1700   int i, j;
1701   dbus_bool_t retval;
1702
1703   /* _dbus_verbose ("%s:   trying process_command()\n"); */
1704
1705   retval = FALSE;
1706
1707   eol = 0;
1708   if (!_dbus_string_find (&auth->incoming, 0, "\r\n", &eol))
1709     return FALSE;
1710
1711   if (!_dbus_string_init (&command))
1712     {
1713       auth->needed_memory = TRUE;
1714       return FALSE;
1715     }
1716
1717   if (!_dbus_string_init (&args))
1718     {
1719       _dbus_string_free (&command);
1720       auth->needed_memory = TRUE;
1721       return FALSE;
1722     }
1723
1724   if (eol > _DBUS_ONE_MEGABYTE)
1725     {
1726       /* This is a giant line, someone is trying to hose us. */
1727       if (!_dbus_string_append (&auth->outgoing, "ERROR \"Command too long\"\r\n"))
1728         goto out;
1729       else
1730         goto next_command;
1731     }
1732
1733   if (!_dbus_string_copy_len (&auth->incoming, 0, eol, &command, 0))
1734     goto out;
1735
1736   if (!_dbus_string_validate_ascii (&command, 0,
1737                                     _dbus_string_get_length (&command)))
1738     {
1739       _dbus_verbose ("%s: Command contained non-ASCII chars or embedded nul\n",
1740                      DBUS_AUTH_NAME (auth));
1741       if (!_dbus_string_append (&auth->outgoing, "ERROR \"Command contained non-ASCII\"\r\n"))
1742         goto out;
1743       else
1744         goto next_command;
1745     }
1746
1747   _dbus_verbose ("%s: got command \"%s\"\n",
1748                  DBUS_AUTH_NAME (auth),
1749                  _dbus_string_get_const_data (&command));
1750
1751   _dbus_string_find_blank (&command, 0, &i);
1752   _dbus_string_skip_blank (&command, i, &j);
1753
1754   if (j > i)
1755     _dbus_string_delete (&command, i, j - i);
1756
1757   if (!_dbus_string_move (&command, i, &args, 0))
1758     goto out;
1759
1760   i = 0;
1761   while (auth->handlers[i].command != NULL)
1762     {
1763       if (_dbus_string_equal_c_str (&command,
1764                                     auth->handlers[i].command))
1765         {
1766           _dbus_verbose ("%s: Processing auth command %s\n",
1767                          DBUS_AUTH_NAME (auth),
1768                          auth->handlers[i].command);
1769
1770           if (!(* auth->handlers[i].func) (auth, &command, &args))
1771             goto out;
1772
1773           break;
1774         }
1775       ++i;
1776     }
1777
1778   if (auth->handlers[i].command == NULL)
1779     {
1780       if (!process_unknown (auth, &command, &args))
1781         goto out;
1782     }
1783
1784  next_command:
1785
1786   /* We've succeeded in processing the whole command so drop it out
1787    * of the incoming buffer and return TRUE to try another command.
1788    */
1789
1790   _dbus_string_delete (&auth->incoming, 0, eol);
1791
1792   /* kill the \r\n */
1793   _dbus_string_delete (&auth->incoming, 0, 2);
1794
1795   retval = TRUE;
1796
1797  out:
1798   _dbus_string_free (&args);
1799   _dbus_string_free (&command);
1800
1801   if (!retval)
1802     auth->needed_memory = TRUE;
1803   else
1804     auth->needed_memory = FALSE;
1805
1806   return retval;
1807 }
1808
1809
1810 /** @} */
1811
1812 /**
1813  * @addtogroup DBusAuth
1814  * @{
1815  */
1816
1817 /**
1818  * Creates a new auth conversation object for the server side.
1819  * See doc/dbus-sasl-profile.txt for full details on what
1820  * this object does.
1821  *
1822  * @returns the new object or #NULL if no memory
1823  */
1824 DBusAuth*
1825 _dbus_auth_server_new (void)
1826 {
1827   DBusAuth *auth;
1828   DBusAuthServer *server_auth;
1829
1830   auth = _dbus_auth_new (sizeof (DBusAuthServer));
1831   if (auth == NULL)
1832     return NULL;
1833
1834   auth->handlers = server_handlers;
1835
1836   server_auth = DBUS_AUTH_SERVER (auth);
1837
1838   /* perhaps this should be per-mechanism with a lower
1839    * max
1840    */
1841   server_auth->failures = 0;
1842   server_auth->max_failures = 6;
1843
1844   return auth;
1845 }
1846
1847 /**
1848  * Creates a new auth conversation object for the client side.
1849  * See doc/dbus-sasl-profile.txt for full details on what
1850  * this object does.
1851  *
1852  * @returns the new object or #NULL if no memory
1853  */
1854 DBusAuth*
1855 _dbus_auth_client_new (void)
1856 {
1857   DBusAuth *auth;
1858
1859   auth = _dbus_auth_new (sizeof (DBusAuthClient));
1860   if (auth == NULL)
1861     return NULL;
1862
1863   auth->handlers = client_handlers;
1864
1865   /* Add a default mechanism to try */
1866   if (!_dbus_list_append (& DBUS_AUTH_CLIENT (auth)->mechs_to_try,
1867                           (void*) &all_mechanisms[0]))
1868     {
1869       _dbus_auth_unref (auth);
1870       return NULL;
1871     }
1872
1873   /* Now try the mechanism we just added */
1874   if (!client_try_next_mechanism (auth))
1875     {
1876       _dbus_auth_unref (auth);
1877       return NULL;
1878     }
1879
1880   return auth;
1881 }
1882
1883 /**
1884  * Increments the refcount of an auth object.
1885  *
1886  * @param auth the auth conversation
1887  */
1888 void
1889 _dbus_auth_ref (DBusAuth *auth)
1890 {
1891   _dbus_assert (auth != NULL);
1892
1893   auth->refcount += 1;
1894 }
1895
1896 /**
1897  * Decrements the refcount of an auth object.
1898  *
1899  * @param auth the auth conversation
1900  */
1901 void
1902 _dbus_auth_unref (DBusAuth *auth)
1903 {
1904   _dbus_assert (auth != NULL);
1905   _dbus_assert (auth->refcount > 0);
1906
1907   auth->refcount -= 1;
1908   if (auth->refcount == 0)
1909     {
1910       shutdown_mech (auth);
1911
1912       if (DBUS_AUTH_IS_CLIENT (auth))
1913         {
1914           _dbus_list_clear (& DBUS_AUTH_CLIENT (auth)->mechs_to_try);
1915         }
1916
1917       if (auth->keyring)
1918         _dbus_keyring_unref (auth->keyring);
1919
1920       _dbus_string_free (&auth->context);
1921       _dbus_string_free (&auth->challenge);
1922       _dbus_string_free (&auth->identity);
1923       _dbus_string_free (&auth->incoming);
1924       _dbus_string_free (&auth->outgoing);
1925
1926       dbus_free_string_array (auth->allowed_mechs);
1927
1928       dbus_free (auth);
1929     }
1930 }
1931
1932 /**
1933  * Sets an array of authentication mechanism names
1934  * that we are willing to use.
1935  *
1936  * @param auth the auth conversation
1937  * @param mechanisms #NULL-terminated array of mechanism names
1938  * @returns #FALSE if no memory
1939  */
1940 dbus_bool_t
1941 _dbus_auth_set_mechanisms (DBusAuth    *auth,
1942                            const char **mechanisms)
1943 {
1944   char **copy;
1945
1946   if (mechanisms != NULL)
1947     {
1948       copy = _dbus_dup_string_array (mechanisms);
1949       if (copy == NULL)
1950         return FALSE;
1951     }
1952   else
1953     copy = NULL;
1954
1955   dbus_free_string_array (auth->allowed_mechs);
1956
1957   auth->allowed_mechs = copy;
1958
1959   return TRUE;
1960 }
1961
1962 /**
1963  * @param auth the auth conversation object
1964  * @returns #TRUE if we're in a final state
1965  */
1966 #define DBUS_AUTH_IN_END_STATE(auth) ((auth)->need_disconnect || (auth)->authenticated)
1967
1968 /**
1969  * Analyzes buffered input and moves the auth conversation forward,
1970  * returning the new state of the auth conversation.
1971  *
1972  * @param auth the auth conversation
1973  * @returns the new state
1974  */
1975 DBusAuthState
1976 _dbus_auth_do_work (DBusAuth *auth)
1977 {
1978   auth->needed_memory = FALSE;
1979
1980   /* Max amount we'll buffer up before deciding someone's on crack */
1981 #define MAX_BUFFER (16 * _DBUS_ONE_KILOBYTE)
1982
1983   do
1984     {
1985       if (DBUS_AUTH_IN_END_STATE (auth))
1986         break;
1987
1988       if (_dbus_string_get_length (&auth->incoming) > MAX_BUFFER ||
1989           _dbus_string_get_length (&auth->outgoing) > MAX_BUFFER)
1990         {
1991           auth->need_disconnect = TRUE;
1992           _dbus_verbose ("%s: Disconnecting due to excessive data buffered in auth phase\n",
1993                          DBUS_AUTH_NAME (auth));
1994           break;
1995         }
1996
1997       if (auth->mech == NULL &&
1998           auth->already_got_mechanisms &&
1999           DBUS_AUTH_CLIENT (auth)->mechs_to_try == NULL)
2000         {
2001           auth->need_disconnect = TRUE;
2002           _dbus_verbose ("%s: Disconnecting because we are out of mechanisms to try using\n",
2003                          DBUS_AUTH_NAME (auth));
2004           break;
2005         }
2006     }
2007   while (process_command (auth));
2008
2009   if (DBUS_AUTH_IS_SERVER (auth) &&
2010       DBUS_AUTH_SERVER (auth)->failures >=
2011       DBUS_AUTH_SERVER (auth)->max_failures)
2012     auth->need_disconnect = TRUE;
2013
2014   if (auth->need_disconnect)
2015     return DBUS_AUTH_STATE_NEED_DISCONNECT;
2016   else if (auth->authenticated)
2017     {
2018       if (_dbus_string_get_length (&auth->incoming) > 0)
2019         return DBUS_AUTH_STATE_AUTHENTICATED_WITH_UNUSED_BYTES;
2020       else
2021         return DBUS_AUTH_STATE_AUTHENTICATED;
2022     }
2023   else if (auth->needed_memory)
2024     return DBUS_AUTH_STATE_WAITING_FOR_MEMORY;
2025   else if (_dbus_string_get_length (&auth->outgoing) > 0)
2026     return DBUS_AUTH_STATE_HAVE_BYTES_TO_SEND;
2027   else
2028     return DBUS_AUTH_STATE_WAITING_FOR_INPUT;
2029 }
2030
2031 /**
2032  * Gets bytes that need to be sent to the peer we're conversing with.
2033  * After writing some bytes, _dbus_auth_bytes_sent() must be called
2034  * to notify the auth object that they were written.
2035  *
2036  * @param auth the auth conversation
2037  * @param str return location for a ref to the buffer to send
2038  * @returns #FALSE if nothing to send
2039  */
2040 dbus_bool_t
2041 _dbus_auth_get_bytes_to_send (DBusAuth          *auth,
2042                               const DBusString **str)
2043 {
2044   _dbus_assert (auth != NULL);
2045   _dbus_assert (str != NULL);
2046
2047   *str = NULL;
2048
2049   if (DBUS_AUTH_IN_END_STATE (auth))
2050     return FALSE;
2051
2052   if (_dbus_string_get_length (&auth->outgoing) == 0)
2053     return FALSE;
2054
2055   *str = &auth->outgoing;
2056
2057   return TRUE;
2058 }
2059
2060 /**
2061  * Notifies the auth conversation object that
2062  * the given number of bytes of the outgoing buffer
2063  * have been written out.
2064  *
2065  * @param auth the auth conversation
2066  * @param bytes_sent number of bytes written out
2067  */
2068 void
2069 _dbus_auth_bytes_sent (DBusAuth *auth,
2070                        int       bytes_sent)
2071 {
2072   _dbus_verbose ("%s: Sent %d bytes of: %s\n",
2073                  DBUS_AUTH_NAME (auth),
2074                  bytes_sent,
2075                  _dbus_string_get_const_data (&auth->outgoing));
2076
2077   _dbus_string_delete (&auth->outgoing,
2078                        0, bytes_sent);
2079
2080   if (auth->authenticated_pending_output &&
2081       _dbus_string_get_length (&auth->outgoing) == 0)
2082     auth->authenticated = TRUE;
2083 }
2084
2085 /**
2086  * Get a buffer to be used for reading bytes from the peer we're conversing
2087  * with. Bytes should be appended to this buffer.
2088  *
2089  * @param auth the auth conversation
2090  * @param buffer return location for buffer to append bytes to
2091  */
2092 void
2093 _dbus_auth_get_buffer (DBusAuth     *auth,
2094                        DBusString **buffer)
2095 {
2096   _dbus_assert (auth != NULL);
2097   _dbus_assert (!auth->buffer_outstanding);
2098
2099   *buffer = &auth->incoming;
2100
2101   auth->buffer_outstanding = TRUE;
2102 }
2103
2104 /**
2105  * Returns a buffer with new data read into it.
2106  *
2107  * @param auth the auth conversation
2108  * @param buffer the buffer being returned
2109  * @param bytes_read number of new bytes added
2110  */
2111 void
2112 _dbus_auth_return_buffer (DBusAuth               *auth,
2113                           DBusString             *buffer,
2114                           int                     bytes_read)
2115 {
2116   _dbus_assert (buffer == &auth->incoming);
2117   _dbus_assert (auth->buffer_outstanding);
2118
2119   auth->buffer_outstanding = FALSE;
2120 }
2121
2122 /**
2123  * Returns leftover bytes that were not used as part of the auth
2124  * conversation.  These bytes will be part of the message stream
2125  * instead. This function may not be called until authentication has
2126  * succeeded.
2127  *
2128  * @param auth the auth conversation
2129  * @param str return location for pointer to string of unused bytes
2130  */
2131 void
2132 _dbus_auth_get_unused_bytes (DBusAuth           *auth,
2133                              const DBusString **str)
2134 {
2135   if (!DBUS_AUTH_IN_END_STATE (auth))
2136     return;
2137
2138   *str = &auth->incoming;
2139 }
2140
2141
2142 /**
2143  * Gets rid of unused bytes returned by _dbus_auth_get_unused_bytes()
2144  * after we've gotten them and successfully moved them elsewhere.
2145  *
2146  * @param auth the auth conversation
2147  */
2148 void
2149 _dbus_auth_delete_unused_bytes (DBusAuth *auth)
2150 {
2151   if (!DBUS_AUTH_IN_END_STATE (auth))
2152     return;
2153
2154   _dbus_string_set_length (&auth->incoming, 0);
2155 }
2156
2157 /**
2158  * Called post-authentication, indicates whether we need to encode
2159  * the message stream with _dbus_auth_encode_data() prior to
2160  * sending it to the peer.
2161  *
2162  * @param auth the auth conversation
2163  * @returns #TRUE if we need to encode the stream
2164  */
2165 dbus_bool_t
2166 _dbus_auth_needs_encoding (DBusAuth *auth)
2167 {
2168   if (!auth->authenticated)
2169     return FALSE;
2170
2171   if (auth->mech != NULL)
2172     {
2173       if (DBUS_AUTH_IS_CLIENT (auth))
2174         return auth->mech->client_encode_func != NULL;
2175       else
2176         return auth->mech->server_encode_func != NULL;
2177     }
2178   else
2179     return FALSE;
2180 }
2181
2182 /**
2183  * Called post-authentication, encodes a block of bytes for sending to
2184  * the peer. If no encoding was negotiated, just copies the bytes
2185  * (you can avoid this by checking _dbus_auth_needs_encoding()).
2186  *
2187  * @param auth the auth conversation
2188  * @param plaintext the plain text data
2189  * @param encoded initialized string to where encoded data is appended
2190  * @returns #TRUE if we had enough memory and successfully encoded
2191  */
2192 dbus_bool_t
2193 _dbus_auth_encode_data (DBusAuth         *auth,
2194                         const DBusString *plaintext,
2195                         DBusString       *encoded)
2196 {
2197   _dbus_assert (plaintext != encoded);
2198
2199   if (!auth->authenticated)
2200     return FALSE;
2201
2202   if (_dbus_auth_needs_encoding (auth))
2203     {
2204       if (DBUS_AUTH_IS_CLIENT (auth))
2205         return (* auth->mech->client_encode_func) (auth, plaintext, encoded);
2206       else
2207         return (* auth->mech->server_encode_func) (auth, plaintext, encoded);
2208     }
2209   else
2210     {
2211       return _dbus_string_copy (plaintext, 0, encoded,
2212                                 _dbus_string_get_length (encoded));
2213     }
2214 }
2215
2216 /**
2217  * Called post-authentication, indicates whether we need to decode
2218  * the message stream with _dbus_auth_decode_data() after
2219  * receiving it from the peer.
2220  *
2221  * @param auth the auth conversation
2222  * @returns #TRUE if we need to encode the stream
2223  */
2224 dbus_bool_t
2225 _dbus_auth_needs_decoding (DBusAuth *auth)
2226 {
2227   if (!auth->authenticated)
2228     return FALSE;
2229
2230   if (auth->mech != NULL)
2231     {
2232       if (DBUS_AUTH_IS_CLIENT (auth))
2233         return auth->mech->client_decode_func != NULL;
2234       else
2235         return auth->mech->server_decode_func != NULL;
2236     }
2237   else
2238     return FALSE;
2239 }
2240
2241
2242 /**
2243  * Called post-authentication, decodes a block of bytes received from
2244  * the peer. If no encoding was negotiated, just copies the bytes (you
2245  * can avoid this by checking _dbus_auth_needs_decoding()).
2246  *
2247  * @todo We need to be able to distinguish "out of memory" error
2248  * from "the data is hosed" error.
2249  *
2250  * @param auth the auth conversation
2251  * @param encoded the encoded data
2252  * @param plaintext initialized string where decoded data is appended
2253  * @returns #TRUE if we had enough memory and successfully decoded
2254  */
2255 dbus_bool_t
2256 _dbus_auth_decode_data (DBusAuth         *auth,
2257                         const DBusString *encoded,
2258                         DBusString       *plaintext)
2259 {
2260   _dbus_assert (plaintext != encoded);
2261
2262   if (!auth->authenticated)
2263     return FALSE;
2264
2265   if (_dbus_auth_needs_decoding (auth))
2266     {
2267       if (DBUS_AUTH_IS_CLIENT (auth))
2268         return (* auth->mech->client_decode_func) (auth, encoded, plaintext);
2269       else
2270         return (* auth->mech->server_decode_func) (auth, encoded, plaintext);
2271     }
2272   else
2273     {
2274       return _dbus_string_copy (encoded, 0, plaintext,
2275                                 _dbus_string_get_length (plaintext));
2276     }
2277 }
2278
2279 /**
2280  * Sets credentials received via reliable means from the operating
2281  * system.
2282  *
2283  * @param auth the auth conversation
2284  * @param credentials the credentials received
2285  */
2286 void
2287 _dbus_auth_set_credentials (DBusAuth               *auth,
2288                             const DBusCredentials  *credentials)
2289 {
2290   auth->credentials = *credentials;
2291 }
2292
2293 /**
2294  * Gets the identity we authorized the client as.  Apps may have
2295  * different policies as to what identities they allow.
2296  *
2297  * @param auth the auth conversation
2298  * @param credentials the credentials we've authorized
2299  */
2300 void
2301 _dbus_auth_get_identity (DBusAuth               *auth,
2302                          DBusCredentials        *credentials)
2303 {
2304   if (auth->authenticated)
2305     *credentials = auth->authorized_identity;
2306   else
2307     _dbus_credentials_clear (credentials);
2308 }
2309
2310 /**
2311  * Sets the "authentication context" which scopes cookies
2312  * with the DBUS_COOKIE_SHA1 auth mechanism for example.
2313  *
2314  * @param auth the auth conversation
2315  * @param context the context
2316  * @returns #FALSE if no memory
2317  */
2318 dbus_bool_t
2319 _dbus_auth_set_context (DBusAuth               *auth,
2320                         const DBusString       *context)
2321 {
2322   return _dbus_string_replace_len (context, 0, _dbus_string_get_length (context),
2323                                    &auth->context, 0, _dbus_string_get_length (context));
2324 }
2325
2326 /** @} */
2327
2328 #ifdef DBUS_BUILD_TESTS
2329 #include "dbus-test.h"
2330 #include "dbus-auth-script.h"
2331 #include <stdio.h>
2332
2333 static dbus_bool_t
2334 process_test_subdir (const DBusString          *test_base_dir,
2335                      const char                *subdir)
2336 {
2337   DBusString test_directory;
2338   DBusString filename;
2339   DBusDirIter *dir;
2340   dbus_bool_t retval;
2341   DBusError error;
2342
2343   retval = FALSE;
2344   dir = NULL;
2345
2346   if (!_dbus_string_init (&test_directory))
2347     _dbus_assert_not_reached ("didn't allocate test_directory\n");
2348
2349   _dbus_string_init_const (&filename, subdir);
2350
2351   if (!_dbus_string_copy (test_base_dir, 0,
2352                           &test_directory, 0))
2353     _dbus_assert_not_reached ("couldn't copy test_base_dir to test_directory");
2354
2355   if (!_dbus_concat_dir_and_file (&test_directory, &filename))
2356     _dbus_assert_not_reached ("couldn't allocate full path");
2357
2358   _dbus_string_free (&filename);
2359   if (!_dbus_string_init (&filename))
2360     _dbus_assert_not_reached ("didn't allocate filename string\n");
2361
2362   dbus_error_init (&error);
2363   dir = _dbus_directory_open (&test_directory, &error);
2364   if (dir == NULL)
2365     {
2366       _dbus_warn ("Could not open %s: %s\n",
2367                   _dbus_string_get_const_data (&test_directory),
2368                   error.message);
2369       dbus_error_free (&error);
2370       goto failed;
2371     }
2372
2373   printf ("Testing:\n");
2374
2375  next:
2376   while (_dbus_directory_get_next_file (dir, &filename, &error))
2377     {
2378       DBusString full_path;
2379
2380       if (!_dbus_string_init (&full_path))
2381         _dbus_assert_not_reached ("couldn't init string");
2382
2383       if (!_dbus_string_copy (&test_directory, 0, &full_path, 0))
2384         _dbus_assert_not_reached ("couldn't copy dir to full_path");
2385
2386       if (!_dbus_concat_dir_and_file (&full_path, &filename))
2387         _dbus_assert_not_reached ("couldn't concat file to dir");
2388
2389       if (!_dbus_string_ends_with_c_str (&filename, ".auth-script"))
2390         {
2391           _dbus_verbose ("Skipping non-.auth-script file %s\n",
2392                          _dbus_string_get_const_data (&filename));
2393           _dbus_string_free (&full_path);
2394           goto next;
2395         }
2396
2397       printf ("    %s\n", _dbus_string_get_const_data (&filename));
2398
2399       if (!_dbus_auth_script_run (&full_path))
2400         {
2401           _dbus_string_free (&full_path);
2402           goto failed;
2403         }
2404       else
2405         _dbus_string_free (&full_path);
2406     }
2407
2408   if (dbus_error_is_set (&error))
2409     {
2410       _dbus_warn ("Could not get next file in %s: %s\n",
2411                   _dbus_string_get_const_data (&test_directory), error.message);
2412       dbus_error_free (&error);
2413       goto failed;
2414     }
2415
2416   retval = TRUE;
2417
2418  failed:
2419
2420   if (dir)
2421     _dbus_directory_close (dir);
2422   _dbus_string_free (&test_directory);
2423   _dbus_string_free (&filename);
2424
2425   return retval;
2426 }
2427
2428 static dbus_bool_t
2429 process_test_dirs (const char *test_data_dir)
2430 {
2431   DBusString test_directory;
2432   dbus_bool_t retval;
2433
2434   retval = FALSE;
2435
2436   _dbus_string_init_const (&test_directory, test_data_dir);
2437
2438   if (!process_test_subdir (&test_directory, "auth"))
2439     goto failed;
2440
2441   retval = TRUE;
2442
2443  failed:
2444
2445   _dbus_string_free (&test_directory);
2446
2447   return retval;
2448 }
2449
2450 dbus_bool_t
2451 _dbus_auth_test (const char *test_data_dir)
2452 {
2453
2454   if (test_data_dir == NULL)
2455     return TRUE;
2456
2457   if (!process_test_dirs (test_data_dir))
2458     return FALSE;
2459
2460   return TRUE;
2461 }
2462
2463 #endif /* DBUS_BUILD_TESTS */