diff options
Diffstat (limited to 'man/fido_bio_info_new.3')
-rw-r--r-- | man/fido_bio_info_new.3 | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/man/fido_bio_info_new.3 b/man/fido_bio_info_new.3 new file mode 100644 index 0000000..c827333 --- /dev/null +++ b/man/fido_bio_info_new.3 | |||
@@ -0,0 +1,81 @@ | |||
1 | .\" Copyright (c) 2019 Yubico AB. All rights reserved. | ||
2 | .\" Use of this source code is governed by a BSD-style | ||
3 | .\" license that can be found in the LICENSE file. | ||
4 | .\" | ||
5 | .Dd $Mdocdate: September 13 2019 $ | ||
6 | .Dt FIDO_BIO_INFO_NEW 3 | ||
7 | .Os | ||
8 | .Sh NAME | ||
9 | .Nm fido_bio_info_new , | ||
10 | .Nm fido_bio_info_free , | ||
11 | .Nm fido_bio_info_type , | ||
12 | .Nm fido_bio_info_max_samples | ||
13 | .Nd FIDO 2 biometric sensor information API | ||
14 | .Sh SYNOPSIS | ||
15 | .In fido.h | ||
16 | .In fido/bio.h | ||
17 | .Ft fido_bio_info_t * | ||
18 | .Fn fido_bio_info_new "void" | ||
19 | .Ft void | ||
20 | .Fn fido_bio_info_free "fido_bio_info_t **info_p" | ||
21 | .Ft uint8_t | ||
22 | .Fn fido_bio_info_type "const fido_bio_info_t *info" | ||
23 | .Ft uint8_t | ||
24 | .Fn fido_bio_info_max_samples "const fido_bio_info_t *info" | ||
25 | .Sh DESCRIPTION | ||
26 | Biometric sensor metadata is abstracted in | ||
27 | .Em libfido2 | ||
28 | by the | ||
29 | .Vt fido_bio_info_t | ||
30 | type. | ||
31 | .Pp | ||
32 | The functions described in this page allow a | ||
33 | .Vt fido_bio_info_t | ||
34 | type to be allocated, deallocated, and inspected. | ||
35 | For device operations on | ||
36 | .Vt fido_bio_info_t , | ||
37 | please refer to | ||
38 | .Xr fido_bio_dev_get_info 3 . | ||
39 | .Pp | ||
40 | The | ||
41 | .Fn fido_bio_info_new | ||
42 | function returns a pointer to a newly allocated, empty | ||
43 | .Vt fido_bio_info_t | ||
44 | type. | ||
45 | If memory cannot be allocated, NULL is returned. | ||
46 | .Pp | ||
47 | The | ||
48 | .Fn fido_bio_info_free | ||
49 | function releases the memory backing | ||
50 | .Fa *info_p , | ||
51 | where | ||
52 | .Fa *info_p | ||
53 | must have been previously allocated by | ||
54 | .Fn fido_bio_info_new . | ||
55 | On return, | ||
56 | .Fa *info_p | ||
57 | is set to NULL. | ||
58 | Either | ||
59 | .Fa info_p | ||
60 | or | ||
61 | .Fa *info_p | ||
62 | may be NULL, in which case | ||
63 | .Fn fido_bio_info_free | ||
64 | is a NOP. | ||
65 | .Pp | ||
66 | The | ||
67 | .Fn fido_bio_info_type | ||
68 | function returns the fingerprint sensor type, which is | ||
69 | .Dv 1 | ||
70 | for touch sensors, and | ||
71 | .Dv 2 | ||
72 | for swipe sensors. | ||
73 | .Pp | ||
74 | The | ||
75 | .Fn fido_bio_info_max_samples | ||
76 | function returns the maximum number of successful samples | ||
77 | required for enrollment. | ||
78 | .Sh SEE ALSO | ||
79 | .Xr fido_bio_dev_get_info 3 , | ||
80 | .Xr fido_bio_enroll_new 3 , | ||
81 | .Xr fido_bio_template 3 | ||