dd864ca596d8170e6630c017232b405d056c3881
[platform/upstream/dbus.git] / dbus / dbus-auth-script.c
1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-auth-script.c Test DBusAuth using a special script file (internal to D-Bus implementation)
3  * 
4  * Copyright (C) 2003 Red Hat, Inc.
5  *
6  * Licensed under the Academic Free License version 2.1
7  * 
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.
12  *
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.
17  * 
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
21  *
22  */
23 #include <config.h>
24
25 #ifdef DBUS_BUILD_TESTS
26
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
34 /**
35  * @defgroup DBusAuthScript code for running unit test scripts for DBusAuth
36  * @ingroup  DBusInternals
37  * @brief DBusAuth unit test scripting
38  *
39  * The code in here is used for unit testing, it loads
40  * up a script that tests DBusAuth.
41  *
42  * @{
43  */
44
45 /* this is slightly different from the other append_quoted_string
46  * in dbus-message-builder.c
47  */
48 static dbus_bool_t
49 append_quoted_string (DBusString       *dest,
50                       const DBusString *quoted)
51 {
52   dbus_bool_t in_quotes = FALSE;
53   dbus_bool_t in_backslash = FALSE;
54   int i;
55
56   i = 0;
57   while (i < _dbus_string_get_length (quoted))
58     {
59       unsigned char b;
60
61       b = _dbus_string_get_byte (quoted, i);
62
63       if (in_backslash)
64         {
65           unsigned char a;
66           
67           if (b == 'r')
68             a = '\r';
69           else if (b == 'n')
70             a = '\n';
71           else if (b == '\\')
72             a = '\\';
73           else
74             {
75               _dbus_warn ("bad backslashed byte %c\n", b);
76               return FALSE;
77             }
78
79           if (!_dbus_string_append_byte (dest, a))
80             return FALSE;
81           
82           in_backslash = FALSE;
83         }
84       else if (b == '\\')
85         {
86           in_backslash = TRUE;
87         }
88       else if (in_quotes)
89         {
90           if (b == '\'')
91             in_quotes = FALSE;
92           else
93             {
94               if (!_dbus_string_append_byte (dest, b))
95                 return FALSE;
96             }
97         }
98       else
99         {
100           if (b == '\'')
101             in_quotes = TRUE;
102           else if (b == ' ' || b == '\n' || b == '\t')
103             break; /* end on whitespace if not quoted */
104           else
105             {
106               if (!_dbus_string_append_byte (dest, b))
107                 return FALSE;
108             }
109         }
110       
111       ++i;
112     }
113
114   return TRUE;
115 }
116
117 static dbus_bool_t
118 same_first_word (const DBusString *a,
119                  const DBusString *b)
120 {
121   int first_a_blank, first_b_blank;
122
123   _dbus_string_find_blank (a, 0, &first_a_blank);
124   _dbus_string_find_blank (b, 0, &first_b_blank);
125
126   if (first_a_blank != first_b_blank)
127     return FALSE;
128
129   return _dbus_string_equal_len (a, b, first_a_blank);
130 }
131
132 static DBusAuthState
133 auth_state_from_string (const DBusString *str)
134
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;
145   else
146     return -1;
147 }
148
149 static const char*
150 auth_state_to_string (DBusAuthState state)
151 {
152   switch (state)
153     {
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";
164     }
165
166   return "unknown";
167 }
168
169 static char **
170 split_string (DBusString *str)
171 {
172   int i, j, k, count, end;
173   char **array;
174
175   end = _dbus_string_get_length (str);
176
177   i = 0;
178   _dbus_string_skip_blank (str, i, &i);
179   for (count = 0; i < end; count++)
180     {
181       _dbus_string_find_blank (str, i, &i);
182       _dbus_string_skip_blank (str, i, &i);
183     }
184
185   array = dbus_new0 (char *, count + 1);
186   if (array == NULL)
187     return NULL;
188
189   i = 0;
190   _dbus_string_skip_blank (str, i, &i);
191   for (k = 0; k < count; k++)
192     {
193       _dbus_string_find_blank (str, i, &j);
194
195       array[k] = dbus_malloc (j - i + 1);
196       if (array[k] == NULL)
197         {
198           dbus_free_string_array (array);
199           return NULL;
200         }
201       memcpy (array[k],
202               _dbus_string_get_const_data_len (str, i, j - i), j - i);
203       array[k][j - i] = '\0';
204
205       _dbus_string_skip_blank (str, j, &i);
206     }
207   array[k] = NULL;
208
209   return array;
210 }
211
212 static void
213 auth_set_unix_credentials(DBusAuth  *auth,
214                           dbus_uid_t uid,
215                           dbus_pid_t pid)
216 {
217   DBusCredentials *credentials;
218
219   credentials = _dbus_credentials_new ();
220   if (credentials == NULL)
221     _dbus_assert_not_reached ("no memory");
222
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);
227
228   _dbus_auth_set_credentials (auth, credentials);
229
230   _dbus_credentials_unref (credentials);
231 }
232
233 /**
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
238  * hold.
239  *
240  * @param filename the file containing the script to run
241  * @returns #TRUE if the script succeeds, #FALSE otherwise
242  */
243 dbus_bool_t
244 _dbus_auth_script_run (const DBusString *filename)
245 {
246   DBusString file;
247   DBusError error;
248   DBusString line;
249   dbus_bool_t retval;
250   int line_no;
251   DBusAuth *auth;
252   DBusString from_auth;
253   DBusAuthState state;
254   DBusString context;
255   DBusString guid;
256   
257   retval = FALSE;
258   auth = NULL;
259
260   _dbus_string_init_const (&guid, "5fa01f4202cd837709a3274ca0df9d00");
261   _dbus_string_init_const (&context, "org_freedesktop_test");
262   
263   if (!_dbus_string_init (&file))
264     return FALSE;
265
266   if (!_dbus_string_init (&line))
267     {
268       _dbus_string_free (&file);
269       return FALSE;
270     }
271
272   if (!_dbus_string_init (&from_auth))
273     {
274       _dbus_string_free (&file);
275       _dbus_string_free (&line);
276       return FALSE;
277     }
278
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);
284       goto out;
285     }
286
287   state = DBUS_AUTH_STATE_NEED_DISCONNECT;
288   line_no = 0;
289
290  next_iteration:
291   while (_dbus_string_pop_line (&file, &line))
292     {      
293       line_no += 1;
294
295       /* _dbus_warn ("%s\n", _dbus_string_get_const_data (&line)); */
296       
297       _dbus_string_delete_leading_blanks (&line);
298
299       if (auth != NULL)
300         {
301           while ((state = _dbus_auth_do_work (auth)) ==
302                  DBUS_AUTH_STATE_HAVE_BYTES_TO_SEND)
303             {
304               const DBusString *tmp;
305               if (_dbus_auth_get_bytes_to_send (auth, &tmp))
306                 {
307                   int count = _dbus_string_get_length (tmp);
308
309                   if (_dbus_string_copy (tmp, 0, &from_auth,
310                                          _dbus_string_get_length (&from_auth)))
311                     _dbus_auth_bytes_sent (auth, count);
312                 }
313             }
314         }
315       
316       if (_dbus_string_get_length (&line) == 0)
317         {
318           /* empty line */
319           goto next_iteration;
320         }
321       else if (_dbus_string_starts_with_c_str (&line,
322                                                "#"))
323         {
324           /* Ignore this comment */
325           goto next_iteration;
326         }
327       else if (_dbus_string_starts_with_c_str (&line,
328                                                "CLIENT"))
329         {
330           DBusCredentials *creds;
331           
332           if (auth != NULL)
333             {
334               _dbus_warn ("already created a DBusAuth (CLIENT or SERVER given twice)\n");
335               goto out;
336             }
337
338           auth = _dbus_auth_client_new ();
339           if (auth == NULL)
340             {
341               _dbus_warn ("no memory to create DBusAuth\n");
342               goto out;
343             }
344
345           /* test ref/unref */
346           _dbus_auth_ref (auth);
347           _dbus_auth_unref (auth);
348
349           creds = _dbus_credentials_new_from_current_process ();
350           if (creds == NULL)
351             {
352               _dbus_warn ("no memory for credentials\n");
353               _dbus_auth_unref (auth);
354               auth = NULL;
355               goto out;
356             }
357               
358           if (!_dbus_auth_set_credentials (auth, creds))
359             {
360               _dbus_warn ("no memory for setting credentials\n");
361               _dbus_auth_unref (auth);
362               auth = NULL;
363               _dbus_credentials_unref (creds);
364               goto out;
365             }
366           
367           _dbus_credentials_unref (creds);
368         }
369       else if (_dbus_string_starts_with_c_str (&line,
370                                                "SERVER"))
371         {
372           DBusCredentials *creds;
373           
374           if (auth != NULL)
375             {
376               _dbus_warn ("already created a DBusAuth (CLIENT or SERVER given twice)\n");
377               goto out;
378             }
379
380           auth = _dbus_auth_server_new (&guid);
381           if (auth == NULL)
382             {
383               _dbus_warn ("no memory to create DBusAuth\n");
384               goto out;
385             }
386
387           /* test ref/unref */
388           _dbus_auth_ref (auth);
389           _dbus_auth_unref (auth);
390
391           creds = _dbus_credentials_new_from_current_process ();
392           if (creds == NULL)
393             {
394               _dbus_warn ("no memory for credentials\n");
395               _dbus_auth_unref (auth);
396               auth = NULL;
397               goto out;
398             }
399               
400           if (!_dbus_auth_set_credentials (auth, creds))
401             {
402               _dbus_warn ("no memory for setting credentials\n");
403               _dbus_auth_unref (auth);
404               auth = NULL;
405               _dbus_credentials_unref (creds);
406               goto out;
407             }
408           
409           _dbus_credentials_unref (creds);
410
411           _dbus_auth_set_context (auth, &context);
412         }
413       else if (auth == NULL)
414         {
415           _dbus_warn ("must specify CLIENT or SERVER\n");
416           goto out;
417
418         }
419       else if (_dbus_string_starts_with_c_str (&line,
420                                                "NO_CREDENTIALS"))
421         {
422           auth_set_unix_credentials (auth, DBUS_UID_UNSET, DBUS_PID_UNSET);
423         }
424       else if (_dbus_string_starts_with_c_str (&line,
425                                                "ROOT_CREDENTIALS"))
426         {
427           auth_set_unix_credentials (auth, 0, DBUS_PID_UNSET);
428         }
429       else if (_dbus_string_starts_with_c_str (&line,
430                                                "SILLY_CREDENTIALS"))
431         {
432           auth_set_unix_credentials (auth, 4312, DBUS_PID_UNSET);
433         }
434       else if (_dbus_string_starts_with_c_str (&line,
435                                                "ALLOWED_MECHS"))
436         {
437           char **mechs;
438
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);
443         }
444       else if (_dbus_string_starts_with_c_str (&line,
445                                                "SEND"))
446         {
447           DBusString to_send;
448           
449           _dbus_string_delete_first_word (&line);
450
451           if (!_dbus_string_init (&to_send))
452             {
453               _dbus_warn ("no memory to allocate string\n");
454               goto out;
455             }
456
457           if (!append_quoted_string (&to_send, &line))
458             {
459               _dbus_warn ("failed to append quoted string line %d\n",
460                           line_no);
461               _dbus_string_free (&to_send);
462               goto out;
463             }
464
465           _dbus_verbose ("Sending '%s'\n", _dbus_string_get_const_data (&to_send));
466           
467           if (!_dbus_string_append (&to_send, "\r\n"))
468             {
469               _dbus_warn ("failed to append \r\n from line %d\n",
470                           line_no);
471               _dbus_string_free (&to_send);
472               goto out;
473             }
474
475           /* Replace USERID_HEX with our username in hex */
476           {
477             int where;
478             
479             if (_dbus_string_find (&to_send, 0,
480                                    "USERID_HEX", &where))
481               {
482                 DBusString username;
483
484                 if (!_dbus_string_init (&username))
485                   {
486                     _dbus_warn ("no memory for userid\n");
487                     _dbus_string_free (&to_send);
488                     goto out;
489                   }
490
491                 if (!_dbus_append_desired_identity (&username))
492                   {
493                     _dbus_warn ("no memory for userid\n");
494                     _dbus_string_free (&username);
495                     _dbus_string_free (&to_send);
496                     goto out;
497                   }
498
499                 _dbus_string_delete (&to_send, where, strlen ("USERID_HEX"));
500                 
501                 if (!_dbus_string_hex_encode (&username, 0,
502                                               &to_send, where))
503                   {
504                     _dbus_warn ("no memory to subst USERID_HEX\n");
505                     _dbus_string_free (&username);
506                     _dbus_string_free (&to_send);
507                     goto out;
508                   }
509
510                 _dbus_string_free (&username);
511               }
512             else if (_dbus_string_find (&to_send, 0,
513                                         "USERNAME_HEX", &where))
514               {
515                 DBusString username;
516                 const DBusString *u;
517                 
518                 if (!_dbus_string_init (&username))
519                   {
520                     _dbus_warn ("no memory for username\n");
521                     _dbus_string_free (&to_send);
522                     goto out;
523                   }
524
525                 if (!_dbus_username_from_current_process (&u) ||
526                     !_dbus_string_copy (u, 0, &username,
527                                         _dbus_string_get_length (&username)))
528                   {
529                     _dbus_warn ("no memory for username\n");
530                     _dbus_string_free (&username);
531                     _dbus_string_free (&to_send);
532                     goto out;
533                   }
534
535                 _dbus_string_delete (&to_send, where, strlen ("USERNAME_HEX"));
536                 
537                 if (!_dbus_string_hex_encode (&username, 0,
538                                               &to_send, where))
539                   {
540                     _dbus_warn ("no memory to subst USERNAME_HEX\n");
541                     _dbus_string_free (&username);
542                     _dbus_string_free (&to_send);
543                     goto out;
544                   }
545
546                 _dbus_string_free (&username);
547               }
548           }
549
550           {
551             DBusString *buffer;
552
553             _dbus_auth_get_buffer (auth, &buffer);
554             if (!_dbus_string_copy (&to_send, 0,
555                                     buffer, _dbus_string_get_length (buffer)))
556               {
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);
560                 goto out;
561               }
562
563             _dbus_auth_return_buffer (auth, buffer, _dbus_string_get_length (&to_send));
564           }
565           
566           _dbus_string_free (&to_send);
567         }
568       else if (_dbus_string_starts_with_c_str (&line,
569                                                "EXPECT_STATE"))
570         {
571           DBusAuthState expected;
572           
573           _dbus_string_delete_first_word (&line);
574
575           expected = auth_state_from_string (&line);
576           if (expected < 0)
577             {
578               _dbus_warn ("bad auth state given to EXPECT_STATE\n");
579               goto parse_failed;
580             }
581
582           if (expected != state)
583             {
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),
587                           line_no);
588               goto out;
589             }
590         }
591       else if (_dbus_string_starts_with_c_str (&line,
592                                                "EXPECT_COMMAND"))
593         {
594           DBusString received;
595           
596           _dbus_string_delete_first_word (&line);
597
598           if (!_dbus_string_init (&received))
599             {
600               _dbus_warn ("no mem to allocate string received\n");
601               goto out;
602             }
603
604           if (!_dbus_string_pop_line (&from_auth, &received))
605             {
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);
609               goto out;
610             }
611
612           if (!same_first_word (&received, &line))
613             {
614               _dbus_warn ("line %d expected command '%s' and got '%s'\n",
615                           line_no,
616                           _dbus_string_get_const_data (&line),
617                           _dbus_string_get_const_data (&received));
618               _dbus_string_free (&received);
619               goto out;
620             }
621           
622           _dbus_string_free (&received);
623         }
624       else if (_dbus_string_starts_with_c_str (&line,
625                                                "EXPECT_UNUSED"))
626         {
627           DBusString expected;
628           const DBusString *unused;
629           
630           _dbus_string_delete_first_word (&line);
631
632           if (!_dbus_string_init (&expected))
633             {
634               _dbus_warn ("no mem to allocate string expected\n");
635               goto out;
636             }
637
638           if (!append_quoted_string (&expected, &line))
639             {
640               _dbus_warn ("failed to append quoted string line %d\n",
641                           line_no);
642               _dbus_string_free (&expected);
643               goto out;
644             }
645
646           _dbus_auth_get_unused_bytes (auth, &unused);
647           
648           if (_dbus_string_equal (&expected, unused))
649             {
650               _dbus_auth_delete_unused_bytes (auth);
651               _dbus_string_free (&expected);
652             }
653           else
654             {
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);
659               goto out;
660             }
661         }
662       else if (_dbus_string_starts_with_c_str (&line,
663                                                "EXPECT_HAVE_NO_CREDENTIALS"))
664         {
665           DBusCredentials *authorized_identity;
666           
667           authorized_identity = _dbus_auth_get_identity (auth);
668           if (!_dbus_credentials_are_empty (authorized_identity))
669             {
670               _dbus_warn ("Expected anonymous login or failed login, but some credentials were authorized\n");
671               goto out;
672             }
673         }
674       else if (_dbus_string_starts_with_c_str (&line,
675                                                "EXPECT_HAVE_SOME_CREDENTIALS"))
676         {
677           DBusCredentials *authorized_identity;
678           
679           authorized_identity = _dbus_auth_get_identity (auth);
680           if (_dbus_credentials_are_empty (authorized_identity))
681             {
682               _dbus_warn ("Expected to have some credentials, but we don't\n");
683               goto out;
684             }
685         }
686       else if (_dbus_string_starts_with_c_str (&line,
687                                                "EXPECT"))
688         {
689           DBusString expected;
690           
691           _dbus_string_delete_first_word (&line);
692
693           if (!_dbus_string_init (&expected))
694             {
695               _dbus_warn ("no mem to allocate string expected\n");
696               goto out;
697             }
698
699           if (!append_quoted_string (&expected, &line))
700             {
701               _dbus_warn ("failed to append quoted string line %d\n",
702                           line_no);
703               _dbus_string_free (&expected);
704               goto out;
705             }
706
707           if (_dbus_string_equal_len (&expected, &from_auth,
708                                       _dbus_string_get_length (&expected)))
709             {
710               _dbus_string_delete (&from_auth, 0,
711                                    _dbus_string_get_length (&expected));
712               _dbus_string_free (&expected);
713             }
714           else
715             {
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);
720               goto out;
721             }
722         }
723       else
724         goto parse_failed;
725
726       goto next_iteration; /* skip parse_failed */
727       
728     parse_failed:
729       {
730         _dbus_warn ("couldn't process line %d \"%s\"\n",
731                     line_no, _dbus_string_get_const_data (&line));
732         goto out;
733       }
734     }
735
736   if (auth == NULL)
737     {
738       _dbus_warn ("Auth script is bogus, did not even have CLIENT or SERVER\n");
739       goto out;
740     }
741   else if (state == DBUS_AUTH_STATE_AUTHENTICATED)
742     {
743       const DBusString *unused;
744
745       _dbus_auth_get_unused_bytes (auth, &unused);
746
747       if (_dbus_string_get_length (unused) > 0)
748         {
749           _dbus_warn ("did not expect unused bytes (scripts must specify explicitly if they are expected)\n");
750           goto out;
751         }
752     }
753
754   if (_dbus_string_get_length (&from_auth) > 0)
755     {
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));
758       goto out;
759     }
760   
761   retval = TRUE;
762   
763  out:
764   if (auth)
765     _dbus_auth_unref (auth);
766
767   _dbus_string_free (&file);
768   _dbus_string_free (&line);
769   _dbus_string_free (&from_auth);
770   
771   return retval;
772 }
773
774 /** @} */
775 #endif /* DBUS_BUILD_TESTS */