Coverage Report

Created: 2022-07-22 12:05

/libfido2/src/dev.c
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * Copyright (c) 2018-2022 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 "fido.h"
8
9
#ifndef TLS
10
#define TLS
11
#endif
12
13
static TLS bool disable_u2f_fallback;
14
15
#ifdef FIDO_FUZZ
16
static void
17
set_random_report_len(fido_dev_t *dev)
18
38.5k
{
19
38.5k
        dev->rx_len = CTAP_MIN_REPORT_LEN +
20
38.5k
            uniform_random(CTAP_MAX_REPORT_LEN - CTAP_MIN_REPORT_LEN + 1);
21
38.5k
        dev->tx_len = CTAP_MIN_REPORT_LEN +
22
38.5k
            uniform_random(CTAP_MAX_REPORT_LEN - CTAP_MIN_REPORT_LEN + 1);
23
38.5k
}
24
#endif
25
26
static void
27
fido_dev_set_extension_flags(fido_dev_t *dev, const fido_cbor_info_t *info)
28
3.51k
{
29
3.51k
        char * const    *ptr = fido_cbor_info_extensions_ptr(info);
30
3.51k
        size_t           len = fido_cbor_info_extensions_len(info);
31
32
10.1k
        for (size_t i = 0; i < len; i++)
33
6.66k
                if (strcmp(ptr[i], "credProtect") == 0)
34
2.28k
                        dev->flags |= FIDO_DEV_CRED_PROT;
35
3.51k
}
36
37
static void
38
fido_dev_set_option_flags(fido_dev_t *dev, const fido_cbor_info_t *info)
39
3.51k
{
40
3.51k
        char * const    *ptr = fido_cbor_info_options_name_ptr(info);
41
3.51k
        const bool      *val = fido_cbor_info_options_value_ptr(info);
42
3.51k
        size_t           len = fido_cbor_info_options_len(info);
43
44
20.7k
        for (size_t i = 0; i < len; i++)
45
17.2k
                if (strcmp(ptr[i], "clientPin") == 0) {
46
2.40k
                        dev->flags |= val[i] ?
47
2.18k
                            FIDO_DEV_PIN_SET : FIDO_DEV_PIN_UNSET;
48
14.8k
                } else if (strcmp(ptr[i], "credMgmt") == 0 ||
49
14.8k
                           strcmp(ptr[i], "credentialMgmtPreview") == 0) {
50
2.12k
                        if (val[i])
51
2.11k
                                dev->flags |= FIDO_DEV_CREDMAN;
52
12.6k
                } else if (strcmp(ptr[i], "uv") == 0) {
53
261
                        dev->flags |= val[i] ?
54
260
                            FIDO_DEV_UV_SET : FIDO_DEV_UV_UNSET;
55
12.4k
                } else if (strcmp(ptr[i], "pinUvAuthToken") == 0) {
56
222
                        if (val[i])
57
219
                                dev->flags |= FIDO_DEV_TOKEN_PERMS;
58
222
                }
59
3.51k
}
60
61
static void
62
fido_dev_set_protocol_flags(fido_dev_t *dev, const fido_cbor_info_t *info)
63
3.51k
{
64
3.51k
        const uint8_t   *ptr = fido_cbor_info_protocols_ptr(info);
65
3.51k
        size_t           len = fido_cbor_info_protocols_len(info);
66
67
8.66k
        for (size_t i = 0; i < len; i++)
68
5.14k
                switch (ptr[i]) {
69
3.17k
                case CTAP_PIN_PROTOCOL1:
70
3.17k
                        dev->flags |= FIDO_DEV_PIN_PROTOCOL1;
71
3.17k
                        break;
72
1.14k
                case CTAP_PIN_PROTOCOL2:
73
1.14k
                        dev->flags |= FIDO_DEV_PIN_PROTOCOL2;
74
1.14k
                        break;
75
831
                default:
76
831
                        fido_log_debug("%s: unknown protocol %u", __func__,
77
831
                            ptr[i]);
78
831
                        break;
79
5.14k
                }
80
3.51k
}
81
82
static void
83
fido_dev_set_flags(fido_dev_t *dev, const fido_cbor_info_t *info)
84
3.51k
{
85
3.51k
        fido_dev_set_extension_flags(dev, info);
86
3.51k
        fido_dev_set_option_flags(dev, info);
87
3.51k
        fido_dev_set_protocol_flags(dev, info);
88
3.51k
}
89
90
static int
91
fido_dev_open_tx(fido_dev_t *dev, const char *path, int *ms)
92
492k
{
93
492k
        int r;
94
95
492k
        if (dev->io_handle != NULL) {
96
0
                fido_log_debug("%s: handle=%p", __func__, dev->io_handle);
97
0
                return (FIDO_ERR_INVALID_ARGUMENT);
98
0
        }
99
100
492k
        if (dev->io.open == NULL || dev->io.close == NULL) {
101
0
                fido_log_debug("%s: NULL open/close", __func__);
102
0
                return (FIDO_ERR_INVALID_ARGUMENT);
103
0
        }
104
105
492k
        if (dev->cid != CTAP_CID_BROADCAST) {
106
0
                fido_log_debug("%s: cid=0x%x", __func__, dev->cid);
107
0
                return (FIDO_ERR_INVALID_ARGUMENT);
108
0
        }
109
110
492k
        if (fido_get_random(&dev->nonce, sizeof(dev->nonce)) < 0) {
111
1.26k
                fido_log_debug("%s: fido_get_random", __func__);
112
1.26k
                return (FIDO_ERR_INTERNAL);
113
1.26k
        }
114
115
491k
        if ((dev->io_handle = dev->io.open(path)) == NULL) {
116
453k
                fido_log_debug("%s: dev->io.open", __func__);
117
453k
                return (FIDO_ERR_INTERNAL);
118
453k
        }
119
120
38.5k
        if (dev->io_own) {
121
38.5k
                dev->rx_len = CTAP_MAX_REPORT_LEN;
122
38.5k
                dev->tx_len = CTAP_MAX_REPORT_LEN;
123
38.5k
        } else {
124
0
                dev->rx_len = fido_hid_report_in_len(dev->io_handle);
125
0
                dev->tx_len = fido_hid_report_out_len(dev->io_handle);
126
0
        }
127
128
38.5k
#ifdef FIDO_FUZZ
129
38.5k
        set_random_report_len(dev);
130
38.5k
#endif
131
132
38.5k
        if (dev->rx_len < CTAP_MIN_REPORT_LEN ||
133
38.5k
            dev->rx_len > CTAP_MAX_REPORT_LEN) {
134
0
                fido_log_debug("%s: invalid rx_len %zu", __func__, dev->rx_len);
135
0
                r = FIDO_ERR_RX;
136
0
                goto fail;
137
0
        }
138
139
38.5k
        if (dev->tx_len < CTAP_MIN_REPORT_LEN ||
140
38.5k
            dev->tx_len > CTAP_MAX_REPORT_LEN) {
141
0
                fido_log_debug("%s: invalid tx_len %zu", __func__, dev->tx_len);
142
0
                r = FIDO_ERR_TX;
143
0
                goto fail;
144
0
        }
145
146
38.5k
        if (fido_tx(dev, CTAP_CMD_INIT, &dev->nonce, sizeof(dev->nonce),
147
38.5k
            ms) < 0) {
148
967
                fido_log_debug("%s: fido_tx", __func__);
149
967
                r = FIDO_ERR_TX;
150
967
                goto fail;
151
967
        }
152
153
37.6k
        return (FIDO_OK);
154
967
fail:
155
967
        dev->io.close(dev->io_handle);
156
967
        dev->io_handle = NULL;
157
158
967
        return (r);
159
38.5k
}
160
161
static int
162
fido_dev_open_rx(fido_dev_t *dev, int *ms)
163
37.6k
{
164
37.6k
        fido_cbor_info_t        *info = NULL;
165
37.6k
        int                      reply_len;
166
37.6k
        int                      r;
167
168
37.6k
        if ((reply_len = fido_rx(dev, CTAP_CMD_INIT, &dev->attr,
169
37.6k
            sizeof(dev->attr), ms)) < 0) {
170
19.8k
                fido_log_debug("%s: fido_rx", __func__);
171
19.8k
                r = FIDO_ERR_RX;
172
19.8k
                goto fail;
173
19.8k
        }
174
175
17.7k
#ifdef FIDO_FUZZ
176
17.7k
        dev->attr.nonce = dev->nonce;
177
17.7k
#endif
178
179
17.7k
        if ((size_t)reply_len != sizeof(dev->attr) ||
180
17.7k
            dev->attr.nonce != dev->nonce) {
181
267
                fido_log_debug("%s: invalid nonce", __func__);
182
267
                r = FIDO_ERR_RX;
183
267
                goto fail;
184
267
        }
185
186
17.5k
        dev->flags = 0;
187
17.5k
        dev->cid = dev->attr.cid;
188
189
17.5k
        if (fido_dev_is_fido2(dev)) {
190
13.6k
                if ((info = fido_cbor_info_new()) == NULL) {
191
48
                        fido_log_debug("%s: fido_cbor_info_new", __func__);
192
48
                        r = FIDO_ERR_INTERNAL;
193
48
                        goto fail;
194
48
                }
195
13.6k
                if ((r = fido_dev_get_cbor_info_wait(dev, info,
196
13.6k
                    ms)) != FIDO_OK) {
197
10.0k
                        fido_log_debug("%s: fido_dev_cbor_info_wait: %d",
198
10.0k
                            __func__, r);
199
10.0k
                        if (disable_u2f_fallback)
200
0
                                goto fail;
201
10.0k
                        fido_log_debug("%s: falling back to u2f", __func__);
202
10.0k
                        fido_dev_force_u2f(dev);
203
10.0k
                } else {
204
3.51k
                        fido_dev_set_flags(dev, info);
205
3.51k
                }
206
13.6k
        }
207
208
17.4k
        if (fido_dev_is_fido2(dev) && info != NULL) {
209
3.51k
                dev->maxmsgsize = fido_cbor_info_maxmsgsiz(info);
210
3.51k
                fido_log_debug("%s: FIDO_MAXMSG=%d, maxmsgsiz=%lu", __func__,
211
3.51k
                    FIDO_MAXMSG, (unsigned long)dev->maxmsgsize);
212
3.51k
        }
213
214
17.4k
        r = FIDO_OK;
215
37.6k
fail:
216
37.6k
        fido_cbor_info_free(&info);
217
218
37.6k
        if (r != FIDO_OK) {
219
20.1k
                dev->io.close(dev->io_handle);
220
20.1k
                dev->io_handle = NULL;
221
20.1k
        }
222
223
37.6k
        return (r);
224
17.4k
}
225
226
static int
227
fido_dev_open_wait(fido_dev_t *dev, const char *path, int *ms)
228
492k
{
229
492k
        int r;
230
231
#ifdef USE_WINHELLO
232
        if (strcmp(path, FIDO_WINHELLO_PATH) == 0)
233
                return (fido_winhello_open(dev));
234
#endif
235
492k
        if ((r = fido_dev_open_tx(dev, path, ms)) != FIDO_OK ||
236
492k
            (r = fido_dev_open_rx(dev, ms)) != FIDO_OK)
237
475k
                return (r);
238
239
17.4k
        return (FIDO_OK);
240
492k
}
241
242
static void
243
run_manifest(fido_dev_info_t *devlist, size_t ilen, size_t *olen,
244
    const char *type, int (*manifest)(fido_dev_info_t *, size_t, size_t *))
245
3.22k
{
246
3.22k
        size_t ndevs = 0;
247
3.22k
        int r;
248
249
3.22k
        if (*olen >= ilen) {
250
70
                fido_log_debug("%s: skipping %s", __func__, type);
251
70
                return;
252
70
        }
253
3.15k
        if ((r = manifest(devlist + *olen, ilen - *olen, &ndevs)) != FIDO_OK)
254
29
                fido_log_debug("%s: %s: 0x%x", __func__, type, r);
255
3.15k
        fido_log_debug("%s: found %zu %s device%s", __func__, ndevs, type,
256
3.15k
            ndevs == 1 ? "" : "s");
257
3.15k
        *olen += ndevs;
258
3.15k
}
259
260
int
261
fido_dev_info_manifest(fido_dev_info_t *devlist, size_t ilen, size_t *olen)
262
1.07k
{
263
1.07k
        *olen = 0;
264
265
1.07k
        run_manifest(devlist, ilen, olen, "hid", fido_hid_manifest);
266
1.07k
#ifdef USE_NFC
267
1.07k
        run_manifest(devlist, ilen, olen, "nfc", fido_nfc_manifest);
268
1.07k
#endif
269
1.07k
#ifdef USE_PCSC
270
1.07k
        run_manifest(devlist, ilen, olen, "pcsc", fido_pcsc_manifest);
271
1.07k
#endif
272
#ifdef USE_WINHELLO
273
        run_manifest(devlist, ilen, olen, "winhello", fido_winhello_manifest);
274
#endif
275
276
1.07k
        return (FIDO_OK);
277
1.07k
}
278
279
int
280
fido_dev_open_with_info(fido_dev_t *dev)
281
0
{
282
0
        int ms = dev->timeout_ms;
283
284
0
        if (dev->path == NULL)
285
0
                return (FIDO_ERR_INVALID_ARGUMENT);
286
287
0
        return (fido_dev_open_wait(dev, dev->path, &ms));
288
0
}
289
290
int
291
fido_dev_open(fido_dev_t *dev, const char *path)
292
492k
{
293
492k
        int ms = dev->timeout_ms;
294
295
492k
#ifdef USE_NFC
296
492k
        if (fido_is_nfc(path) && fido_dev_set_nfc(dev) < 0) {
297
0
                fido_log_debug("%s: fido_dev_set_nfc", __func__);
298
0
                return FIDO_ERR_INTERNAL;
299
0
        }
300
492k
#endif
301
492k
#ifdef USE_PCSC
302
492k
        if (fido_is_pcsc(path) && fido_dev_set_pcsc(dev) < 0) {
303
0
                fido_log_debug("%s: fido_dev_set_pcsc", __func__);
304
0
                return FIDO_ERR_INTERNAL;
305
0
        }
306
492k
#endif
307
308
492k
        return (fido_dev_open_wait(dev, path, &ms));
309
492k
}
310
311
int
312
fido_dev_close(fido_dev_t *dev)
313
17.4k
{
314
#ifdef USE_WINHELLO
315
        if (dev->flags & FIDO_DEV_WINHELLO)
316
                return (fido_winhello_close(dev));
317
#endif
318
17.4k
        if (dev->io_handle == NULL || dev->io.close == NULL)
319
0
                return (FIDO_ERR_INVALID_ARGUMENT);
320
321
17.4k
        dev->io.close(dev->io_handle);
322
17.4k
        dev->io_handle = NULL;
323
17.4k
        dev->cid = CTAP_CID_BROADCAST;
324
325
17.4k
        return (FIDO_OK);
326
17.4k
}
327
328
int
329
fido_dev_set_sigmask(fido_dev_t *dev, const fido_sigset_t *sigmask)
330
0
{
331
0
        if (dev->io_handle == NULL || sigmask == NULL)
332
0
                return (FIDO_ERR_INVALID_ARGUMENT);
333
334
0
#ifdef USE_NFC
335
0
        if (dev->transport.rx == fido_nfc_rx && dev->io.read == fido_nfc_read)
336
0
                return (fido_nfc_set_sigmask(dev->io_handle, sigmask));
337
0
#endif
338
0
        if (dev->transport.rx == NULL && dev->io.read == fido_hid_read)
339
0
                return (fido_hid_set_sigmask(dev->io_handle, sigmask));
340
341
0
        return (FIDO_ERR_INVALID_ARGUMENT);
342
0
}
343
344
int
345
fido_dev_cancel(fido_dev_t *dev)
346
4.43k
{
347
4.43k
        int ms = dev->timeout_ms;
348
349
#ifdef USE_WINHELLO
350
        if (dev->flags & FIDO_DEV_WINHELLO)
351
                return (fido_winhello_cancel(dev));
352
#endif
353
4.43k
        if (fido_dev_is_fido2(dev) == false)
354
3.05k
                return (FIDO_ERR_INVALID_ARGUMENT);
355
1.38k
        if (fido_tx(dev, CTAP_CMD_CANCEL, NULL, 0, &ms) < 0)
356
78
                return (FIDO_ERR_TX);
357
358
1.30k
        return (FIDO_OK);
359
1.38k
}
360
361
int
362
fido_dev_set_io_functions(fido_dev_t *dev, const fido_dev_io_t *io)
363
37.7k
{
364
37.7k
        if (dev->io_handle != NULL) {
365
0
                fido_log_debug("%s: non-NULL handle", __func__);
366
0
                return (FIDO_ERR_INVALID_ARGUMENT);
367
0
        }
368
369
37.7k
        if (io == NULL || io->open == NULL || io->close == NULL ||
370
37.7k
            io->read == NULL || io->write == NULL) {
371
0
                fido_log_debug("%s: NULL function", __func__);
372
0
                return (FIDO_ERR_INVALID_ARGUMENT);
373
0
        }
374
375
37.7k
        dev->io = *io;
376
37.7k
        dev->io_own = true;
377
378
37.7k
        return (FIDO_OK);
379
37.7k
}
380
381
int
382
fido_dev_set_transport_functions(fido_dev_t *dev, const fido_dev_transport_t *t)
383
914
{
384
914
        if (dev->io_handle != NULL) {
385
0
                fido_log_debug("%s: non-NULL handle", __func__);
386
0
                return (FIDO_ERR_INVALID_ARGUMENT);
387
0
        }
388
389
914
        dev->transport = *t;
390
914
        dev->io_own = true;
391
392
914
        return (FIDO_OK);
393
914
}
394
395
void *
396
fido_dev_io_handle(const fido_dev_t *dev)
397
0
{
398
399
0
        return (dev->io_handle);
400
0
}
401
402
void
403
fido_init(int flags)
404
11.3k
{
405
11.3k
        if (flags & FIDO_DEBUG || getenv("FIDO_DEBUG") != NULL)
406
11.3k
                fido_log_init();
407
408
11.3k
        disable_u2f_fallback = (flags & FIDO_DISABLE_U2F_FALLBACK);
409
11.3k
}
410
411
fido_dev_t *
412
fido_dev_new(void)
413
494k
{
414
494k
        fido_dev_t *dev;
415
416
494k
        if ((dev = calloc(1, sizeof(*dev))) == NULL)
417
1.29k
                return (NULL);
418
419
492k
        dev->cid = CTAP_CID_BROADCAST;
420
492k
        dev->timeout_ms = -1;
421
492k
        dev->io = (fido_dev_io_t) {
422
492k
                &fido_hid_open,
423
492k
                &fido_hid_close,
424
492k
                &fido_hid_read,
425
492k
                &fido_hid_write,
426
492k
        };
427
428
492k
        return (dev);
429
494k
}
430
431
fido_dev_t *
432
fido_dev_new_with_info(const fido_dev_info_t *di)
433
0
{
434
0
        fido_dev_t *dev;
435
436
0
        if ((dev = calloc(1, sizeof(*dev))) == NULL)
437
0
                return (NULL);
438
439
#if 0
440
        if (di->io.open == NULL || di->io.close == NULL ||
441
            di->io.read == NULL || di->io.write == NULL) {
442
                fido_log_debug("%s: NULL function", __func__);
443
                fido_dev_free(&dev);
444
                return (NULL);
445
        }
446
#endif
447
448
0
        dev->io = di->io;
449
0
        dev->io_own = di->transport.tx != NULL || di->transport.rx != NULL;
450
0
        dev->transport = di->transport;
451
0
        dev->cid = CTAP_CID_BROADCAST;
452
0
        dev->timeout_ms = -1;
453
454
0
        if ((dev->path = strdup(di->path)) == NULL) {
455
0
                fido_log_debug("%s: strdup", __func__);
456
0
                fido_dev_free(&dev);
457
0
                return (NULL);
458
0
        }
459
460
0
        return (dev);
461
0
}
462
463
void
464
fido_dev_free(fido_dev_t **dev_p)
465
498k
{
466
498k
        fido_dev_t *dev;
467
468
498k
        if (dev_p == NULL || (dev = *dev_p) == NULL)
469
5.88k
                return;
470
471
492k
        free(dev->path);
472
492k
        free(dev);
473
474
492k
        *dev_p = NULL;
475
492k
}
476
477
uint8_t
478
fido_dev_protocol(const fido_dev_t *dev)
479
227
{
480
227
        return (dev->attr.protocol);
481
227
}
482
483
uint8_t
484
fido_dev_major(const fido_dev_t *dev)
485
227
{
486
227
        return (dev->attr.major);
487
227
}
488
489
uint8_t
490
fido_dev_minor(const fido_dev_t *dev)
491
227
{
492
227
        return (dev->attr.minor);
493
227
}
494
495
uint8_t
496
fido_dev_build(const fido_dev_t *dev)
497
227
{
498
227
        return (dev->attr.build);
499
227
}
500
501
uint8_t
502
fido_dev_flags(const fido_dev_t *dev)
503
227
{
504
227
        return (dev->attr.flags);
505
227
}
506
507
bool
508
fido_dev_is_fido2(const fido_dev_t *dev)
509
51.9k
{
510
51.9k
        return (dev->attr.flags & FIDO_CAP_CBOR);
511
51.9k
}
512
513
bool
514
fido_dev_is_winhello(const fido_dev_t *dev)
515
0
{
516
0
        return (dev->flags & FIDO_DEV_WINHELLO);
517
0
}
518
519
bool
520
fido_dev_supports_pin(const fido_dev_t *dev)
521
2.07k
{
522
2.07k
        return (dev->flags & (FIDO_DEV_PIN_SET|FIDO_DEV_PIN_UNSET));
523
2.07k
}
524
525
bool
526
fido_dev_has_pin(const fido_dev_t *dev)
527
2.01k
{
528
2.01k
        return (dev->flags & FIDO_DEV_PIN_SET);
529
2.01k
}
530
531
bool
532
fido_dev_supports_cred_prot(const fido_dev_t *dev)
533
2.19k
{
534
2.19k
        return (dev->flags & FIDO_DEV_CRED_PROT);
535
2.19k
}
536
537
bool
538
fido_dev_supports_credman(const fido_dev_t *dev)
539
2.19k
{
540
2.19k
        return (dev->flags & FIDO_DEV_CREDMAN);
541
2.19k
}
542
543
bool
544
fido_dev_supports_uv(const fido_dev_t *dev)
545
2.01k
{
546
2.01k
        return (dev->flags & (FIDO_DEV_UV_SET|FIDO_DEV_UV_UNSET));
547
2.01k
}
548
549
bool
550
fido_dev_has_uv(const fido_dev_t *dev)
551
2.07k
{
552
2.07k
        return (dev->flags & FIDO_DEV_UV_SET);
553
2.07k
}
554
555
bool
556
fido_dev_supports_permissions(const fido_dev_t *dev)
557
2.37k
{
558
2.37k
        return (dev->flags & FIDO_DEV_TOKEN_PERMS);
559
2.37k
}
560
561
void
562
fido_dev_force_u2f(fido_dev_t *dev)
563
11.4k
{
564
11.4k
        dev->attr.flags &= (uint8_t)~FIDO_CAP_CBOR;
565
11.4k
        dev->flags = 0;
566
11.4k
}
567
568
void
569
fido_dev_force_fido2(fido_dev_t *dev)
570
0
{
571
0
        dev->attr.flags |= FIDO_CAP_CBOR;
572
0
}
573
574
uint8_t
575
fido_dev_get_pin_protocol(const fido_dev_t *dev)
576
9.62k
{
577
9.62k
        if (dev->flags & FIDO_DEV_PIN_PROTOCOL2)
578
1.98k
                return (CTAP_PIN_PROTOCOL2);
579
7.63k
        else if (dev->flags & FIDO_DEV_PIN_PROTOCOL1)
580
6.28k
                return (CTAP_PIN_PROTOCOL1);
581
582
1.35k
        return (0);
583
9.62k
}
584
585
uint64_t
586
fido_dev_maxmsgsize(const fido_dev_t *dev)
587
2.09k
{
588
2.09k
        return (dev->maxmsgsize);
589
2.09k
}
590
591
int
592
fido_dev_set_timeout(fido_dev_t *dev, int ms)
593
37.7k
{
594
37.7k
        if (ms < -1)
595
0
                return (FIDO_ERR_INVALID_ARGUMENT);
596
597
37.7k
        dev->timeout_ms = ms;
598
599
37.7k
        return (FIDO_OK);
600
37.7k
}