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. This is the number of bytes in the random
435 #define N_CHALLENGE_BYTES (128/8)
438 sha1_handle_first_client_response (DBusAuth *auth,
439 const DBusString *data)
441 /* We haven't sent a challenge yet, we're expecting a desired
442 * username from the client.
452 _dbus_string_set_length (&auth->challenge, 0);
454 if (_dbus_string_get_length (data) > 0)
456 if (_dbus_string_get_length (&auth->identity) > 0)
458 /* Tried to send two auth identities, wtf */
459 _dbus_verbose ("client tried to send auth identity, but we already have one\n");
460 return send_rejected (auth);
464 /* this is our auth identity */
465 if (!_dbus_string_copy (data, 0, &auth->identity, 0))
470 if (!_dbus_credentials_from_username (data, &auth->desired_identity))
472 _dbus_verbose ("Did not get a valid username from client\n");
473 return send_rejected (auth);
476 if (!_dbus_string_init (&tmp, _DBUS_INT_MAX))
479 if (!_dbus_string_init (&tmp2, _DBUS_INT_MAX))
481 _dbus_string_free (&tmp);
485 old_len = _dbus_string_get_length (&auth->outgoing);
487 /* we cache the keyring for speed, so here we drop it if it's the
488 * wrong one. FIXME caching the keyring here is useless since we use
489 * a different DBusAuth for every connection.
492 !_dbus_keyring_is_for_user (auth->keyring,
495 _dbus_keyring_unref (auth->keyring);
496 auth->keyring = NULL;
499 if (auth->keyring == NULL)
503 dbus_error_init (&error);
504 auth->keyring = _dbus_keyring_new_homedir (data,
508 if (auth->keyring == NULL)
510 if (dbus_error_has_name (&error,
511 DBUS_ERROR_NO_MEMORY))
513 dbus_error_free (&error);
518 _DBUS_ASSERT_ERROR_IS_SET (&error);
519 _dbus_verbose ("Error loading keyring: %s\n",
521 if (send_rejected (auth))
522 retval = TRUE; /* retval is only about mem */
523 dbus_error_free (&error);
529 _dbus_assert (!dbus_error_is_set (&error));
533 _dbus_assert (auth->keyring != NULL);
535 dbus_error_init (&error);
536 auth->cookie_id = _dbus_keyring_get_best_key (auth->keyring, &error);
537 if (auth->cookie_id < 0)
539 _DBUS_ASSERT_ERROR_IS_SET (&error);
540 _dbus_verbose ("Could not get a cookie ID to send to client: %s\n",
542 if (send_rejected (auth))
544 dbus_error_free (&error);
549 _dbus_assert (!dbus_error_is_set (&error));
552 if (!_dbus_string_copy (&auth->context, 0,
553 &tmp2, _dbus_string_get_length (&tmp2)))
556 if (!_dbus_string_append (&tmp2, " "))
559 if (!_dbus_string_append_int (&tmp2, auth->cookie_id))
562 if (!_dbus_string_append (&tmp2, " "))
565 if (!_dbus_generate_random_bytes (&tmp, N_CHALLENGE_BYTES))
568 _dbus_string_set_length (&auth->challenge, 0);
569 if (!_dbus_string_hex_encode (&tmp, 0, &auth->challenge, 0))
572 if (!_dbus_string_hex_encode (&tmp, 0, &tmp2,
573 _dbus_string_get_length (&tmp2)))
576 if (!_dbus_string_append (&auth->outgoing,
580 if (!_dbus_string_base64_encode (&tmp2, 0, &auth->outgoing,
581 _dbus_string_get_length (&auth->outgoing)))
584 if (!_dbus_string_append (&auth->outgoing,
591 _dbus_string_zero (&tmp);
592 _dbus_string_free (&tmp);
593 _dbus_string_zero (&tmp2);
594 _dbus_string_free (&tmp2);
596 _dbus_string_set_length (&auth->outgoing, old_len);
601 sha1_handle_second_client_response (DBusAuth *auth,
602 const DBusString *data)
604 /* We are expecting a response which is the hex-encoded client
605 * challenge, space, then SHA-1 hash of the concatenation of our
606 * challenge, ":", client challenge, ":", secret key, all
610 DBusString client_challenge;
611 DBusString client_hash;
613 DBusString correct_hash;
617 if (!_dbus_string_find_blank (data, 0, &i))
619 _dbus_verbose ("no space separator in client response\n");
620 return send_rejected (auth);
623 if (!_dbus_string_init (&client_challenge, _DBUS_INT_MAX))
626 if (!_dbus_string_init (&client_hash, _DBUS_INT_MAX))
629 if (!_dbus_string_copy_len (data, 0, i, &client_challenge,
633 _dbus_string_skip_blank (data, i, &i);
635 if (!_dbus_string_copy_len (data, i,
636 _dbus_string_get_length (data) - i,
641 if (_dbus_string_get_length (&client_challenge) == 0 ||
642 _dbus_string_get_length (&client_hash) == 0)
644 _dbus_verbose ("zero-length client challenge or hash\n");
645 if (send_rejected (auth))
650 if (!_dbus_string_init (&correct_hash, _DBUS_INT_MAX))
653 if (!sha1_compute_hash (auth, auth->cookie_id,
659 /* if cookie_id was invalid, then we get an empty hash */
660 if (_dbus_string_get_length (&correct_hash) == 0)
662 if (send_rejected (auth))
667 if (!_dbus_string_equal (&client_hash, &correct_hash))
669 if (send_rejected (auth))
674 if (!_dbus_string_append (&auth->outgoing,
678 _dbus_verbose ("authenticated client with UID %d using DBUS_COOKIE_SHA1\n",
679 auth->desired_identity.uid);
681 auth->authorized_identity = auth->desired_identity;
682 auth->authenticated_pending_begin = TRUE;
686 _dbus_string_zero (&correct_hash);
687 _dbus_string_free (&correct_hash);
689 _dbus_string_zero (&client_hash);
690 _dbus_string_free (&client_hash);
692 _dbus_string_free (&client_challenge);
698 handle_server_data_cookie_sha1_mech (DBusAuth *auth,
699 const DBusString *data)
701 if (auth->cookie_id < 0)
702 return sha1_handle_first_client_response (auth, data);
704 return sha1_handle_second_client_response (auth, data);
708 handle_server_shutdown_cookie_sha1_mech (DBusAuth *auth)
710 auth->cookie_id = -1;
711 _dbus_string_set_length (&auth->challenge, 0);
715 handle_client_initial_response_cookie_sha1_mech (DBusAuth *auth,
716 DBusString *response)
718 const DBusString *username;
723 if (!_dbus_user_info_from_current_process (&username,
727 if (!_dbus_string_base64_encode (username, 0,
729 _dbus_string_get_length (response)))
738 /* FIXME if we send the server an error, right now both sides
739 * just hang. Server has to reject on getting an error, or
740 * client has to cancel. Should be in the spec.
743 handle_client_data_cookie_sha1_mech (DBusAuth *auth,
744 const DBusString *data)
746 /* The data we get from the server should be the cookie context
747 * name, the cookie ID, and the server challenge, separated by
748 * spaces. We send back our challenge string and the correct hash.
752 DBusString cookie_id_str;
753 DBusString server_challenge;
754 DBusString client_challenge;
755 DBusString correct_hash;
763 if (!_dbus_string_find_blank (data, 0, &i))
765 if (_dbus_string_append (&auth->outgoing,
766 "ERROR \"Server did not send context/ID/challenge properly\"\r\n"))
771 if (!_dbus_string_init (&context, _DBUS_INT_MAX))
774 if (!_dbus_string_copy_len (data, 0, i,
778 _dbus_string_skip_blank (data, i, &i);
779 if (!_dbus_string_find_blank (data, i, &j))
781 if (_dbus_string_append (&auth->outgoing,
782 "ERROR \"Server did not send context/ID/challenge properly\"\r\n"))
787 if (!_dbus_string_init (&cookie_id_str, _DBUS_INT_MAX))
790 if (!_dbus_string_copy_len (data, i, j - i,
794 if (!_dbus_string_init (&server_challenge, _DBUS_INT_MAX))
798 _dbus_string_skip_blank (data, i, &i);
799 j = _dbus_string_get_length (data);
801 if (!_dbus_string_copy_len (data, i, j - i,
802 &server_challenge, 0))
805 if (!_dbus_keyring_validate_context (&context))
807 if (_dbus_string_append (&auth->outgoing,
808 "ERROR \"Server sent invalid cookie context\"\r\n"))
813 if (!_dbus_string_parse_int (&cookie_id_str, 0, &val, NULL))
815 if (_dbus_string_append (&auth->outgoing,
816 "ERROR \"Could not parse cookie ID as an integer\"\r\n"))
821 if (_dbus_string_get_length (&server_challenge) == 0)
823 if (_dbus_string_append (&auth->outgoing,
824 "ERROR \"Empty server challenge string\"\r\n"))
829 if (auth->keyring == NULL)
833 dbus_error_init (&error);
834 auth->keyring = _dbus_keyring_new_homedir (NULL,
838 if (auth->keyring == NULL)
840 if (dbus_error_has_name (&error,
841 DBUS_ERROR_NO_MEMORY))
843 dbus_error_free (&error);
848 _DBUS_ASSERT_ERROR_IS_SET (&error);
850 _dbus_verbose ("Error loading keyring: %s\n",
853 if (_dbus_string_append (&auth->outgoing,
854 "ERROR \"Could not load cookie file\"\r\n"))
855 retval = TRUE; /* retval is only about mem */
857 dbus_error_free (&error);
863 _dbus_assert (!dbus_error_is_set (&error));
867 _dbus_assert (auth->keyring != NULL);
869 if (!_dbus_string_init (&tmp, _DBUS_INT_MAX))
872 if (!_dbus_generate_random_bytes (&tmp, N_CHALLENGE_BYTES))
875 if (!_dbus_string_init (&client_challenge, _DBUS_INT_MAX))
878 if (!_dbus_string_hex_encode (&tmp, 0, &client_challenge, 0))
881 if (!_dbus_string_init (&correct_hash, _DBUS_INT_MAX))
884 if (!sha1_compute_hash (auth, val,
890 if (_dbus_string_get_length (&correct_hash) == 0)
892 /* couldn't find the cookie ID or something */
893 if (_dbus_string_append (&auth->outgoing,
894 "ERROR \"Don't have the requested cookie ID\"\r\n"))
899 _dbus_string_set_length (&tmp, 0);
901 if (!_dbus_string_copy (&client_challenge, 0, &tmp,
902 _dbus_string_get_length (&tmp)))
905 if (!_dbus_string_append (&tmp, " "))
908 if (!_dbus_string_copy (&correct_hash, 0, &tmp,
909 _dbus_string_get_length (&tmp)))
912 old_len = _dbus_string_get_length (&auth->outgoing);
913 if (!_dbus_string_append (&auth->outgoing, "DATA "))
916 if (!_dbus_string_base64_encode (&tmp, 0,
918 _dbus_string_get_length (&auth->outgoing)))
920 _dbus_string_set_length (&auth->outgoing, old_len);
924 if (!_dbus_string_append (&auth->outgoing, "\r\n"))
926 _dbus_string_set_length (&auth->outgoing, old_len);
933 _dbus_string_zero (&correct_hash);
934 _dbus_string_free (&correct_hash);
936 _dbus_string_free (&client_challenge);
938 _dbus_string_zero (&tmp);
939 _dbus_string_free (&tmp);
941 _dbus_string_free (&server_challenge);
943 _dbus_string_free (&cookie_id_str);
945 _dbus_string_free (&context);
951 handle_client_shutdown_cookie_sha1_mech (DBusAuth *auth)
953 auth->cookie_id = -1;
954 _dbus_string_set_length (&auth->challenge, 0);
958 handle_server_data_external_mech (DBusAuth *auth,
959 const DBusString *data)
961 if (auth->credentials.uid < 0)
963 _dbus_verbose ("no credentials, mechanism EXTERNAL can't authenticate\n");
964 return send_rejected (auth);
967 if (_dbus_string_get_length (data) > 0)
969 if (_dbus_string_get_length (&auth->identity) > 0)
971 /* Tried to send two auth identities, wtf */
972 _dbus_verbose ("client tried to send auth identity, but we already have one\n");
973 return send_rejected (auth);
977 /* this is our auth identity */
978 if (!_dbus_string_copy (data, 0, &auth->identity, 0))
983 /* Poke client for an auth identity, if none given */
984 if (_dbus_string_get_length (&auth->identity) == 0 &&
985 !auth->already_asked_for_initial_response)
987 if (_dbus_string_append (&auth->outgoing,
990 _dbus_verbose ("sending empty challenge asking client for auth identity\n");
991 auth->already_asked_for_initial_response = TRUE;
998 auth->desired_identity.pid = -1;
999 auth->desired_identity.uid = -1;
1000 auth->desired_identity.gid = -1;
1002 /* If auth->identity is still empty here, then client
1003 * responded with an empty string after we poked it for
1004 * an initial response. This means to try to auth the
1005 * identity provided in the credentials.
1007 if (_dbus_string_get_length (&auth->identity) == 0)
1009 auth->desired_identity.uid = auth->credentials.uid;
1013 if (!_dbus_credentials_from_uid_string (&auth->identity,
1014 &auth->desired_identity))
1016 _dbus_verbose ("could not get credentials from uid string\n");
1017 return send_rejected (auth);
1021 if (auth->desired_identity.uid < 0)
1023 _dbus_verbose ("desired UID %d is no good\n", auth->desired_identity.uid);
1024 return send_rejected (auth);
1027 if (_dbus_credentials_match (&auth->desired_identity,
1028 &auth->credentials))
1030 /* client has authenticated */
1031 if (!_dbus_string_append (&auth->outgoing,
1035 _dbus_verbose ("authenticated client with UID %d matching socket credentials UID %d\n",
1036 auth->desired_identity.uid,
1037 auth->credentials.uid);
1039 auth->authorized_identity.uid = auth->desired_identity.uid;
1041 auth->authenticated_pending_begin = TRUE;
1047 _dbus_verbose ("credentials uid=%d gid=%d do not allow uid=%d gid=%d\n",
1048 auth->credentials.uid, auth->credentials.gid,
1049 auth->desired_identity.uid, auth->desired_identity.gid);
1050 return send_rejected (auth);
1055 handle_server_shutdown_external_mech (DBusAuth *auth)
1061 handle_client_initial_response_external_mech (DBusAuth *auth,
1062 DBusString *response)
1064 /* We always append our UID as an initial response, so the server
1065 * doesn't have to send back an empty challenge to check whether we
1066 * want to specify an identity. i.e. this avoids a round trip that
1067 * the spec for the EXTERNAL mechanism otherwise requires.
1069 DBusString plaintext;
1071 if (!_dbus_string_init (&plaintext, _DBUS_INT_MAX))
1074 if (!_dbus_string_append_our_uid (&plaintext))
1077 if (!_dbus_string_base64_encode (&plaintext, 0,
1079 _dbus_string_get_length (response)))
1082 _dbus_string_free (&plaintext);
1087 _dbus_string_free (&plaintext);
1092 handle_client_data_external_mech (DBusAuth *auth,
1093 const DBusString *data)
1100 handle_client_shutdown_external_mech (DBusAuth *auth)
1105 /* Put mechanisms here in order of preference.
1106 * What I eventually want to have is:
1108 * - a mechanism that checks UNIX domain socket credentials
1109 * - a simple magic cookie mechanism like X11 or ICE
1110 * - mechanisms that chain to Cyrus SASL, so we can use anything it
1111 * offers such as Kerberos, X509, whatever.
1114 static const DBusAuthMechanismHandler
1115 all_mechanisms[] = {
1117 handle_server_data_external_mech,
1119 handle_server_shutdown_external_mech,
1120 handle_client_initial_response_external_mech,
1121 handle_client_data_external_mech,
1123 handle_client_shutdown_external_mech },
1124 { "DBUS_COOKIE_SHA1",
1125 handle_server_data_cookie_sha1_mech,
1127 handle_server_shutdown_cookie_sha1_mech,
1128 handle_client_initial_response_cookie_sha1_mech,
1129 handle_client_data_cookie_sha1_mech,
1131 handle_client_shutdown_cookie_sha1_mech },
1135 static const DBusAuthMechanismHandler*
1136 find_mech (const DBusString *name)
1141 while (all_mechanisms[i].mechanism != NULL)
1143 if (_dbus_string_equal_c_str (name,
1144 all_mechanisms[i].mechanism))
1146 return &all_mechanisms[i];
1155 send_rejected (DBusAuth *auth)
1158 DBusAuthServer *server_auth;
1161 if (!_dbus_string_init (&command, _DBUS_INT_MAX))
1164 if (!_dbus_string_append (&command,
1169 while (all_mechanisms[i].mechanism != NULL)
1171 if (!_dbus_string_append (&command,
1175 if (!_dbus_string_append (&command,
1176 all_mechanisms[i].mechanism))
1182 if (!_dbus_string_append (&command, "\r\n"))
1185 if (!_dbus_string_copy (&command, 0, &auth->outgoing,
1186 _dbus_string_get_length (&auth->outgoing)))
1189 shutdown_mech (auth);
1191 _dbus_assert (DBUS_AUTH_IS_SERVER (auth));
1192 server_auth = DBUS_AUTH_SERVER (auth);
1193 server_auth->failures += 1;
1195 _dbus_string_free (&command);
1200 _dbus_string_free (&command);
1205 process_auth (DBusAuth *auth,
1206 const DBusString *command,
1207 const DBusString *args)
1211 /* We are already using a mechanism, client is on crack */
1212 if (!_dbus_string_append (&auth->outgoing,
1213 "ERROR \"Sent AUTH while another AUTH in progress\"\r\n"))
1218 else if (_dbus_string_get_length (args) == 0)
1220 /* No args to the auth, send mechanisms */
1221 if (!send_rejected (auth))
1230 DBusString base64_response;
1231 DBusString decoded_response;
1233 _dbus_string_find_blank (args, 0, &i);
1235 if (!_dbus_string_init (&mech, _DBUS_INT_MAX))
1238 if (!_dbus_string_init (&base64_response, _DBUS_INT_MAX))
1240 _dbus_string_free (&mech);
1244 if (!_dbus_string_init (&decoded_response, _DBUS_INT_MAX))
1246 _dbus_string_free (&mech);
1247 _dbus_string_free (&base64_response);
1251 if (!_dbus_string_copy_len (args, 0, i, &mech, 0))
1254 if (!_dbus_string_copy (args, i, &base64_response, 0))
1257 if (!_dbus_string_base64_decode (&base64_response, 0,
1258 &decoded_response, 0))
1261 auth->mech = find_mech (&mech);
1262 if (auth->mech != NULL)
1264 _dbus_verbose ("Trying mechanism %s with initial response of %d bytes\n",
1265 auth->mech->mechanism,
1266 _dbus_string_get_length (&decoded_response));
1268 if (!(* auth->mech->server_data_func) (auth,
1274 /* Unsupported mechanism */
1275 if (!send_rejected (auth))
1279 _dbus_string_free (&mech);
1280 _dbus_string_free (&base64_response);
1281 _dbus_string_free (&decoded_response);
1287 _dbus_string_free (&mech);
1288 _dbus_string_free (&base64_response);
1289 _dbus_string_free (&decoded_response);
1295 process_cancel (DBusAuth *auth,
1296 const DBusString *command,
1297 const DBusString *args)
1299 shutdown_mech (auth);
1305 process_begin (DBusAuth *auth,
1306 const DBusString *command,
1307 const DBusString *args)
1309 if (auth->authenticated_pending_begin)
1310 auth->authenticated = TRUE;
1313 auth->need_disconnect = TRUE; /* client trying to send data before auth,
1316 shutdown_mech (auth);
1323 process_data_server (DBusAuth *auth,
1324 const DBusString *command,
1325 const DBusString *args)
1327 if (auth->mech != NULL)
1331 if (!_dbus_string_init (&decoded, _DBUS_INT_MAX))
1334 if (!_dbus_string_base64_decode (args, 0, &decoded, 0))
1336 _dbus_string_free (&decoded);
1340 #ifdef DBUS_ENABLE_VERBOSE_MODE
1341 if (_dbus_string_validate_ascii (&decoded, 0,
1342 _dbus_string_get_length (&decoded)))
1345 _dbus_string_get_const_data (&decoded, &s);
1346 _dbus_verbose ("data: '%s'\n", s);
1350 if (!(* auth->mech->server_data_func) (auth, &decoded))
1352 _dbus_string_free (&decoded);
1356 _dbus_string_free (&decoded);
1360 if (!_dbus_string_append (&auth->outgoing,
1361 "ERROR \"Not currently in an auth conversation\"\r\n"))
1369 process_error_server (DBusAuth *auth,
1370 const DBusString *command,
1371 const DBusString *args)
1377 /* return FALSE if no memory, TRUE if all OK */
1379 get_word (const DBusString *str,
1385 _dbus_string_skip_blank (str, *start, start);
1386 _dbus_string_find_blank (str, *start, &i);
1390 if (!_dbus_string_copy_len (str, *start, i - *start, word, 0))
1400 record_mechanisms (DBusAuth *auth,
1401 const DBusString *command,
1402 const DBusString *args)
1407 if (auth->already_got_mechanisms)
1410 len = _dbus_string_get_length (args);
1416 const DBusAuthMechanismHandler *mech;
1418 if (!_dbus_string_init (&m, _DBUS_INT_MAX))
1421 if (!get_word (args, &next, &m))
1424 mech = find_mech (&m);
1428 /* FIXME right now we try mechanisms in the order
1429 * the server lists them; should we do them in
1430 * some more deterministic order?
1432 * Probably in all_mechanisms order, our order of
1433 * preference. Of course when the server is us,
1434 * it lists things in that order anyhow.
1437 _dbus_verbose ("Adding mechanism %s to list we will try\n",
1440 if (!_dbus_list_append (& DBUS_AUTH_CLIENT (auth)->mechs_to_try,
1448 _dbus_string_get_const_data (&m, &s);
1449 _dbus_verbose ("Server offered mechanism \"%s\" that we don't know how to use\n",
1453 _dbus_string_free (&m);
1456 auth->already_got_mechanisms = TRUE;
1461 _dbus_list_clear (& DBUS_AUTH_CLIENT (auth)->mechs_to_try);
1467 client_try_next_mechanism (DBusAuth *auth)
1469 const DBusAuthMechanismHandler *mech;
1470 DBusString auth_command;
1472 if (DBUS_AUTH_CLIENT (auth)->mechs_to_try == NULL)
1475 mech = DBUS_AUTH_CLIENT (auth)->mechs_to_try->data;
1477 if (!_dbus_string_init (&auth_command, _DBUS_INT_MAX))
1480 if (!_dbus_string_append (&auth_command,
1483 _dbus_string_free (&auth_command);
1487 if (!_dbus_string_append (&auth_command,
1490 _dbus_string_free (&auth_command);
1494 if (mech->client_initial_response_func != NULL)
1496 if (!_dbus_string_append (&auth_command, " "))
1498 _dbus_string_free (&auth_command);
1502 if (!(* mech->client_initial_response_func) (auth, &auth_command))
1504 _dbus_string_free (&auth_command);
1509 if (!_dbus_string_append (&auth_command,
1512 _dbus_string_free (&auth_command);
1516 if (!_dbus_string_copy (&auth_command, 0,
1518 _dbus_string_get_length (&auth->outgoing)))
1520 _dbus_string_free (&auth_command);
1525 _dbus_list_pop_first (& DBUS_AUTH_CLIENT (auth)->mechs_to_try);
1527 _dbus_verbose ("Trying mechanism %s\n",
1528 auth->mech->mechanism);
1530 _dbus_string_free (&auth_command);
1536 process_rejected (DBusAuth *auth,
1537 const DBusString *command,
1538 const DBusString *args)
1540 shutdown_mech (auth);
1542 if (!auth->already_got_mechanisms)
1544 if (!record_mechanisms (auth, command, args))
1548 if (DBUS_AUTH_CLIENT (auth)->mechs_to_try != NULL)
1550 client_try_next_mechanism (auth);
1555 auth->need_disconnect = TRUE;
1562 process_ok (DBusAuth *auth,
1563 const DBusString *command,
1564 const DBusString *args)
1566 if (!_dbus_string_append (&auth->outgoing,
1570 auth->authenticated_pending_output = TRUE;
1576 process_data_client (DBusAuth *auth,
1577 const DBusString *command,
1578 const DBusString *args)
1580 if (auth->mech != NULL)
1584 if (!_dbus_string_init (&decoded, _DBUS_INT_MAX))
1587 if (!_dbus_string_base64_decode (args, 0, &decoded, 0))
1589 _dbus_string_free (&decoded);
1593 #ifdef DBUS_ENABLE_VERBOSE_MODE
1594 if (_dbus_string_validate_ascii (&decoded, 0,
1595 _dbus_string_get_length (&decoded)))
1598 _dbus_string_get_const_data (&decoded, &s);
1599 _dbus_verbose ("data: '%s'\n", s);
1603 if (!(* auth->mech->client_data_func) (auth, &decoded))
1605 _dbus_string_free (&decoded);
1609 _dbus_string_free (&decoded);
1613 if (!_dbus_string_append (&auth->outgoing,
1614 "ERROR \"Got DATA when not in an auth exchange\"\r\n"))
1622 process_error_client (DBusAuth *auth,
1623 const DBusString *command,
1624 const DBusString *args)
1630 process_unknown (DBusAuth *auth,
1631 const DBusString *command,
1632 const DBusString *args)
1634 if (!_dbus_string_append (&auth->outgoing,
1635 "ERROR \"Unknown command\"\r\n"))
1641 /* returns whether to call it again right away */
1643 process_command (DBusAuth *auth)
1651 /* _dbus_verbose (" trying process_command()\n"); */
1656 if (!_dbus_string_find (&auth->incoming, 0, "\r\n", &eol))
1659 if (!_dbus_string_init (&command, _DBUS_INT_MAX))
1661 auth->needed_memory = TRUE;
1665 if (!_dbus_string_init (&args, _DBUS_INT_MAX))
1667 auth->needed_memory = TRUE;
1671 if (eol > _DBUS_ONE_MEGABYTE)
1673 /* This is a giant line, someone is trying to hose us. */
1674 if (!_dbus_string_append (&auth->outgoing, "ERROR \"Command too long\"\r\n"))
1680 if (!_dbus_string_copy_len (&auth->incoming, 0, eol, &command, 0))
1683 if (!_dbus_string_validate_ascii (&command, 0,
1684 _dbus_string_get_length (&command)))
1686 _dbus_verbose ("Command contained non-ASCII chars or embedded nul\n");
1687 if (!_dbus_string_append (&auth->outgoing, "ERROR \"Command contained non-ASCII\"\r\n"))
1695 _dbus_string_get_const_data (&command, &q);
1696 _dbus_verbose ("got command \"%s\"\n", q);
1699 _dbus_string_find_blank (&command, 0, &i);
1700 _dbus_string_skip_blank (&command, i, &j);
1703 _dbus_string_delete (&command, i, j - i);
1705 if (!_dbus_string_move (&command, i, &args, 0))
1709 while (auth->handlers[i].command != NULL)
1711 if (_dbus_string_equal_c_str (&command,
1712 auth->handlers[i].command))
1714 _dbus_verbose ("Processing auth command %s\n",
1715 auth->handlers[i].command);
1717 if (!(* auth->handlers[i].func) (auth, &command, &args))
1725 if (auth->handlers[i].command == NULL)
1727 if (!process_unknown (auth, &command, &args))
1733 /* We've succeeded in processing the whole command so drop it out
1734 * of the incoming buffer and return TRUE to try another command.
1737 _dbus_string_delete (&auth->incoming, 0, eol);
1740 _dbus_string_delete (&auth->incoming, 0, 2);
1745 _dbus_string_free (&args);
1746 _dbus_string_free (&command);
1749 auth->needed_memory = TRUE;
1751 auth->needed_memory = FALSE;
1760 * @addtogroup DBusAuth
1765 * Creates a new auth conversation object for the server side.
1766 * See doc/dbus-sasl-profile.txt for full details on what
1769 * @returns the new object or #NULL if no memory
1772 _dbus_auth_server_new (void)
1775 DBusAuthServer *server_auth;
1777 auth = _dbus_auth_new (sizeof (DBusAuthServer));
1781 auth->handlers = server_handlers;
1783 server_auth = DBUS_AUTH_SERVER (auth);
1785 /* perhaps this should be per-mechanism with a lower
1788 server_auth->failures = 0;
1789 server_auth->max_failures = 6;
1795 * Creates a new auth conversation object for the client side.
1796 * See doc/dbus-sasl-profile.txt for full details on what
1799 * @returns the new object or #NULL if no memory
1802 _dbus_auth_client_new (void)
1806 auth = _dbus_auth_new (sizeof (DBusAuthClient));
1810 auth->handlers = client_handlers;
1812 /* Add a default mechanism to try */
1813 if (!_dbus_list_append (& DBUS_AUTH_CLIENT (auth)->mechs_to_try,
1814 (void*) &all_mechanisms[0]))
1816 _dbus_auth_unref (auth);
1820 /* Now try the mechanism we just added */
1821 if (!client_try_next_mechanism (auth))
1823 _dbus_auth_unref (auth);
1831 * Increments the refcount of an auth object.
1833 * @param auth the auth conversation
1836 _dbus_auth_ref (DBusAuth *auth)
1838 _dbus_assert (auth != NULL);
1840 auth->refcount += 1;
1844 * Decrements the refcount of an auth object.
1846 * @param auth the auth conversation
1849 _dbus_auth_unref (DBusAuth *auth)
1851 _dbus_assert (auth != NULL);
1852 _dbus_assert (auth->refcount > 0);
1854 auth->refcount -= 1;
1855 if (auth->refcount == 0)
1857 shutdown_mech (auth);
1859 if (DBUS_AUTH_IS_CLIENT (auth))
1861 _dbus_list_clear (& DBUS_AUTH_CLIENT (auth)->mechs_to_try);
1865 _dbus_keyring_unref (auth->keyring);
1867 _dbus_string_free (&auth->identity);
1868 _dbus_string_free (&auth->incoming);
1869 _dbus_string_free (&auth->outgoing);
1875 * @param auth the auth conversation object
1876 * @returns #TRUE if we're in a final state
1878 #define DBUS_AUTH_IN_END_STATE(auth) ((auth)->need_disconnect || (auth)->authenticated)
1881 * Analyzes buffered input and moves the auth conversation forward,
1882 * returning the new state of the auth conversation.
1884 * @param auth the auth conversation
1885 * @returns the new state
1888 _dbus_auth_do_work (DBusAuth *auth)
1890 auth->needed_memory = FALSE;
1892 /* Max amount we'll buffer up before deciding someone's on crack */
1893 #define MAX_BUFFER (16 * _DBUS_ONE_KILOBYTE)
1897 if (DBUS_AUTH_IN_END_STATE (auth))
1900 if (_dbus_string_get_length (&auth->incoming) > MAX_BUFFER ||
1901 _dbus_string_get_length (&auth->outgoing) > MAX_BUFFER)
1903 auth->need_disconnect = TRUE;
1904 _dbus_verbose ("Disconnecting due to excessive data buffered in auth phase\n");
1908 if (auth->mech == NULL &&
1909 auth->already_got_mechanisms &&
1910 DBUS_AUTH_CLIENT (auth)->mechs_to_try == NULL)
1912 auth->need_disconnect = TRUE;
1913 _dbus_verbose ("Disconnecting because we are out of mechanisms to try using\n");
1917 while (process_command (auth));
1919 if (DBUS_AUTH_IS_SERVER (auth) &&
1920 DBUS_AUTH_SERVER (auth)->failures >=
1921 DBUS_AUTH_SERVER (auth)->max_failures)
1922 auth->need_disconnect = TRUE;
1924 if (auth->need_disconnect)
1925 return DBUS_AUTH_STATE_NEED_DISCONNECT;
1926 else if (auth->authenticated)
1928 if (_dbus_string_get_length (&auth->incoming) > 0)
1929 return DBUS_AUTH_STATE_AUTHENTICATED_WITH_UNUSED_BYTES;
1931 return DBUS_AUTH_STATE_AUTHENTICATED;
1933 else if (auth->needed_memory)
1934 return DBUS_AUTH_STATE_WAITING_FOR_MEMORY;
1935 else if (_dbus_string_get_length (&auth->outgoing) > 0)
1936 return DBUS_AUTH_STATE_HAVE_BYTES_TO_SEND;
1938 return DBUS_AUTH_STATE_WAITING_FOR_INPUT;
1942 * Gets bytes that need to be sent to the peer we're conversing with.
1943 * After writing some bytes, _dbus_auth_bytes_sent() must be called
1944 * to notify the auth object that they were written.
1946 * @param auth the auth conversation
1947 * @param str return location for a ref to the buffer to send
1948 * @returns #FALSE if nothing to send
1951 _dbus_auth_get_bytes_to_send (DBusAuth *auth,
1952 const DBusString **str)
1954 _dbus_assert (auth != NULL);
1955 _dbus_assert (str != NULL);
1959 if (DBUS_AUTH_IN_END_STATE (auth))
1962 if (_dbus_string_get_length (&auth->outgoing) == 0)
1965 *str = &auth->outgoing;
1971 * Notifies the auth conversation object that
1972 * the given number of bytes of the outgoing buffer
1973 * have been written out.
1975 * @param auth the auth conversation
1976 * @param bytes_sent number of bytes written out
1979 _dbus_auth_bytes_sent (DBusAuth *auth,
1984 _dbus_string_get_const_data (&auth->outgoing, &s);
1985 _dbus_verbose ("Sent %d bytes of: %s\n", bytes_sent, s);
1988 _dbus_string_delete (&auth->outgoing,
1991 if (auth->authenticated_pending_output &&
1992 _dbus_string_get_length (&auth->outgoing) == 0)
1993 auth->authenticated = TRUE;
1997 * Stores bytes received from the peer we're conversing with.
1999 * @param auth the auth conversation
2000 * @param str the received bytes.
2001 * @returns #FALSE if not enough memory to store the bytes or we were already authenticated.
2004 _dbus_auth_bytes_received (DBusAuth *auth,
2005 const DBusString *str)
2007 _dbus_assert (auth != NULL);
2008 _dbus_assert (str != NULL);
2010 if (DBUS_AUTH_IN_END_STATE (auth))
2013 auth->needed_memory = FALSE;
2015 if (!_dbus_string_copy (str, 0,
2017 _dbus_string_get_length (&auth->incoming)))
2019 auth->needed_memory = TRUE;
2023 _dbus_auth_do_work (auth);
2029 * Returns leftover bytes that were not used as part of the auth
2030 * conversation. These bytes will be part of the message stream
2031 * instead. This function may not be called until authentication has
2034 * @param auth the auth conversation
2035 * @param str string to append the unused bytes to
2036 * @returns #FALSE if not enough memory to return the bytes
2039 _dbus_auth_get_unused_bytes (DBusAuth *auth,
2042 if (!DBUS_AUTH_IN_END_STATE (auth))
2045 if (!_dbus_string_move (&auth->incoming,
2047 _dbus_string_get_length (str)))
2054 * Called post-authentication, indicates whether we need to encode
2055 * the message stream with _dbus_auth_encode_data() prior to
2056 * sending it to the peer.
2058 * @param auth the auth conversation
2059 * @returns #TRUE if we need to encode the stream
2062 _dbus_auth_needs_encoding (DBusAuth *auth)
2064 if (!auth->authenticated)
2067 if (auth->mech != NULL)
2069 if (DBUS_AUTH_IS_CLIENT (auth))
2070 return auth->mech->client_encode_func != NULL;
2072 return auth->mech->server_encode_func != NULL;
2079 * Called post-authentication, encodes a block of bytes for sending to
2080 * the peer. If no encoding was negotiated, just copies the bytes
2081 * (you can avoid this by checking _dbus_auth_needs_encoding()).
2083 * @param auth the auth conversation
2084 * @param plaintext the plain text data
2085 * @param encoded initialized string to where encoded data is appended
2086 * @returns #TRUE if we had enough memory and successfully encoded
2089 _dbus_auth_encode_data (DBusAuth *auth,
2090 const DBusString *plaintext,
2091 DBusString *encoded)
2093 _dbus_assert (plaintext != encoded);
2095 if (!auth->authenticated)
2098 if (_dbus_auth_needs_encoding (auth))
2100 if (DBUS_AUTH_IS_CLIENT (auth))
2101 return (* auth->mech->client_encode_func) (auth, plaintext, encoded);
2103 return (* auth->mech->server_encode_func) (auth, plaintext, encoded);
2107 return _dbus_string_copy (plaintext, 0, encoded,
2108 _dbus_string_get_length (encoded));
2113 * Called post-authentication, indicates whether we need to decode
2114 * the message stream with _dbus_auth_decode_data() after
2115 * receiving it from the peer.
2117 * @param auth the auth conversation
2118 * @returns #TRUE if we need to encode the stream
2121 _dbus_auth_needs_decoding (DBusAuth *auth)
2123 if (!auth->authenticated)
2126 if (auth->mech != NULL)
2128 if (DBUS_AUTH_IS_CLIENT (auth))
2129 return auth->mech->client_decode_func != NULL;
2131 return auth->mech->server_decode_func != NULL;
2139 * Called post-authentication, decodes a block of bytes received from
2140 * the peer. If no encoding was negotiated, just copies the bytes (you
2141 * can avoid this by checking _dbus_auth_needs_decoding()).
2143 * @todo We need to be able to distinguish "out of memory" error
2144 * from "the data is hosed" error.
2146 * @param auth the auth conversation
2147 * @param encoded the encoded data
2148 * @param plaintext initialized string where decoded data is appended
2149 * @returns #TRUE if we had enough memory and successfully decoded
2152 _dbus_auth_decode_data (DBusAuth *auth,
2153 const DBusString *encoded,
2154 DBusString *plaintext)
2156 _dbus_assert (plaintext != encoded);
2158 if (!auth->authenticated)
2161 if (_dbus_auth_needs_decoding (auth))
2163 if (DBUS_AUTH_IS_CLIENT (auth))
2164 return (* auth->mech->client_decode_func) (auth, encoded, plaintext);
2166 return (* auth->mech->server_decode_func) (auth, encoded, plaintext);
2170 return _dbus_string_copy (encoded, 0, plaintext,
2171 _dbus_string_get_length (plaintext));
2176 * Sets credentials received via reliable means from the operating
2179 * @param auth the auth conversation
2180 * @param credentials the credentials received
2183 _dbus_auth_set_credentials (DBusAuth *auth,
2184 const DBusCredentials *credentials)
2186 auth->credentials = *credentials;
2190 * Gets the identity we authorized the client as. Apps may have
2191 * different policies as to what identities they allow.
2193 * @param auth the auth conversation
2194 * @param credentials the credentials we've authorized
2197 _dbus_auth_get_identity (DBusAuth *auth,
2198 DBusCredentials *credentials)
2200 if (auth->authenticated)
2202 *credentials = auth->authorized_identity;
2206 credentials->pid = -1;
2207 credentials->uid = -1;
2208 credentials->gid = -1;
2213 * Sets the "authentication context" which scopes cookies
2214 * with the DBUS_COOKIE_SHA1 auth mechanism for example.
2216 * @param auth the auth conversation
2217 * @param context the context
2218 * @returns #FALSE if no memory
2221 _dbus_auth_set_context (DBusAuth *auth,
2222 const DBusString *context)
2224 return _dbus_string_replace_len (context, 0, _dbus_string_get_length (context),
2225 &auth->context, 0, _dbus_string_get_length (context));
2230 #ifdef DBUS_BUILD_TESTS
2231 #include "dbus-test.h"
2232 #include "dbus-auth-script.h"
2236 process_test_subdir (const DBusString *test_base_dir,
2239 DBusString test_directory;
2240 DBusString filename;
2248 if (!_dbus_string_init (&test_directory, _DBUS_INT_MAX))
2249 _dbus_assert_not_reached ("didn't allocate test_directory\n");
2251 _dbus_string_init_const (&filename, subdir);
2253 if (!_dbus_string_copy (test_base_dir, 0,
2254 &test_directory, 0))
2255 _dbus_assert_not_reached ("couldn't copy test_base_dir to test_directory");
2257 if (!_dbus_concat_dir_and_file (&test_directory, &filename))
2258 _dbus_assert_not_reached ("couldn't allocate full path");
2260 _dbus_string_free (&filename);
2261 if (!_dbus_string_init (&filename, _DBUS_INT_MAX))
2262 _dbus_assert_not_reached ("didn't allocate filename string\n");
2264 dbus_error_init (&error);
2265 dir = _dbus_directory_open (&test_directory, &error);
2269 _dbus_string_get_const_data (&test_directory, &s);
2270 _dbus_warn ("Could not open %s: %s\n", s,
2272 dbus_error_free (&error);
2276 printf ("Testing:\n");
2279 while (_dbus_directory_get_next_file (dir, &filename, &error))
2281 DBusString full_path;
2283 if (!_dbus_string_init (&full_path, _DBUS_INT_MAX))
2284 _dbus_assert_not_reached ("couldn't init string");
2286 if (!_dbus_string_copy (&test_directory, 0, &full_path, 0))
2287 _dbus_assert_not_reached ("couldn't copy dir to full_path");
2289 if (!_dbus_concat_dir_and_file (&full_path, &filename))
2290 _dbus_assert_not_reached ("couldn't concat file to dir");
2292 if (!_dbus_string_ends_with_c_str (&filename, ".auth-script"))
2294 const char *filename_c;
2295 _dbus_string_get_const_data (&filename, &filename_c);
2296 _dbus_verbose ("Skipping non-.auth-script file %s\n",
2298 _dbus_string_free (&full_path);
2304 _dbus_string_get_const_data (&filename, &s);
2305 printf (" %s\n", s);
2308 if (!_dbus_auth_script_run (&full_path))
2310 _dbus_string_free (&full_path);
2314 _dbus_string_free (&full_path);
2317 if (dbus_error_is_set (&error))
2320 _dbus_string_get_const_data (&test_directory, &s);
2321 _dbus_warn ("Could not get next file in %s: %s\n",
2323 dbus_error_free (&error);
2332 _dbus_directory_close (dir);
2333 _dbus_string_free (&test_directory);
2334 _dbus_string_free (&filename);
2340 process_test_dirs (const char *test_data_dir)
2342 DBusString test_directory;
2347 _dbus_string_init_const (&test_directory, test_data_dir);
2349 if (!process_test_subdir (&test_directory, "auth"))
2356 _dbus_string_free (&test_directory);
2362 _dbus_auth_test (const char *test_data_dir)
2365 if (test_data_dir == NULL)
2368 if (!process_test_dirs (test_data_dir))
2374 #endif /* DBUS_BUILD_TESTS */