1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-marshal-validate.c Validation routines for marshaled data
4 * Copyright (C) 2005 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
24 #include "dbus-internals.h"
25 #include "dbus-marshal-validate.h"
26 #include "dbus-marshal-recursive.h"
27 #include "dbus-marshal-basic.h"
28 #include "dbus-string.h"
31 * @addtogroup DBusMarshal
37 * Verifies that the range of type_str from type_pos to type_end is a
38 * valid signature. If this function returns #TRUE, it will be safe
39 * to iterate over the signature with a types-only #DBusTypeReader.
40 * The range passed in should NOT include the terminating
41 * nul/DBUS_TYPE_INVALID.
43 * @todo verify that dict entries have exactly two fields
45 * @todo require that dict entries are in an array
47 * @param type_str the string
48 * @param type_pos where the typecodes start
49 * @param len length of typecodes
50 * @returns #DBUS_VALID if valid, reason why invalid otherwise
53 _dbus_validate_signature_with_reason (const DBusString *type_str,
57 const unsigned char *p;
58 const unsigned char *end;
64 _dbus_assert (type_str != NULL);
65 _dbus_assert (type_pos < _DBUS_INT32_MAX - len);
66 _dbus_assert (len >= 0);
67 _dbus_assert (type_pos >= 0);
69 if (len > DBUS_MAXIMUM_SIGNATURE_LENGTH)
70 return DBUS_INVALID_SIGNATURE_TOO_LONG;
72 p = _dbus_string_get_const_data_len (type_str, type_pos, 0);
73 end = _dbus_string_get_const_data_len (type_str, type_pos + len, 0);
77 last = DBUS_TYPE_INVALID;
84 case DBUS_TYPE_BOOLEAN:
86 case DBUS_TYPE_UINT16:
88 case DBUS_TYPE_UINT32:
90 case DBUS_TYPE_UINT64:
91 case DBUS_TYPE_DOUBLE:
92 case DBUS_TYPE_STRING:
93 case DBUS_TYPE_OBJECT_PATH:
94 case DBUS_TYPE_SIGNATURE:
95 case DBUS_TYPE_VARIANT:
100 if (array_depth > DBUS_MAXIMUM_TYPE_RECURSION_DEPTH)
101 return DBUS_INVALID_EXCEEDED_MAXIMUM_ARRAY_RECURSION;
104 case DBUS_STRUCT_BEGIN_CHAR:
107 if (struct_depth > DBUS_MAXIMUM_TYPE_RECURSION_DEPTH)
108 return DBUS_INVALID_EXCEEDED_MAXIMUM_STRUCT_RECURSION;
111 case DBUS_STRUCT_END_CHAR:
112 if (struct_depth == 0)
113 return DBUS_INVALID_STRUCT_ENDED_BUT_NOT_STARTED;
115 if (last == DBUS_STRUCT_BEGIN_CHAR)
116 return DBUS_INVALID_STRUCT_HAS_NO_FIELDS;
121 case DBUS_DICT_ENTRY_BEGIN_CHAR:
122 if (last != DBUS_TYPE_ARRAY)
123 return DBUS_INVALID_DICT_ENTRY_NOT_INSIDE_ARRAY;
125 dict_entry_depth += 1;
127 if (dict_entry_depth > DBUS_MAXIMUM_TYPE_RECURSION_DEPTH)
128 return DBUS_INVALID_EXCEEDED_MAXIMUM_DICT_ENTRY_RECURSION;
131 case DBUS_DICT_ENTRY_END_CHAR:
132 if (dict_entry_depth == 0)
133 return DBUS_INVALID_DICT_ENTRY_ENDED_BUT_NOT_STARTED;
135 if (last == DBUS_DICT_ENTRY_BEGIN_CHAR)
136 return DBUS_INVALID_DICT_ENTRY_HAS_NO_FIELDS;
138 dict_entry_depth -= 1;
141 case DBUS_TYPE_STRUCT: /* doesn't appear in signatures */
142 case DBUS_TYPE_DICT_ENTRY: /* ditto */
144 return DBUS_INVALID_UNKNOWN_TYPECODE;
149 if (*p == DBUS_TYPE_ARRAY)
151 else if (*p == DBUS_STRUCT_END_CHAR ||
152 *p == DBUS_DICT_ENTRY_END_CHAR)
153 return DBUS_INVALID_MISSING_ARRAY_ELEMENT_TYPE;
163 return DBUS_INVALID_MISSING_ARRAY_ELEMENT_TYPE;
165 if (struct_depth > 0)
166 return DBUS_INVALID_STRUCT_STARTED_BUT_NOT_ENDED;
168 if (dict_entry_depth > 0)
169 return DBUS_INVALID_DICT_ENTRY_STARTED_BUT_NOT_ENDED;
171 _dbus_assert (last != DBUS_TYPE_ARRAY);
172 _dbus_assert (last != DBUS_STRUCT_BEGIN_CHAR);
173 _dbus_assert (last != DBUS_DICT_ENTRY_BEGIN_CHAR);
179 validate_body_helper (DBusTypeReader *reader,
181 dbus_bool_t walk_reader_to_end,
182 const unsigned char *p,
183 const unsigned char *end,
184 const unsigned char **new_p)
188 while ((current_type = _dbus_type_reader_get_current_type (reader)) != DBUS_TYPE_INVALID)
190 const unsigned char *a;
194 _dbus_verbose (" validating value of type %s type reader %p type_pos %d p %p end %p %d remain\n",
195 _dbus_type_to_string (current_type), reader, reader->type_pos, p, end,
199 /* Guarantee that p has one byte to look at */
201 return DBUS_INVALID_NOT_ENOUGH_DATA;
203 switch (current_type)
209 case DBUS_TYPE_BOOLEAN:
210 case DBUS_TYPE_INT16:
211 case DBUS_TYPE_UINT16:
212 case DBUS_TYPE_INT32:
213 case DBUS_TYPE_UINT32:
214 case DBUS_TYPE_INT64:
215 case DBUS_TYPE_UINT64:
216 case DBUS_TYPE_DOUBLE:
217 alignment = _dbus_type_get_alignment (current_type);
218 a = _DBUS_ALIGN_ADDRESS (p, alignment);
220 return DBUS_INVALID_NOT_ENOUGH_DATA;
224 return DBUS_INVALID_ALIGNMENT_PADDING_NOT_NUL;
228 if (current_type == DBUS_TYPE_BOOLEAN)
230 dbus_uint32_t v = _dbus_unpack_uint32 (byte_order,
232 if (!(v == 0 || v == 1))
233 return DBUS_INVALID_BOOLEAN_NOT_ZERO_OR_ONE;
239 case DBUS_TYPE_ARRAY:
240 case DBUS_TYPE_STRING:
241 case DBUS_TYPE_OBJECT_PATH:
243 dbus_uint32_t claimed_len;
245 a = _DBUS_ALIGN_ADDRESS (p, 4);
247 return DBUS_INVALID_NOT_ENOUGH_DATA;
251 return DBUS_INVALID_ALIGNMENT_PADDING_NOT_NUL;
255 claimed_len = _dbus_unpack_uint32 (byte_order, p);
258 /* p may now be == end */
259 _dbus_assert (p <= end);
261 if (current_type == DBUS_TYPE_ARRAY)
263 int array_elem_type = _dbus_type_reader_get_element_type (reader);
264 alignment = _dbus_type_get_alignment (array_elem_type);
265 p = _DBUS_ALIGN_ADDRESS (p, alignment);
268 if (claimed_len > (unsigned long) (end - p))
269 return DBUS_INVALID_STRING_LENGTH_OUT_OF_BOUNDS;
271 if (current_type == DBUS_TYPE_OBJECT_PATH)
274 _dbus_string_init_const_len (&str, p, claimed_len);
275 if (!_dbus_validate_path (&str, 0,
276 _dbus_string_get_length (&str)))
277 return DBUS_INVALID_BAD_PATH;
281 else if (current_type == DBUS_TYPE_STRING)
284 _dbus_string_init_const_len (&str, p, claimed_len);
285 if (!_dbus_string_validate_utf8 (&str, 0,
286 _dbus_string_get_length (&str)))
287 return DBUS_INVALID_BAD_UTF8_IN_STRING;
291 else if (current_type == DBUS_TYPE_ARRAY && claimed_len > 0)
294 DBusValidity validity;
295 const unsigned char *array_end;
297 /* Remember that the reader is types only, so we can't
298 * use it to iterate over elements. It stays the same
301 _dbus_type_reader_recurse (reader, &sub);
303 array_end = p + claimed_len;
305 while (p < array_end)
307 /* FIXME we are calling a function per array element! very bad
308 * need if (dbus_type_is_fixed(elem_type)) here to just skip
309 * big blocks of ints/bytes/etc.
312 validity = validate_body_helper (&sub, byte_order, FALSE, p, end, &p);
313 if (validity != DBUS_VALID)
318 return DBUS_INVALID_ARRAY_LENGTH_INCORRECT;
321 /* check nul termination */
322 if (current_type != DBUS_TYPE_ARRAY)
325 return DBUS_INVALID_NOT_ENOUGH_DATA;
328 return DBUS_INVALID_STRING_MISSING_NUL;
334 case DBUS_TYPE_SIGNATURE:
336 dbus_uint32_t claimed_len;
342 /* 1 is for nul termination */
343 if (claimed_len + 1 > (unsigned long) (end - p))
344 return DBUS_INVALID_SIGNATURE_LENGTH_OUT_OF_BOUNDS;
346 _dbus_string_init_const_len (&str, p, claimed_len);
347 if (!_dbus_validate_signature (&str, 0,
348 _dbus_string_get_length (&str)))
349 return DBUS_INVALID_BAD_SIGNATURE;
353 _dbus_assert (p < end);
354 if (*p != DBUS_TYPE_INVALID)
355 return DBUS_INVALID_SIGNATURE_MISSING_NUL;
359 _dbus_verbose ("p = %p end = %p claimed_len %u\n", p, end, claimed_len);
363 case DBUS_TYPE_VARIANT:
365 /* 1 byte sig len, sig typecodes, align to
366 * contained-type-boundary, values.
369 /* In addition to normal signature validation, we need to be sure
370 * the signature contains only a single (possibly container) type.
372 dbus_uint32_t claimed_len;
375 DBusValidity validity;
376 int contained_alignment;
383 if (claimed_len + 1 > (unsigned long) (end - p))
384 return DBUS_INVALID_VARIANT_SIGNATURE_LENGTH_OUT_OF_BOUNDS;
386 _dbus_string_init_const_len (&sig, p, claimed_len);
387 if (!_dbus_validate_signature (&sig, 0,
388 _dbus_string_get_length (&sig)))
389 return DBUS_INVALID_VARIANT_SIGNATURE_BAD;
393 if (*p != DBUS_TYPE_INVALID)
394 return DBUS_INVALID_VARIANT_SIGNATURE_MISSING_NUL;
397 contained_type = _dbus_first_type_in_signature (&sig, 0);
398 if (contained_type == DBUS_TYPE_INVALID)
399 return DBUS_INVALID_VARIANT_SIGNATURE_EMPTY;
401 contained_alignment = _dbus_type_get_alignment (contained_type);
403 a = _DBUS_ALIGN_ADDRESS (p, contained_alignment);
405 return DBUS_INVALID_NOT_ENOUGH_DATA;
409 return DBUS_INVALID_ALIGNMENT_PADDING_NOT_NUL;
413 _dbus_type_reader_init_types_only (&sub, &sig, 0);
415 _dbus_assert (_dbus_type_reader_get_current_type (&sub) != DBUS_TYPE_INVALID);
417 validity = validate_body_helper (&sub, byte_order, FALSE, p, end, &p);
418 if (validity != DBUS_VALID)
421 if (_dbus_type_reader_next (&sub))
422 return DBUS_INVALID_VARIANT_SIGNATURE_SPECIFIES_MULTIPLE_VALUES;
424 _dbus_assert (_dbus_type_reader_get_current_type (&sub) == DBUS_TYPE_INVALID);
428 case DBUS_TYPE_DICT_ENTRY:
429 case DBUS_TYPE_STRUCT:
432 DBusValidity validity;
434 a = _DBUS_ALIGN_ADDRESS (p, 8);
436 return DBUS_INVALID_NOT_ENOUGH_DATA;
440 return DBUS_INVALID_ALIGNMENT_PADDING_NOT_NUL;
444 _dbus_type_reader_recurse (reader, &sub);
446 validity = validate_body_helper (&sub, byte_order, TRUE, p, end, &p);
447 if (validity != DBUS_VALID)
453 _dbus_assert_not_reached ("invalid typecode in supposedly-validated signature");
458 _dbus_verbose (" validated value of type %s type reader %p type_pos %d p %p end %p %d remain\n",
459 _dbus_type_to_string (current_type), reader, reader->type_pos, p, end,
465 _dbus_verbose ("not enough data!!! p = %p end = %p end-p = %d\n",
466 p, end, (int) (end - p));
467 return DBUS_INVALID_NOT_ENOUGH_DATA;
470 if (walk_reader_to_end)
471 _dbus_type_reader_next (reader);
483 * Verifies that the range of value_str from value_pos to value_end is
484 * a legitimate value of type expected_signature. If this function
485 * returns #TRUE, it will be safe to iterate over the values with
486 * #DBusTypeReader. The signature is assumed to be already valid.
488 * If bytes_remaining is not #NULL, then leftover bytes will be stored
489 * there and #DBUS_VALID returned. If it is #NULL, then
490 * #DBUS_INVALID_TOO_MUCH_DATA will be returned if bytes are left
493 * @param expected_signature the expected types in the value_str
494 * @param expected_signature_start where in expected_signature is the signature
495 * @param byte_order the byte order
496 * @param bytes_remaining place to store leftover bytes
497 * @param value_str the string containing the body
498 * @param value_pos where the values start
499 * @param len length of values after value_pos
500 * @returns #DBUS_VALID if valid, reason why invalid otherwise
503 _dbus_validate_body_with_reason (const DBusString *expected_signature,
504 int expected_signature_start,
506 int *bytes_remaining,
507 const DBusString *value_str,
511 DBusTypeReader reader;
512 const unsigned char *p;
513 const unsigned char *end;
514 DBusValidity validity;
516 _dbus_assert (len >= 0);
517 _dbus_assert (value_pos >= 0);
518 _dbus_assert (value_pos <= _dbus_string_get_length (value_str) - len);
520 _dbus_verbose ("validating body from pos %d len %d sig '%s'\n",
521 value_pos, len, _dbus_string_get_const_data_len (expected_signature,
522 expected_signature_start,
525 _dbus_type_reader_init_types_only (&reader,
526 expected_signature, expected_signature_start);
528 p = _dbus_string_get_const_data_len (value_str, value_pos, len);
531 validity = validate_body_helper (&reader, byte_order, TRUE, p, end, &p);
532 if (validity != DBUS_VALID)
537 *bytes_remaining = end - p;
541 return DBUS_INVALID_TOO_MUCH_DATA;
544 _dbus_assert (p == end);
550 * Determine wether the given charater is valid as the first charater
553 #define VALID_INITIAL_NAME_CHARACTER(c) \
554 ( ((c) >= 'A' && (c) <= 'Z') || \
555 ((c) >= 'a' && (c) <= 'z') || \
559 * Determine wether the given charater is valid as a second or later
560 * character in a name
562 #define VALID_NAME_CHARACTER(c) \
563 ( ((c) >= '0' && (c) <= '9') || \
564 ((c) >= 'A' && (c) <= 'Z') || \
565 ((c) >= 'a' && (c) <= 'z') || \
569 * Checks that the given range of the string is a valid object path
570 * name in the D-BUS protocol. Part of the validation ensures that
571 * the object path contains only ASCII.
573 * @todo this is inconsistent with most of DBusString in that
574 * it allows a start,len range that extends past the string end.
576 * @todo change spec to disallow more things, such as spaces in the
579 * @param str the string
580 * @param start first byte index to check
581 * @param len number of bytes to check
582 * @returns #TRUE if the byte range exists and is a valid name
585 _dbus_validate_path (const DBusString *str,
589 const unsigned char *s;
590 const unsigned char *end;
591 const unsigned char *last_slash;
593 _dbus_assert (start >= 0);
594 _dbus_assert (len >= 0);
595 _dbus_assert (start <= _dbus_string_get_length (str));
597 if (len > _dbus_string_get_length (str) - start)
603 s = _dbus_string_get_const_data (str) + start;
615 if ((s - last_slash) < 2)
616 return FALSE; /* no empty path components allowed */
622 if (_DBUS_UNLIKELY (!VALID_NAME_CHARACTER (*s)))
629 if ((end - last_slash) < 2 &&
631 return FALSE; /* trailing slash not allowed unless the string is "/" */
637 * Checks that the given range of the string is a valid interface name
638 * in the D-BUS protocol. This includes a length restriction and an
639 * ASCII subset, see the specification.
641 * @todo this is inconsistent with most of DBusString in that
642 * it allows a start,len range that extends past the string end.
644 * @param str the string
645 * @param start first byte index to check
646 * @param len number of bytes to check
647 * @returns #TRUE if the byte range exists and is a valid name
650 _dbus_validate_interface (const DBusString *str,
654 const unsigned char *s;
655 const unsigned char *end;
656 const unsigned char *iface;
657 const unsigned char *last_dot;
659 _dbus_assert (start >= 0);
660 _dbus_assert (len >= 0);
661 _dbus_assert (start <= _dbus_string_get_length (str));
663 if (len > _dbus_string_get_length (str) - start)
666 if (len > DBUS_MAXIMUM_NAME_LENGTH)
673 iface = _dbus_string_get_const_data (str) + start;
677 /* check special cases of first char so it doesn't have to be done
678 * in the loop. Note we know len > 0
680 if (_DBUS_UNLIKELY (*s == '.')) /* disallow starting with a . */
682 else if (_DBUS_UNLIKELY (!VALID_INITIAL_NAME_CHARACTER (*s)))
691 if (_DBUS_UNLIKELY ((s + 1) == end))
693 else if (_DBUS_UNLIKELY (!VALID_INITIAL_NAME_CHARACTER (*(s + 1))))
696 ++s; /* we just validated the next char, so skip two */
698 else if (_DBUS_UNLIKELY (!VALID_NAME_CHARACTER (*s)))
706 if (_DBUS_UNLIKELY (last_dot == NULL))
713 * Checks that the given range of the string is a valid member name
714 * in the D-BUS protocol. This includes a length restriction, etc.,
715 * see the specification.
717 * @todo this is inconsistent with most of DBusString in that
718 * it allows a start,len range that extends past the string end.
720 * @param str the string
721 * @param start first byte index to check
722 * @param len number of bytes to check
723 * @returns #TRUE if the byte range exists and is a valid name
726 _dbus_validate_member (const DBusString *str,
730 const unsigned char *s;
731 const unsigned char *end;
732 const unsigned char *member;
734 _dbus_assert (start >= 0);
735 _dbus_assert (len >= 0);
736 _dbus_assert (start <= _dbus_string_get_length (str));
738 if (len > _dbus_string_get_length (str) - start)
741 if (len > DBUS_MAXIMUM_NAME_LENGTH)
747 member = _dbus_string_get_const_data (str) + start;
751 /* check special cases of first char so it doesn't have to be done
752 * in the loop. Note we know len > 0
755 if (_DBUS_UNLIKELY (!VALID_INITIAL_NAME_CHARACTER (*s)))
762 if (_DBUS_UNLIKELY (!VALID_NAME_CHARACTER (*s)))
774 * Checks that the given range of the string is a valid error name
775 * in the D-BUS protocol. This includes a length restriction, etc.,
776 * see the specification.
778 * @todo this is inconsistent with most of DBusString in that
779 * it allows a start,len range that extends past the string end.
781 * @param str the string
782 * @param start first byte index to check
783 * @param len number of bytes to check
784 * @returns #TRUE if the byte range exists and is a valid name
787 _dbus_validate_error_name (const DBusString *str,
791 /* Same restrictions as interface name at the moment */
792 return _dbus_validate_interface (str, start, len);
795 /* This assumes the first char exists and is ':' */
797 _dbus_validate_unique_name (const DBusString *str,
801 const unsigned char *s;
802 const unsigned char *end;
803 const unsigned char *name;
805 _dbus_assert (start >= 0);
806 _dbus_assert (len >= 0);
807 _dbus_assert (start <= _dbus_string_get_length (str));
809 if (len > _dbus_string_get_length (str) - start)
812 if (len > DBUS_MAXIMUM_NAME_LENGTH)
815 _dbus_assert (len > 0);
817 name = _dbus_string_get_const_data (str) + start;
819 _dbus_assert (*name == ':');
826 if (_DBUS_UNLIKELY ((s + 1) == end))
828 if (_DBUS_UNLIKELY (!VALID_NAME_CHARACTER (*(s + 1))))
830 ++s; /* we just validated the next char, so skip two */
832 else if (_DBUS_UNLIKELY (!VALID_NAME_CHARACTER (*s)))
844 * Checks that the given range of the string is a valid bus name in
845 * the D-BUS protocol. This includes a length restriction, etc., see
848 * @todo this is inconsistent with most of DBusString in that
849 * it allows a start,len range that extends past the string end.
851 * @param str the string
852 * @param start first byte index to check
853 * @param len number of bytes to check
854 * @returns #TRUE if the byte range exists and is a valid name
857 _dbus_validate_bus_name (const DBusString *str,
861 if (_DBUS_UNLIKELY (len == 0))
863 if (_dbus_string_get_byte (str, start) == ':')
864 return _dbus_validate_unique_name (str, start, len);
866 return _dbus_validate_interface (str, start, len);
870 * Checks that the given range of the string is a valid message type
871 * signature in the D-BUS protocol.
873 * @todo this is inconsistent with most of DBusString in that
874 * it allows a start,len range that extends past the string end.
876 * @param str the string
877 * @param start first byte index to check
878 * @param len number of bytes to check
879 * @returns #TRUE if the byte range exists and is a valid signature
882 _dbus_validate_signature (const DBusString *str,
886 _dbus_assert (start >= 0);
887 _dbus_assert (start <= _dbus_string_get_length (str));
888 _dbus_assert (len >= 0);
890 if (len > _dbus_string_get_length (str) - start)
893 return _dbus_validate_signature_with_reason (str, start, len) == DBUS_VALID;
896 /** define _dbus_check_is_valid_path() */
897 DEFINE_DBUS_NAME_CHECK(path);
898 /** define _dbus_check_is_valid_interface() */
899 DEFINE_DBUS_NAME_CHECK(interface);
900 /** define _dbus_check_is_valid_member() */
901 DEFINE_DBUS_NAME_CHECK(member);
902 /** define _dbus_check_is_valid_error_name() */
903 DEFINE_DBUS_NAME_CHECK(error_name);
904 /** define _dbus_check_is_valid_bus_name() */
905 DEFINE_DBUS_NAME_CHECK(bus_name);
906 /** define _dbus_check_is_valid_signature() */
907 DEFINE_DBUS_NAME_CHECK(signature);
911 /* tests in dbus-marshal-validate-util.c */