1 /* -*- mode: C; c-file-style: "gnu" -*- */
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 #ifdef DBUS_BUILD_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"
35 * @defgroup DBusAuthScript code for running unit test scripts for DBusAuth
36 * @ingroup DBusInternals
37 * @brief DBusAuth unit test scripting
39 * The code in here is used for unit testing, it loads
40 * up a script that tests DBusAuth.
45 /* this is slightly different from the other append_quoted_string
46 * in dbus-message-builder.c
49 append_quoted_string (DBusString *dest,
50 const DBusString *quoted)
52 dbus_bool_t in_quotes = FALSE;
53 dbus_bool_t in_backslash = FALSE;
57 while (i < _dbus_string_get_length (quoted))
61 b = _dbus_string_get_byte (quoted, i);
75 _dbus_warn ("bad backslashed byte %c\n", b);
79 if (!_dbus_string_append_byte (dest, a))
94 if (!_dbus_string_append_byte (dest, b))
102 else if (b == ' ' || b == '\n' || b == '\t')
103 break; /* end on whitespace if not quoted */
106 if (!_dbus_string_append_byte (dest, b))
118 same_first_word (const DBusString *a,
121 int first_a_blank, first_b_blank;
123 _dbus_string_find_blank (a, 0, &first_a_blank);
124 _dbus_string_find_blank (b, 0, &first_b_blank);
126 if (first_a_blank != first_b_blank)
129 return _dbus_string_equal_len (a, b, first_a_blank);
133 auth_state_from_string (const DBusString *str)
135 if (_dbus_string_starts_with_c_str (str, "WAITING_FOR_INPUT"))
136 return DBUS_AUTH_STATE_WAITING_FOR_INPUT;
137 else if (_dbus_string_starts_with_c_str (str, "WAITING_FOR_MEMORY"))
138 return DBUS_AUTH_STATE_WAITING_FOR_MEMORY;
139 else if (_dbus_string_starts_with_c_str (str, "HAVE_BYTES_TO_SEND"))
140 return DBUS_AUTH_STATE_HAVE_BYTES_TO_SEND;
141 else if (_dbus_string_starts_with_c_str (str, "NEED_DISCONNECT"))
142 return DBUS_AUTH_STATE_NEED_DISCONNECT;
143 else if (_dbus_string_starts_with_c_str (str, "AUTHENTICATED"))
144 return DBUS_AUTH_STATE_AUTHENTICATED;
150 auth_state_to_string (DBusAuthState state)
154 case DBUS_AUTH_STATE_WAITING_FOR_INPUT:
155 return "WAITING_FOR_INPUT";
156 case DBUS_AUTH_STATE_WAITING_FOR_MEMORY:
157 return "WAITING_FOR_MEMORY";
158 case DBUS_AUTH_STATE_HAVE_BYTES_TO_SEND:
159 return "HAVE_BYTES_TO_SEND";
160 case DBUS_AUTH_STATE_NEED_DISCONNECT:
161 return "NEED_DISCONNECT";
162 case DBUS_AUTH_STATE_AUTHENTICATED:
163 return "AUTHENTICATED";
170 split_string (DBusString *str)
172 int i, j, k, count, end;
175 end = _dbus_string_get_length (str);
178 _dbus_string_skip_blank (str, i, &i);
179 for (count = 0; i < end; count++)
181 _dbus_string_find_blank (str, i, &i);
182 _dbus_string_skip_blank (str, i, &i);
185 array = dbus_new0 (char *, count + 1);
190 _dbus_string_skip_blank (str, i, &i);
191 for (k = 0; k < count; k++)
193 _dbus_string_find_blank (str, i, &j);
195 array[k] = dbus_malloc (j - i + 1);
196 if (array[k] == NULL)
198 dbus_free_string_array (array);
202 _dbus_string_get_const_data_len (str, i, j - i), j - i);
203 array[k][j - i] = '\0';
205 _dbus_string_skip_blank (str, j, &i);
213 auth_set_unix_credentials(DBusAuth *auth,
217 DBusCredentials *credentials;
219 credentials = _dbus_credentials_new ();
220 if (credentials == NULL)
221 _dbus_assert_not_reached ("no memory");
223 if (uid != DBUS_UID_UNSET)
224 _dbus_credentials_add_unix_uid (credentials, uid);
225 if (pid != DBUS_PID_UNSET)
226 _dbus_credentials_add_unix_pid (credentials, pid);
228 _dbus_auth_set_credentials (auth, credentials);
230 _dbus_credentials_unref (credentials);
234 * Runs an "auth script" which is a script for testing the
235 * authentication protocol. Scripts send and receive data, and then
236 * include assertions about the state of both ends of the connection
237 * after processing the data. A script succeeds if these assertions
240 * @param filename the file containing the script to run
241 * @returns #TRUE if the script succeeds, #FALSE otherwise
244 _dbus_auth_script_run (const DBusString *filename)
252 DBusString from_auth;
260 _dbus_string_init_const (&guid, "5fa01f4202cd837709a3274ca0df9d00");
261 _dbus_string_init_const (&context, "org_freedesktop_test");
263 if (!_dbus_string_init (&file))
266 if (!_dbus_string_init (&line))
268 _dbus_string_free (&file);
272 if (!_dbus_string_init (&from_auth))
274 _dbus_string_free (&file);
275 _dbus_string_free (&line);
279 dbus_error_init (&error);
280 if (!_dbus_file_get_contents (&file, filename, &error)) {
281 _dbus_warn ("Getting contents of %s failed: %s\n",
282 _dbus_string_get_const_data (filename), error.message);
283 dbus_error_free (&error);
287 state = DBUS_AUTH_STATE_NEED_DISCONNECT;
291 while (_dbus_string_pop_line (&file, &line))
295 /* _dbus_warn ("%s\n", _dbus_string_get_const_data (&line)); */
297 _dbus_string_delete_leading_blanks (&line);
301 while ((state = _dbus_auth_do_work (auth)) ==
302 DBUS_AUTH_STATE_HAVE_BYTES_TO_SEND)
304 const DBusString *tmp;
305 if (_dbus_auth_get_bytes_to_send (auth, &tmp))
307 int count = _dbus_string_get_length (tmp);
309 if (_dbus_string_copy (tmp, 0, &from_auth,
310 _dbus_string_get_length (&from_auth)))
311 _dbus_auth_bytes_sent (auth, count);
316 if (_dbus_string_get_length (&line) == 0)
321 else if (_dbus_string_starts_with_c_str (&line,
324 /* Ignore this comment */
327 else if (_dbus_string_starts_with_c_str (&line,
330 DBusCredentials *creds;
334 _dbus_warn ("already created a DBusAuth (CLIENT or SERVER given twice)\n");
338 auth = _dbus_auth_client_new ();
341 _dbus_warn ("no memory to create DBusAuth\n");
346 _dbus_auth_ref (auth);
347 _dbus_auth_unref (auth);
349 creds = _dbus_credentials_new_from_current_process ();
352 _dbus_warn ("no memory for credentials\n");
353 _dbus_auth_unref (auth);
358 if (!_dbus_auth_set_credentials (auth, creds))
360 _dbus_warn ("no memory for setting credentials\n");
361 _dbus_auth_unref (auth);
363 _dbus_credentials_unref (creds);
367 _dbus_credentials_unref (creds);
369 else if (_dbus_string_starts_with_c_str (&line,
372 DBusCredentials *creds;
376 _dbus_warn ("already created a DBusAuth (CLIENT or SERVER given twice)\n");
380 auth = _dbus_auth_server_new (&guid);
383 _dbus_warn ("no memory to create DBusAuth\n");
388 _dbus_auth_ref (auth);
389 _dbus_auth_unref (auth);
391 creds = _dbus_credentials_new_from_current_process ();
394 _dbus_warn ("no memory for credentials\n");
395 _dbus_auth_unref (auth);
400 if (!_dbus_auth_set_credentials (auth, creds))
402 _dbus_warn ("no memory for setting credentials\n");
403 _dbus_auth_unref (auth);
405 _dbus_credentials_unref (creds);
409 _dbus_credentials_unref (creds);
411 _dbus_auth_set_context (auth, &context);
413 else if (auth == NULL)
415 _dbus_warn ("must specify CLIENT or SERVER\n");
419 else if (_dbus_string_starts_with_c_str (&line,
422 auth_set_unix_credentials (auth, DBUS_UID_UNSET, DBUS_PID_UNSET);
424 else if (_dbus_string_starts_with_c_str (&line,
427 auth_set_unix_credentials (auth, 0, DBUS_PID_UNSET);
429 else if (_dbus_string_starts_with_c_str (&line,
430 "SILLY_CREDENTIALS"))
432 auth_set_unix_credentials (auth, 4312, DBUS_PID_UNSET);
434 else if (_dbus_string_starts_with_c_str (&line,
439 _dbus_string_delete_first_word (&line);
440 mechs = split_string (&line);
441 _dbus_auth_set_mechanisms (auth, (const char **) mechs);
442 dbus_free_string_array (mechs);
444 else if (_dbus_string_starts_with_c_str (&line,
449 _dbus_string_delete_first_word (&line);
451 if (!_dbus_string_init (&to_send))
453 _dbus_warn ("no memory to allocate string\n");
457 if (!append_quoted_string (&to_send, &line))
459 _dbus_warn ("failed to append quoted string line %d\n",
461 _dbus_string_free (&to_send);
465 _dbus_verbose ("Sending '%s'\n", _dbus_string_get_const_data (&to_send));
467 if (!_dbus_string_append (&to_send, "\r\n"))
469 _dbus_warn ("failed to append \r\n from line %d\n",
471 _dbus_string_free (&to_send);
475 /* Replace USERID_HEX with our username in hex */
479 if (_dbus_string_find (&to_send, 0,
480 "USERID_HEX", &where))
484 if (!_dbus_string_init (&username))
486 _dbus_warn ("no memory for userid\n");
487 _dbus_string_free (&to_send);
491 if (!_dbus_append_desired_identity (&username))
493 _dbus_warn ("no memory for userid\n");
494 _dbus_string_free (&username);
495 _dbus_string_free (&to_send);
499 _dbus_string_delete (&to_send, where, strlen ("USERID_HEX"));
501 if (!_dbus_string_hex_encode (&username, 0,
504 _dbus_warn ("no memory to subst USERID_HEX\n");
505 _dbus_string_free (&username);
506 _dbus_string_free (&to_send);
510 _dbus_string_free (&username);
512 else if (_dbus_string_find (&to_send, 0,
513 "USERNAME_HEX", &where))
518 if (!_dbus_string_init (&username))
520 _dbus_warn ("no memory for username\n");
521 _dbus_string_free (&to_send);
525 if (!_dbus_username_from_current_process (&u) ||
526 !_dbus_string_copy (u, 0, &username,
527 _dbus_string_get_length (&username)))
529 _dbus_warn ("no memory for username\n");
530 _dbus_string_free (&username);
531 _dbus_string_free (&to_send);
535 _dbus_string_delete (&to_send, where, strlen ("USERNAME_HEX"));
537 if (!_dbus_string_hex_encode (&username, 0,
540 _dbus_warn ("no memory to subst USERNAME_HEX\n");
541 _dbus_string_free (&username);
542 _dbus_string_free (&to_send);
546 _dbus_string_free (&username);
553 _dbus_auth_get_buffer (auth, &buffer);
554 if (!_dbus_string_copy (&to_send, 0,
555 buffer, _dbus_string_get_length (buffer)))
557 _dbus_warn ("not enough memory to call bytes_received, or can't add bytes to auth object already in end state\n");
558 _dbus_string_free (&to_send);
559 _dbus_auth_return_buffer (auth, buffer, 0);
563 _dbus_auth_return_buffer (auth, buffer, _dbus_string_get_length (&to_send));
566 _dbus_string_free (&to_send);
568 else if (_dbus_string_starts_with_c_str (&line,
571 DBusAuthState expected;
573 _dbus_string_delete_first_word (&line);
575 expected = auth_state_from_string (&line);
578 _dbus_warn ("bad auth state given to EXPECT_STATE\n");
582 if (expected != state)
584 _dbus_warn ("expected auth state %s but got %s on line %d\n",
585 auth_state_to_string (expected),
586 auth_state_to_string (state),
591 else if (_dbus_string_starts_with_c_str (&line,
596 _dbus_string_delete_first_word (&line);
598 if (!_dbus_string_init (&received))
600 _dbus_warn ("no mem to allocate string received\n");
604 if (!_dbus_string_pop_line (&from_auth, &received))
606 _dbus_warn ("no line popped from the DBusAuth being tested, expected command %s on line %d\n",
607 _dbus_string_get_const_data (&line), line_no);
608 _dbus_string_free (&received);
612 if (!same_first_word (&received, &line))
614 _dbus_warn ("line %d expected command '%s' and got '%s'\n",
616 _dbus_string_get_const_data (&line),
617 _dbus_string_get_const_data (&received));
618 _dbus_string_free (&received);
622 _dbus_string_free (&received);
624 else if (_dbus_string_starts_with_c_str (&line,
628 const DBusString *unused;
630 _dbus_string_delete_first_word (&line);
632 if (!_dbus_string_init (&expected))
634 _dbus_warn ("no mem to allocate string expected\n");
638 if (!append_quoted_string (&expected, &line))
640 _dbus_warn ("failed to append quoted string line %d\n",
642 _dbus_string_free (&expected);
646 _dbus_auth_get_unused_bytes (auth, &unused);
648 if (_dbus_string_equal (&expected, unused))
650 _dbus_auth_delete_unused_bytes (auth);
651 _dbus_string_free (&expected);
655 _dbus_warn ("Expected unused bytes '%s' and have '%s'\n",
656 _dbus_string_get_const_data (&expected),
657 _dbus_string_get_const_data (unused));
658 _dbus_string_free (&expected);
662 else if (_dbus_string_starts_with_c_str (&line,
663 "EXPECT_HAVE_NO_CREDENTIALS"))
665 DBusCredentials *authorized_identity;
667 authorized_identity = _dbus_auth_get_identity (auth);
668 if (!_dbus_credentials_are_anonymous (authorized_identity))
670 _dbus_warn ("Expected anonymous login or failed login, but some credentials were authorized\n");
674 else if (_dbus_string_starts_with_c_str (&line,
675 "EXPECT_HAVE_SOME_CREDENTIALS"))
677 DBusCredentials *authorized_identity;
679 authorized_identity = _dbus_auth_get_identity (auth);
680 if (_dbus_credentials_are_anonymous (authorized_identity))
682 _dbus_warn ("Expected to have some credentials, but we don't\n");
686 else if (_dbus_string_starts_with_c_str (&line,
691 _dbus_string_delete_first_word (&line);
693 if (!_dbus_string_init (&expected))
695 _dbus_warn ("no mem to allocate string expected\n");
699 if (!append_quoted_string (&expected, &line))
701 _dbus_warn ("failed to append quoted string line %d\n",
703 _dbus_string_free (&expected);
707 if (_dbus_string_equal_len (&expected, &from_auth,
708 _dbus_string_get_length (&expected)))
710 _dbus_string_delete (&from_auth, 0,
711 _dbus_string_get_length (&expected));
712 _dbus_string_free (&expected);
716 _dbus_warn ("Expected exact string '%s' and have '%s'\n",
717 _dbus_string_get_const_data (&expected),
718 _dbus_string_get_const_data (&from_auth));
719 _dbus_string_free (&expected);
726 goto next_iteration; /* skip parse_failed */
730 _dbus_warn ("couldn't process line %d \"%s\"\n",
731 line_no, _dbus_string_get_const_data (&line));
738 _dbus_warn ("Auth script is bogus, did not even have CLIENT or SERVER\n");
741 else if (state == DBUS_AUTH_STATE_AUTHENTICATED)
743 const DBusString *unused;
745 _dbus_auth_get_unused_bytes (auth, &unused);
747 if (_dbus_string_get_length (unused) > 0)
749 _dbus_warn ("did not expect unused bytes (scripts must specify explicitly if they are expected)\n");
754 if (_dbus_string_get_length (&from_auth) > 0)
756 _dbus_warn ("script did not have EXPECT_ statements for all the data received from the DBusAuth\n");
757 _dbus_warn ("Leftover data: %s\n", _dbus_string_get_const_data (&from_auth));
765 _dbus_auth_unref (auth);
767 _dbus_string_free (&file);
768 _dbus_string_free (&line);
769 _dbus_string_free (&from_auth);
775 #endif /* DBUS_BUILD_TESTS */