1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-auth.c Authentication
4 * Copyright (C) 2002, 2003 Red Hat Inc.
6 * Licensed under the Academic Free License version 1.2
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
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"
30 /* See doc/dbus-sasl-profile.txt */
33 * @defgroup DBusAuth Authentication
34 * @ingroup DBusInternals
35 * @brief DBusAuth object
37 * DBusAuth manages the authentication negotiation when a connection
38 * is first established, and also manage any encryption used over a
41 * The file doc/dbus-sasl-profile.txt documents the network protocol
42 * used for authentication.
44 * @todo some SASL profiles require sending the empty string as a
45 * challenge/response, but we don't currently allow that in our
48 * @todo DBusAuth really needs to be rewritten as an explicit state
49 * machine. Right now it's too hard to prove to yourself by inspection
52 * @todo right now sometimes both ends will block waiting for input
53 * from the other end, e.g. if there's an error during
56 * @todo the cookie keyring needs to be cached globally not just
57 * per-auth (which raises threadsafety issues too)
59 * @todo grep FIXME in dbus-auth.c
63 * @defgroup DBusAuthInternals Authentication implementation details
64 * @ingroup DBusInternals
65 * @brief DBusAuth implementation details
67 * Private details of authentication code.
73 * Processes a command. Returns whether we had enough memory to
74 * complete the operation.
76 typedef dbus_bool_t (* DBusProcessAuthCommandFunction) (DBusAuth *auth,
77 const DBusString *command,
78 const DBusString *args);
83 DBusProcessAuthCommandFunction func;
84 } DBusAuthCommandHandler;
87 * This function appends an initial client response to the given string
89 typedef dbus_bool_t (* DBusInitialResponseFunction) (DBusAuth *auth,
90 DBusString *response);
93 * This function processes a block of data received from the peer.
94 * i.e. handles a DATA command.
96 typedef dbus_bool_t (* DBusAuthDataFunction) (DBusAuth *auth,
97 const DBusString *data);
100 * This function encodes a block of data from the peer.
102 typedef dbus_bool_t (* DBusAuthEncodeFunction) (DBusAuth *auth,
103 const DBusString *data,
104 DBusString *encoded);
107 * This function decodes a block of data from the peer.
109 typedef dbus_bool_t (* DBusAuthDecodeFunction) (DBusAuth *auth,
110 const DBusString *data,
111 DBusString *decoded);
114 * This function is called when the mechanism is abandoned.
116 typedef void (* DBusAuthShutdownFunction) (DBusAuth *auth);
120 const char *mechanism;
121 DBusAuthDataFunction server_data_func;
122 DBusAuthEncodeFunction server_encode_func;
123 DBusAuthDecodeFunction server_decode_func;
124 DBusAuthShutdownFunction server_shutdown_func;
125 DBusInitialResponseFunction client_initial_response_func;
126 DBusAuthDataFunction client_data_func;
127 DBusAuthEncodeFunction client_encode_func;
128 DBusAuthDecodeFunction client_decode_func;
129 DBusAuthShutdownFunction client_shutdown_func;
130 } DBusAuthMechanismHandler;
133 * Internal members of DBusAuth.
137 int refcount; /**< reference count */
139 DBusString incoming; /**< Incoming data buffer */
140 DBusString outgoing; /**< Outgoing data buffer */
142 const DBusAuthCommandHandler *handlers; /**< Handlers for commands */
144 const DBusAuthMechanismHandler *mech; /**< Current auth mechanism */
146 DBusString identity; /**< Current identity we're authorizing
150 DBusCredentials credentials; /**< Credentials read from socket,
154 DBusCredentials authorized_identity; /**< Credentials that are authorized */
156 DBusCredentials desired_identity; /**< Identity client has requested */
158 DBusString context; /**< Cookie scope */
159 DBusKeyring *keyring; /**< Keyring for cookie mechanism. */
160 int cookie_id; /**< ID of cookie to use */
161 DBusString challenge; /**< Challenge sent to client */
163 unsigned int needed_memory : 1; /**< We needed memory to continue since last
164 * successful getting something done
166 unsigned int need_disconnect : 1; /**< We've given up, time to disconnect */
167 unsigned int authenticated : 1; /**< We are authenticated */
168 unsigned int authenticated_pending_output : 1; /**< Authenticated once we clear outgoing buffer */
169 unsigned int authenticated_pending_begin : 1; /**< Authenticated once we get BEGIN */
170 unsigned int already_got_mechanisms : 1; /**< Client already got mech list */
171 unsigned int already_asked_for_initial_response : 1; /**< Already sent a blank challenge to get an initial response */
178 DBusList *mechs_to_try; /**< Mechanisms we got from the server that we're going to try using */
186 int failures; /**< Number of times client has been rejected */
187 int max_failures; /**< Number of times we reject before disconnect */
191 static dbus_bool_t process_auth (DBusAuth *auth,
192 const DBusString *command,
193 const DBusString *args);
194 static dbus_bool_t process_cancel (DBusAuth *auth,
195 const DBusString *command,
196 const DBusString *args);
197 static dbus_bool_t process_begin (DBusAuth *auth,
198 const DBusString *command,
199 const DBusString *args);
200 static dbus_bool_t process_data_server (DBusAuth *auth,
201 const DBusString *command,
202 const DBusString *args);
203 static dbus_bool_t process_error_server (DBusAuth *auth,
204 const DBusString *command,
205 const DBusString *args);
206 static dbus_bool_t process_rejected (DBusAuth *auth,
207 const DBusString *command,
208 const DBusString *args);
209 static dbus_bool_t process_ok (DBusAuth *auth,
210 const DBusString *command,
211 const DBusString *args);
212 static dbus_bool_t process_data_client (DBusAuth *auth,
213 const DBusString *command,
214 const DBusString *args);
215 static dbus_bool_t process_error_client (DBusAuth *auth,
216 const DBusString *command,
217 const DBusString *args);
220 static dbus_bool_t client_try_next_mechanism (DBusAuth *auth);
221 static dbus_bool_t send_rejected (DBusAuth *auth);
223 static DBusAuthCommandHandler
224 server_handlers[] = {
225 { "AUTH", process_auth },
226 { "CANCEL", process_cancel },
227 { "BEGIN", process_begin },
228 { "DATA", process_data_server },
229 { "ERROR", process_error_server },
233 static DBusAuthCommandHandler
234 client_handlers[] = {
235 { "REJECTED", process_rejected },
236 { "OK", process_ok },
237 { "DATA", process_data_client },
238 { "ERROR", process_error_client },
243 * @param auth the auth conversation
244 * @returns #TRUE if the conversation is the server side
246 #define DBUS_AUTH_IS_SERVER(auth) ((auth)->handlers == server_handlers)
248 * @param auth the auth conversation
249 * @returns #TRUE if the conversation is the client side
251 #define DBUS_AUTH_IS_CLIENT(auth) ((auth)->handlers == client_handlers)
253 * @param auth the auth conversation
254 * @returns auth cast to DBusAuthClient
256 #define DBUS_AUTH_CLIENT(auth) ((DBusAuthClient*)(auth))
258 * @param auth the auth conversation
259 * @returns auth cast to DBusAuthServer
261 #define DBUS_AUTH_SERVER(auth) ((DBusAuthServer*)(auth))
264 _dbus_auth_new (int size)
268 auth = dbus_malloc0 (size);
274 auth->credentials.pid = -1;
275 auth->credentials.uid = -1;
276 auth->credentials.gid = -1;
278 auth->authorized_identity.pid = -1;
279 auth->authorized_identity.uid = -1;
280 auth->authorized_identity.gid = -1;
282 auth->desired_identity.pid = -1;
283 auth->desired_identity.uid = -1;
284 auth->desired_identity.gid = -1;
286 auth->keyring = NULL;
287 auth->cookie_id = -1;
289 /* note that we don't use the max string length feature,
290 * because you can't use that feature if you're going to
291 * try to recover from out-of-memory (it creates
292 * what looks like unrecoverable inability to alloc
293 * more space in the string). But we do handle
294 * overlong buffers in _dbus_auth_do_work().
297 if (!_dbus_string_init (&auth->incoming, _DBUS_INT_MAX))
300 if (!_dbus_string_init (&auth->outgoing, _DBUS_INT_MAX))
303 if (!_dbus_string_init (&auth->identity, _DBUS_INT_MAX))
306 if (!_dbus_string_init (&auth->context, _DBUS_INT_MAX))
309 if (!_dbus_string_init (&auth->challenge, _DBUS_INT_MAX))
312 /* default context if none is specified */
313 if (!_dbus_string_append (&auth->context, "org_freedesktop_general"))
319 _dbus_string_free (&auth->challenge);
321 _dbus_string_free (&auth->context);
323 _dbus_string_free (&auth->identity);
325 _dbus_string_free (&auth->incoming);
327 _dbus_string_free (&auth->outgoing);
334 shutdown_mech (DBusAuth *auth)
336 /* Cancel any auth */
337 auth->authenticated_pending_begin = FALSE;
338 auth->authenticated = FALSE;
339 auth->already_asked_for_initial_response = FALSE;
340 _dbus_string_set_length (&auth->identity, 0);
342 auth->authorized_identity.pid = -1;
343 auth->authorized_identity.uid = -1;
344 auth->authorized_identity.gid = -1;
346 auth->desired_identity.pid = -1;
347 auth->desired_identity.uid = -1;
348 auth->desired_identity.gid = -1;
350 if (auth->mech != NULL)
352 _dbus_verbose ("Shutting down mechanism %s\n",
353 auth->mech->mechanism);
355 if (DBUS_AUTH_IS_CLIENT (auth))
356 (* auth->mech->client_shutdown_func) (auth);
358 (* auth->mech->server_shutdown_func) (auth);
364 /* Returns TRUE but with an empty string hash if the
365 * cookie_id isn't known. As with all this code
366 * TRUE just means we had enough memory.
369 sha1_compute_hash (DBusAuth *auth,
371 const DBusString *server_challenge,
372 const DBusString *client_challenge,
379 _dbus_assert (auth->keyring != NULL);
383 if (!_dbus_string_init (&cookie, _DBUS_INT_MAX))
386 if (!_dbus_keyring_get_hex_key (auth->keyring, cookie_id,
390 if (_dbus_string_get_length (&cookie) == 0)
396 if (!_dbus_string_init (&to_hash, _DBUS_INT_MAX))
399 if (!_dbus_string_copy (server_challenge, 0,
400 &to_hash, _dbus_string_get_length (&to_hash)))
403 if (!_dbus_string_append (&to_hash, ":"))
406 if (!_dbus_string_copy (client_challenge, 0,
407 &to_hash, _dbus_string_get_length (&to_hash)))
410 if (!_dbus_string_append (&to_hash, ":"))
413 if (!_dbus_string_copy (&cookie, 0,
414 &to_hash, _dbus_string_get_length (&to_hash)))
417 if (!_dbus_sha_compute (&to_hash, hash))
423 _dbus_string_zero (&to_hash);
424 _dbus_string_free (&to_hash);
426 _dbus_string_zero (&cookie);
427 _dbus_string_free (&cookie);
431 /* http://www.ietf.org/rfc/rfc2831.txt suggests at least 64 bits of
432 * entropy, we use 128
434 #define N_CHALLENGE_BYTES (128/8)
437 sha1_handle_first_client_response (DBusAuth *auth,
438 const DBusString *data)
440 /* We haven't sent a challenge yet, we're expecting a desired
441 * username from the client.
451 _dbus_string_set_length (&auth->challenge, 0);
453 if (_dbus_string_get_length (data) > 0)
455 if (_dbus_string_get_length (&auth->identity) > 0)
457 /* Tried to send two auth identities, wtf */
458 _dbus_verbose ("client tried to send auth identity, but we already have one\n");
459 return send_rejected (auth);
463 /* this is our auth identity */
464 if (!_dbus_string_copy (data, 0, &auth->identity, 0))
469 if (!_dbus_credentials_from_username (data, &auth->desired_identity))
471 _dbus_verbose ("Did not get a valid username from client\n");
472 return send_rejected (auth);
475 if (!_dbus_string_init (&tmp, _DBUS_INT_MAX))
478 if (!_dbus_string_init (&tmp2, _DBUS_INT_MAX))
480 _dbus_string_free (&tmp);
484 old_len = _dbus_string_get_length (&auth->outgoing);
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.
491 !_dbus_keyring_is_for_user (auth->keyring,
494 _dbus_keyring_unref (auth->keyring);
495 auth->keyring = NULL;
498 if (auth->keyring == NULL)
502 dbus_error_init (&error);
503 auth->keyring = _dbus_keyring_new_homedir (data,
507 if (auth->keyring == NULL)
509 if (dbus_error_has_name (&error,
510 DBUS_ERROR_NO_MEMORY))
512 dbus_error_free (&error);
517 _dbus_assert (dbus_error_is_set (&error));
518 _dbus_verbose ("Error loading keyring: %s\n",
520 if (send_rejected (auth))
521 retval = TRUE; /* retval is only about mem */
522 dbus_error_free (&error);
528 _dbus_assert (!dbus_error_is_set (&error));
532 _dbus_assert (auth->keyring != NULL);
534 dbus_error_init (&error);
535 auth->cookie_id = _dbus_keyring_get_best_key (auth->keyring, &error);
536 if (auth->cookie_id < 0)
538 _dbus_assert (dbus_error_is_set (&error));
539 _dbus_verbose ("Could not get a cookie ID to send to client: %s\n",
541 if (send_rejected (auth))
543 dbus_error_free (&error);
548 _dbus_assert (!dbus_error_is_set (&error));
551 if (!_dbus_string_copy (&auth->context, 0,
552 &tmp2, _dbus_string_get_length (&tmp2)))
555 if (!_dbus_string_append (&tmp2, " "))
558 if (!_dbus_string_append_int (&tmp2, auth->cookie_id))
561 if (!_dbus_string_append (&tmp2, " "))
564 if (!_dbus_generate_random_bytes (&tmp, N_CHALLENGE_BYTES))
567 _dbus_string_set_length (&auth->challenge, 0);
568 if (!_dbus_string_hex_encode (&tmp, 0, &auth->challenge, 0))
571 if (!_dbus_string_hex_encode (&tmp, 0, &tmp2,
572 _dbus_string_get_length (&tmp2)))
575 if (!_dbus_string_append (&auth->outgoing,
579 if (!_dbus_string_base64_encode (&tmp2, 0, &auth->outgoing,
580 _dbus_string_get_length (&auth->outgoing)))
583 if (!_dbus_string_append (&auth->outgoing,
590 _dbus_string_zero (&tmp);
591 _dbus_string_free (&tmp);
592 _dbus_string_zero (&tmp2);
593 _dbus_string_free (&tmp2);
595 _dbus_string_set_length (&auth->outgoing, old_len);
600 sha1_handle_second_client_response (DBusAuth *auth,
601 const DBusString *data)
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
609 DBusString client_challenge;
610 DBusString client_hash;
612 DBusString correct_hash;
616 if (!_dbus_string_find_blank (data, 0, &i))
618 _dbus_verbose ("no space separator in client response\n");
619 return send_rejected (auth);
622 if (!_dbus_string_init (&client_challenge, _DBUS_INT_MAX))
625 if (!_dbus_string_init (&client_hash, _DBUS_INT_MAX))
628 if (!_dbus_string_copy_len (data, 0, i, &client_challenge,
632 _dbus_string_skip_blank (data, i, &i);
634 if (!_dbus_string_copy_len (data, i,
635 _dbus_string_get_length (data) - i,
640 if (_dbus_string_get_length (&client_challenge) == 0 ||
641 _dbus_string_get_length (&client_hash) == 0)
643 _dbus_verbose ("zero-length client challenge or hash\n");
644 if (send_rejected (auth))
649 if (!_dbus_string_init (&correct_hash, _DBUS_INT_MAX))
652 if (!sha1_compute_hash (auth, auth->cookie_id,
658 /* if cookie_id was invalid, then we get an empty hash */
659 if (_dbus_string_get_length (&correct_hash) == 0)
661 if (send_rejected (auth))
666 if (!_dbus_string_equal (&client_hash, &correct_hash))
668 if (send_rejected (auth))
673 if (!_dbus_string_append (&auth->outgoing,
677 _dbus_verbose ("authenticated client with UID %d using DBUS_COOKIE_SHA1\n",
678 auth->desired_identity.uid);
680 auth->authorized_identity = auth->desired_identity;
681 auth->authenticated_pending_begin = TRUE;
685 _dbus_string_zero (&correct_hash);
686 _dbus_string_free (&correct_hash);
688 _dbus_string_zero (&client_hash);
689 _dbus_string_free (&client_hash);
691 _dbus_string_free (&client_challenge);
697 handle_server_data_cookie_sha1_mech (DBusAuth *auth,
698 const DBusString *data)
700 if (auth->cookie_id < 0)
701 return sha1_handle_first_client_response (auth, data);
703 return sha1_handle_second_client_response (auth, data);
707 handle_server_shutdown_cookie_sha1_mech (DBusAuth *auth)
709 auth->cookie_id = -1;
710 _dbus_string_set_length (&auth->challenge, 0);
714 handle_client_initial_response_cookie_sha1_mech (DBusAuth *auth,
715 DBusString *response)
717 const DBusString *username;
722 if (!_dbus_user_info_from_current_process (&username,
726 if (!_dbus_string_base64_encode (username, 0,
728 _dbus_string_get_length (response)))
737 /* FIXME if we send the server an error, right now both sides
738 * just hang. Server has to reject on getting an error, or
739 * client has to cancel. Should be in the spec.
742 handle_client_data_cookie_sha1_mech (DBusAuth *auth,
743 const DBusString *data)
745 /* The data we get from the server should be the cookie context
746 * name, the cookie ID, and the server challenge, separated by
747 * spaces. We send back our challenge string and the correct hash.
751 DBusString cookie_id_str;
752 DBusString server_challenge;
753 DBusString client_challenge;
754 DBusString correct_hash;
762 if (!_dbus_string_find_blank (data, 0, &i))
764 if (_dbus_string_append (&auth->outgoing,
765 "ERROR \"Server did not send context/ID/challenge properly\"\r\n"))
770 if (!_dbus_string_init (&context, _DBUS_INT_MAX))
773 if (!_dbus_string_copy_len (data, 0, i,
777 _dbus_string_skip_blank (data, i, &i);
778 if (!_dbus_string_find_blank (data, i, &j))
780 if (_dbus_string_append (&auth->outgoing,
781 "ERROR \"Server did not send context/ID/challenge properly\"\r\n"))
786 if (!_dbus_string_init (&cookie_id_str, _DBUS_INT_MAX))
789 if (!_dbus_string_copy_len (data, i, j - i,
793 if (!_dbus_string_init (&server_challenge, _DBUS_INT_MAX))
797 _dbus_string_skip_blank (data, i, &i);
798 j = _dbus_string_get_length (data);
800 if (!_dbus_string_copy_len (data, i, j - i,
801 &server_challenge, 0))
804 if (!_dbus_keyring_validate_context (&context))
806 if (_dbus_string_append (&auth->outgoing,
807 "ERROR \"Server sent invalid cookie context\"\r\n"))
812 if (!_dbus_string_parse_int (&cookie_id_str, 0, &val, NULL))
814 if (_dbus_string_append (&auth->outgoing,
815 "ERROR \"Could not parse cookie ID as an integer\"\r\n"))
820 if (_dbus_string_get_length (&server_challenge) == 0)
822 if (_dbus_string_append (&auth->outgoing,
823 "ERROR \"Empty server challenge string\"\r\n"))
828 if (auth->keyring == NULL)
832 dbus_error_init (&error);
833 auth->keyring = _dbus_keyring_new_homedir (NULL,
837 if (auth->keyring == NULL)
839 if (dbus_error_has_name (&error,
840 DBUS_ERROR_NO_MEMORY))
842 dbus_error_free (&error);
847 _dbus_assert (dbus_error_is_set (&error));
848 _dbus_verbose ("Error loading keyring: %s\n",
851 if (_dbus_string_append (&auth->outgoing,
852 "ERROR \"Could not load cookie file\"\r\n"))
853 retval = TRUE; /* retval is only about mem */
855 dbus_error_free (&error);
861 _dbus_assert (!dbus_error_is_set (&error));
865 _dbus_assert (auth->keyring != NULL);
867 if (!_dbus_string_init (&tmp, _DBUS_INT_MAX))
870 if (!_dbus_generate_random_bytes (&tmp, N_CHALLENGE_BYTES))
873 if (!_dbus_string_init (&client_challenge, _DBUS_INT_MAX))
876 if (!_dbus_string_hex_encode (&tmp, 0, &client_challenge, 0))
879 if (!_dbus_string_init (&correct_hash, _DBUS_INT_MAX))
882 if (!sha1_compute_hash (auth, val,
888 if (_dbus_string_get_length (&correct_hash) == 0)
890 /* couldn't find the cookie ID or something */
891 if (_dbus_string_append (&auth->outgoing,
892 "ERROR \"Don't have the requested cookie ID\"\r\n"))
897 _dbus_string_set_length (&tmp, 0);
899 if (!_dbus_string_copy (&client_challenge, 0, &tmp,
900 _dbus_string_get_length (&tmp)))
903 if (!_dbus_string_append (&tmp, " "))
906 if (!_dbus_string_copy (&correct_hash, 0, &tmp,
907 _dbus_string_get_length (&tmp)))
910 old_len = _dbus_string_get_length (&auth->outgoing);
911 if (!_dbus_string_append (&auth->outgoing, "DATA "))
914 if (!_dbus_string_base64_encode (&tmp, 0,
916 _dbus_string_get_length (&auth->outgoing)))
918 _dbus_string_set_length (&auth->outgoing, old_len);
922 if (!_dbus_string_append (&auth->outgoing, "\r\n"))
924 _dbus_string_set_length (&auth->outgoing, old_len);
931 _dbus_string_zero (&correct_hash);
932 _dbus_string_free (&correct_hash);
934 _dbus_string_free (&client_challenge);
936 _dbus_string_zero (&tmp);
937 _dbus_string_free (&tmp);
939 _dbus_string_free (&server_challenge);
941 _dbus_string_free (&cookie_id_str);
943 _dbus_string_free (&context);
949 handle_client_shutdown_cookie_sha1_mech (DBusAuth *auth)
951 auth->cookie_id = -1;
952 _dbus_string_set_length (&auth->challenge, 0);
956 handle_server_data_external_mech (DBusAuth *auth,
957 const DBusString *data)
959 if (auth->credentials.uid < 0)
961 _dbus_verbose ("no credentials, mechanism EXTERNAL can't authenticate\n");
962 return send_rejected (auth);
965 if (_dbus_string_get_length (data) > 0)
967 if (_dbus_string_get_length (&auth->identity) > 0)
969 /* Tried to send two auth identities, wtf */
970 _dbus_verbose ("client tried to send auth identity, but we already have one\n");
971 return send_rejected (auth);
975 /* this is our auth identity */
976 if (!_dbus_string_copy (data, 0, &auth->identity, 0))
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)
985 if (_dbus_string_append (&auth->outgoing,
988 _dbus_verbose ("sending empty challenge asking client for auth identity\n");
989 auth->already_asked_for_initial_response = TRUE;
996 auth->desired_identity.pid = -1;
997 auth->desired_identity.uid = -1;
998 auth->desired_identity.gid = -1;
1000 /* If auth->identity is still empty here, then client
1001 * responded with an empty string after we poked it for
1002 * an initial response. This means to try to auth the
1003 * identity provided in the credentials.
1005 if (_dbus_string_get_length (&auth->identity) == 0)
1007 auth->desired_identity.uid = auth->credentials.uid;
1011 if (!_dbus_credentials_from_uid_string (&auth->identity,
1012 &auth->desired_identity))
1014 _dbus_verbose ("could not get credentials from uid string\n");
1015 return send_rejected (auth);
1019 if (auth->desired_identity.uid < 0)
1021 _dbus_verbose ("desired UID %d is no good\n", auth->desired_identity.uid);
1022 return send_rejected (auth);
1025 if (_dbus_credentials_match (&auth->desired_identity,
1026 &auth->credentials))
1028 /* client has authenticated */
1029 if (!_dbus_string_append (&auth->outgoing,
1033 _dbus_verbose ("authenticated client with UID %d matching socket credentials UID %d\n",
1034 auth->desired_identity.uid,
1035 auth->credentials.uid);
1037 auth->authorized_identity.uid = auth->desired_identity.uid;
1039 auth->authenticated_pending_begin = TRUE;
1045 _dbus_verbose ("credentials uid=%d gid=%d do not allow uid=%d gid=%d\n",
1046 auth->credentials.uid, auth->credentials.gid,
1047 auth->desired_identity.uid, auth->desired_identity.gid);
1048 return send_rejected (auth);
1053 handle_server_shutdown_external_mech (DBusAuth *auth)
1059 handle_client_initial_response_external_mech (DBusAuth *auth,
1060 DBusString *response)
1062 /* We always append our UID as an initial response, so the server
1063 * doesn't have to send back an empty challenge to check whether we
1064 * want to specify an identity. i.e. this avoids a round trip that
1065 * the spec for the EXTERNAL mechanism otherwise requires.
1067 DBusString plaintext;
1069 if (!_dbus_string_init (&plaintext, _DBUS_INT_MAX))
1072 if (!_dbus_string_append_our_uid (&plaintext))
1075 if (!_dbus_string_base64_encode (&plaintext, 0,
1077 _dbus_string_get_length (response)))
1080 _dbus_string_free (&plaintext);
1085 _dbus_string_free (&plaintext);
1090 handle_client_data_external_mech (DBusAuth *auth,
1091 const DBusString *data)
1098 handle_client_shutdown_external_mech (DBusAuth *auth)
1103 /* Put mechanisms here in order of preference.
1104 * What I eventually want to have is:
1106 * - a mechanism that checks UNIX domain socket credentials
1107 * - a simple magic cookie mechanism like X11 or ICE
1108 * - mechanisms that chain to Cyrus SASL, so we can use anything it
1109 * offers such as Kerberos, X509, whatever.
1112 static const DBusAuthMechanismHandler
1113 all_mechanisms[] = {
1115 handle_server_data_external_mech,
1117 handle_server_shutdown_external_mech,
1118 handle_client_initial_response_external_mech,
1119 handle_client_data_external_mech,
1121 handle_client_shutdown_external_mech },
1122 { "DBUS_COOKIE_SHA1",
1123 handle_server_data_cookie_sha1_mech,
1125 handle_server_shutdown_cookie_sha1_mech,
1126 handle_client_initial_response_cookie_sha1_mech,
1127 handle_client_data_cookie_sha1_mech,
1129 handle_client_shutdown_cookie_sha1_mech },
1133 static const DBusAuthMechanismHandler*
1134 find_mech (const DBusString *name)
1139 while (all_mechanisms[i].mechanism != NULL)
1141 if (_dbus_string_equal_c_str (name,
1142 all_mechanisms[i].mechanism))
1144 return &all_mechanisms[i];
1153 send_rejected (DBusAuth *auth)
1156 DBusAuthServer *server_auth;
1159 if (!_dbus_string_init (&command, _DBUS_INT_MAX))
1162 if (!_dbus_string_append (&command,
1167 while (all_mechanisms[i].mechanism != NULL)
1169 if (!_dbus_string_append (&command,
1173 if (!_dbus_string_append (&command,
1174 all_mechanisms[i].mechanism))
1180 if (!_dbus_string_append (&command, "\r\n"))
1183 if (!_dbus_string_copy (&command, 0, &auth->outgoing,
1184 _dbus_string_get_length (&auth->outgoing)))
1187 shutdown_mech (auth);
1189 _dbus_assert (DBUS_AUTH_IS_SERVER (auth));
1190 server_auth = DBUS_AUTH_SERVER (auth);
1191 server_auth->failures += 1;
1193 _dbus_string_free (&command);
1198 _dbus_string_free (&command);
1203 process_auth (DBusAuth *auth,
1204 const DBusString *command,
1205 const DBusString *args)
1209 /* We are already using a mechanism, client is on crack */
1210 if (!_dbus_string_append (&auth->outgoing,
1211 "ERROR \"Sent AUTH while another AUTH in progress\"\r\n"))
1216 else if (_dbus_string_get_length (args) == 0)
1218 /* No args to the auth, send mechanisms */
1219 if (!send_rejected (auth))
1228 DBusString base64_response;
1229 DBusString decoded_response;
1231 _dbus_string_find_blank (args, 0, &i);
1233 if (!_dbus_string_init (&mech, _DBUS_INT_MAX))
1236 if (!_dbus_string_init (&base64_response, _DBUS_INT_MAX))
1238 _dbus_string_free (&mech);
1242 if (!_dbus_string_init (&decoded_response, _DBUS_INT_MAX))
1244 _dbus_string_free (&mech);
1245 _dbus_string_free (&base64_response);
1249 if (!_dbus_string_copy_len (args, 0, i, &mech, 0))
1252 if (!_dbus_string_copy (args, i, &base64_response, 0))
1255 if (!_dbus_string_base64_decode (&base64_response, 0,
1256 &decoded_response, 0))
1259 auth->mech = find_mech (&mech);
1260 if (auth->mech != NULL)
1262 _dbus_verbose ("Trying mechanism %s with initial response of %d bytes\n",
1263 auth->mech->mechanism,
1264 _dbus_string_get_length (&decoded_response));
1266 if (!(* auth->mech->server_data_func) (auth,
1272 /* Unsupported mechanism */
1273 if (!send_rejected (auth))
1277 _dbus_string_free (&mech);
1278 _dbus_string_free (&base64_response);
1279 _dbus_string_free (&decoded_response);
1285 _dbus_string_free (&mech);
1286 _dbus_string_free (&base64_response);
1287 _dbus_string_free (&decoded_response);
1293 process_cancel (DBusAuth *auth,
1294 const DBusString *command,
1295 const DBusString *args)
1297 shutdown_mech (auth);
1303 process_begin (DBusAuth *auth,
1304 const DBusString *command,
1305 const DBusString *args)
1307 if (auth->authenticated_pending_begin)
1308 auth->authenticated = TRUE;
1311 auth->need_disconnect = TRUE; /* client trying to send data before auth,
1314 shutdown_mech (auth);
1321 process_data_server (DBusAuth *auth,
1322 const DBusString *command,
1323 const DBusString *args)
1325 if (auth->mech != NULL)
1329 if (!_dbus_string_init (&decoded, _DBUS_INT_MAX))
1332 if (!_dbus_string_base64_decode (args, 0, &decoded, 0))
1334 _dbus_string_free (&decoded);
1338 #ifdef DBUS_ENABLE_VERBOSE_MODE
1339 if (_dbus_string_validate_ascii (&decoded, 0,
1340 _dbus_string_get_length (&decoded)))
1343 _dbus_string_get_const_data (&decoded, &s);
1344 _dbus_verbose ("data: '%s'\n", s);
1348 if (!(* auth->mech->server_data_func) (auth, &decoded))
1350 _dbus_string_free (&decoded);
1354 _dbus_string_free (&decoded);
1358 if (!_dbus_string_append (&auth->outgoing,
1359 "ERROR \"Not currently in an auth conversation\"\r\n"))
1367 process_error_server (DBusAuth *auth,
1368 const DBusString *command,
1369 const DBusString *args)
1375 /* return FALSE if no memory, TRUE if all OK */
1377 get_word (const DBusString *str,
1383 _dbus_string_skip_blank (str, *start, start);
1384 _dbus_string_find_blank (str, *start, &i);
1388 if (!_dbus_string_copy_len (str, *start, i - *start, word, 0))
1398 record_mechanisms (DBusAuth *auth,
1399 const DBusString *command,
1400 const DBusString *args)
1405 if (auth->already_got_mechanisms)
1408 len = _dbus_string_get_length (args);
1414 const DBusAuthMechanismHandler *mech;
1416 if (!_dbus_string_init (&m, _DBUS_INT_MAX))
1419 if (!get_word (args, &next, &m))
1422 mech = find_mech (&m);
1426 /* FIXME right now we try mechanisms in the order
1427 * the server lists them; should we do them in
1428 * some more deterministic order?
1430 * Probably in all_mechanisms order, our order of
1431 * preference. Of course when the server is us,
1432 * it lists things in that order anyhow.
1435 _dbus_verbose ("Adding mechanism %s to list we will try\n",
1438 if (!_dbus_list_append (& DBUS_AUTH_CLIENT (auth)->mechs_to_try,
1446 _dbus_string_get_const_data (&m, &s);
1447 _dbus_verbose ("Server offered mechanism \"%s\" that we don't know how to use\n",
1451 _dbus_string_free (&m);
1454 auth->already_got_mechanisms = TRUE;
1459 _dbus_list_clear (& DBUS_AUTH_CLIENT (auth)->mechs_to_try);
1465 client_try_next_mechanism (DBusAuth *auth)
1467 const DBusAuthMechanismHandler *mech;
1468 DBusString auth_command;
1470 if (DBUS_AUTH_CLIENT (auth)->mechs_to_try == NULL)
1473 mech = DBUS_AUTH_CLIENT (auth)->mechs_to_try->data;
1475 if (!_dbus_string_init (&auth_command, _DBUS_INT_MAX))
1478 if (!_dbus_string_append (&auth_command,
1481 _dbus_string_free (&auth_command);
1485 if (!_dbus_string_append (&auth_command,
1488 _dbus_string_free (&auth_command);
1492 if (mech->client_initial_response_func != NULL)
1494 if (!_dbus_string_append (&auth_command, " "))
1496 _dbus_string_free (&auth_command);
1500 if (!(* mech->client_initial_response_func) (auth, &auth_command))
1502 _dbus_string_free (&auth_command);
1507 if (!_dbus_string_append (&auth_command,
1510 _dbus_string_free (&auth_command);
1514 if (!_dbus_string_copy (&auth_command, 0,
1516 _dbus_string_get_length (&auth->outgoing)))
1518 _dbus_string_free (&auth_command);
1523 _dbus_list_pop_first (& DBUS_AUTH_CLIENT (auth)->mechs_to_try);
1525 _dbus_verbose ("Trying mechanism %s\n",
1526 auth->mech->mechanism);
1528 _dbus_string_free (&auth_command);
1534 process_rejected (DBusAuth *auth,
1535 const DBusString *command,
1536 const DBusString *args)
1538 shutdown_mech (auth);
1540 if (!auth->already_got_mechanisms)
1542 if (!record_mechanisms (auth, command, args))
1546 if (DBUS_AUTH_CLIENT (auth)->mechs_to_try != NULL)
1548 client_try_next_mechanism (auth);
1553 auth->need_disconnect = TRUE;
1560 process_ok (DBusAuth *auth,
1561 const DBusString *command,
1562 const DBusString *args)
1564 if (!_dbus_string_append (&auth->outgoing,
1568 auth->authenticated_pending_output = TRUE;
1574 process_data_client (DBusAuth *auth,
1575 const DBusString *command,
1576 const DBusString *args)
1578 if (auth->mech != NULL)
1582 if (!_dbus_string_init (&decoded, _DBUS_INT_MAX))
1585 if (!_dbus_string_base64_decode (args, 0, &decoded, 0))
1587 _dbus_string_free (&decoded);
1591 #ifdef DBUS_ENABLE_VERBOSE_MODE
1592 if (_dbus_string_validate_ascii (&decoded, 0,
1593 _dbus_string_get_length (&decoded)))
1596 _dbus_string_get_const_data (&decoded, &s);
1597 _dbus_verbose ("data: '%s'\n", s);
1601 if (!(* auth->mech->client_data_func) (auth, &decoded))
1603 _dbus_string_free (&decoded);
1607 _dbus_string_free (&decoded);
1611 if (!_dbus_string_append (&auth->outgoing,
1612 "ERROR \"Got DATA when not in an auth exchange\"\r\n"))
1620 process_error_client (DBusAuth *auth,
1621 const DBusString *command,
1622 const DBusString *args)
1628 process_unknown (DBusAuth *auth,
1629 const DBusString *command,
1630 const DBusString *args)
1632 if (!_dbus_string_append (&auth->outgoing,
1633 "ERROR \"Unknown command\"\r\n"))
1639 /* returns whether to call it again right away */
1641 process_command (DBusAuth *auth)
1649 /* _dbus_verbose (" trying process_command()\n"); */
1654 if (!_dbus_string_find (&auth->incoming, 0, "\r\n", &eol))
1657 if (!_dbus_string_init (&command, _DBUS_INT_MAX))
1659 auth->needed_memory = TRUE;
1663 if (!_dbus_string_init (&args, _DBUS_INT_MAX))
1665 auth->needed_memory = TRUE;
1669 if (eol > _DBUS_ONE_MEGABYTE)
1671 /* This is a giant line, someone is trying to hose us. */
1672 if (!_dbus_string_append (&auth->outgoing, "ERROR \"Command too long\"\r\n"))
1678 if (!_dbus_string_copy_len (&auth->incoming, 0, eol, &command, 0))
1681 if (!_dbus_string_validate_ascii (&command, 0,
1682 _dbus_string_get_length (&command)))
1684 _dbus_verbose ("Command contained non-ASCII chars or embedded nul\n");
1685 if (!_dbus_string_append (&auth->outgoing, "ERROR \"Command contained non-ASCII\"\r\n"))
1693 _dbus_string_get_const_data (&command, &q);
1694 _dbus_verbose ("got command \"%s\"\n", q);
1697 _dbus_string_find_blank (&command, 0, &i);
1698 _dbus_string_skip_blank (&command, i, &j);
1701 _dbus_string_delete (&command, i, j - i);
1703 if (!_dbus_string_move (&command, i, &args, 0))
1707 while (auth->handlers[i].command != NULL)
1709 if (_dbus_string_equal_c_str (&command,
1710 auth->handlers[i].command))
1712 _dbus_verbose ("Processing auth command %s\n",
1713 auth->handlers[i].command);
1715 if (!(* auth->handlers[i].func) (auth, &command, &args))
1723 if (auth->handlers[i].command == NULL)
1725 if (!process_unknown (auth, &command, &args))
1731 /* We've succeeded in processing the whole command so drop it out
1732 * of the incoming buffer and return TRUE to try another command.
1735 _dbus_string_delete (&auth->incoming, 0, eol);
1738 _dbus_string_delete (&auth->incoming, 0, 2);
1743 _dbus_string_free (&args);
1744 _dbus_string_free (&command);
1747 auth->needed_memory = TRUE;
1749 auth->needed_memory = FALSE;
1758 * @addtogroup DBusAuth
1763 * Creates a new auth conversation object for the server side.
1764 * See doc/dbus-sasl-profile.txt for full details on what
1767 * @returns the new object or #NULL if no memory
1770 _dbus_auth_server_new (void)
1773 DBusAuthServer *server_auth;
1775 auth = _dbus_auth_new (sizeof (DBusAuthServer));
1779 auth->handlers = server_handlers;
1781 server_auth = DBUS_AUTH_SERVER (auth);
1783 /* perhaps this should be per-mechanism with a lower
1786 server_auth->failures = 0;
1787 server_auth->max_failures = 6;
1793 * Creates a new auth conversation object for the client side.
1794 * See doc/dbus-sasl-profile.txt for full details on what
1797 * @returns the new object or #NULL if no memory
1800 _dbus_auth_client_new (void)
1804 auth = _dbus_auth_new (sizeof (DBusAuthClient));
1808 auth->handlers = client_handlers;
1810 /* Add a default mechanism to try */
1811 if (!_dbus_list_append (& DBUS_AUTH_CLIENT (auth)->mechs_to_try,
1812 (void*) &all_mechanisms[0]))
1814 _dbus_auth_unref (auth);
1818 /* Now try the mechanism we just added */
1819 if (!client_try_next_mechanism (auth))
1821 _dbus_auth_unref (auth);
1829 * Increments the refcount of an auth object.
1831 * @param auth the auth conversation
1834 _dbus_auth_ref (DBusAuth *auth)
1836 _dbus_assert (auth != NULL);
1838 auth->refcount += 1;
1842 * Decrements the refcount of an auth object.
1844 * @param auth the auth conversation
1847 _dbus_auth_unref (DBusAuth *auth)
1849 _dbus_assert (auth != NULL);
1850 _dbus_assert (auth->refcount > 0);
1852 auth->refcount -= 1;
1853 if (auth->refcount == 0)
1855 shutdown_mech (auth);
1857 if (DBUS_AUTH_IS_CLIENT (auth))
1859 _dbus_list_clear (& DBUS_AUTH_CLIENT (auth)->mechs_to_try);
1863 _dbus_keyring_unref (auth->keyring);
1865 _dbus_string_free (&auth->identity);
1866 _dbus_string_free (&auth->incoming);
1867 _dbus_string_free (&auth->outgoing);
1873 * @param auth the auth conversation object
1874 * @returns #TRUE if we're in a final state
1876 #define DBUS_AUTH_IN_END_STATE(auth) ((auth)->need_disconnect || (auth)->authenticated)
1879 * Analyzes buffered input and moves the auth conversation forward,
1880 * returning the new state of the auth conversation.
1882 * @param auth the auth conversation
1883 * @returns the new state
1886 _dbus_auth_do_work (DBusAuth *auth)
1888 auth->needed_memory = FALSE;
1890 /* Max amount we'll buffer up before deciding someone's on crack */
1891 #define MAX_BUFFER (16 * _DBUS_ONE_KILOBYTE)
1895 if (DBUS_AUTH_IN_END_STATE (auth))
1898 if (_dbus_string_get_length (&auth->incoming) > MAX_BUFFER ||
1899 _dbus_string_get_length (&auth->outgoing) > MAX_BUFFER)
1901 auth->need_disconnect = TRUE;
1902 _dbus_verbose ("Disconnecting due to excessive data buffered in auth phase\n");
1906 if (auth->mech == NULL &&
1907 auth->already_got_mechanisms &&
1908 DBUS_AUTH_CLIENT (auth)->mechs_to_try == NULL)
1910 auth->need_disconnect = TRUE;
1911 _dbus_verbose ("Disconnecting because we are out of mechanisms to try using\n");
1915 while (process_command (auth));
1917 if (DBUS_AUTH_IS_SERVER (auth) &&
1918 DBUS_AUTH_SERVER (auth)->failures >=
1919 DBUS_AUTH_SERVER (auth)->max_failures)
1920 auth->need_disconnect = TRUE;
1922 if (auth->need_disconnect)
1923 return DBUS_AUTH_STATE_NEED_DISCONNECT;
1924 else if (auth->authenticated)
1926 if (_dbus_string_get_length (&auth->incoming) > 0)
1927 return DBUS_AUTH_STATE_AUTHENTICATED_WITH_UNUSED_BYTES;
1929 return DBUS_AUTH_STATE_AUTHENTICATED;
1931 else if (auth->needed_memory)
1932 return DBUS_AUTH_STATE_WAITING_FOR_MEMORY;
1933 else if (_dbus_string_get_length (&auth->outgoing) > 0)
1934 return DBUS_AUTH_STATE_HAVE_BYTES_TO_SEND;
1936 return DBUS_AUTH_STATE_WAITING_FOR_INPUT;
1940 * Gets bytes that need to be sent to the peer we're conversing with.
1941 * After writing some bytes, _dbus_auth_bytes_sent() must be called
1942 * to notify the auth object that they were written.
1944 * @param auth the auth conversation
1945 * @param str return location for a ref to the buffer to send
1946 * @returns #FALSE if nothing to send
1949 _dbus_auth_get_bytes_to_send (DBusAuth *auth,
1950 const DBusString **str)
1952 _dbus_assert (auth != NULL);
1953 _dbus_assert (str != NULL);
1957 if (DBUS_AUTH_IN_END_STATE (auth))
1960 if (_dbus_string_get_length (&auth->outgoing) == 0)
1963 *str = &auth->outgoing;
1969 * Notifies the auth conversation object that
1970 * the given number of bytes of the outgoing buffer
1971 * have been written out.
1973 * @param auth the auth conversation
1974 * @param bytes_sent number of bytes written out
1977 _dbus_auth_bytes_sent (DBusAuth *auth,
1982 _dbus_string_get_const_data (&auth->outgoing, &s);
1983 _dbus_verbose ("Sent %d bytes of: %s\n", bytes_sent, s);
1986 _dbus_string_delete (&auth->outgoing,
1989 if (auth->authenticated_pending_output &&
1990 _dbus_string_get_length (&auth->outgoing) == 0)
1991 auth->authenticated = TRUE;
1995 * Stores bytes received from the peer we're conversing with.
1997 * @param auth the auth conversation
1998 * @param str the received bytes.
1999 * @returns #FALSE if not enough memory to store the bytes or we were already authenticated.
2002 _dbus_auth_bytes_received (DBusAuth *auth,
2003 const DBusString *str)
2005 _dbus_assert (auth != NULL);
2006 _dbus_assert (str != NULL);
2008 if (DBUS_AUTH_IN_END_STATE (auth))
2011 auth->needed_memory = FALSE;
2013 if (!_dbus_string_copy (str, 0,
2015 _dbus_string_get_length (&auth->incoming)))
2017 auth->needed_memory = TRUE;
2021 _dbus_auth_do_work (auth);
2027 * Returns leftover bytes that were not used as part of the auth
2028 * conversation. These bytes will be part of the message stream
2029 * instead. This function may not be called until authentication has
2032 * @param auth the auth conversation
2033 * @param str string to append the unused bytes to
2034 * @returns #FALSE if not enough memory to return the bytes
2037 _dbus_auth_get_unused_bytes (DBusAuth *auth,
2040 if (!DBUS_AUTH_IN_END_STATE (auth))
2043 if (!_dbus_string_move (&auth->incoming,
2045 _dbus_string_get_length (str)))
2052 * Called post-authentication, indicates whether we need to encode
2053 * the message stream with _dbus_auth_encode_data() prior to
2054 * sending it to the peer.
2056 * @param auth the auth conversation
2057 * @returns #TRUE if we need to encode the stream
2060 _dbus_auth_needs_encoding (DBusAuth *auth)
2062 if (!auth->authenticated)
2065 if (auth->mech != NULL)
2067 if (DBUS_AUTH_IS_CLIENT (auth))
2068 return auth->mech->client_encode_func != NULL;
2070 return auth->mech->server_encode_func != NULL;
2077 * Called post-authentication, encodes a block of bytes for sending to
2078 * the peer. If no encoding was negotiated, just copies the bytes
2079 * (you can avoid this by checking _dbus_auth_needs_encoding()).
2081 * @param auth the auth conversation
2082 * @param plaintext the plain text data
2083 * @param encoded initialized string to where encoded data is appended
2084 * @returns #TRUE if we had enough memory and successfully encoded
2087 _dbus_auth_encode_data (DBusAuth *auth,
2088 const DBusString *plaintext,
2089 DBusString *encoded)
2091 _dbus_assert (plaintext != encoded);
2093 if (!auth->authenticated)
2096 if (_dbus_auth_needs_encoding (auth))
2098 if (DBUS_AUTH_IS_CLIENT (auth))
2099 return (* auth->mech->client_encode_func) (auth, plaintext, encoded);
2101 return (* auth->mech->server_encode_func) (auth, plaintext, encoded);
2105 return _dbus_string_copy (plaintext, 0, encoded,
2106 _dbus_string_get_length (encoded));
2111 * Called post-authentication, indicates whether we need to decode
2112 * the message stream with _dbus_auth_decode_data() after
2113 * receiving it from the peer.
2115 * @param auth the auth conversation
2116 * @returns #TRUE if we need to encode the stream
2119 _dbus_auth_needs_decoding (DBusAuth *auth)
2121 if (!auth->authenticated)
2124 if (auth->mech != NULL)
2126 if (DBUS_AUTH_IS_CLIENT (auth))
2127 return auth->mech->client_decode_func != NULL;
2129 return auth->mech->server_decode_func != NULL;
2137 * Called post-authentication, decodes a block of bytes received from
2138 * the peer. If no encoding was negotiated, just copies the bytes (you
2139 * can avoid this by checking _dbus_auth_needs_decoding()).
2141 * @todo We need to be able to distinguish "out of memory" error
2142 * from "the data is hosed" error.
2144 * @param auth the auth conversation
2145 * @param encoded the encoded data
2146 * @param plaintext initialized string where decoded data is appended
2147 * @returns #TRUE if we had enough memory and successfully decoded
2150 _dbus_auth_decode_data (DBusAuth *auth,
2151 const DBusString *encoded,
2152 DBusString *plaintext)
2154 _dbus_assert (plaintext != encoded);
2156 if (!auth->authenticated)
2159 if (_dbus_auth_needs_decoding (auth))
2161 if (DBUS_AUTH_IS_CLIENT (auth))
2162 return (* auth->mech->client_decode_func) (auth, encoded, plaintext);
2164 return (* auth->mech->server_decode_func) (auth, encoded, plaintext);
2168 return _dbus_string_copy (encoded, 0, plaintext,
2169 _dbus_string_get_length (plaintext));
2174 * Sets credentials received via reliable means from the operating
2177 * @param auth the auth conversation
2178 * @param credentials the credentials received
2181 _dbus_auth_set_credentials (DBusAuth *auth,
2182 const DBusCredentials *credentials)
2184 auth->credentials = *credentials;
2188 * Gets the identity we authorized the client as. Apps may have
2189 * different policies as to what identities they allow.
2191 * @param auth the auth conversation
2192 * @param credentials the credentials we've authorized
2195 _dbus_auth_get_identity (DBusAuth *auth,
2196 DBusCredentials *credentials)
2198 if (auth->authenticated)
2200 *credentials = auth->authorized_identity;
2204 credentials->pid = -1;
2205 credentials->uid = -1;
2206 credentials->gid = -1;
2211 * Sets the "authentication context" which scopes cookies
2212 * with the DBUS_COOKIE_SHA1 auth mechanism for example.
2214 * @param auth the auth conversation
2215 * @param context the context
2216 * @returns #FALSE if no memory
2219 _dbus_auth_set_context (DBusAuth *auth,
2220 const DBusString *context)
2222 return _dbus_string_replace_len (context, 0, _dbus_string_get_length (context),
2223 &auth->context, 0, _dbus_string_get_length (context));
2228 #ifdef DBUS_BUILD_TESTS
2229 #include "dbus-test.h"
2230 #include "dbus-auth-script.h"
2234 process_test_subdir (const DBusString *test_base_dir,
2237 DBusString test_directory;
2238 DBusString filename;
2241 DBusResultCode result;
2246 if (!_dbus_string_init (&test_directory, _DBUS_INT_MAX))
2247 _dbus_assert_not_reached ("didn't allocate test_directory\n");
2249 _dbus_string_init_const (&filename, subdir);
2251 if (!_dbus_string_copy (test_base_dir, 0,
2252 &test_directory, 0))
2253 _dbus_assert_not_reached ("couldn't copy test_base_dir to test_directory");
2255 if (!_dbus_concat_dir_and_file (&test_directory, &filename))
2256 _dbus_assert_not_reached ("couldn't allocate full path");
2258 _dbus_string_free (&filename);
2259 if (!_dbus_string_init (&filename, _DBUS_INT_MAX))
2260 _dbus_assert_not_reached ("didn't allocate filename string\n");
2262 dir = _dbus_directory_open (&test_directory, &result);
2266 _dbus_string_get_const_data (&test_directory, &s);
2267 _dbus_warn ("Could not open %s: %s\n", s,
2268 dbus_result_to_string (result));
2272 printf ("Testing:\n");
2274 result = DBUS_RESULT_SUCCESS;
2276 while (_dbus_directory_get_next_file (dir, &filename, &result))
2278 DBusString full_path;
2280 if (!_dbus_string_init (&full_path, _DBUS_INT_MAX))
2281 _dbus_assert_not_reached ("couldn't init string");
2283 if (!_dbus_string_copy (&test_directory, 0, &full_path, 0))
2284 _dbus_assert_not_reached ("couldn't copy dir to full_path");
2286 if (!_dbus_concat_dir_and_file (&full_path, &filename))
2287 _dbus_assert_not_reached ("couldn't concat file to dir");
2289 if (!_dbus_string_ends_with_c_str (&filename, ".auth-script"))
2291 const char *filename_c;
2292 _dbus_string_get_const_data (&filename, &filename_c);
2293 _dbus_verbose ("Skipping non-.auth-script file %s\n",
2295 _dbus_string_free (&full_path);
2301 _dbus_string_get_const_data (&filename, &s);
2302 printf (" %s\n", s);
2305 if (!_dbus_auth_script_run (&full_path))
2307 _dbus_string_free (&full_path);
2311 _dbus_string_free (&full_path);
2314 if (result != DBUS_RESULT_SUCCESS)
2317 _dbus_string_get_const_data (&test_directory, &s);
2318 _dbus_warn ("Could not get next file in %s: %s\n",
2319 s, dbus_result_to_string (result));
2328 _dbus_directory_close (dir);
2329 _dbus_string_free (&test_directory);
2330 _dbus_string_free (&filename);
2336 process_test_dirs (const char *test_data_dir)
2338 DBusString test_directory;
2343 _dbus_string_init_const (&test_directory, test_data_dir);
2345 if (!process_test_subdir (&test_directory, "auth"))
2352 _dbus_string_free (&test_directory);
2358 _dbus_auth_test (const char *test_data_dir)
2361 if (test_data_dir == NULL)
2364 if (!process_test_dirs (test_data_dir))
2370 #endif /* DBUS_BUILD_TESTS */