fido_bio_enroll_last_status(3)

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

NAME

4     fido_bio_enroll_new, fido_bio_enroll_free, fido_bio_enroll_last_status,
5     fido_bio_enroll_remaining_samples — FIDO2 biometric enrollment API
6

SYNOPSIS

8     #include <fido.h>
9     #include <fido/bio.h>
10
11     #define FIDO_BIO_ENROLL_FP_GOOD                         0x00
12     #define FIDO_BIO_ENROLL_FP_TOO_HIGH                     0x01
13     #define FIDO_BIO_ENROLL_FP_TOO_LOW                      0x02
14     #define FIDO_BIO_ENROLL_FP_TOO_LEFT                     0x03
15     #define FIDO_BIO_ENROLL_FP_TOO_RIGHT                    0x04
16     #define FIDO_BIO_ENROLL_FP_TOO_FAST                     0x05
17     #define FIDO_BIO_ENROLL_FP_TOO_SLOW                     0x06
18     #define FIDO_BIO_ENROLL_FP_POOR_QUALITY                 0x07
19     #define FIDO_BIO_ENROLL_FP_TOO_SKEWED                   0x08
20     #define FIDO_BIO_ENROLL_FP_TOO_SHORT                    0x09
21     #define FIDO_BIO_ENROLL_FP_MERGE_FAILURE                0x0a
22     #define FIDO_BIO_ENROLL_FP_EXISTS                       0x0b
23     #define FIDO_BIO_ENROLL_FP_DATABASE_FULL                0x0c
24     #define FIDO_BIO_ENROLL_NO_USER_ACTIVITY                0x0d
25     #define FIDO_BIO_ENROLL_NO_USER_PRESENCE_TRANSITION     0x0e
26
27     fido_bio_enroll_t *
28     fido_bio_enroll_new(void);
29
30     void
31     fido_bio_enroll_free(fido_bio_enroll_t **enroll_p);
32
33     uint8_t
34     fido_bio_enroll_last_status(const fido_bio_enroll_t *enroll);
35
36     uint8_t
37     fido_bio_enroll_remaining_samples(const fido_bio_enroll_t *enroll);
38

DESCRIPTION

40     Ongoing FIDO2 biometric enrollments are abstracted in libfido2 by the
41     fido_bio_enroll_t type.
42
43     The functions described in this page allow a fido_bio_enroll_t type to be
44     allocated, deallocated, and inspected.  For device operations on
45     fido_bio_enroll_t, please refer to fido_bio_dev_get_info(3).
46
47     The fido_bio_enroll_new() function returns a pointer to a newly allo‐
48     cated, empty fido_bio_enroll_t type.  If memory cannot be allocated, NULL
49     is returned.
50
51     The fido_bio_enroll_free() function releases the memory backing
52     *enroll_p, where *enroll_p must have been previously allocated by
53     fido_bio_enroll_new().  On return, *enroll_p is set to NULL.  Either
54     enroll_p or *enroll_p may be NULL, in which case fido_bio_enroll_free()
55     is a NOP.
56
57     The fido_bio_enroll_last_status() function returns the enrollment status
58     of enroll.
59
60     The fido_bio_enroll_remaining_samples() function returns the number of
61     samples left for enroll to complete.
62

NAME

SYNOPSIS

DESCRIPTION

SEE ALSO