xref: /openbsd-src/lib/libfido2/src/hid.c (revision ab19a69ebe1d1275c01611de862453c36b3d15b9)
1d75efeb7Sdjm /*
2d75efeb7Sdjm  * Copyright (c) 2018 Yubico AB. All rights reserved.
3d75efeb7Sdjm  * Use of this source code is governed by a BSD-style
4d75efeb7Sdjm  * license that can be found in the LICENSE file.
5d75efeb7Sdjm  */
6d75efeb7Sdjm 
7d75efeb7Sdjm #include "fido.h"
8d75efeb7Sdjm 
9c4a807edSdjm static int
get_key_len(uint8_t tag,uint8_t * key,size_t * key_len)10c4a807edSdjm get_key_len(uint8_t tag, uint8_t *key, size_t *key_len)
11c4a807edSdjm {
12c4a807edSdjm 	*key = tag & 0xfc;
13c4a807edSdjm 	if ((*key & 0xf0) == 0xf0) {
14c4a807edSdjm 		fido_log_debug("%s: *key=0x%02x", __func__, *key);
15c4a807edSdjm 		return (-1);
16c4a807edSdjm 	}
17c4a807edSdjm 
18c4a807edSdjm 	*key_len = tag & 0x3;
19c4a807edSdjm 	if (*key_len == 3) {
20c4a807edSdjm 		*key_len = 4;
21c4a807edSdjm 	}
22c4a807edSdjm 
23c4a807edSdjm 	return (0);
24c4a807edSdjm }
25c4a807edSdjm 
26c4a807edSdjm static int
get_key_val(const void * body,size_t key_len,uint32_t * val)27c4a807edSdjm get_key_val(const void *body, size_t key_len, uint32_t *val)
28c4a807edSdjm {
29c4a807edSdjm 	const uint8_t *ptr = body;
30c4a807edSdjm 
31c4a807edSdjm 	switch (key_len) {
32c4a807edSdjm 	case 0:
33c4a807edSdjm 		*val = 0;
34c4a807edSdjm 		break;
35c4a807edSdjm 	case 1:
36c4a807edSdjm 		*val = ptr[0];
37c4a807edSdjm 		break;
38c4a807edSdjm 	case 2:
39c4a807edSdjm 		*val = (uint32_t)((ptr[1] << 8) | ptr[0]);
40c4a807edSdjm 		break;
41c4a807edSdjm 	default:
42c4a807edSdjm 		fido_log_debug("%s: key_len=%zu", __func__, key_len);
43c4a807edSdjm 		return (-1);
44c4a807edSdjm 	}
45c4a807edSdjm 
46c4a807edSdjm 	return (0);
47c4a807edSdjm }
48c4a807edSdjm 
49c4a807edSdjm int
fido_hid_get_usage(const uint8_t * report_ptr,size_t report_len,uint32_t * usage_page)50c4a807edSdjm fido_hid_get_usage(const uint8_t *report_ptr, size_t report_len,
51c4a807edSdjm     uint32_t *usage_page)
52c4a807edSdjm {
53c4a807edSdjm 	const uint8_t	*ptr = report_ptr;
54c4a807edSdjm 	size_t		 len = report_len;
55c4a807edSdjm 
56c4a807edSdjm 	while (len > 0) {
57c4a807edSdjm 		const uint8_t tag = ptr[0];
58c4a807edSdjm 		ptr++;
59c4a807edSdjm 		len--;
60c4a807edSdjm 
61c4a807edSdjm 		uint8_t  key;
62c4a807edSdjm 		size_t   key_len;
63c4a807edSdjm 		uint32_t key_val;
64c4a807edSdjm 
65c4a807edSdjm 		if (get_key_len(tag, &key, &key_len) < 0 || key_len > len ||
66c4a807edSdjm 		    get_key_val(ptr, key_len, &key_val) < 0) {
67c4a807edSdjm 			return (-1);
68c4a807edSdjm 		}
69c4a807edSdjm 
70c4a807edSdjm 		if (key == 0x4) {
71c4a807edSdjm 			*usage_page = key_val;
72c4a807edSdjm 		}
73c4a807edSdjm 
74c4a807edSdjm 		ptr += key_len;
75c4a807edSdjm 		len -= key_len;
76c4a807edSdjm 	}
77c4a807edSdjm 
78c4a807edSdjm 	return (0);
79c4a807edSdjm }
80c4a807edSdjm 
81c4a807edSdjm int
fido_hid_get_report_len(const uint8_t * report_ptr,size_t report_len,size_t * report_in_len,size_t * report_out_len)82c4a807edSdjm fido_hid_get_report_len(const uint8_t *report_ptr, size_t report_len,
83c4a807edSdjm     size_t *report_in_len, size_t *report_out_len)
84c4a807edSdjm {
85c4a807edSdjm 	const uint8_t	*ptr = report_ptr;
86c4a807edSdjm 	size_t		 len = report_len;
87c4a807edSdjm 	uint32_t	 report_size = 0;
88c4a807edSdjm 
89c4a807edSdjm 	while (len > 0) {
90c4a807edSdjm 		const uint8_t tag = ptr[0];
91c4a807edSdjm 		ptr++;
92c4a807edSdjm 		len--;
93c4a807edSdjm 
94c4a807edSdjm 		uint8_t  key;
95c4a807edSdjm 		size_t   key_len;
96c4a807edSdjm 		uint32_t key_val;
97c4a807edSdjm 
98c4a807edSdjm 		if (get_key_len(tag, &key, &key_len) < 0 || key_len > len ||
99c4a807edSdjm 		    get_key_val(ptr, key_len, &key_val) < 0) {
100c4a807edSdjm 			return (-1);
101c4a807edSdjm 		}
102c4a807edSdjm 
103c4a807edSdjm 		if (key == 0x94) {
104c4a807edSdjm 			report_size = key_val;
105c4a807edSdjm 		} else if (key == 0x80) {
106c4a807edSdjm 			*report_in_len = (size_t)report_size;
107c4a807edSdjm 		} else if (key == 0x90) {
108c4a807edSdjm 			*report_out_len = (size_t)report_size;
109c4a807edSdjm 		}
110c4a807edSdjm 
111c4a807edSdjm 		ptr += key_len;
112c4a807edSdjm 		len -= key_len;
113c4a807edSdjm 	}
114c4a807edSdjm 
115c4a807edSdjm 	return (0);
116c4a807edSdjm }
117c4a807edSdjm 
118d75efeb7Sdjm fido_dev_info_t *
fido_dev_info_new(size_t n)119d75efeb7Sdjm fido_dev_info_new(size_t n)
120d75efeb7Sdjm {
121d75efeb7Sdjm 	return (calloc(n, sizeof(fido_dev_info_t)));
122d75efeb7Sdjm }
123d75efeb7Sdjm 
124*ab19a69eSdjm static void
fido_dev_info_reset(fido_dev_info_t * di)125*ab19a69eSdjm fido_dev_info_reset(fido_dev_info_t *di)
126*ab19a69eSdjm {
127*ab19a69eSdjm 	free(di->path);
128*ab19a69eSdjm 	free(di->manufacturer);
129*ab19a69eSdjm 	free(di->product);
130*ab19a69eSdjm 	memset(di, 0, sizeof(*di));
131*ab19a69eSdjm }
132*ab19a69eSdjm 
133d75efeb7Sdjm void
fido_dev_info_free(fido_dev_info_t ** devlist_p,size_t n)134d75efeb7Sdjm fido_dev_info_free(fido_dev_info_t **devlist_p, size_t n)
135d75efeb7Sdjm {
136d75efeb7Sdjm 	fido_dev_info_t *devlist;
137d75efeb7Sdjm 
138d75efeb7Sdjm 	if (devlist_p == NULL || (devlist = *devlist_p) == NULL)
139d75efeb7Sdjm 		return;
140d75efeb7Sdjm 
141*ab19a69eSdjm 	for (size_t i = 0; i < n; i++)
142*ab19a69eSdjm 		fido_dev_info_reset(&devlist[i]);
143d75efeb7Sdjm 
144d75efeb7Sdjm 	free(devlist);
145d75efeb7Sdjm 
146d75efeb7Sdjm 	*devlist_p = NULL;
147d75efeb7Sdjm }
148d75efeb7Sdjm 
149d75efeb7Sdjm const fido_dev_info_t *
fido_dev_info_ptr(const fido_dev_info_t * devlist,size_t i)150d75efeb7Sdjm fido_dev_info_ptr(const fido_dev_info_t *devlist, size_t i)
151d75efeb7Sdjm {
152d75efeb7Sdjm 	return (&devlist[i]);
153d75efeb7Sdjm }
154d75efeb7Sdjm 
155*ab19a69eSdjm int
fido_dev_info_set(fido_dev_info_t * devlist,size_t i,const char * path,const char * manufacturer,const char * product,const fido_dev_io_t * io,const fido_dev_transport_t * transport)156*ab19a69eSdjm fido_dev_info_set(fido_dev_info_t *devlist, size_t i,
157*ab19a69eSdjm     const char *path, const char *manufacturer, const char *product,
158*ab19a69eSdjm     const fido_dev_io_t *io, const fido_dev_transport_t *transport)
159*ab19a69eSdjm {
160*ab19a69eSdjm 	char *path_copy = NULL, *manu_copy = NULL, *prod_copy = NULL;
161*ab19a69eSdjm 	int r;
162*ab19a69eSdjm 
163*ab19a69eSdjm 	if (path == NULL || manufacturer == NULL || product == NULL ||
164*ab19a69eSdjm 	    io == NULL) {
165*ab19a69eSdjm 		r = FIDO_ERR_INVALID_ARGUMENT;
166*ab19a69eSdjm 		goto out;
167*ab19a69eSdjm 	}
168*ab19a69eSdjm 
169*ab19a69eSdjm 	if ((path_copy = strdup(path)) == NULL ||
170*ab19a69eSdjm 	    (manu_copy = strdup(manufacturer)) == NULL ||
171*ab19a69eSdjm 	    (prod_copy = strdup(product)) == NULL) {
172*ab19a69eSdjm 		r = FIDO_ERR_INTERNAL;
173*ab19a69eSdjm 		goto out;
174*ab19a69eSdjm 	}
175*ab19a69eSdjm 
176*ab19a69eSdjm 	fido_dev_info_reset(&devlist[i]);
177*ab19a69eSdjm 	devlist[i].path = path_copy;
178*ab19a69eSdjm 	devlist[i].manufacturer = manu_copy;
179*ab19a69eSdjm 	devlist[i].product = prod_copy;
180*ab19a69eSdjm 	devlist[i].io = *io;
181*ab19a69eSdjm 	if (transport)
182*ab19a69eSdjm 		devlist[i].transport = *transport;
183*ab19a69eSdjm 	r = FIDO_OK;
184*ab19a69eSdjm out:
185*ab19a69eSdjm 	if (r != FIDO_OK) {
186*ab19a69eSdjm 		free(prod_copy);
187*ab19a69eSdjm 		free(manu_copy);
188*ab19a69eSdjm 		free(path_copy);
189*ab19a69eSdjm 	}
190*ab19a69eSdjm 	return (r);
191*ab19a69eSdjm }
192*ab19a69eSdjm 
193d75efeb7Sdjm const char *
fido_dev_info_path(const fido_dev_info_t * di)194d75efeb7Sdjm fido_dev_info_path(const fido_dev_info_t *di)
195d75efeb7Sdjm {
196d75efeb7Sdjm 	return (di->path);
197d75efeb7Sdjm }
198d75efeb7Sdjm 
199d75efeb7Sdjm int16_t
fido_dev_info_vendor(const fido_dev_info_t * di)200d75efeb7Sdjm fido_dev_info_vendor(const fido_dev_info_t *di)
201d75efeb7Sdjm {
202d75efeb7Sdjm 	return (di->vendor_id);
203d75efeb7Sdjm }
204d75efeb7Sdjm 
205d75efeb7Sdjm int16_t
fido_dev_info_product(const fido_dev_info_t * di)206d75efeb7Sdjm fido_dev_info_product(const fido_dev_info_t *di)
207d75efeb7Sdjm {
208d75efeb7Sdjm 	return (di->product_id);
209d75efeb7Sdjm }
210d75efeb7Sdjm 
211d75efeb7Sdjm const char *
fido_dev_info_manufacturer_string(const fido_dev_info_t * di)212d75efeb7Sdjm fido_dev_info_manufacturer_string(const fido_dev_info_t *di)
213d75efeb7Sdjm {
214d75efeb7Sdjm 	return (di->manufacturer);
215d75efeb7Sdjm }
216d75efeb7Sdjm 
217d75efeb7Sdjm const char *
fido_dev_info_product_string(const fido_dev_info_t * di)218d75efeb7Sdjm fido_dev_info_product_string(const fido_dev_info_t *di)
219d75efeb7Sdjm {
220d75efeb7Sdjm 	return (di->product);
221d75efeb7Sdjm }
222