1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-auth-script.c Test DBusAuth using a special script file (internal to D-Bus implementation)
4 * Copyright (C) 2003 Red Hat, Inc.
6 * Licensed under the Academic Free License version 2.1
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
27 #include "dbus-auth-script.h"
28 #include "dbus-auth.h"
29 #include "dbus-string.h"
30 #include "dbus-hash.h"
31 #include "dbus-credentials.h"
32 #include "dbus-internals.h"
33 #include "dbus-authorization.h"
36 * @defgroup DBusAuthScript code for running unit test scripts for DBusAuth
37 * @ingroup DBusInternals
38 * @brief DBusAuth unit test scripting
40 * The code in here is used for unit testing, it loads
41 * up a script that tests DBusAuth.
46 /* this is slightly different from the other append_quoted_string
47 * in dbus-message-builder.c
50 append_quoted_string (DBusString *dest,
51 const DBusString *quoted)
53 dbus_bool_t in_quotes = FALSE;
54 dbus_bool_t in_backslash = FALSE;
58 while (i < _dbus_string_get_length (quoted))
62 b = _dbus_string_get_byte (quoted, i);
76 _dbus_warn ("bad backslashed byte %c\n", b);
80 if (!_dbus_string_append_byte (dest, a))
95 if (!_dbus_string_append_byte (dest, b))
103 else if (b == ' ' || b == '\n' || b == '\t')
104 break; /* end on whitespace if not quoted */
107 if (!_dbus_string_append_byte (dest, b))
119 same_first_word (const DBusString *a,
122 int first_a_blank, first_b_blank;
124 _dbus_string_find_blank (a, 0, &first_a_blank);
125 _dbus_string_find_blank (b, 0, &first_b_blank);
127 if (first_a_blank != first_b_blank)
130 return _dbus_string_equal_len (a, b, first_a_blank);
134 auth_state_from_string (const DBusString *str)
136 if (_dbus_string_starts_with_c_str (str, "WAITING_FOR_INPUT"))
137 return DBUS_AUTH_STATE_WAITING_FOR_INPUT;
138 else if (_dbus_string_starts_with_c_str (str, "WAITING_FOR_MEMORY"))
139 return DBUS_AUTH_STATE_WAITING_FOR_MEMORY;
140 else if (_dbus_string_starts_with_c_str (str, "HAVE_BYTES_TO_SEND"))
141 return DBUS_AUTH_STATE_HAVE_BYTES_TO_SEND;
142 else if (_dbus_string_starts_with_c_str (str, "NEED_DISCONNECT"))
143 return DBUS_AUTH_STATE_NEED_DISCONNECT;
144 else if (_dbus_string_starts_with_c_str (str, "AUTHENTICATED"))
145 return DBUS_AUTH_STATE_AUTHENTICATED;
151 auth_state_to_string (DBusAuthState state)
155 case DBUS_AUTH_STATE_WAITING_FOR_INPUT:
156 return "WAITING_FOR_INPUT";
157 case DBUS_AUTH_STATE_WAITING_FOR_MEMORY:
158 return "WAITING_FOR_MEMORY";
159 case DBUS_AUTH_STATE_HAVE_BYTES_TO_SEND:
160 return "HAVE_BYTES_TO_SEND";
161 case DBUS_AUTH_STATE_NEED_DISCONNECT:
162 return "NEED_DISCONNECT";
163 case DBUS_AUTH_STATE_AUTHENTICATED:
164 return "AUTHENTICATED";
171 split_string (DBusString *str)
173 int i, j, k, count, end;
176 end = _dbus_string_get_length (str);
179 _dbus_string_skip_blank (str, i, &i);
180 for (count = 0; i < end; count++)
182 _dbus_string_find_blank (str, i, &i);
183 _dbus_string_skip_blank (str, i, &i);
186 array = dbus_new0 (char *, count + 1);
191 _dbus_string_skip_blank (str, i, &i);
192 for (k = 0; k < count; k++)
194 _dbus_string_find_blank (str, i, &j);
196 array[k] = dbus_malloc (j - i + 1);
197 if (array[k] == NULL)
199 dbus_free_string_array (array);
203 _dbus_string_get_const_data_len (str, i, j - i), j - i);
204 array[k][j - i] = '\0';
206 _dbus_string_skip_blank (str, j, &i);
214 auth_set_unix_credentials(DBusAuth *auth,
218 DBusCredentials *credentials;
220 credentials = _dbus_credentials_new ();
221 if (credentials == NULL)
222 _dbus_assert_not_reached ("no memory");
224 if (uid != DBUS_UID_UNSET)
225 _dbus_credentials_add_unix_uid (credentials, uid);
226 if (pid != DBUS_PID_UNSET)
227 _dbus_credentials_add_pid (credentials, pid);
229 _dbus_auth_set_credentials (auth, credentials);
231 _dbus_credentials_unref (credentials);
235 * Runs an "auth script" which is a script for testing the
236 * authentication protocol. Scripts send and receive data, and then
237 * include assertions about the state of both ends of the connection
238 * after processing the data. A script succeeds if these assertions
241 * @param filename the file containing the script to run
242 * @returns #TRUE if the script succeeds, #FALSE otherwise
245 _dbus_auth_script_run (const DBusString *filename)
248 DBusError error = DBUS_ERROR_INIT;
253 DBusAuthorization *authorization;
254 DBusString from_auth;
261 authorization = NULL;
263 _dbus_string_init_const (&guid, "5fa01f4202cd837709a3274ca0df9d00");
264 _dbus_string_init_const (&context, "org_freedesktop_test");
266 if (!_dbus_string_init (&file))
269 if (!_dbus_string_init (&line))
271 _dbus_string_free (&file);
275 if (!_dbus_string_init (&from_auth))
277 _dbus_string_free (&file);
278 _dbus_string_free (&line);
282 if (!_dbus_file_get_contents (&file, filename, &error)) {
283 _dbus_warn ("Getting contents of %s failed: %s\n",
284 _dbus_string_get_const_data (filename), error.message);
285 dbus_error_free (&error);
289 state = DBUS_AUTH_STATE_NEED_DISCONNECT;
293 while (_dbus_string_pop_line (&file, &line))
297 /* _dbus_warn ("%s\n", _dbus_string_get_const_data (&line)); */
299 _dbus_string_delete_leading_blanks (&line);
303 while ((state = _dbus_auth_do_work (auth)) ==
304 DBUS_AUTH_STATE_HAVE_BYTES_TO_SEND)
306 const DBusString *tmp;
307 if (_dbus_auth_get_bytes_to_send (auth, &tmp))
309 int count = _dbus_string_get_length (tmp);
311 if (_dbus_string_copy (tmp, 0, &from_auth,
312 _dbus_string_get_length (&from_auth)))
313 _dbus_auth_bytes_sent (auth, count);
318 if (_dbus_string_get_length (&line) == 0)
323 else if (_dbus_string_starts_with_c_str (&line,
326 /* Ignore this comment */
330 else if (_dbus_string_starts_with_c_str (&line,
333 /* Ignore this line */
336 else if (_dbus_string_starts_with_c_str (&line,
340 _dbus_warn ("skipping unix only auth script\n");
346 else if (_dbus_string_starts_with_c_str (&line,
349 /* Ignore this line */
352 else if (_dbus_string_starts_with_c_str (&line,
356 _dbus_warn ("skipping windows only auth script\n");
361 else if (_dbus_string_starts_with_c_str (&line,
364 DBusCredentials *creds;
368 _dbus_warn ("already created a DBusAuth (CLIENT or SERVER given twice)\n");
372 auth = _dbus_auth_client_new ();
375 _dbus_warn ("no memory to create DBusAuth\n");
379 creds = _dbus_credentials_new_from_current_process ();
382 _dbus_warn ("no memory for credentials\n");
386 if (!_dbus_auth_set_credentials (auth, creds))
388 _dbus_warn ("no memory for setting credentials\n");
389 _dbus_credentials_unref (creds);
393 _dbus_credentials_unref (creds);
395 else if (_dbus_string_starts_with_c_str (&line, "SERVER") ||
396 _dbus_string_starts_with_c_str (&line, "SERVER_ANONYMOUS"))
398 DBusCredentials *creds;
402 _dbus_warn ("already created a DBusAuth (CLIENT or SERVER given twice)\n");
406 /* empty authorization, it will use default rules */
407 authorization = _dbus_authorization_new ();
408 if (authorization == NULL)
410 _dbus_warn ("no memory to create DBusAuthorization\n");
413 /* if we are testing an anonymous server, we need to enable
414 * anonymous authorization, or the mech will REJECT */
415 if (_dbus_string_starts_with_c_str (&line, "SERVER_ANONYMOUS"))
416 _dbus_authorization_set_allow_anonymous (authorization, TRUE);
418 auth = _dbus_auth_server_new (&guid, authorization);
421 _dbus_warn ("no memory to create DBusAuth\n");
425 creds = _dbus_credentials_new_from_current_process ();
428 _dbus_warn ("no memory for credentials\n");
432 if (!_dbus_auth_set_credentials (auth, creds))
434 _dbus_warn ("no memory for setting credentials\n");
435 _dbus_credentials_unref (creds);
439 _dbus_credentials_unref (creds);
441 _dbus_auth_set_context (auth, &context);
443 else if (auth == NULL)
445 _dbus_warn ("must specify CLIENT or SERVER\n");
449 else if (_dbus_string_starts_with_c_str (&line,
452 auth_set_unix_credentials (auth, DBUS_UID_UNSET, DBUS_PID_UNSET);
454 else if (_dbus_string_starts_with_c_str (&line,
457 auth_set_unix_credentials (auth, 0, DBUS_PID_UNSET);
459 else if (_dbus_string_starts_with_c_str (&line,
460 "SILLY_CREDENTIALS"))
462 auth_set_unix_credentials (auth, 4312, DBUS_PID_UNSET);
464 else if (_dbus_string_starts_with_c_str (&line,
469 _dbus_string_delete_first_word (&line);
470 mechs = split_string (&line);
471 _dbus_auth_set_mechanisms (auth, (const char **) mechs);
472 dbus_free_string_array (mechs);
474 else if (_dbus_string_starts_with_c_str (&line,
479 _dbus_string_delete_first_word (&line);
481 if (!_dbus_string_init (&to_send))
483 _dbus_warn ("no memory to allocate string\n");
487 if (!append_quoted_string (&to_send, &line))
489 _dbus_warn ("failed to append quoted string line %d\n",
491 _dbus_string_free (&to_send);
495 _dbus_verbose ("Sending '%s'\n", _dbus_string_get_const_data (&to_send));
497 if (!_dbus_string_append (&to_send, "\r\n"))
499 _dbus_warn ("failed to append \r\n from line %d\n",
501 _dbus_string_free (&to_send);
505 /* Replace USERID_HEX with our username in hex */
509 if (_dbus_string_find (&to_send, 0,
510 "USERID_HEX", &where))
514 if (!_dbus_string_init (&username))
516 _dbus_warn ("no memory for userid\n");
517 _dbus_string_free (&to_send);
521 if (!_dbus_append_user_from_current_process (&username))
523 _dbus_warn ("no memory for userid\n");
524 _dbus_string_free (&username);
525 _dbus_string_free (&to_send);
529 _dbus_string_delete (&to_send, where, strlen ("USERID_HEX"));
531 if (!_dbus_string_hex_encode (&username, 0,
534 _dbus_warn ("no memory to subst USERID_HEX\n");
535 _dbus_string_free (&username);
536 _dbus_string_free (&to_send);
540 _dbus_string_free (&username);
542 else if (_dbus_string_find (&to_send, 0,
543 "USERNAME_HEX", &where))
547 if (!_dbus_string_init (&username))
549 _dbus_warn ("no memory for username\n");
550 _dbus_string_free (&to_send);
554 if (!_dbus_append_user_from_current_process (&username))
556 _dbus_warn ("no memory for username\n");
557 _dbus_string_free (&username);
558 _dbus_string_free (&to_send);
562 _dbus_string_delete (&to_send, where, strlen ("USERNAME_HEX"));
564 if (!_dbus_string_hex_encode (&username, 0,
567 _dbus_warn ("no memory to subst USERNAME_HEX\n");
568 _dbus_string_free (&username);
569 _dbus_string_free (&to_send);
573 _dbus_string_free (&username);
580 _dbus_auth_get_buffer (auth, &buffer);
581 if (!_dbus_string_copy (&to_send, 0,
582 buffer, _dbus_string_get_length (buffer)))
584 _dbus_warn ("not enough memory to call bytes_received, or can't add bytes to auth object already in end state\n");
585 _dbus_string_free (&to_send);
586 _dbus_auth_return_buffer (auth, buffer, 0);
590 _dbus_auth_return_buffer (auth, buffer, _dbus_string_get_length (&to_send));
593 _dbus_string_free (&to_send);
595 else if (_dbus_string_starts_with_c_str (&line,
598 DBusAuthState expected;
600 _dbus_string_delete_first_word (&line);
602 expected = auth_state_from_string (&line);
605 _dbus_warn ("bad auth state given to EXPECT_STATE\n");
609 if (expected != state)
611 _dbus_warn ("expected auth state %s but got %s on line %d\n",
612 auth_state_to_string (expected),
613 auth_state_to_string (state),
618 else if (_dbus_string_starts_with_c_str (&line,
623 _dbus_string_delete_first_word (&line);
625 if (!_dbus_string_init (&received))
627 _dbus_warn ("no mem to allocate string received\n");
631 if (!_dbus_string_pop_line (&from_auth, &received))
633 _dbus_warn ("no line popped from the DBusAuth being tested, expected command %s on line %d\n",
634 _dbus_string_get_const_data (&line), line_no);
635 _dbus_string_free (&received);
639 if (!same_first_word (&received, &line))
641 _dbus_warn ("line %d expected command '%s' and got '%s'\n",
643 _dbus_string_get_const_data (&line),
644 _dbus_string_get_const_data (&received));
645 _dbus_string_free (&received);
649 _dbus_string_free (&received);
651 else if (_dbus_string_starts_with_c_str (&line,
655 const DBusString *unused;
657 _dbus_string_delete_first_word (&line);
659 if (!_dbus_string_init (&expected))
661 _dbus_warn ("no mem to allocate string expected\n");
665 if (!append_quoted_string (&expected, &line))
667 _dbus_warn ("failed to append quoted string line %d\n",
669 _dbus_string_free (&expected);
673 _dbus_auth_get_unused_bytes (auth, &unused);
675 if (_dbus_string_equal (&expected, unused))
677 _dbus_auth_delete_unused_bytes (auth);
678 _dbus_string_free (&expected);
682 _dbus_warn ("Expected unused bytes '%s' and have '%s'\n",
683 _dbus_string_get_const_data (&expected),
684 _dbus_string_get_const_data (unused));
685 _dbus_string_free (&expected);
689 else if (_dbus_string_starts_with_c_str (&line,
690 "EXPECT_HAVE_NO_CREDENTIALS"))
692 DBusCredentials *authorized_identity;
694 authorized_identity = _dbus_auth_get_identity (auth);
695 if (!_dbus_credentials_are_anonymous (authorized_identity))
697 _dbus_warn ("Expected anonymous login or failed login, but some credentials were authorized\n");
701 else if (_dbus_string_starts_with_c_str (&line,
702 "EXPECT_HAVE_SOME_CREDENTIALS"))
704 DBusCredentials *authorized_identity;
706 authorized_identity = _dbus_auth_get_identity (auth);
707 if (_dbus_credentials_are_anonymous (authorized_identity))
709 _dbus_warn ("Expected to have some credentials, but we don't\n");
713 else if (_dbus_string_starts_with_c_str (&line,
718 _dbus_string_delete_first_word (&line);
720 if (!_dbus_string_init (&expected))
722 _dbus_warn ("no mem to allocate string expected\n");
726 if (!append_quoted_string (&expected, &line))
728 _dbus_warn ("failed to append quoted string line %d\n",
730 _dbus_string_free (&expected);
734 if (_dbus_string_equal_len (&expected, &from_auth,
735 _dbus_string_get_length (&expected)))
737 _dbus_string_delete (&from_auth, 0,
738 _dbus_string_get_length (&expected));
739 _dbus_string_free (&expected);
743 _dbus_warn ("Expected exact string '%s' and have '%s'\n",
744 _dbus_string_get_const_data (&expected),
745 _dbus_string_get_const_data (&from_auth));
746 _dbus_string_free (&expected);
753 goto next_iteration; /* skip parse_failed */
757 _dbus_warn ("couldn't process line %d \"%s\"\n",
758 line_no, _dbus_string_get_const_data (&line));
765 _dbus_warn ("Auth script is bogus, did not even have CLIENT or SERVER\n");
768 else if (state == DBUS_AUTH_STATE_AUTHENTICATED)
770 const DBusString *unused;
772 _dbus_auth_get_unused_bytes (auth, &unused);
774 if (_dbus_string_get_length (unused) > 0)
776 _dbus_warn ("did not expect unused bytes (scripts must specify explicitly if they are expected)\n");
781 if (_dbus_string_get_length (&from_auth) > 0)
783 _dbus_warn ("script did not have EXPECT_ statements for all the data received from the DBusAuth\n");
784 _dbus_warn ("Leftover data: %s\n", _dbus_string_get_const_data (&from_auth));
792 _dbus_auth_free (auth);
794 _dbus_authorization_free (authorization);
796 _dbus_string_free (&file);
797 _dbus_string_free (&line);
798 _dbus_string_free (&from_auth);
804 #endif /* DBUS_ENABLE_EMBEDDED_TESTS */