Do more robust validation of devices passed to the SDL HIDAPI functions

This commit is contained in:
Sam Lantinga 2021-11-08 06:34:32 -08:00
parent dd8c354843
commit f61b10dcf1

View File

@ -423,19 +423,22 @@ static const struct hidapi_backend LIBUSB_Backend = {
typedef struct _HIDDeviceWrapper HIDDeviceWrapper; typedef struct _HIDDeviceWrapper HIDDeviceWrapper;
struct _HIDDeviceWrapper struct _HIDDeviceWrapper
{ {
SDL_hid_device *device; /* must be first field */ const void *magic;
SDL_hid_device *device;
const struct hidapi_backend *backend; const struct hidapi_backend *backend;
}; };
static char device_magic;
#if HAVE_PLATFORM_BACKEND || HAVE_DRIVER_BACKEND || defined(SDL_LIBUSB_DYNAMIC) #if HAVE_PLATFORM_BACKEND || HAVE_DRIVER_BACKEND || defined(SDL_LIBUSB_DYNAMIC)
static HIDDeviceWrapper * static HIDDeviceWrapper *
CreateHIDDeviceWrapper(SDL_hid_device *device, const struct hidapi_backend *backend) CreateHIDDeviceWrapper(SDL_hid_device *device, const struct hidapi_backend *backend)
{ {
HIDDeviceWrapper *ret = (HIDDeviceWrapper *)SDL_malloc(sizeof(*ret)); HIDDeviceWrapper *wrapper = (HIDDeviceWrapper *)SDL_malloc(sizeof(*wrapper));
ret->device = device; wrapper->magic = &device_magic;
ret->backend = backend; wrapper->device = device;
return ret; wrapper->backend = backend;
return wrapper;
} }
static SDL_hid_device * static SDL_hid_device *
@ -455,9 +458,17 @@ UnwrapHIDDevice(SDL_hid_device *device)
static void static void
DeleteHIDDeviceWrapper(HIDDeviceWrapper *device) DeleteHIDDeviceWrapper(HIDDeviceWrapper *device)
{ {
device->magic = NULL;
SDL_free(device); SDL_free(device);
} }
#define CHECK_DEVICE_MAGIC(device, retval) \
SDL_assert(device && device->magic == &device_magic); \
if (!device || device->magic != &device_magic) { \
SDL_SetError("Invalid device"); \
return retval; \
}
#ifndef SDL_DISABLE_HIDAPI #ifndef SDL_DISABLE_HIDAPI
#define COPY_IF_EXISTS(var) \ #define COPY_IF_EXISTS(var) \
@ -848,9 +859,8 @@ int SDL_hid_write(SDL_hid_device *device, const unsigned char *data, size_t leng
HIDDeviceWrapper *wrapper = UnwrapHIDDevice(device); HIDDeviceWrapper *wrapper = UnwrapHIDDevice(device);
int result; int result;
if (!wrapper) { CHECK_DEVICE_MAGIC(wrapper, -1);
return -1;
}
result = wrapper->backend->hid_write(wrapper->device, data, length); result = wrapper->backend->hid_write(wrapper->device, data, length);
if (result < 0) { if (result < 0) {
SDL_SetHIDAPIError(wrapper->backend->hid_error(wrapper->device)); SDL_SetHIDAPIError(wrapper->backend->hid_error(wrapper->device));
@ -863,9 +873,8 @@ int SDL_hid_read_timeout(SDL_hid_device *device, unsigned char *data, size_t len
HIDDeviceWrapper *wrapper = UnwrapHIDDevice(device); HIDDeviceWrapper *wrapper = UnwrapHIDDevice(device);
int result; int result;
if (!wrapper) { CHECK_DEVICE_MAGIC(wrapper, -1);
return -1;
}
result = wrapper->backend->hid_read_timeout(wrapper->device, data, length, milliseconds); result = wrapper->backend->hid_read_timeout(wrapper->device, data, length, milliseconds);
if (result < 0) { if (result < 0) {
SDL_SetHIDAPIError(wrapper->backend->hid_error(wrapper->device)); SDL_SetHIDAPIError(wrapper->backend->hid_error(wrapper->device));
@ -878,9 +887,8 @@ int SDL_hid_read(SDL_hid_device *device, unsigned char *data, size_t length)
HIDDeviceWrapper *wrapper = UnwrapHIDDevice(device); HIDDeviceWrapper *wrapper = UnwrapHIDDevice(device);
int result; int result;
if (!wrapper) { CHECK_DEVICE_MAGIC(wrapper, -1);
return -1;
}
result = wrapper->backend->hid_read(wrapper->device, data, length); result = wrapper->backend->hid_read(wrapper->device, data, length);
if (result < 0) { if (result < 0) {
SDL_SetHIDAPIError(wrapper->backend->hid_error(wrapper->device)); SDL_SetHIDAPIError(wrapper->backend->hid_error(wrapper->device));
@ -893,9 +901,8 @@ int SDL_hid_set_nonblocking(SDL_hid_device *device, int nonblock)
HIDDeviceWrapper *wrapper = UnwrapHIDDevice(device); HIDDeviceWrapper *wrapper = UnwrapHIDDevice(device);
int result; int result;
if (!wrapper) { CHECK_DEVICE_MAGIC(wrapper, -1);
return -1;
}
result = wrapper->backend->hid_set_nonblocking(wrapper->device, nonblock); result = wrapper->backend->hid_set_nonblocking(wrapper->device, nonblock);
if (result < 0) { if (result < 0) {
SDL_SetHIDAPIError(wrapper->backend->hid_error(wrapper->device)); SDL_SetHIDAPIError(wrapper->backend->hid_error(wrapper->device));
@ -908,9 +915,8 @@ int SDL_hid_send_feature_report(SDL_hid_device *device, const unsigned char *dat
HIDDeviceWrapper *wrapper = UnwrapHIDDevice(device); HIDDeviceWrapper *wrapper = UnwrapHIDDevice(device);
int result; int result;
if (!wrapper) { CHECK_DEVICE_MAGIC(wrapper, -1);
return -1;
}
result = wrapper->backend->hid_send_feature_report(wrapper->device, data, length); result = wrapper->backend->hid_send_feature_report(wrapper->device, data, length);
if (result < 0) { if (result < 0) {
SDL_SetHIDAPIError(wrapper->backend->hid_error(wrapper->device)); SDL_SetHIDAPIError(wrapper->backend->hid_error(wrapper->device));
@ -923,9 +929,8 @@ int SDL_hid_get_feature_report(SDL_hid_device *device, unsigned char *data, size
HIDDeviceWrapper *wrapper = UnwrapHIDDevice(device); HIDDeviceWrapper *wrapper = UnwrapHIDDevice(device);
int result; int result;
if (!wrapper) { CHECK_DEVICE_MAGIC(wrapper, -1);
return -1;
}
result = wrapper->backend->hid_get_feature_report(wrapper->device, data, length); result = wrapper->backend->hid_get_feature_report(wrapper->device, data, length);
if (result < 0) { if (result < 0) {
SDL_SetHIDAPIError(wrapper->backend->hid_error(wrapper->device)); SDL_SetHIDAPIError(wrapper->backend->hid_error(wrapper->device));
@ -937,20 +942,19 @@ void SDL_hid_close(SDL_hid_device *device)
{ {
HIDDeviceWrapper *wrapper = UnwrapHIDDevice(device); HIDDeviceWrapper *wrapper = UnwrapHIDDevice(device);
if (wrapper) { CHECK_DEVICE_MAGIC(wrapper,);
wrapper->backend->hid_close(wrapper->device); wrapper->backend->hid_close(wrapper->device);
DeleteHIDDeviceWrapper(wrapper); DeleteHIDDeviceWrapper(wrapper);
} }
}
int SDL_hid_get_manufacturer_string(SDL_hid_device *device, wchar_t *string, size_t maxlen) int SDL_hid_get_manufacturer_string(SDL_hid_device *device, wchar_t *string, size_t maxlen)
{ {
HIDDeviceWrapper *wrapper = UnwrapHIDDevice(device); HIDDeviceWrapper *wrapper = UnwrapHIDDevice(device);
int result; int result;
if (!wrapper) { CHECK_DEVICE_MAGIC(wrapper, -1);
return -1;
}
result = wrapper->backend->hid_get_manufacturer_string(wrapper->device, string, maxlen); result = wrapper->backend->hid_get_manufacturer_string(wrapper->device, string, maxlen);
if (result < 0) { if (result < 0) {
SDL_SetHIDAPIError(wrapper->backend->hid_error(wrapper->device)); SDL_SetHIDAPIError(wrapper->backend->hid_error(wrapper->device));
@ -963,9 +967,8 @@ int SDL_hid_get_product_string(SDL_hid_device *device, wchar_t *string, size_t m
HIDDeviceWrapper *wrapper = UnwrapHIDDevice(device); HIDDeviceWrapper *wrapper = UnwrapHIDDevice(device);
int result; int result;
if (!wrapper) { CHECK_DEVICE_MAGIC(wrapper, -1);
return -1;
}
result = wrapper->backend->hid_get_product_string(wrapper->device, string, maxlen); result = wrapper->backend->hid_get_product_string(wrapper->device, string, maxlen);
if (result < 0) { if (result < 0) {
SDL_SetHIDAPIError(wrapper->backend->hid_error(wrapper->device)); SDL_SetHIDAPIError(wrapper->backend->hid_error(wrapper->device));
@ -978,9 +981,8 @@ int SDL_hid_get_serial_number_string(SDL_hid_device *device, wchar_t *string, si
HIDDeviceWrapper *wrapper = UnwrapHIDDevice(device); HIDDeviceWrapper *wrapper = UnwrapHIDDevice(device);
int result; int result;
if (!wrapper) { CHECK_DEVICE_MAGIC(wrapper, -1);
return -1;
}
result = wrapper->backend->hid_get_serial_number_string(wrapper->device, string, maxlen); result = wrapper->backend->hid_get_serial_number_string(wrapper->device, string, maxlen);
if (result < 0) { if (result < 0) {
SDL_SetHIDAPIError(wrapper->backend->hid_error(wrapper->device)); SDL_SetHIDAPIError(wrapper->backend->hid_error(wrapper->device));
@ -993,9 +995,8 @@ int SDL_hid_get_indexed_string(SDL_hid_device *device, int string_index, wchar_t
HIDDeviceWrapper *wrapper = UnwrapHIDDevice(device); HIDDeviceWrapper *wrapper = UnwrapHIDDevice(device);
int result; int result;
if (!wrapper) { CHECK_DEVICE_MAGIC(wrapper, -1);
return -1;
}
result = wrapper->backend->hid_get_indexed_string(wrapper->device, string_index, string, maxlen); result = wrapper->backend->hid_get_indexed_string(wrapper->device, string_index, string, maxlen);
if (result < 0) { if (result < 0) {
SDL_SetHIDAPIError(wrapper->backend->hid_error(wrapper->device)); SDL_SetHIDAPIError(wrapper->backend->hid_error(wrapper->device));