1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-marshal-validate.h 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 #ifndef DBUS_MARSHAL_VALIDATE_H
25 #define DBUS_MARSHAL_VALIDATE_H
30 #error "config.h not included here"
34 * This is used rather than a bool for high visibility
38 DBUS_VALIDATION_MODE_WE_TRUST_THIS_DATA_ABSOLUTELY,
39 DBUS_VALIDATION_MODE_DATA_IS_UNTRUSTED
43 * This is primarily used in unit testing, so we can verify that each
44 * invalid message is invalid for the expected reasons. Thus we really
45 * want a distinct enum value for every codepath leaving the validator
46 * functions. Enum values are specified manually for ease of debugging
47 * (so you can see the enum value given a printf)
51 #define _DBUS_NEGATIVE_VALIDITY_COUNT 3
52 DBUS_INVALID_FOR_UNKNOWN_REASON = -3,
53 DBUS_VALID_BUT_INCOMPLETE = -2,
54 DBUS_VALIDITY_UNKNOWN = -1,
56 DBUS_INVALID_UNKNOWN_TYPECODE = 1,
57 DBUS_INVALID_MISSING_ARRAY_ELEMENT_TYPE = 2,
58 DBUS_INVALID_SIGNATURE_TOO_LONG = 3, /* this one is impossible right now since
59 * you can't put a too-long value in a byte
61 DBUS_INVALID_EXCEEDED_MAXIMUM_ARRAY_RECURSION = 4,
62 DBUS_INVALID_EXCEEDED_MAXIMUM_STRUCT_RECURSION = 5,
63 DBUS_INVALID_STRUCT_ENDED_BUT_NOT_STARTED = 6,
64 DBUS_INVALID_STRUCT_STARTED_BUT_NOT_ENDED = 7,
65 DBUS_INVALID_STRUCT_HAS_NO_FIELDS = 8,
66 DBUS_INVALID_ALIGNMENT_PADDING_NOT_NUL = 9,
67 DBUS_INVALID_BOOLEAN_NOT_ZERO_OR_ONE = 10,
68 DBUS_INVALID_NOT_ENOUGH_DATA = 11,
69 DBUS_INVALID_TOO_MUCH_DATA = 12,
70 DBUS_INVALID_BAD_BYTE_ORDER = 13,
71 DBUS_INVALID_BAD_PROTOCOL_VERSION = 14,
72 DBUS_INVALID_BAD_MESSAGE_TYPE = 15,
73 DBUS_INVALID_BAD_SERIAL = 16,
74 DBUS_INVALID_INSANE_FIELDS_ARRAY_LENGTH = 17,
75 DBUS_INVALID_INSANE_BODY_LENGTH = 18,
76 DBUS_INVALID_MESSAGE_TOO_LONG = 19,
77 DBUS_INVALID_HEADER_FIELD_CODE = 20,
78 DBUS_INVALID_HEADER_FIELD_HAS_WRONG_TYPE = 21,
79 DBUS_INVALID_USES_LOCAL_INTERFACE = 22,
80 DBUS_INVALID_USES_LOCAL_PATH = 23,
81 DBUS_INVALID_HEADER_FIELD_APPEARS_TWICE = 24,
82 DBUS_INVALID_BAD_DESTINATION = 25,
83 DBUS_INVALID_BAD_INTERFACE = 26,
84 DBUS_INVALID_BAD_MEMBER = 27,
85 DBUS_INVALID_BAD_ERROR_NAME = 28,
86 DBUS_INVALID_BAD_SENDER = 29,
87 DBUS_INVALID_MISSING_PATH = 30,
88 DBUS_INVALID_MISSING_INTERFACE = 31,
89 DBUS_INVALID_MISSING_MEMBER = 32,
90 DBUS_INVALID_MISSING_ERROR_NAME = 33,
91 DBUS_INVALID_MISSING_REPLY_SERIAL = 34,
92 DBUS_INVALID_LENGTH_OUT_OF_BOUNDS = 35,
93 DBUS_INVALID_ARRAY_LENGTH_EXCEEDS_MAXIMUM = 36,
94 DBUS_INVALID_BAD_PATH = 37,
95 DBUS_INVALID_SIGNATURE_LENGTH_OUT_OF_BOUNDS = 38,
96 DBUS_INVALID_BAD_UTF8_IN_STRING = 39,
97 DBUS_INVALID_ARRAY_LENGTH_INCORRECT = 40,
98 DBUS_INVALID_VARIANT_SIGNATURE_LENGTH_OUT_OF_BOUNDS = 41,
99 DBUS_INVALID_VARIANT_SIGNATURE_BAD = 42,
100 DBUS_INVALID_VARIANT_SIGNATURE_EMPTY = 43,
101 DBUS_INVALID_VARIANT_SIGNATURE_SPECIFIES_MULTIPLE_VALUES = 44,
102 DBUS_INVALID_VARIANT_SIGNATURE_MISSING_NUL = 45,
103 DBUS_INVALID_STRING_MISSING_NUL = 46,
104 DBUS_INVALID_SIGNATURE_MISSING_NUL = 47,
105 DBUS_INVALID_EXCEEDED_MAXIMUM_DICT_ENTRY_RECURSION = 48,
106 DBUS_INVALID_DICT_ENTRY_ENDED_BUT_NOT_STARTED = 49,
107 DBUS_INVALID_DICT_ENTRY_STARTED_BUT_NOT_ENDED = 50,
108 DBUS_INVALID_DICT_ENTRY_HAS_NO_FIELDS = 51,
109 DBUS_INVALID_DICT_ENTRY_HAS_ONLY_ONE_FIELD = 52,
110 DBUS_INVALID_DICT_ENTRY_HAS_TOO_MANY_FIELDS = 53,
111 DBUS_INVALID_DICT_ENTRY_NOT_INSIDE_ARRAY = 54,
115 DBusValidity _dbus_validate_signature_with_reason (const DBusString *type_str,
118 DBusValidity _dbus_validate_body_with_reason (const DBusString *expected_signature,
119 int expected_signature_start,
121 int *bytes_remaining,
122 const DBusString *value_str,
126 dbus_bool_t _dbus_validate_path (const DBusString *str,
129 dbus_bool_t _dbus_validate_interface (const DBusString *str,
132 dbus_bool_t _dbus_validate_member (const DBusString *str,
135 dbus_bool_t _dbus_validate_error_name (const DBusString *str,
138 dbus_bool_t _dbus_validate_bus_name (const DBusString *str,
141 dbus_bool_t _dbus_validate_signature (const DBusString *str,
145 #ifdef DBUS_DISABLE_CHECKS
147 /* Be sure they don't exist, since we don't want to use them outside of checks
148 * and so we want the compile failure.
150 #define DECLARE_DBUS_NAME_CHECK(what)
151 #define DEFINE_DBUS_NAME_CHECK(what)
153 #else /* !DBUS_DISABLE_CHECKS */
155 /** A name check is used in _dbus_return_if_fail(), it's not suitable
156 * for validating untrusted data. use _dbus_validate_##what for that.
158 #define DECLARE_DBUS_NAME_CHECK(what) \
159 dbus_bool_t _dbus_check_is_valid_##what (const char *name)
161 /** Define a name check to be used in _dbus_return_if_fail() statements.
163 #define DEFINE_DBUS_NAME_CHECK(what) \
165 _dbus_check_is_valid_##what (const char *name) \
172 _dbus_string_init_const (&str, name); \
173 return _dbus_validate_##what (&str, 0, \
174 _dbus_string_get_length (&str)); \
176 #endif /* !DBUS_DISABLE_CHECKS */
178 DECLARE_DBUS_NAME_CHECK(path);
179 DECLARE_DBUS_NAME_CHECK(interface);
180 DECLARE_DBUS_NAME_CHECK(member);
181 DECLARE_DBUS_NAME_CHECK(error_name);
182 DECLARE_DBUS_NAME_CHECK(bus_name);
183 DECLARE_DBUS_NAME_CHECK(signature);
185 #endif /* DBUS_MARSHAL_VALIDATE_H */