fido_bio_info_type(3)

1FIDO_BIO_INFO_NEW(3)     BSD Library Functions Manual     FIDO_BIO_INFO_NEW(3)
2

NAME

4     fido_bio_info_new, fido_bio_info_free, fido_bio_info_type,
5     fido_bio_info_max_samples — FIDO2 biometric sensor information API
6

SYNOPSIS

8     #include <fido.h>
9     #include <fido/bio.h>
10
11     fido_bio_info_t *
12     fido_bio_info_new(void);
13
14     void
15     fido_bio_info_free(fido_bio_info_t **info_p);
16
17     uint8_t
18     fido_bio_info_type(const fido_bio_info_t *info);
19
20     uint8_t
21     fido_bio_info_max_samples(const fido_bio_info_t *info);
22

DESCRIPTION

24     Biometric sensor metadata is abstracted in libfido2 by the
25     fido_bio_info_t type.
26
27     The functions described in this page allow a fido_bio_info_t type to be
28     allocated, deallocated, and inspected.  For device operations on
29     fido_bio_info_t, please refer to fido_bio_dev_get_info(3).
30
31     The fido_bio_info_new() function returns a pointer to a newly allocated,
32     empty fido_bio_info_t type.  If memory cannot be allocated, NULL is re‐
33     turned.
34
35     The fido_bio_info_free() function releases the memory backing *info_p,
36     where *info_p must have been previously allocated by fido_bio_info_new().
37     On return, *info_p is set to NULL.  Either info_p or *info_p may be NULL,
38     in which case fido_bio_info_free() is a NOP.
39
40     The fido_bio_info_type() function returns the fingerprint sensor type,
41     which is 1 for touch sensors, and 2 for swipe sensors.
42
43     The fido_bio_info_max_samples() function returns the maximum number of
44     successful samples required for enrollment.
45

NAME

SYNOPSIS

DESCRIPTION

SEE ALSO