dbus-syntax.c
/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
/* dbus-syntax.c - utility functions for strings with special syntax
*
* Author: Simon McVittie <simon.mcvittie@collabora.co.uk>
* Copyright © 2011 Nokia Corporation
*
* SPDX-License-Identifier: AFL-2.1 OR GPL-2.0-or-later
*
* Licensed under the Academic Free License version 2.1
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
#include <config.h>
#include "dbus-syntax.h"
#include "dbus-internals.h"
#include "dbus-marshal-validate.h"
#include "dbus-shared.h"
dbus_bool_t
dbus_validate_path (const char *path,
DBusError *error)
{
DBusString str;
int len;
_dbus_return_val_if_fail (path != NULL, FALSE);
_dbus_string_init_const (&str, path);
len = _dbus_string_get_length (&str);
/* In general, it ought to be valid... */
if (_DBUS_LIKELY (_dbus_validate_path (&str, 0, len)))
return TRUE;
/* slow path: string is invalid, find out why */
if (!_dbus_string_validate_utf8 (&str, 0, len))
{
/* don't quote the actual string here, since a DBusError also needs to
* be valid UTF-8 */
dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
"Object path was not valid UTF-8");
return FALSE;
}
/* FIXME: later, diagnose exactly how it was invalid */
dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
"Object path was not valid: '%s'", path);
return FALSE;
}
dbus_bool_t
dbus_validate_interface (const char *name,
DBusError *error)
{
DBusString str;
int len;
_dbus_return_val_if_fail (name != NULL, FALSE);
_dbus_string_init_const (&str, name);
len = _dbus_string_get_length (&str);
/* In general, it ought to be valid... */
if (_DBUS_LIKELY (_dbus_validate_interface (&str, 0, len)))
return TRUE;
/* slow path: string is invalid, find out why */
if (!_dbus_string_validate_utf8 (&str, 0, len))
{
/* don't quote the actual string here, since a DBusError also needs to
* be valid UTF-8 */
dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
"Interface name was not valid UTF-8");
return FALSE;
}
/* FIXME: later, diagnose exactly how it was invalid */
dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
"Interface name was not valid: '%s'", name);
return FALSE;
}
dbus_bool_t
dbus_validate_member (const char *name,
DBusError *error)
{
DBusString str;
int len;
_dbus_return_val_if_fail (name != NULL, FALSE);
_dbus_string_init_const (&str, name);
len = _dbus_string_get_length (&str);
/* In general, it ought to be valid... */
if (_DBUS_LIKELY (_dbus_validate_member (&str, 0, len)))
return TRUE;
/* slow path: string is invalid, find out why */
if (!_dbus_string_validate_utf8 (&str, 0, len))
{
/* don't quote the actual string here, since a DBusError also needs to
* be valid UTF-8 */
dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
"Member name was not valid UTF-8");
return FALSE;
}
/* FIXME: later, diagnose exactly how it was invalid */
dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
"Member name was not valid: '%s'", name);
return FALSE;
}
dbus_bool_t
dbus_validate_error_name (const char *name,
DBusError *error)
{
DBusString str;
int len;
_dbus_return_val_if_fail (name != NULL, FALSE);
_dbus_string_init_const (&str, name);
len = _dbus_string_get_length (&str);
/* In general, it ought to be valid... */
if (_DBUS_LIKELY (_dbus_validate_error_name (&str, 0, len)))
return TRUE;
/* slow path: string is invalid, find out why */
if (!_dbus_string_validate_utf8 (&str, 0, len))
{
/* don't quote the actual string here, since a DBusError also needs to
* be valid UTF-8 */
dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
"Error name was not valid UTF-8");
return FALSE;
}
/* FIXME: later, diagnose exactly how it was invalid */
dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
"Error name was not valid: '%s'", name);
return FALSE;
}
dbus_bool_t
dbus_validate_bus_name (const char *name,
DBusError *error)
{
DBusString str;
int len;
_dbus_return_val_if_fail (name != NULL, FALSE);
_dbus_string_init_const (&str, name);
len = _dbus_string_get_length (&str);
/* In general, it ought to be valid... */
if (_DBUS_LIKELY (_dbus_validate_bus_name (&str, 0, len)))
return TRUE;
/* slow path: string is invalid, find out why */
if (!_dbus_string_validate_utf8 (&str, 0, len))
{
/* don't quote the actual string here, since a DBusError also needs to
* be valid UTF-8 */
dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
"Bus name was not valid UTF-8");
return FALSE;
}
/* FIXME: later, diagnose exactly how it was invalid */
dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
"Bus name was not valid: '%s'", name);
return FALSE;
}
dbus_bool_t
dbus_validate_utf8 (const char *alleged_utf8,
DBusError *error)
{
DBusString str;
_dbus_return_val_if_fail (alleged_utf8 != NULL, FALSE);
_dbus_string_init_const (&str, alleged_utf8);
if (_DBUS_LIKELY (_dbus_string_validate_utf8 (&str, 0,
_dbus_string_get_length (&str))))
return TRUE;
/* don't quote the actual string here, since a DBusError also needs to
* be valid UTF-8 */
dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
"String was not valid UTF-8");
return FALSE;
}
/* end of group */
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:356
NULL
#define NULL
A null pointer, defined appropriately for C or C++.
Definition dbus-macros.h:51
TRUE
#define TRUE
Expands to "1".
Definition dbus-macros.h:41
FALSE
#define FALSE
Expands to "0".
Definition dbus-macros.h:44
_dbus_validate_error_name
dbus_bool_t _dbus_validate_error_name(const DBusString *str, int start, int len)
Checks that the given range of the string is a valid error name in the D-Bus protocol.
Definition dbus-marshal-validate.c:1124
_dbus_validate_member
dbus_bool_t _dbus_validate_member(const DBusString *str, int start, int len)
Checks that the given range of the string is a valid member name in the D-Bus protocol.
Definition dbus-marshal-validate.c:1063
_dbus_validate_path
dbus_bool_t _dbus_validate_path(const DBusString *str, int start, int len)
Checks that the given range of the string is a valid object path name in the D-Bus protocol.
Definition dbus-marshal-validate.c:849
_dbus_validate_interface
dbus_bool_t _dbus_validate_interface(const DBusString *str, int start, int len)
Checks that the given range of the string is a valid interface name in the D-Bus protocol.
Definition dbus-marshal-validate.c:987
_dbus_validate_bus_name
dbus_bool_t _dbus_validate_bus_name(const DBusString *str, int start, int len)
Checks that the given range of the string is a valid bus name in the D-Bus protocol.
Definition dbus-marshal-validate.c:1253
DBUS_ERROR_INVALID_ARGS
#define DBUS_ERROR_INVALID_ARGS
Invalid arguments passed to a method call.
Definition dbus-protocol.h:397
_dbus_string_init_const
void _dbus_string_init_const(DBusString *str, const char *value)
Initializes a constant string.
Definition dbus-string.c:197
_dbus_string_validate_utf8
dbus_bool_t _dbus_string_validate_utf8(const DBusString *str, int start, int len)
Checks that the given range of the string is valid UTF-8.
Definition dbus-string.c:2678
dbus_validate_interface
dbus_bool_t dbus_validate_interface(const char *name, DBusError *error)
Check an interface name for validity.
Definition dbus-syntax.c:103
dbus_validate_path
dbus_bool_t dbus_validate_path(const char *path, DBusError *error)
Check an object path for validity.
Definition dbus-syntax.c:56
dbus_validate_utf8
dbus_bool_t dbus_validate_utf8(const char *alleged_utf8, DBusError *error)
Check a string for validity.
Definition dbus-syntax.c:291
dbus_validate_member
dbus_bool_t dbus_validate_member(const char *name, DBusError *error)
Check a member (method/signal) name for validity.
Definition dbus-syntax.c:150
dbus_validate_bus_name
dbus_bool_t dbus_validate_bus_name(const char *name, DBusError *error)
Check a bus name for validity.
Definition dbus-syntax.c:244
dbus_validate_error_name
dbus_bool_t dbus_validate_error_name(const char *name, DBusError *error)
Check an error name for validity.
Definition dbus-syntax.c:197
dbus_bool_t
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition dbus-types.h:37
DBusError
Object representing an exception.
Definition dbus-errors.h:51
DBusString
Definition dbus-string.h:47