dbus-marshal-validate.h revision 9c3d566e95c9080f6040c64531b0ccae22bd5d74
15c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington/* -*- mode: C; c-file-style: "gnu" -*- */ 25c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington/* dbus-marshal-validate.h Validation routines for marshaled data 35c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington * 45c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington * Copyright (C) 2005 Red Hat, Inc. 55c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington * 65c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington * Licensed under the Academic Free License version 2.1 75c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington * 85c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington * This program is free software; you can redistribute it and/or modify 95c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington * it under the terms of the GNU General Public License as published by 105c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington * the Free Software Foundation; either version 2 of the License, or 115c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington * (at your option) any later version. 125c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington * 135c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington * This program is distributed in the hope that it will be useful, 145c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington * but WITHOUT ANY WARRANTY; without even the implied warranty of 155c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 165c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington * GNU General Public License for more details. 175c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington * 185c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington * You should have received a copy of the GNU General Public License 195c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington * along with this program; if not, write to the Free Software 205c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 215c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington * 225c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington */ 235c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington 245c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington#ifndef DBUS_MARSHAL_VALIDATE_H 255c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington#define DBUS_MARSHAL_VALIDATE_H 265c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington 275c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington#include <config.h> 285c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington#include <dbus/dbus-marshal-basic.h> 295c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington 305c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington#ifndef PACKAGE 315c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington#error "config.h not included here" 325c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington#endif 335c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington 349c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington/** 359c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington * This is primarily used in unit testing, so we can verify that each 369c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington * invalid message is invalid for the expected reasons. Thus we really 379c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington * want a distinct enum value for every codepath leaving the validator 389c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington * functions. Enum values are specified manually for ease of debugging 399c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington * (so you can see the enum value given a printf) 409c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington */ 419c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Penningtontypedef enum 429c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington{ 439c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_VALID = 0, 449c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_UNKNOWN_TYPECODE = 1, 459c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_MISSING_ARRAY_ELEMENT_TYPE = 2, 469c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_SIGNATURE_TOO_LONG = 3, 479c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_EXCEEDED_MAXIMUM_ARRAY_RECURSION = 4, 489c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_EXCEEDED_MAXIMUM_STRUCT_RECURSION = 5, 499c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_STRUCT_ENDED_BUT_NOT_STARTED = 6, 509c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_STRUCT_STARTED_BUT_NOT_ENDED = 7, 519c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_STRUCT_HAS_NO_FIELDS = 8, 529c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_ALIGNMENT_PADDING_NOT_NUL = 9, 539c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_BOOLEAN_NOT_ZERO_OR_ONE = 10, 549c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_NOT_ENOUGH_DATA = 11, 559c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_TOO_MUCH_DATA = 12, 569c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_BAD_BYTE_ORDER = 13, 579c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_BAD_PROTOCOL_VERSION = 14, 589c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_BAD_MESSAGE_TYPE = 15, 599c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_BAD_SERIAL = 16, 609c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_INSANE_FIELDS_ARRAY_LENGTH = 17, 619c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_INSANE_BODY_LENGTH = 18, 629c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_MESSAGE_TOO_LONG = 19, 639c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_HEADER_FIELD_CODE = 20, 649c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_HEADER_FIELD_HAS_WRONG_TYPE = 21, 659c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_USES_LOCAL_INTERFACE = 22, 669c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_USES_LOCAL_PATH = 23, 679c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_HEADER_FIELD_APPEARS_TWICE = 24, 689c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_BAD_DESTINATION = 25, 699c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_BAD_INTERFACE = 26, 709c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_BAD_MEMBER = 27, 719c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_BAD_ERROR_NAME = 28, 729c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_BAD_SENDER = 29, 739c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_MISSING_PATH = 30, 749c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_MISSING_INTERFACE = 31, 759c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_MISSING_MEMBER = 32, 769c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_MISSING_ERROR_NAME = 33, 779c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_MISSING_REPLY_SERIAL = 34, 789c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_STRING_LENGTH_OUT_OF_BOUNDS = 35, 799c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_ARRAY_LENGTH_OUT_OF_BOUNDS = 36, 809c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_ARRAY_LENGTH_EXCEEDS_MAXIMUM = 37, 819c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_BAD_PATH = 38, 829c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_SIGNATURE_LENGTH_OUT_OF_BOUNDS = 39, 839c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_BAD_SIGNATURE = 40, 849c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_BAD_UTF8_IN_STRING = 41, 859c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_ARRAY_LENGTH_INCORRECT = 42, 869c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_VARIANT_SIGNATURE_LENGTH_OUT_OF_BOUNDS = 43, 879c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_VARIANT_SIGNATURE_BAD = 44, 889c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_VARIANT_SIGNATURE_EMPTY = 45, 899c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_VARIANT_SIGNATURE_SPECIFIES_MULTIPLE_VALUES = 46, 909c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_VARIANT_SIGNATURE_MISSING_NUL = 47, 919c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_STRING_MISSING_NUL = 48, 929c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBUS_INVALID_SIGNATURE_MISSING_NUL = 49, 939c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington} DBusValidity; 949c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington 959c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc PenningtonDBusValidity _dbus_validate_signature_with_reason (const DBusString *type_str, 969c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington int type_pos, 979c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington int len); 989c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc PenningtonDBusValidity _dbus_validate_body_with_reason (const DBusString *expected_signature, 999c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington int expected_signature_start, 1009c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington int byte_order, 1019c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington int *bytes_remaining, 1029c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington const DBusString *value_str, 1039c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington int value_pos, 1049c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington int len); 1059c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington 1069c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Penningtondbus_bool_t _dbus_validate_path (const DBusString *str, 1079c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington int start, 1089c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington int len); 1099c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Penningtondbus_bool_t _dbus_validate_interface (const DBusString *str, 1109c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington int start, 1119c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington int len); 1129c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Penningtondbus_bool_t _dbus_validate_member (const DBusString *str, 1139c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington int start, 1149c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington int len); 1159c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Penningtondbus_bool_t _dbus_validate_error_name (const DBusString *str, 1169c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington int start, 1179c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington int len); 1189c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Penningtondbus_bool_t _dbus_validate_service (const DBusString *str, 1199c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington int start, 1209c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington int len); 1219c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Penningtondbus_bool_t _dbus_validate_signature (const DBusString *str, 1229c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington int start, 1239c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington int len); 1249c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington 1259c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington#ifdef DBUS_DISABLE_CHECKS 1269c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington 1279c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington/* Be sure they don't exist, since we don't want to use them outside of checks 1289c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington * and so we want the compile failure. 1299c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington */ 1309c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington#define DECLARE_DBUS_NAME_CHECK(what) 1319c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington#define DEFINE_DBUS_NAME_CHECK(what) 1329c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington 1339c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington#else /* !DBUS_DISABLE_CHECKS */ 1349c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington 1359c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington/* A name check is used in _dbus_return_if_fail(), it's not suitable 1369c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington * for validating untrusted data. use _dbus_validate_##what for that. 1379c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington */ 1389c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington#define DECLARE_DBUS_NAME_CHECK(what) \ 1399c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Penningtondbus_bool_t _dbus_check_is_valid_##what (const char *name) 1409c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington 1419c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington#define DEFINE_DBUS_NAME_CHECK(what) \ 1429c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Penningtondbus_bool_t \ 1439c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington_dbus_check_is_valid_##what (const char *name) \ 1449c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington{ \ 1459c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington DBusString str; \ 1469c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington \ 1479c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington if (name == NULL) \ 1489c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington return FALSE; \ 1499c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington \ 1509c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington _dbus_string_init_const (&str, name); \ 1519c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington return _dbus_validate_##what (&str, 0, \ 1529c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington _dbus_string_get_length (&str)); \ 1539c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington} 1549c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington#endif /* !DBUS_DISABLE_CHECKS */ 1559c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc Pennington 1569c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc PenningtonDECLARE_DBUS_NAME_CHECK(path); 1579c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc PenningtonDECLARE_DBUS_NAME_CHECK(interface); 1589c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc PenningtonDECLARE_DBUS_NAME_CHECK(member); 1599c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc PenningtonDECLARE_DBUS_NAME_CHECK(error_name); 1609c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc PenningtonDECLARE_DBUS_NAME_CHECK(service); 1619c3d566e95c9080f6040c64531b0ccae22bd5d74Havoc PenningtonDECLARE_DBUS_NAME_CHECK(signature); 1625c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington 1635c486a24e50ef731b8f970060ab10e928cd0e7cdHavoc Pennington#endif /* DBUS_MARSHAL_VALIDATE_H */ 164