/libfido2/src/hid_linux.c
Line | Count | Source (jump to first uncovered line) |
1 | | /* |
2 | | * Copyright (c) 2019 Yubico AB. All rights reserved. |
3 | | * Use of this source code is governed by a BSD-style |
4 | | * license that can be found in the LICENSE file. |
5 | | */ |
6 | | |
7 | | #include <sys/types.h> |
8 | | #include <sys/file.h> |
9 | | #include <sys/ioctl.h> |
10 | | |
11 | | #include <linux/hidraw.h> |
12 | | #include <linux/input.h> |
13 | | |
14 | | #include <errno.h> |
15 | | #include <libudev.h> |
16 | | #include <time.h> |
17 | | #include <unistd.h> |
18 | | |
19 | | #include "fido.h" |
20 | | |
21 | | struct hid_linux { |
22 | | int fd; |
23 | | size_t report_in_len; |
24 | | size_t report_out_len; |
25 | | sigset_t sigmask; |
26 | | const sigset_t *sigmaskp; |
27 | | }; |
28 | | |
29 | | static int |
30 | | get_report_descriptor(int fd, struct hidraw_report_descriptor *hrd) |
31 | 496k | { |
32 | 496k | int s = -1; |
33 | | |
34 | 496k | if (ioctl(fd, IOCTL_REQ(HIDIOCGRDESCSIZE), &s) == -1) { |
35 | 1.25k | fido_log_error(errno, "%s: ioctl HIDIOCGRDESCSIZE", __func__); |
36 | 1.25k | return (-1); |
37 | 1.25k | } |
38 | | |
39 | 495k | if (s < 0 || (unsigned)s > HID_MAX_DESCRIPTOR_SIZE) { |
40 | 0 | fido_log_debug("%s: HIDIOCGRDESCSIZE %d", __func__, s); |
41 | 0 | return (-1); |
42 | 0 | } |
43 | | |
44 | 495k | hrd->size = (unsigned)s; |
45 | | |
46 | 495k | if (ioctl(fd, IOCTL_REQ(HIDIOCGRDESC), hrd) == -1) { |
47 | 1.32k | fido_log_error(errno, "%s: ioctl HIDIOCGRDESC", __func__); |
48 | 1.32k | return (-1); |
49 | 1.32k | } |
50 | | |
51 | 494k | return (0); |
52 | 495k | } |
53 | | |
54 | | static bool |
55 | | is_fido(const char *path) |
56 | 496k | { |
57 | 496k | int fd; |
58 | 496k | uint32_t usage_page = 0; |
59 | 496k | struct hidraw_report_descriptor hrd; |
60 | | |
61 | 496k | memset(&hrd, 0, sizeof(hrd)); |
62 | | |
63 | 496k | if ((fd = fido_hid_unix_open(path)) == -1) |
64 | 0 | return (false); |
65 | | |
66 | 496k | if (get_report_descriptor(fd, &hrd) < 0 || |
67 | 496k | fido_hid_get_usage(hrd.value, hrd.size, &usage_page) < 0) |
68 | 261k | usage_page = 0; |
69 | | |
70 | 496k | if (close(fd) == -1) |
71 | 0 | fido_log_error(errno, "%s: close", __func__); |
72 | | |
73 | 496k | return (usage_page == 0xf1d0); |
74 | 496k | } |
75 | | |
76 | | static int |
77 | | parse_uevent(const char *uevent, int *bus, int16_t *vendor_id, |
78 | | int16_t *product_id) |
79 | 66.5k | { |
80 | 66.5k | char *cp; |
81 | 66.5k | char *p; |
82 | 66.5k | char *s; |
83 | 66.5k | int ok = -1; |
84 | 66.5k | short unsigned int x; |
85 | 66.5k | short unsigned int y; |
86 | 66.5k | short unsigned int z; |
87 | | |
88 | 66.5k | if ((s = cp = strdup(uevent)) == NULL) |
89 | 186 | return (-1); |
90 | | |
91 | 137k | while ((p = strsep(&cp, "\n")) != NULL && *p != '\0') { |
92 | 80.7k | if (strncmp(p, "HID_ID=", 7) == 0) { |
93 | 11.8k | if (sscanf(p + 7, "%hx:%hx:%hx", &x, &y, &z) == 3) { |
94 | 10.0k | *bus = (int)x; |
95 | 10.0k | *vendor_id = (int16_t)y; |
96 | 10.0k | *product_id = (int16_t)z; |
97 | 10.0k | ok = 0; |
98 | 10.0k | break; |
99 | 10.0k | } |
100 | 11.8k | } |
101 | 80.7k | } |
102 | | |
103 | 66.3k | free(s); |
104 | | |
105 | 66.3k | return (ok); |
106 | 66.5k | } |
107 | | |
108 | | static char * |
109 | | get_parent_attr(struct udev_device *dev, const char *subsystem, |
110 | | const char *devtype, const char *attr) |
111 | 70.3k | { |
112 | 70.3k | struct udev_device *parent; |
113 | 70.3k | const char *value; |
114 | | |
115 | 70.3k | if ((parent = udev_device_get_parent_with_subsystem_devtype(dev, |
116 | 70.3k | subsystem, devtype)) == NULL || (value = |
117 | 70.1k | udev_device_get_sysattr_value(parent, attr)) == NULL) |
118 | 381 | return (NULL); |
119 | | |
120 | 69.9k | return (strdup(value)); |
121 | 70.3k | } |
122 | | |
123 | | static char * |
124 | | get_usb_attr(struct udev_device *dev, const char *attr) |
125 | 3.32k | { |
126 | 3.32k | return (get_parent_attr(dev, "usb", "usb_device", attr)); |
127 | 3.32k | } |
128 | | |
129 | | static int |
130 | | copy_info(fido_dev_info_t *di, struct udev *udev, |
131 | | struct udev_list_entry *udev_entry) |
132 | 500k | { |
133 | 500k | const char *name; |
134 | 500k | const char *path; |
135 | 500k | char *uevent = NULL; |
136 | 500k | struct udev_device *dev = NULL; |
137 | 500k | int bus = 0; |
138 | 500k | int ok = -1; |
139 | | |
140 | 500k | memset(di, 0, sizeof(*di)); |
141 | | |
142 | 500k | if ((name = udev_list_entry_get_name(udev_entry)) == NULL || |
143 | 500k | (dev = udev_device_new_from_syspath(udev, name)) == NULL || |
144 | 500k | (path = udev_device_get_devnode(dev)) == NULL || |
145 | 500k | is_fido(path) == 0) |
146 | 433k | goto fail; |
147 | | |
148 | 67.0k | if ((uevent = get_parent_attr(dev, "hid", NULL, "uevent")) == NULL || |
149 | 67.0k | parse_uevent(uevent, &bus, &di->vendor_id, &di->product_id) < 0) { |
150 | 56.9k | fido_log_debug("%s: uevent", __func__); |
151 | 56.9k | goto fail; |
152 | 56.9k | } |
153 | | |
154 | 10.0k | #ifndef FIDO_HID_ANY |
155 | 10.0k | if (bus != BUS_USB) { |
156 | 8.42k | fido_log_debug("%s: bus", __func__); |
157 | 8.42k | goto fail; |
158 | 8.42k | } |
159 | 1.66k | #endif |
160 | | |
161 | 1.66k | di->path = strdup(path); |
162 | 1.66k | if ((di->manufacturer = get_usb_attr(dev, "manufacturer")) == NULL) |
163 | 19 | di->manufacturer = strdup(""); |
164 | 1.66k | if ((di->product = get_usb_attr(dev, "product")) == NULL) |
165 | 18 | di->product = strdup(""); |
166 | 1.66k | if (di->path == NULL || di->manufacturer == NULL || di->product == NULL) |
167 | 14 | goto fail; |
168 | | |
169 | 1.64k | ok = 0; |
170 | 500k | fail: |
171 | 500k | if (dev != NULL) |
172 | 497k | udev_device_unref(dev); |
173 | | |
174 | 500k | free(uevent); |
175 | | |
176 | 500k | if (ok < 0) { |
177 | 498k | free(di->path); |
178 | 498k | free(di->manufacturer); |
179 | 498k | free(di->product); |
180 | 498k | explicit_bzero(di, sizeof(*di)); |
181 | 498k | } |
182 | | |
183 | 500k | return (ok); |
184 | 1.64k | } |
185 | | |
186 | | int |
187 | | fido_hid_manifest(fido_dev_info_t *devlist, size_t ilen, size_t *olen) |
188 | 1.22k | { |
189 | 1.22k | struct udev *udev = NULL; |
190 | 1.22k | struct udev_enumerate *udev_enum = NULL; |
191 | 1.22k | struct udev_list_entry *udev_list; |
192 | 1.22k | struct udev_list_entry *udev_entry; |
193 | 1.22k | int r = FIDO_ERR_INTERNAL; |
194 | | |
195 | 1.22k | *olen = 0; |
196 | | |
197 | 1.22k | if (ilen == 0) |
198 | 0 | return (FIDO_OK); /* nothing to do */ |
199 | | |
200 | 1.22k | if (devlist == NULL) |
201 | 0 | return (FIDO_ERR_INVALID_ARGUMENT); |
202 | | |
203 | 1.22k | if ((udev = udev_new()) == NULL || |
204 | 1.22k | (udev_enum = udev_enumerate_new(udev)) == NULL) |
205 | 7 | goto fail; |
206 | | |
207 | 1.21k | if (udev_enumerate_add_match_subsystem(udev_enum, "hidraw") < 0 || |
208 | 1.21k | udev_enumerate_scan_devices(udev_enum) < 0) |
209 | 6 | goto fail; |
210 | | |
211 | 1.21k | if ((udev_list = udev_enumerate_get_list_entry(udev_enum)) == NULL) { |
212 | 3 | r = FIDO_OK; /* zero hidraw devices */ |
213 | 3 | goto fail; |
214 | 3 | } |
215 | | |
216 | 500k | udev_list_entry_foreach(udev_entry, udev_list) { |
217 | 500k | if (copy_info(&devlist[*olen], udev, udev_entry) == 0) { |
218 | 1.64k | devlist[*olen].io = (fido_dev_io_t) { |
219 | 1.64k | fido_hid_open, |
220 | 1.64k | fido_hid_close, |
221 | 1.64k | fido_hid_read, |
222 | 1.64k | fido_hid_write, |
223 | 1.64k | }; |
224 | 1.64k | if (++(*olen) == ilen) |
225 | 38 | break; |
226 | 1.64k | } |
227 | 500k | } |
228 | | |
229 | 1.20k | r = FIDO_OK; |
230 | 1.22k | fail: |
231 | 1.22k | if (udev_enum != NULL) |
232 | 1.21k | udev_enumerate_unref(udev_enum); |
233 | 1.22k | if (udev != NULL) |
234 | 1.22k | udev_unref(udev); |
235 | | |
236 | 1.22k | return (r); |
237 | 1.20k | } |
238 | | |
239 | | void * |
240 | | fido_hid_open(const char *path) |
241 | 0 | { |
242 | 0 | struct hid_linux *ctx; |
243 | 0 | struct hidraw_report_descriptor hrd; |
244 | 0 | struct timespec tv_pause; |
245 | 0 | long interval_ms, retries = 0; |
246 | |
|
247 | 0 | if ((ctx = calloc(1, sizeof(*ctx))) == NULL || |
248 | 0 | (ctx->fd = fido_hid_unix_open(path)) == -1) { |
249 | 0 | free(ctx); |
250 | 0 | return (NULL); |
251 | 0 | } |
252 | | |
253 | 0 | while (flock(ctx->fd, LOCK_EX|LOCK_NB) == -1) { |
254 | 0 | if (errno != EWOULDBLOCK) { |
255 | 0 | fido_log_error(errno, "%s: flock", __func__); |
256 | 0 | fido_hid_close(ctx); |
257 | 0 | return (NULL); |
258 | 0 | } |
259 | 0 | if (retries++ >= 15) { |
260 | 0 | fido_log_debug("%s: flock timeout", __func__); |
261 | 0 | fido_hid_close(ctx); |
262 | 0 | return (NULL); |
263 | 0 | } |
264 | 0 | interval_ms = retries * 100000000L; |
265 | 0 | tv_pause.tv_sec = interval_ms / 1000000000L; |
266 | 0 | tv_pause.tv_nsec = interval_ms % 1000000000L; |
267 | 0 | if (nanosleep(&tv_pause, NULL) == -1) { |
268 | 0 | fido_log_error(errno, "%s: nanosleep", __func__); |
269 | 0 | fido_hid_close(ctx); |
270 | 0 | return (NULL); |
271 | 0 | } |
272 | 0 | } |
273 | | |
274 | 0 | if (get_report_descriptor(ctx->fd, &hrd) < 0 || |
275 | 0 | fido_hid_get_report_len(hrd.value, hrd.size, &ctx->report_in_len, |
276 | 0 | &ctx->report_out_len) < 0 || ctx->report_in_len == 0 || |
277 | 0 | ctx->report_out_len == 0) { |
278 | 0 | fido_log_debug("%s: using default report sizes", __func__); |
279 | 0 | ctx->report_in_len = CTAP_MAX_REPORT_LEN; |
280 | 0 | ctx->report_out_len = CTAP_MAX_REPORT_LEN; |
281 | 0 | } |
282 | |
|
283 | 0 | return (ctx); |
284 | 0 | } |
285 | | |
286 | | void |
287 | | fido_hid_close(void *handle) |
288 | 0 | { |
289 | 0 | struct hid_linux *ctx = handle; |
290 | |
|
291 | 0 | if (close(ctx->fd) == -1) |
292 | 0 | fido_log_error(errno, "%s: close", __func__); |
293 | |
|
294 | 0 | free(ctx); |
295 | 0 | } |
296 | | |
297 | | int |
298 | | fido_hid_set_sigmask(void *handle, const fido_sigset_t *sigmask) |
299 | 0 | { |
300 | 0 | struct hid_linux *ctx = handle; |
301 | |
|
302 | 0 | ctx->sigmask = *sigmask; |
303 | 0 | ctx->sigmaskp = &ctx->sigmask; |
304 | |
|
305 | 0 | return (FIDO_OK); |
306 | 0 | } |
307 | | |
308 | | int |
309 | | fido_hid_read(void *handle, unsigned char *buf, size_t len, int ms) |
310 | 0 | { |
311 | 0 | struct hid_linux *ctx = handle; |
312 | 0 | ssize_t r; |
313 | |
|
314 | 0 | if (len != ctx->report_in_len) { |
315 | 0 | fido_log_debug("%s: len %zu", __func__, len); |
316 | 0 | return (-1); |
317 | 0 | } |
318 | | |
319 | 0 | if (fido_hid_unix_wait(ctx->fd, ms, ctx->sigmaskp) < 0) { |
320 | 0 | fido_log_debug("%s: fd not ready", __func__); |
321 | 0 | return (-1); |
322 | 0 | } |
323 | | |
324 | 0 | if ((r = read(ctx->fd, buf, len)) == -1) { |
325 | 0 | fido_log_error(errno, "%s: read", __func__); |
326 | 0 | return (-1); |
327 | 0 | } |
328 | | |
329 | 0 | if (r < 0 || (size_t)r != len) { |
330 | 0 | fido_log_debug("%s: %zd != %zu", __func__, r, len); |
331 | 0 | return (-1); |
332 | 0 | } |
333 | | |
334 | 0 | return ((int)r); |
335 | 0 | } |
336 | | |
337 | | int |
338 | | fido_hid_write(void *handle, const unsigned char *buf, size_t len) |
339 | 0 | { |
340 | 0 | struct hid_linux *ctx = handle; |
341 | 0 | ssize_t r; |
342 | |
|
343 | 0 | if (len != ctx->report_out_len + 1) { |
344 | 0 | fido_log_debug("%s: len %zu", __func__, len); |
345 | 0 | return (-1); |
346 | 0 | } |
347 | | |
348 | 0 | if ((r = write(ctx->fd, buf, len)) == -1) { |
349 | 0 | fido_log_error(errno, "%s: write", __func__); |
350 | 0 | return (-1); |
351 | 0 | } |
352 | | |
353 | 0 | if (r < 0 || (size_t)r != len) { |
354 | 0 | fido_log_debug("%s: %zd != %zu", __func__, r, len); |
355 | 0 | return (-1); |
356 | 0 | } |
357 | | |
358 | 0 | return ((int)r); |
359 | 0 | } |
360 | | |
361 | | size_t |
362 | | fido_hid_report_in_len(void *handle) |
363 | 0 | { |
364 | 0 | struct hid_linux *ctx = handle; |
365 | |
|
366 | 0 | return (ctx->report_in_len); |
367 | 0 | } |
368 | | |
369 | | size_t |
370 | | fido_hid_report_out_len(void *handle) |
371 | 0 | { |
372 | 0 | struct hid_linux *ctx = handle; |
373 | |
|
374 | 0 | return (ctx->report_out_len); |
375 | 0 | } |