1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-auth.c Authentication
4 * Copyright (C) 2002, 2003, 2004 Red Hat Inc.
6 * Licensed under the Academic Free License version 2.1
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.
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.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 #include "dbus-auth.h"
26 #include "dbus-string.h"
27 #include "dbus-list.h"
28 #include "dbus-internals.h"
29 #include "dbus-keyring.h"
31 #include "dbus-protocol.h"
32 #include "dbus-credentials.h"
35 * @defgroup DBusAuth Authentication
36 * @ingroup DBusInternals
37 * @brief DBusAuth object
39 * DBusAuth manages the authentication negotiation when a connection
40 * is first established, and also manage any encryption used over a
43 * @todo some SASL profiles require sending the empty string as a
44 * challenge/response, but we don't currently allow that in our
47 * @todo right now sometimes both ends will block waiting for input
48 * from the other end, e.g. if there's an error during
51 * @todo the cookie keyring needs to be cached globally not just
52 * per-auth (which raises threadsafety issues too)
54 * @todo grep FIXME in dbus-auth.c
58 * @defgroup DBusAuthInternals Authentication implementation details
59 * @ingroup DBusInternals
60 * @brief DBusAuth implementation details
62 * Private details of authentication code.
68 * This function appends an initial client response to the given string
70 typedef dbus_bool_t (* DBusInitialResponseFunction) (DBusAuth *auth,
71 DBusString *response);
74 * This function processes a block of data received from the peer.
75 * i.e. handles a DATA command.
77 typedef dbus_bool_t (* DBusAuthDataFunction) (DBusAuth *auth,
78 const DBusString *data);
81 * This function encodes a block of data from the peer.
83 typedef dbus_bool_t (* DBusAuthEncodeFunction) (DBusAuth *auth,
84 const DBusString *data,
88 * This function decodes a block of data from the peer.
90 typedef dbus_bool_t (* DBusAuthDecodeFunction) (DBusAuth *auth,
91 const DBusString *data,
95 * This function is called when the mechanism is abandoned.
97 typedef void (* DBusAuthShutdownFunction) (DBusAuth *auth);
100 * Virtual table representing a particular auth mechanism.
104 const char *mechanism; /**< Name of the mechanism */
105 DBusAuthDataFunction server_data_func; /**< Function on server side for DATA */
106 DBusAuthEncodeFunction server_encode_func; /**< Function on server side to encode */
107 DBusAuthDecodeFunction server_decode_func; /**< Function on server side to decode */
108 DBusAuthShutdownFunction server_shutdown_func; /**< Function on server side to shut down */
109 DBusInitialResponseFunction client_initial_response_func; /**< Function on client side to handle initial response */
110 DBusAuthDataFunction client_data_func; /**< Function on client side for DATA */
111 DBusAuthEncodeFunction client_encode_func; /**< Function on client side for encode */
112 DBusAuthDecodeFunction client_decode_func; /**< Function on client side for decode */
113 DBusAuthShutdownFunction client_shutdown_func; /**< Function on client side for shutdown */
114 } DBusAuthMechanismHandler;
117 * Enumeration for the known authentication commands.
120 DBUS_AUTH_COMMAND_AUTH,
121 DBUS_AUTH_COMMAND_CANCEL,
122 DBUS_AUTH_COMMAND_DATA,
123 DBUS_AUTH_COMMAND_BEGIN,
124 DBUS_AUTH_COMMAND_REJECTED,
125 DBUS_AUTH_COMMAND_OK,
126 DBUS_AUTH_COMMAND_ERROR,
127 DBUS_AUTH_COMMAND_UNKNOWN,
128 DBUS_AUTH_COMMAND_NEGOTIATE_UNIX_FD,
129 DBUS_AUTH_COMMAND_AGREE_UNIX_FD
133 * Auth state function, determines the reaction to incoming events for
134 * a particular state. Returns whether we had enough memory to
135 * complete the operation.
137 typedef dbus_bool_t (* DBusAuthStateFunction) (DBusAuth *auth,
138 DBusAuthCommand command,
139 const DBusString *args);
142 * Information about a auth state.
146 const char *name; /**< Name of the state */
147 DBusAuthStateFunction handler; /**< State function for this state */
151 * Internal members of DBusAuth.
155 int refcount; /**< reference count */
156 const char *side; /**< Client or server */
158 DBusString incoming; /**< Incoming data buffer */
159 DBusString outgoing; /**< Outgoing data buffer */
161 const DBusAuthStateData *state; /**< Current protocol state */
163 const DBusAuthMechanismHandler *mech; /**< Current auth mechanism */
165 DBusString identity; /**< Current identity we're authorizing
169 DBusCredentials *credentials; /**< Credentials read from socket
172 DBusCredentials *authorized_identity; /**< Credentials that are authorized */
174 DBusCredentials *desired_identity; /**< Identity client has requested */
176 DBusString context; /**< Cookie scope */
177 DBusKeyring *keyring; /**< Keyring for cookie mechanism. */
178 int cookie_id; /**< ID of cookie to use */
179 DBusString challenge; /**< Challenge sent to client */
181 char **allowed_mechs; /**< Mechanisms we're allowed to use,
182 * or #NULL if we can use any
185 unsigned int needed_memory : 1; /**< We needed memory to continue since last
186 * successful getting something done
188 unsigned int already_got_mechanisms : 1; /**< Client already got mech list */
189 unsigned int already_asked_for_initial_response : 1; /**< Already sent a blank challenge to get an initial response */
190 unsigned int buffer_outstanding : 1; /**< Buffer is "checked out" for reading data into */
192 unsigned int unix_fd_possible : 1; /**< This side could do unix fd passing */
193 unsigned int unix_fd_negotiated : 1; /**< Unix fd was successfully negotiated */
197 * "Subclass" of DBusAuth for client side
201 DBusAuth base; /**< Parent class */
203 DBusList *mechs_to_try; /**< Mechanisms we got from the server that we're going to try using */
205 DBusString guid_from_server; /**< GUID received from server */
210 * "Subclass" of DBusAuth for server side.
214 DBusAuth base; /**< Parent class */
216 int failures; /**< Number of times client has been rejected */
217 int max_failures; /**< Number of times we reject before disconnect */
219 DBusString guid; /**< Our globally unique ID in hex encoding */
223 static void goto_state (DBusAuth *auth,
224 const DBusAuthStateData *new_state);
225 static dbus_bool_t send_auth (DBusAuth *auth,
226 const DBusAuthMechanismHandler *mech);
227 static dbus_bool_t send_data (DBusAuth *auth,
229 static dbus_bool_t send_rejected (DBusAuth *auth);
230 static dbus_bool_t send_error (DBusAuth *auth,
231 const char *message);
232 static dbus_bool_t send_ok (DBusAuth *auth);
233 static dbus_bool_t send_begin (DBusAuth *auth);
234 static dbus_bool_t send_cancel (DBusAuth *auth);
235 static dbus_bool_t send_negotiate_unix_fd (DBusAuth *auth);
236 static dbus_bool_t send_agree_unix_fd (DBusAuth *auth);
242 static dbus_bool_t handle_server_state_waiting_for_auth (DBusAuth *auth,
243 DBusAuthCommand command,
244 const DBusString *args);
245 static dbus_bool_t handle_server_state_waiting_for_data (DBusAuth *auth,
246 DBusAuthCommand command,
247 const DBusString *args);
248 static dbus_bool_t handle_server_state_waiting_for_begin (DBusAuth *auth,
249 DBusAuthCommand command,
250 const DBusString *args);
252 static const DBusAuthStateData server_state_waiting_for_auth = {
253 "WaitingForAuth", handle_server_state_waiting_for_auth
255 static const DBusAuthStateData server_state_waiting_for_data = {
256 "WaitingForData", handle_server_state_waiting_for_data
258 static const DBusAuthStateData server_state_waiting_for_begin = {
259 "WaitingForBegin", handle_server_state_waiting_for_begin
266 static dbus_bool_t handle_client_state_waiting_for_data (DBusAuth *auth,
267 DBusAuthCommand command,
268 const DBusString *args);
269 static dbus_bool_t handle_client_state_waiting_for_ok (DBusAuth *auth,
270 DBusAuthCommand command,
271 const DBusString *args);
272 static dbus_bool_t handle_client_state_waiting_for_reject (DBusAuth *auth,
273 DBusAuthCommand command,
274 const DBusString *args);
275 static dbus_bool_t handle_client_state_waiting_for_agree_unix_fd (DBusAuth *auth,
276 DBusAuthCommand command,
277 const DBusString *args);
279 static const DBusAuthStateData client_state_need_send_auth = {
282 static const DBusAuthStateData client_state_waiting_for_data = {
283 "WaitingForData", handle_client_state_waiting_for_data
285 static const DBusAuthStateData client_state_waiting_for_ok = {
286 "WaitingForOK", handle_client_state_waiting_for_ok
288 static const DBusAuthStateData client_state_waiting_for_reject = {
289 "WaitingForReject", handle_client_state_waiting_for_reject
291 static const DBusAuthStateData client_state_waiting_for_agree_unix_fd = {
292 "WaitingForAgreeUnixFD", handle_client_state_waiting_for_agree_unix_fd
296 * Common terminal states. Terminal states have handler == NULL.
299 static const DBusAuthStateData common_state_authenticated = {
300 "Authenticated", NULL
303 static const DBusAuthStateData common_state_need_disconnect = {
304 "NeedDisconnect", NULL
307 static const char auth_side_client[] = "client";
308 static const char auth_side_server[] = "server";
310 * @param auth the auth conversation
311 * @returns #TRUE if the conversation is the server side
313 #define DBUS_AUTH_IS_SERVER(auth) ((auth)->side == auth_side_server)
315 * @param auth the auth conversation
316 * @returns #TRUE if the conversation is the client side
318 #define DBUS_AUTH_IS_CLIENT(auth) ((auth)->side == auth_side_client)
320 * @param auth the auth conversation
321 * @returns auth cast to DBusAuthClient
323 #define DBUS_AUTH_CLIENT(auth) ((DBusAuthClient*)(auth))
325 * @param auth the auth conversation
326 * @returns auth cast to DBusAuthServer
328 #define DBUS_AUTH_SERVER(auth) ((DBusAuthServer*)(auth))
331 * The name of the auth ("client" or "server")
332 * @param auth the auth conversation
335 #define DBUS_AUTH_NAME(auth) ((auth)->side)
338 _dbus_auth_new (int size)
342 auth = dbus_malloc0 (size);
348 auth->keyring = NULL;
349 auth->cookie_id = -1;
351 /* note that we don't use the max string length feature,
352 * because you can't use that feature if you're going to
353 * try to recover from out-of-memory (it creates
354 * what looks like unrecoverable inability to alloc
355 * more space in the string). But we do handle
356 * overlong buffers in _dbus_auth_do_work().
359 if (!_dbus_string_init (&auth->incoming))
362 if (!_dbus_string_init (&auth->outgoing))
365 if (!_dbus_string_init (&auth->identity))
368 if (!_dbus_string_init (&auth->context))
371 if (!_dbus_string_init (&auth->challenge))
374 /* default context if none is specified */
375 if (!_dbus_string_append (&auth->context, "org_freedesktop_general"))
378 auth->credentials = _dbus_credentials_new ();
379 if (auth->credentials == NULL)
382 auth->authorized_identity = _dbus_credentials_new ();
383 if (auth->authorized_identity == NULL)
386 auth->desired_identity = _dbus_credentials_new ();
387 if (auth->desired_identity == NULL)
394 _dbus_credentials_unref (auth->desired_identity);
397 _dbus_credentials_unref (auth->authorized_identity);
399 _dbus_credentials_unref (auth->credentials);
401 /* last alloc was an append to context, which is freed already below */ ;
403 _dbus_string_free (&auth->challenge);
405 _dbus_string_free (&auth->context);
407 _dbus_string_free (&auth->identity);
409 _dbus_string_free (&auth->outgoing);
411 _dbus_string_free (&auth->incoming);
418 shutdown_mech (DBusAuth *auth)
420 /* Cancel any auth */
421 auth->already_asked_for_initial_response = FALSE;
422 _dbus_string_set_length (&auth->identity, 0);
424 _dbus_credentials_clear (auth->authorized_identity);
425 _dbus_credentials_clear (auth->desired_identity);
427 if (auth->mech != NULL)
429 _dbus_verbose ("%s: Shutting down mechanism %s\n",
430 DBUS_AUTH_NAME (auth), auth->mech->mechanism);
432 if (DBUS_AUTH_IS_CLIENT (auth))
433 (* auth->mech->client_shutdown_func) (auth);
435 (* auth->mech->server_shutdown_func) (auth);
442 * DBUS_COOKIE_SHA1 mechanism
445 /* Returns TRUE but with an empty string hash if the
446 * cookie_id isn't known. As with all this code
447 * TRUE just means we had enough memory.
450 sha1_compute_hash (DBusAuth *auth,
452 const DBusString *server_challenge,
453 const DBusString *client_challenge,
460 _dbus_assert (auth->keyring != NULL);
464 if (!_dbus_string_init (&cookie))
467 if (!_dbus_keyring_get_hex_key (auth->keyring, cookie_id,
471 if (_dbus_string_get_length (&cookie) == 0)
477 if (!_dbus_string_init (&to_hash))
480 if (!_dbus_string_copy (server_challenge, 0,
481 &to_hash, _dbus_string_get_length (&to_hash)))
484 if (!_dbus_string_append (&to_hash, ":"))
487 if (!_dbus_string_copy (client_challenge, 0,
488 &to_hash, _dbus_string_get_length (&to_hash)))
491 if (!_dbus_string_append (&to_hash, ":"))
494 if (!_dbus_string_copy (&cookie, 0,
495 &to_hash, _dbus_string_get_length (&to_hash)))
498 if (!_dbus_sha_compute (&to_hash, hash))
504 _dbus_string_zero (&to_hash);
505 _dbus_string_free (&to_hash);
507 _dbus_string_zero (&cookie);
508 _dbus_string_free (&cookie);
512 /** http://www.ietf.org/rfc/rfc2831.txt suggests at least 64 bits of
513 * entropy, we use 128. This is the number of bytes in the random
516 #define N_CHALLENGE_BYTES (128/8)
519 sha1_handle_first_client_response (DBusAuth *auth,
520 const DBusString *data)
522 /* We haven't sent a challenge yet, we're expecting a desired
523 * username from the client.
532 _dbus_string_set_length (&auth->challenge, 0);
534 if (_dbus_string_get_length (data) > 0)
536 if (_dbus_string_get_length (&auth->identity) > 0)
538 /* Tried to send two auth identities, wtf */
539 _dbus_verbose ("%s: client tried to send auth identity, but we already have one\n",
540 DBUS_AUTH_NAME (auth));
541 return send_rejected (auth);
545 /* this is our auth identity */
546 if (!_dbus_string_copy (data, 0, &auth->identity, 0))
551 if (!_dbus_credentials_add_from_user (auth->desired_identity, data))
553 _dbus_verbose ("%s: Did not get a valid username from client\n",
554 DBUS_AUTH_NAME (auth));
555 return send_rejected (auth);
558 if (!_dbus_string_init (&tmp))
561 if (!_dbus_string_init (&tmp2))
563 _dbus_string_free (&tmp);
567 /* we cache the keyring for speed, so here we drop it if it's the
568 * wrong one. FIXME caching the keyring here is useless since we use
569 * a different DBusAuth for every connection.
572 !_dbus_keyring_is_for_credentials (auth->keyring,
573 auth->desired_identity))
575 _dbus_keyring_unref (auth->keyring);
576 auth->keyring = NULL;
579 if (auth->keyring == NULL)
581 dbus_error_init (&error);
582 auth->keyring = _dbus_keyring_new_for_credentials (auth->desired_identity,
586 if (auth->keyring == NULL)
588 if (dbus_error_has_name (&error,
589 DBUS_ERROR_NO_MEMORY))
591 dbus_error_free (&error);
596 _DBUS_ASSERT_ERROR_IS_SET (&error);
597 _dbus_verbose ("%s: Error loading keyring: %s\n",
598 DBUS_AUTH_NAME (auth), error.message);
599 if (send_rejected (auth))
600 retval = TRUE; /* retval is only about mem */
601 dbus_error_free (&error);
607 _dbus_assert (!dbus_error_is_set (&error));
611 _dbus_assert (auth->keyring != NULL);
613 dbus_error_init (&error);
614 auth->cookie_id = _dbus_keyring_get_best_key (auth->keyring, &error);
615 if (auth->cookie_id < 0)
617 _DBUS_ASSERT_ERROR_IS_SET (&error);
618 _dbus_verbose ("%s: Could not get a cookie ID to send to client: %s\n",
619 DBUS_AUTH_NAME (auth), error.message);
620 if (send_rejected (auth))
622 dbus_error_free (&error);
627 _dbus_assert (!dbus_error_is_set (&error));
630 if (!_dbus_string_copy (&auth->context, 0,
631 &tmp2, _dbus_string_get_length (&tmp2)))
634 if (!_dbus_string_append (&tmp2, " "))
637 if (!_dbus_string_append_int (&tmp2, auth->cookie_id))
640 if (!_dbus_string_append (&tmp2, " "))
643 if (!_dbus_generate_random_bytes (&tmp, N_CHALLENGE_BYTES))
646 _dbus_string_set_length (&auth->challenge, 0);
647 if (!_dbus_string_hex_encode (&tmp, 0, &auth->challenge, 0))
650 if (!_dbus_string_hex_encode (&tmp, 0, &tmp2,
651 _dbus_string_get_length (&tmp2)))
654 if (!send_data (auth, &tmp2))
657 goto_state (auth, &server_state_waiting_for_data);
661 _dbus_string_zero (&tmp);
662 _dbus_string_free (&tmp);
663 _dbus_string_zero (&tmp2);
664 _dbus_string_free (&tmp2);
670 sha1_handle_second_client_response (DBusAuth *auth,
671 const DBusString *data)
673 /* We are expecting a response which is the hex-encoded client
674 * challenge, space, then SHA-1 hash of the concatenation of our
675 * challenge, ":", client challenge, ":", secret key, all
679 DBusString client_challenge;
680 DBusString client_hash;
682 DBusString correct_hash;
686 if (!_dbus_string_find_blank (data, 0, &i))
688 _dbus_verbose ("%s: no space separator in client response\n",
689 DBUS_AUTH_NAME (auth));
690 return send_rejected (auth);
693 if (!_dbus_string_init (&client_challenge))
696 if (!_dbus_string_init (&client_hash))
699 if (!_dbus_string_copy_len (data, 0, i, &client_challenge,
703 _dbus_string_skip_blank (data, i, &i);
705 if (!_dbus_string_copy_len (data, i,
706 _dbus_string_get_length (data) - i,
711 if (_dbus_string_get_length (&client_challenge) == 0 ||
712 _dbus_string_get_length (&client_hash) == 0)
714 _dbus_verbose ("%s: zero-length client challenge or hash\n",
715 DBUS_AUTH_NAME (auth));
716 if (send_rejected (auth))
721 if (!_dbus_string_init (&correct_hash))
724 if (!sha1_compute_hash (auth, auth->cookie_id,
730 /* if cookie_id was invalid, then we get an empty hash */
731 if (_dbus_string_get_length (&correct_hash) == 0)
733 if (send_rejected (auth))
738 if (!_dbus_string_equal (&client_hash, &correct_hash))
740 if (send_rejected (auth))
745 if (!_dbus_credentials_add_credentials (auth->authorized_identity,
746 auth->desired_identity))
749 /* Copy process ID from the socket credentials if it's there
751 if (!_dbus_credentials_add_credential (auth->authorized_identity,
752 DBUS_CREDENTIAL_UNIX_PROCESS_ID,
759 _dbus_verbose ("%s: authenticated client using DBUS_COOKIE_SHA1\n",
760 DBUS_AUTH_NAME (auth));
765 _dbus_string_zero (&correct_hash);
766 _dbus_string_free (&correct_hash);
768 _dbus_string_zero (&client_hash);
769 _dbus_string_free (&client_hash);
771 _dbus_string_free (&client_challenge);
777 handle_server_data_cookie_sha1_mech (DBusAuth *auth,
778 const DBusString *data)
780 if (auth->cookie_id < 0)
781 return sha1_handle_first_client_response (auth, data);
783 return sha1_handle_second_client_response (auth, data);
787 handle_server_shutdown_cookie_sha1_mech (DBusAuth *auth)
789 auth->cookie_id = -1;
790 _dbus_string_set_length (&auth->challenge, 0);
794 handle_client_initial_response_cookie_sha1_mech (DBusAuth *auth,
795 DBusString *response)
802 if (!_dbus_string_init (&username))
805 if (!_dbus_append_user_from_current_process (&username))
808 if (!_dbus_string_hex_encode (&username, 0,
810 _dbus_string_get_length (response)))
816 _dbus_string_free (&username);
822 handle_client_data_cookie_sha1_mech (DBusAuth *auth,
823 const DBusString *data)
825 /* The data we get from the server should be the cookie context
826 * name, the cookie ID, and the server challenge, separated by
827 * spaces. We send back our challenge string and the correct hash.
831 DBusString cookie_id_str;
832 DBusString server_challenge;
833 DBusString client_challenge;
834 DBusString correct_hash;
841 if (!_dbus_string_find_blank (data, 0, &i))
843 if (send_error (auth,
844 "Server did not send context/ID/challenge properly"))
849 if (!_dbus_string_init (&context))
852 if (!_dbus_string_copy_len (data, 0, i,
856 _dbus_string_skip_blank (data, i, &i);
857 if (!_dbus_string_find_blank (data, i, &j))
859 if (send_error (auth,
860 "Server did not send context/ID/challenge properly"))
865 if (!_dbus_string_init (&cookie_id_str))
868 if (!_dbus_string_copy_len (data, i, j - i,
872 if (!_dbus_string_init (&server_challenge))
876 _dbus_string_skip_blank (data, i, &i);
877 j = _dbus_string_get_length (data);
879 if (!_dbus_string_copy_len (data, i, j - i,
880 &server_challenge, 0))
883 if (!_dbus_keyring_validate_context (&context))
885 if (send_error (auth, "Server sent invalid cookie context"))
890 if (!_dbus_string_parse_int (&cookie_id_str, 0, &val, NULL))
892 if (send_error (auth, "Could not parse cookie ID as an integer"))
897 if (_dbus_string_get_length (&server_challenge) == 0)
899 if (send_error (auth, "Empty server challenge string"))
904 if (auth->keyring == NULL)
908 dbus_error_init (&error);
909 auth->keyring = _dbus_keyring_new_for_credentials (NULL,
913 if (auth->keyring == NULL)
915 if (dbus_error_has_name (&error,
916 DBUS_ERROR_NO_MEMORY))
918 dbus_error_free (&error);
923 _DBUS_ASSERT_ERROR_IS_SET (&error);
925 _dbus_verbose ("%s: Error loading keyring: %s\n",
926 DBUS_AUTH_NAME (auth), error.message);
928 if (send_error (auth, "Could not load cookie file"))
929 retval = TRUE; /* retval is only about mem */
931 dbus_error_free (&error);
937 _dbus_assert (!dbus_error_is_set (&error));
941 _dbus_assert (auth->keyring != NULL);
943 if (!_dbus_string_init (&tmp))
946 if (!_dbus_generate_random_bytes (&tmp, N_CHALLENGE_BYTES))
949 if (!_dbus_string_init (&client_challenge))
952 if (!_dbus_string_hex_encode (&tmp, 0, &client_challenge, 0))
955 if (!_dbus_string_init (&correct_hash))
958 if (!sha1_compute_hash (auth, val,
964 if (_dbus_string_get_length (&correct_hash) == 0)
966 /* couldn't find the cookie ID or something */
967 if (send_error (auth, "Don't have the requested cookie ID"))
972 _dbus_string_set_length (&tmp, 0);
974 if (!_dbus_string_copy (&client_challenge, 0, &tmp,
975 _dbus_string_get_length (&tmp)))
978 if (!_dbus_string_append (&tmp, " "))
981 if (!_dbus_string_copy (&correct_hash, 0, &tmp,
982 _dbus_string_get_length (&tmp)))
985 if (!send_data (auth, &tmp))
991 _dbus_string_zero (&correct_hash);
992 _dbus_string_free (&correct_hash);
994 _dbus_string_free (&client_challenge);
996 _dbus_string_zero (&tmp);
997 _dbus_string_free (&tmp);
999 _dbus_string_free (&server_challenge);
1001 _dbus_string_free (&cookie_id_str);
1003 _dbus_string_free (&context);
1009 handle_client_shutdown_cookie_sha1_mech (DBusAuth *auth)
1011 auth->cookie_id = -1;
1012 _dbus_string_set_length (&auth->challenge, 0);
1016 * EXTERNAL mechanism
1020 handle_server_data_external_mech (DBusAuth *auth,
1021 const DBusString *data)
1023 if (_dbus_credentials_are_anonymous (auth->credentials))
1025 _dbus_verbose ("%s: no credentials, mechanism EXTERNAL can't authenticate\n",
1026 DBUS_AUTH_NAME (auth));
1027 return send_rejected (auth);
1030 if (_dbus_string_get_length (data) > 0)
1032 if (_dbus_string_get_length (&auth->identity) > 0)
1034 /* Tried to send two auth identities, wtf */
1035 _dbus_verbose ("%s: client tried to send auth identity, but we already have one\n",
1036 DBUS_AUTH_NAME (auth));
1037 return send_rejected (auth);
1041 /* this is our auth identity */
1042 if (!_dbus_string_copy (data, 0, &auth->identity, 0))
1047 /* Poke client for an auth identity, if none given */
1048 if (_dbus_string_get_length (&auth->identity) == 0 &&
1049 !auth->already_asked_for_initial_response)
1051 if (send_data (auth, NULL))
1053 _dbus_verbose ("%s: sending empty challenge asking client for auth identity\n",
1054 DBUS_AUTH_NAME (auth));
1055 auth->already_asked_for_initial_response = TRUE;
1056 goto_state (auth, &server_state_waiting_for_data);
1063 _dbus_credentials_clear (auth->desired_identity);
1065 /* If auth->identity is still empty here, then client
1066 * responded with an empty string after we poked it for
1067 * an initial response. This means to try to auth the
1068 * identity provided in the credentials.
1070 if (_dbus_string_get_length (&auth->identity) == 0)
1072 if (!_dbus_credentials_add_credentials (auth->desired_identity,
1075 return FALSE; /* OOM */
1080 if (!_dbus_credentials_add_from_user (auth->desired_identity,
1083 _dbus_verbose ("%s: could not get credentials from uid string\n",
1084 DBUS_AUTH_NAME (auth));
1085 return send_rejected (auth);
1089 if (_dbus_credentials_are_anonymous (auth->desired_identity))
1091 _dbus_verbose ("%s: desired user %s is no good\n",
1092 DBUS_AUTH_NAME (auth),
1093 _dbus_string_get_const_data (&auth->identity));
1094 return send_rejected (auth);
1097 if (_dbus_credentials_are_superset (auth->credentials,
1098 auth->desired_identity))
1100 /* client has authenticated */
1101 if (!_dbus_credentials_add_credentials (auth->authorized_identity,
1102 auth->desired_identity))
1105 /* also copy process ID from the socket credentials
1107 if (!_dbus_credentials_add_credential (auth->authorized_identity,
1108 DBUS_CREDENTIAL_UNIX_PROCESS_ID,
1112 /* also copy audit data from the socket credentials
1114 if (!_dbus_credentials_add_credential (auth->authorized_identity,
1115 DBUS_CREDENTIAL_ADT_AUDIT_DATA_ID,
1119 if (!send_ok (auth))
1122 _dbus_verbose ("%s: authenticated client based on socket credentials\n",
1123 DBUS_AUTH_NAME (auth));
1129 _dbus_verbose ("%s: desired identity not found in socket credentials\n",
1130 DBUS_AUTH_NAME (auth));
1131 return send_rejected (auth);
1136 handle_server_shutdown_external_mech (DBusAuth *auth)
1142 handle_client_initial_response_external_mech (DBusAuth *auth,
1143 DBusString *response)
1145 /* We always append our UID as an initial response, so the server
1146 * doesn't have to send back an empty challenge to check whether we
1147 * want to specify an identity. i.e. this avoids a round trip that
1148 * the spec for the EXTERNAL mechanism otherwise requires.
1150 DBusString plaintext;
1152 if (!_dbus_string_init (&plaintext))
1155 if (!_dbus_append_user_from_current_process (&plaintext))
1158 if (!_dbus_string_hex_encode (&plaintext, 0,
1160 _dbus_string_get_length (response)))
1163 _dbus_string_free (&plaintext);
1168 _dbus_string_free (&plaintext);
1173 handle_client_data_external_mech (DBusAuth *auth,
1174 const DBusString *data)
1181 handle_client_shutdown_external_mech (DBusAuth *auth)
1187 * ANONYMOUS mechanism
1191 handle_server_data_anonymous_mech (DBusAuth *auth,
1192 const DBusString *data)
1194 if (_dbus_string_get_length (data) > 0)
1196 /* Client is allowed to send "trace" data, the only defined
1197 * meaning is that if it contains '@' it is an email address,
1198 * and otherwise it is anything else, and it's supposed to be
1201 if (!_dbus_string_validate_utf8 (data, 0, _dbus_string_get_length (data)))
1203 _dbus_verbose ("%s: Received invalid UTF-8 trace data from ANONYMOUS client\n",
1204 DBUS_AUTH_NAME (auth));
1207 DBusString plaintext;
1209 _dbus_string_init_const (&plaintext, "D-Bus " DBUS_VERSION_STRING);
1210 _dbus_string_init (&encoded);
1211 _dbus_string_hex_encode (&plaintext, 0,
1214 _dbus_verbose ("%s: try '%s'\n",
1215 DBUS_AUTH_NAME (auth), _dbus_string_get_const_data (&encoded));
1217 return send_rejected (auth);
1220 _dbus_verbose ("%s: ANONYMOUS client sent trace string: '%s'\n",
1221 DBUS_AUTH_NAME (auth),
1222 _dbus_string_get_const_data (data));
1225 /* We want to be anonymous (clear in case some other protocol got midway through I guess) */
1226 _dbus_credentials_clear (auth->desired_identity);
1228 /* Copy process ID from the socket credentials
1230 if (!_dbus_credentials_add_credential (auth->authorized_identity,
1231 DBUS_CREDENTIAL_UNIX_PROCESS_ID,
1235 /* Anonymous is always allowed */
1236 if (!send_ok (auth))
1239 _dbus_verbose ("%s: authenticated client as anonymous\n",
1240 DBUS_AUTH_NAME (auth));
1246 handle_server_shutdown_anonymous_mech (DBusAuth *auth)
1252 handle_client_initial_response_anonymous_mech (DBusAuth *auth,
1253 DBusString *response)
1255 /* Our initial response is a "trace" string which must be valid UTF-8
1256 * and must be an email address if it contains '@'.
1257 * We just send the dbus implementation info, like a user-agent or
1258 * something, because... why not. There's nothing guaranteed here
1259 * though, we could change it later.
1261 DBusString plaintext;
1263 if (!_dbus_string_init (&plaintext))
1266 if (!_dbus_string_append (&plaintext,
1267 "libdbus " DBUS_VERSION_STRING))
1270 if (!_dbus_string_hex_encode (&plaintext, 0,
1272 _dbus_string_get_length (response)))
1275 _dbus_string_free (&plaintext);
1280 _dbus_string_free (&plaintext);
1285 handle_client_data_anonymous_mech (DBusAuth *auth,
1286 const DBusString *data)
1293 handle_client_shutdown_anonymous_mech (DBusAuth *auth)
1298 /* Put mechanisms here in order of preference.
1299 * Right now we have:
1301 * - EXTERNAL checks socket credentials (or in the future, other info from the OS)
1302 * - DBUS_COOKIE_SHA1 uses a cookie in the home directory, like xauth or ICE
1303 * - ANONYMOUS checks nothing but doesn't auth the person as a user
1305 * We might ideally add a mechanism to chain to Cyrus SASL so we can
1306 * use its mechanisms as well.
1309 static const DBusAuthMechanismHandler
1310 all_mechanisms[] = {
1312 handle_server_data_external_mech,
1314 handle_server_shutdown_external_mech,
1315 handle_client_initial_response_external_mech,
1316 handle_client_data_external_mech,
1318 handle_client_shutdown_external_mech },
1319 { "DBUS_COOKIE_SHA1",
1320 handle_server_data_cookie_sha1_mech,
1322 handle_server_shutdown_cookie_sha1_mech,
1323 handle_client_initial_response_cookie_sha1_mech,
1324 handle_client_data_cookie_sha1_mech,
1326 handle_client_shutdown_cookie_sha1_mech },
1328 handle_server_data_anonymous_mech,
1330 handle_server_shutdown_anonymous_mech,
1331 handle_client_initial_response_anonymous_mech,
1332 handle_client_data_anonymous_mech,
1334 handle_client_shutdown_anonymous_mech },
1338 static const DBusAuthMechanismHandler*
1339 find_mech (const DBusString *name,
1340 char **allowed_mechs)
1344 if (allowed_mechs != NULL &&
1345 !_dbus_string_array_contains ((const char**) allowed_mechs,
1346 _dbus_string_get_const_data (name)))
1350 while (all_mechanisms[i].mechanism != NULL)
1352 if (_dbus_string_equal_c_str (name,
1353 all_mechanisms[i].mechanism))
1355 return &all_mechanisms[i];
1364 send_auth (DBusAuth *auth, const DBusAuthMechanismHandler *mech)
1366 DBusString auth_command;
1368 if (!_dbus_string_init (&auth_command))
1371 if (!_dbus_string_append (&auth_command,
1374 _dbus_string_free (&auth_command);
1378 if (!_dbus_string_append (&auth_command,
1381 _dbus_string_free (&auth_command);
1385 if (mech->client_initial_response_func != NULL)
1387 if (!_dbus_string_append (&auth_command, " "))
1389 _dbus_string_free (&auth_command);
1393 if (!(* mech->client_initial_response_func) (auth, &auth_command))
1395 _dbus_string_free (&auth_command);
1400 if (!_dbus_string_append (&auth_command,
1403 _dbus_string_free (&auth_command);
1407 if (!_dbus_string_copy (&auth_command, 0,
1409 _dbus_string_get_length (&auth->outgoing)))
1411 _dbus_string_free (&auth_command);
1415 _dbus_string_free (&auth_command);
1416 shutdown_mech (auth);
1418 goto_state (auth, &client_state_waiting_for_data);
1424 send_data (DBusAuth *auth, DBusString *data)
1428 if (data == NULL || _dbus_string_get_length (data) == 0)
1429 return _dbus_string_append (&auth->outgoing, "DATA\r\n");
1432 old_len = _dbus_string_get_length (&auth->outgoing);
1433 if (!_dbus_string_append (&auth->outgoing, "DATA "))
1436 if (!_dbus_string_hex_encode (data, 0, &auth->outgoing,
1437 _dbus_string_get_length (&auth->outgoing)))
1440 if (!_dbus_string_append (&auth->outgoing, "\r\n"))
1446 _dbus_string_set_length (&auth->outgoing, old_len);
1453 send_rejected (DBusAuth *auth)
1456 DBusAuthServer *server_auth;
1459 if (!_dbus_string_init (&command))
1462 if (!_dbus_string_append (&command,
1467 while (all_mechanisms[i].mechanism != NULL)
1469 if (!_dbus_string_append (&command,
1473 if (!_dbus_string_append (&command,
1474 all_mechanisms[i].mechanism))
1480 if (!_dbus_string_append (&command, "\r\n"))
1483 if (!_dbus_string_copy (&command, 0, &auth->outgoing,
1484 _dbus_string_get_length (&auth->outgoing)))
1487 shutdown_mech (auth);
1489 _dbus_assert (DBUS_AUTH_IS_SERVER (auth));
1490 server_auth = DBUS_AUTH_SERVER (auth);
1491 server_auth->failures += 1;
1493 if (server_auth->failures >= server_auth->max_failures)
1494 goto_state (auth, &common_state_need_disconnect);
1496 goto_state (auth, &server_state_waiting_for_auth);
1498 _dbus_string_free (&command);
1503 _dbus_string_free (&command);
1508 send_error (DBusAuth *auth, const char *message)
1510 return _dbus_string_append_printf (&auth->outgoing,
1511 "ERROR \"%s\"\r\n", message);
1515 send_ok (DBusAuth *auth)
1519 orig_len = _dbus_string_get_length (&auth->outgoing);
1521 if (_dbus_string_append (&auth->outgoing, "OK ") &&
1522 _dbus_string_copy (& DBUS_AUTH_SERVER (auth)->guid,
1525 _dbus_string_get_length (&auth->outgoing)) &&
1526 _dbus_string_append (&auth->outgoing, "\r\n"))
1528 goto_state (auth, &server_state_waiting_for_begin);
1533 _dbus_string_set_length (&auth->outgoing, orig_len);
1539 send_begin (DBusAuth *auth)
1542 if (!_dbus_string_append (&auth->outgoing,
1546 goto_state (auth, &common_state_authenticated);
1551 process_ok(DBusAuth *auth,
1552 const DBusString *args_from_ok) {
1556 /* "args_from_ok" should be the GUID, whitespace already pulled off the front */
1557 _dbus_assert (_dbus_string_get_length (& DBUS_AUTH_CLIENT (auth)->guid_from_server) == 0);
1559 /* We decode the hex string to binary, using guid_from_server as scratch... */
1562 if (!_dbus_string_hex_decode (args_from_ok, 0, &end_of_hex,
1563 & DBUS_AUTH_CLIENT (auth)->guid_from_server, 0))
1566 /* now clear out the scratch */
1567 _dbus_string_set_length (& DBUS_AUTH_CLIENT (auth)->guid_from_server, 0);
1569 if (end_of_hex != _dbus_string_get_length (args_from_ok) ||
1572 _dbus_verbose ("Bad GUID from server, parsed %d bytes and had %d bytes from server\n",
1573 end_of_hex, _dbus_string_get_length (args_from_ok));
1574 goto_state (auth, &common_state_need_disconnect);
1578 if (!_dbus_string_copy (args_from_ok, 0, &DBUS_AUTH_CLIENT (auth)->guid_from_server, 0)) {
1579 _dbus_string_set_length (& DBUS_AUTH_CLIENT (auth)->guid_from_server, 0);
1583 _dbus_verbose ("Got GUID '%s' from the server\n",
1584 _dbus_string_get_const_data (& DBUS_AUTH_CLIENT (auth)->guid_from_server));
1586 if (auth->unix_fd_possible)
1587 return send_negotiate_unix_fd(auth);
1589 _dbus_verbose("Not negotiating unix fd passing, since not possible\n");
1590 return send_begin (auth);
1594 send_cancel (DBusAuth *auth)
1596 if (_dbus_string_append (&auth->outgoing, "CANCEL\r\n"))
1598 goto_state (auth, &client_state_waiting_for_reject);
1606 process_data (DBusAuth *auth,
1607 const DBusString *args,
1608 DBusAuthDataFunction data_func)
1613 if (!_dbus_string_init (&decoded))
1616 if (!_dbus_string_hex_decode (args, 0, &end, &decoded, 0))
1618 _dbus_string_free (&decoded);
1622 if (_dbus_string_get_length (args) != end)
1624 _dbus_string_free (&decoded);
1625 if (!send_error (auth, "Invalid hex encoding"))
1631 #ifdef DBUS_ENABLE_VERBOSE_MODE
1632 if (_dbus_string_validate_ascii (&decoded, 0,
1633 _dbus_string_get_length (&decoded)))
1634 _dbus_verbose ("%s: data: '%s'\n",
1635 DBUS_AUTH_NAME (auth),
1636 _dbus_string_get_const_data (&decoded));
1639 if (!(* data_func) (auth, &decoded))
1641 _dbus_string_free (&decoded);
1645 _dbus_string_free (&decoded);
1650 send_negotiate_unix_fd (DBusAuth *auth)
1652 if (!_dbus_string_append (&auth->outgoing,
1653 "NEGOTIATE_UNIX_FD\r\n"))
1656 goto_state (auth, &client_state_waiting_for_agree_unix_fd);
1661 send_agree_unix_fd (DBusAuth *auth)
1663 _dbus_assert(auth->unix_fd_possible);
1665 auth->unix_fd_negotiated = TRUE;
1666 _dbus_verbose("Agreed to UNIX FD passing\n");
1668 if (!_dbus_string_append (&auth->outgoing,
1669 "AGREE_UNIX_FD\r\n"))
1672 goto_state (auth, &server_state_waiting_for_begin);
1677 handle_auth (DBusAuth *auth, const DBusString *args)
1679 if (_dbus_string_get_length (args) == 0)
1681 /* No args to the auth, send mechanisms */
1682 if (!send_rejected (auth))
1691 DBusString hex_response;
1693 _dbus_string_find_blank (args, 0, &i);
1695 if (!_dbus_string_init (&mech))
1698 if (!_dbus_string_init (&hex_response))
1700 _dbus_string_free (&mech);
1704 if (!_dbus_string_copy_len (args, 0, i, &mech, 0))
1707 _dbus_string_skip_blank (args, i, &i);
1708 if (!_dbus_string_copy (args, i, &hex_response, 0))
1711 auth->mech = find_mech (&mech, auth->allowed_mechs);
1712 if (auth->mech != NULL)
1714 _dbus_verbose ("%s: Trying mechanism %s\n",
1715 DBUS_AUTH_NAME (auth),
1716 auth->mech->mechanism);
1718 if (!process_data (auth, &hex_response,
1719 auth->mech->server_data_func))
1724 /* Unsupported mechanism */
1725 _dbus_verbose ("%s: Unsupported mechanism %s\n",
1726 DBUS_AUTH_NAME (auth),
1727 _dbus_string_get_const_data (&mech));
1729 if (!send_rejected (auth))
1733 _dbus_string_free (&mech);
1734 _dbus_string_free (&hex_response);
1740 _dbus_string_free (&mech);
1741 _dbus_string_free (&hex_response);
1747 handle_server_state_waiting_for_auth (DBusAuth *auth,
1748 DBusAuthCommand command,
1749 const DBusString *args)
1753 case DBUS_AUTH_COMMAND_AUTH:
1754 return handle_auth (auth, args);
1756 case DBUS_AUTH_COMMAND_CANCEL:
1757 case DBUS_AUTH_COMMAND_DATA:
1758 return send_error (auth, "Not currently in an auth conversation");
1760 case DBUS_AUTH_COMMAND_BEGIN:
1761 goto_state (auth, &common_state_need_disconnect);
1764 case DBUS_AUTH_COMMAND_ERROR:
1765 return send_rejected (auth);
1767 case DBUS_AUTH_COMMAND_NEGOTIATE_UNIX_FD:
1768 return send_error (auth, "Need to authenticate first");
1770 case DBUS_AUTH_COMMAND_REJECTED:
1771 case DBUS_AUTH_COMMAND_OK:
1772 case DBUS_AUTH_COMMAND_UNKNOWN:
1773 case DBUS_AUTH_COMMAND_AGREE_UNIX_FD:
1775 return send_error (auth, "Unknown command");
1780 handle_server_state_waiting_for_data (DBusAuth *auth,
1781 DBusAuthCommand command,
1782 const DBusString *args)
1786 case DBUS_AUTH_COMMAND_AUTH:
1787 return send_error (auth, "Sent AUTH while another AUTH in progress");
1789 case DBUS_AUTH_COMMAND_CANCEL:
1790 case DBUS_AUTH_COMMAND_ERROR:
1791 return send_rejected (auth);
1793 case DBUS_AUTH_COMMAND_DATA:
1794 return process_data (auth, args, auth->mech->server_data_func);
1796 case DBUS_AUTH_COMMAND_BEGIN:
1797 goto_state (auth, &common_state_need_disconnect);
1800 case DBUS_AUTH_COMMAND_NEGOTIATE_UNIX_FD:
1801 return send_error (auth, "Need to authenticate first");
1803 case DBUS_AUTH_COMMAND_REJECTED:
1804 case DBUS_AUTH_COMMAND_OK:
1805 case DBUS_AUTH_COMMAND_UNKNOWN:
1806 case DBUS_AUTH_COMMAND_AGREE_UNIX_FD:
1808 return send_error (auth, "Unknown command");
1813 handle_server_state_waiting_for_begin (DBusAuth *auth,
1814 DBusAuthCommand command,
1815 const DBusString *args)
1819 case DBUS_AUTH_COMMAND_AUTH:
1820 return send_error (auth, "Sent AUTH while expecting BEGIN");
1822 case DBUS_AUTH_COMMAND_DATA:
1823 return send_error (auth, "Sent DATA while expecting BEGIN");
1825 case DBUS_AUTH_COMMAND_BEGIN:
1826 goto_state (auth, &common_state_authenticated);
1829 case DBUS_AUTH_COMMAND_NEGOTIATE_UNIX_FD:
1830 if (auth->unix_fd_possible)
1831 return send_agree_unix_fd(auth);
1833 return send_error(auth, "Unix FD passing not supported, not authenticated or otherwise not possible");
1835 case DBUS_AUTH_COMMAND_REJECTED:
1836 case DBUS_AUTH_COMMAND_OK:
1837 case DBUS_AUTH_COMMAND_UNKNOWN:
1838 case DBUS_AUTH_COMMAND_AGREE_UNIX_FD:
1840 return send_error (auth, "Unknown command");
1842 case DBUS_AUTH_COMMAND_CANCEL:
1843 case DBUS_AUTH_COMMAND_ERROR:
1844 return send_rejected (auth);
1848 /* return FALSE if no memory, TRUE if all OK */
1850 get_word (const DBusString *str,
1856 _dbus_string_skip_blank (str, *start, start);
1857 _dbus_string_find_blank (str, *start, &i);
1861 if (!_dbus_string_copy_len (str, *start, i - *start, word, 0))
1871 record_mechanisms (DBusAuth *auth,
1872 const DBusString *args)
1877 if (auth->already_got_mechanisms)
1880 len = _dbus_string_get_length (args);
1886 const DBusAuthMechanismHandler *mech;
1888 if (!_dbus_string_init (&m))
1891 if (!get_word (args, &next, &m))
1893 _dbus_string_free (&m);
1897 mech = find_mech (&m, auth->allowed_mechs);
1901 /* FIXME right now we try mechanisms in the order
1902 * the server lists them; should we do them in
1903 * some more deterministic order?
1905 * Probably in all_mechanisms order, our order of
1906 * preference. Of course when the server is us,
1907 * it lists things in that order anyhow.
1910 if (mech != &all_mechanisms[0])
1912 _dbus_verbose ("%s: Adding mechanism %s to list we will try\n",
1913 DBUS_AUTH_NAME (auth), mech->mechanism);
1915 if (!_dbus_list_append (& DBUS_AUTH_CLIENT (auth)->mechs_to_try,
1918 _dbus_string_free (&m);
1924 _dbus_verbose ("%s: Already tried mechanism %s; not adding to list we will try\n",
1925 DBUS_AUTH_NAME (auth), mech->mechanism);
1930 _dbus_verbose ("%s: Server offered mechanism \"%s\" that we don't know how to use\n",
1931 DBUS_AUTH_NAME (auth),
1932 _dbus_string_get_const_data (&m));
1935 _dbus_string_free (&m);
1938 auth->already_got_mechanisms = TRUE;
1943 _dbus_list_clear (& DBUS_AUTH_CLIENT (auth)->mechs_to_try);
1949 process_rejected (DBusAuth *auth, const DBusString *args)
1951 const DBusAuthMechanismHandler *mech;
1952 DBusAuthClient *client;
1954 client = DBUS_AUTH_CLIENT (auth);
1956 if (!auth->already_got_mechanisms)
1958 if (!record_mechanisms (auth, args))
1962 if (DBUS_AUTH_CLIENT (auth)->mechs_to_try != NULL)
1964 mech = client->mechs_to_try->data;
1966 if (!send_auth (auth, mech))
1969 _dbus_list_pop_first (&client->mechs_to_try);
1971 _dbus_verbose ("%s: Trying mechanism %s\n",
1972 DBUS_AUTH_NAME (auth),
1978 _dbus_verbose ("%s: Disconnecting because we are out of mechanisms to try using\n",
1979 DBUS_AUTH_NAME (auth));
1980 goto_state (auth, &common_state_need_disconnect);
1988 handle_client_state_waiting_for_data (DBusAuth *auth,
1989 DBusAuthCommand command,
1990 const DBusString *args)
1992 _dbus_assert (auth->mech != NULL);
1996 case DBUS_AUTH_COMMAND_DATA:
1997 return process_data (auth, args, auth->mech->client_data_func);
1999 case DBUS_AUTH_COMMAND_REJECTED:
2000 return process_rejected (auth, args);
2002 case DBUS_AUTH_COMMAND_OK:
2003 return process_ok(auth, args);
2005 case DBUS_AUTH_COMMAND_ERROR:
2006 return send_cancel (auth);
2008 case DBUS_AUTH_COMMAND_AUTH:
2009 case DBUS_AUTH_COMMAND_CANCEL:
2010 case DBUS_AUTH_COMMAND_BEGIN:
2011 case DBUS_AUTH_COMMAND_UNKNOWN:
2012 case DBUS_AUTH_COMMAND_NEGOTIATE_UNIX_FD:
2013 case DBUS_AUTH_COMMAND_AGREE_UNIX_FD:
2015 return send_error (auth, "Unknown command");
2020 handle_client_state_waiting_for_ok (DBusAuth *auth,
2021 DBusAuthCommand command,
2022 const DBusString *args)
2026 case DBUS_AUTH_COMMAND_REJECTED:
2027 return process_rejected (auth, args);
2029 case DBUS_AUTH_COMMAND_OK:
2030 return process_ok(auth, args);
2032 case DBUS_AUTH_COMMAND_DATA:
2033 case DBUS_AUTH_COMMAND_ERROR:
2034 return send_cancel (auth);
2036 case DBUS_AUTH_COMMAND_AUTH:
2037 case DBUS_AUTH_COMMAND_CANCEL:
2038 case DBUS_AUTH_COMMAND_BEGIN:
2039 case DBUS_AUTH_COMMAND_UNKNOWN:
2040 case DBUS_AUTH_COMMAND_NEGOTIATE_UNIX_FD:
2041 case DBUS_AUTH_COMMAND_AGREE_UNIX_FD:
2043 return send_error (auth, "Unknown command");
2048 handle_client_state_waiting_for_reject (DBusAuth *auth,
2049 DBusAuthCommand command,
2050 const DBusString *args)
2054 case DBUS_AUTH_COMMAND_REJECTED:
2055 return process_rejected (auth, args);
2057 case DBUS_AUTH_COMMAND_AUTH:
2058 case DBUS_AUTH_COMMAND_CANCEL:
2059 case DBUS_AUTH_COMMAND_DATA:
2060 case DBUS_AUTH_COMMAND_BEGIN:
2061 case DBUS_AUTH_COMMAND_OK:
2062 case DBUS_AUTH_COMMAND_ERROR:
2063 case DBUS_AUTH_COMMAND_UNKNOWN:
2064 case DBUS_AUTH_COMMAND_NEGOTIATE_UNIX_FD:
2065 case DBUS_AUTH_COMMAND_AGREE_UNIX_FD:
2067 goto_state (auth, &common_state_need_disconnect);
2073 handle_client_state_waiting_for_agree_unix_fd(DBusAuth *auth,
2074 DBusAuthCommand command,
2075 const DBusString *args)
2079 case DBUS_AUTH_COMMAND_AGREE_UNIX_FD:
2080 _dbus_assert(auth->unix_fd_possible);
2081 auth->unix_fd_negotiated = TRUE;
2082 _dbus_verbose("Sucessfully negotiated UNIX FD passing\n");
2083 return send_begin (auth);
2085 case DBUS_AUTH_COMMAND_ERROR:
2086 _dbus_assert(auth->unix_fd_possible);
2087 auth->unix_fd_negotiated = FALSE;
2088 _dbus_verbose("Failed to negotiate UNIX FD passing\n");
2089 return send_begin (auth);
2091 case DBUS_AUTH_COMMAND_OK:
2092 case DBUS_AUTH_COMMAND_DATA:
2093 case DBUS_AUTH_COMMAND_REJECTED:
2094 case DBUS_AUTH_COMMAND_AUTH:
2095 case DBUS_AUTH_COMMAND_CANCEL:
2096 case DBUS_AUTH_COMMAND_BEGIN:
2097 case DBUS_AUTH_COMMAND_UNKNOWN:
2098 case DBUS_AUTH_COMMAND_NEGOTIATE_UNIX_FD:
2100 return send_error (auth, "Unknown command");
2105 * Mapping from command name to enum
2108 const char *name; /**< Name of the command */
2109 DBusAuthCommand command; /**< Corresponding enum */
2110 } DBusAuthCommandName;
2112 static const DBusAuthCommandName auth_command_names[] = {
2113 { "AUTH", DBUS_AUTH_COMMAND_AUTH },
2114 { "CANCEL", DBUS_AUTH_COMMAND_CANCEL },
2115 { "DATA", DBUS_AUTH_COMMAND_DATA },
2116 { "BEGIN", DBUS_AUTH_COMMAND_BEGIN },
2117 { "REJECTED", DBUS_AUTH_COMMAND_REJECTED },
2118 { "OK", DBUS_AUTH_COMMAND_OK },
2119 { "ERROR", DBUS_AUTH_COMMAND_ERROR },
2120 { "NEGOTIATE_UNIX_FD", DBUS_AUTH_COMMAND_NEGOTIATE_UNIX_FD },
2121 { "AGREE_UNIX_FD", DBUS_AUTH_COMMAND_AGREE_UNIX_FD }
2124 static DBusAuthCommand
2125 lookup_command_from_name (DBusString *command)
2129 for (i = 0; i < _DBUS_N_ELEMENTS (auth_command_names); i++)
2131 if (_dbus_string_equal_c_str (command,
2132 auth_command_names[i].name))
2133 return auth_command_names[i].command;
2136 return DBUS_AUTH_COMMAND_UNKNOWN;
2140 goto_state (DBusAuth *auth,
2141 const DBusAuthStateData *state)
2143 _dbus_verbose ("%s: going from state %s to state %s\n",
2144 DBUS_AUTH_NAME (auth),
2148 auth->state = state;
2151 /* returns whether to call it again right away */
2153 process_command (DBusAuth *auth)
2155 DBusAuthCommand command;
2162 /* _dbus_verbose ("%s: trying process_command()\n"); */
2167 if (!_dbus_string_find (&auth->incoming, 0, "\r\n", &eol))
2170 if (!_dbus_string_init (&line))
2172 auth->needed_memory = TRUE;
2176 if (!_dbus_string_init (&args))
2178 _dbus_string_free (&line);
2179 auth->needed_memory = TRUE;
2183 if (!_dbus_string_copy_len (&auth->incoming, 0, eol, &line, 0))
2186 if (!_dbus_string_validate_ascii (&line, 0,
2187 _dbus_string_get_length (&line)))
2189 _dbus_verbose ("%s: Command contained non-ASCII chars or embedded nul\n",
2190 DBUS_AUTH_NAME (auth));
2191 if (!send_error (auth, "Command contained non-ASCII"))
2197 _dbus_verbose ("%s: got command \"%s\"\n",
2198 DBUS_AUTH_NAME (auth),
2199 _dbus_string_get_const_data (&line));
2201 _dbus_string_find_blank (&line, 0, &i);
2202 _dbus_string_skip_blank (&line, i, &j);
2205 _dbus_string_delete (&line, i, j - i);
2207 if (!_dbus_string_move (&line, i, &args, 0))
2210 /* FIXME 1.0 we should probably validate that only the allowed
2211 * chars are in the command name
2214 command = lookup_command_from_name (&line);
2215 if (!(* auth->state->handler) (auth, command, &args))
2220 /* We've succeeded in processing the whole command so drop it out
2221 * of the incoming buffer and return TRUE to try another command.
2224 _dbus_string_delete (&auth->incoming, 0, eol);
2227 _dbus_string_delete (&auth->incoming, 0, 2);
2232 _dbus_string_free (&args);
2233 _dbus_string_free (&line);
2236 auth->needed_memory = TRUE;
2238 auth->needed_memory = FALSE;
2247 * @addtogroup DBusAuth
2252 * Creates a new auth conversation object for the server side.
2253 * See doc/dbus-sasl-profile.txt for full details on what
2256 * @returns the new object or #NULL if no memory
2259 _dbus_auth_server_new (const DBusString *guid)
2262 DBusAuthServer *server_auth;
2263 DBusString guid_copy;
2265 if (!_dbus_string_init (&guid_copy))
2268 if (!_dbus_string_copy (guid, 0, &guid_copy, 0))
2270 _dbus_string_free (&guid_copy);
2274 auth = _dbus_auth_new (sizeof (DBusAuthServer));
2277 _dbus_string_free (&guid_copy);
2281 auth->side = auth_side_server;
2282 auth->state = &server_state_waiting_for_auth;
2284 server_auth = DBUS_AUTH_SERVER (auth);
2286 server_auth->guid = guid_copy;
2288 /* perhaps this should be per-mechanism with a lower
2291 server_auth->failures = 0;
2292 server_auth->max_failures = 6;
2298 * Creates a new auth conversation object for the client side.
2299 * See doc/dbus-sasl-profile.txt for full details on what
2302 * @returns the new object or #NULL if no memory
2305 _dbus_auth_client_new (void)
2308 DBusString guid_str;
2310 if (!_dbus_string_init (&guid_str))
2313 auth = _dbus_auth_new (sizeof (DBusAuthClient));
2316 _dbus_string_free (&guid_str);
2320 DBUS_AUTH_CLIENT (auth)->guid_from_server = guid_str;
2322 auth->side = auth_side_client;
2323 auth->state = &client_state_need_send_auth;
2325 /* Start the auth conversation by sending AUTH for our default
2327 if (!send_auth (auth, &all_mechanisms[0]))
2329 _dbus_auth_unref (auth);
2337 * Increments the refcount of an auth object.
2339 * @param auth the auth conversation
2340 * @returns the auth conversation
2343 _dbus_auth_ref (DBusAuth *auth)
2345 _dbus_assert (auth != NULL);
2347 auth->refcount += 1;
2353 * Decrements the refcount of an auth object.
2355 * @param auth the auth conversation
2358 _dbus_auth_unref (DBusAuth *auth)
2360 _dbus_assert (auth != NULL);
2361 _dbus_assert (auth->refcount > 0);
2363 auth->refcount -= 1;
2364 if (auth->refcount == 0)
2366 shutdown_mech (auth);
2368 if (DBUS_AUTH_IS_CLIENT (auth))
2370 _dbus_string_free (& DBUS_AUTH_CLIENT (auth)->guid_from_server);
2371 _dbus_list_clear (& DBUS_AUTH_CLIENT (auth)->mechs_to_try);
2375 _dbus_assert (DBUS_AUTH_IS_SERVER (auth));
2377 _dbus_string_free (& DBUS_AUTH_SERVER (auth)->guid);
2381 _dbus_keyring_unref (auth->keyring);
2383 _dbus_string_free (&auth->context);
2384 _dbus_string_free (&auth->challenge);
2385 _dbus_string_free (&auth->identity);
2386 _dbus_string_free (&auth->incoming);
2387 _dbus_string_free (&auth->outgoing);
2389 dbus_free_string_array (auth->allowed_mechs);
2391 _dbus_credentials_unref (auth->credentials);
2392 _dbus_credentials_unref (auth->authorized_identity);
2393 _dbus_credentials_unref (auth->desired_identity);
2400 * Sets an array of authentication mechanism names
2401 * that we are willing to use.
2403 * @param auth the auth conversation
2404 * @param mechanisms #NULL-terminated array of mechanism names
2405 * @returns #FALSE if no memory
2408 _dbus_auth_set_mechanisms (DBusAuth *auth,
2409 const char **mechanisms)
2413 if (mechanisms != NULL)
2415 copy = _dbus_dup_string_array (mechanisms);
2422 dbus_free_string_array (auth->allowed_mechs);
2424 auth->allowed_mechs = copy;
2430 * @param auth the auth conversation object
2431 * @returns #TRUE if we're in a final state
2433 #define DBUS_AUTH_IN_END_STATE(auth) ((auth)->state->handler == NULL)
2436 * Analyzes buffered input and moves the auth conversation forward,
2437 * returning the new state of the auth conversation.
2439 * @param auth the auth conversation
2440 * @returns the new state
2443 _dbus_auth_do_work (DBusAuth *auth)
2445 auth->needed_memory = FALSE;
2447 /* Max amount we'll buffer up before deciding someone's on crack */
2448 #define MAX_BUFFER (16 * _DBUS_ONE_KILOBYTE)
2452 if (DBUS_AUTH_IN_END_STATE (auth))
2455 if (_dbus_string_get_length (&auth->incoming) > MAX_BUFFER ||
2456 _dbus_string_get_length (&auth->outgoing) > MAX_BUFFER)
2458 goto_state (auth, &common_state_need_disconnect);
2459 _dbus_verbose ("%s: Disconnecting due to excessive data buffered in auth phase\n",
2460 DBUS_AUTH_NAME (auth));
2464 while (process_command (auth));
2466 if (auth->needed_memory)
2467 return DBUS_AUTH_STATE_WAITING_FOR_MEMORY;
2468 else if (_dbus_string_get_length (&auth->outgoing) > 0)
2469 return DBUS_AUTH_STATE_HAVE_BYTES_TO_SEND;
2470 else if (auth->state == &common_state_need_disconnect)
2471 return DBUS_AUTH_STATE_NEED_DISCONNECT;
2472 else if (auth->state == &common_state_authenticated)
2473 return DBUS_AUTH_STATE_AUTHENTICATED;
2474 else return DBUS_AUTH_STATE_WAITING_FOR_INPUT;
2478 * Gets bytes that need to be sent to the peer we're conversing with.
2479 * After writing some bytes, _dbus_auth_bytes_sent() must be called
2480 * to notify the auth object that they were written.
2482 * @param auth the auth conversation
2483 * @param str return location for a ref to the buffer to send
2484 * @returns #FALSE if nothing to send
2487 _dbus_auth_get_bytes_to_send (DBusAuth *auth,
2488 const DBusString **str)
2490 _dbus_assert (auth != NULL);
2491 _dbus_assert (str != NULL);
2495 if (_dbus_string_get_length (&auth->outgoing) == 0)
2498 *str = &auth->outgoing;
2504 * Notifies the auth conversation object that
2505 * the given number of bytes of the outgoing buffer
2506 * have been written out.
2508 * @param auth the auth conversation
2509 * @param bytes_sent number of bytes written out
2512 _dbus_auth_bytes_sent (DBusAuth *auth,
2515 _dbus_verbose ("%s: Sent %d bytes of: %s\n",
2516 DBUS_AUTH_NAME (auth),
2518 _dbus_string_get_const_data (&auth->outgoing));
2520 _dbus_string_delete (&auth->outgoing,
2525 * Get a buffer to be used for reading bytes from the peer we're conversing
2526 * with. Bytes should be appended to this buffer.
2528 * @param auth the auth conversation
2529 * @param buffer return location for buffer to append bytes to
2532 _dbus_auth_get_buffer (DBusAuth *auth,
2533 DBusString **buffer)
2535 _dbus_assert (auth != NULL);
2536 _dbus_assert (!auth->buffer_outstanding);
2538 *buffer = &auth->incoming;
2540 auth->buffer_outstanding = TRUE;
2544 * Returns a buffer with new data read into it.
2546 * @param auth the auth conversation
2547 * @param buffer the buffer being returned
2548 * @param bytes_read number of new bytes added
2551 _dbus_auth_return_buffer (DBusAuth *auth,
2555 _dbus_assert (buffer == &auth->incoming);
2556 _dbus_assert (auth->buffer_outstanding);
2558 auth->buffer_outstanding = FALSE;
2562 * Returns leftover bytes that were not used as part of the auth
2563 * conversation. These bytes will be part of the message stream
2564 * instead. This function may not be called until authentication has
2567 * @param auth the auth conversation
2568 * @param str return location for pointer to string of unused bytes
2571 _dbus_auth_get_unused_bytes (DBusAuth *auth,
2572 const DBusString **str)
2574 if (!DBUS_AUTH_IN_END_STATE (auth))
2577 *str = &auth->incoming;
2582 * Gets rid of unused bytes returned by _dbus_auth_get_unused_bytes()
2583 * after we've gotten them and successfully moved them elsewhere.
2585 * @param auth the auth conversation
2588 _dbus_auth_delete_unused_bytes (DBusAuth *auth)
2590 if (!DBUS_AUTH_IN_END_STATE (auth))
2593 _dbus_string_set_length (&auth->incoming, 0);
2597 * Called post-authentication, indicates whether we need to encode
2598 * the message stream with _dbus_auth_encode_data() prior to
2599 * sending it to the peer.
2601 * @param auth the auth conversation
2602 * @returns #TRUE if we need to encode the stream
2605 _dbus_auth_needs_encoding (DBusAuth *auth)
2607 if (auth->state != &common_state_authenticated)
2610 if (auth->mech != NULL)
2612 if (DBUS_AUTH_IS_CLIENT (auth))
2613 return auth->mech->client_encode_func != NULL;
2615 return auth->mech->server_encode_func != NULL;
2622 * Called post-authentication, encodes a block of bytes for sending to
2623 * the peer. If no encoding was negotiated, just copies the bytes
2624 * (you can avoid this by checking _dbus_auth_needs_encoding()).
2626 * @param auth the auth conversation
2627 * @param plaintext the plain text data
2628 * @param encoded initialized string to where encoded data is appended
2629 * @returns #TRUE if we had enough memory and successfully encoded
2632 _dbus_auth_encode_data (DBusAuth *auth,
2633 const DBusString *plaintext,
2634 DBusString *encoded)
2636 _dbus_assert (plaintext != encoded);
2638 if (auth->state != &common_state_authenticated)
2641 if (_dbus_auth_needs_encoding (auth))
2643 if (DBUS_AUTH_IS_CLIENT (auth))
2644 return (* auth->mech->client_encode_func) (auth, plaintext, encoded);
2646 return (* auth->mech->server_encode_func) (auth, plaintext, encoded);
2650 return _dbus_string_copy (plaintext, 0, encoded,
2651 _dbus_string_get_length (encoded));
2656 * Called post-authentication, indicates whether we need to decode
2657 * the message stream with _dbus_auth_decode_data() after
2658 * receiving it from the peer.
2660 * @param auth the auth conversation
2661 * @returns #TRUE if we need to encode the stream
2664 _dbus_auth_needs_decoding (DBusAuth *auth)
2666 if (auth->state != &common_state_authenticated)
2669 if (auth->mech != NULL)
2671 if (DBUS_AUTH_IS_CLIENT (auth))
2672 return auth->mech->client_decode_func != NULL;
2674 return auth->mech->server_decode_func != NULL;
2682 * Called post-authentication, decodes a block of bytes received from
2683 * the peer. If no encoding was negotiated, just copies the bytes (you
2684 * can avoid this by checking _dbus_auth_needs_decoding()).
2686 * @todo 1.0? We need to be able to distinguish "out of memory" error
2687 * from "the data is hosed" error.
2689 * @param auth the auth conversation
2690 * @param encoded the encoded data
2691 * @param plaintext initialized string where decoded data is appended
2692 * @returns #TRUE if we had enough memory and successfully decoded
2695 _dbus_auth_decode_data (DBusAuth *auth,
2696 const DBusString *encoded,
2697 DBusString *plaintext)
2699 _dbus_assert (plaintext != encoded);
2701 if (auth->state != &common_state_authenticated)
2704 if (_dbus_auth_needs_decoding (auth))
2706 if (DBUS_AUTH_IS_CLIENT (auth))
2707 return (* auth->mech->client_decode_func) (auth, encoded, plaintext);
2709 return (* auth->mech->server_decode_func) (auth, encoded, plaintext);
2713 return _dbus_string_copy (encoded, 0, plaintext,
2714 _dbus_string_get_length (plaintext));
2719 * Sets credentials received via reliable means from the operating
2722 * @param auth the auth conversation
2723 * @param credentials the credentials received
2724 * @returns #FALSE on OOM
2727 _dbus_auth_set_credentials (DBusAuth *auth,
2728 DBusCredentials *credentials)
2730 _dbus_credentials_clear (auth->credentials);
2731 return _dbus_credentials_add_credentials (auth->credentials,
2736 * Gets the identity we authorized the client as. Apps may have
2737 * different policies as to what identities they allow.
2739 * Returned credentials are not a copy and should not be modified
2741 * @param auth the auth conversation
2742 * @returns the credentials we've authorized BY REFERENCE do not modify
2745 _dbus_auth_get_identity (DBusAuth *auth)
2747 if (auth->state == &common_state_authenticated)
2749 return auth->authorized_identity;
2753 /* FIXME instead of this, keep an empty credential around that
2754 * doesn't require allocation or something
2756 /* return empty credentials */
2757 _dbus_assert (_dbus_credentials_are_empty (auth->authorized_identity));
2758 return auth->authorized_identity;
2763 * Gets the GUID from the server if we've authenticated; gets
2765 * @param auth the auth object
2766 * @returns the GUID in ASCII hex format
2769 _dbus_auth_get_guid_from_server (DBusAuth *auth)
2771 _dbus_assert (DBUS_AUTH_IS_CLIENT (auth));
2773 if (auth->state == &common_state_authenticated)
2774 return _dbus_string_get_const_data (& DBUS_AUTH_CLIENT (auth)->guid_from_server);
2780 * Sets the "authentication context" which scopes cookies
2781 * with the DBUS_COOKIE_SHA1 auth mechanism for example.
2783 * @param auth the auth conversation
2784 * @param context the context
2785 * @returns #FALSE if no memory
2788 _dbus_auth_set_context (DBusAuth *auth,
2789 const DBusString *context)
2791 return _dbus_string_replace_len (context, 0, _dbus_string_get_length (context),
2792 &auth->context, 0, _dbus_string_get_length (context));
2796 * Sets whether unix fd passing is potentially on the transport and
2797 * hence shall be negotiated.
2799 * @param auth the auth conversation
2800 * @param b TRUE when unix fd passing shall be negotiated, otherwise FALSE
2803 _dbus_auth_set_unix_fd_possible(DBusAuth *auth, dbus_bool_t b)
2805 auth->unix_fd_possible = b;
2809 * Queries whether unix fd passing was sucessfully negotiated.
2811 * @param auth the auth conversion
2812 * @returns #TRUE when unix fd passing was negotiated.
2815 _dbus_auth_get_unix_fd_negotiated(DBusAuth *auth)
2817 return auth->unix_fd_negotiated;
2822 /* tests in dbus-auth-util.c */