D-Bus: dbus-keyring.c Source File

D-Bus 1.10.22

dbus-keyring.c
1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-keyring.c Store secret cookies in your homedir
3 *
4 * Copyright (C) 2003, 2004 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 *
22 */
23
24 #include <config.h>
25 #include "dbus-keyring.h"
26 #include "dbus-protocol.h"
27 #include <dbus/dbus-string.h>
28 #include <dbus/dbus-list.h>
29 #include <dbus/dbus-sysdeps.h>
30
67 #define NEW_KEY_TIMEOUT_SECONDS (60*5)
68
73 #define EXPIRE_KEYS_TIMEOUT_SECONDS (NEW_KEY_TIMEOUT_SECONDS + (60*2))
74
77 #define MAX_TIME_TRAVEL_SECONDS (60*5)
78
83 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
84 #define MAX_KEYS_IN_FILE 10
85 #else
86 #define MAX_KEYS_IN_FILE 256
87 #endif
88
92 typedef struct
93 {
94 dbus_int32_t id;
96 long creation_time;
101 DBusString secret;
103 } DBusKey;
104
111 struct DBusKeyring
112 {
113 int refcount;
114 DBusString directory;
115 DBusString filename;
116 DBusString filename_lock;
117 DBusKey *keys;
118 int n_keys;
119 DBusCredentials *credentials;
120 };
121
122 static DBusKeyring*
123 _dbus_keyring_new (void)
124 {
125 DBusKeyring *keyring;
126
127 keyring = dbus_new0 (DBusKeyring, 1);
128 if (keyring == NULL)
129 goto out_0;
130
131 if (!_dbus_string_init (&keyring->directory))
132 goto out_1;
133
134 if (!_dbus_string_init (&keyring->filename))
135 goto out_2;
136
137 if (!_dbus_string_init (&keyring->filename_lock))
138 goto out_3;
139
140 keyring->refcount = 1;
141 keyring->keys = NULL;
142 keyring->n_keys = 0;
143
144 return keyring;
145
146 out_3:
147 _dbus_string_free (&keyring->filename);
148 out_2:
149 _dbus_string_free (&keyring->directory);
150 out_1:
151 dbus_free (keyring);
152 out_0:
153 return NULL;
154 }
155
156 static void
157 free_keys (DBusKey *keys,
158 int n_keys)
159 {
160 int i;
161
162 /* should be safe for args NULL, 0 */
163
164 i = 0;
165 while (i < n_keys)
166 {
167 _dbus_string_free (&keys[i].secret);
168 ++i;
169 }
170
171 dbus_free (keys);
172 }
173
174 /* Our locking scheme is highly unreliable. However, there is
175 * unfortunately no reliable locking scheme in user home directories;
176 * between bugs in Linux NFS, people using Tru64 or other total crap
177 * NFS, AFS, random-file-system-of-the-week, and so forth, fcntl() in
178 * homedirs simply generates tons of bug reports. This has been
179 * learned through hard experience with GConf, unfortunately.
180 *
181 * This bad hack might work better for the kind of lock we have here,
182 * which we don't expect to hold for any length of time. Crashing
183 * while we hold it should be unlikely, and timing out such that we
184 * delete a stale lock should also be unlikely except when the
185 * filesystem is running really slowly. Stuff might break in corner
186 * cases but as long as it's not a security-level breakage it should
187 * be OK.
188 */
189
191 #define MAX_LOCK_TIMEOUTS 32
192
193 #define LOCK_TIMEOUT_MILLISECONDS 250
194
195 static dbus_bool_t
196 _dbus_keyring_lock (DBusKeyring *keyring)
197 {
198 int n_timeouts;
199
200 n_timeouts = 0;
201 while (n_timeouts < MAX_LOCK_TIMEOUTS)
202 {
203 DBusError error = DBUS_ERROR_INIT;
204
205 if (_dbus_create_file_exclusively (&keyring->filename_lock,
206 &error))
207 break;
208
209 _dbus_verbose ("Did not get lock file, sleeping %d milliseconds (%s)\n",
210 LOCK_TIMEOUT_MILLISECONDS, error.message);
211 dbus_error_free (&error);
212
213 _dbus_sleep_milliseconds (LOCK_TIMEOUT_MILLISECONDS);
214
215 ++n_timeouts;
216 }
217
218 if (n_timeouts == MAX_LOCK_TIMEOUTS)
219 {
220 DBusError error = DBUS_ERROR_INIT;
221
222 _dbus_verbose ("Lock file timed out %d times, assuming stale\n",
223 n_timeouts);
224
225 if (!_dbus_delete_file (&keyring->filename_lock, &error))
226 {
227 _dbus_verbose ("Couldn't delete old lock file: %s\n",
228 error.message);
229 dbus_error_free (&error);
230 return FALSE;
231 }
232
233 if (!_dbus_create_file_exclusively (&keyring->filename_lock,
234 &error))
235 {
236 _dbus_verbose ("Couldn't create lock file after deleting stale one: %s\n",
237 error.message);
238 dbus_error_free (&error);
239 return FALSE;
240 }
241 }
242
243 return TRUE;
244 }
245
246 static void
247 _dbus_keyring_unlock (DBusKeyring *keyring)
248 {
249 DBusError error = DBUS_ERROR_INIT;
250
251 if (!_dbus_delete_file (&keyring->filename_lock, &error))
252 {
253 _dbus_warn ("Failed to delete lock file: %s\n",
254 error.message);
255 dbus_error_free (&error);
256 }
257 }
258
259 static DBusKey*
260 find_key_by_id (DBusKey *keys,
261 int n_keys,
262 int id)
263 {
264 int i;
265
266 i = 0;
267 while (i < n_keys)
268 {
269 if (keys[i].id == id)
270 return &keys[i];
271
272 ++i;
273 }
274
275 return NULL;
276 }
277
278 static dbus_bool_t
279 add_new_key (DBusKey **keys_p,
280 int *n_keys_p,
281 DBusError *error)
282 {
283 DBusKey *new;
284 DBusString bytes;
285 int id;
286 long timestamp;
287 const unsigned char *s;
288 dbus_bool_t retval;
289 DBusKey *keys;
290 int n_keys;
291
292 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
293
294 if (!_dbus_string_init (&bytes))
295 {
296 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
297 return FALSE;
298 }
299
300 keys = *keys_p;
301 n_keys = *n_keys_p;
302 retval = FALSE;
303
304 /* Generate an integer ID and then the actual key. */
305 retry:
306
307 if (!_dbus_generate_random_bytes (&bytes, 4, error))
308 goto out;
309
310 s = (const unsigned char*) _dbus_string_get_const_data (&bytes);
311
312 id = s[0] | (s[1] << 8) | (s[2] << 16) | (s[3] << 24);
313 if (id < 0)
314 id = - id;
315 _dbus_assert (id >= 0);
316
317 if (find_key_by_id (keys, n_keys, id) != NULL)
318 {
319 _dbus_string_set_length (&bytes, 0);
320 _dbus_verbose ("Key ID %d already existed, trying another one\n",
321 id);
322 goto retry;
323 }
324
325 _dbus_verbose ("Creating key with ID %d\n", id);
326
327 #define KEY_LENGTH_BYTES 24
328 _dbus_string_set_length (&bytes, 0);
329 if (!_dbus_generate_random_bytes (&bytes, KEY_LENGTH_BYTES, error))
330 {
331 goto out;
332 }
333
334 new = dbus_realloc (keys, sizeof (DBusKey) * (n_keys + 1));
335 if (new == NULL)
336 {
337 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
338 goto out;
339 }
340
341 keys = new;
342 *keys_p = keys; /* otherwise *keys_p ends up invalid */
343 n_keys += 1;
344
345 if (!_dbus_string_init (&keys[n_keys-1].secret))
346 {
347 n_keys -= 1; /* we don't want to free the one we didn't init */
348 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
349 goto out;
350 }
351
352 _dbus_get_real_time (&timestamp, NULL);
353
354 keys[n_keys-1].id = id;
355 keys[n_keys-1].creation_time = timestamp;
356 if (!_dbus_string_move (&bytes, 0,
357 &keys[n_keys-1].secret,
358 0))
359 {
360 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
361 _dbus_string_free (&keys[n_keys-1].secret);
362 n_keys -= 1;
363 goto out;
364 }
365
366 retval = TRUE;
367
368 out:
369 *n_keys_p = n_keys;
370
371 _dbus_string_free (&bytes);
372 return retval;
373 }
374
389 static dbus_bool_t
390 _dbus_keyring_reload (DBusKeyring *keyring,
391 dbus_bool_t add_new,
392 DBusError *error)
393 {
394 DBusString contents;
395 DBusString line;
396 dbus_bool_t retval;
397 dbus_bool_t have_lock;
398 DBusKey *keys;
399 int n_keys;
400 int i;
401 long now;
402 DBusError tmp_error;
403
404 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
405
406 if (!_dbus_check_dir_is_private_to_user (&keyring->directory, error))
407 return FALSE;
408
409 if (!_dbus_string_init (&contents))
410 {
411 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
412 return FALSE;
413 }
414
415 if (!_dbus_string_init (&line))
416 {
417 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
418 _dbus_string_free (&contents);
419 return FALSE;
420 }
421
422 keys = NULL;
423 n_keys = 0;
424 retval = FALSE;
425 have_lock = FALSE;
426
427 _dbus_get_real_time (&now, NULL);
428
429 if (add_new)
430 {
431 if (!_dbus_keyring_lock (keyring))
432 {
433 dbus_set_error (error, DBUS_ERROR_FAILED,
434 "Could not lock keyring file to add to it");
435 goto out;
436 }
437
438 have_lock = TRUE;
439 }
440
441 dbus_error_init (&tmp_error);
442 if (!_dbus_file_get_contents (&contents,
443 &keyring->filename,
444 &tmp_error))
445 {
446 _dbus_verbose ("Failed to load keyring file: %s\n",
447 tmp_error.message);
448 /* continue with empty keyring file, so we recreate it */
449 dbus_error_free (&tmp_error);
450 }
451
452 if (!_dbus_string_validate_ascii (&contents, 0,
453 _dbus_string_get_length (&contents)))
454 {
455 _dbus_warn ("Secret keyring file contains non-ASCII! Ignoring existing contents\n");
456 _dbus_string_set_length (&contents, 0);
457 }
458
459 /* FIXME this is badly inefficient for large keyring files
460 * (not that large keyring files exist outside of test suites)
461 */
462 while (_dbus_string_pop_line (&contents, &line))
463 {
464 int next;
465 long val;
466 int id;
467 long timestamp;
468 int len;
469 int end;
470 DBusKey *new;
471
472 /* Don't load more than the max. */
473 if (n_keys >= (add_new ? MAX_KEYS_IN_FILE - 1 : MAX_KEYS_IN_FILE))
474 break;
475
476 next = 0;
477 if (!_dbus_string_parse_int (&line, 0, &val, &next))
478 {
479 _dbus_verbose ("could not parse secret key ID at start of line\n");
480 continue;
481 }
482
483 if (val > _DBUS_INT32_MAX || val < 0)
484 {
485 _dbus_verbose ("invalid secret key ID at start of line\n");
486 continue;
487 }
488
489 id = val;
490
491 _dbus_string_skip_blank (&line, next, &next);
492
493 if (!_dbus_string_parse_int (&line, next, &timestamp, &next))
494 {
495 _dbus_verbose ("could not parse secret key timestamp\n");
496 continue;
497 }
498
499 if (timestamp < 0 ||
500 (now + MAX_TIME_TRAVEL_SECONDS) < timestamp ||
501 (now - EXPIRE_KEYS_TIMEOUT_SECONDS) > timestamp)
502 {
503 _dbus_verbose ("dropping/ignoring %ld-seconds old key with timestamp %ld as current time is %ld\n",
504 now - timestamp, timestamp, now);
505 continue;
506 }
507
508 _dbus_string_skip_blank (&line, next, &next);
509
510 len = _dbus_string_get_length (&line);
511
512 if ((len - next) == 0)
513 {
514 _dbus_verbose ("no secret key after ID and timestamp\n");
515 continue;
516 }
517
518 /* We have all three parts */
519 new = dbus_realloc (keys, sizeof (DBusKey) * (n_keys + 1));
520 if (new == NULL)
521 {
522 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
523 goto out;
524 }
525
526 keys = new;
527 n_keys += 1;
528
529 if (!_dbus_string_init (&keys[n_keys-1].secret))
530 {
531 n_keys -= 1; /* we don't want to free the one we didn't init */
532 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
533 goto out;
534 }
535
536 keys[n_keys-1].id = id;
537 keys[n_keys-1].creation_time = timestamp;
538 if (!_dbus_string_hex_decode (&line, next, &end,
539 &keys[n_keys-1].secret, 0))
540 {
541 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
542 goto out;
543 }
544
545 if (_dbus_string_get_length (&line) != end)
546 {
547 _dbus_verbose ("invalid hex encoding in keyring file\n");
548 _dbus_string_free (&keys[n_keys - 1].secret);
549 n_keys -= 1;
550 continue;
551 }
552 }
553
554 _dbus_verbose ("Successfully loaded %d existing keys\n",
555 n_keys);
556
557 if (add_new)
558 {
559 if (!add_new_key (&keys, &n_keys, error))
560 {
561 _dbus_verbose ("Failed to generate new key: %s\n",
562 error ? error->message : "(unknown)");
563 goto out;
564 }
565
566 _dbus_string_set_length (&contents, 0);
567
568 i = 0;
569 while (i < n_keys)
570 {
571 if (!_dbus_string_append_int (&contents,
572 keys[i].id))
573 goto nomem;
574
575 if (!_dbus_string_append_byte (&contents, ' '))
576 goto nomem;
577
578 if (!_dbus_string_append_int (&contents,
579 keys[i].creation_time))
580 goto nomem;
581
582 if (!_dbus_string_append_byte (&contents, ' '))
583 goto nomem;
584
585 if (!_dbus_string_hex_encode (&keys[i].secret, 0,
586 &contents,
587 _dbus_string_get_length (&contents)))
588 goto nomem;
589
590 if (!_dbus_string_append_byte (&contents, '\n'))
591 goto nomem;
592
593 ++i;
594 continue;
595
596 nomem:
597 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
598 goto out;
599 }
600
601 if (!_dbus_string_save_to_file (&contents, &keyring->filename,
602 FALSE, error))
603 goto out;
604 }
605
606 if (keyring->keys)
607 free_keys (keyring->keys, keyring->n_keys);
608 keyring->keys = keys;
609 keyring->n_keys = n_keys;
610 keys = NULL;
611 n_keys = 0;
612
613 retval = TRUE;
614
615 out:
616 if (have_lock)
617 _dbus_keyring_unlock (keyring);
618
619 if (! ((retval == TRUE && (error == NULL || error->name == NULL)) ||
620 (retval == FALSE && (error == NULL || error->name != NULL))))
621 {
622 if (error && error->name)
623 _dbus_verbose ("error is %s: %s\n", error->name, error->message);
624 _dbus_warn ("returning %d but error pointer %p name %s\n",
625 retval, error, error->name ? error->name : "(none)");
626 _dbus_assert_not_reached ("didn't handle errors properly");
627 }
628
629 if (keys != NULL)
630 {
631 i = 0;
632 while (i < n_keys)
633 {
634 _dbus_string_zero (&keys[i].secret);
635 _dbus_string_free (&keys[i].secret);
636 ++i;
637 }
638
639 dbus_free (keys);
640 }
641
642 _dbus_string_free (&contents);
643 _dbus_string_free (&line);
644
645 return retval;
646 }
647 /* end of internals */
649
662 DBusKeyring *
663 _dbus_keyring_ref (DBusKeyring *keyring)
664 {
665 keyring->refcount += 1;
666
667 return keyring;
668 }
669
676 void
677 _dbus_keyring_unref (DBusKeyring *keyring)
678 {
679 keyring->refcount -= 1;
680
681 if (keyring->refcount == 0)
682 {
683 if (keyring->credentials)
684 _dbus_credentials_unref (keyring->credentials);
685
686 _dbus_string_free (&keyring->filename);
687 _dbus_string_free (&keyring->filename_lock);
688 _dbus_string_free (&keyring->directory);
689 free_keys (keyring->keys, keyring->n_keys);
690 dbus_free (keyring);
691 }
692 }
693
704 DBusKeyring*
705 _dbus_keyring_new_for_credentials (DBusCredentials *credentials,
706 const DBusString *context,
707 DBusError *error)
708 {
709 DBusString ringdir;
710 DBusKeyring *keyring;
711 dbus_bool_t error_set;
712 DBusError tmp_error;
713 DBusCredentials *our_credentials;
714
715 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
716
717 if (_dbus_check_setuid ())
718 {
719 dbus_set_error_const (error, DBUS_ERROR_NOT_SUPPORTED,
720 "Unable to create DBus keyring when setuid");
721 return NULL;
722 }
723
724 keyring = NULL;
725 error_set = FALSE;
726 our_credentials = NULL;
727
728 if (!_dbus_string_init (&ringdir))
729 {
730 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
731 return NULL;
732 }
733
734 if (credentials != NULL)
735 {
736 our_credentials = _dbus_credentials_copy (credentials);
737 }
738 else
739 {
740 our_credentials = _dbus_credentials_new_from_current_process ();
741 }
742
743 if (our_credentials == NULL)
744 goto failed;
745
746 if (_dbus_credentials_are_anonymous (our_credentials))
747 {
748 if (!_dbus_credentials_add_from_current_process (our_credentials))
749 goto failed;
750 }
751
752 if (!_dbus_append_keyring_directory_for_credentials (&ringdir,
753 our_credentials))
754 goto failed;
755
756 keyring = _dbus_keyring_new ();
757 if (keyring == NULL)
758 goto failed;
759
760 _dbus_assert (keyring->credentials == NULL);
761 keyring->credentials = our_credentials;
762 our_credentials = NULL; /* so we don't unref it again later */
763
764 /* should have been validated already, but paranoia check here */
765 if (!_dbus_keyring_validate_context (context))
766 {
767 error_set = TRUE;
768 dbus_set_error_const (error,
769 DBUS_ERROR_FAILED,
770 "Invalid context in keyring creation");
771 goto failed;
772 }
773
774 /* Save keyring dir in the keyring object */
775 if (!_dbus_string_copy (&ringdir, 0,
776 &keyring->directory, 0))
777 goto failed;
778
779 /* Create keyring->filename based on keyring dir and context */
780 if (!_dbus_string_copy (&keyring->directory, 0,
781 &keyring->filename, 0))
782 goto failed;
783
784 if (!_dbus_concat_dir_and_file (&keyring->filename,
785 context))
786 goto failed;
787
788 /* Create lockfile name */
789 if (!_dbus_string_copy (&keyring->filename, 0,
790 &keyring->filename_lock, 0))
791 goto failed;
792
793 if (!_dbus_string_append (&keyring->filename_lock, ".lock"))
794 goto failed;
795
796 /* Reload keyring */
797 dbus_error_init (&tmp_error);
798 if (!_dbus_keyring_reload (keyring, FALSE, &tmp_error))
799 {
800 _dbus_verbose ("didn't load an existing keyring: %s\n",
801 tmp_error.message);
802 dbus_error_free (&tmp_error);
803 }
804
805 /* We don't fail fatally if we can't create the directory,
806 * but the keyring will probably always be empty
807 * unless someone else manages to create it
808 */
809 dbus_error_init (&tmp_error);
810 if (!_dbus_ensure_directory (&keyring->directory,
811 &tmp_error))
812 {
813 _dbus_verbose ("Creating keyring directory: %s\n",
814 tmp_error.message);
815 dbus_error_free (&tmp_error);
816 }
817
818 _dbus_string_free (&ringdir);
819
820 return keyring;
821
822 failed:
823 if (!error_set)
824 dbus_set_error_const (error,
825 DBUS_ERROR_NO_MEMORY,
826 NULL);
827 if (our_credentials)
828 _dbus_credentials_unref (our_credentials);
829 if (keyring)
830 _dbus_keyring_unref (keyring);
831 _dbus_string_free (&ringdir);
832 return NULL;
833
834 }
835
848 dbus_bool_t
849 _dbus_keyring_validate_context (const DBusString *context)
850 {
851 if (_dbus_string_get_length (context) == 0)
852 {
853 _dbus_verbose ("context is zero-length\n");
854 return FALSE;
855 }
856
857 if (!_dbus_string_validate_ascii (context, 0,
858 _dbus_string_get_length (context)))
859 {
860 _dbus_verbose ("context not valid ascii\n");
861 return FALSE;
862 }
863
864 /* no directory separators */
865 if (_dbus_string_find (context, 0, "/", NULL))
866 {
867 _dbus_verbose ("context contains a slash\n");
868 return FALSE;
869 }
870
871 if (_dbus_string_find (context, 0, "\\", NULL))
872 {
873 _dbus_verbose ("context contains a backslash\n");
874 return FALSE;
875 }
876
877 /* prevent attempts to use dotfiles or ".." or ".lock"
878 * all of which might allow some kind of attack
879 */
880 if (_dbus_string_find (context, 0, ".", NULL))
881 {
882 _dbus_verbose ("context contains a dot\n");
883 return FALSE;
884 }
885
886 /* no spaces/tabs, those are used for separators in the protocol */
887 if (_dbus_string_find_blank (context, 0, NULL))
888 {
889 _dbus_verbose ("context contains a blank\n");
890 return FALSE;
891 }
892
893 if (_dbus_string_find (context, 0, "\n", NULL))
894 {
895 _dbus_verbose ("context contains a newline\n");
896 return FALSE;
897 }
898
899 if (_dbus_string_find (context, 0, "\r", NULL))
900 {
901 _dbus_verbose ("context contains a carriage return\n");
902 return FALSE;
903 }
904
905 return TRUE;
906 }
907
908 static DBusKey*
909 find_recent_key (DBusKeyring *keyring)
910 {
911 int i;
912 long tv_sec, tv_usec;
913
914 _dbus_get_real_time (&tv_sec, &tv_usec);
915
916 i = 0;
917 while (i < keyring->n_keys)
918 {
919 DBusKey *key = &keyring->keys[i];
920
921 _dbus_verbose ("Key %d is %ld seconds old\n",
922 i, tv_sec - key->creation_time);
923
924 if ((tv_sec - NEW_KEY_TIMEOUT_SECONDS) < key->creation_time)
925 return key;
926
927 ++i;
928 }
929
930 return NULL;
931 }
932
944 int
945 _dbus_keyring_get_best_key (DBusKeyring *keyring,
946 DBusError *error)
947 {
948 DBusKey *key;
949
950 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
951
952 key = find_recent_key (keyring);
953 if (key)
954 return key->id;
955
956 /* All our keys are too old, or we've never loaded the
957 * keyring. Create a new one.
958 */
959 if (!_dbus_keyring_reload (keyring, TRUE,
960 error))
961 return -1;
962
963 key = find_recent_key (keyring);
964 if (key)
965 return key->id;
966 else
967 {
968 dbus_set_error_const (error,
969 DBUS_ERROR_FAILED,
970 "No recent-enough key found in keyring, and unable to create a new key");
971 return -1;
972 }
973 }
974
983 dbus_bool_t
984 _dbus_keyring_is_for_credentials (DBusKeyring *keyring,
985 DBusCredentials *credentials)
986 {
987 return _dbus_credentials_same_user (keyring->credentials,
988 credentials);
989 }
990
1002 dbus_bool_t
1003 _dbus_keyring_get_hex_key (DBusKeyring *keyring,
1004 int key_id,
1005 DBusString *hex_key)
1006 {
1007 DBusKey *key;
1008
1009 key = find_key_by_id (keyring->keys,
1010 keyring->n_keys,
1011 key_id);
1012 if (key == NULL)
1013 return TRUE; /* had enough memory, so TRUE */
1014
1015 return _dbus_string_hex_encode (&key->secret, 0,
1016 hex_key,
1017 _dbus_string_get_length (hex_key));
1018 }
1019 /* end of exposed API */
1021
1022 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
1023 #include "dbus-test.h"
1024 #include <stdio.h>
1025
1026 dbus_bool_t
1027 _dbus_keyring_test (void)
1028 {
1029 DBusString context;
1030 DBusKeyring *ring1;
1031 DBusKeyring *ring2;
1032 int id;
1033 DBusError error;
1034 int i;
1035
1036 ring1 = NULL;
1037 ring2 = NULL;
1038
1039 /* Context validation */
1040
1041 _dbus_string_init_const (&context, "foo");
1042 _dbus_assert (_dbus_keyring_validate_context (&context));
1043 _dbus_string_init_const (&context, "org_freedesktop_blah");
1044 _dbus_assert (_dbus_keyring_validate_context (&context));
1045
1046 _dbus_string_init_const (&context, "");
1047 _dbus_assert (!_dbus_keyring_validate_context (&context));
1048 _dbus_string_init_const (&context, ".foo");
1049 _dbus_assert (!_dbus_keyring_validate_context (&context));
1050 _dbus_string_init_const (&context, "bar.foo");
1051 _dbus_assert (!_dbus_keyring_validate_context (&context));
1052 _dbus_string_init_const (&context, "bar/foo");
1053 _dbus_assert (!_dbus_keyring_validate_context (&context));
1054 _dbus_string_init_const (&context, "bar\\foo");
1055 _dbus_assert (!_dbus_keyring_validate_context (&context));
1056 _dbus_string_init_const (&context, "foo\xfa\xf0");
1057 _dbus_assert (!_dbus_keyring_validate_context (&context));
1058 _dbus_string_init_const (&context, "foo\x80");
1059 _dbus_assert (!_dbus_keyring_validate_context (&context));
1060 _dbus_string_init_const (&context, "foo\x7f");
1061 _dbus_assert (_dbus_keyring_validate_context (&context));
1062 _dbus_string_init_const (&context, "foo bar");
1063 _dbus_assert (!_dbus_keyring_validate_context (&context));
1064
1065 if (!_dbus_string_init (&context))
1066 _dbus_assert_not_reached ("no memory");
1067 if (!_dbus_string_append_byte (&context, '\0'))
1068 _dbus_assert_not_reached ("no memory");
1069 _dbus_assert (!_dbus_keyring_validate_context (&context));
1070 _dbus_string_free (&context);
1071
1072 /* Now verify that if we create a key in keyring 1,
1073 * it is properly loaded in keyring 2
1074 */
1075
1076 _dbus_string_init_const (&context, "org_freedesktop_dbus_testsuite");
1077 dbus_error_init (&error);
1078 ring1 = _dbus_keyring_new_for_credentials (NULL, &context,
1079 &error);
1080 _dbus_assert (ring1 != NULL);
1081 _dbus_assert (error.name == NULL);
1082
1083 id = _dbus_keyring_get_best_key (ring1, &error);
1084 if (id < 0)
1085 {
1086 fprintf (stderr, "Could not load keyring: %s\n", error.message);
1087 dbus_error_free (&error);
1088 goto failure;
1089 }
1090
1091 ring2 = _dbus_keyring_new_for_credentials (NULL, &context, &error);
1092 _dbus_assert (ring2 != NULL);
1093 _dbus_assert (error.name == NULL);
1094
1095 if (ring1->n_keys != ring2->n_keys)
1096 {
1097 fprintf (stderr, "Different number of keys in keyrings\n");
1098 goto failure;
1099 }
1100
1101 /* We guarantee we load and save keeping keys in a fixed
1102 * order
1103 */
1104 i = 0;
1105 while (i < ring1->n_keys)
1106 {
1107 if (ring1->keys[i].id != ring2->keys[i].id)
1108 {
1109 fprintf (stderr, "Keyring 1 has first key ID %d and keyring 2 has %d\n",
1110 ring1->keys[i].id, ring2->keys[i].id);
1111 goto failure;
1112 }
1113
1114 if (ring1->keys[i].creation_time != ring2->keys[i].creation_time)
1115 {
1116 fprintf (stderr, "Keyring 1 has first key time %ld and keyring 2 has %ld\n",
1117 ring1->keys[i].creation_time, ring2->keys[i].creation_time);
1118 goto failure;
1119 }
1120
1121 if (!_dbus_string_equal (&ring1->keys[i].secret,
1122 &ring2->keys[i].secret))
1123 {
1124 fprintf (stderr, "Keyrings 1 and 2 have different secrets for same ID/timestamp\n");
1125 goto failure;
1126 }
1127
1128 ++i;
1129 }
1130
1131 printf (" %d keys in test\n", ring1->n_keys);
1132
1133 /* Test ref/unref */
1134 _dbus_keyring_ref (ring1);
1135 _dbus_keyring_ref (ring2);
1136 _dbus_keyring_unref (ring1);
1137 _dbus_keyring_unref (ring2);
1138
1139
1140 /* really unref */
1141 _dbus_keyring_unref (ring1);
1142 _dbus_keyring_unref (ring2);
1143
1144 return TRUE;
1145
1146 failure:
1147 if (ring1)
1148 _dbus_keyring_unref (ring1);
1149 if (ring2)
1150 _dbus_keyring_unref (ring2);
1151
1152 return FALSE;
1153 }
1154
1155 #endif /* DBUS_ENABLE_EMBEDDED_TESTS */
1156
_dbus_string_append
dbus_bool_t _dbus_string_append(DBusString *str, const char *buffer)
Appends a nul-terminated C-style string to a DBusString.
Definition: dbus-string.c:935
_dbus_string_parse_int
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_string_parse_int(const DBusString *str, int start, long *value_return, int *end_return)
Parses an integer contained in a DBusString.
Definition: dbus-sysdeps.c:435
DBusKey::id
dbus_int32_t id
identifier used to refer to the key
Definition: dbus-keyring.c:94
DBusKeyring::refcount
int refcount
Reference count.
Definition: dbus-keyring.c:113
DBusError::message
const char * message
public error message field
Definition: dbus-errors.h:51
NULL
#define NULL
A null pointer, defined appropriately for C or C++.
DBusCredentials
Definition: dbus-credentials.c:48
_dbus_check_dir_is_private_to_user
dbus_bool_t _dbus_check_dir_is_private_to_user(DBusString *dir, DBusError *error)
Checks to make sure the given directory is private to the user.
Definition: dbus-sysdeps-unix.c:2275
_dbus_keyring_unref
void _dbus_keyring_unref(DBusKeyring *keyring)
Decrements refcount and finalizes if it reaches zero.
Definition: dbus-keyring.c:677
MAX_KEYS_IN_FILE
#define MAX_KEYS_IN_FILE
Maximum number of keys in the keyring before we just ignore the rest.
Definition: dbus-keyring.c:86
_dbus_string_equal
dbus_bool_t _dbus_string_equal(const DBusString *a, const DBusString *b)
Tests two DBusString for equality.
Definition: dbus-string.c:2013
_dbus_credentials_copy
DBusCredentials * _dbus_credentials_copy(DBusCredentials *credentials)
Copy a credentials object.
Definition: dbus-credentials.c:523
_dbus_create_file_exclusively
dbus_bool_t _dbus_create_file_exclusively(const DBusString *filename, DBusError *error)
Creates the given file, failing if the file already exists.
Definition: dbus-file-unix.c:353
dbus_realloc
void * dbus_realloc(void *memory, size_t bytes)
Resizes a block of memory previously allocated by dbus_malloc() or dbus_malloc0().
Definition: dbus-memory.c:601
_dbus_ensure_directory
dbus_bool_t _dbus_ensure_directory(const DBusString *filename, DBusError *error)
Creates a directory; succeeds if the directory is created or already existed.
Definition: dbus-sysdeps-unix.c:2956
dbus_free
void dbus_free(void *memory)
Frees a block of memory previously allocated by dbus_malloc() or dbus_malloc0().
Definition: dbus-memory.c:701
EXPIRE_KEYS_TIMEOUT_SECONDS
#define EXPIRE_KEYS_TIMEOUT_SECONDS
The time after which we drop a key from the secrets file.
Definition: dbus-keyring.c:73
_dbus_string_save_to_file
dbus_bool_t _dbus_string_save_to_file(const DBusString *str, const DBusString *filename, dbus_bool_t world_readable, DBusError *error)
Writes a string out to a file.
Definition: dbus-file-unix.c:164
_dbus_string_hex_encode
dbus_bool_t _dbus_string_hex_encode(const DBusString *source, int start, DBusString *dest, int insert_at)
Encodes a string in hex, the way MD5 and SHA-1 are usually encoded.
Definition: dbus-string.c:2259
DBUS_ERROR_NOT_SUPPORTED
#define DBUS_ERROR_NOT_SUPPORTED
Requested operation isn&#39;t supported (like ENOSYS on UNIX).
Definition: dbus-protocol.h:369
_dbus_string_append_int
DBUS_PRIVATE_EXPORT dbus_bool_t _dbus_string_append_int(DBusString *str, long value)
Appends an integer to a DBusString.
Definition: dbus-sysdeps.c:354
DBusKeyring
Internals of DBusKeyring.
Definition: dbus-keyring.c:111
_dbus_assert
#define _dbus_assert(condition)
Aborts with an error message if the condition is false.
Definition: dbus-internals.h:148
DBUS_ERROR_INIT
#define DBUS_ERROR_INIT
Expands to a suitable initializer for a DBusError on the stack.
Definition: dbus-errors.h:62
_dbus_check_setuid
dbus_bool_t _dbus_check_setuid(void)
NOTE: If you modify this function, please also consider making the corresponding change in GLib...
Definition: dbus-sysdeps-unix.c:4407
dbus_error_free
void dbus_error_free(DBusError *error)
Frees an error that&#39;s been set (or just initialized), then reinitializes the error as in dbus_error_i...
Definition: dbus-errors.c:211
_dbus_file_get_contents
dbus_bool_t _dbus_file_get_contents(DBusString *str, const DBusString *filename, DBusError *error)
Appends the contents of the given file to the string, returning error code.
Definition: dbus-file-unix.c:55
_dbus_keyring_get_hex_key
dbus_bool_t _dbus_keyring_get_hex_key(DBusKeyring *keyring, int key_id, DBusString *hex_key)
Gets the hex-encoded secret key for the given ID.
Definition: dbus-keyring.c:1003
_dbus_concat_dir_and_file
dbus_bool_t _dbus_concat_dir_and_file(DBusString *dir, const DBusString *next_component)
Appends the given filename to the given directory.
Definition: dbus-sysdeps-unix.c:3019
DBusKeyring::n_keys
int n_keys
Number of keys.
Definition: dbus-keyring.c:118
_dbus_string_init
dbus_bool_t _dbus_string_init(DBusString *str)
Initializes a string.
Definition: dbus-string.c:175
_dbus_string_copy
dbus_bool_t _dbus_string_copy(const DBusString *source, int start, DBusString *dest, int insert_at)
Like _dbus_string_move(), but does not delete the section of the source string that&#39;s copied to the d...
Definition: dbus-string.c:1283
_dbus_string_find
dbus_bool_t _dbus_string_find(const DBusString *str, int start, const char *substr, int *found)
Finds the given substring in the string, returning TRUE and filling in the byte index where the subst...
Definition: dbus-string.c:1604
_dbus_delete_file
dbus_bool_t _dbus_delete_file(const DBusString *filename, DBusError *error)
Deletes the given file.
Definition: dbus-file-unix.c:399
DBusKeyring::credentials
DBusCredentials * credentials
Credentials containing user the keyring is for.
Definition: dbus-keyring.c:119
_dbus_string_move
dbus_bool_t _dbus_string_move(DBusString *source, int start, DBusString *dest, int insert_at)
Moves the end of one string into another string.
Definition: dbus-string.c:1259
dbus_new0
#define dbus_new0(type, count)
Safe macro for using dbus_malloc0().
Definition: dbus-memory.h:59
_dbus_credentials_are_anonymous
dbus_bool_t _dbus_credentials_are_anonymous(DBusCredentials *credentials)
Checks whether a credentials object contains a user identity.
Definition: dbus-credentials.c:408
LOCK_TIMEOUT_MILLISECONDS
#define LOCK_TIMEOUT_MILLISECONDS
Length of each timeout while waiting for a lock.
Definition: dbus-keyring.c:193
DBusString
Definition: dbus-string.h:42
DBusKeyring::filename
DBusString filename
Keyring filename.
Definition: dbus-keyring.c:115
dbus_bool_t
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
_dbus_string_init_const
void _dbus_string_init_const(DBusString *str, const char *value)
Initializes a constant string.
Definition: dbus-string.c:190
_dbus_string_skip_blank
void _dbus_string_skip_blank(const DBusString *str, int start, int *end)
Skips blanks from start, storing the first non-blank in *end (blank is space or tab).
Definition: dbus-string.c:1803
DBusKey::creation_time
long creation_time
when the key was generated, as unix timestamp.
Definition: dbus-keyring.c:96
_dbus_credentials_new_from_current_process
DBusCredentials * _dbus_credentials_new_from_current_process(void)
Creates a new object with credentials (user ID and process ID) from the current process.
Definition: dbus-credentials.c:95
_dbus_string_pop_line
dbus_bool_t _dbus_string_pop_line(DBusString *source, DBusString *dest)
Assigns a newline-terminated or \r\n-terminated line from the front of the string to the given dest s...
Definition: dbus-string.c:1909
_dbus_warn
void _dbus_warn(const char *format,...)
Prints a warning message to stderr.
Definition: dbus-internals.c:230
_dbus_append_keyring_directory_for_credentials
dbus_bool_t _dbus_append_keyring_directory_for_credentials(DBusString *directory, DBusCredentials *credentials)
Appends the directory in which a keyring for the given credentials should be stored.
Definition: dbus-sysdeps-unix.c:4180
_dbus_string_zero
void _dbus_string_zero(DBusString *str)
Clears all allocated bytes in the string to zero.
Definition: dbus-string.c:2685
DBusError
Object representing an exception.
Definition: dbus-errors.h:48
_dbus_keyring_get_best_key
int _dbus_keyring_get_best_key(DBusKeyring *keyring, DBusError *error)
Gets a recent key to use for authentication.
Definition: dbus-keyring.c:945
dbus_set_error
void dbus_set_error(DBusError *error, const char *name, const char *format,...)
Assigns an error name and message to a DBusError.
Definition: dbus-errors.c:354
DBusKeyring::keys
DBusKey * keys
Keys loaded from the file.
Definition: dbus-keyring.c:117
NEW_KEY_TIMEOUT_SECONDS
#define NEW_KEY_TIMEOUT_SECONDS
The maximum age of a key before we create a new key to use in challenges.
Definition: dbus-keyring.c:67
_dbus_string_append_byte
dbus_bool_t _dbus_string_append_byte(DBusString *str, unsigned char byte)
Appends a single byte to the string, returning FALSE if not enough memory.
Definition: dbus-string.c:1157
DBusKeyring::directory
DBusString directory
Directory the below two items are inside.
Definition: dbus-keyring.c:114
_dbus_string_free
void _dbus_string_free(DBusString *str)
Frees a string created by _dbus_string_init().
Definition: dbus-string.c:259
_dbus_credentials_add_from_current_process
dbus_bool_t _dbus_credentials_add_from_current_process(DBusCredentials *credentials)
Adds the credentials of the current process to the passed-in credentials object.
Definition: dbus-sysdeps-unix.c:2621
TRUE
#define TRUE
Expands to "1".
_dbus_assert_not_reached
#define _dbus_assert_not_reached(explanation)
Aborts with an error message if called.
Definition: dbus-internals.h:159
DBUS_ERROR_FAILED
#define DBUS_ERROR_FAILED
A generic error; "something went wrong" - see the error message for more.
Definition: dbus-protocol.h:355
DBusError::name
const char * name
public error name field
Definition: dbus-errors.h:50
MAX_LOCK_TIMEOUTS
#define MAX_LOCK_TIMEOUTS
Maximum number of timeouts waiting for lock before we decide it&#39;s stale.
Definition: dbus-keyring.c:191
DBusKeyring::filename_lock
DBusString filename_lock
Name of lockfile.
Definition: dbus-keyring.c:116
_dbus_string_find_blank
dbus_bool_t _dbus_string_find_blank(const DBusString *str, int start, int *found)
Finds a blank (space or tab) in the string.
Definition: dbus-string.c:1765
_dbus_keyring_is_for_credentials
dbus_bool_t _dbus_keyring_is_for_credentials(DBusKeyring *keyring, DBusCredentials *credentials)
Checks whether the keyring is for the same user as the given credentials.
Definition: dbus-keyring.c:984
_dbus_keyring_new_for_credentials
DBusKeyring * _dbus_keyring_new_for_credentials(DBusCredentials *credentials, const DBusString *context, DBusError *error)
Creates a new keyring that lives in the ~/.dbus-keyrings directory of the user represented by credent...
Definition: dbus-keyring.c:705
dbus_error_init
void dbus_error_init(DBusError *error)
Initializes a DBusError structure.
Definition: dbus-errors.c:188
_dbus_string_hex_decode
dbus_bool_t _dbus_string_hex_decode(const DBusString *source, int start, int *end_return, DBusString *dest, int insert_at)
Decodes a string from hex encoding.
Definition: dbus-string.c:2309
_dbus_generate_random_bytes
dbus_bool_t _dbus_generate_random_bytes(DBusString *str, int n_bytes, DBusError *error)
Generates the given number of securely random bytes, using the best mechanism we can come up with...
Definition: dbus-sysdeps-unix.c:3094
MAX_TIME_TRAVEL_SECONDS
#define MAX_TIME_TRAVEL_SECONDS
The maximum amount of time a key can be in the future.
Definition: dbus-keyring.c:77
DBusKey::secret
DBusString secret
the actual key
Definition: dbus-keyring.c:101
DBUS_ERROR_NO_MEMORY
#define DBUS_ERROR_NO_MEMORY
There was not enough memory to complete an operation.
Definition: dbus-protocol.h:357
_DBUS_INT32_MAX
#define _DBUS_INT32_MAX
Maximum value of type "int32".
Definition: dbus-internals.h:259
_dbus_credentials_unref
void _dbus_credentials_unref(DBusCredentials *credentials)
Decrement refcount on credentials.
Definition: dbus-credentials.c:130
FALSE
#define FALSE
Expands to "0".
_dbus_credentials_same_user
dbus_bool_t _dbus_credentials_same_user(DBusCredentials *credentials, DBusCredentials *other_credentials)
Check whether the user-identifying credentials in two credentials objects are identical.
Definition: dbus-credentials.c:552
dbus_set_error_const
void dbus_set_error_const(DBusError *error, const char *name, const char *message)
Assigns an error name and message to a DBusError.
Definition: dbus-errors.c:243
_dbus_string_set_length
dbus_bool_t _dbus_string_set_length(DBusString *str, int length)
Sets the length of a string.
Definition: dbus-string.c:802
_dbus_sleep_milliseconds
void _dbus_sleep_milliseconds(int milliseconds)
Sleeps the given number of milliseconds.
Definition: dbus-sysdeps-unix.c:3064
_dbus_string_validate_ascii
dbus_bool_t _dbus_string_validate_ascii(const DBusString *str, int start, int len)
Checks that the given range of the string is valid ASCII with no nul bytes.
Definition: dbus-string.c:2450
_dbus_keyring_validate_context
dbus_bool_t _dbus_keyring_validate_context(const DBusString *context)
Checks whether the context is a valid context.
Definition: dbus-keyring.c:849
_dbus_get_real_time
void _dbus_get_real_time(long *tv_sec, long *tv_usec)
Get current time, as in gettimeofday().
Definition: dbus-sysdeps-unix.c:2934
_dbus_keyring_ref
DBusKeyring * _dbus_keyring_ref(DBusKeyring *keyring)
Increments reference count of the keyring.
Definition: dbus-keyring.c:663
DBusKey
A single key from the cookie file.
Definition: dbus-keyring.c:92