fido_bio_dev_enroll_begin(3)

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

NAME

4     fido_bio_dev_get_info, fido_bio_dev_enroll_begin,
5     fido_bio_dev_enroll_continue, fido_bio_dev_enroll_cancel,
6     fido_bio_dev_enroll_remove, fido_bio_dev_get_template_array,
7     fido_bio_dev_set_template_name — FIDO 2 biometric authenticator API
8

SYNOPSIS

10     #include <fido.h>
11     #include <fido/bio.h>
12
13     int
14     fido_bio_dev_get_info(fido_dev_t *dev, fido_bio_info_t *info);
15
16     int
17     fido_bio_dev_enroll_begin(fido_dev_t *dev, fido_bio_template_t *template,
18         fido_bio_enroll_t *enroll, uint32_t timeout_ms, const char *pin);
19
20     int
21     fido_bio_dev_enroll_continue(fido_dev_t *dev,
22         const fido_bio_template_t *template, fido_bio_enroll_t *enroll,
23         uint32_t timeout_ms);
24
25     int
26     fido_bio_dev_enroll_cancel(fido_dev_t *dev);
27
28     int
29     fido_bio_dev_enroll_remove(fido_dev_t *dev,
30         const fido_bio_template_t *template, const char *pin);
31
32     int
33     fido_bio_dev_get_template_array(fido_dev_t *dev,
34         fido_bio_template_array_t *template_array, const char *pin);
35
36     int
37     fido_bio_dev_set_template_name(fido_dev_t *dev,
38         const fido_bio_template_t *template, const char *pin);
39

DESCRIPTION

41     The functions described in this page allow biometric templates on a FIDO2
42     authenticator to be listed, created, removed, and customised.  For a
43     description of the types involved, please refer to fido_bio_info_new(3),
44     fido_bio_enroll_new(3), and fido_bio_template(3).
45
46     The fido_bio_dev_get_info() function populates info with sensor informa‐
47     tion from dev.
48
49     The fido_bio_dev_enroll_begin() function initiates a biometric enrollment
50     on dev, instructing the authenticator to wait timeout_ms milliseconds.
51     On success, template and enroll will be populated with the newly created
52     template's information and enrollment status, respectively.
53
54     The fido_bio_dev_enroll_continue() function continues an ongoing enroll‐
55     ment on dev, instructing the authenticator to wait timeout_ms millisec‐
56     onds.  On success, enroll will be updated to reflect the status of the
57     biometric enrollment.
58
59     The fido_bio_dev_enroll_cancel() function cancels an ongoing enrollment
60     on dev.
61
62     The fido_bio_dev_enroll_remove() function removes template from dev.
63
64     The fido_bio_dev_get_template_array() function populates template_array
65     with the templates currently enrolled on dev.
66
67     The fido_bio_dev_set_template_name() function sets the friendly name of
68     template on dev.
69
70     The error codes returned by fido_bio_dev_get_info(),
71     fido_bio_dev_enroll_begin(), fido_bio_dev_enroll_continue(),
72     fido_bio_dev_enroll_cancel(), fido_bio_dev_enroll_remove(),
73     fido_bio_dev_get_template_array(), and fido_bio_dev_set_template_name()
74     are defined in <fido/err.h>.  On success, FIDO_OK is returned.
75

NAME

SYNOPSIS

DESCRIPTION

SEE ALSO