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-internals.h"
32 #include "dbus-userdb.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 * Runs an "auth script" which is a script for testing the
214 * authentication protocol. Scripts send and receive data, and then
215 * include assertions about the state of both ends of the connection
216 * after processing the data. A script succeeds if these assertions
219 * @param filename the file containing the script to run
220 * @returns #TRUE if the script succeeds, #FALSE otherwise
223 _dbus_auth_script_run (const DBusString *filename)
231 DBusString from_auth;
238 _dbus_string_init_const (&context, "org_freedesktop_test");
240 if (!_dbus_string_init (&file))
243 if (!_dbus_string_init (&line))
245 _dbus_string_free (&file);
249 if (!_dbus_string_init (&from_auth))
251 _dbus_string_free (&file);
252 _dbus_string_free (&line);
256 dbus_error_init (&error);
257 if (!_dbus_file_get_contents (&file, filename, &error)) {
258 _dbus_warn ("Getting contents of %s failed: %s\n",
259 _dbus_string_get_const_data (filename), error.message);
260 dbus_error_free (&error);
264 state = DBUS_AUTH_STATE_NEED_DISCONNECT;
267 while (_dbus_string_pop_line (&file, &line))
271 _dbus_string_delete_leading_blanks (&line);
275 while ((state = _dbus_auth_do_work (auth)) ==
276 DBUS_AUTH_STATE_HAVE_BYTES_TO_SEND)
278 const DBusString *tmp;
279 if (_dbus_auth_get_bytes_to_send (auth, &tmp))
281 int count = _dbus_string_get_length (tmp);
283 if (_dbus_string_copy (tmp, 0, &from_auth,
284 _dbus_string_get_length (&from_auth)))
285 _dbus_auth_bytes_sent (auth, count);
290 if (_dbus_string_get_length (&line) == 0)
295 else if (_dbus_string_starts_with_c_str (&line,
298 /* Ignore this comment */
301 else if (_dbus_string_starts_with_c_str (&line,
304 DBusCredentials creds;
308 _dbus_warn ("already created a DBusAuth (CLIENT or SERVER given twice)\n");
312 auth = _dbus_auth_client_new ();
315 _dbus_warn ("no memory to create DBusAuth\n");
320 _dbus_auth_ref (auth);
321 _dbus_auth_unref (auth);
323 _dbus_credentials_from_current_process (&creds);
324 _dbus_auth_set_credentials (auth, &creds);
326 else if (_dbus_string_starts_with_c_str (&line,
329 DBusCredentials creds;
333 _dbus_warn ("already created a DBusAuth (CLIENT or SERVER given twice)\n");
337 auth = _dbus_auth_server_new ();
340 _dbus_warn ("no memory to create DBusAuth\n");
345 _dbus_auth_ref (auth);
346 _dbus_auth_unref (auth);
348 _dbus_credentials_from_current_process (&creds);
349 _dbus_auth_set_credentials (auth, &creds);
350 _dbus_auth_set_context (auth, &context);
352 else if (auth == NULL)
354 _dbus_warn ("must specify CLIENT or SERVER\n");
358 else if (_dbus_string_starts_with_c_str (&line,
361 DBusCredentials creds = { -1, -1, -1 };
362 _dbus_auth_set_credentials (auth, &creds);
364 else if (_dbus_string_starts_with_c_str (&line,
367 DBusCredentials creds = { -1, 0, 0 };
368 _dbus_auth_set_credentials (auth, &creds);
370 else if (_dbus_string_starts_with_c_str (&line,
371 "SILLY_CREDENTIALS"))
373 DBusCredentials creds = { -1, 4312, 1232 };
374 _dbus_auth_set_credentials (auth, &creds);
376 else if (_dbus_string_starts_with_c_str (&line,
381 _dbus_string_delete_first_word (&line);
382 mechs = split_string (&line);
383 _dbus_auth_set_mechanisms (auth, (const char **) mechs);
384 dbus_free_string_array (mechs);
386 else if (_dbus_string_starts_with_c_str (&line,
391 _dbus_string_delete_first_word (&line);
393 if (!_dbus_string_init (&to_send))
395 _dbus_warn ("no memory to allocate string\n");
399 if (!append_quoted_string (&to_send, &line))
401 _dbus_warn ("failed to append quoted string line %d\n",
403 _dbus_string_free (&to_send);
407 _dbus_verbose ("Sending '%s'\n", _dbus_string_get_const_data (&to_send));
409 if (!_dbus_string_append (&to_send, "\r\n"))
411 _dbus_warn ("failed to append \r\n from line %d\n",
413 _dbus_string_free (&to_send);
417 /* Replace USERID_HEX with our username in hex */
421 if (_dbus_string_find (&to_send, 0,
422 "USERID_HEX", &where))
426 if (!_dbus_string_init (&username))
428 _dbus_warn ("no memory for userid\n");
429 _dbus_string_free (&to_send);
433 if (!_dbus_string_append_uint (&username,
436 _dbus_warn ("no memory for userid\n");
437 _dbus_string_free (&username);
438 _dbus_string_free (&to_send);
442 _dbus_string_delete (&to_send, where, strlen ("USERID_HEX"));
444 if (!_dbus_string_hex_encode (&username, 0,
447 _dbus_warn ("no memory to subst USERID_HEX\n");
448 _dbus_string_free (&username);
449 _dbus_string_free (&to_send);
453 _dbus_string_free (&username);
455 else if (_dbus_string_find (&to_send, 0,
456 "USERNAME_HEX", &where))
461 if (!_dbus_string_init (&username))
463 _dbus_warn ("no memory for username\n");
464 _dbus_string_free (&to_send);
468 if (!_dbus_username_from_current_process (&u) ||
469 !_dbus_string_copy (u, 0, &username,
470 _dbus_string_get_length (&username)))
472 _dbus_warn ("no memory for username\n");
473 _dbus_string_free (&username);
474 _dbus_string_free (&to_send);
478 _dbus_string_delete (&to_send, where, strlen ("USERNAME_HEX"));
480 if (!_dbus_string_hex_encode (&username, 0,
483 _dbus_warn ("no memory to subst USERNAME_HEX\n");
484 _dbus_string_free (&username);
485 _dbus_string_free (&to_send);
489 _dbus_string_free (&username);
496 _dbus_auth_get_buffer (auth, &buffer);
497 if (!_dbus_string_copy (&to_send, 0,
498 buffer, _dbus_string_get_length (buffer)))
500 _dbus_warn ("not enough memory to call bytes_received, or can't add bytes to auth object already in end state\n");
501 _dbus_string_free (&to_send);
502 _dbus_auth_return_buffer (auth, buffer, 0);
506 _dbus_auth_return_buffer (auth, buffer, _dbus_string_get_length (&to_send));
509 _dbus_string_free (&to_send);
511 else if (_dbus_string_starts_with_c_str (&line,
514 DBusAuthState expected;
516 _dbus_string_delete_first_word (&line);
518 expected = auth_state_from_string (&line);
521 _dbus_warn ("bad auth state given to EXPECT_STATE\n");
525 if (expected != state)
527 _dbus_warn ("expected auth state %s but got %s on line %d\n",
528 auth_state_to_string (expected),
529 auth_state_to_string (state),
534 else if (_dbus_string_starts_with_c_str (&line,
539 _dbus_string_delete_first_word (&line);
541 if (!_dbus_string_init (&received))
543 _dbus_warn ("no mem to allocate string received\n");
547 if (!_dbus_string_pop_line (&from_auth, &received))
549 _dbus_warn ("no line popped from the DBusAuth being tested, expected command %s on line %d\n",
550 _dbus_string_get_const_data (&line), line_no);
551 _dbus_string_free (&received);
555 if (!same_first_word (&received, &line))
557 _dbus_warn ("line %d expected command '%s' and got '%s'\n",
559 _dbus_string_get_const_data (&line),
560 _dbus_string_get_const_data (&received));
561 _dbus_string_free (&received);
565 _dbus_string_free (&received);
567 else if (_dbus_string_starts_with_c_str (&line,
571 const DBusString *unused;
573 _dbus_string_delete_first_word (&line);
575 if (!_dbus_string_init (&expected))
577 _dbus_warn ("no mem to allocate string expected\n");
581 if (!append_quoted_string (&expected, &line))
583 _dbus_warn ("failed to append quoted string line %d\n",
585 _dbus_string_free (&expected);
589 _dbus_auth_get_unused_bytes (auth, &unused);
591 if (_dbus_string_equal (&expected, unused))
593 _dbus_auth_delete_unused_bytes (auth);
594 _dbus_string_free (&expected);
598 _dbus_warn ("Expected unused bytes '%s' and have '%s'\n",
599 _dbus_string_get_const_data (&expected),
600 _dbus_string_get_const_data (unused));
601 _dbus_string_free (&expected);
605 else if (_dbus_string_starts_with_c_str (&line,
610 _dbus_string_delete_first_word (&line);
612 if (!_dbus_string_init (&expected))
614 _dbus_warn ("no mem to allocate string expected\n");
618 if (!append_quoted_string (&expected, &line))
620 _dbus_warn ("failed to append quoted string line %d\n",
622 _dbus_string_free (&expected);
626 if (_dbus_string_equal_len (&expected, &from_auth,
627 _dbus_string_get_length (&expected)))
629 _dbus_string_delete (&from_auth, 0,
630 _dbus_string_get_length (&expected));
631 _dbus_string_free (&expected);
635 _dbus_warn ("Expected exact string '%s' and have '%s'\n",
636 _dbus_string_get_const_data (&expected),
637 _dbus_string_get_const_data (&from_auth));
638 _dbus_string_free (&expected);
645 goto next_iteration; /* skip parse_failed */
649 _dbus_warn ("couldn't process line %d \"%s\"\n",
650 line_no, _dbus_string_get_const_data (&line));
656 state == DBUS_AUTH_STATE_AUTHENTICATED)
658 const DBusString *unused;
660 _dbus_auth_get_unused_bytes (auth, &unused);
662 if (_dbus_string_get_length (unused) > 0)
664 _dbus_warn ("did not expect unused bytes (scripts must specify explicitly if they are expected)\n");
669 if (_dbus_string_get_length (&from_auth) > 0)
671 _dbus_warn ("script did not have EXPECT_ statements for all the data received from the DBusAuth\n");
672 _dbus_warn ("Leftover data: %s\n", _dbus_string_get_const_data (&from_auth));
680 _dbus_auth_unref (auth);
682 _dbus_string_free (&file);
683 _dbus_string_free (&line);
684 _dbus_string_free (&from_auth);
690 #endif /* DBUS_BUILD_TESTS */